better native types for carbon

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

diff --git a/src/xrc/xmlres.cpp b/src/xrc/xmlres.cpp
index fc16e6ec42b115c1fd5c40a33f2afd40ef38b748..075489d9e7cecbd6809d58d921e0e4d2a02b9d61 100644 (file)
--- a/src/xrc/xmlres.cpp
+++ b/src/xrc/xmlres.cpp
@@ -44,7 +44,7 @@
 #include "wx/fontenum.h"
 #include "wx/fontmap.h"
 #include "wx/artprov.h"
 #include "wx/fontenum.h"
 #include "wx/fontmap.h"
 #include "wx/artprov.h"

-
+#include "wx/dir.h"

 #include "wx/xml/xml.h"
 
 
 #include "wx/xml/xml.h"
 
 


@@ -70,6 +70,22 @@ class wxXmlResourceDataRecords : public wxVector<wxXmlResourceDataRecord*>
     // this is a class so that it can be forward-declared
 };
 
     // this is a class so that it can be forward-declared
 };
 

+namespace
+{
+
+// helper used by DoFindResource() and elsewhere: returns true if this is an
+// object or object_ref node
+//
+// node must be non-NULL
+inline bool IsObjectNode(wxXmlNode *node)
+{
+    return node->GetType() == wxXML_ELEMENT_NODE &&
+             (node->GetName() == wxS("object") ||
+                node->GetName() == wxS("object_ref"));
+}
+
+} // anonymous namespace
+

 
 wxXmlResource *wxXmlResource::ms_instance = NULL;
 
 
 wxXmlResource *wxXmlResource::ms_instance = NULL;
 


@@ -162,8 +178,35 @@ bool wxXmlResource::IsArchive(const wxString& filename)
 
 #endif // wxUSE_FILESYSTEM
 
 
 #endif // wxUSE_FILESYSTEM
 

