From 83fdf79672dfe71b6c0bb9ea52a7df723a292b12 Mon Sep 17 00:00:00 2001
From: Francesco Montorsi <f18m_cpp217828@yahoo.it>
Date: Mon, 27 Oct 2008 21:16:01 +0000
Subject: [PATCH] fixed some false positives; fixed method declaration-position
 detection also for operators

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56534 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 utils/ifacecheck/src/ifacecheck.cpp | 48 +++++++++++++++++++----------
 utils/ifacecheck/src/xmlparser.cpp  |  4 +++
 utils/ifacecheck/src/xmlparser.h    |  4 +++
 3 files changed, 40 insertions(+), 16 deletions(-)

diff --git a/utils/ifacecheck/src/ifacecheck.cpp b/utils/ifacecheck/src/ifacecheck.cpp
index 2a07c143a6..fc71239f59 100644
--- a/utils/ifacecheck/src/ifacecheck.cpp
+++ b/utils/ifacecheck/src/ifacecheck.cpp
@@ -82,6 +82,7 @@ public:
     bool Compare();
     int CompareClasses(const wxClass* iface, const wxClass* api);
     bool FixMethod(const wxString& header, const wxMethod* iface, const wxMethod* api);
+    bool StringContainsMethodName(const wxString& str, const wxMethod* m);
 
     void ShowProgress();
     void PrintStatistics(long secs);
@@ -398,6 +399,12 @@ int IfaceCheckApp::CompareClasses(const wxClass* iface, const wxClass* api)
     return count;
 }
 
+bool IfaceCheckApp::StringContainsMethodName(const wxString& str, const wxMethod* m)
+{
+    return str.Contains(m->GetName()) ||
+           (m->IsOperator() && str.Contains("operator"));
+}
+
 bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, const wxMethod* api)
 {
     wxASSERT(iface && api);
@@ -408,7 +415,8 @@ bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, con
         return false;
     }
 
-    // GetLocation() returns the line where the last part of the prototype is placed:
+    // GetLocation() returns the line where the last part of the prototype is placed;
+    // i.e. the line containing the semicolon at the end of the declaration.
     int end = iface->GetLocation()-1;
     if (end <= 0 || end >= (int)file.GetLineCount()) {
         LogWarning("\tinvalid location info for method '%s': %d.",
@@ -425,7 +433,7 @@ bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, con
     // is this a one-line prototype declaration?
     bool founddecl = false;
     int start;
-    if (file.GetLine(end).Contains(iface->GetName()))
+    if (StringContainsMethodName(file.GetLine(end), iface))
     {
         // yes, this prototype is all on this line:
         start = end;
@@ -433,27 +441,27 @@ bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, con
     }
     else
     {
-        start = end-1;
+        start = end;    // will be decremented inside the while{} loop below
 
-        // find the start point of this prototype declaration:
-        while (start > 0 &&
-            !file.GetLine(start).Contains(";") &&
-            !file.GetLine(start).Contains("*/"))
+        // find the start point of this prototype declaration; i.e. the line
+        // containing the function name, which is also the line following
+        // the marker '*/' for the closure of the doxygen comment
+        do
         {
-            start--;
+            start--;        // go up one line
 
-            founddecl |= file.GetLine(start).Contains(iface->GetName());
+            if (StringContainsMethodName(file.GetLine(start), iface))
+                founddecl = true;
         }
-
-        // start-th line contains either the declaration of another prototype
-        // or the closing tag */ of a doxygen comment; start one line below
-        start++;
+        while (start > 0 && !founddecl &&
+               !file.GetLine(start).Contains(";") &&
+               !file.GetLine(start).Contains("*/"));
     }
 
     if (start <= 0 || !founddecl)
     {
-        LogError("\tcan't find the beginning of the declaration of '%s' method in '%s' header looking backwards from line %d",
-                    iface->GetAsString(), header, end);
+        LogError("\tcan't find the beginning of the declaration of '%s' method in '%s' header looking backwards from line %d; I arrived at %d and gave up",
+                 iface->GetAsString(), header, end+1 /* zero-based => 1-based */, start);
         return false;
     }
 
@@ -479,15 +487,23 @@ bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, con
 
     wxMethod tmp(*api);
 
-    // discard API argument names and replace them with those parsed from doxygen XML:
+    // discard gcc XML argument names and replace them with those parsed from doxygen XML;
+    // in this way we should avoid introducing doxygen warnings about cases where the argument
+    // 'xx' of the prototype is called 'yy' in the function's docs.
     const wxArgumentTypeArray& doxygenargs = iface->GetArgumentTypes();
     const wxArgumentTypeArray& realargs = api->GetArgumentTypes();
     if (realargs.GetCount() == doxygenargs.GetCount())
     {
         for (unsigned int j=0; j<doxygenargs.GetCount(); j++)
             if (doxygenargs[j]==realargs[j])
+            {
                 realargs[j].SetArgumentName(doxygenargs[j].GetArgumentName());
 
+                if (realargs[j].GetDefaultValue().IsNumber() &&
+                    doxygenargs[j].GetDefaultValue().StartsWith("wx"))
+                    realargs[j].SetDefaultValue(doxygenargs[j].GetDefaultValue());
+            }
+
         tmp.SetArgumentTypes(realargs);
     }
 
diff --git a/utils/ifacecheck/src/xmlparser.cpp b/utils/ifacecheck/src/xmlparser.cpp
index 849a36a8a9..c9dae4fc52 100644
--- a/utils/ifacecheck/src/xmlparser.cpp
+++ b/utils/ifacecheck/src/xmlparser.cpp
@@ -81,6 +81,9 @@ void wxType::SetTypeFromString(const wxString& t)
 
     m_strType.Replace(" ,", ",");
 
+    // ADHOC-FIX
+    m_strType.Replace("_wxArraywxArrayStringBase", "const wxString&");
+
     m_strType = m_strType.Strip(wxString::both);
 
 
@@ -107,6 +110,7 @@ void wxType::SetTypeFromString(const wxString& t)
     m_strTypeClean.Replace("wxDateTime::", "");
     m_strTypeClean.Replace("wxStockGDI::", "");     // same story for some other classes
     m_strTypeClean.Replace("wxHelpEvent::", "");
+    m_strTypeClean.Replace("wxWindowID", "int");
 }
 
 bool wxType::IsOk() const
diff --git a/utils/ifacecheck/src/xmlparser.h b/utils/ifacecheck/src/xmlparser.h
index 7f0cf3e3c2..34c44fff8b 100644
--- a/utils/ifacecheck/src/xmlparser.h
+++ b/utils/ifacecheck/src/xmlparser.h
@@ -213,11 +213,14 @@ public:     // getters
         { return m_retType==wxEmptyType && !m_strName.StartsWith("~"); }
     bool IsDtor() const
         { return m_retType==wxEmptyType && m_strName.StartsWith("~"); }
+    bool IsOperator() const
+        { return m_strName.StartsWith("operator"); }
 
     bool IsDeprecated() const
         { return m_bDeprecated; }
 
 
+
 public:     // setters
 
     void SetReturnType(const wxType& t)
@@ -263,6 +266,7 @@ public:     // misc
     // argument, thus is able to act also as default ctor
     bool ActsAsDefaultCtor() const;
 
+    // dumps the contents of this class in the given stream
     void Dump(wxTextOutputStream& stream) const;
 
 protected:
-- 
2.45.2