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 LogMessage("%s: couldn't find the real interface for the '%s' class",
169 interface
[i
].GetHeader(), cname
);
174 LogMessage("%d methods (%.1f%%) of the interface headers do not exist in the real headers",
175 mcount
, (float)(100.0 * mcount
/m_interface
.GetMethodCount()));
176 LogMessage("%d classes (%.1f%%) of the interface headers do not exist in the real headers",
177 ccount
, (float)(100.0 * ccount
/m_interface
.GetClassesCount()));
182 int IfaceCheckApp::CompareClasses(const wxClass
* iface
, const wxClassPtrArray
& api
)
184 wxString searchedclasses
;
185 const wxMethod
*real
;
188 wxASSERT(iface
&& api
.GetCount()>0);
190 // build a string with the names of the API classes compared to iface
191 for (unsigned int j
=0; j
<api
.GetCount(); j
++)
192 searchedclasses
+= "/" + api
[j
]->GetName();
193 searchedclasses
.Remove(0, 1);
196 // shorten the name of the header so the log file is more readable
197 wxString header
= iface
->GetHeader().AfterLast('/');
199 for (unsigned int i
=0; i
<iface
->GetMethodCount(); i
++)
201 const wxMethod
& m
= iface
->GetMethod(i
);
202 wxString tofind
= m
.GetAsString();
205 // search in the methods of the api classes provided
206 for (unsigned int j
=0; j
<api
.GetCount(); j
++)
208 real
= api
[j
]->FindMethod(m
);
211 // there is a matching prototype! It's ok!
212 //LogMessage("the doxygen method '%s' has a match in the real interface of '%s'!",
213 // tofind, api[j]->GetName());
220 wxMethodPtrArray overloads
;
222 // try searching for a method with the same name but with
223 // different return type / arguments / qualifiers
224 for (unsigned int j
=0; j
<api
.GetCount(); j
++)
226 wxMethodPtrArray results
= api
[j
]->FindMethodNamed(m
.GetName());
228 // append "results" array to "overloads"
229 WX_APPEND_ARRAY(overloads
, results
);
232 if (overloads
.GetCount()>1)
234 // TODO: decide which of these overloads is the most "similar" to m
235 // and eventually modify it
236 LogWarning("%s: there are %d overloads of method '%s' in the classes '%s' "
237 "all with different signatures; manual fix is required",
238 header
, overloads
.GetCount(), tofind
, searchedclasses
);
240 else if (overloads
.GetCount() == 1)
243 if (m_modify
) tmp
= "; fixing it...";
245 LogWarning("%s: the method '%s' of classes '%s' has a different signature%s",
246 header
, tofind
, searchedclasses
, tmp
);
250 FixMethod(iface
->GetHeader(), &m
, overloads
[0]);
254 LogMessage("%s: real '%s' class has no method '%s'",
255 header
, searchedclasses
, tofind
);
256 count
++; // count this type of warnings
264 void IfaceCheckApp::FixMethod(const wxString
& header
, const wxMethod
* iface
, const wxMethod
* api
)
266 wxASSERT(iface
&& api
);
269 if (!file
.Open(header
)) {
270 LogError("can't open the '%s' header file.", header
);
275 // fix iface signature to match that of "api" method:
276 file
.RemoveLine(iface
->GetLocation());
277 file
.InsertLine(api
->GetAsString(), iface
->GetLocation());
279 // GetLocation() returns the line where the last part of the prototype is placed:
280 int end
= iface
->GetLocation()-1;
282 // find the start point of this prototype declaration:
284 while (!file
.GetLine(start
).Contains(";") && !file
.GetLine(start
).Contains("*/"))
289 LogError("can't find the beginning of the declaration of '%s' method in '%s' header",
290 iface
->GetAsString(), header
);
295 // remove the old prototype
296 for (int i
=start
; i
<=end
; i
++)
299 // insert the new one
300 file
.InsertLine(" " + api
->GetAsString(), start
);
304 LogError("can't save the '%s' header file.", header
);
309 void IfaceCheckApp::PrintStatistics(long secs
)
311 LogMessage("wx real headers contains declaration of %d classes (%d methods)",
312 m_api
.GetClassesCount(), m_api
.GetMethodCount());
313 LogMessage("wx interface headers contains declaration of %d classes (%d methods)",
314 m_interface
.GetClassesCount(), m_interface
.GetMethodCount());
315 LogMessage("total processing took %d seconds.", secs
);