-bool wxXmlResource::Load(const wxString& filemask)
+bool wxXmlResource::LoadFile(const wxFileName& file)
+{
+#if wxUSE_FILESYSTEM
+    return Load(wxFileSystem::FileNameToURL(file));
+#else
+    return Load(file.GetFullPath());
+#endif
+}
+
+bool wxXmlResource::LoadAllFiles(const wxString& dirname)

 {
 {

+    bool ok = true;
+    wxArrayString files;
+
+    wxDir::GetAllFiles(dirname, &files, "*.xrc");
+
+    for ( wxArrayString::const_iterator i = files.begin(); i != files.end(); ++i )
+    {
+        if ( !LoadFile(*i) )
+            ok = false;
+    }
+
+    return ok;
+}
+
+bool wxXmlResource::Load(const wxString& filemask_)
+{
+    wxString filemask = ConvertFileNameToURL(filemask_);
+

 #if wxUSE_FILESYSTEM
     wxFileSystem fsys;
 #   define wxXmlFindFirst  fsys.FindFirst(filemask, wxFILE)
 #if wxUSE_FILESYSTEM
     wxFileSystem fsys;
 #   define wxXmlFindFirst  fsys.FindFirst(filemask, wxFILE)


@@ -181,8 +224,6 @@ bool wxXmlResource::Load(const wxString& filemask)
 
     while (!fnd.empty())
     {
 
     while (!fnd.empty())
     {

-        fnd = ConvertFileNameToURL(fnd);
-

 #if wxUSE_FILESYSTEM
         if ( IsArchive(fnd) )
         {
 #if wxUSE_FILESYSTEM
         if ( IsArchive(fnd) )
         {


@@ -366,7 +407,7 @@ bool wxXmlResource::AttachUnknownControl(const wxString& name,
     wxWindow *container = parent->FindWindow(name + wxT("_container"));
     if (!container)
     {
     wxWindow *container = parent->FindWindow(name + wxT("_container"));
     if (!container)
     {

-        wxLogError(_("Cannot find container for unknown control '%s'."), name.c_str());
+        wxLogError("Cannot find container for unknown control '%s'.", name);

         return false;
     }
     return control->Reparent(container);
         return false;
     }
     return control->Reparent(container);


@@ -497,7 +538,7 @@ bool wxXmlResource::UpdateResources()
                 delete rec->Doc;
                 rec->Doc = new wxXmlDocument;
             }
                 delete rec->Doc;
                 rec->Doc = new wxXmlDocument;
             }

-            if (!stream || !rec->Doc->Load(*stream, encoding))
+            if (!stream || !stream->IsOk() || !rec->Doc->Load(*stream, encoding))

             {
                 wxLogError(_("Cannot load resources from file '%s'."),
                            rec->File);
             {
                 wxLogError(_("Cannot load resources from file '%s'."),
                            rec->File);


@@ -506,7 +547,11 @@ bool wxXmlResource::UpdateResources()
             }
             else if (rec->Doc->GetRoot()->GetName() != wxT("resource"))
             {
             }
             else if (rec->Doc->GetRoot()->GetName() != wxT("resource"))
             {

-                wxLogError(_("Invalid XRC resource '%s': doesn't have root node 'resource'."), rec->File);
+                ReportError
+                (
+                    rec->Doc->GetRoot(),
+                    "invalid XRC resource, doesn't have root node <resource>"
+                );

                 wxDELETE(rec->Doc);
                 rt = false;
             }
                 wxDELETE(rec->Doc);
                 rt = false;
             }


@@ -525,7 +570,7 @@ bool wxXmlResource::UpdateResources()
                     m_version = version;
                 if (m_version != version)
                 {
                     m_version = version;
                 if (m_version != version)
                 {

-                    wxLogError(_("Resource files must have same version number!"));
+                    wxLogError("Resource files must have same version number.");

                     rt = false;
                 }
 
                     rt = false;
                 }
 


@@ -551,86 +596,121 @@ bool wxXmlResource::UpdateResources()
     return rt;
 }
 
     return rt;
 }
 

-

 wxXmlNode *wxXmlResource::DoFindResource(wxXmlNode *parent,
                                          const wxString& name,
                                          const wxString& classname,
 wxXmlNode *wxXmlResource::DoFindResource(wxXmlNode *parent,
                                          const wxString& name,
                                          const wxString& classname,

-                                         bool recursive)
+                                         bool recursive) const

 {
 {

-    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())
     {
     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")) &&
-             node->GetAttribute(wxT("name"), &dummy) && dummy == name )
+        if ( IsObjectNode(node) && node->GetAttribute(wxS("name")) == name )

         {
         {

-            wxString cls(node->GetAttribute(wxT("class"), wxEmptyString));
-            if (!classname || cls == classname)
+            // empty class name matches everything
+            if ( classname.empty() )

                 return node;
                 return node;

+
+            wxString cls(node->GetAttribute(wxS("class")));
+

             // object_ref may not have 'class' attribute:
             // object_ref may not have 'class' attribute:

-            if (cls.empty() && node->GetName() == wxT("object_ref"))
+            if (cls.empty() && node->GetName() == wxS("object_ref"))

             {
             {

-                wxString refName = node->GetAttribute(wxT("ref"), wxEmptyString);
+                wxString refName = node->GetAttribute(wxS("ref"));

                 if (refName.empty())
                     continue;
                 if (refName.empty())
                     continue;

-                wxXmlNode* refNode = FindResource(refName, wxEmptyString, true);
-                if (refNode &&
-                    refNode->GetAttribute(wxT("class"), wxEmptyString) == classname)
-                {
-                    return node;
-                }
+
+                const wxXmlNode * const refNode = GetResourceNode(refName);
+                if ( refNode )
+                    cls = refNode->GetAttribute(wxS("class"));

             }
             }

+
+            if ( cls == classname )
+                return node;

         }
     }
 
         }
     }
 

+    // then recurse in child nodes

     if ( recursive )
     if ( recursive )

+    {

         for (node = parent->GetChildren(); node; node = node->GetNext())
         {
         for (node = parent->GetChildren(); node; node = node->GetNext())
         {

-            if ( node->GetType() == wxXML_ELEMENT_NODE &&
-                 (node->GetName() == wxT("object") ||
-                  node->GetName() == wxT("object_ref")) )
+            if ( IsObjectNode(node) )

             {
                 wxXmlNode* found = DoFindResource(node, name, classname, true);
                 if ( found )
                     return found;
             }
         }
             {
                 wxXmlNode* found = DoFindResource(node, name, classname, true);
                 if ( found )
                     return found;
             }
         }

+    }

 
 

-   return NULL;
+    return NULL;

 }
 
 wxXmlNode *wxXmlResource::FindResource(const wxString& name,
                                        const wxString& classname,
                                        bool recursive)
 {
 }
 
 wxXmlNode *wxXmlResource::FindResource(const wxString& name,
                                        const wxString& classname,
                                        bool recursive)
 {

-    UpdateResources(); //ensure everything is up-to-date
+    wxString path;
+    wxXmlNode * const
+        node = GetResourceNodeAndLocation(name, classname, recursive, &path);
+
+    if ( !node )
+    {
+        ReportError
+        (
+            NULL,
+            wxString::Format
+            (
+                "XRC resource \"%s\" (class \"%s\") not found",
+                name, classname
+            )
+        );
+    }
+#if wxUSE_FILESYSTEM
+    else // node was found
+    {
+        // ensure that relative paths work correctly when loading this node
+        // (which should happen as soon as we return as FindResource() result
+        // is always passed to CreateResFromNode())
+        m_curFileSystem.ChangePathTo(path);
+    }
+#endif // wxUSE_FILESYSTEM
+
+    return node;
+}
+
+wxXmlNode *
+wxXmlResource::GetResourceNodeAndLocation(const wxString& name,
+                                          const wxString& classname,
+                                          bool recursive,
+                                          wxString *path) const
+{
+    // ensure everything is up-to-date: this is needed to support on-remand
+    // reloading of XRC files
+    const_cast<wxXmlResource *>(this)->UpdateResources();

 
 

-    wxString dummy;

     for ( wxXmlResourceDataRecords::const_iterator f = Data().begin();
           f != Data().end(); ++f )
     {
     for ( wxXmlResourceDataRecords::const_iterator f = Data().begin();
           f != Data().end(); ++f )
     {

-        wxXmlResourceDataRecord* const rec = *f;
-        if ( rec->Doc == NULL || rec->Doc->GetRoot() == NULL )
+        wxXmlResourceDataRecord *const rec = *f;
+        wxXmlDocument * const doc = rec->Doc;
+        if ( !doc || !doc->GetRoot() )

             continue;
 
             continue;
 

-        wxXmlNode* found = DoFindResource(rec->Doc->GetRoot(),
-                                          name, classname, recursive);
+        wxXmlNode * const
+            found = DoFindResource(doc->GetRoot(), name, classname, recursive);

         if ( found )
         {
         if ( found )
         {

-#if wxUSE_FILESYSTEM
-            m_curFileSystem.ChangePathTo(rec->File);
-#endif
+            if ( path )
+                *path = rec->File;
+

             return found;
         }
     }
 
             return found;
         }
     }
 

-    wxLogError(_("XRC resource '%s' (class '%s') not found!"),
-               name.c_str(), classname.c_str());

     return NULL;
 }
 
     return NULL;
 }
 


