added encodings handling to XRC, so that it is possible to load resources that don't use English+wxLocale for i18n

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

contrib/include/wx/xrc/xml.h

@@ -100,12 +100,8 @@ private:
 // element with name="title", irrelevant content and one child (wxXML_TEXT_NODE
 // with content="hi").
 //
-// If wxUSE_UNICODE is 0, all strings are encoded in UTF-8 encoding (same as
+// If wxUSE_UNICODE is 0, all strings are encoded in the encoding given to Load
-// ASCII for characters 0-127). You can use wxMBConvUTF8 to convert then to
+// (default is UTF-8).
-// desired encoding:
-//
-//     wxCSConv myConv("iso8859-2");
-//     wxString s(cMB2WC(node->GetContent().c_str()), myConv);
 
 class WXXMLDLLEXPORT wxXmlNode
 {
@@ -175,18 +171,18 @@ private:
 
 
 
-// This class holds XML data/document as parsed by libxml. Note that
+// This class holds XML data/document as parsed by XML parser.
-// internal representation is independant on libxml and you can use
-// it without libxml (see Load/SaveBinary).
 
 class WXXMLDLLEXPORT wxXmlDocument : public wxObject
 {
 public:
     wxXmlDocument() : wxObject(), m_version(wxT("1.0")), m_root(NULL)  {}
     wxXmlDocument(const wxString& filename,
-                  wxXmlIOType io_type = wxXML_IO_AUTO);
+                  wxXmlIOType io_type = wxXML_IO_AUTO,
+                  const wxString& encoding = wxT("UTF-8"));
     wxXmlDocument(wxInputStream& stream,
-                  wxXmlIOType io_type = wxXML_IO_AUTO);
+                  wxXmlIOType io_type = wxXML_IO_AUTO,
+                  const wxString& encoding = wxT("UTF-8"));
     ~wxXmlDocument() { delete m_root; }
 
     wxXmlDocument(const wxXmlDocument& doc);
@@ -194,10 +190,12 @@ public:
 
     // Parses .xml file and loads data. Returns TRUE on success, FALSE
     // otherwise.
-    // NOTE: Any call to this method will result into linking against libxml
+    bool Load(const wxString& filename,
-    //       and app's binary size will grow by ca. 250kB
+              wxXmlIOType io_type = wxXML_IO_AUTO,
-    bool Load(const wxString& filename, wxXmlIOType io_type = wxXML_IO_AUTO);
+              const wxString& encoding = wxT("UTF-8"));
-    bool Load(wxInputStream& stream, wxXmlIOType io_type = wxXML_IO_AUTO);
+    bool Load(wxInputStream& stream,
+              wxXmlIOType io_type = wxXML_IO_AUTO,
+              const wxString& encoding = wxT("UTF-8"));
 
     // Saves document as .xml file.
     bool Save(const wxString& filename,
@@ -214,15 +212,20 @@ public:
     wxString GetVersion() const { return m_version; }
     // Returns encoding of document (may be empty).
     // Note: this is the encoding original fail was saved in, *not* the
-    // encoding of in-memory representation! Data in wxXmlNode are always
+    // encoding of in-memory representation!
-    // stored in wchar_t (in Unicode build) or UTF-8 encoded
+    wxString GetFileEncoding() const { return m_fileEncoding; }
-    // (if wxUSE_UNICODE is 0).
-    wxString GetEncoding() const { return m_encoding; }
 
     // Write-access methods:
     void SetRoot(wxXmlNode *node) { delete m_root ; m_root = node; }
     void SetVersion(const wxString& version) { m_version = version; }
-    void SetEncoding(const wxString& encoding) { m_encoding = encoding; }
+    void SetFileEncoding(const wxString& encoding) { m_fileEncoding = encoding; }
+
+#if !wxUSE_UNICODE
+    // Returns encoding of in-memory representation of the document
+    // (same as passed to Load or ctor, defaults to UTF-8).
+    // NB: this is meaningless in Unicode build where data are stored as wchar_t*
+    wxString GetEncoding() const { return m_encoding; }
+#endif
 
     static void AddHandler(wxXmlIOHandler *handler);
     static void CleanUpHandlers();
@@ -232,7 +235,11 @@ protected:
     static wxList *sm_handlers;
 
 private:
-    wxString m_version, m_encoding;
+    wxString   m_version;
+    wxString   m_fileEncoding;
+#if !wxUSE_UNICODE
+    wxString   m_encoding;
+#endif
     wxXmlNode *m_root;
 
     void DoCopy(const wxXmlDocument& doc);
@@ -252,7 +259,8 @@ class WXXMLDLLEXPORT wxXmlIOHandler : public wxObject
         virtual bool CanLoad(wxInputStream& stream) = 0;
         virtual bool CanSave() = 0;
 
-        virtual bool Load(wxInputStream& stream, wxXmlDocument& doc) = 0;
+        virtual bool Load(wxInputStream& stream, wxXmlDocument& doc, 
+                          const wxString& encoding) = 0;
         virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc) = 0;
 };
 

