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 the keywords validator.
      23             :  *
      24             :  * The advgetopt library offers a keywords validator which makes it really
      25             :  * simple to verify that a command line option matches an exact word without
      26             :  * having to handle a regular expression. It will also be slightly faster.
      27             :  *
      28             :  * The keywords are written as parameters separated by commas (,):
      29             :  *
      30             :  * \code
      31             :  *     keywords(on,off)
      32             :  * \endcode
      33             :  */
      34             : 
      35             : // self
      36             : //
      37             : #include    <advgetopt/validator.h>
      38             : 
      39             : 
      40             : 
      41             : namespace advgetopt
      42             : {
      43             : 
      44             : 
      45             : 
      46           4 : class validator_keywords
      47             :     : public validator
      48             : {
      49             : public:
      50             :                                 validator_keywords(string_list_t const & data);
      51             : 
      52             :     // validator implementation
      53             :     //
      54             :     virtual std::string         name() const override;
      55             :     virtual bool                validate(std::string const & value) const override;
      56             : 
      57             : private:
      58             :     string_set_t                f_keywords = string_set_t();
      59             : };
      60             : 
      61             : 
      62             : 
      63             : }   // namespace advgetopt
      64             : // vim: ts=4 sw=4 et