@@ -705,8 +785,15 @@ wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent,
 
         if ( !refNode )
         {
 
         if ( !refNode )
         {

-            wxLogError(_("Referenced object node with ref=\"%s\" not found!"),
-                       refName.c_str());
+            ReportError
+            (
+                node,
+                wxString::Format
+                (
+                    "referenced object node with ref=\"%s\" not found",
+                    refName
+                )
+            );

             return NULL;
         }
 
             return NULL;
         }
 


@@ -734,9 +821,16 @@ wxObject *wxXmlResource::CreateResFromNode(wxXmlNode *node, wxObject *parent,
         }
     }
 
         }
     }
 

-    wxLogError(_("No handler found for XML node '%s', class '%s'!"),
-               node->GetName().c_str(),
-               node->GetAttribute(wxT("class"), wxEmptyString).c_str());
+    ReportError
+    (
+        node,
+        wxString::Format
+        (
+            "no handler found for XML node \"%s\" (class \"%s\")",
+            node->GetName(),
+            node->GetAttribute("class", wxEmptyString)
+        )
+    );

     return NULL;
 }
 
     return NULL;
 }
 


@@ -808,8 +902,15 @@ wxObject *wxXmlResourceHandler::CreateResource(wxXmlNode *node, wxObject *parent
             if (!m_instance)
             {
                 wxString name = node->GetAttribute(wxT("name"), wxEmptyString);
             if (!m_instance)
             {
                 wxString name = node->GetAttribute(wxT("name"), wxEmptyString);

-                wxLogError(_("Subclass '%s' not found for resource '%s', not subclassing!"),
-                           subclass.c_str(), name.c_str());
+                ReportError
+                (
+                    node,
+                    wxString::Format
+                    (
+                        "subclass \"%s\" not found for resource \"%s\", not subclassing",
+                        subclass, name
+                    )
+                );

             }
         }
     }
             }
         }
     }


