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
24 #include "wx/cmdline.h"
25 #include "wx/textfile.h"
26 #include "wx/filename.h"
27 #include "wx/stopwatch.h" // for wxGetLocalTime
28 #include "xmlparser.h"
30 // global verbosity flag
31 bool g_verbose
= false;
35 // ----------------------------------------------------------------------------
37 // ----------------------------------------------------------------------------
39 #define API_DUMP_FILE "dump.api.txt"
40 #define INTERFACE_DUMP_FILE "dump.interface.txt"
42 #define PROCESS_ONLY_OPTION "p"
43 #define USE_PREPROCESSOR_OPTION "u"
45 #define MODIFY_SWITCH "m"
46 #define DUMP_SWITCH "d"
47 #define HELP_SWITCH "h"
48 #define VERBOSE_SWITCH "v"
50 static const wxCmdLineEntryDesc g_cmdLineDesc
[] =
52 { wxCMD_LINE_OPTION
, USE_PREPROCESSOR_OPTION
, "use-preproc",
53 "uses the preprocessor output to increase the checker accuracy",
54 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_NEEDS_SEPARATOR
},
55 { wxCMD_LINE_OPTION
, PROCESS_ONLY_OPTION
, "process-only",
56 "processes only header files matching the given wildcard",
57 wxCMD_LINE_VAL_STRING
, wxCMD_LINE_NEEDS_SEPARATOR
},
58 { wxCMD_LINE_SWITCH
, MODIFY_SWITCH
, "modify",
59 "modify the interface headers to match the real ones" },
60 { wxCMD_LINE_SWITCH
, DUMP_SWITCH
, "dump",
61 "dump both interface and API to plain text dump.*.txt files" },
62 { wxCMD_LINE_SWITCH
, HELP_SWITCH
, "help",
63 "show help message", wxCMD_LINE_VAL_NONE
, wxCMD_LINE_OPTION_HELP
},
64 { wxCMD_LINE_SWITCH
, VERBOSE_SWITCH
, "verbose",
66 { wxCMD_LINE_PARAM
, NULL
, NULL
,
67 "gccXML", wxCMD_LINE_VAL_STRING
, wxCMD_LINE_OPTION_MANDATORY
},
68 { wxCMD_LINE_PARAM
, NULL
, NULL
,
69 "doxygenXML", wxCMD_LINE_VAL_STRING
, wxCMD_LINE_OPTION_MANDATORY
},
73 class IfaceCheckApp
: public wxAppConsole
76 // don't use builtin cmd line parsing:
77 virtual bool OnInit() { m_modify
=false; return true; }
80 bool ParsePreprocessorOutput(const wxString
& filename
);
83 int CompareClasses(const wxClass
* iface
, const wxClass
* api
);
84 bool FixMethod(const wxString
& header
, const wxMethod
* iface
, const wxMethod
* api
);
85 bool StringContainsMethodName(const wxString
& str
, const wxMethod
* m
);
88 void PrintStatistics(long secs
);
90 bool IsToProcess(const wxString
& headername
) const
92 if (m_strToMatch
.IsEmpty())
94 return wxMatchWild(m_strToMatch
, headername
, false);
98 wxXmlGccInterface m_gccInterface
; // "real" headers API
99 wxXmlDoxygenInterface m_doxyInterface
; // doxygen-commented headers API
101 // was the MODIFY_SWITCH passed?
104 // if non-empty, then PROCESS_ONLY_OPTION was passed and this is the
105 // wildcard expression to match
106 wxString m_strToMatch
;
109 IMPLEMENT_APP_CONSOLE(IfaceCheckApp
)
111 int IfaceCheckApp::OnRun()
113 long startTime
= wxGetLocalTime(); // for timing purpose
115 wxCmdLineParser
parser(g_cmdLineDesc
, argc
, argv
);
117 wxString::Format("wxWidgets Interface checker utility (built %s against %s)",
118 __DATE__
, wxVERSION_STRING
));
120 // parse the command line...
122 wxString preprocFile
;
123 switch (parser
.Parse())
126 if (parser
.Found(VERBOSE_SWITCH
))
129 // IMPORTANT: parsing #define values must be done _before_ actually
130 // parsing the GCC/doxygen XML files
131 if (parser
.Found(USE_PREPROCESSOR_OPTION
, &preprocFile
))
133 if (!ParsePreprocessorOutput(preprocFile
))
137 // in any case set basic std preprocessor #defines:
138 m_doxyInterface
.AddPreprocessorValue("NULL", "0");
140 //g_bLogEnabled = false;
142 // parse the two XML files which contain the real and the doxygen interfaces
143 // for wxWidgets API:
144 if (!m_gccInterface
.Parse(parser
.GetParam(0)) ||
145 !m_doxyInterface
.Parse(parser
.GetParam(1)))
148 g_bLogEnabled
= true;
150 if (parser
.Found(DUMP_SWITCH
))
152 LogMessage("Dumping real API to '%s'...", API_DUMP_FILE
);
153 m_gccInterface
.Dump(API_DUMP_FILE
);
155 LogMessage("Dumping interface API to '%s'...", INTERFACE_DUMP_FILE
);
156 m_doxyInterface
.Dump(INTERFACE_DUMP_FILE
);
160 if (parser
.Found(MODIFY_SWITCH
))
163 if (parser
.Found(PROCESS_ONLY_OPTION
, &m_strToMatch
))
165 size_t len
= m_strToMatch
.Len();
166 if (m_strToMatch
.StartsWith("\"") &&
167 m_strToMatch
.EndsWith("\"") &&
169 m_strToMatch
= m_strToMatch
.Mid(1, len
-2);
176 PrintStatistics(wxGetLocalTime() - startTime
);
180 wxPrintf("\nThis utility checks that the interface XML files created by Doxygen are in\n");
181 wxPrintf("synch with the real headers (whose contents are extracted by the gcc XML file).\n\n");
182 wxPrintf("The 'gccXML' parameter should be the wxapi.xml file created by the 'rungccxml.sh'\n");
183 wxPrintf("script which resides in 'utils/ifacecheck'.\n");
184 wxPrintf("The 'doxygenXML' parameter should be the index.xml file created by Doxygen\n");
185 wxPrintf("for the wxWidgets 'interface' folder.\n\n");
186 wxPrintf("Since the gcc XML file does not contain info about #defines, if you use\n");
187 wxPrintf("the -%s option, you'll get a smaller number of false warnings.\n",
188 USE_PREPROCESSOR_OPTION
);
190 // HELP_SWITCH was passed or a syntax error occurred
195 void IfaceCheckApp::ShowProgress()
201 bool IfaceCheckApp::Compare()
203 const wxClassArray
& interfaces
= m_doxyInterface
.GetClasses();
205 int mcount
= 0, ccount
= 0;
207 LogMessage("Comparing the interface API to the real API (%d classes to compare)...",
208 interfaces
.GetCount());
210 if (!m_strToMatch
.IsEmpty())
211 LogMessage("Processing only header files matching '%s' expression.", m_strToMatch
);
213 for (unsigned int i
=0; i
<interfaces
.GetCount(); i
++)
215 // only compare the methods which are available for the port
216 // for which the gcc XML was produced
217 if (interfaces
[i
].GetAvailability() != wxPORT_UNKNOWN
&&
218 (interfaces
[i
].GetAvailability() & m_gccInterface
.GetInterfacePort()) == 0) {
221 LogMessage("skipping class '%s' since it's not available for the %s port.",
222 interfaces
[i
].GetName(), m_gccInterface
.GetInterfacePortName());
224 continue; // skip this method
227 // shorten the name of the header so the log file is more readable
228 // and also for calling IsToProcess() against it
229 wxString header
= wxFileName(interfaces
[i
].GetHeader()).GetFullName();
231 if (!IsToProcess(header
))
232 continue; // skip this one
234 wxString cname
= interfaces
[i
].GetName();
236 // search in the real headers for i-th interface class; we search for
237 // both class cname and cnameBase since in wxWidgets world tipically
238 // class cname is platform-specific while the real public interface of
239 // that class is part of the cnameBase class.
240 /*c = m_gccInterface.FindClass(cname + "Base");
243 c
= m_gccInterface
.FindClass(cname
);
246 // sometimes the platform-specific class is named "wxGeneric" + cname
248 c
= m_gccInterface
.FindClass("wxGeneric" + cname
.Mid(2));
251 c
= m_gccInterface
.FindClass("wxGtk" + cname
.Mid(2));
257 // there is a class with the same (logic) name!
258 mcount
+= CompareClasses(&interfaces
[i
], c
);
262 LogMessage("%s: couldn't find the real interface for the '%s' class",
268 LogMessage("%d methods (%.1f%%) of the interface headers do not exist in the real headers",
269 mcount
, (float)(100.0 * mcount
/m_doxyInterface
.GetMethodCount()));
270 LogMessage("%d classes (%.1f%%) of the interface headers do not exist in the real headers",
271 ccount
, (float)(100.0 * ccount
/m_doxyInterface
.GetClassesCount()));
276 int IfaceCheckApp::CompareClasses(const wxClass
* iface
, const wxClass
* api
)
278 const wxMethod
*real
;
281 wxASSERT(iface
&& api
);
283 // shorten the name of the header so the log file is more readable
284 wxString header
= wxFileName(iface
->GetHeader()).GetFullName();
286 for (unsigned int i
=0; i
<iface
->GetMethodCount(); i
++)
288 const wxMethod
& m
= iface
->GetMethod(i
);
290 // only compare the methods which are available for the port
291 // for which the gcc XML was produced
292 if (m
.GetAvailability() != wxPORT_UNKNOWN
&&
293 (m
.GetAvailability() & m_gccInterface
.GetInterfacePort()) == 0) {
296 LogMessage("skipping method '%s' since it's not available for the %s port.",
297 m
.GetAsString(), m_gccInterface
.GetInterfacePortName());
299 continue; // skip this method
302 // search in the methods of the api classes provided
303 real
= api
->RecursiveUpwardFindMethod(m
, &m_gccInterface
);
306 if (!real
&& m
.ActsAsDefaultCtor())
308 // build an artifical default ctor for this class:
310 temp
.GetArgumentTypes().Clear();
312 real
= api
->RecursiveUpwardFindMethod(temp
, &m_gccInterface
);
317 wxMethodPtrArray overloads
=
318 api
->RecursiveUpwardFindMethodsNamed(m
.GetName(), &m_gccInterface
);
320 #define HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES 1
321 #if HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES
323 for (unsigned int k
=0; k
<overloads
.GetCount(); k
++)
324 if (overloads
[k
]->MatchesExceptForAttributes(m
))
326 // fix default values of results[k]:
327 wxMethod
tmp(*overloads
[k
]);
328 tmp
.SetArgumentTypes(m
.GetArgumentTypes());
330 // modify interface header
331 if (FixMethod(iface
->GetHeader(), &m
, &tmp
))
332 LogMessage("Adjusted attributes of '%s' method", m
.GetAsString());
340 #endif // HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES
342 if (overloads
.GetCount()==0)
344 LogMessage("%s: real '%s' class and their parents have no method '%s'",
345 header
, api
->GetName(), m
.GetAsString());
346 // we've found no overloads
350 // first, output a warning
351 wxString warning
= header
;
352 if (overloads
.GetCount()>1)
353 warning
+= wxString::Format(": in the real headers there are %d overloads of '%s' for "
354 "'%s' all with different signatures:\n",
355 overloads
.GetCount(), m
.GetName(), api
->GetName());
357 warning
+= wxString::Format(": in the real headers there is a method '%s' for '%s'"
358 " but has different signature:\n",
359 m
.GetName(), api
->GetName());
362 // get a list of the prototypes with _all_ possible attributes:
363 warning
+= "\tdoxy header: " + m
.GetAsString(true, true, true, true);
364 for (unsigned int j
=0; j
<overloads
.GetCount(); j
++)
365 warning
+= "\n\treal header: " + overloads
[j
]->GetAsString(true, true, true, true);
367 wxPrint(warning
+ "\n");
370 if (overloads
.GetCount()>1)
372 // TODO: decide which of these overloads is the most "similar" to m
373 // and eventually modify it
375 wxPrint("\tmanual fix is required\n");
379 wxASSERT(overloads
.GetCount() == 1);
381 if (m_modify
|| m
.IsCtor())
383 wxPrint("\tfixing it...\n");
386 FixMethod(iface
->GetHeader(), &m
, overloads
[0]);
393 #if HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES
402 bool IfaceCheckApp::StringContainsMethodName(const wxString
& str
, const wxMethod
* m
)
404 return str
.Contains(m
->GetName()) ||
405 (m
->IsOperator() && str
.Contains("operator"));
408 bool IfaceCheckApp::FixMethod(const wxString
& header
, const wxMethod
* iface
, const wxMethod
* api
)
410 wxASSERT(iface
&& api
);
413 if (!file
.Open(header
)) {
414 LogError("\tcan't open the '%s' header file.", header
);
418 // GetLocation() returns the line where the last part of the prototype is placed;
419 // i.e. the line containing the semicolon at the end of the declaration.
420 int end
= iface
->GetLocation()-1;
421 if (end
<= 0 || end
>= (int)file
.GetLineCount()) {
422 LogWarning("\tinvalid location info for method '%s': %d.",
423 iface
->GetAsString(), iface
->GetLocation());
427 if (!file
.GetLine(end
).Contains(";")) {
428 LogWarning("\tinvalid location info for method '%s': %d.",
429 iface
->GetAsString(), iface
->GetLocation());
433 // is this a one-line prototype declaration?
434 bool founddecl
= false;
436 if (StringContainsMethodName(file
.GetLine(end
), iface
))
438 // yes, this prototype is all on this line:
444 start
= end
; // will be decremented inside the while{} loop below
446 // find the start point of this prototype declaration; i.e. the line
447 // containing the function name, which is also the line following
448 // the marker '*/' for the closure of the doxygen comment
451 start
--; // go up one line
453 if (StringContainsMethodName(file
.GetLine(start
), iface
))
456 while (start
> 0 && !founddecl
&&
457 !file
.GetLine(start
).Contains(";") &&
458 !file
.GetLine(start
).Contains("*/"));
461 if (start
<= 0 || !founddecl
)
463 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",
464 iface
->GetAsString(), header
, end
+1 /* zero-based => 1-based */, start
);
468 // remove the old prototype
469 for (int i
=start
; i
<=end
; i
++)
470 file
.RemoveLine(start
); // remove (end-start)-nth times the start-th line
472 #define INDENTATION_STR wxString(" ")
474 // if possible, add also the @deprecated tag in the doxygen comment if it's missing
475 int deprecationOffset
= 0;
476 if (file
.GetLine(start
-1).Contains("*/") &&
477 (api
->IsDeprecated() && !iface
->IsDeprecated()))
479 file
.RemoveLine(start
-1);
480 file
.InsertLine(INDENTATION_STR
+ INDENTATION_STR
+
481 "@deprecated @todo provide deprecation description", start
-1);
482 file
.InsertLine(INDENTATION_STR
+ "*/", start
++);
484 // we have added a new line in the final balance
490 // discard gcc XML argument names and replace them with those parsed from doxygen XML;
491 // in this way we should avoid introducing doxygen warnings about cases where the argument
492 // 'xx' of the prototype is called 'yy' in the function's docs.
493 const wxArgumentTypeArray
& doxygenargs
= iface
->GetArgumentTypes();
494 const wxArgumentTypeArray
& realargs
= api
->GetArgumentTypes();
495 if (realargs
.GetCount() == doxygenargs
.GetCount())
497 for (unsigned int j
=0; j
<doxygenargs
.GetCount(); j
++)
498 if (doxygenargs
[j
]==realargs
[j
])
500 realargs
[j
].SetArgumentName(doxygenargs
[j
].GetArgumentName());
502 if (realargs
[j
].GetDefaultValue().IsNumber() &&
503 doxygenargs
[j
].GetDefaultValue().StartsWith("wx"))
504 realargs
[j
].SetDefaultValue(doxygenargs
[j
].GetDefaultValue());
507 tmp
.SetArgumentTypes(realargs
);
510 #define WRAP_COLUMN 80
512 wxArrayString toinsert
;
513 toinsert
.Add(INDENTATION_STR
+ tmp
.GetAsString() + ";");
515 int nStartColumn
= toinsert
[0].Find('(');
516 wxASSERT(nStartColumn
!= wxNOT_FOUND
);
518 // wrap lines too long at comma boundaries
519 for (unsigned int i
=0; i
<toinsert
.GetCount(); i
++)
521 size_t len
= toinsert
[i
].Len();
522 if (len
> WRAP_COLUMN
)
524 wxASSERT(i
== toinsert
.GetCount()-1);
527 wxString tmpleft
= toinsert
[i
].Left(WRAP_COLUMN
);
528 int comma
= tmpleft
.Find(',', true /* from end */);
529 if (comma
== wxNOT_FOUND
)
530 break; // break out of the for cycle...
532 toinsert
.Add(wxString(' ', nStartColumn
+1) +
533 toinsert
[i
].Right(len
-comma
-2)); // exclude the comma and the space after it
534 toinsert
[i
] = tmpleft
.Left(comma
+1); // include the comma
538 // insert the new lines
539 for (unsigned int i
=0; i
<toinsert
.GetCount(); i
++)
540 file
.InsertLine(toinsert
[i
], start
+i
);
542 // now save the modification
544 LogError("\tcan't save the '%s' header file.", header
);
548 // how many lines did we add/remove in total?
549 int nOffset
= toinsert
.GetCount() + deprecationOffset
- (end
-start
+1);
554 LogMessage("\tthe final row offset for following methods is %d lines.", nOffset
);
556 // update the other method's locations for those methods which belong to the modified header
557 // and are placed _below_ the modified method
558 wxClassPtrArray cToUpdate
= m_doxyInterface
.FindClassesDefinedIn(header
);
559 for (unsigned int i
=0; i
< cToUpdate
.GetCount(); i
++)
561 for (unsigned int j
=0; j
< cToUpdate
[i
]->GetMethodCount(); j
++)
563 wxMethod
& m
= cToUpdate
[i
]->GetMethod(j
);
564 if (m
.GetLocation() > iface
->GetLocation())
566 // update the location of this method
567 m
.SetLocation(m
.GetLocation()+nOffset
);
575 bool IfaceCheckApp::ParsePreprocessorOutput(const wxString
& filename
)
578 if (!tf
.Open(filename
)) {
579 LogError("can't open the '%s' preprocessor output file.", filename
);
584 for (unsigned int i
=0; i
< tf
.GetLineCount(); i
++)
586 const wxString
& line
= tf
.GetLine(i
);
587 wxString defnameval
= line
.Mid(8); // what follows the "#define " string
589 // the format of this line should be:
590 // #define DEFNAME DEFVALUE
591 if (!line
.StartsWith("#define ")) {
592 LogError("unexpected content in '%s' at line %d.", filename
, i
+1);
596 if (defnameval
.Contains(" "))
599 wxString defname
= defnameval
.BeforeFirst(' ');
600 if (defname
.Contains("("))
601 continue; // this is a macro, skip it!
604 wxString defval
= defnameval
.AfterFirst(' ').Strip(wxString::both
);
605 if (defval
.StartsWith("(") && defval
.EndsWith(")"))
606 defval
= defval
.Mid(1, defval
.Len()-2);
608 // store this pair in the doxygen interface, where it can be useful
609 m_doxyInterface
.AddPreprocessorValue(defname
, defval
);
614 // it looks like the format of this line is:
616 // we are not interested to symbols #defined to nothing,
617 // so we just ignore this line.
621 LogMessage("Parsed %d preprocessor #defines from '%s' which will be used later...",
627 void IfaceCheckApp::PrintStatistics(long secs
)
629 // these stats, for what regards the gcc XML, are all referred to the wxWidgets
632 LogMessage("wx real headers contains declaration of %d classes (%d methods)",
633 m_gccInterface
.GetClassesCount(), m_gccInterface
.GetMethodCount());
634 LogMessage("wx interface headers contains declaration of %d classes (%d methods)",
635 m_doxyInterface
.GetClassesCount(), m_doxyInterface
.GetMethodCount());
637 // build a list of the undocumented wx classes
640 const wxClassArray
& arr
= m_gccInterface
.GetClasses();
641 for (unsigned int i
=0; i
<arr
.GetCount(); i
++) {
642 if (m_doxyInterface
.FindClass(arr
[i
].GetName()) == NULL
) {
643 list
+= arr
[i
].GetName() + ", ";
651 LogMessage("the list of the %d undocumented wx classes is: %s", undoc
, list
);
652 LogMessage("total processing took %d seconds.", secs
);