contrib/include/wx/xrc/xmlio.h

@@ -27,7 +27,8 @@ public:
     virtual bool CanLoad(wxInputStream& stream);
     virtual bool CanSave() { return FALSE; }
 
-    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc);
+    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc,
+                      const wxString& encoding);
     virtual bool Save(wxOutputStream& WXUNUSED(stream), const wxXmlDocument& WXUNUSED(doc))
         { return FALSE; }
 };
@@ -40,7 +41,8 @@ public:
     virtual bool CanLoad(wxInputStream& WXUNUSED(stream)) { return FALSE; }
     virtual bool CanSave() { return TRUE; }
 
-    virtual bool Load(wxInputStream& WXUNUSED(stream), wxXmlDocument& WXUNUSED(doc)) 
+    virtual bool Load(wxInputStream& WXUNUSED(stream), wxXmlDocument& WXUNUSED(doc),
+                      const wxString& WXUNUSED(encoding))
         { return FALSE; }
     virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc);
 };
@@ -55,7 +57,8 @@ public:
     virtual bool CanLoad(wxInputStream& stream);
     virtual bool CanSave() { return TRUE; }
 
-    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc);
+    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc,
+                      const wxString& encoding);
     virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc);
 
 protected:
@@ -75,7 +78,8 @@ public:
     virtual wxXmlIOType GetType() { return wxXML_IO_BINZ; }
     virtual bool CanLoad(wxInputStream& stream);
 
-    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc);
+    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc,
+                      const wxString& encoding);
     virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc);
 };
 

include/wx/xrc/xml.h

@@ -100,12 +100,8 @@ private:
 // element with name="title", irrelevant content and one child (wxXML_TEXT_NODE
 // with content="hi").
 //
-// If wxUSE_UNICODE is 0, all strings are encoded in UTF-8 encoding (same as
+// If wxUSE_UNICODE is 0, all strings are encoded in the encoding given to Load
-// ASCII for characters 0-127). You can use wxMBConvUTF8 to convert then to
+// (default is UTF-8).
-// desired encoding:
-//
-//     wxCSConv myConv("iso8859-2");
-//     wxString s(cMB2WC(node->GetContent().c_str()), myConv);
 
 class WXXMLDLLEXPORT wxXmlNode
 {
@@ -175,18 +171,18 @@ private:
 
 
 
-// This class holds XML data/document as parsed by libxml. Note that
+// This class holds XML data/document as parsed by XML parser.
-// internal representation is independant on libxml and you can use
-// it without libxml (see Load/SaveBinary).
 
 class WXXMLDLLEXPORT wxXmlDocument : public wxObject
 {
 public:
     wxXmlDocument() : wxObject(), m_version(wxT("1.0")), m_root(NULL)  {}
     wxXmlDocument(const wxString& filename,
-                  wxXmlIOType io_type = wxXML_IO_AUTO);
+                  wxXmlIOType io_type = wxXML_IO_AUTO,
+                  const wxString& encoding = wxT("UTF-8"));
     wxXmlDocument(wxInputStream& stream,
-                  wxXmlIOType io_type = wxXML_IO_AUTO);
+                  wxXmlIOType io_type = wxXML_IO_AUTO,
+                  const wxString& encoding = wxT("UTF-8"));
     ~wxXmlDocument() { delete m_root; }
 
     wxXmlDocument(const wxXmlDocument& doc);
@@ -194,10 +190,12 @@ public:
 
     // Parses .xml file and loads data. Returns TRUE on success, FALSE
     // otherwise.
