validator_double.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_double.h"
 
 
// cppthread
//
#include    <cppthread/log.h>
 
 
// snapdev
//
#include    <snapdev/trim_string.h>
 
 
// last include
//
#include    <snapdev/poison.h>
 
 
 
 
namespace advgetopt
{
 
 
 
namespace
{
 
 
class validator_double_factory
    : public validator_factory
{
public:
    validator_double_factory()
    {
        validator::register_validator(*this);
    }
 
    virtual std::string get_name() const override
    {
        return std::string("double");
    }
 
    virtual std::shared_ptr<validator> create(string_list_t const & data) const override
    {
        return std::make_shared<validator_double>(data);
    }
};
 
validator_double_factory       g_validator_double_factory;
 
 
} // no name namespace
 
 
 
 
validator_double::validator_double(string_list_t const & range_list)
{
    for(auto r : range_list)
    {
        range_t range;
        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;"
                                  " it must be a valid floating point,"
                                  " optionally preceded by a sign (+ or -)."
                               << 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 be a valid floating point,"
                                      " optionally preceded by a sign (+ or -)."
                                   << 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 be a valid floating point,"
                                      " optionally preceded by a sign (+ or -)."
                                   << 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_double::name() const
{
    return std::string("double");
}
 
 
bool validator_double::validate(std::string const & value) const
{
    double result(0.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 floating point number.");
    return false;
}
 
 
bool validator_double::convert_string(std::string const & value, double & result)
{
    char const * start(value.c_str());
 
    // do not allow spaces before the number
    //
    if(start[0] != '+'
    && start[0] != '-'
    && (start[0] < '0' || start[0] > '9'))
    {
        return false;
    }
 
    char * end(nullptr);
    errno = 0;
    result = std::strtod(start, &end);
 
    // do not allow anything after the last digit
    // also return false on an overflow
    //
    return end == start + value.length()
        && errno != ERANGE;
}
 
 
 
} // namespace advgetopt
// vim: ts=4 sw=4 et