utils/ifacecheck/src/ifacecheck.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        ifacecheck.cpp
   3 // Purpose:     Interface headers <=> real headers coherence checker
   4 // Author:      Francesco Montorsi
   5 // Created:     2008/03/17
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2008 Francesco Montorsi
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // For compilers that support precompilation, includes "wx/wx.h".
  12 #include "wx/wxprec.h"
  13
  14 #ifdef __BORLANDC__
  15     #pragma hdrstop
  16 #endif
  17
  18 // for all others, include the necessary headers
  19 #ifndef WX_PRECOMP
  20     #include "wx/app.h"
  21     #include "wx/crt.h"
  22 #endif
  23
  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"
  29
  30 // global verbosity flag
  31 bool g_verbose = false;
  32
  33
  34
  35 // ----------------------------------------------------------------------------
  36 // IfaceCheckApp
  37 // ----------------------------------------------------------------------------
  38
  39 #define API_DUMP_FILE               "dump.api.txt"
  40 #define INTERFACE_DUMP_FILE         "dump.interface.txt"
  41
  42 #define PROCESS_ONLY_OPTION         "p"
  43 #define USE_PREPROCESSOR_OPTION     "u"
  44
  45 #define MODIFY_SWITCH               "m"
  46 #define DUMP_SWITCH                 "d"
  47 #define HELP_SWITCH                 "h"
  48 #define VERBOSE_SWITCH              "v"
  49
  50 static const wxCmdLineEntryDesc g_cmdLineDesc[] =
  51 {
  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",
  65         "be 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 },
  70     wxCMD_LINE_DESC_END
  71 };
  72
  73 class IfaceCheckLog : public wxLog
  74 {
  75 public:
  76     IfaceCheckLog() {}
  77
  78     virtual void DoLogText(const wxString& msg)
  79     {
  80         // send all messages to stdout (normal behaviour is to sent them to stderr)
  81         wxPuts(msg);
  82         fflush(stdout);
  83     }
  84 };
  85
  86 class IfaceCheckApp : public wxAppConsole
  87 {
  88 public:
  89     // don't use builtin cmd line parsing:
  90     virtual bool OnInit() { m_modify=false; return true; }
  91     virtual int OnRun();
  92
  93     bool ParsePreprocessorOutput(const wxString& filename);
  94
  95     bool Compare();
  96     int CompareClasses(const wxClass* iface, const wxClass* api);
  97     bool FixMethod(const wxString& header, const wxMethod* iface, const wxMethod* api);
  98     bool StringContainsMethodName(const wxString& str, const wxMethod* m);
  99
 100     void PrintStatistics(long secs);
 101
 102     bool IsToProcess(const wxString& headername) const
 103     {
 104         if (m_strToMatch.IsEmpty())
 105             return true;
 106         return wxMatchWild(m_strToMatch, headername, false);
 107     }
 108
 109 protected:
 110     wxXmlGccInterface m_gccInterface;                  // "real" headers API
 111     wxXmlDoxygenInterface m_doxyInterface;             // doxygen-commented headers API
 112
 113     // was the MODIFY_SWITCH passed?
 114     bool m_modify;
 115
 116     // if non-empty, then PROCESS_ONLY_OPTION was passed and this is the
 117     // wildcard expression to match
 118     wxString m_strToMatch;
 119 };
 120
 121 IMPLEMENT_APP_CONSOLE(IfaceCheckApp)
 122
 123 int IfaceCheckApp::OnRun()
 124 {
 125     long startTime = wxGetLocalTime();      // for timing purpose
 126
 127     wxCmdLineParser parser(g_cmdLineDesc, argc, argv);
 128     parser.SetLogo(
 129         wxString::Format("wxWidgets Interface checker utility (built %s against %s)",
 130                          __DATE__, wxVERSION_STRING));
 131
 132     // make the output more readable:
 133     wxLog::SetActiveTarget(new IfaceCheckLog);
 134     wxLog::DisableTimestamp();
 135
 136     // parse the command line...
 137     bool ok = true;
 138     wxString preprocFile;
 139     switch (parser.Parse())
 140     {
 141         case 0:
 142             if (parser.Found(VERBOSE_SWITCH))
 143                 g_verbose = true;
 144
 145             // IMPORTANT: parsing #define values must be done _before_ actually
 146             //            parsing the GCC/doxygen XML files
 147             if (parser.Found(USE_PREPROCESSOR_OPTION, &preprocFile))
 148             {
 149                 if (!ParsePreprocessorOutput(preprocFile))
 150                     return 1;
 151             }
 152
 153             // in any case set basic std preprocessor #defines:
 154             m_doxyInterface.AddPreprocessorValue("NULL", "0");
 155
 156             // parse the two XML files which contain the real and the doxygen interfaces
 157             // for wxWidgets API:
 158             if (!m_gccInterface.Parse(parser.GetParam(0)) ||
 159                 !m_doxyInterface.Parse(parser.GetParam(1)))
 160                 return 1;
 161
 162             if (parser.Found(DUMP_SWITCH))
 163             {
 164                 wxLogMessage("Dumping real API to '%s'...", API_DUMP_FILE);
 165                 m_gccInterface.Dump(API_DUMP_FILE);
 166
 167                 wxLogMessage("Dumping interface API to '%s'...", INTERFACE_DUMP_FILE);
 168                 m_doxyInterface.Dump(INTERFACE_DUMP_FILE);
 169             }
 170             else
 171             {
 172                 if (parser.Found(MODIFY_SWITCH))
 173                     m_modify = true;
 174
 175                 if (parser.Found(PROCESS_ONLY_OPTION, &m_strToMatch))
 176                 {
 177                     size_t len = m_strToMatch.Len();
 178                     if (m_strToMatch.StartsWith("\"") &&
 179                         m_strToMatch.EndsWith("\"") &&
 180                         len > 2)
 181                         m_strToMatch = m_strToMatch.Mid(1, len-2);
 182                 }
 183
 184
 185                 ok = Compare();
 186             }
 187
 188             PrintStatistics(wxGetLocalTime() - startTime);
 189             return ok ? 0 : 1;
 190
 191         default:
 192             wxPrintf("\nThis utility checks that the interface XML files created by Doxygen are in\n");
 193             wxPrintf("synch with the real headers (whose contents are extracted by the gcc XML file).\n\n");
 194             wxPrintf("The 'gccXML' parameter should be the wxapi.xml file created by the 'rungccxml.sh'\n");
 195             wxPrintf("script which resides in 'utils/ifacecheck'.\n");
 196             wxPrintf("The 'doxygenXML' parameter should be the index.xml file created by Doxygen\n");
 197             wxPrintf("for the wxWidgets 'interface' folder.\n\n");
 198             wxPrintf("Since the gcc XML file does not contain info about #defines, if you use\n");
 199             wxPrintf("the -%s option, you'll get a smaller number of false warnings.\n",
 200                      USE_PREPROCESSOR_OPTION);
 201
 202             // HELP_SWITCH was passed or a syntax error occurred
 203             return 0;
 204     }
 205 }
 206
 207 bool IfaceCheckApp::Compare()
 208 {
 209     const wxClassArray& interfaces = m_doxyInterface.GetClasses();
 210     const wxClass* c;
 211     int mcount = 0, ccount = 0;
 212
 213     wxLogMessage("Comparing the interface API to the real API (%d classes to compare)...",
 214                  interfaces.GetCount());
 215
 216     if (!m_strToMatch.IsEmpty())
 217         wxLogMessage("Processing only header files matching '%s' expression.", m_strToMatch);
 218
 219     for (unsigned int i=0; i<interfaces.GetCount(); i++)
 220     {
 221         // only compare the methods which are available for the port
 222         // for which the gcc XML was produced
 223         if (interfaces[i].GetAvailability() != wxPORT_UNKNOWN &&
 224             (interfaces[i].GetAvailability() & m_gccInterface.GetInterfacePort()) == 0) {
 225
 226             if (g_verbose)
 227                 wxLogMessage("skipping class '%s' since it's not available for the %s port.",
 228                            interfaces[i].GetName(), m_gccInterface.GetInterfacePortName());
 229
 230             continue;       // skip this method
 231         }
 232
 233         // shorten the name of the header so the log file is more readable
 234         // and also for calling IsToProcess() against it
 235         wxString header = wxFileName(interfaces[i].GetHeader()).GetFullName();
 236
 237         if (!IsToProcess(header))
 238             continue;       // skip this one
 239
 240         wxString cname = interfaces[i].GetName();
 241
 242         // search in the real headers for i-th interface class; we search for
 243         // both class cname and cnameBase since in wxWidgets world tipically
 244         // class cname is platform-specific while the real public interface of
 245         // that class is part of the cnameBase class.
 246         /*c = m_gccInterface.FindClass(cname + "Base");
 247         if (c) api.Add(c);*/
 248
 249         c = m_gccInterface.FindClass(cname);
 250         if (!c)
 251         {
 252             // sometimes the platform-specific class is named "wxGeneric" + cname
 253             // or similar:
 254             c = m_gccInterface.FindClass("wxGeneric" + cname.Mid(2));
 255             if (!c)
 256             {
 257                 c = m_gccInterface.FindClass("wxGtk" + cname.Mid(2));
 258             }
 259         }
 260
 261         if (c) {
 262
 263             // there is a class with the same (logic) name!
 264             mcount += CompareClasses(&interfaces[i], c);
 265
 266         } else {
 267
 268             wxLogMessage("%s: couldn't find the real interface for the '%s' class",
 269                        header, cname);
 270             ccount++;
 271         }
 272     }
 273
 274     wxLogMessage("%d on a total of %d methods (%.1f%%) of the interface headers do not exist in the real headers",
 275                mcount, m_doxyInterface.GetMethodCount(), (float)(100.0 * mcount/m_doxyInterface.GetMethodCount()));
 276     wxLogMessage("%d on a total of %d classes (%.1f%%) of the interface headers do not exist in the real headers",
 277                ccount, m_doxyInterface.GetClassesCount(), (float)(100.0 * ccount/m_doxyInterface.GetClassesCount()));
 278
 279     return true;
 280 }
 281
 282 int IfaceCheckApp::CompareClasses(const wxClass* iface, const wxClass* api)
 283 {
 284     const wxMethod *real;
 285     int count = 0;
 286
 287     wxASSERT(iface && api);
 288
 289     // shorten the name of the header so the log file is more readable
 290     wxString header = wxFileName(iface->GetHeader()).GetFullName();
 291
 292     for (unsigned int i=0; i<iface->GetMethodCount(); i++)
 293     {
 294         const wxMethod& m = iface->GetMethod(i);
 295
 296         // only compare the methods which are available for the port
 297         // for which the gcc XML was produced
 298         if (m.GetAvailability() != wxPORT_UNKNOWN &&
 299             (m.GetAvailability() & m_gccInterface.GetInterfacePort()) == 0) {
 300
 301             if (g_verbose)
 302                 wxLogMessage("skipping method '%s' since it's not available for the %s port.",
 303                            m.GetAsString(), m_gccInterface.GetInterfacePortName());
 304
 305             continue;       // skip this method
 306         }
 307
 308         // search in the methods of the api classes provided
 309         real = api->RecursiveUpwardFindMethod(m, &m_gccInterface);
 310
 311         // avoid some false positives:
 312         if (!real && m.ActsAsDefaultCtor())
 313         {
 314             // build an artificial default ctor for this class:
 315             wxMethod temp(m);
 316             temp.GetArgumentTypes().Clear();
 317
 318             // repeat search:
 319             real = api->RecursiveUpwardFindMethod(temp, &m_gccInterface);
 320         }
 321
 322         // no matches?
 323         if (!real)
 324         {
 325             bool proceed = true;
 326             wxMethodPtrArray overloads =
 327                 api->RecursiveUpwardFindMethodsNamed(m.GetName(), &m_gccInterface);
 328
 329             // avoid false positives:
 330             for (unsigned int k=0; k<overloads.GetCount(); k++)
 331                 if (overloads[k]->MatchesExceptForAttributes(m) &&
 332                     m.IsDeprecated() && !overloads[k]->IsDeprecated())
 333                 {
 334                     // maybe the iface method is marked as deprecated but the
 335                     // real method is not?
 336                     wxMethod tmp(*overloads[k]);
 337                     tmp.SetDeprecated(true);
 338
 339                     if (tmp == m)
 340                     {
 341                         // in this case, we can disregard this warning... the real
 342                         // method probably is included in WXWIN_COMPAT sections!
 343                         proceed = false;    // skip this method
 344                     }
 345                 }
 346
 347 #define HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES        0
 348 #if HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES
 349             for (unsigned int k=0; k<overloads.GetCount(); k++)
 350                 if (overloads[k]->MatchesExceptForAttributes(m))
 351                 {
 352                     // fix default values of results[k]:
 353                     wxMethod tmp(*overloads[k]);
 354                     tmp.SetArgumentTypes(m.GetArgumentTypes());
 355
 356                     // modify interface header
 357                     if (FixMethod(iface->GetHeader(), &m, &tmp))
 358                         wxLogMessage("Adjusted attributes of '%s' method", m.GetAsString());
 359
 360                     proceed = false;
 361                     break;
 362                 }
 363 #endif // HACK_TO_AUTO_CORRECT_ONLY_METHOD_ATTRIBUTES
 364
 365             if (proceed)
 366             {
 367                 if (overloads.GetCount()==0)
 368                 {
 369                     wxLogMessage("%s: real '%s' class and their parents have no method '%s'",
 370                                 header, api->GetName(), m.GetAsString());
 371                     // we've found no overloads
 372                 }
 373                 else
 374                 {
 375                     // first, output a warning
 376                     wxString warning = header;
 377                     if (overloads.GetCount()>1)
 378                         warning += wxString::Format(": in the real headers there are %d overloads of '%s' for "
 379                                                     "'%s' all with different signatures:\n",
 380                                                     overloads.GetCount(), m.GetName(), api->GetName());
 381                     else {
 382                         warning += wxString::Format(": in the real headers there is a method '%s' for '%s'"
 383                                                     " but has different signature:\n",
 384                                                     m.GetName(), api->GetName());
 385                     }
 386
 387                     // get a list of the prototypes with _all_ possible attributes:
 388                     warning += "\tdoxy header: " + m.GetAsString(true, true, true, true);
 389                     for (unsigned int j=0; j<overloads.GetCount(); j++)
 390                         warning += "\n\treal header: " + overloads[j]->GetAsString(true, true, true, true);
 391
 392                     wxLogWarning("%s", warning);
 393                     count++;
 394
 395                     if (overloads.GetCount()>1)
 396                     {
 397                         // TODO: decide which of these overloads is the most "similar" to m
 398                         //       and eventually modify it
 399                         if (m_modify)
 400                             wxLogWarning("\tmanual fix is required");
 401                     }
 402                     else
 403                     {
 404                         wxASSERT(overloads.GetCount() == 1);
 405
 406                         if (m_modify || m.IsCtor())
 407                         {
 408                             wxLogWarning("\tfixing it...");
 409
 410                             // try to modify it!
 411                             FixMethod(iface->GetHeader(), &m, overloads[0]);
 412                         }
 413                     }
 414                 }
 415
 416                 count++;
 417             }       // if (proceed)
 418         }
 419     }
 420
 421     return count;
 422 }
 423
 424 bool IfaceCheckApp::StringContainsMethodName(const wxString& str, const wxMethod* m)
 425 {
 426     return str.Contains(m->GetName()) ||
 427            (m->IsOperator() && str.Contains("operator"));
 428 }
 429
 430 bool IfaceCheckApp::FixMethod(const wxString& header, const wxMethod* iface, const wxMethod* api)
 431 {
 432     unsigned int i,j;
 433     wxASSERT(iface && api);
 434
 435     wxTextFile file;
 436     if (!file.Open(header)) {
 437         wxLogError("\tcan't open the '%s' header file.", header);
 438         return false;
 439     }
 440
 441     // GetLocation() returns the line where the last part of the prototype is placed;
 442     // i.e. the line containing the semicolon at the end of the declaration.
 443     int end = iface->GetLocation()-1;
 444     if (end <= 0 || end >= (int)file.GetLineCount()) {
 445         wxLogWarning("\tinvalid location info for method '%s': %d.",
 446                    iface->GetAsString(), iface->GetLocation());
 447         return false;
 448     }
 449
 450     if (!file.GetLine(end).Contains(";")) {
 451         wxLogWarning("\tinvalid location info for method '%s': %d.",
 452                    iface->GetAsString(), iface->GetLocation());
 453         return false;
 454     }
 455
 456     // is this a one-line prototype declaration?
 457     bool founddecl = false;
 458     int start;
 459     if (StringContainsMethodName(file.GetLine(end), iface))
 460     {
 461         // yes, this prototype is all on this line:
 462         start = end;
 463         founddecl = true;
 464     }
 465     else
 466     {
 467         start = end;    // will be decremented inside the while{} loop below
 468
 469         // find the start point of this prototype declaration; i.e. the line
 470         // containing the function name, which is also the line following
 471         // the marker '*/' for the closure of the doxygen comment
 472         do
 473         {
 474             start--;        // go up one line
 475
 476             if (StringContainsMethodName(file.GetLine(start), iface))
 477                 founddecl = true;
 478         }
 479         while (start > 0 && !founddecl &&
 480                !file.GetLine(start).Contains(";") &&
 481                !file.GetLine(start).Contains("*/"));
 482     }
 483
 484     if (start <= 0 || !founddecl)
 485     {
 486         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",
 487                  iface->GetAsString(), header, end+1 /* zero-based => 1-based */, start);
 488         return false;
 489     }
 490
 491     // remove the old prototype
 492     for (int k=start; k<=end; k++)
 493         file.RemoveLine(start);     // remove (end-start)-nth times the start-th line
 494
 495 #define INDENTATION_STR  wxString("    ")
 496
 497     // if possible, add also the @deprecated tag in the doxygen comment if it's missing
 498     int deprecationOffset = 0;
 499     if (file.GetLine(start-1).Contains("*/") &&
 500         (api->IsDeprecated() && !iface->IsDeprecated()))
 501     {
 502         file.RemoveLine(start-1);
 503         file.InsertLine(INDENTATION_STR + INDENTATION_STR +
 504                         "@deprecated @todo provide deprecation description", start-1);
 505         file.InsertLine(INDENTATION_STR + "*/", start++);
 506
 507         // we have added a new line in the final balance
 508         deprecationOffset=1;
 509     }
 510
 511     wxMethod tmp(*api);
 512
 513     // discard gcc XML argument names and replace them with those parsed from doxygen XML;
 514     // in this way we should avoid introducing doxygen warnings about cases where the argument
 515     // 'xx' of the prototype is called 'yy' in the function's docs.
 516     const wxArgumentTypeArray& doxygenargs = iface->GetArgumentTypes();
 517     const wxArgumentTypeArray& realargs = api->GetArgumentTypes();
 518     if (realargs.GetCount() == doxygenargs.GetCount())
 519     {
 520         for (j=0; j<doxygenargs.GetCount(); j++)
 521             if (doxygenargs[j]==realargs[j])
 522             {
 523                 realargs[j].SetArgumentName(doxygenargs[j].GetArgumentName());
 524
 525                 if (realargs[j].GetDefaultValue().IsNumber() &&
 526                     doxygenargs[j].GetDefaultValue().StartsWith("wx"))
 527                     realargs[j].SetDefaultValue(doxygenargs[j].GetDefaultValue());
 528             }
 529
 530         tmp.SetArgumentTypes(realargs);
 531     }
 532
 533 #define WRAP_COLUMN     80
 534
 535     wxArrayString toinsert;
 536     toinsert.Add(INDENTATION_STR + tmp.GetAsString() + ";");
 537
 538     int nStartColumn = toinsert[0].Find('(');
 539     wxASSERT(nStartColumn != wxNOT_FOUND);
 540
 541     // wrap lines too long at comma boundaries
 542     for (i=0; i<toinsert.GetCount(); i++)
 543     {
 544         size_t len = toinsert[i].Len();
 545         if (len > WRAP_COLUMN)
 546         {
 547             wxASSERT(i == toinsert.GetCount()-1);
 548
 549             // break this line
 550             wxString tmpleft = toinsert[i].Left(WRAP_COLUMN);
 551             int comma = tmpleft.Find(',', true /* from end */);
 552             if (comma == wxNOT_FOUND)
 553                 break;     // break out of the for cycle...
 554
 555             toinsert.Add(wxString(' ', nStartColumn+1) +
 556                          toinsert[i].Right(len-comma-2));   // exclude the comma and the space after it
 557             toinsert[i] = tmpleft.Left(comma+1);            // include the comma
 558         }
 559     }
 560
 561     // insert the new lines
 562     for (i=0; i<toinsert.GetCount(); i++)
 563         file.InsertLine(toinsert[i], start+i);
 564
 565     // now save the modification
 566     if (!file.Write()) {
 567         wxLogError("\tcan't save the '%s' header file.", header);
 568         return false;
 569     }
 570
 571     // how many lines did we add/remove in total?
 572     int nOffset = toinsert.GetCount() + deprecationOffset - (end-start+1);
 573     if (nOffset == 0)
 574         return false;
 575
 576     if (g_verbose)
 577         wxLogMessage("\tthe final row offset for following methods is %d lines.", nOffset);
 578
 579     // update the other method's locations for those methods which belong to the modified header
 580     // and are placed _below_ the modified method
 581     wxClassPtrArray cToUpdate = m_doxyInterface.FindClassesDefinedIn(header);
 582     for (i=0; i < cToUpdate.GetCount(); i++)
 583     {
 584         for (j=0; j < cToUpdate[i]->GetMethodCount(); j++)
 585         {
 586             wxMethod& m = cToUpdate[i]->GetMethod(j);
 587             if (m.GetLocation() > iface->GetLocation())
 588             {
 589                 // update the location of this method
 590                 m.SetLocation(m.GetLocation()+nOffset);
 591             }
 592         }
 593     }
 594
 595     return true;
 596 }
 597
 598 bool IfaceCheckApp::ParsePreprocessorOutput(const wxString& filename)
 599 {
 600     wxTextFile tf;
 601     if (!tf.Open(filename)) {
 602         wxLogError("can't open the '%s' preprocessor output file.", filename);
 603         return false;
 604     }
 605
 606     size_t useful = 0;
 607     for (unsigned int i=0; i < tf.GetLineCount(); i++)
 608     {
 609         const wxString& line = tf.GetLine(i);
 610         wxString defnameval = line.Mid(8);     // what follows the "#define " string
 611
 612         // the format of this line should be:
 613         //    #define DEFNAME DEFVALUE
 614         if (!line.StartsWith("#define ")) {
 615             wxLogError("unexpected content in '%s' at line %d.", filename, i+1);
 616             return false;
 617         }
 618
 619         if (defnameval.Contains(" "))
 620         {
 621             // get DEFNAME
 622             wxString defname = defnameval.BeforeFirst(' ');
 623             if (defname.Contains("("))
 624                 continue;       // this is a macro, skip it!
 625
 626             // get DEFVAL
 627             wxString defval = defnameval.AfterFirst(' ').Strip(wxString::both);
 628             if (defval.StartsWith("(") && defval.EndsWith(")"))
 629                 defval = defval.Mid(1, defval.Len()-2);
 630
 631             // store this pair in the doxygen interface, where it can be useful
 632             m_doxyInterface.AddPreprocessorValue(defname, defval);
 633             useful++;
 634         }
 635         else
 636         {
 637             // it looks like the format of this line is:
 638             //    #define DEFNAME
 639             // we are not interested to symbols #defined to nothing,
 640             // so we just ignore this line.
 641         }
 642     }
 643
 644     wxLogMessage("Parsed %d preprocessor #defines from '%s' which will be used later...",
 645                useful, filename);
 646
 647     return true;
 648 }
 649
 650 void IfaceCheckApp::PrintStatistics(long secs)
 651 {
 652     // these stats, for what regards the gcc XML, are all referred to the wxWidgets
 653     // classes only!
 654
 655     wxLogMessage("wx real headers contains declaration of %d classes (%d methods)",
 656                m_gccInterface.GetClassesCount(), m_gccInterface.GetMethodCount());
 657     wxLogMessage("wx interface headers contains declaration of %d classes (%d methods)",
 658                m_doxyInterface.GetClassesCount(), m_doxyInterface.GetMethodCount());
 659
 660     // build a list of the undocumented wx classes
 661     wxString list;
 662     int undoc = 0;
 663     const wxClassArray& arr = m_gccInterface.GetClasses();
 664     for (unsigned int i=0; i<arr.GetCount(); i++) {
 665         if (m_doxyInterface.FindClass(arr[i].GetName()) == NULL) {
 666             list += arr[i].GetName() + ", ";
 667             undoc++;
 668         }
 669     }
 670
 671     list.RemoveLast();
 672     list.RemoveLast();
 673
 674     wxLogMessage("the list of the %d undocumented wx classes is: %s", undoc, list);
 675     wxLogMessage("total processing took %d seconds.", secs);
 676 }
 677