X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/95dfcbad9762c40248146278327e3cfbc1b1c92a..6b03a638a437316e47f02a896d3ad664d59c6ddb:/utils/ifacecheck/src/xmlparser.cpp diff --git a/utils/ifacecheck/src/xmlparser.cpp b/utils/ifacecheck/src/xmlparser.cpp index d694d9a87c..3942535b1f 100644 --- a/utils/ifacecheck/src/xmlparser.cpp +++ b/utils/ifacecheck/src/xmlparser.cpp @@ -40,6 +40,9 @@ WX_DEFINE_OBJARRAY(wxClassArray) // defined in ifacecheck.cpp extern bool g_verbose; +// global variable: +bool g_bLogEnabled = true; + // ---------------------------------------------------------------------------- @@ -74,6 +77,27 @@ void wxType::SetTypeFromString(const wxString& t) m_strType.Replace(" ,", ","); m_strType = m_strType.Strip(wxString::both); + + // now set the clean version + m_strTypeClean = m_strType; + m_strTypeClean.Replace("const", ""); + m_strTypeClean.Replace("static", ""); + m_strTypeClean.Replace("*", ""); + m_strTypeClean.Replace("&", ""); + m_strTypeClean.Replace("[]", ""); + m_strTypeClean = m_strTypeClean.Strip(wxString::both); + + // to avoid false errors types like wxStandardPaths and wxStandardPathsBase + // need to be considered as the same type + if (m_strTypeClean.EndsWith("Base")) + m_strTypeClean = m_strTypeClean.Left(m_strTypeClean.Len()-4); + + // 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::", ""); } bool wxType::IsOk() const @@ -82,31 +106,23 @@ bool wxType::IsOk() const // "reverse_iterator_impl" type // It can also contain commas, * and & operators etc - return !GetClean().IsEmpty(); -} - -wxString wxType::GetClean() const -{ - wxString ret(m_strType); - ret.Replace("const", ""); - ret.Replace("static", ""); - ret.Replace("*", ""); - ret.Replace("&", ""); - ret.Replace("[]", ""); - return ret.Strip(wxString::both); + return !m_strTypeClean.IsEmpty(); } bool wxType::operator==(const wxType& m) const { // brain-dead comparison: - if (GetClean() == m.GetClean() && + if (m_strTypeClean == m.m_strTypeClean && IsConst() == m.IsConst() && IsStatic() == m.IsStatic() && IsPointer() == m.IsPointer() && IsReference() == m.IsReference()) return true; + if (g_verbose) + LogMessage("Type '%s' does not match type '%s'", m_strType, m.m_strType); + return false; } @@ -115,23 +131,53 @@ bool wxType::operator==(const wxType& m) const // wxArgumentType // ---------------------------------------------------------------------------- -void wxArgumentType::SetDefaultValue(const wxString& defval) +void wxArgumentType::SetDefaultValue(const wxString& defval, const wxString& defvalForCmp) { - m_strDefaultValue=defval.Strip(wxString::both); + m_strDefaultValue = defval.Strip(wxString::both); + m_strDefaultValueForCmp = defvalForCmp.IsEmpty() ? m_strDefaultValue : defvalForCmp.Strip(wxString::both); + + // adjust aesthetic form of DefaultValue for the modify mode of ifacecheck: + // we may need to write it out in an interface header + if (m_strDefaultValue == "0u") + m_strDefaultValue = "0"; // in order to make valid&simple comparison on argument defaults, // we reduce some of the multiple forms in which the same things may appear // to a single form: - m_strDefaultValue.Replace("0u", "0"); + if (m_strDefaultValueForCmp == "0u") + m_strDefaultValueForCmp = "0"; - if (IsPointer()) - m_strDefaultValue.Replace("0", "NULL"); - else - m_strDefaultValue.Replace("NULL", "0"); + // fix for unicode strings: + m_strDefaultValueForCmp.Replace("\\000\\000\\000", ""); + if (m_strDefaultValueForCmp.StartsWith("wxT(") && + m_strDefaultValueForCmp.EndsWith(")")) + { + // get rid of the wxT() part + unsigned int len = m_strDefaultValueForCmp.Len(); + m_strDefaultValueForCmp = m_strDefaultValueForCmp.Mid(4,len-5); + } - if (m_strDefaultValue.Contains("wxGetTranslation")) - m_strDefaultValue = "_(TOFIX)"; // TODO: wxGetTranslation gives problems to gccxml +/* + if (IsPointer()) + m_strDefaultValueForCmp.Replace("0", "NULL"); + else + m_strDefaultValueForCmp.Replace("NULL", "0"); +*/ + // ADHOC-FIX: + // doxygen likes to put wxDateTime:: in front of all wxDateTime enums; + // fix this to avoid false positives + m_strDefaultValueForCmp.Replace("wxDateTime::", ""); + m_strDefaultValueForCmp.Replace("wxStockGDI::", ""); // same story for some other classes + m_strDefaultValueForCmp.Replace("wxHelpEvent::", ""); // same story for some other classes + + m_strDefaultValueForCmp.Replace("wxGet_wxConvLocal()", "wxConvLocal"); + + m_strDefaultValueForCmp.Replace("* GetColour(COLOUR_BLACK)", "*wxBLACK"); + + // ADHOC-FIX: + if (m_strDefaultValueForCmp.Contains("wxGetTranslation")) + m_strDefaultValueForCmp = "_(TOFIX)"; // TODO: wxGetTranslation gives problems to gccxml } bool wxArgumentType::operator==(const wxArgumentType& m) const @@ -139,8 +185,46 @@ bool wxArgumentType::operator==(const wxArgumentType& m) const if ((const wxType&)(*this) != (const wxType&)m) return false; - if (m_strDefaultValue != m.m_strDefaultValue) + // ADHOC-FIX: + // default values for style attributes of wxWindow-derived classes in gccxml appear as raw + // numbers; avoid false positives in this case! + if (m_strArgName == m.m_strArgName && m_strArgName == "style" && + (m_strDefaultValueForCmp.IsNumber() || m.m_strDefaultValueForCmp.IsNumber())) + return true; + + // fix for default values which were replaced by gcc-xml with their numeric values + // (at this point we know that m_strTypeClean == m.m_strTypeClean): + if (m_strTypeClean == "long" || m_strTypeClean == "int") + { + if ((m_strDefaultValueForCmp.IsNumber() && m.m_strDefaultValueForCmp.StartsWith("wx")) || + (m.m_strDefaultValueForCmp.IsNumber() && m_strDefaultValueForCmp.StartsWith("wx"))) + { + if (g_verbose) + LogMessage("Supposing '%s' default value to be the same of '%s'...", + m_strDefaultValueForCmp, m.m_strDefaultValueForCmp); + + return true; + } + } + + if (m_strDefaultValueForCmp != m.m_strDefaultValueForCmp) + { + // maybe the default values are numbers. + // in this case gccXML gives as default values things like '-0x0000001' instead of just '-1'. + // To handle these cases, we try to convert the default value strings to numbers: + long def1val, def2val; + if (m_strDefaultValueForCmp.ToLong(&def1val, 0 /* auto-detect */) && + m.m_strDefaultValueForCmp.ToLong(&def2val, 0 /* auto-detect */)) + { + if (def1val == def2val) + return true; // the default values match + } + + if (g_verbose) + LogMessage("Argument type '%s = %s' has different default value from '%s = %s'", + m_strType, m_strDefaultValueForCmp, m.m_strType, m.m_strDefaultValueForCmp); return false; + } // we deliberately avoid checks on the argument name @@ -170,7 +254,7 @@ bool wxMethod::IsOk() const return false; } - wxASSERT((m_bVirtual && m_bPureVirtual) || !m_bVirtual); + wxASSERT(!m_bPureVirtual || (m_bPureVirtual && m_bVirtual)); for (unsigned int i=0; im_methods.RemoveAt(j); + j--; } return true; @@ -360,7 +480,7 @@ const wxMethod* wxClass::FindMethod(const wxMethod& m) const return NULL; } -wxMethodPtrArray wxClass::FindMethodNamed(const wxString& name) const +wxMethodPtrArray wxClass::FindMethodsNamed(const wxString& name) const { wxMethodPtrArray ret; @@ -403,11 +523,11 @@ void wxXmlInterface::Dump(const wxString& filename) bool wxXmlInterface::CheckParseResults() const { // this check can be quite slow, so do it only for debug releases: -#ifdef __WXDEBUG__ +//#ifdef __WXDEBUG__ for (unsigned int i=0; iattrib: #define ATTRIB_CONST 1 #define ATTRIB_REFERENCE 2 #define ATTRIB_POINTER 4 @@ -442,7 +563,8 @@ public: toResolveTypeItem(unsigned int refID, unsigned int attribint) : ref(refID), attribs(attribint) {} - unsigned long ref, attribs; + unsigned long ref, // the referenced type's ID + attribs; // the attributes of this reference }; #if 1 @@ -468,10 +590,10 @@ typedef std::map wxToResolveTypeHashMap; bool getID(unsigned long *id, const wxStringCharType* str) { wxStringCharType *end; -#if wxUSE_UNICODE_UTF8 - unsigned long val = strtoul(str+1, &end, GCCXML_BASE); -#else +#if wxUSE_UNICODE_WCHAR unsigned long val = wcstoul(str+1, &end, GCCXML_BASE); +#else + unsigned long val = strtoul(str+1, &end, GCCXML_BASE); #endif // return true only if scan was stopped by the terminating NUL and @@ -488,10 +610,10 @@ bool getID(unsigned long *id, const wxStringCharType* str) // in nodes like ones... i.e. numeric values separed by " _" token bool getMemberIDs(wxClassMemberIdHashMap* map, wxClass* p, const wxStringCharType* str) { -#if wxUSE_UNICODE_UTF8 - size_t len = strlen(str); -#else +#if wxUSE_UNICODE_WCHAR size_t len = wcslen(str); +#else + size_t len = strlen(str); #endif if (len == 0 || str[0] != '_') @@ -504,10 +626,10 @@ bool getMemberIDs(wxClassMemberIdHashMap* map, wxClass* p, const wxStringCharTyp while (curpos < end) { // curpos always points to the underscore of the next token to parse: -#if wxUSE_UNICODE_UTF8 - unsigned long id = strtoul(curpos+1, &nexttoken, GCCXML_BASE); -#else +#if wxUSE_UNICODE_WCHAR unsigned long id = wcstoul(curpos+1, &nexttoken, GCCXML_BASE); +#else + unsigned long id = strtoul(curpos+1, &nexttoken, GCCXML_BASE); #endif if ( *nexttoken != ' ' || errno == ERANGE || errno == EINVAL ) return false; @@ -547,10 +669,36 @@ bool wxXmlGccInterface::Parse(const wxString& filename) return false; } + wxString version = doc.GetRoot()->GetAttribute("cvs_revision"); + bool old = false; + +#define MIN_REVISION 120 + + if (!version.StartsWith("1.")) + old = true; + if (!old) + { + unsigned long rev = 0; + if (!version.Mid(2).ToULong(&rev)) + old = true; + else + if (rev < MIN_REVISION) + old = true; + } + + if (old) + { + LogError("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; + } + wxToResolveTypeHashMap toResolveTypes; wxClassMemberIdHashMap members; wxTypeIdHashMap types; wxTypeIdHashMap files; + wxTypeIdHashMap typedefs; // prealloc quite a lot of memory! m_classes.Alloc(ESTIMATED_NUM_CLASSES); @@ -609,6 +757,23 @@ bool wxXmlGccInterface::Parse(const wxString& filename) // register this class also as possible return/argument type: types[id] = cname; } + else if (n == "Typedef") + { + unsigned long typeId = 0; + if (!getID(&typeId, child->GetAttribute("type"))) { + LogError("Invalid type for node %s: %s", n, child->GetAttribute("type")); + return false; + } + + // this typedef node tell us that every type referenced with the + // "typeId" ID should be called with another name: + wxString name = child->GetAttribute("name"); + + // save this typedef in a separate hashmap... + typedefs[typeId] = name; + + types[id] = name; + } else if (n == "PointerType" || n == "ReferenceType" || n == "CvQualifiedType" || n == "ArrayType") { @@ -648,11 +813,14 @@ bool wxXmlGccInterface::Parse(const wxString& filename) } if (argstr.Len() > 0) - argstr = argstr.Left(argstr.Len()-2); + argstr = argstr.Left(argstr.Len()-2); // remove final comma // these nodes make reference to other types... we'll resolve them later //toResolveTypes[id] = toResolveTypeItem(ret, 0); - types[id] = child->GetAttribute("returns") + "(" + argstr + ")"; + //types[id] = child->GetAttribute("returns") + "(" + argstr + ")"; + + types[id] = "TOFIX"; // typically this type will be "fixed" thanks + // to a typedef later... } else if (n == "File") { @@ -696,7 +864,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) } // some nodes with IDs referenced by methods as return/argument types, do reference - // in turn o ther nodes (see PointerType, ReferenceType and CvQualifierType above); + // in turn other nodes (see PointerType, ReferenceType and CvQualifierType above); // thus we need to resolve their name iteratively: while (toResolveTypes.size()>0) { @@ -729,7 +897,10 @@ bool wxXmlGccInterface::Parse(const wxString& filename) newtype = newtype + "[]"; // add the resolved type to the list of "primary" types - types[id] = newtype; + if (newtype.Contains("TOFIX") && typedefs[id] != "") + types[id] = typedefs[id]; // better use a typedef for this type! + else + types[id] = newtype; // this one has been resolved; erase it through its iterator! toResolveTypes.erase(i); @@ -752,7 +923,7 @@ bool wxXmlGccInterface::Parse(const wxString& filename) } else { - LogError("Cannot solve '%s' reference type!", referenced); + LogError("Cannot solve '%d' reference type!", referenced); return false; } } @@ -783,10 +954,10 @@ bool wxXmlGccInterface::Parse(const wxString& filename) child = doc.GetRoot()->GetChildren(); while (child) { - wxString n = child->GetName(); + wxString n = child->GetName(), acc = child->GetAttribute("access"); - // only register public methods - if (child->GetAttribute("access") == "public" && + // only register public&protected methods + if ((acc == "public" || acc == "protected") && (n == "Method" || n == "Constructor" || n == "Destructor" || n == "OperatorMethod")) { unsigned long id = 0; @@ -808,6 +979,8 @@ bool wxXmlGccInterface::Parse(const wxString& filename) return false; } + // 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'", newfunc.GetName(), p->GetName()); @@ -893,7 +1066,9 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, return false; } - argtypes.Add(wxArgumentType(idx->second, arg->GetAttribute("default"))); + argtypes.Add(wxArgumentType(idx->second, + arg->GetAttribute("default"), + arg->GetAttribute("name"))); } arg = arg->GetNext(); @@ -914,6 +1089,14 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, m.SetPureVirtual(p->GetAttribute("pure_virtual") == "1"); m.SetDeprecated(p->GetAttribute("attributes") == "deprecated"); + // decode access specifier + if (p->GetAttribute("access") == "public") + m.SetAccessSpecifier(wxMAS_PUBLIC); + else if (p->GetAttribute("access") == "protected") + m.SetAccessSpecifier(wxMAS_PROTECTED); + else if (p->GetAttribute("access") == "private") + m.SetAccessSpecifier(wxMAS_PRIVATE); + if (!m.IsOk()) { LogError("The prototype '%s' is not valid!", m.GetAsString()); return false; @@ -923,6 +1106,121 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, } + +// ---------------------------------------------------------------------------- +// wxXmlDoxygenInterface global helpers +// ---------------------------------------------------------------------------- + +static wxString GetTextFromChildren(const wxXmlNode *n) +{ + wxString text; + + // consider the tree + // + // this is a string + // + // + // |- + // | |- this + // |- is a + // |- + // |- string + // + // unlike wxXmlNode::GetNodeContent() which would return " is a " + // this function returns "this is a string" + + wxXmlNode *ref = n->GetChildren(); + while (ref) { + if (ref->GetType() == wxXML_ELEMENT_NODE) + text += ref->GetNodeContent(); + else if (ref->GetType() == wxXML_TEXT_NODE) + text += ref->GetContent(); + else + LogWarning("Unexpected node type while getting text from '%s' node", n->GetName()); + + ref = ref->GetNext(); + } + + return text; +} + +static bool HasTextNodeContaining(const wxXmlNode *parent, const wxString& name) +{ + if (!parent) + return false; + + wxXmlNode *p = parent->GetChildren(); + while (p) + { + switch (p->GetType()) + { + case wxXML_TEXT_NODE: + if (p->GetContent() == name) + return true; + break; + + case wxXML_ELEMENT_NODE: + // recurse into this node... + if (HasTextNodeContaining(p, name)) + return true; + break; + + default: + // skip it + break; + } + + p = p->GetNext(); + } + + return false; +} + +static const wxXmlNode* FindNodeNamed(const wxXmlNode* parent, const wxString& name) +{ + if (!parent) + return NULL; + + const wxXmlNode *p = parent->GetChildren(); + while (p) + { + if (p->GetName() == name) + return p; // found! + + // search recursively in the children of this node + const wxXmlNode *ret = FindNodeNamed(p, name); + if (ret) + return ret; + + p = p->GetNext(); + } + + return NULL; +} + +int GetAvailabilityFor(const wxXmlNode *node) +{ + // identify custom XML tags + const wxXmlNode* onlyfor = FindNodeNamed(node, "onlyfor"); + if (!onlyfor) + return wxPORT_UNKNOWN; + + wxArrayString ports = wxSplit(onlyfor->GetNodeContent(), ','); + int nAvail = wxPORT_UNKNOWN; + for (unsigned int i=0; i < ports.GetCount(); i++) + { + if (!ports[i].StartsWith("wx")) { + LogError("unexpected port ID '%s'", ports[i]); + return false; + } + + nAvail |= wxPlatformInfo::GetPortId(ports[i].Mid(2)); + } + + return nAvail; +} + + // ---------------------------------------------------------------------------- // wxXmlDoxygenInterface // ---------------------------------------------------------------------------- @@ -945,6 +1243,13 @@ bool wxXmlDoxygenInterface::Parse(const wxString& filename) return false; } + /* + NB: we may need in future to do a version-check here if the + format of the XML generated by doxygen changes. + For now (doxygen version 1.5.5), this check is not required + since AFAIK the XML format never changed since it was introduced. + */ + m_classes.Alloc(ESTIMATED_NUM_CLASSES); // process files referenced by this index file @@ -1005,8 +1310,11 @@ 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" && - subchild->GetAttribute("kind") == "public-func") + (kind == "public-func" || kind == "protected-func")) { wxXmlNode *membernode = subchild->GetChildren(); @@ -1023,6 +1331,13 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) return false; } + if (kind == "public-func") + m.SetAccessSpecifier(wxMAS_PUBLIC); + else if (kind == "protected-func") + m.SetAccessSpecifier(wxMAS_PROTECTED); + else if (kind == "private-func") + m.SetAccessSpecifier(wxMAS_PRIVATE); + if (absoluteFile.IsEmpty()) absoluteFile = header; else if (header != absoluteFile) @@ -1055,6 +1370,11 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) klass.SetHeader(subchild->GetNodeContent()); }*/ + else if (subchild->GetName() == "detaileddescription") + { + // identify custom XML tags + klass.SetAvailability(GetAvailabilityFor(subchild)); + } subchild = subchild->GetNext(); } @@ -1076,68 +1396,6 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) return true; } -static wxString GetTextFromChildren(const wxXmlNode *n) -{ - wxString text; - - // consider the tree - // - // this is a string - // - // - // |- - // | |- this - // |- is a - // |- - // |- string - // - // unlike wxXmlNode::GetNodeContent() which would return " is a " - // this function returns "this is a string" - - wxXmlNode *ref = n->GetChildren(); - while (ref) { - if (ref->GetType() == wxXML_ELEMENT_NODE) - text += ref->GetNodeContent(); - else if (ref->GetType() == wxXML_TEXT_NODE) - text += ref->GetContent(); - else - LogWarning("Unexpected node type while getting text from '%s' node", n->GetName()); - - ref = ref->GetNext(); - } - - return text; -} - -static bool HasTextNodeContaining(const wxXmlNode *parent, const wxString& name) -{ - wxXmlNode *p = parent->GetChildren(); - while (p) - { - switch (p->GetType()) - { - case wxXML_TEXT_NODE: - if (p->GetContent() == name) - return true; - break; - - case wxXML_ELEMENT_NODE: - // recurse into this node... - if (HasTextNodeContaining(p, name)) - return true; - break; - - default: - // skip it - break; - } - - p = p->GetNext(); - } - - return false; -} - bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxString& header) { wxArgumentTypeArray args; @@ -1163,7 +1421,7 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin else if (n->GetName() == "declname") namestr = GetTextFromChildren(n); else if (n->GetName() == "defval") - defstr = GetTextFromChildren(n); + defstr = GetTextFromChildren(n).Strip(wxString::both); else if (n->GetName() == "array") arrstr = GetTextFromChildren(n); @@ -1175,7 +1433,15 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin return false; } - args.Add(wxArgumentType(typestr + arrstr, defstr, namestr)); + wxArgumentType newarg(typestr + arrstr, defstr, namestr); + + // can we use preprocessor output to transform the default value + // into the same form which gets processed by wxXmlGccInterface? + wxStringHashMap::const_iterator it = m_preproc.find(defstr); + if (it != m_preproc.end()) + newarg.SetDefaultValue(defstr, it->second); + + args.Add(newarg); } else if (child->GetName() == "location") { @@ -1190,6 +1456,9 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin // Doxygen outputs somewhere nested inside // a Deprecated tag. m.SetDeprecated(HasTextNodeContaining(child, "Deprecated")); + + // identify custom XML tags + m.SetAvailability(GetAvailabilityFor(child)); } child = child->GetNext();