1 | /*! |
---|
2 | \file |
---|
3 | \brief UI (user info) class for loading/saving objects from/to configuration files. |
---|
4 | It is designed with use of libconfig C/C++ Configuration File Library |
---|
5 | \ref ui_page |
---|
6 | \author Vaclav Smidl. |
---|
7 | |
---|
8 | ----------------------------------- |
---|
9 | BDM++ - C++ library for Bayesian Decision Making under Uncertainty |
---|
10 | |
---|
11 | Using IT++ for numerical operations |
---|
12 | ----------------------------------- |
---|
13 | */ |
---|
14 | |
---|
15 | #ifndef USER_INFO_H |
---|
16 | #define USER_INFO_H |
---|
17 | |
---|
18 | #include <stdio.h> |
---|
19 | #include <string> |
---|
20 | #include <typeinfo> |
---|
21 | #include <map> |
---|
22 | #include <stdexcept> |
---|
23 | |
---|
24 | #include "libconfig/libconfig.h++" |
---|
25 | #include "../bdmroot.h" |
---|
26 | #include "itpp/itbase.h" |
---|
27 | |
---|
28 | |
---|
29 | using std::string; |
---|
30 | using namespace std; |
---|
31 | using namespace libconfig; |
---|
32 | |
---|
33 | namespace bdm { |
---|
34 | |
---|
35 | //! Exception prepared for reporting user-info errors which are always related to some concrete Setting path |
---|
36 | //! |
---|
37 | //! \ref ui_page |
---|
38 | class UIException : public std::exception { |
---|
39 | |
---|
40 | public: |
---|
41 | //! Error message |
---|
42 | const string message; |
---|
43 | |
---|
44 | //! Path to the problematic setting |
---|
45 | const string path; |
---|
46 | |
---|
47 | //! Use this constructor when you can pass the problematical Setting as a parameter |
---|
48 | UIException ( const string &message, const Setting &element ) |
---|
49 | : message ( "UI error: " + message + "." ), path ( "Check path \"" + string ( element.getPath() ) + "\"." ) { |
---|
50 | } |
---|
51 | |
---|
52 | //! This constructor is for other occasions, when only path of problematical Setting is known |
---|
53 | UIException ( const string &message, const string &path ) |
---|
54 | : message ( "UI error: " + message + "." ), path ( "Check path \"" + path + "\"." ) { |
---|
55 | } |
---|
56 | |
---|
57 | //! Overriden method for reporting an error message |
---|
58 | virtual const char* what() const throw() { |
---|
59 | return ( message + " " + path ).c_str(); |
---|
60 | } |
---|
61 | ~UIException() throw() {}; |
---|
62 | }; |
---|
63 | |
---|
64 | |
---|
65 | /*! |
---|
66 | @brief This class serves to load and/or save user-infos into/from |
---|
67 | configuration files stored on a hard-disk. |
---|
68 | |
---|
69 | Firstly, save some user-infos into the new UIFile instance. Then, |
---|
70 | call the save method with a filename as its only argument: |
---|
71 | |
---|
72 | \code |
---|
73 | CAudi audi; |
---|
74 | UIFile file; |
---|
75 | UI::save( audi, file, "TT"); |
---|
76 | file.save("cars.cfg"); |
---|
77 | \endcode |
---|
78 | |
---|
79 | In the other way round, when loading object from a configuration file, |
---|
80 | the appropriate code looks like this: |
---|
81 | |
---|
82 | \code |
---|
83 | UIFile file("cars.cfg"); |
---|
84 | CAudi *audi = UI::build<CAudi>(file,"TT"); |
---|
85 | \endcode |
---|
86 | |
---|
87 | \ref ui_page |
---|
88 | */ |
---|
89 | class UIFile : public Config { |
---|
90 | public: |
---|
91 | //! Create empty file instance prepared to store Settings |
---|
92 | UIFile(); |
---|
93 | |
---|
94 | //! Creates instance and fills it from the configuration file file_name |
---|
95 | UIFile ( const string &file_name ); |
---|
96 | |
---|
97 | //! Save all the stored Settings into the configuration file file_name |
---|
98 | void save ( const string &file_name ); |
---|
99 | |
---|
100 | //! This operator allows the ability of substituting Setting parameter by UIFile instance |
---|
101 | operator Setting&(); |
---|
102 | }; |
---|
103 | |
---|
104 | /*! |
---|
105 | @brief This class serves to expand links used within configuration files. |
---|
106 | |
---|
107 | Value of any type but string can be linked to some other value of the same type |
---|
108 | defined elsewhere in the current configuration file or even in some different |
---|
109 | configuration file. |
---|
110 | |
---|
111 | Link have three parts, \<name\> : \<path\> \<\@filename\>. Field \<name\> contains the |
---|
112 | name of the new setting, \<path\> is the relative path to the referenced setting, which |
---|
113 | has to be taken from the %root Setting element. The last part \<\@filename\> is optional, |
---|
114 | it contains filename in the case the link should refer to a variable stored in a different |
---|
115 | file. From the previous part \<path\>, it has to be separated by '@'. |
---|
116 | |
---|
117 | \code |
---|
118 | ... |
---|
119 | jardovo : |
---|
120 | { |
---|
121 | class = "Car"; |
---|
122 | year = 1992; |
---|
123 | manufacturer = "liaz"; |
---|
124 | kilometers = 1555000; |
---|
125 | }; |
---|
126 | ondrejovo : |
---|
127 | { |
---|
128 | class = "Bike"; |
---|
129 | year = 1996; |
---|
130 | manufacturer = "author"; |
---|
131 | electricLights = true; |
---|
132 | matr = ( 2, 2, [ 1.0, 0.0, 0.0, 1.0 ] ); |
---|
133 | }; |
---|
134 | |
---|
135 | #this is the example of local link to another mean of transport |
---|
136 | elisky = "jardovo"; |
---|
137 | |
---|
138 | ... |
---|
139 | |
---|
140 | # And this link is external link pointing to the file "other_cars.cfg" stored in the |
---|
141 | # same directory. In that file, it refers to the local Setting "magic_cars.skubankovo". |
---|
142 | kati = "magic_cars.skubankovo@other_cars.cfg"; |
---|
143 | |
---|
144 | ... |
---|
145 | \endcode |
---|
146 | |
---|
147 | When you want to expand a possible linked setting "element" within your code, it has to be treated this way: |
---|
148 | |
---|
149 | \code |
---|
150 | ... |
---|
151 | |
---|
152 | const SettingResolver link( element ); |
---|
153 | |
---|
154 | ... |
---|
155 | |
---|
156 | int len = link.result.getLength(); |
---|
157 | |
---|
158 | ... |
---|
159 | \endcode |
---|
160 | |
---|
161 | The whole point is that a resolved link (class member #result, i.e., "link.result" in the previous example) could point |
---|
162 | into a different configuration file. In that case there has to be an UIFile instance managing reading from this |
---|
163 | file. As the libconfig::Config deletes all its Settings when dealocated, UIFile must not be dealocated until all |
---|
164 | the necessary operation on the linked Setting are finished (otherwise, the link #result would be invalid just after |
---|
165 | the UIFile dealocation). And that is exactly the mechanism implemented within SettingResolver class. It assures, |
---|
166 | that the #result Setting reference is valid within the scope of SettingResolver instance. |
---|
167 | |
---|
168 | \ref ui_page |
---|
169 | */ |
---|
170 | class SettingResolver : root { |
---|
171 | private: |
---|
172 | //! If necessary, this pointer stores an addres of an opened UIFile, else it equals NULL |
---|
173 | UIFile *file; |
---|
174 | |
---|
175 | //! This method initialize #result reference, i.e., it executes the main code of SettingResolver class |
---|
176 | //! |
---|
177 | //! This code could be also located directly in constructor. The only reason why we made this |
---|
178 | //! method is the keyword 'const' within the declaration of #result reference . Such a reference |
---|
179 | //! have to be intialized before any other constructor command, exactly in the way it is implemented now. |
---|
180 | const Setting &initialize_reference ( UIFile* &file, const Setting &potential_link ); |
---|
181 | |
---|
182 | public: |
---|
183 | //! Reference to a resolved link or to the original Setting in the case it does not contain a link |
---|
184 | const Setting &result; |
---|
185 | |
---|
186 | //! If potential_link contains a link to some other setting, it is resolved here. Anyway, the Setting reference #result is prepared for use. |
---|
187 | SettingResolver ( const Setting &potential_link ); |
---|
188 | |
---|
189 | //! An opened UIFile file is closed here if necessary. |
---|
190 | ~SettingResolver(); |
---|
191 | }; |
---|
192 | |
---|
193 | /*! |
---|
194 | @brief UI is an abstract class which collects all the auxiliary functions useful to prepare some concrete |
---|
195 | user-infos. |
---|
196 | |
---|
197 | See static methods 'build', 'get' and 'save'. Writing user-infos with these methods is rather simple. The |
---|
198 | rest of this class is intended for internal purposes only. Its meaning is to allow pointers to its templated |
---|
199 | descendant ParticularUI<T>. |
---|
200 | |
---|
201 | \ref ui_page |
---|
202 | */ |
---|
203 | class UI { |
---|
204 | private: |
---|
205 | //! Class with state shared across all its instances ("monostate"), encapsulating two maps, one mapping names to UI instances and the other mapping type_infos to class names |
---|
206 | //! |
---|
207 | //! The key property of this class is that it initializes the internal maps on global init, |
---|
208 | //! before the instance is used for a first time. Therefore, we do not have to care about initialization |
---|
209 | //! during a call of UIREGISTER macro operating with both these mappings. |
---|
210 | class MappedUI { |
---|
211 | private: |
---|
212 | //! Type definition of mapping which transforms class names to the related UI instances |
---|
213 | typedef map< const string, const UI* const > StringToUIMap; |
---|
214 | |
---|
215 | //! Type definition of mapping which transforms RTTI type_infos to the related class names |
---|
216 | typedef map< const type_info * const, const string > TypeInfoToStringMap; |
---|
217 | |
---|
218 | //! Immediately initialized instance of type StringToUIMap |
---|
219 | static StringToUIMap& mapped_strings(); |
---|
220 | |
---|
221 | //! Immediately initialized instance of type TypeInfoToStringMap |
---|
222 | static TypeInfoToStringMap& mapped_type_infos(); |
---|
223 | |
---|
224 | //! Method for reporting a error when an attempt to operate with an unregistered class occures |
---|
225 | static void unregistered_class_error ( const string &unregistered_class_name ); |
---|
226 | |
---|
227 | public: |
---|
228 | //! Add a pair key-userinfo into the internal map |
---|
229 | static void add_class ( const string &class_name, const type_info * const class_type_info, const UI* const ui ); |
---|
230 | |
---|
231 | //! Search for an userinfo related to the passed class name within the internal map |
---|
232 | static const UI& retrieve_ui ( const string &class_name ); |
---|
233 | |
---|
234 | //! Search for an class name related to the passed type_info within the internal map |
---|
235 | static const string& retrieve_class_name ( const type_info* const class_type_info ); |
---|
236 | }; |
---|
237 | |
---|
238 | //! Function assertting that the setting element is of the SettingType type |
---|
239 | static void assert_type ( const Setting &element, Setting::Type type ); |
---|
240 | |
---|
241 | //! Method assembling a typeless instance, it is implemented in descendant class ParticularUI<T> |
---|
242 | virtual root* new_instance() const = 0; |
---|
243 | |
---|
244 | //! Method switching from the \a element to its child Setting according the passed \a index, it also does all the necessary error-checking |
---|
245 | static const Setting& to_child_setting ( const Setting &element, const int index ); |
---|
246 | |
---|
247 | //! Method switching from the \a element to its child Setting according the passed \a name, it also does all the necessary error-checking |
---|
248 | static const Setting& to_child_setting ( const Setting &element, const string &name ); |
---|
249 | |
---|
250 | //! This method converts a Setting into a matrix |
---|
251 | static void from_setting ( mat& matrix, const Setting &element ); |
---|
252 | //! This method converts a Setting into an integer vector |
---|
253 | static void from_setting ( ivec &vector, const Setting &element ); |
---|
254 | //! This method converts a Setting into a string |
---|
255 | static void from_setting ( string &str, const Setting &element ); |
---|
256 | //! This method converts a Setting into a real vector |
---|
257 | static void from_setting ( vec &vector, const Setting &element ); |
---|
258 | //! This method converts a Setting into a integer scalar |
---|
259 | static void from_setting ( int &integer, const Setting &element ); |
---|
260 | //! This method converts a Setting into a real scalar |
---|
261 | static void from_setting ( double &real, const Setting &element ); |
---|
262 | //! This method converts a Setting into a class T descendant |
---|
263 | template<class T> static void from_setting ( T* &instance, const Setting &element ) { |
---|
264 | const SettingResolver link ( element ); |
---|
265 | assert_type ( link.result, Setting::TypeGroup ); |
---|
266 | |
---|
267 | // we get a value stored in the "class" attribute |
---|
268 | string class_name; |
---|
269 | if ( !link.result.lookupValue ( "class", class_name ) ) |
---|
270 | throw UIException ( "the obligatory \"class\" identifier is missing", link.result ); |
---|
271 | |
---|
272 | // then we find a user-info related to this type |
---|
273 | const UI& related_UI = MappedUI::retrieve_ui ( class_name ); |
---|
274 | |
---|
275 | root* typeless_instance = related_UI.new_instance(); |
---|
276 | |
---|
277 | instance = dynamic_cast<T*> ( typeless_instance ); |
---|
278 | if ( !instance ) |
---|
279 | throw UIException ( "class " + class_name + " is not a descendant of the desired output class. Try to call the UI::build<T> function with a different type parameter.", link.result ); |
---|
280 | |
---|
281 | try { |
---|
282 | instance->from_setting ( link.result ); |
---|
283 | } catch ( SettingException sttng_xcptn ) { |
---|
284 | string msg = "the method " + class_name + ".from_setting(Setting&) has thrown a SettingException. Try to correct this method. Check path \"" + sttng_xcptn.getPath() + "\"."; |
---|
285 | throw UIException(msg, link.result); |
---|
286 | } |
---|
287 | } |
---|
288 | |
---|
289 | //! This methods converts a Setting into a new templated array of type Array<T> |
---|
290 | template<class T> static void from_setting ( T &variable_to_load, const Setting &element ) { |
---|
291 | const SettingResolver link ( element ); |
---|
292 | |
---|
293 | assert_type ( link.result, Setting::TypeList ); |
---|
294 | |
---|
295 | int len = link.result.getLength(); |
---|
296 | array_to_load.set_length ( len ); |
---|
297 | if ( len == 0 ) return; |
---|
298 | |
---|
299 | for ( int i = 0; i < len; i++ ) |
---|
300 | from_setting ( array_to_load ( i ), link.result[i] ); |
---|
301 | } |
---|
302 | |
---|
303 | //! This is dummy version of the from_setting method for other, unsupported types. It just throws an exception. |
---|
304 | //! |
---|
305 | //! At the moment, this is the only way how to compile the library without obtaining the compiler error c2665. |
---|
306 | //! The exception can help to find the place where the template is misused and also to correct it. |
---|
307 | template<class T> static void from_setting ( T &array_to_load, const Setting &element ) { |
---|
308 | throw UIException ( "from_setting is not implemented for this type", element ); |
---|
309 | } |
---|
310 | |
---|
311 | |
---|
312 | protected: |
---|
313 | //! Default constructor for internal use only, see \sa ParticularUI<T> |
---|
314 | UI ( const string& class_name, const type_info * const class_type_info ) { |
---|
315 | MappedUI::add_class ( class_name, class_type_info, this ); |
---|
316 | } |
---|
317 | |
---|
318 | public: |
---|
319 | |
---|
320 | //! Enumerical type used to determine whether the data for concrete Settingis is compulsory or optional |
---|
321 | enum SettingPresence { optional, compulsory } ; |
---|
322 | |
---|
323 | //! \name Initialization of classes |
---|
324 | //!@{ |
---|
325 | //! The type T has to be a #bdm::root descendant class |
---|
326 | |
---|
327 | //! The new instance of type T* is constructed and initialized with values stored in the Setting element[name] |
---|
328 | //! |
---|
329 | //! If there is not any sub-element named #name, the null pointer is returned. |
---|
330 | template<class T> static T* build ( const Setting &element, const string &name, SettingPresence settingPresence = optional ) { |
---|
331 | if ( !element.exists ( name ) ) { |
---|
332 | if ( settingPresence == optional ) |
---|
333 | return NULL; |
---|
334 | else |
---|
335 | throw UIException ( "the compulsory Setting named \"" + name + "\" is missing", element ); |
---|
336 | } |
---|
337 | |
---|
338 | T* instance; |
---|
339 | from_setting<T> ( instance, to_child_setting ( element, name ) ); |
---|
340 | return instance; |
---|
341 | } |
---|
342 | |
---|
343 | //! The new instance of type T* is constructed and initialized with values stored in the Setting element[index] |
---|
344 | //! |
---|
345 | //! If there is not any sub-element indexed by #index, the null pointer is returned. |
---|
346 | template<class T> static T* build ( const Setting &element, const int index, SettingPresence settingPresence = optional ) { |
---|
347 | if ( element.getLength() <= index ) { |
---|
348 | if ( settingPresence == optional ) |
---|
349 | return NULL; |
---|
350 | else { |
---|
351 | stringstream stream; |
---|
352 | stream << index; |
---|
353 | throw UIException ( "the compulsory Setting with the index " + stream.str() + " is missing", element ); |
---|
354 | } |
---|
355 | } |
---|
356 | |
---|
357 | T* instance; |
---|
358 | from_setting<T> ( instance, to_child_setting ( element, index ) ); |
---|
359 | return instance; |
---|
360 | } |
---|
361 | |
---|
362 | //! The new instance of type T* is constructed and initialized with values stored in the Setting element |
---|
363 | template<class T> static T* build ( const Setting &element ) { |
---|
364 | T* instance; |
---|
365 | from_setting<T> ( instance, element ); |
---|
366 | return instance; |
---|
367 | |
---|
368 | } |
---|
369 | |
---|
370 | //!@} |
---|
371 | |
---|
372 | //! \name Initialization of structures |
---|
373 | //!@{ |
---|
374 | //! The type T has to be int, double, string, vec, ivec or mat. |
---|
375 | |
---|
376 | //! The existing instance of type T is initialized with values stored in the Setting element[name] |
---|
377 | //! If there is not any sub-element named #name, this method returns false. |
---|
378 | template<class T> static bool get ( T &instance, const Setting &element, const string &name, SettingPresence settingPresence = optional ) { |
---|
379 | if ( !element.exists ( name ) ) { |
---|
380 | if ( settingPresence == optional ) |
---|
381 | return false; |
---|
382 | else |
---|
383 | throw UIException ( "the compulsory Setting named \"" + name + "\" is missing", element ); |
---|
384 | } |
---|
385 | |
---|
386 | from_setting ( instance, to_child_setting ( element, name ) ); |
---|
387 | return true; |
---|
388 | } |
---|
389 | |
---|
390 | //! The existing instance of type T is initialized with values stored in the Setting element[index] |
---|
391 | //! If there is not any sub-element indexed by #index, this method returns false. |
---|
392 | template<class T> static bool get ( T &instance, const Setting &element, const int index, SettingPresence settingPresence = optional ) { |
---|
393 | if ( element.getLength() <= index ) { |
---|
394 | if ( settingPresence == optional ) |
---|
395 | return false; |
---|
396 | else { |
---|
397 | stringstream stream; |
---|
398 | stream << index; |
---|
399 | throw UIException ( "the compulsory Setting with the index " + stream.str() + " is missing", element ); |
---|
400 | } |
---|
401 | } |
---|
402 | |
---|
403 | from_setting ( instance, to_child_setting ( element, index ) ); |
---|
404 | return true; |
---|
405 | } |
---|
406 | |
---|
407 | //! The existing instance of type T is initialized with values stored in the Setting element directly |
---|
408 | template<class T> static bool get ( T &instance, const Setting &element ) { |
---|
409 | from_setting ( instance, element ); |
---|
410 | return true; |
---|
411 | } |
---|
412 | //!@} |
---|
413 | |
---|
414 | //! \name Initialization of arrays Array<T> |
---|
415 | //!@{ |
---|
416 | //! The type T has to be int, double, string, vec, ivec or mat, or pointer to any root descendant. |
---|
417 | |
---|
418 | //! The existing array of type T is initialized with values stored in the Setting element[name] |
---|
419 | //! If there is not any sub-element named #name, this method returns false. |
---|
420 | template<class T> static bool get ( Array<T> &array_to_load, const Setting &element, const string &name, SettingPresence settingPresence = optional ) { |
---|
421 | if ( !element.exists ( name ) ) |
---|
422 | return false; |
---|
423 | |
---|
424 | from_setting ( array_to_load, to_child_setting ( element, name ) ); |
---|
425 | return true; |
---|
426 | } |
---|
427 | |
---|
428 | //! The existing array of type T is initialized with values stored in the Setting element[index] |
---|
429 | //! If there is not any sub-element indexed by #index, this method returns false. |
---|
430 | template<class T> static bool get ( Array<T> &array_to_load, const Setting &element, const int index, SettingPresence settingPresence = optional ) { |
---|
431 | if ( element.getLength() <= index ) |
---|
432 | return false; |
---|
433 | |
---|
434 | from_setting ( array_to_load, to_child_setting ( element, index ) ); |
---|
435 | return true; |
---|
436 | } |
---|
437 | |
---|
438 | //! The existing array of type T is initialized with values stored in the Setting element |
---|
439 | template<class T> static bool get ( Array<T> &array_to_load, const Setting &element ) { |
---|
440 | from_setting ( array_to_load, element ); |
---|
441 | return true; |
---|
442 | } |
---|
443 | //!@} |
---|
444 | |
---|
445 | //! \name Serialization of objects and structures into a new Setting |
---|
446 | //!@{ |
---|
447 | //! The new child Setting can be accessed either by its name - if some name is passed as a parameter - |
---|
448 | //! or by its integer index. In that case, the new element is added at the very end of the current list of child Settings. |
---|
449 | |
---|
450 | //! A root descendant instance is stored in the new child Setting appended to the passed element |
---|
451 | template< class T> static void save ( const T * const instance, Setting &element, const string &name = "" ) { |
---|
452 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeGroup ) |
---|
453 | : element.add ( name, Setting::TypeGroup ); |
---|
454 | |
---|
455 | const string &class_name = MappedUI::retrieve_class_name ( &typeid ( *instance ) ); |
---|
456 | |
---|
457 | // add attribute "class" |
---|
458 | Setting &type = set.add ( "class", Setting::TypeString ); |
---|
459 | type = class_name; |
---|
460 | |
---|
461 | try { |
---|
462 | instance->to_setting ( set ); |
---|
463 | } catch ( SettingException sttng_xcptn ) { |
---|
464 | string msg = "the method "; |
---|
465 | msg += class_name; |
---|
466 | msg += ".to_setting(Setting&) has thrown a SettingException. Try to correct this method."; |
---|
467 | throw UIException(msg, sttng_xcptn.getPath()); |
---|
468 | } |
---|
469 | } |
---|
470 | |
---|
471 | //! An Array<T> instance is stored in the new child Setting appended to the passed element |
---|
472 | template<class T> static void save ( const Array<T> &array_to_save, Setting &element, const string &name = "" ) { |
---|
473 | assert_type ( element, Setting::TypeGroup ); |
---|
474 | Setting &list = ( name == "" ) ? element.add ( Setting::TypeList ) |
---|
475 | : element.add ( name, Setting::TypeList ); |
---|
476 | for ( int i = 0; i < array_to_save.length(); i++ ) |
---|
477 | save ( array_to_save ( i ), list ); |
---|
478 | } |
---|
479 | |
---|
480 | //! A matrix(of type mat) is stored in the new child Setting appended to the passed element |
---|
481 | static void save ( const mat &matrix, Setting &element, const string &name = "" ); |
---|
482 | |
---|
483 | //! An integer vector (of type ivec) is stored in the new child Setting appended to the passed element |
---|
484 | static void save ( const ivec &vec, Setting &element, const string &name = "" ); |
---|
485 | |
---|
486 | //! A double vector (of type vec) is stored in the new child Setting appended to the passed element |
---|
487 | static void save ( const vec &vector, Setting &element, const string &name = "" ); |
---|
488 | |
---|
489 | //! A string is stored in the new child Setting appended to the passed element |
---|
490 | static void save ( const string &str, Setting &element, const string &name = "" ); |
---|
491 | |
---|
492 | //! An integer is stored in the new child Setting appended to the passed element |
---|
493 | static void save ( const int &integer, Setting &element, const string &name = "" ); |
---|
494 | |
---|
495 | //! A double is stored in the new child Setting appended to the passed element |
---|
496 | static void save ( const double &real, Setting &element, const string &name = "" ); |
---|
497 | //!@} |
---|
498 | |
---|
499 | }; |
---|
500 | |
---|
501 | |
---|
502 | //! The only UI descendant class which is not intended for direct use. It should be accessed within the ::UIREGISTER macro only. |
---|
503 | //! \ref ui_page |
---|
504 | template<typename T> class ParticularUI : private UI { |
---|
505 | private: |
---|
506 | //! Default constructor, which is intentionally declared as private |
---|
507 | ParticularUI<T> ( const string &class_name ) : UI ( class_name, &typeid ( T ) ) {}; |
---|
508 | |
---|
509 | public: |
---|
510 | //! The only instance of this class (each type T has its own instance) which is used as a factory for processing related UI |
---|
511 | static const ParticularUI<T>& factory; |
---|
512 | |
---|
513 | //! A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless construcotor in class T |
---|
514 | root* new_instance() const { |
---|
515 | return new T(); |
---|
516 | } |
---|
517 | }; |
---|
518 | |
---|
519 | } |
---|
520 | |
---|
521 | /*! |
---|
522 | \def UIREGISTER(class_name) |
---|
523 | \brief Macro for registration of class into map of user-infos, registered class is scriptable using UI static methods |
---|
524 | |
---|
525 | Argument \a class_name has to be a descendant of root class and also, it has to have parameterless constructor prepared. |
---|
526 | This macro should be used in header file, immediately after a class declaration. |
---|
527 | |
---|
528 | \ref ui_page |
---|
529 | */ |
---|
530 | #ifndef BDMLIB |
---|
531 | #define UIREGISTER(class_name) template<> const ParticularUI<class_name>& ParticularUI<class_name>::factory = ParticularUI<class_name>(#class_name) |
---|
532 | #else |
---|
533 | #define UIREGISTER(class_name) |
---|
534 | #endif |
---|
535 | |
---|
536 | #endif // #ifndef USER_INFO_H |
---|