Changeset 870 for library/bdm/bdmroot.h

Timestamp:

03/18/10 19:13:02 (14 years ago)

Author:

mido

Message:

LOG_LEVEL final cut (or rather semifinal? I hope to improve work with ids soon)
and also it rests to adapt applications, work is in progress

Files:

• library/bdm/bdmroot.h (modified) (5 diffs)

library/bdm/bdmroot.h

@@ -38 +38 @@
 void UI_DBG (const Setting &S, const string &spc, ostream &out );
         
-//! level of details that will be logged to a logger
-// DULEZITE TODO - zde musi respektovat aktualne ulozene hodnoty, tj. nacist je, pak pridat
-// ty co se maji v tomto kroku ulozit a pak vse ulozit.. protoze to delame kompozici a ne dedenim  DODELAT
-// ALE HOUBY, TAKHLE TO NEJDE, musime nechat jako samostatny objekt, kazda uroven tedy zvlast, 
-// jednoznacne jmeno atd.. 
-//
-//! information about connection to a logger
-template<class T> class logged_options {
+//! This class stores a details that will be logged to a logger
+template<class T> class log_level_template {
 private:
+        // UserInfo class have to be able to read all the internal 
+        // attributes to be able to write/read log_level to/from a Setting structure
         friend class UI;
 
@@ -52 +48 @@
         bitset<32> values;
 
+        //! string equivalents of the used enumerations which are filled with a help of #LOG_LEVEL macro within class T
         const Array<string> &names() const
         {
-                return T::option_names();
+                return T::log_level_names();
         }
 
 public:
         
+        //! a general utility transforming a comma-separated sequence of strings into an instance of Array<strings>
+        static Array<string> string2Array( const string &input )
+        {
+                string result = input;
+                string::size_type loc;
+                while( loc = result.find( ',' ), loc != string::npos )
+                        result[loc] = ' ';
+                return Array<string>("{ " + result + " }" );
+        }
+
+        //! is any field of log_level active?
         bool any() const
         {
@@ -64 +72 @@
         }
 
-        bool operator [] (const enum T::possible_options &option ) const
-        {
-                return values[option];
-        }
-
-        bitset<32>::reference operator [] (const enum T::possible_options &option )
-        {
-                return values[option];
+        //! read only operator for testing  individual fields of log_level
+        //!
+        //! it is necessary to acces it with a proper enumeration type, thus this approach is type-safe
+        bool operator [] (const enum T::log_level_enums &log_level ) const
+        {
+                return values[log_level];
+        }
+
+        //! operator for setting an individual field of log_level 
+        //!
+        //! it is necessary to acces it with a proper enumeration type, thus this approach is type-safe
+        bitset<32>::reference operator [] (const enum T::log_level_enums &log_level )
+        {
+                return values[log_level];
         }
 };
 
-// MUZEME INTERNE POUZIVAT ENUMY, A KLIDNE MENIT JEJICH PORADI, DIKY TOMUHLE MAKRU SE VZDY NAMAPUJI NA TY SPRAVNE STRINGY 
-#define LOG_LEVEL(CLASSNAME,...) private: friend class logged_options<CLASSNAME>; static const Array<string> &option_names() { static const Array<string> option_names( "{"#__VA_ARGS__" }" ); return option_names; }; public: enum possible_options { __VA_ARGS__ }; logged_options<CLASSNAME> log_level;
+/*!
+  \def LOG_LEVEL(classname,...)
+  \brief Macro for defining a log_level attribute with a specific set of enumerations related to a specific class 
+
+  This macro has to be called within a class declaration. Its argument \a classname has to correspond to that wrapping class.
+  This macro defines a log_level instance which can be modified either directly or by the means of #UI class.
+
+  One of the main purposes of this macro is to allow variability in using enumerations. By relating them to their names through
+  an array of strings, we are no more dependant on their precise ordering. What is more, we can add or remove any without harming 
+  any applications which are using this library.
+
+  \todo Write a more detailed explanation including also examples
+
+  \ref ui
+*/
+#define LOG_LEVEL(classname,...) public: enum log_level_enums { __VA_ARGS__ }; log_level_template<classname> log_level; private: friend class log_level_template<classname>; static const Array<string> &log_level_names() { static const Array<string> log_level_names = log_level_template<classname>::string2Array( #__VA_ARGS__ ); return log_level_names; }
 
 //forward declaration
@@ -99 +127 @@
         friend class UI;
 
-        // TODO okomentovat
-        static const Array<string> &option_names() 
+        //! This method is a dummy method closely related to to the #LOG_LEVEL macro, do not remove it
+        static const string &log_level_names() 
         { 
-                static const Array<string> option_names; 
-                return option_names; 
+                static const string log_level_names; 
+                return log_level_names; 
         }; 
 
@@ -189 +217 @@
 
 public:
-        // TODO okomentovat
-        enum possible_options { };
+        //! This enumeration defines all possible options specifing the level of details logged by a logger about this specific class 
+        //! 
+        //! It has to be reimplemented in descendant classes using the #LOG_LEVEL macro
+        enum log_level_enums { };
 
         //!default constructor