Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add 'availability' infos to both wxMethod and wxClass: in this way ifacecheck does not warn about methods documented to be available only for port X, which are missing from the gcc XML, if the gcc XML was produced for a port different than X; this requires @onlyfor ALIAS to output <onlyfor> tags in the XML output

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52863 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-27 20:57:05 +00:00
parent d9faa1fede
commit 03d4f7b992
5 changed files with 228 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

185
utils/ifacecheck/src/xmlparser.cpp
View File

@@ -927,6 +927,121 @@ bool wxXmlGccInterface::ParseMethod(const wxXmlNode *p,
}
// ----------------------------------------------------------------------------
// wxXmlDoxygenInterface global helpers
// ----------------------------------------------------------------------------
static wxString GetTextFromChildren(const wxXmlNode *n)
{
wxString text;
// consider the tree
//
// <a><b>this</b> is a <b>string</b></a>
//
// <a>
// |- <b>
// | |- this
// |- is a
// |- <b>
// |- 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 <onlyfor> 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
// ----------------------------------------------------------------------------
@@ -1059,6 +1174,11 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename)
klass.SetHeader(subchild->GetNodeContent());
}*/
else if (subchild->GetName() == "detaileddescription")
{
// identify <onlyfor> custom XML tags
klass.SetAvailability(GetAvailabilityFor(subchild));
}
subchild = subchild->GetNext();
}
@@ -1080,68 +1200,6 @@ bool wxXmlDoxygenInterface::ParseCompoundDefinition(const wxString& filename)
return true;
}
static wxString GetTextFromChildren(const wxXmlNode *n)
{
wxString text;
// consider the tree
//
// <a><b>this</b> is a <b>string</b></a>
//
// <a>
// |- <b>
// | |- this
// |- is a
// |- <b>
// |- 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;
@@ -1202,6 +1260,9 @@ bool wxXmlDoxygenInterface::ParseMethod(const wxXmlNode* p, wxMethod& m, wxStrin
// Doxygen outputs somewhere nested inside <detaileddescription>
// a <xreftitle>Deprecated</xreftitle> tag.
m.SetDeprecated(HasTextNodeContaining(child, "Deprecated"));
// identify <onlyfor> custom XML tags
m.SetAvailability(GetAvailabilityFor(child));
}
child = child->GetNext();