validator_integer.cpp

Go to the documentation of this file.

// Copyright (c) 2006-2025  Made to Order Software Corp.  All Rights Reserved
//
// https://snapwebsites.org/project/advgetopt
// contact@m2osw.com
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
// self
//
#include    "advgetopt/validator_integer.h"
 
 
// cppthread
//
#include    <cppthread/log.h>
 
 
// snapdev
//
#include    <snapdev/trim_string.h>
 
 
// last include
//
#include    <snapdev/poison.h>
 
 
 
 
namespace advgetopt
{
 
 
 
namespace
{
 
 
 
class validator_integer_factory
    : public validator_factory
{
public:
    validator_integer_factory()
    {
        validator::register_validator(*this);
    }
 
    virtual std::string get_name() const override
    {
        return std::string("integer");
    }
 
    virtual std::shared_ptr<validator> create(string_list_t const & data) const override
    {
        return std::make_shared<validator_integer>(data);
    }
};
 
validator_integer_factory       g_validator_integer_factory;
 
 
 
} // no name namespace
 
 
 
 
 
validator_integer::validator_integer(string_list_t const & range_list)
{
    range_t range;
    for(auto r : range_list)
    {
        std::string::size_type const pos(r.find("..."));
        if(pos == std::string::npos)
        {
            if(!convert_string(r, range.f_minimum))
            {
                cppthread::log << cppthread::log_level_t::error
                               << r
                               << " is not a valid standalone value for your ranges;"
                                  " it must only be digits, optionally preceded by a sign (+ or -)"
                                  " and not overflow an int64_t value."
                               << cppthread::end;
                continue;
            }
            range.f_maximum = range.f_minimum;
        }
        else
        {
            std::string const min_value(snapdev::trim_string(r.substr(0, pos)));
            if(!min_value.empty())
            {
                if(!convert_string(min_value, range.f_minimum))
                {
                    cppthread::log << cppthread::log_level_t::error
                                   << min_value
                                   << " is not a valid value for your range's start;"
                                      " it must only be digits, optionally preceded by a sign (+ or -)"
                                      " and not overflow an int64_t value."
                                   << cppthread::end;
                    continue;
                }
            }
 
            std::string const max_value(snapdev::trim_string(r.substr(pos + 3)));
            if(!max_value.empty())
            {
                if(!convert_string(max_value, range.f_maximum))
                {
                    cppthread::log << cppthread::log_level_t::error
                                   << max_value
                                   << " is not a valid value for your range's end;"
                                      " it must only be digits, optionally preceded by a sign (+ or -)"
                                      " and not overflow an int64_t value."
                                   << cppthread::end;
                    continue;
                }
            }
 
            if(range.f_minimum > range.f_maximum)
            {
                cppthread::log << cppthread::log_level_t::error
                               << min_value
                               << " has to be smaller or equal to "
                               << max_value
                               << "; you have an invalid range."
                               << cppthread::end;
                continue;
            }
        }
        f_allowed_values.push_back(range);
    }
}
 
 
std::string validator_integer::name() const
{
    return std::string("integer");
}
 
 
bool validator_integer::validate(std::string const & value) const
{
    std::int64_t result(0);
    if(convert_string(value, result))
    {
        if(f_allowed_values.empty())
        {
            return true;
        }
 
        for(auto f : f_allowed_values)
        {
            if(result >= f.f_minimum
            && result <= f.f_maximum)
            {
                return true;
            }
        }
        set_error("out of range.");
        return false;
    }
 
    set_error("not a valid number.");
    return false;
}
 
 
bool validator_integer::convert_string(std::string const & value, std::int64_t & result)
{
    std::uint64_t integer(0);
    char const * s(value.c_str());
 
    char sign('\0');
    if(*s == '-' || *s == '+')
    {
        sign = *s;
        ++s;
    }
 
    int base(10);
    if(*s == '0')
    {
        switch(s[1])
        {
        case 'B':
        case 'b':
            base = 2;
            s += 2;
            break;
 
        case 'D':
        case 'd':
            //base = 10; -- this is the default
            s += 2;
            break;
 
        case 'O':
        case 'o':
            base = 8;
            s += 2;
            break;
 
        case 'X':
        case 'x':
            base = 16;
            s += 2;
            break;
 
        // default: start from 's' (including the '0')
        }
    }
 
    if(*s == '\0')
    {
        // empty string or just the introducer, not considered valid
        //
        return false;
    }
 
    for(;;)
    {
        char const c(*s++);
        if(c == '\0')
        {
            // valid
            //
            if(sign == '-')
            {
                if(integer > 0x8000000000000000ULL)
                {
                    return false;
                }
                result = -integer;
            }
            else
            {
                if(integer > 0x7FFFFFFFFFFFFFFFULL)
                {
                    return false;
                }
                result = integer;
            }
            return true;
        }
 
        std::int64_t digit(std::numeric_limits<std::int64_t>::max());
        if(c >= '0' && c <= '9')
        {
            digit = c - '0';
        }
        else if(c >= 'a' && c <= 'f')
        {
            digit = c - ('a' - 10);
        }
        else if(c >= 'A' && c <= 'F')
        {
            digit = c - ('A' - 10);
        }
        if(digit >= base)
        {
            // invalid digit
            //
            return false;
        }
 
        std::uint64_t const old(integer);
        integer = integer * base + digit;
        if(integer < old)
        {
            // overflow
            //
            return false;
        }
    }
}
 
 
 
} // namespace advgetopt
// vim: ts=4 sw=4 et