X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6df6e35a3eae74404f15f8f7c09ce19c29f47b4a..2bdba43f026251eafe1cfe3ad35ee4ca08f9253b:/src/xml/xml.cpp diff --git a/src/xml/xml.cpp b/src/xml/xml.cpp index 4c94c15431..4941e6104b 100644 --- a/src/xml/xml.cpp +++ b/src/xml/xml.cpp @@ -40,7 +40,7 @@ IMPLEMENT_CLASS(wxXmlDocument, wxObject) // a private utility used by wxXML -static bool wxIsWhiteOnly(const wxChar *buf); +static bool wxIsWhiteOnly(const wxString& buf); //----------------------------------------------------------------------------- @@ -49,10 +49,11 @@ static bool wxIsWhiteOnly(const wxChar *buf); wxXmlNode::wxXmlNode(wxXmlNode *parent,wxXmlNodeType type, const wxString& name, const wxString& content, - wxXmlProperty *props, wxXmlNode *next) + wxXmlAttribute *attrs, wxXmlNode *next, int lineNo) : m_type(type), m_name(name), m_content(content), - m_properties(props), m_parent(parent), - m_children(NULL), m_next(next) + m_attrs(attrs), m_parent(parent), + m_children(NULL), m_next(next), + m_lineNo(lineNo) { if (m_parent) { @@ -67,10 +68,12 @@ wxXmlNode::wxXmlNode(wxXmlNode *parent,wxXmlNodeType type, } wxXmlNode::wxXmlNode(wxXmlNodeType type, const wxString& name, - const wxString& content) + const wxString& content, + int lineNo) : m_type(type), m_name(name), m_content(content), - m_properties(NULL), m_parent(NULL), - m_children(NULL), m_next(NULL) + m_attrs(NULL), m_parent(NULL), + m_children(NULL), m_next(NULL), + m_lineNo(lineNo) {} wxXmlNode::wxXmlNode(const wxXmlNode& node) @@ -89,8 +92,8 @@ wxXmlNode::~wxXmlNode() delete c; } - wxXmlProperty *p, *p2; - for (p = m_properties; p; p = p2) + wxXmlAttribute *p, *p2; + for (p = m_attrs; p; p = p2) { p2 = p->GetNext(); delete p; @@ -99,7 +102,7 @@ wxXmlNode::~wxXmlNode() wxXmlNode& wxXmlNode::operator=(const wxXmlNode& node) { - wxDELETE(m_properties); + wxDELETE(m_attrs); wxDELETE(m_children); DoCopy(node); return *this; @@ -110,6 +113,7 @@ void wxXmlNode::DoCopy(const wxXmlNode& node) m_type = node.m_type; m_name = node.m_name; m_content = node.m_content; + m_lineNo = node.m_lineNo; m_children = NULL; wxXmlNode *n = node.m_children; @@ -119,49 +123,51 @@ void wxXmlNode::DoCopy(const wxXmlNode& node) n = n->GetNext(); } - m_properties = NULL; - wxXmlProperty *p = node.m_properties; + m_attrs = NULL; + wxXmlAttribute *p = node.m_attrs; while (p) { - AddProperty(p->GetName(), p->GetValue()); + AddAttribute(p->GetName(), p->GetValue()); p = p->GetNext(); } } -bool wxXmlNode::HasProp(const wxString& propName) const +bool wxXmlNode::HasAttribute(const wxString& attrName) const { - wxXmlProperty *prop = GetProperties(); + wxXmlAttribute *attr = GetAttributes(); - while (prop) + while (attr) { - if (prop->GetName() == propName) return true; - prop = prop->GetNext(); + if (attr->GetName() == attrName) return true; + attr = attr->GetNext(); } return false; } -bool wxXmlNode::GetPropVal(const wxString& propName, wxString *value) const +bool wxXmlNode::GetAttribute(const wxString& attrName, wxString *value) const { - wxXmlProperty *prop = GetProperties(); + wxCHECK_MSG( value, false, "value argument must not be NULL" ); - while (prop) + wxXmlAttribute *attr = GetAttributes(); + + while (attr) { - if (prop->GetName() == propName) + if (attr->GetName() == attrName) { - *value = prop->GetValue(); + *value = attr->GetValue(); return true; } - prop = prop->GetNext(); + attr = attr->GetNext(); } return false; } -wxString wxXmlNode::GetPropVal(const wxString& propName, const wxString& defaultVal) const +wxString wxXmlNode::GetAttribute(const wxString& attrName, const wxString& defaultVal) const { wxString tmp; - if (GetPropVal(propName, &tmp)) + if (GetAttribute(attrName, &tmp)) return tmp; return defaultVal; @@ -181,39 +187,69 @@ void wxXmlNode::AddChild(wxXmlNode *child) child->m_parent = this; } -bool wxXmlNode::InsertChild(wxXmlNode *child, wxXmlNode *before_node) +// inserts a new node in front of 'followingNode' +bool wxXmlNode::InsertChild(wxXmlNode *child, wxXmlNode *followingNode) { - wxCHECK_MSG(before_node == NULL || before_node->GetParent() == this, false, - wxT("wxXmlNode::InsertChild - the node has incorrect parent")); - wxCHECK_MSG(child, false, wxT("Cannot insert a NULL pointer!")); + wxCHECK_MSG( child, false, "cannot insert a NULL node!" ); + wxCHECK_MSG( child->m_parent == NULL, false, "node already has a parent" ); + wxCHECK_MSG( child->m_next == NULL, false, "node already has m_next" ); + wxCHECK_MSG( followingNode == NULL || followingNode->GetParent() == this, + false, + "wxXmlNode::InsertChild - followingNode has incorrect parent" ); - if (m_children == before_node) - m_children = child; - else if (m_children == NULL) - { - if (before_node != NULL) - return false; // we have no children so we don't need to search - m_children = child; - } - else if (before_node == NULL) + // this is for backward compatibility, NULL was allowed here thanks to + // the confusion about followingNode's meaning + if ( followingNode == NULL ) + followingNode = m_children; + + if ( m_children == followingNode ) { - // prepend child - child->m_parent = this; child->m_next = m_children; m_children = child; - return true; } else { wxXmlNode *ch = m_children; - while (ch && ch->m_next != before_node) ch = ch->m_next; - if (!ch) - return false; // before_node not found + while ( ch && ch->m_next != followingNode ) + ch = ch->m_next; + if ( !ch ) + { + wxFAIL_MSG( "followingNode has this node as parent, but couldn't be found among children" ); + return false; + } + + child->m_next = followingNode; ch->m_next = child; } child->m_parent = this; - child->m_next = before_node; + return true; +} + +// inserts a new node right after 'precedingNode' +bool wxXmlNode::InsertChildAfter(wxXmlNode *child, wxXmlNode *precedingNode) +{ + wxCHECK_MSG( child, false, "cannot insert a NULL node!" ); + wxCHECK_MSG( child->m_parent == NULL, false, "node already has a parent" ); + wxCHECK_MSG( child->m_next == NULL, false, "node already has m_next" ); + wxCHECK_MSG( precedingNode == NULL || precedingNode->m_parent == this, false, + "precedingNode has wrong parent" ); + + if ( precedingNode ) + { + child->m_next = precedingNode->m_next; + precedingNode->m_next = child; + } + else // precedingNode == NULL + { + wxCHECK_MSG( m_children == NULL, false, + "NULL precedingNode only makes sense when there are no children" ); + + child->m_next = m_children; + m_children = child; + } + + child->m_parent = this; return true; } @@ -246,50 +282,65 @@ bool wxXmlNode::RemoveChild(wxXmlNode *child) } } +void wxXmlNode::AddAttribute(const wxString& name, const wxString& value) +{ + AddProperty(name, value); +} + +void wxXmlNode::AddAttribute(wxXmlAttribute *attr) +{ + AddProperty(attr); +} + +bool wxXmlNode::DeleteAttribute(const wxString& name) +{ + return DeleteProperty(name); +} + void wxXmlNode::AddProperty(const wxString& name, const wxString& value) { - AddProperty(new wxXmlProperty(name, value, NULL)); + AddProperty(new wxXmlAttribute(name, value, NULL)); } -void wxXmlNode::AddProperty(wxXmlProperty *prop) +void wxXmlNode::AddProperty(wxXmlAttribute *attr) { - if (m_properties == NULL) - m_properties = prop; + if (m_attrs == NULL) + m_attrs = attr; else { - wxXmlProperty *p = m_properties; + wxXmlAttribute *p = m_attrs; while (p->GetNext()) p = p->GetNext(); - p->SetNext(prop); + p->SetNext(attr); } } bool wxXmlNode::DeleteProperty(const wxString& name) { - wxXmlProperty *prop; + wxXmlAttribute *attr; - if (m_properties == NULL) + if (m_attrs == NULL) return false; - else if (m_properties->GetName() == name) + else if (m_attrs->GetName() == name) { - prop = m_properties; - m_properties = prop->GetNext(); - prop->SetNext(NULL); - delete prop; + attr = m_attrs; + m_attrs = attr->GetNext(); + attr->SetNext(NULL); + delete attr; return true; } else { - wxXmlProperty *p = m_properties; + wxXmlAttribute *p = m_attrs; while (p->GetNext()) { if (p->GetNext()->GetName() == name) { - prop = p->GetNext(); - p->SetNext(prop->GetNext()); - prop->SetNext(NULL); - delete prop; + attr = p->GetNext(); + p->SetNext(attr->GetNext()); + attr->SetNext(NULL); + delete attr; return true; } p = p->GetNext(); @@ -386,7 +437,11 @@ void wxXmlDocument::DoCopy(const wxXmlDocument& doc) m_encoding = doc.m_encoding; #endif m_fileEncoding = doc.m_fileEncoding; - m_root = new wxXmlNode(*doc.m_root); + + if (doc.m_root) + m_root = new wxXmlNode(*doc.m_root); + else + m_root = NULL; } bool wxXmlDocument::Load(const wxString& filename, const wxString& encoding, int flags) @@ -414,13 +469,9 @@ bool wxXmlDocument::Save(const wxString& filename, int indentstep) const // converts Expat-produced string in UTF-8 into wxString using the specified // conv or keep in UTF-8 if conv is NULL static wxString CharToString(wxMBConv *conv, - const char *s, size_t len = wxString::npos) + const char *s, size_t len = wxString::npos) { -#if wxUSE_UNICODE - wxUnusedVar(conv); - - return wxString(s, wxConvUTF8, len); -#else // !wxUSE_UNICODE +#if !wxUSE_UNICODE if ( conv ) { // there can be no embedded NULs in this string so we don't need the @@ -430,66 +481,101 @@ static wxString CharToString(wxMBConv *conv, return wxString(wbuf, *conv); } - else // already in UTF-8, no conversion needed - { - return wxString(s, len != wxString::npos ? len : strlen(s)); - } -#endif // wxUSE_UNICODE/!wxUSE_UNICODE + // else: the string is wanted in UTF-8 +#endif // !wxUSE_UNICODE + + wxUnusedVar(conv); + return wxString::FromUTF8(s, len); } // returns true if the given string contains only whitespaces -bool wxIsWhiteOnly(const wxChar *buf) +bool wxIsWhiteOnly(const wxString& buf) { - for (const wxChar *c = buf; *c != wxT('\0'); c++) - if (*c != wxT(' ') && *c != wxT('\t') && *c != wxT('\n') && *c != wxT('\r')) + for ( wxString::const_iterator i = buf.begin(); i != buf.end(); ++i ) + { + wxChar c = *i; + if ( c != wxT(' ') && c != wxT('\t') && c != wxT('\n') && c != wxT('\r')) return false; + } return true; } struct wxXmlParsingContext { + wxXmlParsingContext() + : conv(NULL), + root(NULL), + node(NULL), + lastChild(NULL), + lastAsText(NULL), + removeWhiteOnlyNodes(false) + {} + + XML_Parser parser; wxMBConv *conv; wxXmlNode *root; - wxXmlNode *node; - wxXmlNode *lastAsText; + wxXmlNode *node; // the node being parsed + wxXmlNode *lastChild; // the last child of "node" + wxXmlNode *lastAsText; // the last _text_ child of "node" wxString encoding; wxString version; - bool bLastCdata; bool removeWhiteOnlyNodes; }; +// checks that ctx->lastChild is in consistent state +#define ASSERT_LAST_CHILD_OK(ctx) \ + wxASSERT( ctx->lastChild == NULL || \ + ctx->lastChild->GetNext() == NULL ); \ + wxASSERT( ctx->lastChild == NULL || \ + ctx->lastChild->GetParent() == ctx->node ) + extern "C" { static void StartElementHnd(void *userData, const char *name, const char **atts) { wxXmlParsingContext *ctx = (wxXmlParsingContext*)userData; - wxXmlNode *node = new wxXmlNode(wxXML_ELEMENT_NODE, CharToString(ctx->conv, name)); + wxXmlNode *node = new wxXmlNode(wxXML_ELEMENT_NODE, + CharToString(ctx->conv, name), + wxEmptyString, + XML_GetCurrentLineNumber(ctx->parser)); const char **a = atts; + + // add node attributes while (*a) { - node->AddProperty(CharToString(ctx->conv, a[0]), CharToString(ctx->conv, a[1])); + node->AddAttribute(CharToString(ctx->conv, a[0]), CharToString(ctx->conv, a[1])); a += 2; } + if (ctx->root == NULL) + { ctx->root = node; + } else - ctx->node->AddChild(node); - ctx->node = node; + { + ASSERT_LAST_CHILD_OK(ctx); + ctx->node->InsertChildAfter(node, ctx->lastChild); + } + ctx->lastAsText = NULL; -} + ctx->lastChild = NULL; // our new node "node" has no children yet + + ctx->node = node; } -extern "C" { static void EndElementHnd(void *userData, const char* WXUNUSED(name)) { wxXmlParsingContext *ctx = (wxXmlParsingContext*)userData; + // we're exiting the last children of ctx->node->GetParent() and going + // back one level up, so current value of ctx->node points to the last + // child of ctx->node->GetParent() + ctx->lastChild = ctx->node; + ctx->node = ctx->node->GetParent(); ctx->lastAsText = NULL; } -} -extern "C" { static void TextHnd(void *userData, const char *s, int len) { wxXmlParsingContext *ctx = (wxXmlParsingContext*)userData; @@ -497,15 +583,7 @@ static void TextHnd(void *userData, const char *s, int len) if (ctx->lastAsText) { - if ( ctx->bLastCdata ) - { - ctx->lastAsText->SetContent(ctx->lastAsText->GetContent() + - CharToString(NULL, s, len)); - } - else - { - ctx->lastAsText->SetContent(ctx->lastAsText->GetContent() + str); - } + ctx->lastAsText->SetContent(ctx->lastAsText->GetContent() + str); } else { @@ -515,52 +593,52 @@ static void TextHnd(void *userData, const char *s, int len) if (!whiteOnly) { - ctx->lastAsText = new wxXmlNode(wxXML_TEXT_NODE, wxT("text"), str); - ctx->node->AddChild(ctx->lastAsText); + wxXmlNode *textnode = + new wxXmlNode(wxXML_TEXT_NODE, wxT("text"), str, + XML_GetCurrentLineNumber(ctx->parser)); + + ASSERT_LAST_CHILD_OK(ctx); + ctx->node->InsertChildAfter(textnode, ctx->lastChild); + ctx->lastChild= ctx->lastAsText = textnode; } } } -} -extern "C" { static void StartCdataHnd(void *userData) { wxXmlParsingContext *ctx = (wxXmlParsingContext*)userData; - ctx->bLastCdata = true; - - ctx->lastAsText = new wxXmlNode(wxXML_CDATA_SECTION_NODE, wxT("cdata"),wxT("")); - ctx->node->AddChild(ctx->lastAsText); -} -} - -extern "C" { -static void EndCdataHnd(void *userData) -{ - wxXmlParsingContext *ctx = (wxXmlParsingContext*)userData; + wxXmlNode *textnode = + new wxXmlNode(wxXML_CDATA_SECTION_NODE, wxT("cdata"), wxT(""), + XML_GetCurrentLineNumber(ctx->parser)); - ctx->bLastCdata = false; -} + ASSERT_LAST_CHILD_OK(ctx); + ctx->node->InsertChildAfter(textnode, ctx->lastChild); + ctx->lastChild= ctx->lastAsText = textnode; } -extern "C" { static void CommentHnd(void *userData, const char *data) { wxXmlParsingContext *ctx = (wxXmlParsingContext*)userData; if (ctx->node) { - // VS: ctx->node == NULL happens if there is a comment before - // the root element (e.g. wxDesigner's output). We ignore such - // comments, no big deal... - ctx->node->AddChild(new wxXmlNode(wxXML_COMMENT_NODE, - wxT("comment"), CharToString(ctx->conv, data))); + wxXmlNode *commentnode = + new wxXmlNode(wxXML_COMMENT_NODE, + wxT("comment"), CharToString(ctx->conv, data), + XML_GetCurrentLineNumber(ctx->parser)); + + ASSERT_LAST_CHILD_OK(ctx); + ctx->node->InsertChildAfter(commentnode, ctx->lastChild); + ctx->lastChild = commentnode; } + //else: ctx->node == NULL happens if there is a comment before + // the root element. We current don't have a way to represent + // these in wxXmlDocument (FIXME). + ctx->lastAsText = NULL; } -} -extern "C" { static void DefaultHnd(void *userData, const char *s, int len) { // XML header: @@ -578,17 +656,14 @@ static void DefaultHnd(void *userData, const char *s, int len) ctx->version = buf.Mid(pos + 9).BeforeFirst(buf[(size_t)pos+8]); } } -} -extern "C" { static int UnknownEncodingHnd(void * WXUNUSED(encodingHandlerData), const XML_Char *name, XML_Encoding *info) { // We must build conversion table for expat. The easiest way to do so // is to let wxCSConv convert as string containing all characters to // wide character representation: - wxString str(name, wxConvLibc); - wxCSConv conv(str); + wxCSConv conv(name); char mbBuf[2]; wchar_t wcBuf[10]; size_t i; @@ -612,7 +687,8 @@ static int UnknownEncodingHnd(void * WXUNUSED(encodingHandlerData), return 1; } -} + +} // extern "C" bool wxXmlDocument::Load(wxInputStream& stream, const wxString& encoding, int flags) { @@ -628,20 +704,19 @@ bool wxXmlDocument::Load(wxInputStream& stream, const wxString& encoding, int fl bool done; XML_Parser parser = XML_ParserCreate(NULL); - ctx.root = ctx.node = NULL; ctx.encoding = wxT("UTF-8"); // default in absence of encoding="" ctx.conv = NULL; #if !wxUSE_UNICODE - if ( encoding != wxT("UTF-8") && encoding != wxT("utf-8") ) + if ( encoding.CmpNoCase(wxT("UTF-8")) != 0 ) ctx.conv = new wxCSConv(encoding); #endif ctx.removeWhiteOnlyNodes = (flags & wxXMLDOC_KEEP_WHITESPACE_NODES) == 0; - ctx.bLastCdata = false; + ctx.parser = parser; XML_SetUserData(parser, (void*)&ctx); XML_SetElementHandler(parser, StartElementHnd, EndElementHnd); XML_SetCharacterDataHandler(parser, TextHnd); - XML_SetCdataSectionHandler(parser, StartCdataHnd, EndCdataHnd ); + XML_SetStartCdataSectionHandler(parser, StartCdataHnd); XML_SetCommentHandler(parser, CommentHnd); XML_SetDefaultHandler(parser, DefaultHnd); XML_SetUnknownEncodingHandler(parser, UnknownEncodingHnd, NULL); @@ -780,7 +855,7 @@ static void OutputNode(wxOutputStream& stream, wxXmlNode *node, int indent, wxMBConv *convMem, wxMBConv *convFile, int indentstep) { wxXmlNode *n, *prev; - wxXmlProperty *prop; + wxXmlAttribute *attr; switch (node->GetType()) { @@ -798,14 +873,14 @@ static void OutputNode(wxOutputStream& stream, wxXmlNode *node, int indent, OutputString(stream, wxT("<")); OutputString(stream, node->GetName()); - prop = node->GetProperties(); - while (prop) + attr = node->GetAttributes(); + while (attr) { - OutputString(stream, wxT(" ") + prop->GetName() + wxT("=\"")); - OutputStringEnt(stream, prop->GetValue(), convMem, convFile, + OutputString(stream, wxT(" ") + attr->GetName() + wxT("=\"")); + OutputStringEnt(stream, attr->GetValue(), convMem, convFile, XML_ESCAPE_QUOTES); OutputString(stream, wxT("\"")); - prop = prop->GetNext(); + attr = attr->GetNext(); } if (node->GetChildren()) @@ -849,17 +924,23 @@ bool wxXmlDocument::Save(wxOutputStream& stream, int indentstep) const wxString s; - wxMBConv *convMem = NULL; + wxMBConv *convMem = NULL, + *convFile; #if wxUSE_UNICODE - wxMBConv *convFile = new wxCSConv(GetFileEncoding()); + convFile = new wxCSConv(GetFileEncoding()); + convMem = NULL; #else - wxMBConv *convFile = NULL; - if ( GetFileEncoding() != GetEncoding() ) + if ( GetFileEncoding().CmpNoCase(GetEncoding()) != 0 ) { convFile = new wxCSConv(GetFileEncoding()); convMem = new wxCSConv(GetEncoding()); } + else // file and in-memory encodings are the same, no conversion needed + { + convFile = + convMem = NULL; + } #endif s.Printf(wxT("\n"), @@ -869,10 +950,8 @@ bool wxXmlDocument::Save(wxOutputStream& stream, int indentstep) const OutputNode(stream, GetRoot(), 0, convMem, convFile, indentstep); OutputString(stream, wxT("\n")); - if ( convFile ) - delete convFile; - if ( convMem ) - delete convMem; + delete convFile; + delete convMem; return true; }