CommandLine.h

#ifndef _theplu_yat_utility_commandline_
#define _theplu_yat_utility_commandline_

//$Id: CommandLine.h 4207 2022-08-26 04:36:28Z peter $

/*
  Copyright (C) 2007, 2008, 2009 Jari Häkkinen, Peter Johansson
  Copyright (C) 2010, 2011, 2012, 2013, 2014, 2022 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library 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 3 of the
  License, or (at your option) any later version.

  The yat library 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 yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include <algorithm>
#include <cctype>
#include <map>
#include <iosfwd>
#include <sstream>
#include <stdexcept>
#include <string>
#include <typeinfo>
#include <utility>
#include <vector>

namespace theplu {
namespace yat {
namespace utility {

  class Option;

  class CommandLine
  {
  public:
    CommandLine(std::string str="Available options are:");

    virtual ~CommandLine(void);

    void add(Option&);

    void allow_free_args(size_t n);

    const std::vector<std::string>& free_args(void) const;

    void parse(int argc, char* argv[]);

    bool parsed(void) const;

    std::string program_name(void) const;

    void sort(void);

    template<class Compare>
    void sort(Compare compare);

    std::string try_help(void) const;

  private:
    friend std::ostream& operator<<(std::ostream& os, const CommandLine& cl);
    bool is_long_option(std::string str) const;
    bool is_short_option(std::string str) const;
    void parse(std::vector<std::string>::iterator& first,
               std::vector<std::string>::iterator& last);
    void parse_long(std::vector<std::string>::iterator& first,
                    std::vector<std::string>::iterator& last);
    void parse_short(std::vector<std::string>::iterator& first,
                     std::vector<std::string>::iterator& last);
    void parse_free_arg(std::vector<std::string>::iterator& first,
                        std::vector<std::string>::iterator& last);
    std::string description_;
    std::vector<std::string> free_arg_;
    size_t free_arg_max_;
    std::vector<Option*> options_;
    std::map<char, Option*> short_options_;
    std::map<std::string, Option*> long_options_;
    bool parsed_;
    std::string program_name_;

    // use cond to make doxygen ignore this privat class
    struct OptionCompare
    {
      bool operator()(const Option*, const Option*) const;
    };

  };

  std::ostream& operator<<(std::ostream&, const CommandLine&);

  template<class Compare>
  void CommandLine::sort(Compare compare)
  {
    std::sort(options_.begin(), options_.end(), compare);
  }

}}} // end of namespace utility, yat, and theplu

#endif