@@ -883,9 +984,17 @@ int wxXmlResourceHandler::GetStyle(const wxString& param, int defaults)
         fl = tkn.GetNextToken();
         index = m_styleNames.Index(fl);
         if (index != wxNOT_FOUND)
         fl = tkn.GetNextToken();
         index = m_styleNames.Index(fl);
         if (index != wxNOT_FOUND)

+        {

             style |= m_styleValues[index];
             style |= m_styleValues[index];

+        }

         else
         else

-            wxLogError(_("Unknown style flag ") + fl);
+        {
+            ReportParamError
+            (
+                param,
+                wxString::Format("unknown style flag \"%s\"", fl)
+            );
+        }

     }
     return style;
 }
     }
     return style;
 }


@@ -1110,8 +1219,11 @@ wxColour wxXmlResourceHandler::GetColour(const wxString& param, const wxColour&
         if (clr.Ok())
             return clr;
 
         if (clr.Ok())
             return clr;
 

-        wxLogError(_("XRC resource: Incorrect colour specification '%s' for attribute '%s'."),
-                   v.c_str(), param.c_str());
+        ReportParamError
+        (
+            param,
+            wxString::Format("incorrect colour specification \"%s\"", v)
+        );

         return wxNullColour;
     }
 
         return wxNullColour;
     }
 


