source: trunk/yat/utility/OptionInFile.h @ 1486

#ifndef _theplu_yat_utility_option_in_file_
#define _theplu_yat_utility_option_in_file_

// $Id: OptionInFile.h 1486 2008-09-09 21:17:19Z jari $

/*
  Copyright (C) 2008 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 this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/

#include "OptionFile.h"

#include <iosfwd>
#include <string>

namespace theplu {
namespace yat {
namespace utility {

  class CommandLine;
  /**
     \brief Class for file related options
   */
  class OptionInFile : public OptionFile
  {
  public:
    /**
       \brief Constructor 
       
       \param cmd Commandline Option is associated with
       \param name string such as "file" for --file, "f" for -f or
       "f,file" for having both short and long option name
       \param desc string used in help display
       \param required If true option must be found in commandline or
       exception is thrown in validation
    */
    OptionInFile(CommandLine& cmd, std::string name, std::string desc, 
                 bool required=false); 

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

    /**
       \return ifstream corresponding to value(). If option was not
       found during parsing, std::cin is returned.
    */
    std::istream& istream(void);

  private:
    std::ifstream* is_;
    
  };

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

#endif