source: trunk/yat/utility/CommandLine.h @ 981

#ifndef _theplu_yat_utility_commandline_
#define _theplu_yat_utility_commandline_

//$Id: CommandLine.h 981 2007-10-22 04:18:40Z peter $

/*
  Copyright (C) 2007 Peter Johansson

  This file is part of the yat library, http://trac.thep.lu.se/trac/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 2 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 this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "TypeInfo.h"

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

namespace theplu {
namespace yat {
namespace utility {

  class Option;

  /**
     @brief Class for parsing the command line.
     
     Provides parsing and storage of command line arguments. The class
     is typically used by hooking a number of Option objects to
     CommandLine, and then call the parse() function. Here is a short
     example how the class may be used:
  
     \code
  
     CommandLine cmd;
     OptionArg<std::string> dir(cmd, "d,dir", "output directory");
     OptionSwitch help(cmd, "h,help", "display this help and exit");
     OptionSwitch target(cmd, "T,target", "treat DEST as a normal file", true);
     OptionSwitch verbose(cmd, "v,verbose", "explain what is being done");
     OptionSwitch version(cmd, "version", "output version and exit");
     try {
       cmd.parse(argc, argv);
     }
     catch (std::runtime_error e){
       std::cout << e.what() << std::endl;
       return 1;
     }  
     if (help.present()){
       std::cout << "Usage: " << cmd.program_name() << " [OPTION]...\n\n"
                 << "This is a test\n\n" << cmd << "\n"
                 << "Report bugs to peter@example.net\n";
       exit(0);
     }
     if (version.present()){
       std::cout << cmd.program_name() << " 1.0\n"
                 << "Copyright (C) 2007 Peter Johansson\n\n"
                 << "This is free softwarel see the source for copying "
                 << "conditions. There is NO\nwarranty; not even for "
                 << "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n";
       exit(0);
     }
     ...
     \endcode

     After creation a number of Option classes are hooked up to the
     CommandLine object in their constructors. 

     Each parameter is associated to a one-character flag and/or a
     longer string flag. The longer flag expects to be preceded by
     '--' as e.g. '--help' for help. The shorter flag expects to be
     preceded by '-' as e.g. '-h', and can also be concatenated like
     "program -vf", which is equivalent to "program -v -f". or
     its sibblings for different types. By using the allow_help()
     function help will be displayed when flag (default is '-h' and
     '--help') is found in parsing.
  */
  class CommandLine
  {
  public:
    /**
       \brief deafult constructor
    */
    CommandLine(void);

    /**
       \brief Destructor
    */
    virtual ~CommandLine(void);

    /**
       \brief Function to add an option. 
    */
    void add(Option&);

    /**
       \brief parse the commandline

       throw std::runtime_error if an error is detected.
    */
    void parse(int argc, char* argv[]);

    /**
       @return Name of more; more specifically argv[0] is
       stripped so only string after the last '/' remains.
     */
    std::string program_name(void) const;

    /**
       \return something like "Try `<program_name()> --help` for
       more information."
     */
    std::string try_help(void) const;

  private:
    friend std::ostream& operator<<(std::ostream& os, const CommandLine& cl);
    void add_private(std::string, Option&);
    bool is_long_option(std::string str) const;
    bool is_short_option(std::string str) const;
    std::vector<std::string> split(std::string str, char del) const;

    std::vector<Option*> options_;
    std::map<char, Option*> short_options_;
    std::map<std::string, Option*> long_options_;
    std::string program_name_;
  };

  /**
     \brief CommandLine output operator
  */
  std::ostream& operator<<(std::ostream&, const CommandLine&);

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

#endif