@@ -1152,8 +1264,11 @@ wxBitmap wxXmlResourceHandler::GetBitmap(const wxString& param,
     wxFSFile *fsfile = GetCurFileSystem().OpenFile(name, wxFS_READ | wxFS_SEEKABLE);
     if (fsfile == NULL)
     {
     wxFSFile *fsfile = GetCurFileSystem().OpenFile(name, wxFS_READ | wxFS_SEEKABLE);
     if (fsfile == NULL)
     {

-        wxLogError(_("XRC resource: Cannot create bitmap from '%s'."),
-                   name.c_str());
+        ReportParamError
+        (
+            param,
+            wxString::Format("cannot open bitmap resource \"%s\"", name)
+        );

         return wxNullBitmap;
     }
     wxImage img(*(fsfile->GetStream()));
         return wxNullBitmap;
     }
     wxImage img(*(fsfile->GetStream()));


@@ -1164,8 +1279,11 @@ wxBitmap wxXmlResourceHandler::GetBitmap(const wxString& param,
 
     if (!img.Ok())
     {
 
     if (!img.Ok())
     {

-        wxLogError(_("XRC resource: Cannot create bitmap from '%s'."),
-                   name.c_str());
+        ReportParamError
+        (
+            param,
+            wxString::Format("cannot create bitmap from \"%s\"", name)
+        );

         return wxNullBitmap;
     }
     if (!(size == wxDefaultSize)) img.Rescale(size.x, size.y);
         return wxNullBitmap;
     }
     if (!(size == wxDefaultSize)) img.Rescale(size.x, size.y);


@@ -1256,7 +1374,11 @@ wxSize wxXmlResourceHandler::GetSize(const wxString& param,
     if (!s.BeforeFirst(wxT(',')).ToLong(&sx) ||
         !s.AfterLast(wxT(',')).ToLong(&sy))
     {
     if (!s.BeforeFirst(wxT(',')).ToLong(&sx) ||
         !s.AfterLast(wxT(',')).ToLong(&sy))
     {

-        wxLogError(_("Cannot parse coordinates from '%s'."), s.c_str());
+        ReportParamError
+        (
+            param,
+            wxString::Format("cannot parse coordinates value \"%s\"", s)
+        );

         return wxDefaultSize;
     }
 
         return wxDefaultSize;
     }
 


@@ -1272,7 +1394,11 @@ wxSize wxXmlResourceHandler::GetSize(const wxString& param,
         }
         else
         {
         }
         else
         {

-            wxLogError(_("Cannot convert dialog units: dialog unknown."));
+            ReportParamError
+            (
+                param,
+                "cannot convert dialog units: dialog unknown"
+            );

             return wxDefaultSize;
         }
     }
             return wxDefaultSize;
         }
     }


@@ -1304,7 +1430,11 @@ wxCoord wxXmlResourceHandler::GetDimension(const wxString& param,
 
     if (!s.ToLong(&sx))
     {
 
     if (!s.ToLong(&sx))
     {

-        wxLogError(_("Cannot parse dimension from '%s'."), s.c_str());
+        ReportParamError
+        (
+            param,
+            wxString::Format("cannot parse dimension value \"%s\"", s)
+        );

         return defaultv;
     }
 
         return defaultv;
     }
 


@@ -1320,7 +1450,11 @@ wxCoord wxXmlResourceHandler::GetDimension(const wxString& param,
         }
         else
         {
         }
         else
         {

-            wxLogError(_("Cannot convert dialog units: dialog unknown."));
+            ReportParamError
+            (
+                param,
+                "cannot convert dialog units: dialog unknown"
+            );

             return defaultv;
         }
     }
             return defaultv;
         }
     }


@@ -1341,7 +1475,6 @@ static wxFont GetSystemFont(const wxString& name)
         SYSFNT(wxSYS_ANSI_VAR_FONT)
         SYSFNT(wxSYS_SYSTEM_FONT)
         SYSFNT(wxSYS_DEVICE_DEFAULT_FONT)
         SYSFNT(wxSYS_ANSI_VAR_FONT)
         SYSFNT(wxSYS_SYSTEM_FONT)
         SYSFNT(wxSYS_DEVICE_DEFAULT_FONT)

-        SYSFNT(wxSYS_DEFAULT_PALETTE)

         SYSFNT(wxSYS_SYSTEM_FIXED_FONT)
         SYSFNT(wxSYS_DEFAULT_GUI_FONT)
         #undef SYSFNT
         SYSFNT(wxSYS_SYSTEM_FIXED_FONT)
         SYSFNT(wxSYS_DEFAULT_GUI_FONT)
         #undef SYSFNT


@@ -1355,7 +1488,8 @@ wxFont wxXmlResourceHandler::GetFont(const wxString& param)
     wxXmlNode *font_node = GetParamNode(param);
     if (font_node == NULL)
     {
     wxXmlNode *font_node = GetParamNode(param);
     if (font_node == NULL)
     {

-        wxLogError(_("Cannot find font node '%s'."), param.c_str());
+        ReportError(
+            wxString::Format("cannot find font node \"%s\"", param));

         return wxNullFont;
     }
 
         return wxNullFont;
     }
 


