X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/83fdf79672dfe71b6c0bb9ea52a7df723a292b12..90e10cd1bedc5cac1ce1b5331d6fd2a351014cfa:/utils/ifacecheck/src/xmlparser.cpp?ds=inline diff --git a/utils/ifacecheck/src/xmlparser.cpp b/utils/ifacecheck/src/xmlparser.cpp index c9dae4fc52..350d2f0986 100644 --- a/utils/ifacecheck/src/xmlparser.cpp +++ b/utils/ifacecheck/src/xmlparser.cpp @@ -1,4 +1,4 @@ - ///////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// // Name: xmlparser.cpp // Purpose: Parser of the API/interface XML files // Author: Francesco Montorsi @@ -68,6 +68,7 @@ void wxType::SetTypeFromString(const wxString& t) m_strType.Replace("[]", "*"); m_strType.Replace("long int", "long"); // in wx typically we never write "long int", just "long" m_strType.Replace("long unsigned int", "unsigned long"); + m_strType.Replace("short unsigned int", "unsigned short"); // make sure the * and & operator always use the same spacing rules // (to make sure GetAsString() output is always consistent) @@ -82,7 +83,8 @@ void wxType::SetTypeFromString(const wxString& t) m_strType.Replace(" ,", ","); // ADHOC-FIX - m_strType.Replace("_wxArraywxArrayStringBase", "const wxString&"); + m_strType.Replace("_wxArraywxArrayStringBase", "wxString"); + m_strType.Replace("ExitCode", "void*"); // used in wxThread stuff m_strType = m_strType.Strip(wxString::both); @@ -104,12 +106,12 @@ void wxType::SetTypeFromString(const wxString& t) if (m_strTypeClean.EndsWith("Base")) m_strTypeClean = m_strTypeClean.Left(m_strTypeClean.Len()-4); + // remove the namespace from the types; there's no problem of conflicts + // (except for templates) and this avoids tons of false warnings + if (m_strTypeClean.Contains("::") && !m_strTypeClean.Contains("<")) + m_strTypeClean = m_strTypeClean.Mid(m_strTypeClean.Find("::")+2); + // ADHOC-FIX: - // doxygen likes to put wxDateTime:: in front of all wxDateTime enums; - // fix this to avoid false positives - m_strTypeClean.Replace("wxDateTime::", ""); - m_strTypeClean.Replace("wxStockGDI::", ""); // same story for some other classes - m_strTypeClean.Replace("wxHelpEvent::", ""); m_strTypeClean.Replace("wxWindowID", "int"); } @@ -135,8 +137,8 @@ bool wxType::operator==(const wxType& m) const if (g_verbose) { - LogMessage("Type '%s' does not match type '%s'", m_strType, m.m_strType); - LogMessage(" => TypeClean %s / %s; IsConst %d / %d; IsStatic %d / %d; IsPointer %d / %d; IsReference %d / %d", + wxLogMessage("Type '%s' does not match type '%s'", m_strType, m.m_strType); + wxLogMessage(" => TypeClean %s / %s; IsConst %d / %d; IsStatic %d / %d; IsPointer %d / %d; IsReference %d / %d", m_strTypeClean, m.m_strTypeClean, IsConst(), m.IsConst(), IsStatic(), m.IsStatic(), IsPointer(), m.IsPointer(), IsReference(), m.IsReference()); @@ -163,16 +165,19 @@ void wxArgumentType::SetDefaultValue(const wxString& defval, const wxString& def // Note: we adjust the aesthetic form of the m_strDefaultValue string for the "modify mode" // of ifacecheck: we may need to write it out in an interface header - wxString *p; + wxString *p = NULL; for (int i=0; i<2; i++) // to avoid copying&pasting the code! { if (i == 0) p = &m_strDefaultValue; if (i == 1) p = &m_strDefaultValueForCmp; - if (*p == "0u") *p = "0"; + if (*p == "0u" || *p == "0l") *p = "0"; p->Replace("0x000000001", "1"); p->Replace("\\000\\000\\000", ""); // fix for unicode strings: + p->Replace("\\011", "\\t"); + p->Replace("e+0", ""); + p->Replace("2147483647", "__INT_MAX__"); // ADHOC-FIX: for wxConv* default values p->Replace("wxConvAuto(wxFONTENCODING_DEFAULT)", "wxConvAuto()"); @@ -210,6 +215,10 @@ bool wxArgumentType::operator==(const wxArgumentType& m) const if ((const wxType&)(*this) != (const wxType&)m) return false; + // check if the default values match + // --------------------------------- + + // ADHOC-FIX: // default values for style attributes of wxWindow-derived classes in gccxml appear as raw // numbers; avoid false positives in this case! @@ -225,12 +234,19 @@ bool wxArgumentType::operator==(const wxArgumentType& m) const (m.m_strDefaultValueForCmp.IsNumber() && m_strDefaultValueForCmp.StartsWith("wx"))) { if (g_verbose) - LogMessage("Supposing '%s' default value to be the same of '%s'...", + { + wxLogMessage("Supposing '%s' default value to be the same of '%s'...", m_strDefaultValueForCmp, m.m_strDefaultValueForCmp); + } return true; } } + else if (m_strTypeClean == "float" || m_strTypeClean == "double") + // gccXML translates the default floating values in a hardly usable + // format; e.g. 25.2 => 2.51999999999999992894572642398998141288757324219e+1 + // we avoid check on these... + return true; if (m_strDefaultValueForCmp != m.m_strDefaultValueForCmp) { @@ -246,8 +262,10 @@ bool wxArgumentType::operator==(const wxArgumentType& m) const } if (g_verbose) - LogMessage("Argument type '%s = %s' has different default value from '%s = %s'", + { + wxLogMessage("Argument type '%s = %s' has different default value from '%s = %s'", m_strType, m_strDefaultValueForCmp, m.m_strType, m.m_strDefaultValueForCmp); + } return false; } @@ -266,7 +284,7 @@ bool wxMethod::IsOk() const // NOTE: m_retType can be a wxEmptyType, and means that this method // is a ctor or a dtor. if (!m_retType.IsOk() && m_retType!=wxEmptyType) { - LogError("'%s' method has invalid return type: %s", m_retType.GetAsString()); + wxLogError("'%s' method has invalid return type: %s", m_retType.GetAsString()); return false; } @@ -275,7 +293,7 @@ bool wxMethod::IsOk() const // a function can't be both const and static or virtual and static! if ((m_bConst && m_bStatic) || ((m_bVirtual || m_bPureVirtual) && m_bStatic)) { - LogError("'%s' method can't be both const/static or virtual/static", m_strName); + wxLogError("'%s' method can't be both const/static or virtual/static", m_strName); return false; } @@ -283,7 +301,7 @@ bool wxMethod::IsOk() const for (unsigned int i=0; iFindClass(m_parents[i]); if (!parent) { - LogError("Could not find parent '%s' of class '%s'...", + wxLogError("Could not find parent '%s' of class '%s'...", m_parents[i], GetName()); return false; } @@ -588,7 +612,7 @@ wxMethodPtrArray wxClass::RecursiveUpwardFindMethodsNamed(const wxString& name, { const wxClass *parent = allclasses->FindClass(m_parents[i]); if (!parent) { - LogError("Could not find parent '%s' of class '%s'...", + wxLogError("Could not find parent '%s' of class '%s'...", m_parents[i], GetName()); return false; } @@ -623,21 +647,33 @@ void wxXmlInterface::Dump(const wxString& filename) // dump the classes in alphabetical order wxSortedClassArray sorted(CompareWxClassObjects); sorted.Alloc(m_classes.GetCount()); - for (unsigned int i=0; iDump(apiout); } -bool wxXmlInterface::CheckParseResults() const +bool wxXmlInterface::CheckConsistency() const { // this check can be quite slow, so do it only for debug releases: //#ifdef __WXDEBUG__ for (unsigned int i=0; iGetName() != "GCC_XML") { - LogError("invalid root node for %s", filename); + wxLogError("invalid root node for %s", filename); return false; } @@ -806,7 +842,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) if (old) { - LogError("The version of GCC-XML used for the creation of %s is too old; " + wxLogError("The version of GCC-XML used for the creation of %s is too old; " "the cvs_revision attribute of the root node reports '%s', " "minimal required is 1.%d.", filename, version, MIN_REVISION); return false; @@ -832,7 +868,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) // NOTE: nodes can have an id == "f0"... - LogError("Invalid id for node %s: %s", n, child->GetAttribute("id")); + wxLogError("Invalid id for node %s: %s", n, child->GetAttribute("id")); return false; } @@ -840,7 +876,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) { wxString cname = child->GetAttribute("name"); if (cname.IsEmpty()) { - LogError("Invalid empty name for '%s' node", n); + wxLogError("Invalid empty name for '%s' node", n); return false; } @@ -869,7 +905,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) if (ids.IsEmpty()) { if (child->GetAttribute("incomplete") != "1") { - LogError("Invalid member IDs for '%s' class node: %s", + wxLogError("Invalid member IDs for '%s' class node: %s", cname, child->GetAttribute("id")); return false; } @@ -880,7 +916,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) { // decode the non-empty list of IDs: if (!getMemberIDs(&members, newClass, ids)) { - LogError("Invalid member IDs for '%s' class node: %s", + wxLogError("Invalid member IDs for '%s' class node: %s", cname, child->GetAttribute("id")); return false; } @@ -894,7 +930,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) { unsigned long typeId = 0; if (!getID(&typeId, child->GetAttribute("type"))) { - LogError("Invalid type for node %s: %s", n, child->GetAttribute("type")); + wxLogError("Invalid type for node %s: %s", n, child->GetAttribute("type")); return false; } @@ -912,7 +948,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) { unsigned long type = 0; if (!getID(&type, child->GetAttribute("type")) || type == 0) { - LogError("Invalid type for node %s: %s", n, child->GetAttribute("type")); + wxLogError("Invalid type for node %s: %s", n, child->GetAttribute("type")); return false; } @@ -958,7 +994,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) else if (n == "File") { if (!child->GetAttribute("id").StartsWith("f")) { - LogError("Unexpected file ID: %s", child->GetAttribute("id")); + wxLogError("Unexpected file ID: %s", child->GetAttribute("id")); return false; } @@ -983,8 +1019,10 @@ bool wxXmlGccInterface::Parse(const wxString& filename) // they're never used as return/argument types by wxWidgets methods if (g_verbose) - LogWarning("Type node '%s' with ID '%s' does not have name attribute", + { + wxLogWarning("Type node '%s' with ID '%s' does not have name attribute", n, child->GetAttribute("id")); + } types[id] = "TOFIX"; } @@ -1002,8 +1040,10 @@ bool wxXmlGccInterface::Parse(const wxString& filename) while (toResolveTypes.size()>0) { if (g_verbose) - LogMessage("%d types were collected; %d types need yet to be resolved...", + { + wxLogMessage("%d types were collected; %d types need yet to be resolved...", types.size(), toResolveTypes.size()); + } for (wxToResolveTypeHashMap::iterator i = toResolveTypes.begin(); i != toResolveTypes.end();) @@ -1056,7 +1096,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) } else { - LogError("Cannot solve '%d' reference type!", referenced); + wxLogError("Cannot solve '%d' reference type!", referenced); return false; } } @@ -1064,11 +1104,12 @@ bool wxXmlGccInterface::Parse(const wxString& filename) } // resolve header names - for (unsigned int i=0; isecond); } // resolve parent names - for (unsigned int i=0; iGetAttribute("id"))) { - LogError("invalid ID for node '%s' with ID '%s'", n, child->GetAttribute("id")); + wxLogError("invalid ID for node '%s' with ID '%s'", n, child->GetAttribute("id")); return false; } @@ -1131,7 +1172,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) // this node is a method of the i-th class! wxMethod newfunc; if (!ParseMethod(child, types, newfunc)) { - LogError("The method '%s' could not be added to class '%s'", + wxLogError("The method '%s' could not be added to class '%s'", child->GetAttribute("demangled"), p->GetName()); return false; } @@ -1139,12 +1180,12 @@ bool wxXmlGccInterface::Parse(const wxString& filename) // do some additional check that we can do only here: if (newfunc.IsCtor() && !p->IsValidCtorForThisClass(newfunc)) { - LogError("The method '%s' does not seem to be a ctor for '%s'", + wxLogError("The method '%s' does not seem to be a ctor for '%s'", newfunc.GetName(), p->GetName()); return false; } if (newfunc.IsDtor() && !p->IsValidDtorForThisClass(newfunc)) { - LogError("The method '%s' does not seem to be a dtor for '%s'", + wxLogError("The method '%s' does not seem to be a dtor for '%s'", newfunc.GetName(), p->GetName()); return false; } @@ -1159,8 +1200,8 @@ bool wxXmlGccInterface::Parse(const wxString& filename) if ((++nodes%PROGRESS_RATE)==0) ShowProgress(); } - if (!CheckParseResults()) - return false; + if (!CheckConsistency()) + return false; // the check failed return true; } @@ -1182,7 +1223,7 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, if (!getID(&retid, p->GetAttribute("returns")) || retid == 0) { if (p->GetName() != "Destructor" && p->GetName() != "Constructor") { - LogError("Empty return ID for method '%s', with ID '%s'", + wxLogError("Empty return ID for method '%s', with ID '%s'", name, p->GetAttribute("id")); return false; } @@ -1191,13 +1232,13 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, { wxTypeIdHashMap::const_iterator retidx = types.find(retid); if (retidx == types.end()) { - LogError("Could not find return type ID '%s'", retid); + wxLogError("Could not find return type ID '%s'", retid); return false; } ret = wxType(retidx->second); if (!ret.IsOk()) { - LogError("Invalid return type '%s' for method '%s', with ID '%s'", + wxLogError("Invalid return type '%s' for method '%s', with ID '%s'", retidx->second, name, p->GetAttribute("id")); return false; } @@ -1212,14 +1253,14 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, { unsigned long id = 0; if (!getID(&id, arg->GetAttribute("type")) || id == 0) { - LogError("Invalid argument type ID '%s' for method '%s' with ID %s", + wxLogError("Invalid argument type ID '%s' for method '%s' with ID %s", arg->GetAttribute("type"), name, p->GetAttribute("id")); return false; } wxTypeIdHashMap::const_iterator idx = types.find(id); if (idx == types.end()) { - LogError("Could not find argument type ID '%s'", id); + wxLogError("Could not find argument type ID '%s'", id); return false; } @@ -1255,7 +1296,7 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, m.SetAccessSpecifier(wxMAS_PRIVATE); if (!m.IsOk()) { - LogError("The prototype '%s' is not valid!", m.GetAsString()); + wxLogError("The prototype '%s' is not valid!", m.GetAsString()); return false; } @@ -1293,7 +1334,7 @@ static wxString GetTextFromChildren(const wxXmlNode *n) else if (ref->GetType() == wxXML_TEXT_NODE) text += ref->GetContent(); else - LogWarning("Unexpected node type while getting text from '%s' node", n->GetName()); + wxLogWarning("Unexpected node type while getting text from '%s' node", n->GetName()); ref = ref->GetNext(); } @@ -1367,7 +1408,7 @@ int GetAvailabilityFor(const wxXmlNode *node) for (unsigned int i=0; i < ports.GetCount(); i++) { if (!ports[i].StartsWith("wx")) { - LogError("unexpected port ID '%s'", ports[i]); + wxLogError("unexpected port ID '%s'", ports[i]); return false; } @@ -1387,16 +1428,16 @@ bool wxXmlDoxygenInterface::Parse(const wxString& filename) wxXmlDocument index; wxXmlNode *compound; - LogMessage("Parsing %s...", filename); + wxLogMessage("Parsing %s...", filename); if (!index.Load(filename)) { - LogError("can't load %s", filename); + wxLogError("can't load %s", filename); return false; } // start processing the index: if (index.GetRoot()->GetName() != "doxygenindex") { - LogError("invalid root node for %s", filename); + wxLogError("invalid root node for %s", filename); return false; } @@ -1427,8 +1468,8 @@ bool wxXmlDoxygenInterface::Parse(const wxString& filename) } //wxPrint("\n"); - if (!CheckParseResults()) - return false; + if (!CheckConsistency()) + return false; // the check failed return true; } @@ -1441,16 +1482,18 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) int nodes = 0; if (g_verbose) - LogMessage("Parsing %s...", filename); + { + wxLogMessage("Parsing %s...", filename); + } if (!doc.Load(filename)) { - LogError("can't load %s", filename); + wxLogError("can't load %s", filename); return false; } // start processing this compound definition XML if (doc.GetRoot()->GetName() != "doxygen") { - LogError("invalid root node for %s", filename); + wxLogError("invalid root node for %s", filename); return false; } @@ -1468,41 +1511,47 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) wxXmlNode *subchild = child->GetChildren(); while (subchild) { - wxString kind = subchild->GetAttribute("kind"); - - // parse only public&protected functions: - if (subchild->GetName() == "sectiondef" && - (kind == "public-func" || kind == "protected-func")) + // NOTE: when documenting functions using the //@{ and //@} + // tags to create function groups, doxygen puts the + // contained methods into a "user-defined" section + // so we _must_ use the "prot" attribute to distinguish + // public/protected methods from private ones and cannot + // rely on the kind="public" attribute of + if (subchild->GetName() == "sectiondef") { - wxXmlNode *membernode = subchild->GetChildren(); while (membernode) { + const wxString& accessSpec = membernode->GetAttribute("prot"); + + // parse only public&protected functions: if (membernode->GetName() == "memberdef" && - membernode->GetAttribute("kind") == "function") + membernode->GetAttribute("kind") == "function" && + (accessSpec == "public" || accessSpec == "protected")) { - wxMethod m; if (!ParseMethod(membernode, m, header)) { - LogError("The method '%s' could not be added to class '%s'", - m.GetName(), klass.GetName()); + wxLogError("The method '%s' could not be added to class '%s'", + m.GetName(), klass.GetName()); return false; } - if (kind == "public-func") + if (accessSpec == "public") m.SetAccessSpecifier(wxMAS_PUBLIC); - else if (kind == "protected-func") + else if (accessSpec == "protected") m.SetAccessSpecifier(wxMAS_PROTECTED); - else if (kind == "private-func") + else if (accessSpec == "private") m.SetAccessSpecifier(wxMAS_PRIVATE); if (absoluteFile.IsEmpty()) absoluteFile = header; else if (header != absoluteFile) { - LogError("The method '%s' is documented in a different " - "file from others (which belong to '%s') ?", - header, absoluteFile); + wxLogError("Found inconsistency in the XML file '%s': " + "the method '%s' is documented in the " + "file '%s' but the other methods of the same " + "class are documented in the file '%s'", + filename, m.GetName(), header, absoluteFile); return false; } @@ -1544,10 +1593,14 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) // add a new class if (klass.IsOk()) + { m_classes.Add(klass); + } else if (g_verbose) - LogWarning("discarding class '%s' with %d methods...", - klass.GetName(), klass.GetMethodCount()); + { + wxLogWarning("discarding class '%s' with %d methods...", + klass.GetName(), klass.GetMethodCount()); + } } child = child->GetNext(); @@ -1592,7 +1645,7 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin } if (typestr.IsEmpty()) { - LogError("cannot find type node for a param in method '%s'", m.GetName()); + wxLogError("cannot find type node for a param in method '%s'", m.GetName()); return false; } @@ -1640,7 +1693,7 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin m.SetPureVirtual(p->GetAttribute("virt")=="pure-virtual"); if (!m.IsOk()) { - LogError("The prototype '%s' is not valid!", m.GetAsString()); + wxLogError("The prototype '%s' is not valid!", m.GetAsString()); return false; }