-    // NOTE: Any call to this method will result into linking against libxml
+    bool Load(const wxString& filename,
-    //       and app's binary size will grow by ca. 250kB
+              wxXmlIOType io_type = wxXML_IO_AUTO,
-    bool Load(const wxString& filename, wxXmlIOType io_type = wxXML_IO_AUTO);
+              const wxString& encoding = wxT("UTF-8"));
-    bool Load(wxInputStream& stream, wxXmlIOType io_type = wxXML_IO_AUTO);
+    bool Load(wxInputStream& stream,
+              wxXmlIOType io_type = wxXML_IO_AUTO,
+              const wxString& encoding = wxT("UTF-8"));
 
     // Saves document as .xml file.
     bool Save(const wxString& filename,
@@ -214,15 +212,20 @@ public:
     wxString GetVersion() const { return m_version; }
     // Returns encoding of document (may be empty).
     // Note: this is the encoding original fail was saved in, *not* the
-    // encoding of in-memory representation! Data in wxXmlNode are always
+    // encoding of in-memory representation!
-    // stored in wchar_t (in Unicode build) or UTF-8 encoded
+    wxString GetFileEncoding() const { return m_fileEncoding; }
-    // (if wxUSE_UNICODE is 0).
-    wxString GetEncoding() const { return m_encoding; }
 
     // Write-access methods:
     void SetRoot(wxXmlNode *node) { delete m_root ; m_root = node; }
     void SetVersion(const wxString& version) { m_version = version; }
-    void SetEncoding(const wxString& encoding) { m_encoding = encoding; }
+    void SetFileEncoding(const wxString& encoding) { m_fileEncoding = encoding; }
+
+#if !wxUSE_UNICODE
+    // Returns encoding of in-memory representation of the document
+    // (same as passed to Load or ctor, defaults to UTF-8).
+    // NB: this is meaningless in Unicode build where data are stored as wchar_t*
+    wxString GetEncoding() const { return m_encoding; }
+#endif
 
     static void AddHandler(wxXmlIOHandler *handler);
     static void CleanUpHandlers();
@@ -232,7 +235,11 @@ protected:
     static wxList *sm_handlers;
 
 private:
-    wxString m_version, m_encoding;
+    wxString   m_version;
+    wxString   m_fileEncoding;
+#if !wxUSE_UNICODE
+    wxString   m_encoding;
+#endif
     wxXmlNode *m_root;
 
     void DoCopy(const wxXmlDocument& doc);
@@ -252,7 +259,8 @@ class WXXMLDLLEXPORT wxXmlIOHandler : public wxObject
         virtual bool CanLoad(wxInputStream& stream) = 0;
         virtual bool CanSave() = 0;
 
-        virtual bool Load(wxInputStream& stream, wxXmlDocument& doc) = 0;
+        virtual bool Load(wxInputStream& stream, wxXmlDocument& doc, 
+                          const wxString& encoding) = 0;
         virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc) = 0;
 };
 

include/wx/xrc/xmlio.h

@@ -27,7 +27,8 @@ public:
     virtual bool CanLoad(wxInputStream& stream);
     virtual bool CanSave() { return FALSE; }
 
-    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc);
+    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc,
+                      const wxString& encoding);
     virtual bool Save(wxOutputStream& WXUNUSED(stream), const wxXmlDocument& WXUNUSED(doc))
         { return FALSE; }
 };
@@ -40,7 +41,8 @@ public:
     virtual bool CanLoad(wxInputStream& WXUNUSED(stream)) { return FALSE; }
     virtual bool CanSave() { return TRUE; }
 
-    virtual bool Load(wxInputStream& WXUNUSED(stream), wxXmlDocument& WXUNUSED(doc)) 
+    virtual bool Load(wxInputStream& WXUNUSED(stream), wxXmlDocument& WXUNUSED(doc),
+                      const wxString& WXUNUSED(encoding))
         { return FALSE; }
     virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc);
 };
@@ -55,7 +57,8 @@ public:
     virtual bool CanLoad(wxInputStream& stream);
     virtual bool CanSave() { return TRUE; }
 
-    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc);
+    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc,
+                      const wxString& encoding);
     virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc);
 
 protected:
@@ -75,7 +78,8 @@ public:
     virtual wxXmlIOType GetType() { return wxXML_IO_BINZ; }
     virtual bool CanLoad(wxInputStream& stream);
 
-    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc);
+    virtual bool Load(wxInputStream& stream, wxXmlDocument& doc,
+                      const wxString& encoding);
     virtual bool Save(wxOutputStream& stream, const wxXmlDocument& doc);
 };