@@ -1518,17 +1652,13 @@ void wxXmlResourceHandler::SetupWindow(wxWindow *wnd)
 
 void wxXmlResourceHandler::CreateChildren(wxObject *parent, bool this_hnd_only)
 {
 
 void wxXmlResourceHandler::CreateChildren(wxObject *parent, bool this_hnd_only)
 {

-    wxXmlNode *n = m_node->GetChildren();
-
-    while (n)
+    for ( wxXmlNode *n = m_node->GetChildren(); n; n = n->GetNext() )

     {
     {

-        if (n->GetType() == wxXML_ELEMENT_NODE &&
-           (n->GetName() == wxT("object") || n->GetName() == wxT("object_ref")))
+        if ( IsObjectNode(n) )

         {
             m_resource->CreateResFromNode(n, parent, NULL,
                                           this_hnd_only ? this : NULL);
         }
         {
             m_resource->CreateResFromNode(n, parent, NULL,
                                           this_hnd_only ? this : NULL);
         }

-        n = n->GetNext();

     }
 }
 
     }
 }
 


@@ -1550,12 +1680,87 @@ void wxXmlResourceHandler::CreateChildrenPrivately(wxObject *parent, wxXmlNode *
 }
 
 
 }
 
 

+//-----------------------------------------------------------------------------
+// errors reporting
+//-----------------------------------------------------------------------------

 
 

+void wxXmlResourceHandler::ReportError(const wxString& message)
+{
+    m_resource->ReportError(m_node, message);
+}

 
 

+void wxXmlResourceHandler::ReportError(wxXmlNode *context,
+                                       const wxString& message)
+{
+    m_resource->ReportError(context ? context : m_node, message);
+}
+
+void wxXmlResourceHandler::ReportParamError(const wxString& param,
+                                            const wxString& message)
+{
+    m_resource->ReportError(GetParamNode(param), message);
+}
+
+namespace
+{

 
 

+wxString
+GetFileNameFromNode(wxXmlNode *node, const wxXmlResourceDataRecords& files)
+{
+    wxXmlNode *root = node;
+    while ( root->GetParent() )
+        root = root->GetParent();
+
+    for ( wxXmlResourceDataRecords::const_iterator i = files.begin();
+          i != files.end(); ++i )
+    {
+        if ( (*i)->Doc->GetRoot() == root )
+        {
+            return (*i)->File;
+        }
+    }
+
+    return wxEmptyString; // not found
+}
+
+} // anonymous namespace
+
+void wxXmlResource::ReportError(wxXmlNode *context, const wxString& message)
+{
+    if ( !context )
+    {
+        DoReportError("", NULL, message);
+        return;
+    }
+
+    // We need to find out the file that 'context' is part of. Performance of
+    // this code is not critical, so we simply find the root XML node and
+    // compare it with all loaded XRC files.
+    const wxString filename = GetFileNameFromNode(context, Data());
+
+    DoReportError(filename, context, message);
+}
+
+void wxXmlResource::DoReportError(const wxString& xrcFile, wxXmlNode *position,
+                                  const wxString& message)
+{
+    const int line = position ? position->GetLineNumber() : -1;
+
+    wxString loc;
+    if ( !xrcFile.empty() )
+        loc = xrcFile + ':';
+    if ( line != -1 )
+        loc += wxString::Format("%d:", line);
+    if ( !loc.empty() )
+        loc += ' ';
+
+    wxLogError("XRC error: %s%s", loc, message);
+}

 
 
 
 

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

 
 #define XRCID_TABLE_SIZE     1024
 
 
 #define XRCID_TABLE_SIZE     1024
 


@@ -1798,7 +2003,9 @@ static void AddStdXRCID_Records()
 
 
 
 
 
 

-// --------------- module and globals -----------------------------
+//-----------------------------------------------------------------------------
+// module and globals
+//-----------------------------------------------------------------------------

 
 // normally we would do the cleanup from wxXmlResourceModule::OnExit() but it
 // can happen that some XRC records have been created because of the use of
 
 // normally we would do the cleanup from wxXmlResourceModule::OnExit() but it
 // can happen that some XRC records have been created because of the use of