Option.h

#ifndef _theplu_yat_utility_option_
#define _theplu_yat_utility_option_

// $Id: Option.h 2384 2010-12-22 14:03:36Z peter $

/*
  Copyright (C) 2007, 2008 Jari Häkkinen, Peter Johansson
  Copyright (C) 2009, 2010 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 <string>
#include <vector>

namespace theplu {
namespace yat {
namespace utility {

  class CommandLine;
  class Option
  {
  public:
    Option(CommandLine& cmd, std::string name, std::string desc); 

    virtual ~Option(void);
    
    std::string description(void) const;

    void description(const std::string& description);

    std::string long_name(void) const;

    void parse(std::vector<std::string>::iterator&, 
               const std::vector<std::string>::iterator&);

    bool present(void) const;

    std::string print(void);

    void reset(void);

    char short_name(void) const;

    void validate(void);

  protected:
    const CommandLine& cmd(void) const;

  private:
    virtual void do_parse(std::vector<std::string>::iterator&, 
                          const std::vector<std::string>::iterator&)=0;

    virtual std::string print1(void) const;

    virtual std::string print2(void) const;

    virtual std::string print3(void) const;

    virtual std::string print4(void) const;

    virtual void do_validate(void) const=0;


    const CommandLine& cmd_;
    std::string description_;
    std::string long_name_;
    bool present_;
    char short_name_;

    // copy not allowed
    Option(const Option&);
    Option& operator=(const Option&);
  };

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

#endif