source: trunk/yat/utility/Option.h @ 743

#ifndef _theplu_yat_utility_option_
#define _theplu_yat_utility_option_

// $Id: Option.h 743 2007-01-15 14:12:31Z peter $

/*
  Copyright (C) 2006 Peter Johansson, Jari Hakkinen

  This file is part of the yat library, http://lev.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 <string>

namespace theplu {
namespace yat {
namespace utility {

  ///
  /// @brief Container of variables for an option. @see CommandLine
  ///
  class Option
  {
  public:

    ///
    /// different types of arguments to an option
    ///
    enum argument_type {
      no_arg, string_arg, int_arg, double_arg
    };


    /// 
    /// @brief Constructor 
    /// 
    /// @param short_name one character key such as 'h' for -h flag
    /// @param long_name string key such as "help" for --help flag
    /// @param arg telling what kind argument this option expects
    /// @param desc string used in help display
    ///
    Option(char short_name, std::string long_name, 
           argument_type arg, std::string desc); 

    ///
    /// @return argument type for option
    ///
    argument_type arg_type(void) const;
    
    ///
    /// @return long name
    ///
    std::string long_name(void) const;

    ///
    /// @return long name unless long name is empty in which case the
    /// short one character name is returned.
    ///
    std::string name(void) const;

    ///
    /// @brief Get or set the present status.
    ///
    /// @return true if option has been detected in parsing
    ///
    bool& present(void);

    ///
    /// sends output to std::cerr of type
    ///
    /// -v, --verbose  explain what is going on
    ///
    void print(void) const;

    ///
    /// @return short name
    ///
    char short_name(void) const;

    ///
    /// @return reference to argument value
    ///
    std::string& value(void);


  private:
    argument_type arg_type_;
    std::string long_name_;
    std::string mess_;
    char short_name_;
    bool present_;
    std::string value_;
  };

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

#endif