1 | // |
---|
2 | // C++ Implementation: user_info.cpp |
---|
3 | // |
---|
4 | // Description: UI (user info) class for loading/saving objects from/to configuration files. |
---|
5 | // |
---|
6 | // |
---|
7 | // Author: smidl <smidl@utia.cas.cz>, (C) 2009 |
---|
8 | // |
---|
9 | // Copyright: See COPYING file that comes with this distribution |
---|
10 | // |
---|
11 | // |
---|
12 | |
---|
13 | #include "user_info.h" |
---|
14 | |
---|
15 | namespace bdm { |
---|
16 | |
---|
17 | string UIException::format_message ( const string &reason, const string &path ) { |
---|
18 | stringstream ss; |
---|
19 | ss << reason; |
---|
20 | ss << " Check path \"" << path << "\"."; |
---|
21 | return ss.str(); |
---|
22 | } |
---|
23 | |
---|
24 | ///////////////////////////// Class UIFile ///////////////////////////////////////////// |
---|
25 | |
---|
26 | UIFile::UIFile() { |
---|
27 | } |
---|
28 | |
---|
29 | UIFile::UIFile ( const string &file_name ) { |
---|
30 | try { |
---|
31 | readFile ( file_name.c_str() ); |
---|
32 | // this flag has to be set AFTER each file load, that is why it is right here |
---|
33 | setAutoConvert ( true ); |
---|
34 | } catch ( FileIOException f ) { |
---|
35 | string msg = "UI error: file "; |
---|
36 | msg += file_name; |
---|
37 | msg += " not found."; |
---|
38 | bdm_error ( msg ); |
---|
39 | } catch ( ParseException& P ) { |
---|
40 | stringstream msg; |
---|
41 | msg << "UI error: parsing error """ << P.getError() << """ in file " << file_name << " on line " << P.getLine() << "."; |
---|
42 | bdm_error ( msg.str() ); |
---|
43 | } |
---|
44 | } |
---|
45 | |
---|
46 | |
---|
47 | void UIFile::save ( const string &file_name ) { |
---|
48 | try { |
---|
49 | writeFile ( file_name.c_str() ); |
---|
50 | } catch ( FileIOException f ) { |
---|
51 | string msg = "UI error: file "; |
---|
52 | msg += file_name; |
---|
53 | msg += " is inacessible."; |
---|
54 | bdm_error ( msg ); |
---|
55 | } |
---|
56 | } |
---|
57 | |
---|
58 | UIFile::operator Setting&() { |
---|
59 | return getRoot(); |
---|
60 | } |
---|
61 | |
---|
62 | ///////////////////////////// Class UI::MappedUI ///////////////////////////////////////////// |
---|
63 | |
---|
64 | UI::MappedUI::StringToUIMap& UI::MappedUI::mapped_strings() { |
---|
65 | // this way it is ensured that there is only one instance of StringTpUIMap, and |
---|
66 | // what is more, this declaration leaves its allocation/deallocation on the compiler |
---|
67 | static StringToUIMap var; |
---|
68 | return var; |
---|
69 | } |
---|
70 | |
---|
71 | UI::MappedUI::TypeInfoToStringMap& UI::MappedUI::mapped_type_infos() { |
---|
72 | // this way it is ensured that there is only one instance of TypeInfoToStringMap, and |
---|
73 | // what is more, this declaration leaves its allocation/deallocation on the compiler |
---|
74 | static TypeInfoToStringMap var; |
---|
75 | return var; |
---|
76 | } |
---|
77 | |
---|
78 | void UI::MappedUI::add_class ( const string &class_name, const type_info * const class_type_info, const UI* const ui ) { |
---|
79 | pair< StringToUIMap::iterator, bool> inres = |
---|
80 | mapped_strings().insert ( |
---|
81 | StringToUIMap::value_type ( class_name, ui ) ); |
---|
82 | if ( inres.second ) { |
---|
83 | mapped_type_infos().insert ( |
---|
84 | TypeInfoToStringMap::value_type ( |
---|
85 | class_type_info, class_name ) ); |
---|
86 | } |
---|
87 | } |
---|
88 | |
---|
89 | void UI::MappedUI::unregistered_class_error ( const string &unregistered_class_name ) { |
---|
90 | stringstream msg; |
---|
91 | msg << "UI error: class " + unregistered_class_name + " was not properly registered. Use the macro ""UIREGISTER([class name]);"" within your code." << endl; |
---|
92 | |
---|
93 | if ( mapped_strings().size() ) { |
---|
94 | StringToUIMap::const_iterator iter = mapped_strings().begin(); |
---|
95 | msg << "These classes are already registered: " << iter->first; |
---|
96 | for ( iter++; iter != mapped_strings().end(); iter++ ) |
---|
97 | msg << ", " << iter->first; |
---|
98 | msg << "." << endl; |
---|
99 | } else |
---|
100 | msg << "There is not any registered class yet!" << endl; |
---|
101 | |
---|
102 | bdm_error ( msg.str() ); |
---|
103 | } |
---|
104 | |
---|
105 | const UI& UI::MappedUI::retrieve_ui ( const string &class_name ) { |
---|
106 | StringToUIMap::const_iterator iter = mapped_strings().find ( class_name ); |
---|
107 | if ( iter == mapped_strings().end() ) |
---|
108 | unregistered_class_error ( class_name ); |
---|
109 | |
---|
110 | return *iter->second; |
---|
111 | } |
---|
112 | |
---|
113 | const string& UI::MappedUI::retrieve_class_name ( const type_info * const class_type_info ) { |
---|
114 | TypeInfoToStringMap::const_iterator iter = mapped_type_infos().find ( class_type_info ); |
---|
115 | if ( iter == mapped_type_infos().end() ) |
---|
116 | unregistered_class_error ( "with RTTI name " + string ( class_type_info->name() ) ); |
---|
117 | return iter->second; |
---|
118 | } |
---|
119 | |
---|
120 | ///////////////////////////// Class SettingResolver ///////////////////////////////////////////// |
---|
121 | |
---|
122 | SettingResolver::SettingResolver ( const Setting &potential_link ) |
---|
123 | : result ( initialize_reference ( file, potential_link ) ) { |
---|
124 | } |
---|
125 | |
---|
126 | const Setting& SettingResolver::initialize_reference ( UIFile *&file, const Setting &potential_link ) { |
---|
127 | file = NULL; |
---|
128 | |
---|
129 | if ( potential_link.getType() != Setting::TypeString ) |
---|
130 | return potential_link; |
---|
131 | |
---|
132 | string link = ( const char* ) potential_link; |
---|
133 | size_t aerobase = link.find ( '@' ); |
---|
134 | |
---|
135 | const Setting *result; |
---|
136 | if ( aerobase != string::npos ) { |
---|
137 | string file_name = link.substr ( aerobase + 1, link.length() ); |
---|
138 | file = new UIFile ( file_name ); |
---|
139 | result = & ( Setting& ) ( *file ); |
---|
140 | link = link.substr ( 0, aerobase ); |
---|
141 | } else { |
---|
142 | result = &potential_link; |
---|
143 | while ( !result->isRoot() ) |
---|
144 | result = &result->getParent(); |
---|
145 | } |
---|
146 | |
---|
147 | if ( !result->exists ( link ) ) |
---|
148 | throw UISettingException ( "UIException: linked setting was not found.", string ( ( const char* ) potential_link ) ); |
---|
149 | |
---|
150 | return ( *result ) [link]; |
---|
151 | } |
---|
152 | |
---|
153 | SettingResolver::~SettingResolver() { |
---|
154 | if ( file ) delete file; |
---|
155 | } |
---|
156 | |
---|
157 | ///////////////////////////// Class UI ///////////////////////////////////////////// |
---|
158 | |
---|
159 | void UI::assert_type ( const Setting &element, Setting::Type type ) { |
---|
160 | if ( element.getType() != type ) |
---|
161 | throw UISettingException ( "UIException: wrong setting type.", element ); |
---|
162 | } |
---|
163 | |
---|
164 | const Setting& UI::to_child_setting ( const Setting &element, const int index ) { |
---|
165 | if ( !element.isList() ) |
---|
166 | throw UISettingException ( "UIException: only TypeList elements could be indexed by integers.", element ); |
---|
167 | |
---|
168 | return element[index]; |
---|
169 | } |
---|
170 | |
---|
171 | const Setting& UI::to_child_setting ( const Setting &element, const string &name ) { |
---|
172 | if ( !element.isGroup() ) |
---|
173 | throw UISettingException ( "UIException: only TypeGroup elements could be indexed by strings.", element ); |
---|
174 | |
---|
175 | return element[name]; |
---|
176 | } |
---|
177 | |
---|
178 | void UI::call_to_setting( const root &instance, Setting &set, string class_name ) { |
---|
179 | try { |
---|
180 | instance.to_setting ( set ); |
---|
181 | } catch ( SettingException &sttng_xcptn ) { |
---|
182 | string msg = "UIException: method "; |
---|
183 | msg += class_name; |
---|
184 | msg += ".to_setting(Setting&) has thrown a SettingException."; |
---|
185 | throw UISettingException ( msg, sttng_xcptn.getPath() ); |
---|
186 | } |
---|
187 | } |
---|
188 | |
---|
189 | void UI::save ( const root &instance, Setting &element, const string &name ) { |
---|
190 | Setting &set = ( name == "" ) ? (element.getType()==Setting::TypeArray || element.getType()==Setting::TypeList) ? element.add ( Setting::TypeGroup ) : element |
---|
191 | : element.add ( name, Setting::TypeGroup ); |
---|
192 | |
---|
193 | call_to_setting( instance, set ); |
---|
194 | } |
---|
195 | |
---|
196 | void UI::save ( const log_level_base &log_level, Setting &element ) { |
---|
197 | assert_type ( element, Setting::TypeGroup ); |
---|
198 | string name = "log_level"; |
---|
199 | |
---|
200 | if( element.exists( name ) ) |
---|
201 | assert_type ( element[name], Setting::TypeString ); |
---|
202 | else |
---|
203 | element.add ( name, Setting::TypeString ); |
---|
204 | |
---|
205 | call_to_setting( log_level, element[name] ); |
---|
206 | } |
---|
207 | |
---|
208 | void UI::save ( const root * const instance, Setting &element, const string &name ) { |
---|
209 | Setting &set = ( name == "" ) ? (element.getType()==Setting::TypeArray || element.getType()==Setting::TypeList) ? element.add ( Setting::TypeGroup ) : element |
---|
210 | : element.add ( name, Setting::TypeGroup ); |
---|
211 | |
---|
212 | // add attribute "class" |
---|
213 | const string &class_name = MappedUI::retrieve_class_name ( &typeid ( *instance ) ); |
---|
214 | Setting &type = set.add ( "class", Setting::TypeString ); |
---|
215 | type = class_name; |
---|
216 | |
---|
217 | call_to_setting( *instance, set, class_name ); |
---|
218 | } |
---|
219 | |
---|
220 | void UI::save ( const int &integer, Setting &element, const string &name ) { |
---|
221 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeInt ) |
---|
222 | : element.add ( name, Setting::TypeInt ); |
---|
223 | set = integer; |
---|
224 | } |
---|
225 | |
---|
226 | void UI::save ( const double &real, Setting &element, const string &name ) { |
---|
227 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeFloat ) |
---|
228 | : element.add ( name, Setting::TypeFloat ); |
---|
229 | set = real; |
---|
230 | } |
---|
231 | |
---|
232 | void UI::save ( const string &str, Setting &element, const string &name ) { |
---|
233 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeString ) |
---|
234 | : element.add ( name, Setting::TypeString ); |
---|
235 | set = str; |
---|
236 | } |
---|
237 | |
---|
238 | void UI::save ( const mat &matrix, Setting &element, const string &name ) { |
---|
239 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeList ) |
---|
240 | : element.add ( name, Setting::TypeList ); |
---|
241 | |
---|
242 | Setting &tag = set.add ( Setting::TypeString ); |
---|
243 | tag = "matrix"; |
---|
244 | |
---|
245 | Setting &rows = set.add ( Setting::TypeInt ); |
---|
246 | rows = matrix.rows(); |
---|
247 | |
---|
248 | Setting &cols = set.add ( Setting::TypeInt ); |
---|
249 | cols = matrix.cols(); |
---|
250 | |
---|
251 | Setting &elements = set.add ( Setting::TypeArray ); |
---|
252 | |
---|
253 | // build matrix row-wise |
---|
254 | for ( int i = 0; i < matrix.rows(); i++ ) |
---|
255 | for ( int j = 0; j < matrix.cols(); j++ ) { |
---|
256 | Setting &new_field = elements.add ( Setting::TypeFloat ); |
---|
257 | new_field = matrix ( i, j ); |
---|
258 | } |
---|
259 | } |
---|
260 | |
---|
261 | void UI::save ( const ldmat &matrix, Setting &element, const string &name ) { |
---|
262 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeGroup) |
---|
263 | : element.add ( name, Setting::TypeGroup ); |
---|
264 | |
---|
265 | save (matrix._L(), set, "L"); |
---|
266 | save (matrix._D(), set, "D"); |
---|
267 | } |
---|
268 | |
---|
269 | void UI::save ( const ivec &vector, Setting &element, const string &name ) { |
---|
270 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeArray ) |
---|
271 | : element.add ( name, Setting::TypeArray ); |
---|
272 | for ( int i = 0; i < vector.length(); i++ ) { |
---|
273 | Setting &new_field = set.add ( Setting::TypeInt ); |
---|
274 | new_field = vector ( i ); |
---|
275 | } |
---|
276 | } |
---|
277 | |
---|
278 | void UI::save ( const vec &vector, Setting &element, const string &name ) { |
---|
279 | Setting &set = ( name == "" ) ? element.add ( Setting::TypeArray ) |
---|
280 | : element.add ( name, Setting::TypeArray ); |
---|
281 | for ( int i = 0; i < vector.length(); i++ ) { |
---|
282 | Setting &new_field = set.add ( Setting::TypeFloat ); |
---|
283 | new_field = vector ( i ); |
---|
284 | } |
---|
285 | } |
---|
286 | |
---|
287 | |
---|
288 | void UI::call_from_setting( root &instance, const Setting &set, string class_name) { |
---|
289 | try { |
---|
290 | instance.from_setting ( set ); |
---|
291 | } catch ( SettingException &sttng_xcptn ) { |
---|
292 | string msg = "UIException: method "; |
---|
293 | msg += class_name; |
---|
294 | msg += ".from_setting(Setting&) has thrown a SettingException."; |
---|
295 | throw UISettingException ( msg, sttng_xcptn.getPath() ); |
---|
296 | } catch ( std::runtime_error &e ) { |
---|
297 | string msg = "UIException: method "; |
---|
298 | msg += class_name; |
---|
299 | msg += " says: "; |
---|
300 | msg += e.what(); |
---|
301 | throw UISettingException ( msg, set ); |
---|
302 | } |
---|
303 | |
---|
304 | // validate the new instance |
---|
305 | instance.validate(); |
---|
306 | } |
---|
307 | |
---|
308 | void UI::from_setting ( log_level_base &log_level, const Setting &element ) { |
---|
309 | assert_type( element, Setting::TypeString ); |
---|
310 | call_from_setting( log_level, element ); |
---|
311 | } |
---|
312 | |
---|
313 | void UI::from_setting ( root &instance, const Setting &element ) { |
---|
314 | const SettingResolver link ( element ); |
---|
315 | assert_type( link.result, Setting::TypeGroup ); |
---|
316 | call_from_setting( instance, link.result); |
---|
317 | } |
---|
318 | |
---|
319 | void UI::from_setting ( mat& matrix, const Setting &element ) { |
---|
320 | const SettingResolver link ( element ); |
---|
321 | |
---|
322 | if ( link.result.isNumber() ) { |
---|
323 | matrix.set_size ( 1, 1 ); |
---|
324 | matrix ( 0, 0 ) = link.result; |
---|
325 | return; |
---|
326 | } |
---|
327 | |
---|
328 | if ( link.result.isList() ) { |
---|
329 | int data_offset; |
---|
330 | |
---|
331 | if ( link.result.getLength() == 3 ) |
---|
332 | data_offset = 0; |
---|
333 | else if ( link.result.getLength() == 4 ) { |
---|
334 | assert_type ( link.result[0], Setting::TypeString ); |
---|
335 | const char* elem1 = ( const char* ) link.result[0]; |
---|
336 | if ( ( strcmp ( elem1, "matrix" ) ) ) |
---|
337 | throw UISettingException ( "UIException: the setting supposed to represent a matrix element has wrong syntax.", link.result ); |
---|
338 | |
---|
339 | data_offset = 1; |
---|
340 | } else |
---|
341 | throw UISettingException ( "UIException: the setting supposed to represent a matrix element has wrong syntax.", link.result ); |
---|
342 | |
---|
343 | Setting &rows_setting = link.result[0 + data_offset]; |
---|
344 | Setting &cols_setting = link.result[1 + data_offset]; |
---|
345 | Setting &elements = link.result[2 + data_offset]; |
---|
346 | |
---|
347 | // vvv ----- not working in matlab!! |
---|
348 | //assert_type ( cols_setting, Setting::TypeInt ); |
---|
349 | //assert_type ( rows_setting, Setting::TypeInt ); |
---|
350 | //assert_type ( elements, Setting::TypeArray ); |
---|
351 | |
---|
352 | int cols = cols_setting; |
---|
353 | int rows = rows_setting; |
---|
354 | int elems = elements.getLength(); |
---|
355 | |
---|
356 | if ( cols < 0 || rows < 0 ) |
---|
357 | throw UISettingException ( "UIException: the dimensions of a matrix has to be non-negative.", link.result ); |
---|
358 | |
---|
359 | if ( elems != cols * rows ) |
---|
360 | throw UISettingException ( "UIException: the count of the matrix elements is incompatible with matrix dimension.", elements ); |
---|
361 | |
---|
362 | matrix.set_size ( rows, cols ); |
---|
363 | |
---|
364 | if ( cols == 0 || rows == 0 ) |
---|
365 | return; |
---|
366 | |
---|
367 | if ( !elements[0].isNumber() ) |
---|
368 | throw UISettingException ( "UIException: matrix elements have to be numbers.", elements[0] ); |
---|
369 | |
---|
370 | // build matrix row-wise |
---|
371 | int k = 0; |
---|
372 | for ( int i = 0; i < rows; i++ ) |
---|
373 | for ( int j = 0; j < cols; j++ ) |
---|
374 | matrix ( i, j ) = elements[k++]; |
---|
375 | return; |
---|
376 | } |
---|
377 | |
---|
378 | throw UISettingException ( "UIException: only numeric types or TypeList are supported as matrix values.", link.result ); |
---|
379 | } |
---|
380 | |
---|
381 | void UI::from_setting ( ldmat& matrix, const Setting &element ) { |
---|
382 | if(element.exists("L")) { |
---|
383 | UI::from_setting(matrix.__L(), element["L"]); |
---|
384 | } else { |
---|
385 | throw UISettingException ( "UIException: ldmat must contain matrix L.", element); |
---|
386 | } |
---|
387 | if(element.exists("D")) { |
---|
388 | UI::from_setting(matrix.__D(), element["D"]); |
---|
389 | } else { |
---|
390 | throw UISettingException ( "UIException: ldmat must contain vector D.", element); |
---|
391 | } |
---|
392 | matrix.validate(); |
---|
393 | } |
---|
394 | |
---|
395 | void UI::from_setting ( vec &vector, const Setting &element ) { |
---|
396 | const SettingResolver link ( element ); |
---|
397 | |
---|
398 | if ( link.result.isNumber() ) { |
---|
399 | vector.set_length ( 1 ); |
---|
400 | vector ( 0 ) = link.result; |
---|
401 | return; |
---|
402 | } |
---|
403 | |
---|
404 | if ( link.result.isList() ) { |
---|
405 | mat matrix; |
---|
406 | from_setting ( matrix, link.result ); |
---|
407 | |
---|
408 | if ( matrix.cols() != 1 && matrix.rows() != 1 && matrix.cols() != 0 ) |
---|
409 | throw UISettingException ( "UIException: the vector length is invalid, it seems to be rather a matrix.", link.result ); |
---|
410 | |
---|
411 | int len = matrix.rows() * matrix.cols(); |
---|
412 | vector.set_length ( len ); |
---|
413 | if ( len == 0 ) return; |
---|
414 | |
---|
415 | if ( matrix.cols() == 1 ) |
---|
416 | for ( int i = 0; i < len; i++ ) |
---|
417 | vector ( i ) = matrix ( i, 0 ); |
---|
418 | else |
---|
419 | for ( int i = 0; i < len; i++ ) |
---|
420 | vector ( i ) = matrix ( 0, i ); |
---|
421 | return; |
---|
422 | } |
---|
423 | |
---|
424 | if ( link.result.isArray() ) { |
---|
425 | int len = link.result.getLength(); |
---|
426 | vector.set_length ( len ); |
---|
427 | if ( len == 0 ) return; |
---|
428 | |
---|
429 | if ( !link.result[0].isNumber() ) |
---|
430 | throw UISettingException ( "UIException: a vector element has to be a number.", link.result[0] ); |
---|
431 | |
---|
432 | for ( int i = 0; i < len; i++ ) |
---|
433 | vector ( i ) = link.result[i]; |
---|
434 | |
---|
435 | return; |
---|
436 | } |
---|
437 | |
---|
438 | throw UISettingException ( "UIException: only numeric types, TypeArray or TypeList are supported as vector values.", link.result ); |
---|
439 | } |
---|
440 | |
---|
441 | void UI::from_setting ( ivec &vector, const Setting &element ) { |
---|
442 | vec double_vector; |
---|
443 | from_setting ( double_vector, element ); |
---|
444 | int len = double_vector.length(); |
---|
445 | vector.set_length ( len ); |
---|
446 | for ( int i = 0; i < len; i++ ) |
---|
447 | vector ( i ) = ( int ) double_vector ( i ); |
---|
448 | } |
---|
449 | |
---|
450 | void UI::from_setting ( string &str, const Setting &element ) { |
---|
451 | assert_type ( element, Setting::TypeString ); |
---|
452 | str = ( const char* ) element; |
---|
453 | } |
---|
454 | |
---|
455 | void UI::from_setting ( int &integer, const Setting &element ) { |
---|
456 | // assert_type ( element, Setting::TypeInt ); |
---|
457 | integer = element; |
---|
458 | } |
---|
459 | |
---|
460 | void UI::from_setting ( double &real, const Setting &element ) { |
---|
461 | // assert_type ( element, Setting::TypeFloat ); |
---|
462 | real = element; |
---|
463 | } |
---|
464 | |
---|
465 | }//namespace |
---|