File: ifOptions.h

package info (click to toggle)
fact%2B%2B 1.6.5~dfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 4,496 kB
  • sloc: cpp: 28,000; java: 22,674; xml: 3,268; makefile: 102; ansic: 61; sh: 3
file content (174 lines) | stat: -rw-r--r-- 5,465 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/* This file is part of the FaCT++ DL reasoner
Copyright (C) 2003-2015 Dmitry Tsarkov and The University of Manchester
Copyright (C) 2015-2016 Dmitry Tsarkov

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This 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
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef IFOPTIONS_H
#define IFOPTIONS_H

/********************************************************\
|* Interface for the options management for the FaCT++  *|
\********************************************************/

#include <string>
#include <map>
#include <iosfwd>

#include "fpp_assert.h"

class Configuration;

/// class for working with general options with boolean, integer or text values
class ifOption
{
public:		// type interface
		/// type of an option
	enum ioType { iotBool, iotInt, iotText };

private:	// preventing copying (unimplemented)
		/// no empty c'tor
	ifOption ( void );
		/// no copy c'tor
	ifOption ( const ifOption& o );
		/// no assignment
	ifOption& operator = ( const ifOption& o );

protected:	// members
		/// option name
	std::string optionName;
		/// informal descriprion
	std::string optionDescription;
		/// default value (name of type)
	std::string defaultValue;
		/// textual value [relevant iff (type == iotText)]
	std::string tValue;
		/// type of value: bool, int or text
	ioType type;
		/// integer value [relevant iff (type == iotInt)]
	int iValue;
		/// boolean value [relevant iff (type == iotBool)]
	bool bValue;

public:		// interface
		/// c'tor (init all values including proper ?Value)
	ifOption ( const std::string& name, const std::string& desc, ioType t, const std::string& defVal );
		/// empty d'tor
	~ifOption (void ) {}

	// write methods

		/// set boolean value; @return false in case of error
	bool setValue ( bool b ) { bValue = b; return (type != iotBool); }
		/// set integer value; @return false in case of error
	bool setValue ( int i ) { iValue = i; return (type != iotInt); }
		/// set string value; @return false in case of error
	bool setValue ( const std::string& t ) { tValue = t; return (type != iotText); }
		/// set textualy given value of current type; @return false in case of error
	bool setAValue ( const std::string& s );

	// access methods
		/// get value of a Boolean option
	bool getBool ( void ) const { fpp_assert ( type == iotBool ); return bValue; }
		/// get value of an integer option
	int getInt ( void ) const { fpp_assert ( type == iotInt ); return iValue; }
		/// get value of a string option
	const std::string& getText ( void ) const { fpp_assert ( type == iotText ); return tValue; }

		/// output in the form of config file
	void printConfString ( std::ostream& o ) const;
}; // ifOption

// implementation of class ifOption

inline ifOption :: ifOption ( const std::string& name, const std::string& desc, ioType t, const std::string& defVal )
	: optionName(name)
	, optionDescription(desc)
	, defaultValue(defVal)
	, type(t)
{
	setAValue (defVal);
}

/// set of options with access by name
class ifOptionSet
{
protected:	// internal type definitions
		/// base internal type
	typedef std::map<std::string,ifOption*> OptionSet;

protected:	// members
		/// set of all avaliable (given) options
	OptionSet Base;

protected:	// methods
		/// get access option structure by name; @return NULL if no such option was registered
	const ifOption* locateOption ( const std::string& name ) const;

public:		// interface
		/// empty c'tor
	ifOptionSet ( void ) {}
		/// d'tor (delete all registered options)
	~ifOptionSet ( void )
	{
		for ( OptionSet::iterator p = Base.begin(); p != Base.end(); ++p )
			delete p->second;
	}

		/// register an option with given name, description, type and default. @return true iff such option exists
	bool RegisterOption (
		const std::string& name,
		const std::string& desc,
		ifOption::ioType t,
		const std::string& defVal )
	{
		if ( locateOption (name) != NULL )
			return true;
		Base[name] = new ifOption ( name, desc, t, defVal );
		return false;
	}
		/// init all registered option using given section of given configuration
	bool initByConfigure ( Configuration& conf, const std::string& Section );

	// read access

		/// get Boolean value of given option
	bool getBool ( const std::string& optionName ) const
	{
		const ifOption* p = locateOption ( optionName );
		fpp_assert ( p != NULL );
		return p->getBool ();
	}
		/// get integral value of given option
	int getInt ( const std::string& optionName ) const
	{
		const ifOption* p = locateOption ( optionName );
		fpp_assert ( p != NULL );
		return p->getInt ();
	}
		/// get string value of given option
	const std::string& getText ( const std::string& optionName ) const
	{
		const ifOption* p = locateOption ( optionName );
		fpp_assert ( p != NULL );
		return p->getText ();
	}

		/// output option set in the form of config file
	void printConfig ( std::ostream& o ) const;
}; // ifOptionSet

#endif