OptionHelp.h

#ifndef _theplu_yat_utility_option_help_
#define _theplu_yat_utility_option_help_

// $Id: OptionHelp.h 2119 2009-12-12 23:11:43Z peter $

/*
  Copyright (C) 2007, 2008 Jari Häkkinen, 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 "OptionSwitch.h"

#include <string>

namespace theplu {
namespace yat {
namespace utility {

  class CommandLine;
  class OptionHelp : public OptionSwitch
  {
  public:
    OptionHelp(CommandLine& cmd, std::string name="h,help", 
               std::string desc="display this help and exit"); 

    std::string& post_arguments(void);

    std::string& synopsis(void);

    std::string& usage(void);

  private:
    std::string usage_;
    std::string synopsis_;
    std::string post_cmd_;

    void do_parse2(std::vector<std::string>::iterator, 
                   std::vector<std::string>::iterator);

  };

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

#endif