Changeset 394 for library/bdm/base/user_info.cpp

Timestamp:

06/22/09 13:10:28 (15 years ago)

Author:

mido

Message:

1) UI_File renamed to UIFile
2) part UI's documentation
3) stat/mixtures.h renamed to stat/emix.h and related changes applied

Files:

• library/bdm/base/user_info.cpp (modified) (17 diffs)

library/bdm/base/user_info.cpp

@@ -15 +15 @@
 namespace bdm
 {
-///////////////////////// UI FILE /////////////////////////////////////////////
-
-UI_File::UI_File ()
-{
-    setAutoConvert( true );
-}
-
-//! loads root element from a file
-UI_File::UI_File ( const string &file_name )
+///////////////////////////// Class UIFile /////////////////////////////////////////////
+
+UIFile::UIFile()
+{
+}
+
+UIFile::UIFile ( const string &file_name )
 {
     try
     {
         readFile( file_name.c_str()  );
-        setAutoConvert( true );
+                // this flag has to be set AFTER each file load, that is why it is right here
+                setAutoConvert( true );
     }
     catch ( FileIOException f )
@@ -43 +42 @@
 
 
-//! save UserInfo to the file (typically with an XML extension)
-void UI_File::save(  const string &file_name )
+void UIFile::save(const string &file_name )
 {
     try
@@ -56 +54 @@
 }
 
-UI_File::operator Setting&()
+UIFile::operator Setting&()
 {
     return getRoot();
 }
-///////////////////////// INTERNAL MAPPED_UI /////////////////////////////////////////////
-
-UI::Mapped_UI::String_To_UI_Map& UI::Mapped_UI::mapped_strings()
-{
-    static String_To_UI_Map var;
+
+///////////////////////////// Class UI::MappedUI /////////////////////////////////////////////
+
+UI::MappedUI::StringToUIMap& UI::MappedUI::mapped_strings()
+{
+        // this way it is ensured that there is only one instance of StringTpUIMap, and 
+        // what is more, this declaration leaves its allocation/deallocation on the compiler
+    static StringToUIMap var;
     return var;
 }
 
-UI::Mapped_UI::Type_Info_To_String_Map& UI::Mapped_UI::mapped_type_infos()
-{
-    static Type_Info_To_String_Map var;
+UI::MappedUI::TypeInfoToStringMap& UI::MappedUI::mapped_type_infos()
+{
+        // this way it is ensured that there is only one instance of TypeInfoToStringMap, and 
+        // what is more, this declaration leaves its allocation/deallocation on the compiler
+    static TypeInfoToStringMap var;
     return var;
 }
 
-void UI::Mapped_UI::add_class( const string &class_name, const type_info * const class_type_info, const UI* const ui )
+void UI::MappedUI::add_class( const string &class_name, const type_info * const class_type_info, const UI* const ui )
 {
     pair< const string, const UI* const > new_pair = make_pair( class_name, ui );
@@ -81 +84 @@
 }
 
-const UI& UI::Mapped_UI::retrieve_ui( const string &class_name )
-{
-    String_To_UI_Map::const_iterator iter = mapped_strings().find( class_name );
+void UI::MappedUI::unregistered_class_error( const string &unregistered_class_name )
+{
+        stringstream msg;
+    msg << "UI error: class " + unregistered_class_name + " was not properly registered. Use the macro ""UIREGISTER([class name]);"" within your code." << endl;
+
+        if( mapped_strings().size() )
+        {
+            StringToUIMap::const_iterator iter = mapped_strings().begin();
+                msg << "These classes are already registered: " << iter->first;
+                for(; iter != mapped_strings().end(); iter++)
+                        msg << ", " << iter->first;
+                msg << "." << endl;
+        }                       
+        else
+                msg << "There is not any registered class yet!" << endl;
+        
+    it_error ( msg.str() );             
+}
+
+const UI& UI::MappedUI::retrieve_ui( const string &class_name )
+{
+    StringToUIMap::const_iterator iter = mapped_strings().find( class_name );
     if ( iter == mapped_strings().end())
-                // TODO dat sem vypis seznamu registrovanych trid
-        it_error ( "UI error: class " + class_name + " was not properly registered. Use the macro ""UIREGISTER([class name]);"" within your code." );
-    return *iter->second;
-}
-
-const string& UI::Mapped_UI::retrieve_class_name( const type_info * const class_type_info )
-{
-    Type_Info_To_String_Map::const_iterator iter = mapped_type_infos().find( class_type_info );
+                unregistered_class_error( class_name );
+            
+        return *iter->second;
+}
+
+const string& UI::MappedUI::retrieve_class_name( const type_info * const class_type_info )
+{
+    TypeInfoToStringMap::const_iterator iter = mapped_type_infos().find( class_type_info );
     if ( iter == mapped_type_infos().end())
-        it_error ( "UI error: class with RTTI name " + string(class_type_info->name()) + " was not properly registered. Use the macro ""UIREGISTER([class name]);"" within your code." );
+                unregistered_class_error( "with RTTI name " + string(class_type_info->name()) );
     return iter->second;
 }
 
-///////////////////////// INTERNAL LINK EXPANDER /////////////////////////////////////////////
-
-UI::SettingResolver::SettingResolver( const Setting &potential_link ): result( initialize_reference( file, potential_link ) )
-{
-}
-
-const Setting& UI::SettingResolver::initialize_reference(UI_File *&file, const Setting &potential_link)
+///////////////////////////// Class UI::SettingResolver /////////////////////////////////////////////
+
+UI::SettingResolver::SettingResolver( const Setting &potential_link )
+        : result( initialize_reference( file, potential_link ) )
+{
+}
+
+const Setting& UI::SettingResolver::initialize_reference(UIFile *&file, const Setting &potential_link)
 {
         file = NULL;
@@ -118 +141 @@
     {
         string file_name = link.substr( aerobase + 1, link.length() );
-        file = new UI_File( file_name );
+        file = new UIFile( file_name );
         result = &(Setting&)(*file);
         link = link.substr( 0, aerobase );
@@ -130 +153 @@
 
     if ( !result->exists( link ) )
-        ui_error( "linked Setting was not found", potential_link );
+        ui_error( "linked setting was not found", potential_link );
 
     return (*result)[link];
@@ -140 +163 @@
 }
 
-///////////////////////// UI /////////////////////////////////////////////
+///////////////////////////// Class UI /////////////////////////////////////////////
 
 void UI::ui_error( string message, const Setting &element )
@@ -149 +172 @@
 }
 
-//! This methods - kvuli ukladani pole stringu, dat jen privatne?
-void UI::save( const string &str, Setting &element )
-{
-    Setting &set = element.add( Setting::TypeString );
+const Setting& UI::to_child_setting( const Setting &element, const int index )
+{
+    if ( !element.isList())
+        ui_error( "only TypeList elements could be indexed by integers", element );
+
+    if ( element.getLength() <= index )
+        ui_error( "there is not any child with index " + index, element );
+
+    return element[index];
+}
+
+const Setting& UI::to_child_setting( const Setting &element, const string &name )
+{
+    if ( !element.isGroup())
+        ui_error( "only TypeGroup elements could be indexed by strings", element );
+
+    if ( !element.exists( name ) )
+        ui_error( "there is not any child named """ + name, element );
+
+    return element[name];
+}
+
+void UI::save( const int &integer, Setting &element, const string &name)
+{
+    Setting &set = (name == "") ? element.add( Setting::TypeInt )
+                                            : element.add( name, Setting::TypeInt );
+    set = integer;
+}
+
+void UI::save( const double &real, Setting &element, const string &name)
+{
+    Setting &set = (name == "") ? element.add( Setting::TypeFloat )
+                                            : element.add( name, Setting::TypeFloat );
+    set = real;
+}
+
+void UI::save( const string &str, Setting &element, const string &name)
+{
+    Setting &set = (name == "") ? element.add( Setting::TypeString )
+                                            : element.add( name, Setting::TypeString );
     set = str;
 }
@@ -158 +217 @@
 void UI::save( const mat &matrix, Setting &element, const string &name)
 {
-
     Setting &set = (name == "") ? element.add( Setting::TypeList )
-                    : element.add( name, Setting::TypeList );
+                                            : element.add( name, Setting::TypeList );
 
     Setting &cols = set.add( Setting::TypeInt );
@@ -179 +237 @@
 }
 
-
-//! This methods tries to save a integer vector
 void UI::save( const ivec &vector, Setting &element, const string &name)
 {
-
     Setting &set = (name == "") ? element.add( Setting::TypeArray )
                     : element.add( name, Setting::TypeArray );
@@ -193 +248 @@
 }
 
-
-//! This methods tries to save a double vector
 void UI::save( const vec &vector, Setting &element, const string &name)
 {
@@ -205 +258 @@
     }
 }
-
-
-//! This methods tries to build a new double matrix
 
 void UI::from_setting( mat& matrix, const Setting &element )
@@ -274 +324 @@
 }
 
-//! This methods tries to build a new integer vector
 void UI::from_setting( ivec &vector, const Setting &element )
 {
@@ -301 +350 @@
                 Setting &elements = link.result[2];
         // ASSERT_UITYPE(elements[0],TypeInt); -- spolehame an autoconvert
-
 
         if ( matrix.cols() == 1 )
@@ -328 +376 @@
 }
 
-//! This methods tries to build a new double vector
 void UI::from_setting( vec &vector, const Setting &element )
 {
@@ -379 +426 @@
 }
 
-
 void UI::from_setting( string &str, const Setting &element )
 {
@@ -386 +432 @@
 }
 
-
-///////////////////////// UI FILE /////////////////////////////////////////////
-//! This methods tries to save an instance of type T (or some of its descendant types)
-//! and build DOM tree accordingly. Then, it creates a new DOMNode named according class_name
-//! and connecti it to the passed Setting as a new child node.
-const Setting& UI::to_child_setting( const Setting &element, const int index )
-{
-    if ( !element.isList())
-        ui_error( "only TypeList elements could be indexed by integers", element );
-
-    if ( element.getLength() <= index )
-        ui_error( "there is not any child with index " + index, element );
-
-    return element[index];
-}
-
-const Setting& UI::to_child_setting( const Setting &element, const string &name )
-{
-    ASSERT_UITYPE(element,TypeGroup);
-    if ( !element.exists( name ) )
-        ui_error( "there is not any child named """ + name, element );
-    return element[name];
-}
-
-
-}
-
+void UI::from_setting( int &integer, const Setting &element )
+{
+    ASSERT_UITYPE(element,TypeInt);
+    integer = element;
+}
+
+void UI::from_setting( double &real, const Setting &element )
+{
+    ASSERT_UITYPE(element,TypeFloat);
+    real = element;
+}
+
+}