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