Line data    Source code

       1             : // Copyright (c) 2006-2022  Made to Order Software Corp.  All Rights Reserved
       2             : //
       3             : // https://snapwebsites.org/project/advgetopt
       4             : // contact@m2osw.com
       5             : //
       6             : // This program is free software; you can redistribute it and/or modify
       7             : // it under the terms of the GNU General Public License as published by
       8             : // the Free Software Foundation; either version 2 of the License, or
       9             : // (at your option) any later version.
      10             : //
      11             : // This program is distributed in the hope that it will be useful,
      12             : // but WITHOUT ANY WARRANTY; without even the implied warranty of
      13             : // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      14             : // GNU General Public License for more details.
      15             : //
      16             : // You should have received a copy of the GNU General Public License along
      17             : // with this program; if not, write to the Free Software Foundation, Inc.,
      18             : // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
      19             : #pragma once
      20             : 
      21             : /** \file
      22             :  * \brief Declaration of validators which can be used to verify the parameters.
      23             :  *
      24             :  * The library offers parameter validations using validator objects. You
      25             :  * can even make your own validator objects available before parsing your
      26             :  * data so that way it can be verified as expected.
      27             :  *
      28             :  * Validators are recognized by name. A value can be assigned a validator
      29             :  * by specify the \em type of data it supports.
      30             :  */
      31             : 
      32             : // self
      33             : //
      34             : #include    <advgetopt/utils.h>
      35             : 
      36             : 
      37             : // C++
      38             : //
      39             : #include    <memory>
      40             : 
      41             : 
      42             : 
      43             : namespace advgetopt
      44             : {
      45             : 
      46             : 
      47             : 
      48             : class validator;
      49             : 
      50          19 : class validator_factory
      51             : {
      52             : public:
      53             :     virtual                     ~validator_factory();
      54             : 
      55             :     virtual std::string         get_name() const = 0;
      56             :     virtual std::shared_ptr<validator>
      57             :                                 create(string_list_t const & data) const = 0;
      58             : };
      59             : 
      60             : 
      61         183 : class validator
      62             : {
      63             : public:
      64             :     typedef std::shared_ptr<validator>      pointer_t;
      65             :     typedef std::vector<pointer_t>          vector_t;
      66             : 
      67             :     virtual                     ~validator();
      68             : 
      69             :     // virtuals
      70             :     //
      71             :     virtual std::string         name() const = 0;
      72             :     virtual bool                validate(std::string const & value) const = 0;
      73             : 
      74             :     static void                 register_validator(validator_factory const & factory);
      75             :     static pointer_t            create(std::string const & name, string_list_t const & data);
      76             :     static pointer_t            create(std::string const & name_and_params);
      77             : };
      78             : 
      79             : 
      80             : 
      81             : }   // namespace advgetopt
      82             : // vim: ts=4 sw=4 et