cmdline_parameters.h

/*
 * cmdline_parameters.h
 * This file is part of dbPager Classes Library (DCL)
 *
 * Copyright (c) 2008 Dennis Prochko <wolfsoft@mail.ru>
 *
 * DCL 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 version 3.
 *
 * DCL 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 DCL; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA  02110-1301  USA
 */

#ifndef _CMDLINE_PARAMETERS_H_
#define _CMDLINE_PARAMETERS_H_

#include <vector>
#include <string>

#include <dcl/exception.h>

namespace dbp {


class cmdline_parameters_exception: public exception {
public:
        cmdline_parameters_exception(const std::string &msg): exception(msg) { }
};


class cmdline_parameter {
public:
        enum parameter_type {
          OPTION,
          OPTION_WITH_VALUE,
          COMMAND,        
          FILENAME
        };
        char short_name;                        
        std::string long_name;          
        std::string value_name;         
        std::string value;                      
        std::string description;        
        parameter_type type;            

        cmdline_parameter(): short_name(0), type(FILENAME) { };
        explicit cmdline_parameter(char short_name,
          const std::string &long_name, const std::string &description,
          const std::string &value_name = "",
          parameter_type type = OPTION): short_name(short_name),
          long_name(long_name), value_name(value_name), description(description),
          type(type) { };
        explicit cmdline_parameter(parameter_type type): short_name(0),
          type(type) { };
        explicit cmdline_parameter(const std::string &description,
          parameter_type type): short_name(0), description(description),
          type(type) { };
        bool operator==(const parameter_type p_type) const;
        bool operator==(const std::string &name) const;
};



class cmdline_parameters {
public:
        typedef std::vector<cmdline_parameter> params;
        cmdline_parameters(): _pos(0) { };
        /*
                Registers the command line parameter as known one.
                
                \param param the command line parameter
        */
        void add(const cmdline_parameter &param);

        bool parse(int argc, char* argv[], cmdline_parameter &param);

        params::const_iterator begin() const;

        params::const_iterator end() const;
private:
        int _pos;
        params _params;
};

} // namespace

#endif /*_CMDLINE_PARAMETERS_H_*/