1 /////////////////////////////////////////////////////////////////////////////
2 // Name: ifacecheck.cpp
3 // Purpose: Interface headers <=> real headers coherence checker
4 // Author: Francesco Montorsi
7 // Copyright: (c) 2008 Francesco Montorsi
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // For compilers that support precompilation, includes "wx/wx.h".
12 #include "wx/wxprec.h"
18 // for all others, include the necessary headers
23 #include "wx/cmdline.h"
24 #include "wx/textfile.h"
25 #include "wx/stopwatch.h" // for wxGetLocalTime
26 #include "xmlparser.h"
28 // global verbosity flag
29 bool g_verbose
= false;
33 // ----------------------------------------------------------------------------
35 // ----------------------------------------------------------------------------
37 #define API_DUMP_FILE "dump.api.txt"
38 #define INTERFACE_DUMP_FILE "dump.interface.txt"
40 #define MODIFY_SWITCH "m"
41 #define DUMP_SWITCH "dump"
42 #define HELP_SWITCH "h"
43 #define VERBOSE_SWITCH "v"
45 static const wxCmdLineEntryDesc g_cmdLineDesc
[] =
47 { wxCMD_LINE_SWITCH
, MODIFY_SWITCH
, "modify",
48 "modify the interface headers to match the real ones" },
49 { wxCMD_LINE_SWITCH
, "", DUMP_SWITCH
,
50 "dump both interface and API to plain text" },
51 { wxCMD_LINE_SWITCH
, HELP_SWITCH
, "help",
52 "show help message", wxCMD_LINE_VAL_NONE
, wxCMD_LINE_OPTION_HELP
},
53 { wxCMD_LINE_SWITCH
, VERBOSE_SWITCH
, "verbose",
55 { wxCMD_LINE_PARAM
, NULL
, NULL
,
56 "gccXML", wxCMD_LINE_VAL_STRING
, wxCMD_LINE_OPTION_MANDATORY
},
57 { wxCMD_LINE_PARAM
, NULL
, NULL
,
58 "doxygenXML", wxCMD_LINE_VAL_STRING
, wxCMD_LINE_OPTION_MANDATORY
},
62 class IfaceCheckApp
: public wxAppConsole
65 // don't use builtin cmd line parsing:
66 virtual bool OnInit() { m_modify
=false; return true; }
70 int CompareClasses(const wxClass
* iface
, const wxClassPtrArray
& api
);
71 void FixMethod(const wxString
& header
, const wxMethod
* iface
, const wxMethod
* api
);
74 void PrintStatistics(long secs
);
77 wxXmlGccInterface m_api
; // "real" headers API
78 wxXmlDoxygenInterface m_interface
; // doxygen-commented headers API
80 // was the MODIFY_SWITCH passed?
84 IMPLEMENT_APP_CONSOLE(IfaceCheckApp
)
86 int IfaceCheckApp::OnRun()
88 long startTime
= wxGetLocalTime(); // for timing purpose
90 // parse the command line...
91 wxCmdLineParser
parser(g_cmdLineDesc
, argc
, argv
);
93 switch (parser
.Parse())
96 // HELP_SWITCH was passed
100 if (parser
.Found(VERBOSE_SWITCH
))
103 if (!m_api
.Parse(parser
.GetParam(0)) ||
104 !m_interface
.Parse(parser
.GetParam(1)))
107 if (parser
.Found(DUMP_SWITCH
))
109 LogMessage("Dumping real API to '%s'...", API_DUMP_FILE
);
110 m_api
.Dump(API_DUMP_FILE
);
112 LogMessage("Dumping interface API to '%s'...", INTERFACE_DUMP_FILE
);
113 m_interface
.Dump(INTERFACE_DUMP_FILE
);
117 if (parser
.Found(MODIFY_SWITCH
))
123 PrintStatistics(wxGetLocalTime() - startTime
);
130 void IfaceCheckApp::ShowProgress()
136 bool IfaceCheckApp::Compare()
138 const wxClassArray
& interface
= m_interface
.GetClasses();
141 int mcount
= 0, ccount
= 0;
143 LogMessage("Comparing the interface API to the real API (%d classes to compare)...",
144 interface
.GetCount());
146 for (unsigned int i
=0; i
<interface
.GetCount(); i
++)
148 wxString cname
= interface
[i
].GetName();
152 // search in the real headers for i-th interface class
153 // for both class cname and cnameBase as in wxWidgets world, most often
154 // class cname is platform-specific while the real public interface of
155 // that class is part of the cnameBase class.
156 c
= m_api
.FindClass(cname
);
158 c
= m_api
.FindClass(cname
+ "Base");
161 if (api
.GetCount()>0) {
163 // there is a class with exactly the same name!
164 mcount
+= CompareClasses(&interface
[i
], api
);
168 // shorten the name of the header so the log file is more readable
169 wxString header
= interface
[i
].GetHeader().AfterLast('/');
171 LogMessage("%s: couldn't find the real interface for the '%s' class",
177 LogMessage("%d methods (%.1f%%) of the interface headers do not exist in the real headers",
178 mcount
, (float)(100.0 * mcount
/m_interface
.GetMethodCount()));
179 LogMessage("%d classes (%.1f%%) of the interface headers do not exist in the real headers",
180 ccount
, (float)(100.0 * ccount
/m_interface
.GetClassesCount()));
185 int IfaceCheckApp::CompareClasses(const wxClass
* iface
, const wxClassPtrArray
& api
)
187 wxString searchedclasses
;
188 const wxMethod
*real
;
191 wxASSERT(iface
&& api
.GetCount()>0);
193 // build a string with the names of the API classes compared to iface
194 for (unsigned int j
=0; j
<api
.GetCount(); j
++)
195 searchedclasses
+= "/" + api
[j
]->GetName();
196 searchedclasses
.Remove(0, 1);
198 // shorten the name of the header so the log file is more readable
199 wxString header
= iface
->GetHeader().AfterLast('/');
201 for (unsigned int i
=0; i
<iface
->GetMethodCount(); i
++)
203 const wxMethod
& m
= iface
->GetMethod(i
);
206 // search in the methods of the api classes provided
207 for (unsigned int j
=0; j
<api
.GetCount(); j
++)
209 real
= api
[j
]->FindMethod(m
);
211 matches
++; // there is a real matching prototype! It's ok!
216 wxMethodPtrArray overloads
;
218 // try searching for a method with the same name but with
219 // different return type / arguments / qualifiers
220 for (unsigned int j
=0; j
<api
.GetCount(); j
++)
222 wxMethodPtrArray results
= api
[j
]->FindMethodNamed(m
.GetName());
224 // append "results" array to "overloads"
225 WX_APPEND_ARRAY(overloads
, results
);
228 if (overloads
.GetCount()==0)
230 LogMessage("%s: real '%s' class has no method '%s'",
231 header
, searchedclasses
, m
.GetAsString());
232 // we've found no overloads
236 // first, output a warning
237 wxString warning
= header
;
238 if (overloads
.GetCount()>1)
239 warning
+= wxString::Format(": in the real headers there are %d overloads of '%s' for "
240 "'%s' all with different signatures:\n",
241 overloads
.GetCount(), m
.GetName(), searchedclasses
);
243 warning
+= wxString::Format(": in the real headers there is a method '%s' for '%s'"
244 " but has different signature:\n",
245 m
.GetName(), searchedclasses
);
247 warning
+= "\tdoxy header: " + m
.GetAsString();
248 for (unsigned int j
=0; j
<overloads
.GetCount(); j
++)
249 warning
+= "\n\treal header: " + overloads
[j
]->GetAsString();
251 wxPrint(warning
+ "\n");
254 if (overloads
.GetCount()>1)
256 // TODO: decide which of these overloads is the most "similar" to m
257 // and eventually modify it
259 wxPrint("\tmanual fix is required\n");
263 wxASSERT(overloads
.GetCount() == 1);
267 wxPrint("\tfixing it...\n");
270 FixMethod(iface
->GetHeader(), &m
, overloads
[0]);
282 void IfaceCheckApp::FixMethod(const wxString
& header
, const wxMethod
* iface
, const wxMethod
* api
)
284 wxASSERT(iface
&& api
);
287 if (!file
.Open(header
)) {
288 LogError("can't open the '%s' header file.", header
);
292 // GetLocation() returns the line where the last part of the prototype is placed:
293 int end
= iface
->GetLocation()-1;
294 if (end
<= 0 || end
>= (int)file
.GetLineCount()) {
295 LogWarning("invalid location info for method '%s': %d.",
296 iface
->GetAsString(), iface
->GetLocation());
300 if (!file
.GetLine(end
).Contains(iface
->GetName())) {
301 LogWarning("invalid location info for method '%s': %d.",
302 iface
->GetAsString(), iface
->GetLocation());
306 // find the start point of this prototype declaration:
309 !file
.GetLine(start
).Contains(";") &&
310 !file
.GetLine(start
).Contains("*/"))
315 LogError("can't find the beginning of the declaration of '%s' method in '%s' header",
316 iface
->GetAsString(), header
);
320 // start-th line contains either the declaration of another prototype
321 // or the closing tag */ of a doxygen comment; start one line below
324 // remove the old prototype
325 for (int i
=start
; i
<=end
; i
++)
326 file
.RemoveLine(start
); // remove (end-start)-nth times the start-th line
328 #define INDENTATION_STR wxString(" ")
330 // if possible, add also the @deprecated tag in the doxygen comment
331 if (file
.GetLine(start
-1).Contains("*/") && api
->IsDeprecated())
333 file
.RemoveLine(start
-1);
334 file
.InsertLine(INDENTATION_STR
+ INDENTATION_STR
+
335 "@deprecated @todo provide deprecation description", start
-1);
336 file
.InsertLine(INDENTATION_STR
+ "*/", start
++);
339 // insert the new one
340 file
.InsertLine(INDENTATION_STR
+ api
->GetAsString() + ";", start
);
342 // now save the modification
344 LogError("can't save the '%s' header file.", header
);
349 void IfaceCheckApp::PrintStatistics(long secs
)
351 LogMessage("wx real headers contains declaration of %d classes (%d methods)",
352 m_api
.GetClassesCount(), m_api
.GetMethodCount());
353 LogMessage("wx interface headers contains declaration of %d classes (%d methods)",
354 m_interface
.GetClassesCount(), m_interface
.GetMethodCount());
355 LogMessage("total processing took %d seconds.", secs
);