X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5934cda171bc0535abd044da92f3728524a11faf..b8885bb39b61f599b16d059a17ea4d9cae7018e7:/utils/ifacecheck/src/xmlparser.cpp?ds=sidebyside diff --git a/utils/ifacecheck/src/xmlparser.cpp b/utils/ifacecheck/src/xmlparser.cpp index b768a519ec..86247d1122 100644 --- a/utils/ifacecheck/src/xmlparser.cpp +++ b/utils/ifacecheck/src/xmlparser.cpp @@ -17,28 +17,33 @@ // for all others, include the necessary headers #ifndef WX_PRECOMP + #include "wx/crt.h" #endif #include "wx/xml/xml.h" #include "wx/wfstream.h" -#include "wx/arrimpl.cpp" -#include "wx/dynarray.h" +#include "wx/hashmap.h" #include "wx/filename.h" #include "xmlparser.h" +#include -#define PROGRESS_RATE 1000 // each PROGRESS_RATE nodes processed print a dot -#define ESTIMATED_NUM_CLASSES 600 // used by both wxXmlInterface-derived classes to prealloc mem -#define ESTIMATED_NUM_TYPES 50000 // used only by wxGccXmlInterface to prealloc mem -#define ESTIMATED_NUM_FILES 800 // used only by wxGccXmlInterface to prealloc mem - +#include WX_DEFINE_OBJARRAY(wxTypeArray) +WX_DEFINE_OBJARRAY(wxArgumentTypeArray) WX_DEFINE_OBJARRAY(wxMethodArray) WX_DEFINE_OBJARRAY(wxClassArray) -// declared in ifacecheck.cpp +#define PROGRESS_RATE 1000 // each PROGRESS_RATE nodes processed print a dot +#define ESTIMATED_NUM_CLASSES 600 // used by both wxXmlInterface-derived classes to prealloc mem + + +// defined in ifacecheck.cpp extern bool g_verbose; +// global variable: +bool g_bLogEnabled = true; + // ---------------------------------------------------------------------------- @@ -47,12 +52,67 @@ extern bool g_verbose; wxType wxEmptyType; -void wxType::SetFromString(const wxString& t) +void wxType::SetTypeFromString(const wxString& t) { - m_strType = t.Strip(wxString::both); + /* + TODO: optimize the following code writing a single function + which works at char-level and does everything in a single pass + */ + + // clean the type string + // --------------------- + + m_strType = t; // [] is the same as * for gccxml 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) + m_strType.Replace("*", "* "); + m_strType.Replace("&", "& "); + m_strType.Replace(" *", "*"); + m_strType.Replace(" &", "&"); + + while (m_strType.Contains(" ")) + m_strType.Replace(" ", " "); // do it once again + + m_strType.Replace(" ,", ","); + + // ADHOC-FIX + m_strType.Replace("_wxArraywxArrayStringBase", "wxString"); + m_strType.Replace("ExitCode", "void*"); // used in wxThread stuff + + m_strType = m_strType.Strip(wxString::both); + + + + // clean the type string (this time for the comparison) + // ---------------------------------------------------- + + m_strTypeClean = m_strType; // begin with the already-cleaned string + 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); + + // 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: + m_strTypeClean.Replace("wxWindowID", "int"); } bool wxType::IsOk() const @@ -61,34 +121,160 @@ 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) + { + 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()); + } + return false; } + +// ---------------------------------------------------------------------------- +// wxArgumentType +// ---------------------------------------------------------------------------- + +void wxArgumentType::SetDefaultValue(const wxString& defval, const wxString& defvalForCmp) +{ + m_strDefaultValue = defval.Strip(wxString::both); + m_strDefaultValueForCmp = defvalForCmp.IsEmpty() ? + m_strDefaultValue : defvalForCmp.Strip(wxString::both); + + + // clean the default argument strings + // ---------------------------------- + + // 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 = 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 == "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()"); + p->Replace("wxGet_wxConvUTF8()", "wxConvUTF8"); + p->Replace("wxGet_wxConvLocal()", "wxConvLocal"); + } + + + // clean ONLY the default argument string specific for comparison + // -------------------------------------------------------------- + + 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); + } + + // 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("* 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 +{ + 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! + 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) + { + 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) + { + // 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) + { + wxLogMessage("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 + + return true; +} + + // ---------------------------------------------------------------------------- // wxMethod // ---------------------------------------------------------------------------- @@ -98,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; } @@ -106,143 +292,113 @@ bool wxMethod::IsOk() const return false; // a function can't be both const and static or virtual and static! - if ((m_bConst && m_bStatic) || (m_bVirtual && m_bStatic)) { - LogError("'%s' method can't be both const/static or virtual/static", m_strName); + if ((m_bConst && m_bStatic) || ((m_bVirtual || m_bPureVirtual) && m_bStatic)) { + wxLogError("'%s' method can't be both const/static or virtual/static", m_strName); return false; } + wxASSERT(!m_bPureVirtual || (m_bPureVirtual && m_bVirtual)); + for (unsigned int i=0; i) - // so we don't do any test on them. + // so we don't do any test on their contents + if (m_args.GetCount()>0) + { + bool previousArgHasDefault = m_args[0].HasDefaultValue(); + for (unsigned int i=1; i1 && - !temp.Last().Contains("&") && - !temp.Last().Contains("*") && - g_) - arg.Replace(temp.Last(), ""); // looks like an argument name - remove it - - ret.Add(wxType(arg)); - } - - return ret; -} -*/ bool wxMethod::operator==(const wxMethod& m) const { - if (GetReturnType() != m.GetReturnType() || - GetName() != m.GetName() || - IsConst() != m.IsConst() || + // check attributes + if (IsConst() != m.IsConst() || IsStatic() != m.IsStatic() || - IsVirtual() != m.IsVirtual()) - return false; + IsVirtual() != m.IsVirtual() || + IsPureVirtual() != m.IsPureVirtual() || + IsDeprecated() != m.IsDeprecated() || + GetAccessSpecifier() != m.GetAccessSpecifier()) + { + if (g_verbose) + { + wxLogMessage("The method '%s' does not match method '%s'; different attributes", GetName(), m.GetName()); + } - if (m_args.GetCount()!=m.m_args.GetCount()) return false; + } - for (unsigned int i=0; i0) - ret.RemoveLast(); + ret = ret.Left(ret.Len()-2); ret += ")"; @@ -266,8 +430,28 @@ wxString wxMethod::GetAsString() const ret += " const"; if (m_bStatic) ret = "static " + ret; - if (m_bVirtual) + if (m_bVirtual || m_bPureVirtual) ret = "virtual " + ret; + if (m_bPureVirtual) + ret += " = 0"; + if (m_bDeprecated && bDeprecated) + ret += " [deprecated]"; + + if (bAccessSpec) + { + switch (m_access) + { + case wxMAS_PUBLIC: + ret += " [public]"; + break; + case wxMAS_PROTECTED: + ret += " [protected]"; + break; + case wxMAS_PRIVATE: + ret += " [private]"; + break; + } + } return ret; } @@ -278,7 +462,8 @@ void wxMethod::Dump(wxTextOutputStream& stream) const stream << "[" + m_strName + "]"; for (unsigned int i=0; im_methods.RemoveAt(j); + //j--; } return true; @@ -359,7 +552,39 @@ const wxMethod* wxClass::FindMethod(const wxMethod& m) const return NULL; } -wxMethodPtrArray wxClass::FindMethodNamed(const wxString& name) const +const wxMethod* wxClass::RecursiveUpwardFindMethod(const wxMethod& m, + const wxXmlInterface* allclasses) const +{ + // first, search into *this + const wxMethod* ret = FindMethod(m); + if (ret) + return ret; + + // then, search into its parents + for (unsigned int i=0; iFindClass(m_parents[i]); + if (!parent) { + wxLogError("Could not find parent '%s' of class '%s'...", + m_parents[i], GetName()); + return false; + } + + const wxMethod *parentMethod = parent->RecursiveUpwardFindMethod(m, allclasses); + if (parentMethod) + return parentMethod; + } + } + + // could not find anything even in parent classes... + return NULL; +} + +wxMethodPtrArray wxClass::FindMethodsNamed(const wxString& name) const { wxMethodPtrArray ret; @@ -371,6 +596,37 @@ wxMethodPtrArray wxClass::FindMethodNamed(const wxString& name) const } +wxMethodPtrArray wxClass::RecursiveUpwardFindMethodsNamed(const wxString& name, + const wxXmlInterface* allclasses) const +{ + // first, search into *this + wxMethodPtrArray ret = FindMethodsNamed(name); + if (ret.GetCount()>0) + return ret; // stop here, don't look upward in the parents + + // then, search into parents of this class + for (unsigned int i=0; iFindClass(m_parents[i]); + if (!parent) { + wxLogError("Could not find parent '%s' of class '%s'...", + m_parents[i], GetName()); + return false; + } + + wxMethodPtrArray temp = parent->RecursiveUpwardFindMethodsNamed(name, allclasses); + WX_APPEND_ARRAY(ret, temp); + } + } + + return ret; +} + + + // ---------------------------------------------------------------------------- // wxXmlInterface // ---------------------------------------------------------------------------- @@ -391,281 +647,364 @@ 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__ +//#ifdef __WXDEBUG__ for (unsigned int i=0; iattrib: #define ATTRIB_CONST 1 #define ATTRIB_REFERENCE 2 #define ATTRIB_POINTER 4 #define ATTRIB_ARRAY 8 +// it may sound strange but gccxml, in order to produce shorter ID names +// uses (after the underscore) characters in range 0-9 and a-z in the ID names; +// in order to be able to translate such strings into numbers using strtoul() +// we use as base 10 (possible digits) + 25 (possible characters) = 35 +#define GCCXML_BASE 35 + class toResolveTypeItem { public: toResolveTypeItem() { attribs=0; } - toResolveTypeItem(const wxString& namestr, int attribint) - : ref(namestr), attribs(attribint) {} + toResolveTypeItem(unsigned int refID, unsigned int attribint) + : ref(refID), attribs(attribint) {} - wxString ref; - int attribs; + unsigned long ref, // the referenced type's ID + attribs; // the attributes of this reference }; -//WX_DECLARE_STRING_HASH_MAP( toResolveTypeItem, wxToResolveTypeHashMap ); +#if 1 + +// for wxToResolveTypeHashMap, keys == gccXML IDs and values == toResolveTypeItem +WX_DECLARE_HASH_MAP( unsigned long, toResolveTypeItem, + wxIntegerHash, wxIntegerEqual, + wxToResolveTypeHashMap ); + +// for wxClassMemberIdHashMap, keys == gccXML IDs and values == wxClass which owns that member ID +WX_DECLARE_HASH_MAP( unsigned long, wxClass*, + wxIntegerHash, wxIntegerEqual, + wxClassMemberIdHashMap ); + +#else #include -typedef std::map wxToResolveTypeHashMap; +typedef std::map wxToResolveTypeHashMap; +#endif -bool wxXmlGccInterface::Parse(const wxString& filename) -{ - wxXmlDocument doc; - wxXmlNode *child; - int nodes = 0; - LogMessage("Parsing %s...", filename); +// utility to parse gccXML ID values; +// this function is equivalent to wxString(str).Mid(1).ToULong(&id, GCCXML_BASE) +// but is a little bit faster +bool getID(unsigned long *id, const wxString& str) +{ + const wxStringCharType * const start = str.wx_str()+1; + wxStringCharType *end; +#if wxUSE_UNICODE_WCHAR + unsigned long val = wcstoul(start, &end, GCCXML_BASE); +#else + unsigned long val = strtoul(start, &end, GCCXML_BASE); +#endif - if (!doc.Load(filename)) { - LogError("can't load %s", filename); + // return true only if scan was stopped by the terminating NUL and + // if the string was not empty to start with and no under/overflow + // occurred: + if ( *end != '\0' || end == start || errno == ERANGE || errno == EINVAL ) return false; - } - // start processing the XML file - if (doc.GetRoot()->GetName() != "GCC_XML") { - LogError("invalid root node for %s", filename); - return false; - } + *id = val; + return true; +} - wxToResolveTypeHashMap toResolveTypes; - wxArrayString arrMemberIds; - wxStringHashMap types; - wxStringHashMap files; +// utility specialized to parse efficiently the gccXML list of IDs which occur +// in nodes like ones... i.e. numeric values separated by " _" token +bool getMemberIDs(wxClassMemberIdHashMap* map, wxClass* p, const wxString& str) +{ + const wxStringCharType * const start = str.wx_str(); +#if wxUSE_UNICODE_WCHAR + size_t len = wcslen(start); +#else + size_t len = strlen(start); +#endif - // prealloc quite a lot of memory! - m_classes.Alloc(ESTIMATED_NUM_CLASSES); - arrMemberIds.Alloc(ESTIMATED_NUM_TYPES); + if (len == 0 || start[0] != '_') + return false; -#if 0 - // do a quick parsing of the nodes; we take advantage of the fact that - // gccxml puts all of them in a contiguos block at the end of the file it produces. - child = doc.GetRoot()->GetChildren(); - while (child && child->GetName() != "File") - child = child->GetNext(); // skip everything until first node + const wxStringCharType *curpos = start, + *end = start + len; + wxStringCharType *nexttoken; - // here starts the node block - while (child) + while (curpos < end) { - wxString id = child->GetAttribute("id", ""); - if (!id.StartsWith("f")) { - LogError("Unexpected file ID: %s", id); + // curpos always points to the underscore of the next token to parse: +#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; - } - fileIds.Add(id); - fileNames.Add(child->GetAttribute("name", "")); + // advance current position + curpos = nexttoken + 1; - child = child->GetNext(); + // add this ID to the hashmap + wxClassMemberIdHashMap::value_type v(id, p); + map->insert(v); } -#endif -#if 0 - wxString allWxClassesIds, allWxMethodsIds, allWxReferencesIds; - allWxClassesIds.Alloc(240000); - allWxMethodsIds.Alloc(240000); - allWxReferencesIds.Alloc(240000); - child = doc.GetRoot()->GetChildren(); - while (child) - { - if (child->GetName() == "Class") - if (child->GetAttribute("name", wxEmptyString).StartsWith("wx")) - allWxClassesIds += " " + child->GetAttribute("members", wxEmptyString); - child = child->GetNext(); - } + return true; +} - child = doc.GetRoot()->GetChildren(); - while (child) - { - wxString n = child->GetName(); - if ((n == "Method" || n == "Constructor" || n == "Destructor" || n == "OperatorMethod") && - child->GetAttribute("access", wxEmptyString) == "public") - { - if (allWxClassesIds.Contains(child->GetAttribute("id", wxEmptyString))) - { - allWxMethodsIds += " " + child->GetAttribute("returns", wxEmptyString); - wxXmlNode *arg = child->GetChildren(); - while (arg) - { - if (arg->GetName() == "Argument") - allWxMethodsIds += " " + arg->GetAttribute("type", wxEmptyString); +// ---------------------------------------------------------------------------- +// wxXmlGccInterface +// ---------------------------------------------------------------------------- + +bool wxXmlGccInterface::Parse(const wxString& filename) +{ + wxXmlDocument doc; + wxXmlNode *child; + int nodes = 0; + + wxLogMessage("Parsing %s...", filename); - arg = arg->GetNext(); - } - } - } + if (!doc.Load(filename)) { + wxLogError("can't load %s", filename); + return false; + } - child = child->GetNext(); + // start processing the XML file + if (doc.GetRoot()->GetName() != "GCC_XML") { + wxLogError("invalid root node for %s", filename); + return false; } - child = doc.GetRoot()->GetChildren(); - while (child) - { - if (allWxMethodsIds.Contains(child->GetAttribute("id", wxEmptyString))) - { - const wxString& type = child->GetAttribute("type", wxEmptyString); - allWxReferencesIds += " " + type; - } + wxString version = doc.GetRoot()->GetAttribute("cvs_revision"); + bool old = false; - child = child->GetNext(); - } +#define MIN_REVISION 120 - child = doc.GetRoot()->GetChildren(); - while (child) + if (!version.StartsWith("1.")) + old = true; + if (!old) { - if (allWxReferencesIds.Contains(child->GetAttribute("id", wxEmptyString))) - { - const wxString& type = child->GetAttribute("type", wxEmptyString); - allWxReferencesIds += " " + type; - } + unsigned long rev = 0; + if (!version.Mid(2).ToULong(&rev)) + old = true; + else + if (rev < MIN_REVISION) + old = true; + } - child = child->GetNext(); + if (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; } - LogMessage("adfafdasfdas %d-%d-%d", allWxClassesIds.Len(), - allWxMethodsIds.Len(), allWxReferencesIds.Len()); -#endif + wxToResolveTypeHashMap toResolveTypes; + wxClassMemberIdHashMap members; + wxTypeIdHashMap types; + wxTypeIdHashMap files; + wxTypeIdHashMap typedefs; + // prealloc quite a lot of memory! + m_classes.Alloc(ESTIMATED_NUM_CLASSES); // build a list of wx classes and in general of all existent types child = doc.GetRoot()->GetChildren(); while (child) { const wxString& n = child->GetName(); - const wxString& id = child->GetAttribute("id", wxEmptyString); -#if 0 - if (!allWxClassesIds.Contains(id) && !allWxMethodsIds.Contains(id) && !allWxReferencesIds.Contains(id)) - ; // ignore this node - else -#endif -#if 0 - wxString fid = child->GetAttribute("file", ""); - int fileidx = wxNOT_FOUND; - - if (!fid.IsEmpty()) { - fileidx = fileIds.Index(fid); - if (fileidx == wxNOT_FOUND) { - LogError("couldn't find the file ID '%s'", fid); - return false; - } - } + unsigned long id = 0; + if (!getID(&id, child->GetAttribute("id")) || (id == 0 && n != "File")) { - if (fileidx!=wxNOT_FOUND && !fileNames[fileidx].Contains("wx")) - { - // skip this node: not wx related! - } else -#endif + // NOTE: nodes can have an id == "f0"... - /*if (child->GetAttribute("artificial", "") == "1") - { - // discard this immediately - we're not interested + wxLogError("Invalid id for node %s: %s", n, child->GetAttribute("id")); + return false; } - else*/ + if (n == "Class") { - wxString cname = child->GetAttribute("name", wxEmptyString); + 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; } // only register wx classes (do remember also the IDs of their members) - if (cname.StartsWith("wx")) { - arrMemberIds.Add(child->GetAttribute("members", wxEmptyString)); - + if (cname.StartsWith("wx")) + { // NB: "file" attribute contains an ID value that we'll resolve later - m_classes.Add(wxClass(cname, child->GetAttribute("file", wxEmptyString))); + m_classes.Add(wxClass(cname, child->GetAttribute("file"))); + + // the just-inserted class: + wxClass *newClass = &m_classes.Last(); + + // now get a list of the base classes: + wxXmlNode *baseNode = child->GetChildren(); + while (baseNode) + { + // for now we store as "parents" only the parent IDs... + // later we will resolve them into full class names + if (baseNode->GetName() == "Base") + newClass->AddParent(baseNode->GetAttribute("type")); + + baseNode = baseNode->GetNext(); + } + + const wxString& ids = child->GetAttribute("members"); + if (ids.IsEmpty()) + { + if (child->GetAttribute("incomplete") != "1") { + wxLogError("Invalid member IDs for '%s' class node: %s", + cname, child->GetAttribute("id")); + return false; + } + //else: don't warn the user; it looks like "incomplete" classes + // never have any member... + } + else + { + // decode the non-empty list of IDs: + if (!getMemberIDs(&members, newClass, ids)) { + wxLogError("Invalid member IDs for '%s' class node: %s", + cname, child->GetAttribute("id")); + return false; + } + } } // register this class also as possible return/argument type: - //typeIds.Add(child->GetAttribute("id", wxEmptyString)); - //typeNames.Add(cname); types[id] = cname; } + else if (n == "Typedef") + { + unsigned long typeId = 0; + if (!getID(&typeId, child->GetAttribute("type"))) { + wxLogError("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") { - const wxString& type = child->GetAttribute("type", wxEmptyString); - if (id.IsEmpty() || type.IsEmpty()) { - LogError("Invalid empty type/id for '%s' node", n); + unsigned long type = 0; + if (!getID(&type, child->GetAttribute("type")) || type == 0) { + wxLogError("Invalid type for node %s: %s", n, child->GetAttribute("type")); return false; } - int attr = 0; + unsigned long attr = 0; if (n == "PointerType") attr = ATTRIB_POINTER; else if (n == "ReferenceType") attr = ATTRIB_REFERENCE; - else if (n == "CvQualifiedType" && child->GetAttribute("const", "") == "1") + else if (n == "CvQualifiedType" && child->GetAttribute("const") == "1") attr = ATTRIB_CONST; else if (n == "ArrayType") attr = ATTRIB_ARRAY; // these nodes make reference to other types... we'll resolve them later - //toResolveTypeIds.Add(id); - //toResolveRefType.Add(type); - //toResolveAttrib.Add(attr); toResolveTypes[id] = toResolveTypeItem(type, attr); } else if (n == "FunctionType" || n == "MethodType") { - /* TODO: incomplete */ - - const wxString& ret = child->GetAttribute("returns", wxEmptyString); - if (id.IsEmpty() || ret.IsEmpty()) { - LogError("Invalid empty ret/id for '%s' node", n); - return false; + /* + TODO: parsing FunctionType and MethodType nodes is not as easy + as for other "simple" types. + */ + + wxString argstr; + wxXmlNode *arg = child->GetChildren(); + while (arg) + { + if (arg->GetName() == "Argument") + argstr += arg->GetAttribute("type") + ", "; + arg = arg->GetNext(); } + if (argstr.Len() > 0) + 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); + //toResolveTypes[id] = toResolveTypeItem(ret, 0); + //types[id] = child->GetAttribute("returns") + "(" + argstr + ")"; + + types[id] = "TOFIX"; // typically this type will be "fixed" thanks + // to a typedef later... } else if (n == "File") { - if (!id.StartsWith("f")) { - LogError("Unexpected file ID: %s", id); + if (!child->GetAttribute("id").StartsWith("f")) { + wxLogError("Unexpected file ID: %s", child->GetAttribute("id")); return false; } // just ignore this node... all file IDs/names were already parsed - files[id] = child->GetAttribute("name", ""); + files[id] = child->GetAttribute("name"); } else { // we register everything else as a possible return/argument type: - const wxString& name = child->GetAttribute("name", wxEmptyString); - /*if (id.IsEmpty() || name.IsEmpty()) { - LogError("Invalid empty name/id for '%s' node", n); - return false; - }*/ + const wxString& name = child->GetAttribute("name"); if (!name.IsEmpty()) { @@ -680,10 +1019,11 @@ bool wxXmlGccInterface::Parse(const wxString& filename) // they're never used as return/argument types by wxWidgets methods if (g_verbose) - LogWarning("Type '%s' with ID '%s' does not have name attribute", n, id); + { + wxLogWarning("Type node '%s' with ID '%s' does not have name attribute", + n, child->GetAttribute("id")); + } - //typeIds.Add(id); - //typeNames.Add("TOFIX"); types[id] = "TOFIX"; } } @@ -695,39 +1035,45 @@ 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) { 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();) { - const wxString& id = i->first; - const wxString& referenced = i->second.ref; + unsigned long id = i->first; + unsigned long referenced = i->second.ref; - wxStringHashMap::iterator primary = types.find(referenced); + wxTypeIdHashMap::iterator primary = types.find(referenced); if (primary != types.end()) { // this to-resolve-type references a "primary" type - wxString newtype; + wxString newtype = primary->second; int attribs = i->second.attribs; + // attribs may contain a combination of ATTRIB_* flags: if (attribs & ATTRIB_CONST) - newtype = "const " + primary->second; + newtype = "const " + newtype; if (attribs & ATTRIB_REFERENCE) - newtype = primary->second + "&"; + newtype = newtype + "&"; if (attribs & ATTRIB_POINTER) - newtype = primary->second + "*"; + newtype = newtype + "*"; if (attribs & ATTRIB_ARRAY) - newtype = primary->second + "[]"; + 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); @@ -750,121 +1096,101 @@ bool wxXmlGccInterface::Parse(const wxString& filename) } else { -#if 1 - LogError("Cannot solve '%s' reference type!", referenced); + wxLogError("Cannot solve '%d' reference type!", referenced); return false; -#else - typeIds.Add(toResolveTypeIds[i]); - typeNames.Add("TOFIX"); - - // this one has been resolved! - toResolveTypeIds.RemoveAt(i); - toResolveRefType.RemoveAt(i); - toResolveAttrib.RemoveAt(i); - n--; -#endif } } } -/* - // now get the return types of all wx methods parsed above - child = doc.GetRoot()->GetChildren(); - int idx; - while (child) { - - wxString n = child->GetName(); - - if (n == "PointerType" || n == "ReferenceType" || n == "CvQualifiedType") { - wxString id = child->GetAttribute("id", wxEmptyString); - wxString type = child->GetAttribute("type", wxEmptyString); - - // are we interested to this id? - while ((idx = retTypeIds.Index(id)) != wxNOT_FOUND) - { - // substitute this ID with the ID referenced by this node - retTypeIds[idx] = type; - // leave "incompleteMethods" array untouched - } - } else { - wxString id = child->GetAttribute("id", wxEmptyString); - wxString name = child->GetAttribute("name", wxEmptyString); - if (!name.IsEmpty()) - { - // are we interested to this id? - while ((idx = retTypeIds.Index(id)) != wxNOT_FOUND) - { - wxMethod *p = (wxMethod*)incompleteMethods[idx]; - p->SetFromString(name + " " + p->GetAsString()); - - //LogMessage("rettype node is named %s and is '%s'", n, - // child->GetAttribute("name", "")); - - // prototype is now complete; remove it from the list of protos - // waiting for completion - retTypeIds.RemoveAt(idx); - incompleteMethods.RemoveAt(idx); - } - } - } - - child = child->GetNext(); - - // give feedback to the user about the progress... - if ((++nodes%PROGRESS_RATE)==0) ShowProgress(); - }*/ } // resolve header names - for (unsigned int i=0; isecond); } + // resolve parent names + for (i=0; isecond); + } + } + // build the list of the wx methods child = doc.GetRoot()->GetChildren(); while (child) { - wxString n = child->GetName(); + wxString n = child->GetName(), acc = child->GetAttribute("access"); - if (n == "Method" || n == "Constructor" || n == "Destructor" || n == "OperatorMethod") + // only register public&protected methods + if ((acc == "public" || acc == "protected") && + (n == "Method" || n == "Constructor" || n == "Destructor" || n == "OperatorMethod")) { - wxString id = child->GetAttribute("id", wxEmptyString); + unsigned long id = 0; + if (!getID(&id, child->GetAttribute("id"))) { + wxLogError("invalid ID for node '%s' with ID '%s'", n, child->GetAttribute("id")); + return false; + } - // only register public methods - if (child->GetAttribute("access", wxEmptyString) == "public") + wxClassMemberIdHashMap::const_iterator it = members.find(id); + if (it != members.end()) { - wxASSERT(arrMemberIds.GetCount()==m_classes.GetCount()); + wxClass *p = it->second; - for (unsigned int i=0; i node is a method of the i-th class! - wxMethod newfunc; - if (!ParseMethod(child, types, newfunc)) - return false; - - if (newfunc.IsCtor() && !m_classes[i].IsValidCtorForThisClass(newfunc)) { - LogError("The method '%s' does not seem to be a ctor for '%s'", - newfunc.GetName(), m_classes[i].GetName()); - return false; - } - if (newfunc.IsDtor() && !m_classes[i].IsValidDtorForThisClass(newfunc)) { - LogError("The method '%s' does not seem to be a dtor for '%s'", - newfunc.GetName(), m_classes[i].GetName()); - return false; - } + // this node is a method of the i-th class! + wxMethod newfunc; + if (!ParseMethod(child, types, newfunc)) { + wxLogError("The method '%s' could not be added to class '%s'", + child->GetAttribute("demangled"), p->GetName()); + return false; + } - m_classes[i].AddMethod(newfunc); - } + // do some additional check that we can do only here: + + if (newfunc.IsCtor() && !p->IsValidCtorForThisClass(newfunc)) { + 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)) { + wxLogError("The method '%s' does not seem to be a dtor for '%s'", + newfunc.GetName(), p->GetName()); + return false; + } + + p->AddMethod(newfunc); } } @@ -874,19 +1200,18 @@ bool wxXmlGccInterface::Parse(const wxString& filename) if ((++nodes%PROGRESS_RATE)==0) ShowProgress(); } - //wxPrint("\n"); - if (!CheckParseResults()) - return false; + if (!CheckConsistency()) + return false; // the check failed return true; } bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, - const wxStringHashMap& types, + const wxTypeIdHashMap& types, wxMethod& m) { // get the real name - wxString name = p->GetAttribute("name", wxEmptyString).Strip(wxString::both); + wxString name = p->GetAttribute("name").Strip(wxString::both); if (p->GetName() == "Destructor") name = "~" + name; else if (p->GetName() == "OperatorMethod") @@ -894,53 +1219,54 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, // resolve return type wxType ret; - wxString retid = p->GetAttribute("returns", wxEmptyString); - if (retid.IsEmpty()) + unsigned long retid = 0; + 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'", - name, p->GetAttribute("id", "")); + wxLogError("Empty return ID for method '%s', with ID '%s'", + name, p->GetAttribute("id")); return false; } } else { - wxStringHashMap::const_iterator retidx = types.find(retid); + 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'", - retidx->second, name, p->GetAttribute("id", "")); + wxLogError("Invalid return type '%s' for method '%s', with ID '%s'", + retidx->second, name, p->GetAttribute("id")); return false; } } // resolve argument types - wxTypeArray argtypes; - wxArrayString argdefs; + wxArgumentTypeArray argtypes; wxXmlNode *arg = p->GetChildren(); while (arg) { if (arg->GetName() == "Argument") { - wxString id = arg->GetAttribute("type", wxEmptyString); - wxStringHashMap::const_iterator idx = types.find(id); - if (idx == types.end()) { - LogError("Could not find argument type ID '%s'", id); + unsigned long id = 0; + if (!getID(&id, arg->GetAttribute("type")) || id == 0) { + wxLogError("Invalid argument type ID '%s' for method '%s' with ID %s", + arg->GetAttribute("type"), name, p->GetAttribute("id")); return false; } - argtypes.Add(wxType(idx->second)); + wxTypeIdHashMap::const_iterator idx = types.find(id); + if (idx == types.end()) { + wxLogError("Could not find argument type ID '%s'", id); + return false; + } - wxString def = arg->GetAttribute("default", ""); - if (def.Contains("wxGetTranslation")) - argdefs.Add(wxEmptyString); // TODO: wxGetTranslation gives problems to gccxml - else - argdefs.Add(def); + argtypes.Add(wxArgumentType(idx->second, + arg->GetAttribute("default"), + arg->GetAttribute("name"))); } arg = arg->GetNext(); @@ -948,13 +1274,29 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p, m.SetReturnType(ret); m.SetName(name); - m.SetArgumentTypes(argtypes, argdefs); - m.SetConst(p->GetAttribute("const", "") == "1"); - m.SetStatic(p->GetAttribute("static", "") == "1"); - m.SetVirtual(p->GetAttribute("virtual", "") == "1"); + m.SetArgumentTypes(argtypes); + m.SetConst(p->GetAttribute("const") == "1"); + m.SetStatic(p->GetAttribute("static") == "1"); + + // NOTE: gccxml is smart enough to mark as virtual those functions + // which are declared virtual in base classes but don't have + // the "virtual" keyword explicitly indicated in the derived + // classes... so we don't need any further logic for virtuals + + m.SetVirtual(p->GetAttribute("virtual") == "1"); + 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()); + wxLogError("The prototype '%s' is not valid!", m.GetAsString()); return false; } @@ -962,6 +1304,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 + wxLogWarning("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")) { + wxLogError("unexpected port ID '%s'", ports[i]); + return false; + } + + nAvail |= wxPlatformInfo::GetPortId(ports[i].Mid(2)); + } + + return nAvail; +} + + // ---------------------------------------------------------------------------- // wxXmlDoxygenInterface // ---------------------------------------------------------------------------- @@ -971,19 +1428,26 @@ 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; } + /* + 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 @@ -991,9 +1455,9 @@ bool wxXmlDoxygenInterface::Parse(const wxString& filename) while (compound) { if (compound->GetName() == "compound" && - compound->GetAttribute("kind", "") == "class") + compound->GetAttribute("kind") == "class") { - wxString refid = compound->GetAttribute("refid", ""); + wxString refid = compound->GetAttribute("refid"); wxFileName fn(filename); if (!ParseCompoundDefinition(fn.GetPath(wxPATH_GET_SEPARATOR) + refid + ".xml")) @@ -1004,29 +1468,32 @@ bool wxXmlDoxygenInterface::Parse(const wxString& filename) } //wxPrint("\n"); - if (!CheckParseResults()) - return false; + if (!CheckConsistency()) + return false; // the check failed return true; } bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) { + wxClassMemberIdHashMap parents; wxXmlDocument doc; wxXmlNode *child; 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; } @@ -1035,7 +1502,7 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) while (child) { if (child->GetName() == "compounddef" && - child->GetAttribute("kind", wxEmptyString) == "class") + child->GetAttribute("kind") == "class") { // parse this class wxClass klass; @@ -1044,32 +1511,51 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) wxXmlNode *subchild = child->GetChildren(); while (subchild) { - if (subchild->GetName() == "sectiondef" && - subchild->GetAttribute("kind", wxEmptyString) == "public-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", wxEmptyString) == "function") + membernode->GetAttribute("kind") == "function" && + (accessSpec == "public" || accessSpec == "protected")) { - wxMethod m; - if (ParseMethod(membernode, m, header)) + if (!ParseMethod(membernode, m, header)) { + wxLogError("The method '%s' could not be added to class '%s'", + m.GetName(), klass.GetName()); + return false; + } + + if (accessSpec == "public") + m.SetAccessSpecifier(wxMAS_PUBLIC); + else if (accessSpec == "protected") + m.SetAccessSpecifier(wxMAS_PROTECTED); + else if (accessSpec == "private") + m.SetAccessSpecifier(wxMAS_PRIVATE); + + if (absoluteFile.IsEmpty()) + absoluteFile = header; + else if (header != absoluteFile) { - 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); - return false; - } - - klass.AddMethod(m); + 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; } + + klass.AddMethod(m); } membernode = membernode->GetNext(); @@ -1091,16 +1577,30 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename) klass.SetHeader(subchild->GetNodeContent()); }*/ + else if (subchild->GetName() == "detaileddescription") + { + // identify custom XML tags + klass.SetAvailability(GetAvailabilityFor(subchild)); + } + else if (subchild->GetName() == "basecompoundref") + { + // add the name of this parent to the list of klass' parents + klass.AddParent(subchild->GetNodeContent()); + } subchild = subchild->GetNext(); } // 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(); @@ -1112,43 +1612,9 @@ 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; -} - bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxString& header) { - wxTypeArray args; - wxArrayString defs; + wxArgumentTypeArray args; long line; wxXmlNode *child = p->GetChildren(); @@ -1160,7 +1626,7 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin m.SetReturnType(wxType(GetTextFromChildren(child))); else if (child->GetName() == "param") { - wxString typestr, defstr, arrstr; + wxString typestr, namestr, defstr, arrstr; wxXmlNode *n = child->GetChildren(); while (n) { @@ -1168,9 +1634,10 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin // if the node has children, they should be all TEXT and nodes // and we need to take the text they contain, in the order they appear typestr = GetTextFromChildren(n); + else if (n->GetName() == "declname") + namestr = GetTextFromChildren(n); else if (n->GetName() == "defval") - // same for the node - defstr = GetTextFromChildren(n); + defstr = GetTextFromChildren(n).Strip(wxString::both); else if (n->GetName() == "array") arrstr = GetTextFromChildren(n); @@ -1178,30 +1645,55 @@ 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; } - args.Add(wxType(typestr + arrstr)); - defs.Add(defstr); + 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") { - if (child->GetAttribute("line", "").ToLong(&line)) + line = -1; + if (child->GetAttribute("line").ToLong(&line)) m.SetLocation((int)line); - header = child->GetAttribute("file", ""); + header = child->GetAttribute("file"); + } + else if (child->GetName() == "detaileddescription") + { + // when a method has a @deprecated tag inside its description, + // Doxygen outputs somewhere nested inside + // a Deprecated tag. + m.SetDeprecated(HasTextNodeContaining(child, "Deprecated")); + + // identify custom XML tags + m.SetAvailability(GetAvailabilityFor(child)); } child = child->GetNext(); } - m.SetArgumentTypes(args, defs); - m.SetConst(p->GetAttribute("const", "")=="yes"); - m.SetStatic(p->GetAttribute("static", "")=="yes"); - m.SetVirtual(p->GetAttribute("virt", "")=="virtual"); + m.SetArgumentTypes(args); + m.SetConst(p->GetAttribute("const")=="yes"); + m.SetStatic(p->GetAttribute("static")=="yes"); + + // NOTE: Doxygen is smart enough to mark as virtual those functions + // which are declared virtual in base classes but don't have + // the "virtual" keyword explicitly indicated in the derived + // classes... so we don't need any further logic for virtuals + + m.SetVirtual(p->GetAttribute("virt")=="virtual"); + 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; }