root/library/bdm/base/user_info.cpp @ 565

Revision 565, 11.2 kB (checked in by vbarta, 15 years ago)

using own error macros (basically copied from IT++, but never aborting)

  • Property svn:eol-style set to native
Line 
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
15namespace bdm {
16
17string 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
26UIFile::UIFile() {
27}
28
29UIFile::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
47void 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
58UIFile::operator Setting&() {
59        return getRoot();
60}
61
62///////////////////////////// Class UI::MappedUI /////////////////////////////////////////////
63
64UI::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
71UI::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
78void 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
89void 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
105const 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
113const 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
122SettingResolver::SettingResolver ( const Setting &potential_link )
123                : result ( initialize_reference ( file, potential_link ) ) {
124}
125
126const 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
153SettingResolver::~SettingResolver() {
154        if ( file ) delete file;
155}
156
157///////////////////////////// Class UI /////////////////////////////////////////////
158
159void UI::assert_type ( const Setting &element, Setting::Type type ) {
160        if ( element.getType() != type )
161                throw UISettingException ( "UIException: wrong setting type.", element );
162}
163
164const 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
171const 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
178void UI::save ( const int &integer, Setting &element, const string &name ) {
179        Setting &set = ( name == "" ) ? element.add ( Setting::TypeInt )
180                       : element.add ( name, Setting::TypeInt );
181        set = integer;
182}
183
184void UI::save ( const double &real, Setting &element, const string &name ) {
185        Setting &set = ( name == "" ) ? element.add ( Setting::TypeFloat )
186                       : element.add ( name, Setting::TypeFloat );
187        set = real;
188}
189
190void UI::save ( const string &str, Setting &element, const string &name ) {
191        Setting &set = ( name == "" ) ? element.add ( Setting::TypeString )
192                       : element.add ( name, Setting::TypeString );
193        set = str;
194}
195
196void UI::save ( const mat &matrix, Setting &element, const string &name ) {
197        Setting &set = ( name == "" ) ? element.add ( Setting::TypeList )
198                       : element.add ( name, Setting::TypeList );
199
200        Setting &cols = set.add ( Setting::TypeInt );
201        cols = matrix.cols();
202
203        Setting &rows = set.add ( Setting::TypeInt );
204        rows = matrix.rows();
205
206        Setting &elements = set.add ( Setting::TypeArray );
207
208        // build matrix row-wise
209        for ( int i = 0; i < matrix.rows(); i++ )
210                for ( int j = 0; j < matrix.cols(); j++ ) {
211                        Setting &new_field = elements.add ( Setting::TypeFloat );
212                        new_field = matrix ( i, j );
213                }
214}
215
216void UI::save ( const ivec &vector, Setting &element, const string &name ) {
217        Setting &set = ( name == "" ) ? element.add ( Setting::TypeArray )
218                       : element.add ( name, Setting::TypeArray );
219        for ( int i = 0; i < vector.length(); i++ ) {
220                Setting &new_field = set.add ( Setting::TypeInt );
221                new_field = vector ( i );
222        }
223}
224
225void UI::save ( const vec &vector, Setting &element, const string &name ) {
226        Setting &set = ( name == "" ) ? element.add ( Setting::TypeArray )
227                       : element.add ( name, Setting::TypeArray );
228        for ( int i = 0; i < vector.length(); i++ ) {
229                Setting &new_field = set.add ( Setting::TypeFloat );
230                new_field = vector ( i );
231        }
232}
233
234void UI::from_setting ( mat& matrix, const Setting &element ) {
235        const SettingResolver link ( element );
236
237        if ( link.result.isNumber() ) {
238                matrix.set_size ( 1, 1 );
239                matrix ( 0, 0 ) = link.result;
240                return;
241        }
242
243        if ( link.result.isList() ) {
244                int data_offset;
245
246                if ( link.result.getLength() == 3 )
247                        data_offset = 0;
248                else if ( link.result.getLength() == 4 ) {
249                        assert_type ( link.result[0], Setting::TypeString );
250                        const char* elem1 = ( const char* ) link.result[0];
251                        if ( ( strcmp ( elem1, "matrix" ) ) )
252                                throw UISettingException ( "UIException: the setting supposed to represent a matrix element has wrong syntax.", link.result );
253
254                        data_offset = 1;
255                } else
256                        throw UISettingException ( "UIException: the setting supposed to represent a matrix element has wrong syntax.", link.result );
257
258                Setting &rows_setting = link.result[0 + data_offset];
259                Setting &cols_setting = link.result[1 + data_offset];
260                Setting &elements = link.result[2 + data_offset];
261
262                assert_type ( cols_setting, Setting::TypeInt );
263                assert_type ( rows_setting, Setting::TypeInt );
264                assert_type ( elements, Setting::TypeArray );
265
266                int cols = cols_setting;
267                int rows = rows_setting;
268
269                if ( cols < 0 || rows < 0 )
270                        throw UISettingException ( "UIException: the dimensions of a matrix has to be non-negative.", link.result );
271
272                if ( elements.getLength() != cols * rows )
273                        throw UISettingException ( "UIException: the count of the matrix elements is incompatible with matrix dimension.", elements );
274
275                matrix.set_size ( rows, cols );
276
277                if ( cols == 0 || rows == 0 )
278                        return;
279
280                if ( !elements[0].isNumber() )
281                        throw UISettingException ( "UIException: matrix elements have to be numbers.", elements[0] );
282
283                // build matrix row-wise
284                int k = 0;
285                for ( int i = 0; i < rows; i++ )
286                        for ( int j = 0; j < cols; j++ )
287                                matrix ( i, j ) = elements[k++];
288                return;
289        }
290
291        throw UISettingException ( "UIException: only numeric types or TypeList are supported as matrix values.", link.result );
292}
293
294void UI::from_setting ( vec &vector, const Setting &element ) {
295        const SettingResolver link ( element );
296
297        if ( link.result.isNumber() ) {
298                vector.set_length ( 1 );
299                vector ( 0 ) = link.result;
300                return;
301        }
302
303        if ( link.result.isList() ) {
304                mat matrix;
305                from_setting ( matrix, link.result );
306
307                if ( matrix.cols() != 1 && matrix.rows() != 1 )
308                        throw UISettingException ( "UIException: the vector length is invalid, it seems to be rather a matrix.", link.result );
309
310                int len = matrix.rows() * matrix.cols();
311                vector.set_length ( len );
312                if ( len == 0 ) return;
313
314                if ( matrix.cols() == 1 )
315                        for ( int i = 0; i < len; i++ )
316                                vector ( i ) = matrix ( i, 0 );
317                else
318                        for ( int i = 0; i < len; i++ )
319                                vector ( i ) = matrix ( 0, i );
320                return;
321        }
322
323        if ( link.result.isArray() ) {
324                int len = link.result.getLength();
325                vector.set_length ( len );
326                if ( len == 0 ) return;
327
328                if ( !link.result[0].isNumber() )
329                        throw UISettingException ( "UIException: a vector element has to be a number.", link.result[0] );
330
331                for ( int i = 0; i < len; i++ )
332                        vector ( i ) = link.result[i];
333
334                return;
335        }
336
337        throw UISettingException ( "UIException: only numeric types, TypeArray or TypeList are supported as vector values.", link.result );
338}
339
340void UI::from_setting ( ivec &vector, const Setting &element ) {
341        vec double_vector;
342        from_setting ( double_vector, element );
343        int len = double_vector.length();
344        vector.set_length ( len );
345        for ( int i = 0; i < len; i++ )
346                vector ( i ) = ( int ) double_vector ( i );
347}
348
349void UI::from_setting ( string &str, const Setting &element ) {
350        assert_type ( element, Setting::TypeString );
351        str = ( const char* ) element;
352}
353
354void UI::from_setting ( int &integer, const Setting &element ) {
355//      assert_type ( element, Setting::TypeInt );
356        integer = element;
357}
358
359void UI::from_setting ( double &real, const Setting &element ) {
360//      assert_type ( element, Setting::TypeFloat );
361        real = element;
362}
363
364}
Note: See TracBrowser for help on using the browser.