void IfaceCheckApp::PrintStatistics(long secs) { // these stats, for what regards the gcc XML, are all referred to the wxWidgets // classes only! wxLogMessage("wx real headers contains declaration of %d classes (%d methods)", m_gccInterface.GetClassesCount(), m_gccInterface.GetMethodCount()); wxLogMessage("wx interface headers contains declaration of %d classes (%d methods)", m_doxyInterface.GetClassesCount(), m_doxyInterface.GetMethodCount()); // build a list of the undocumented wx classes wxString list; int undoc = 0; const wxClassArray& arr = m_gccInterface.GetClasses(); for (unsigned int i=0; i<arr.GetCount(); i++) { if (m_doxyInterface.FindClass(arr[i].GetName()) == NULL) { list += arr[i].GetName() + ", "; undoc++; } } list.RemoveLast(); list.RemoveLast(); wxLogMessage("the list of the %d undocumented wx classes is: %s", undoc, list); wxLogMessage("total processing took %d seconds.", secs); }
bool IfaceCheckApp::ParsePreprocessorOutput(const wxString& filename) { wxTextFile tf; if (!tf.Open(filename)) { wxLogError("can't open the '%s' preprocessor output file.", filename); return false; } size_t useful = 0; #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (unsigned int i=0; i < tf.GetLineCount(); i++) { const wxString& line = tf.GetLine(i); wxString defnameval = line.Mid(8); // what follows the "#define " string // the format of this line should be: // #define DEFNAME DEFVALUE if (!line.StartsWith("#define ")) { wxLogError("unexpected content in '%s' at line %d.", filename, i+1); return false; } if (defnameval.Contains(" ")) { // get DEFNAME wxString defname = defnameval.BeforeFirst(' '); if (defname.Contains("(")) continue; // this is a macro, skip it! // get DEFVAL wxString defval = defnameval.AfterFirst(' ').Strip(wxString::both); if (defval.StartsWith("(") && defval.EndsWith(")")) defval = defval.Mid(1, defval.Len()-2); // store this pair in the doxygen interface, where it can be useful m_doxyInterface.AddPreprocessorValue(defname, defval); useful++; } else { // it looks like the format of this line is: // #define DEFNAME // we are not interested to symbols #defined to nothing, // so we just ignore this line. } } wxLogMessage("Parsed %d preprocessor #defines from '%s' which will be used later...", useful, filename); return true; }
bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, const wxMethod* api) { unsigned int i,j; wxASSERT(iface && api); wxTextFile file; if (!file.Open(header)) { wxLogError("\tcan't open the '%s' header file.", header); return false; } // 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()) { wxLogWarning("\tinvalid location info for method '%s': %d.", iface->GetAsString(), iface->GetLocation()); return false; } if (!file.GetLine(end).Contains(";")) { wxLogWarning("\tinvalid location info for method '%s': %d.", iface->GetAsString(), iface->GetLocation()); return false; } // is this a one-line prototype declaration? bool founddecl = false; int start; if (StringContainsMethodName(file.GetLine(end), iface)) { // yes, this prototype is all on this line: start = end; founddecl = true; } else { start = end; // will be decremented inside the while{} loop below // 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 #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ do { start--; // go up one line if (StringContainsMethodName(file.GetLine(start), iface)) founddecl = true; } #if defined(__INTEL_COMPILER) && 0 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ while (start > 0 && !founddecl && !file.GetLine(start).Contains(";") && !file.GetLine(start).Contains("*/")); } if (start <= 0 || !founddecl) { wxLogError("\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; } // remove the old prototype #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (int k=start; k<=end; k++) file.RemoveLine(start); // remove (end-start)-nth times the start-th line #define INDENTATION_STR wxString(" ") // if possible, add also the @deprecated tag in the doxygen comment if it's missing int deprecationOffset = 0; if (file.GetLine(start-1).Contains("*/") && (api->IsDeprecated() && !iface->IsDeprecated())) { file.RemoveLine(start-1); file.InsertLine(INDENTATION_STR + INDENTATION_STR + "@deprecated @todo provide deprecation description", start-1); file.InsertLine(INDENTATION_STR + "*/", start++); // we have added a new line in the final balance deprecationOffset=1; } wxMethod tmp(*api); // 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()) { #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (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); } #define WRAP_COLUMN 80 wxArrayString toinsert; toinsert.Add(INDENTATION_STR + tmp.GetAsString() + ";"); int nStartColumn = toinsert[0].Find('('); wxASSERT(nStartColumn != wxNOT_FOUND); // wrap lines too long at comma boundaries #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (i=0; i<toinsert.GetCount(); i++) { size_t len = toinsert[i].Len(); if (len > WRAP_COLUMN) { wxASSERT(i == toinsert.GetCount()-1); // break this line wxString tmpleft = toinsert[i].Left(WRAP_COLUMN); int comma = tmpleft.Find(',', true /* from end */); if (comma == wxNOT_FOUND) break; // break out of the for cycle... toinsert.Add(wxString(' ', nStartColumn+1) + toinsert[i].Right(len-comma-2)); // exclude the comma and the space after it toinsert[i] = tmpleft.Left(comma+1); // include the comma } } // insert the new lines #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (i=0; i<toinsert.GetCount(); i++) file.InsertLine(toinsert[i], start+i); // now save the modification if (!file.Write()) { wxLogError("\tcan't save the '%s' header file.", header); return false; } // how many lines did we add/remove in total? int nOffset = toinsert.GetCount() + deprecationOffset - (end-start+1); if (nOffset == 0) return false; if (g_verbose) { wxLogMessage("\tthe final row offset for following methods is %d lines.", nOffset); } // update the other method's locations for those methods which belong to the modified header // and are placed _below_ the modified method wxClassPtrArray cToUpdate = m_doxyInterface.FindClassesDefinedIn(header); #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (i=0; i < cToUpdate.GetCount(); i++) { #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (j=0; j < cToUpdate[i]->GetMethodCount(); j++) { wxMethod& m = cToUpdate[i]->GetMethod(j); if (m.GetLocation() > iface->GetLocation()) { // update the location of this method m.SetLocation(m.GetLocation()+nOffset); } } } return true; }
bool IfaceCheckApp::Compare() { const wxClassArray& interfaces = m_doxyInterface.GetClasses(); const wxClass* c; int mcount = 0, ccount = 0; wxLogMessage("Comparing the interface API to the real API (%d classes to compare)...", interfaces.GetCount()); if (!m_strToMatch.IsEmpty()) { wxLogMessage("Processing only header files matching '%s' expression.", m_strToMatch); } #if defined(__INTEL_COMPILER) && 1 /* VDM auto patch */ # pragma ivdep # pragma swp # pragma unroll # pragma prefetch # if 0 # pragma simd noassert # endif #endif /* VDM auto patch */ for (unsigned int i=0; i<interfaces.GetCount(); i++) { // only compare the methods which are available for the port // for which the gcc XML was produced if (interfaces[i].GetAvailability() != wxPORT_UNKNOWN && (interfaces[i].GetAvailability() & m_gccInterface.GetInterfacePort()) == 0) { if (g_verbose) { wxLogMessage("skipping class '%s' since it's not available for the %s port.", interfaces[i].GetName(), m_gccInterface.GetInterfacePortName()); } continue; // skip this method } // shorten the name of the header so the log file is more readable // and also for calling IsToProcess() against it wxString header = wxFileName(interfaces[i].GetHeader()).GetFullName(); if (!IsToProcess(header)) continue; // skip this one wxString cname = interfaces[i].GetName(); // search in the real headers for i-th interface class; we search for // both class cname and cnameBase since in wxWidgets world tipically // class cname is platform-specific while the real public interface of // that class is part of the cnameBase class. /*c = m_gccInterface.FindClass(cname + "Base"); if (c) api.Add(c);*/ c = m_gccInterface.FindClass(cname); if (!c) { // sometimes the platform-specific class is named "wxGeneric" + cname // or similar: c = m_gccInterface.FindClass("wxGeneric" + cname.Mid(2)); if (!c) { c = m_gccInterface.FindClass("wxGtk" + cname.Mid(2)); } } if (c) { // there is a class with the same (logic) name! mcount += CompareClasses(&interfaces[i], c); } else { wxLogMessage("%s: couldn't find the real interface for the '%s' class", header, cname); ccount++; } } wxLogMessage("%d on a total of %d methods (%.1f%%) of the interface headers do not exist in the real headers", mcount, m_doxyInterface.GetMethodCount(), (float)(100.0 * mcount/m_doxyInterface.GetMethodCount())); wxLogMessage("%d on a total of %d classes (%.1f%%) of the interface headers do not exist in the real headers", ccount, m_doxyInterface.GetClassesCount(), (float)(100.0 * ccount/m_doxyInterface.GetClassesCount())); return true; }
int IfaceCheckApp::OnRun() { long startTime = wxGetLocalTime(); // for timing purpose wxCmdLineParser parser(g_cmdLineDesc, argc, argv); parser.SetLogo( wxString::Format("wxWidgets Interface checker utility (built %s against %s)", __DATE__, wxVERSION_STRING)); // make the output more readable: wxLog::SetActiveTarget(new IfaceCheckLog); wxLog::DisableTimestamp(); // parse the command line... bool ok = true; wxString preprocFile; switch (parser.Parse()) { case 0: if (parser.Found(VERBOSE_SWITCH)) g_verbose = true; // IMPORTANT: parsing #define values must be done _before_ actually // parsing the GCC/doxygen XML files if (parser.Found(USE_PREPROCESSOR_OPTION, &preprocFile)) { if (!ParsePreprocessorOutput(preprocFile)) return 1; } // in any case set basic std preprocessor #defines: m_doxyInterface.AddPreprocessorValue("NULL", "0"); // parse the two XML files which contain the real and the doxygen interfaces // for wxWidgets API: if (!m_gccInterface.Parse(parser.GetParam(0)) || !m_doxyInterface.Parse(parser.GetParam(1))) return 1; if (parser.Found(DUMP_SWITCH)) { wxLogMessage("Dumping real API to '%s'...", API_DUMP_FILE); m_gccInterface.Dump(API_DUMP_FILE); wxLogMessage("Dumping interface API to '%s'...", INTERFACE_DUMP_FILE); m_doxyInterface.Dump(INTERFACE_DUMP_FILE); } else { if (parser.Found(MODIFY_SWITCH)) m_modify = true; if (parser.Found(PROCESS_ONLY_OPTION, &m_strToMatch)) { size_t len = m_strToMatch.Len(); if (m_strToMatch.StartsWith("\"") && m_strToMatch.EndsWith("\"") && len > 2) m_strToMatch = m_strToMatch.Mid(1, len-2); } ok = Compare(); } PrintStatistics(wxGetLocalTime() - startTime); return ok ? 0 : 1; default: wxPrintf("\nThis utility checks that the interface XML files created by Doxygen are in\n"); wxPrintf("synch with the real headers (whose contents are extracted by the gcc XML file).\n\n"); wxPrintf("The 'gccXML' parameter should be the wxapi.xml file created by the 'rungccxml.sh'\n"); wxPrintf("script which resides in 'utils/ifacecheck'.\n"); wxPrintf("The 'doxygenXML' parameter should be the index.xml file created by Doxygen\n"); wxPrintf("for the wxWidgets 'interface' folder.\n\n"); wxPrintf("Since the gcc XML file does not contain info about #defines, if you use\n"); wxPrintf("the -%s option, you'll get a smaller number of false warnings.\n", USE_PREPROCESSOR_OPTION); // HELP_SWITCH was passed or a syntax error occurred return 0; } }