flags extension

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@23146 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/flags.h

@@ -16,36 +16,34 @@
 #pragma interface "flags.h"
 #endif
 
-#include <bitset>
+// wxBitset should be applied to an enum, then this can be used like
-
-// wxFlags should be applied to an enum, then this can be used like
 // bitwise operators but keeps the type safety and information, the
 // enums must be in a sequence , their value determines the bit position
 // that they represent
 // The api is made as close as possible to <bitset> 
 
-template <class T> class wxFlags
+template <class T> class wxBitset
 {
 	friend class wxEnumData ;
 public:
-    // creates a wxFlags<> object with all flags initialized to 0
+    // creates a wxBitset<> object with all flags initialized to 0
-    wxFlags() { m_data = 0; }
+    wxBitset() { m_data = 0; }
 
-    // created a wxFlags<> object initialized according to the bits of the 
+    // created a wxBitset<> object initialized according to the bits of the 
     // integral value val
-    wxFlags(unsigned long val) { m_data = val ; }
+    wxBitset(unsigned long val) { m_data = val ; }
 
-    // copies the content in the new wxFlags<> object from another one
+    // copies the content in the new wxBitset<> object from another one
-    wxFlags(const wxFlags &src) { m_data = src.m_data; }
+    wxBitset(const wxBitset &src) { m_data = src.m_data; }
 
-    // creates a wxFlags<> object that has the specific flag set
+    // creates a wxBitset<> object that has the specific flag set
-    wxFlags(const T el) { m_data |= 1 << el; }
+    wxBitset(const T el) { m_data |= 1 << el; }
 
     // returns the integral value that the bits of this object represent
     unsigned long to_ulong() const { return m_data ; }
 
     // assignment
-    wxFlags &operator =(const wxFlags &rhs)
+    wxBitset &operator =(const wxBitset &rhs)
     {
 		m_data = rhs.m_data;
 		return *this;
@@ -53,7 +51,7 @@ public:
 
     // bitwise or operator, sets all bits that are in rhs and leaves
     // the rest unchanged
-    wxFlags &operator |=(const wxFlags &rhs) 
+    wxBitset &operator |=(const wxBitset &rhs) 
     {
 		m_data |= rhs.m_data;
 		return *this;
@@ -61,7 +59,7 @@ public:
 
     // bitwsie exclusive-or operator, toggles the value of all bits
     // that are set in bits and leaves all others unchanged
-    wxFlags &operator ^=(const wxFlags &rhs) // difference
+    wxBitset &operator ^=(const wxBitset &rhs) // difference
     {
 		m_data ^= rhs.m_data;
 		return *this;
@@ -69,7 +67,7 @@ public:
 
     // bitwise and operator, resets all bits that are not in rhs and leaves
     // all others unchanged
-    wxFlags &operator &=(const wxFlags &rhs) // intersection
+    wxBitset &operator &=(const wxBitset &rhs) // intersection
     {
 		m_data &= rhs.m_data;
 		return *this;
@@ -77,47 +75,47 @@ public:
 
     // bitwise or operator, returns a new bitset that has all bits set that set are in 
     // bitset2 or in this bitset
-   wxFlags operator |(const wxFlags &bitset2) const // union
+   wxBitset operator |(const wxBitset &bitset2) const // union
     {
-		wxFlags<T> s;
+		wxBitset<T> s;
 		s.m_data = m_data | bitset2.m_data;
 		return s;
     }
 
     // bitwise exclusive-or operator, returns a new bitset that has all bits set that are set either in 
     // bitset2 or in this bitset but not in both
-    wxFlags operator ^(const wxFlags &bitset2) const // difference
+    wxBitset operator ^(const wxBitset &bitset2) const // difference
     {
-		wxFlags<T> s;
+		wxBitset<T> s;
 		s.m_data = m_data ^ bitset2.m_data;
 		return s;
     }
 
     // bitwise and operator, returns a new bitset that has all bits set that are set both in 
     // bitset2 and in this bitset
-    wxFlags operator &(const wxFlags &bitset2) const // intersection
+    wxBitset operator &(const wxBitset &bitset2) const // intersection
     {
-		wxFlags<T> s;
+		wxBitset<T> s;
 		s.m_data = m_data & bitset2.m_data;
 		return s;
     }
 
     // sets appropriate the bit to true
-    wxFlags& set(const T el) //Add element
+    wxBitset& set(const T el) //Add element
     {
 		m_data |= 1 << el;
 		return *this;
     }
     
     // clears the appropriate flag to false
-    wxFlags& reset(const T el) //remove element
+    wxBitset& reset(const T el) //remove element
     {
 		m_data &= ~(1 << el);
 		return *this;
     }
 
     // clear all flags
-    wxFlags& reset()
+    wxBitset& reset()
     {
 		m_data = 0;
 		return *this;
@@ -142,13 +140,13 @@ public:
     }
 
     // true if both have the same flags
-    bool operator ==(const wxFlags &rhs) const
+    bool operator ==(const wxBitset &rhs) const
     {
 		return m_data == rhs.m_data;
     }
 
     // true if both differ in their flags set
-    bool operator !=(const wxFlags &rhs) const
+    bool operator !=(const wxBitset &rhs) const
     {
 		return !operator==(rhs);
     }
@@ -159,5 +157,11 @@ private :
 	unsigned long m_data;
 };
 
+#define WX_DEFINE_FLAGS( flags ) \
+    struct flags \
+    {\
+    flags(long data=0) :m_data(data) {} \
+        long m_data ;\
+    } ;
 
 #endif

include/wx/xti.h

@@ -143,7 +143,7 @@ private :
 //  Strawberry,
 // };
 //
-// typedef wxFlags<wxFlavor> wxCoupe ;
+// typedef wxBitset<wxFlavor> wxCoupe ;
 //
 // in the implementation file :
 //
@@ -164,7 +164,7 @@ private :
 void wxSetStringToArray( const wxString &s , wxArrayString &array ) ;
 
 template<typename e>
-void wxSetFromString(const wxString &s , wxFlags<e> &data )
+void wxSetFromString(const wxString &s , wxBitset<e> &data )
 {
     wxEnumData* edata = wxGetEnumData((e) 0) ;
     data.reset() ;
@@ -184,7 +184,7 @@ void wxSetFromString(const wxString &s , wxFlags<e> &data )
 }
 
 template<typename e>
-void wxSetToString( wxString &s , const wxFlags<e> &data )
+void wxSetToString( wxString &s , const wxBitset<e> &data )
 {
     wxEnumData* edata = wxGetEnumData((e) 0) ;
     int count = edata->GetEnumCount() ;
@@ -203,15 +203,15 @@ void wxSetToString( wxString &s , const wxFlags<e> &data )
     }
 }
 
-//  if the wxFlags specialization above does not work for all compilers, add this to the WX_IMPLEMENT_SET_STREAMING macro
+//  if the wxBitset specialization above does not work for all compilers, add this to the WX_IMPLEMENT_SET_STREAMING macro
 //  template<> const wxTypeInfo* wxGetTypeInfo( SetName * ){ static wxEnumTypeInfo s_typeInfo(wxT_SET , &s_enumData##e) ; return &s_typeInfo ; }
 
 #define WX_IMPLEMENT_SET_STREAMING(SetName,e) \
-    template<> void wxStringReadValue(const wxString &s , wxFlags<e> &data ) \
+    template<> void wxStringReadValue(const wxString &s , wxBitset<e> &data ) \
 { \
     wxSetFromString( s , data ) ; \
 } \
-    template<> void wxStringWriteValue( wxString &s , const wxFlags<e> &data ) \
+    template<> void wxStringWriteValue( wxString &s , const wxBitset<e> &data ) \
 { \
     wxSetToString( s , data ) ; \
 } \
@@ -222,6 +222,72 @@ template<> const wxTypeInfo* wxGetTypeInfo( SetName * ) \
     static wxEnumTypeInfo s_typeInfo(wxT_SET , &s_enumData##e , &wxToStringConverter<SetName> , &wxFromStringConverter<SetName> , &ToLong##SetName , &FromLong##SetName, #SetName ) ; return &s_typeInfo ; \
 } 
 
+template<typename e>
+void wxFlagsFromString(const wxString &s , e &data )
+{
+    wxEnumData* edata = wxGetEnumData((e*) 0) ;
+    data.m_data = 0 ;
+
+    wxArrayString array ;
+    wxSetStringToArray( s , array ) ;
+    wxString flag;
+    for ( int i = 0 ; i < array.Count() ; ++i )
+    {
+        flag = array[i] ;
+        int ivalue ;
+        if ( edata->HasEnumMemberValue( flag , &ivalue ) )
+        {
+            data.m_data |= ivalue ;
+        }
+    }
+}
+
+template<typename e>
+void wxFlagsToString( wxString &s , const e& data )
+{
+    wxEnumData* edata = wxGetEnumData((e*) 0) ;
+    int count = edata->GetEnumCount() ;
+    int i ;
+    s.Clear() ;
+    long dataValue = data.m_data ;
+    for ( i = 0 ; i < count ; i++ )
+    {
+        int value = edata->GetEnumMemberValueByIndex(i) ;
+        // make this to allow for multi-bit constants to work
+        if ( value && ( dataValue & value ) == value )
+        {
+            // clear the flags we just set
+            dataValue &= ~value ;
+            // this could also be done by the templated calls
+            if ( !s.IsEmpty() )
+                s +="|" ;
+            s += edata->GetEnumMemberNameByIndex(i) ;
+        }
+    }
+}
+
+#define WX_BEGIN_FLAGS( e ) \
+    wxEnumMemberData s_enumDataMembers##e[] = {
+
+#define WX_FLAGS_MEMBER( v ) { #v, v } ,
+
+#define WX_END_FLAGS( e ) { NULL , 0 } } ; \
+    wxEnumData s_enumData##e( s_enumDataMembers##e ) ; \
+    wxEnumData *wxGetEnumData(e*) { return &s_enumData##e ; } \
+    template<> void wxStringReadValue(const wxString &s , e &data ) \
+{ \
+    wxFlagsFromString<e>( s , data ) ; \
+} \
+    template<> void wxStringWriteValue( wxString &s , const e& data ) \
+{ \
+    wxFlagsToString<e>( s , data ) ; \
+} \
+    void FromLong##e( long data , wxxVariant& result ) { result = wxxVariant(e(data)) ;} \
+    void ToLong##e( const wxxVariant& data , long &result ) { result = (long) data.Get<e>().m_data ;} \
+template<> const wxTypeInfo* wxGetTypeInfo( e * ) \
+{ \
+    static wxEnumTypeInfo s_typeInfo(wxT_SET , &s_enumData##e , &wxToStringConverter<e> , &wxFromStringConverter<e> , &ToLong##e , &FromLong##e, #e ) ; return &s_typeInfo ; \
+} 
 
 // ----------------------------------------------------------------------------
 // Type Information
@@ -247,7 +313,7 @@ enum wxTypeKind
     wxT_FLOAT,
     wxT_DOUBLE,
     wxT_STRING, // must be wxString
-    wxT_SET, // must be wxFlags<> template
+    wxT_SET, // must be wxBitset<> template
     wxT_ENUM,
     wxT_CUSTOM, // user defined type (e.g. wxPoint)