1 | #ifndef _theplu_yat_utility_option_in_file_ |
---|
2 | #define _theplu_yat_utility_option_in_file_ |
---|
3 | |
---|
4 | // $Id: OptionInFile.h 1486 2008-09-09 21:17:19Z jari $ |
---|
5 | |
---|
6 | /* |
---|
7 | Copyright (C) 2008 Peter Johansson |
---|
8 | |
---|
9 | This file is part of the yat library, http://dev.thep.lu.se/yat |
---|
10 | |
---|
11 | The yat library is free software; you can redistribute it and/or |
---|
12 | modify it under the terms of the GNU General Public License as |
---|
13 | published by the Free Software Foundation; either version 3 of the |
---|
14 | License, or (at your option) any later version. |
---|
15 | |
---|
16 | The yat library is distributed in the hope that it will be useful, |
---|
17 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
---|
19 | General Public License for more details. |
---|
20 | |
---|
21 | You should have received a copy of the GNU General Public License |
---|
22 | along with this program; if not, write to the Free Software |
---|
23 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA |
---|
24 | 02111-1307, USA. |
---|
25 | */ |
---|
26 | |
---|
27 | #include "OptionFile.h" |
---|
28 | |
---|
29 | #include <iosfwd> |
---|
30 | #include <string> |
---|
31 | |
---|
32 | namespace theplu { |
---|
33 | namespace yat { |
---|
34 | namespace utility { |
---|
35 | |
---|
36 | class CommandLine; |
---|
37 | /** |
---|
38 | \brief Class for file related options |
---|
39 | */ |
---|
40 | class OptionInFile : public OptionFile |
---|
41 | { |
---|
42 | public: |
---|
43 | /** |
---|
44 | \brief Constructor |
---|
45 | |
---|
46 | \param cmd Commandline Option is associated with |
---|
47 | \param name string such as "file" for --file, "f" for -f or |
---|
48 | "f,file" for having both short and long option name |
---|
49 | \param desc string used in help display |
---|
50 | \param required If true option must be found in commandline or |
---|
51 | exception is thrown in validation |
---|
52 | */ |
---|
53 | OptionInFile(CommandLine& cmd, std::string name, std::string desc, |
---|
54 | bool required=false); |
---|
55 | |
---|
56 | /** |
---|
57 | \brief Destructor |
---|
58 | */ |
---|
59 | virtual ~OptionInFile(void); |
---|
60 | |
---|
61 | /** |
---|
62 | \return ifstream corresponding to value(). If option was not |
---|
63 | found during parsing, std::cin is returned. |
---|
64 | */ |
---|
65 | std::istream& istream(void); |
---|
66 | |
---|
67 | private: |
---|
68 | std::ifstream* is_; |
---|
69 | |
---|
70 | }; |
---|
71 | |
---|
72 | }}} // of namespace utility, yat, and theplu |
---|
73 | |
---|
74 | #endif |
---|