wxXRC cleanup: removed .xmlbin format

[wxWidgets.git] / src / xrc / xmlres.cpp

diff --git a/src/xrc/xmlres.cpp b/src/xrc/xmlres.cpp
index 745d4213fdaf6d2650b33b722dc64db7fecae7f1..bd45b371852f511a889089724eac878cd1d1e5e5 100644 (file)
--- a/src/xrc/xmlres.cpp
+++ b/src/xrc/xmlres.cpp
@@ -40,6 +40,22 @@
 WX_DEFINE_OBJARRAY(wxXmlResourceDataRecords);
 
 
 WX_DEFINE_OBJARRAY(wxXmlResourceDataRecords);
 
 

+wxXmlResource *wxXmlResource::ms_instance = NULL;
+
+/*static*/ wxXmlResource *wxXmlResource::Get()
+{
+    if ( !ms_instance )
+        ms_instance = new wxXmlResource;
+    return ms_instance;
+}
+
+/*static*/ wxXmlResource *wxXmlResource::Set(wxXmlResource *res)
+{
+    wxXmlResource *old = ms_instance;
+    ms_instance = res;
+    return old;
+}
+

 wxXmlResource::wxXmlResource(int flags)
 {
     m_handlers.DeleteContents(TRUE);
 wxXmlResource::wxXmlResource(int flags)
 {
     m_handlers.DeleteContents(TRUE);


@@ -84,9 +100,9 @@ bool wxXmlResource::Load(const wxString& filemask)
     {
 #if wxUSE_FILESYSTEM
         if (filemask.Lower().Matches(wxT("*.zip")) ||
     {
 #if wxUSE_FILESYSTEM
         if (filemask.Lower().Matches(wxT("*.zip")) ||

-            filemask.Lower().Matches(wxT("*.rsc")))
+            filemask.Lower().Matches(wxT("*.xrs")))

         {
         {

-            rt = rt && Load(fnd + wxT("#zip:*.xmb"));
+            rt = rt && Load(fnd + wxT("#zip:*.xmlbin"));

             rt = rt && Load(fnd + wxT("#zip:*.xrc"));
         }
         else
             rt = rt && Load(fnd + wxT("#zip:*.xrc"));
         }
         else


@@ -270,6 +286,17 @@ void wxXmlResource::UpdateResources()
     wxFileSystem fsys;
 #   endif
 
     wxFileSystem fsys;
 #   endif
 

+    wxString encoding(wxT("UTF-8"));
+#if !wxUSE_UNICODE && wxUSE_INTL
+    if ( (GetFlags() & wxXRC_USE_LOCALE) == 0 )
+    {
+        // In case we are not using wxLocale to translate strings, convert the strings
+        // GUI's charset. This must not be done when wxXRC_USE_LOCALE is on, because
+        // it could break wxGetTranslation lookup.
+        encoding = wxLocale::GetSystemEncodingName();
+    }
+#endif
+

     for (size_t i = 0; i < m_data.GetCount(); i++)
     {
         modif = (m_data[i].Doc == NULL);
     for (size_t i = 0; i < m_data.GetCount(); i++)
     {
         modif = (m_data[i].Doc == NULL);


@@ -289,7 +316,7 @@ void wxXmlResource::UpdateResources()
 
         if (modif)
         {
 
         if (modif)
         {

-                       wxInputStream *stream = NULL;
+            wxInputStream *stream = NULL;

 
 #           if wxUSE_FILESYSTEM
             file = fsys.OpenFile(m_data[i].File);
 
 #           if wxUSE_FILESYSTEM
             file = fsys.OpenFile(m_data[i].File);


@@ -304,9 +331,10 @@ void wxXmlResource::UpdateResources()
                 delete m_data[i].Doc;
                 m_data[i].Doc = new wxXmlDocument;
             }
                 delete m_data[i].Doc;
                 m_data[i].Doc = new wxXmlDocument;
             }

-            if (!stream || !m_data[i].Doc->Load(*stream))
+            if (!stream || !m_data[i].Doc->Load(*stream, encoding))

             {
             {

-                wxLogError(_("Cannot load resources from file '%s'."), m_data[i].File.c_str());
+                wxLogError(_("Cannot load resources from file '%s'."),
+                           m_data[i].File.c_str());

                 wxDELETE(m_data[i].Doc);
             }
             else if (m_data[i].Doc->GetRoot()->GetName() != wxT("resource"))
                 wxDELETE(m_data[i].Doc);
             }
             else if (m_data[i].Doc->GetRoot()->GetName() != wxT("resource"))


@@ -344,29 +372,64 @@ void wxXmlResource::UpdateResources()
 }
 
 
 }
 
 

+wxXmlNode *wxXmlResource::DoFindResource(wxXmlNode *parent, 
+                                         const wxString& name, 
+                                         const wxString& classname, 
+                                         bool recursive)
+{
+    wxString dummy;
+    wxXmlNode *node;
+
+    // first search for match at the top-level nodes (as this is
+    // where the resource is most commonly looked for):
+    for (node = parent->GetChildren(); node; node = node->GetNext())
+    {
+        if ( node->GetType() == wxXML_ELEMENT_NODE && 
+                 (node->GetName() == wxT("object") || 
+                  node->GetName() == wxT("object_ref")) &&
+                (!classname || 
+                 node->GetPropVal(wxT("class"), wxEmptyString) == classname) &&
+                node->GetPropVal(wxT("name"), &dummy) && dummy == name )
+            return node;
+    }
+
+    if ( recursive )
+        for (node = parent->GetChildren(); node; node = node->GetNext())
+        {
+            if ( node->GetType() == wxXML_ELEMENT_NODE && 
+                 (node->GetName() == wxT("object") || 
+                  node->GetName() == wxT("object_ref")) )
+            {
+                wxXmlNode* found = DoFindResource(node, name, classname, TRUE);
+                if ( found )
+                    return found;
+            }
+        }
+
+   return NULL;
+}

 
 

-wxXmlNode *wxXmlResource::FindResource(const wxString& name, const wxString& classname)
+wxXmlNode *wxXmlResource::FindResource(const wxString& name, 
+                                       const wxString& classname,
+                                       bool recursive)

 {
     UpdateResources(); //ensure everything is up-to-date
 
     wxString dummy;
     for (size_t f = 0; f < m_data.GetCount(); f++)
     {
 {
     UpdateResources(); //ensure everything is up-to-date
 
     wxString dummy;
     for (size_t f = 0; f < m_data.GetCount(); f++)
     {

-        if (m_data[f].Doc == NULL || m_data[f].Doc->GetRoot() == NULL) continue;
-        for (wxXmlNode *node = m_data[f].Doc->GetRoot()->GetChildren();
-                                      node; node = node->GetNext())
-            if (node->GetType() == wxXML_ELEMENT_NODE &&
-                (!classname ||
-                  node->GetPropVal(wxT("class"), wxEmptyString) == classname) &&
-                node->GetName() == wxT("object") &&
-                node->GetPropVal(wxT("name"), &dummy) &&
-                dummy == name)
-            {
+        if ( m_data[f].Doc == NULL || m_data[f].Doc->GetRoot() == NULL )
+            continue;
+
+        wxXmlNode* found = DoFindResource(m_data[f].Doc->GetRoot(), 
+                                          name, classname, recursive);
+        if ( found )
+        {

 #if wxUSE_FILESYSTEM
 #if wxUSE_FILESYSTEM

-                m_curFileSystem.ChangePathTo(m_data[f].File);
+            m_curFileSystem.ChangePathTo(m_data[f].File);

 #endif
 #endif

-                return node;
-            }
+            return found;
+        }

     }
 
     wxLogError(_("XRC resource '%s' (class '%s') not found!"),
     }
 
     wxLogError(_("XRC resource '%s' (class '%s') not found!"),


@@ -374,12 +437,74 @@ wxXmlNode *wxXmlResource::FindResource(const wxString& name, const wxString& cla
     return NULL;
 }
 
     return NULL;
 }
 

+static void MergeNodes(wxXmlNode& dest, wxXmlNode& with)
+{
+    // Merge properties:
+    for (wxXmlProperty *prop = with.GetProperties(); prop; prop = prop->GetNext())
+    {
+        wxXmlProperty *dprop;
+        for (dprop = dest.GetProperties(); dprop; dprop = dprop->GetNext())
+        {
+       
+            if ( dprop->GetName() == prop->GetName() )
+            {
+                dprop->SetValue(prop->GetValue());
+                break;
+            }
+        }
+
+        if ( !dprop )
+            dest.AddProperty(prop->GetName(), prop->GetValue());
+   }
+
+    // Merge child nodes:
+    for (wxXmlNode* node = with.GetChildren(); node; node = node->GetNext())
+    {
+        wxString name = node->GetPropVal(wxT("name"), wxEmptyString);
+        wxXmlNode *dnode;
+
+        for (dnode = dest.GetChildren(); dnode; dnode = dnode->GetNext() )
+        {
+            if ( dnode->GetName() == node->GetName() &&
+                 dnode->GetPropVal("name", wxEmptyString) == name &&
+                 dnode->GetType() == node->GetType() )
+            {
+                MergeNodes(*dnode, *node);
+                break;
+            }
+        }
+
+        if ( !dnode )
+            dest.AddChild(new wxXmlNode(*node));
+    }

 
 

+    if ( dest.GetType() == wxXML_TEXT_NODE && with.GetContent().Length() )
+         dest.SetContent(with.GetContent());
+}

 
 wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent, wxObject *instance)
 {
     if (node == NULL) return NULL;
 
 
 wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent, wxObject *instance)
 {
     if (node == NULL) return NULL;
 

+    // handling of referenced resource
+    if ( node->GetName() == wxT("object_ref") )
+    {
+        wxString refName = node->GetPropVal(wxT("ref"), wxEmptyString);
+        wxXmlNode* refNode = FindResource(refName, wxEmptyString, TRUE);
+
+        if ( !refNode )
+        {
+            wxLogError(_("Referenced object node with ref=\"%s\" not found!"), 
+                       refName.c_str());
+            return NULL;
+        }
+
+        wxXmlNode copy(*refNode);
+        MergeNodes(copy, *node);
+
+        return CreateResFromNode(&copy, parent, instance);
+    }
+

     wxXmlResourceHandler *handler;
     wxObject *ret;
     wxNode * ND = m_handlers.GetFirst();
     wxXmlResourceHandler *handler;
     wxObject *ret;
     wxNode * ND = m_handlers.GetFirst();


@@ -403,11 +528,6 @@ wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent, wx
 
 
 
 
 
 

-
-
-
-
-

 wxXmlResourceHandler::wxXmlResourceHandler()
         : m_node(NULL), m_parent(NULL), m_instance(NULL),
           m_parentAsWindow(NULL), m_instanceAsWindow(NULL)
 wxXmlResourceHandler::wxXmlResourceHandler()
         : m_node(NULL), m_parent(NULL), m_instance(NULL),
           m_parentAsWindow(NULL), m_instanceAsWindow(NULL)


@@ -593,7 +713,7 @@ int wxXmlResourceHandler::GetID()
     stdID(wxID_DEFAULT); stdID(wxID_MORE); stdID(wxID_SETUP);
     stdID(wxID_RESET); stdID(wxID_HELP_CONTEXT);
 #undef stdID
     stdID(wxID_DEFAULT); stdID(wxID_MORE); stdID(wxID_SETUP);
     stdID(wxID_RESET); stdID(wxID_HELP_CONTEXT);
 #undef stdID

-    else return wxXmlResource::GetXMLID(sid);
+    else return wxXmlResource::GetXRCID(sid);

 }
 
 
 }
 
 


@@ -922,32 +1042,32 @@ void wxXmlResourceHandler::CreateChildrenPrivately(wxObject *parent, wxXmlNode *
 
 
 
 
 
 

-// --------------- XMLID implementation -----------------------------
+// --------------- XRCID implementation -----------------------------

 
 

-#define XMLID_TABLE_SIZE     1024
+#define XRCID_TABLE_SIZE     1024

 
 
 
 

-struct XMLID_record
+struct XRCID_record

 {
     int id;
     wxChar *key;
 {
     int id;
     wxChar *key;

-    XMLID_record *next;
+    XRCID_record *next;

 };
 
 };
 

-static XMLID_record *XMLID_Records[XMLID_TABLE_SIZE] = {NULL};
+static XRCID_record *XRCID_Records[XRCID_TABLE_SIZE] = {NULL};

 
 

-/*static*/ int wxXmlResource::GetXMLID(const wxChar *str_id)
+/*static*/ int wxXmlResource::GetXRCID(const wxChar *str_id)

 {
 {

-    static int XMLID_LastID = wxID_HIGHEST;
+    static int XRCID_LastID = wxID_HIGHEST;

 
     int index = 0;
 
     for (const wxChar *c = str_id; *c != wxT('\0'); c++) index += (int)*c;
 
     int index = 0;
 
     for (const wxChar *c = str_id; *c != wxT('\0'); c++) index += (int)*c;

-    index %= XMLID_TABLE_SIZE;
+    index %= XRCID_TABLE_SIZE;

 
 

-    XMLID_record *oldrec = NULL;
+    XRCID_record *oldrec = NULL;

     int matchcnt = 0;
     int matchcnt = 0;

-    for (XMLID_record *rec = XMLID_Records[index]; rec; rec = rec->next)
+    for (XRCID_record *rec = XRCID_Records[index]; rec; rec = rec->next)

     {
         if (wxStrcmp(rec->key, str_id) == 0)
         {
     {
         if (wxStrcmp(rec->key, str_id) == 0)
         {


@@ -957,10 +1077,10 @@ static XMLID_record *XMLID_Records[XMLID_TABLE_SIZE] = {NULL};
         oldrec = rec;
     }
 
         oldrec = rec;
     }
 

-    XMLID_record **rec_var = (oldrec == NULL) ?
-                              &XMLID_Records[index] : &oldrec->next;
-    *rec_var = new XMLID_record;
-    (*rec_var)->id = ++XMLID_LastID;
+    XRCID_record **rec_var = (oldrec == NULL) ?
+                              &XRCID_Records[index] : &oldrec->next;
+    *rec_var = new XRCID_record;
+    (*rec_var)->id = ++XRCID_LastID;

     (*rec_var)->key = wxStrdup(str_id);
     (*rec_var)->next = NULL;
 
     (*rec_var)->key = wxStrdup(str_id);
     (*rec_var)->next = NULL;
 


@@ -968,20 +1088,20 @@ static XMLID_record *XMLID_Records[XMLID_TABLE_SIZE] = {NULL};
 }
 
 
 }
 
 

-static void CleanXMLID_Record(XMLID_record *rec)
+static void CleanXRCID_Record(XRCID_record *rec)

 {
     if (rec)
     {
 {
     if (rec)
     {

-        CleanXMLID_Record(rec->next);
+        CleanXRCID_Record(rec->next);

         free(rec->key);
         delete rec;
     }
 }
 
         free(rec->key);
         delete rec;
     }
 }
 

-static void CleanXMLID_Records()
+static void CleanXRCID_Records()

 {
 {

-    for (int i = 0; i < XMLID_TABLE_SIZE; i++)
-        CleanXMLID_Record(XMLID_Records[i]);
+    for (int i = 0; i < XRCID_TABLE_SIZE; i++)
+        CleanXRCID_Record(XRCID_Records[i]);

 }
 
 
 }
 
 


@@ -993,22 +1113,19 @@ static void CleanXMLID_Records()
 
 // --------------- module and globals -----------------------------
 
 
 // --------------- module and globals -----------------------------
 

-
-static wxXmlResource gs_XmlResource;
-
-wxXmlResource *wxTheXmlResource = &gs_XmlResource;
-
-

 class wxXmlResourceModule: public wxModule
 {
 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule)
 public:
     wxXmlResourceModule() {}
 class wxXmlResourceModule: public wxModule
 {
 DECLARE_DYNAMIC_CLASS(wxXmlResourceModule)
 public:
     wxXmlResourceModule() {}

-    bool OnInit() {return TRUE;}
+    bool OnInit()
+    {
+        return TRUE;
+    }

     void OnExit()
     {
     void OnExit()
     {

-        wxTheXmlResource->ClearHandlers();
-        CleanXMLID_Records();
+        delete wxXmlResource::Set(NULL);
+        CleanXRCID_Records();

     }
 };
 
     }
 };