X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/31dc7e4995ae83221268b24488ac724ab291b7fb..6ce8b8484654b5ab073951373c93d9bdd8221881:/utils/HelpGen/src/HelpGen.cpp diff --git a/utils/HelpGen/src/HelpGen.cpp b/utils/HelpGen/src/HelpGen.cpp index 28e9d4460c..47b9ae8726 100644 --- a/utils/HelpGen/src/HelpGen.cpp +++ b/utils/HelpGen/src/HelpGen.cpp @@ -6,7 +6,7 @@ // Created: 06/01/99 // RCS-ID: $Id$ // Copyright: (c) 1999 VZ -// Licence: GPL +// Licence: wxWindows Licence ///////////////////////////////////////////////////////////////////////////// /* @@ -48,22 +48,27 @@ // headers // ----------------------------------------------------------------------------- -// wxWindows +// wxWidgets #include "wx/wxprec.h" -#if wxUSE_GUI - #error "This is a console program and can be only compiled using wxBase" +#ifdef __BORLANDC__ + #pragma hdrstop +#endif + +#if wxUSE_UNICODE + #error "HelpGen doesn't build in Unicode mode" #endif #ifndef WX_PRECOMP #include "wx/string.h" #include "wx/log.h" #include "wx/dynarray.h" - #include "wx/wx.h" + #include "wx/app.h" #endif // WX_PRECOMP #include "wx/file.h" #include "wx/regex.h" +#include "wx/hash.h" // C++ parsing classes #include "cjparser.h" @@ -72,37 +77,15 @@ #include #include -// argh, Windows defines this -#ifdef GetCurrentTime -#undef GetCurrentTime -#endif - -// ----------------------------------------------------------------------------- -// global vars -// ----------------------------------------------------------------------------- - -class HelpGenApp: public wxApp -{ -public: - HelpGenApp() {}; - - // don't let wxWin parse our cmd line, we do it ourselves - virtual bool OnInit() { return TRUE; } - - virtual int OnRun(); -}; - -// IMPLEMENT_APP(HelpGenApp); - // ----------------------------------------------------------------------------- // private functions // ----------------------------------------------------------------------------- // return the label for the given function name (i.e. argument of \label) -static wxString MakeLabel(const char *classname, const char *funcname = NULL); +static wxString MakeLabel(const wxChar *classname, const wxChar *funcname = NULL); // return the whole \helpref{arg}{arg_label} string -static wxString MakeHelpref(const char *argument); +static wxString MakeHelpref(const wxChar *argument); // [un]quote special TeX characters (in place) static void TeXFilter(wxString* str); @@ -113,7 +96,7 @@ static wxString GetAllComments(const spContext& ctx); // get the string with current time (returns pointer to static buffer) // timeFormat is used for the call of strftime(3) -static const char *GetCurrentTime(const char *timeFormat); +static const char *GetCurrentTimeFormatted(const char *timeFormat); // get the string containing the program version static const wxString GetVersionString(); @@ -157,7 +140,7 @@ struct FunctionDocEntry return 1; } - wxString dtorname = wxString('~') + classname; + wxString dtorname = wxString(_T("~")) + classname; // there is only one dtor, so the logic here is simpler if ( (*pp1)->name == dtorname ) { @@ -168,7 +151,7 @@ struct FunctionDocEntry } // two normal methods - return strcmp((*pp1)->name, (*pp2)->name); + return wxStrcmp((*pp1)->name, (*pp2)->name); } } @@ -211,17 +194,17 @@ public: bool FlushAll() { if ( m_text.empty() ) - return TRUE; + return true; if ( !Write(m_text) ) { - wxLogError("Failed to output generated documentation."); + wxLogError(_T("Failed to output generated documentation.")); - return FALSE; + return false; } m_text.clear(); - return TRUE; + return true; } private: @@ -243,22 +226,22 @@ public: // already have) bool AddNamesFromFile(const wxString& filename); - // return TRUE if we ignore this function + // return true if we ignore this function bool IgnoreMethod(const wxString& classname, const wxString& funcname) const { if ( IgnoreClass(classname) ) - return TRUE; + return true; IgnoreListEntry ignore(classname, funcname); return m_ignore.Index(&ignore) != wxNOT_FOUND; } - // return TRUE if we ignore this class entirely + // return true if we ignore this class entirely bool IgnoreClass(const wxString& classname) const { - IgnoreListEntry ignore(classname, ""); + IgnoreListEntry ignore(classname, wxEmptyString); return m_ignore.Index(&ignore) != wxNOT_FOUND; } @@ -280,8 +263,10 @@ protected: IgnoreListEntry *second); // for efficiency, let's sort it +public: // FIXME: macro requires it WX_DEFINE_SORTED_ARRAY(IgnoreListEntry *, ArrayNamesToIgnore); +protected: ArrayNamesToIgnore m_ignore; private: @@ -339,7 +324,7 @@ protected: wxTeXFile m_file; // file we're writing to now // state variables - bool m_inClass, // TRUE after file successfully opened + bool m_inClass, // true after file successfully opened m_inTypesSection, // enums & typedefs go there m_inMethodSection, // functions go here m_isFirstParam; // first parameter of current function? @@ -385,10 +370,10 @@ public: DocManager(bool checkParamNames); ~DocManager(); - // returns FALSE on failure + // returns false on failure bool ParseTeXFile(const wxString& filename); - // returns FALSE if there were any differences + // returns false if there were any differences bool DumpDifferences(spContext *ctxTop) const; // get our `ignore' object @@ -400,7 +385,7 @@ protected: // returns the length of 'match' if the string 'str' starts with it or 0 // otherwise - static size_t TryMatch(const char *str, const char *match); + static size_t TryMatch(const wxChar *str, const wxChar *match); // skip spaces: returns pointer to first non space character (also // updates the value of m_line) @@ -415,12 +400,12 @@ protected: } // skips characters until the next 'c' in '*pp' unless it ends before in - // which case FALSE is returned and pp points to '\0', otherwise TRUE is + // which case false is returned and pp points to '\0', otherwise true is // returned and pp points to 'c' bool SkipUntil(const char **pp, char c); // the same as SkipUntil() but only spaces are skipped: on first non space - // character different from 'c' the function stops and returns FALSE + // character different from 'c' the function stops and returns false bool SkipSpaceUntil(const char **pp, char c); // extract the string between {} and modify '*pp' to point at the @@ -441,6 +426,8 @@ protected: // information about all functions documented in the TeX file(s) // ------------------------------------------------------------- +public: // Note: Sun C++ 5.5 requires TypeInfo and ParamInfo to be public + // info about a type: for now stored as text string, but must be parsed // further later (to know that "char *" == "char []" - TODO) class TypeInfo @@ -457,6 +444,8 @@ protected: wxString m_type; }; + friend class ParamInfo; // for access to TypeInfo + // info abotu a function parameter class ParamInfo { @@ -478,7 +467,8 @@ protected: wxString m_value; // default value }; - WX_DEFINE_ARRAY(ParamInfo *, ArrayParamInfo); +public: // FIXME: macro requires it + WX_DEFINE_ARRAY_PTR(ParamInfo *, ArrayParamInfo); // info about a function struct MethodInfo @@ -520,9 +510,10 @@ protected: ArrayParamInfo m_params; }; - WX_DEFINE_ARRAY(MethodInfo *, ArrayMethodInfo); - WX_DEFINE_ARRAY(ArrayMethodInfo *, ArrayMethodInfos); + WX_DEFINE_ARRAY_PTR(MethodInfo *, ArrayMethodInfo); + WX_DEFINE_ARRAY_PTR(ArrayMethodInfo *, ArrayMethodInfos); +private: // first array contains the names of all classes we found, the second has a // pointer to the array of methods of the given class at the same index as // the class name appears in m_classes @@ -541,10 +532,12 @@ private: // implementation // ============================================================================= +static char **g_argv = NULL; + // this function never returns static void usage() { - wxString prog = wxTheApp->argv[0]; + wxString prog = g_argv[0]; wxString basename = prog.AfterLast('/'); #ifdef __WXMSW__ if ( !basename ) @@ -580,8 +573,18 @@ static void usage() exit(1); } -int HelpGenApp::OnRun() +int main(int argc, char **argv) { + g_argv = argv; + + wxInitializer initializer; + if ( !initializer ) + { + fprintf(stderr, "Failed to initialize the wxWidgets library, aborting."); + + return -1; + } + enum { Mode_None, @@ -596,8 +599,8 @@ int HelpGenApp::OnRun() wxArrayString filesH, filesTeX; wxString directoryOut, // directory for 'dmup' output ignoreFile; // file with classes/functions to ignore - bool overwrite = FALSE, // overwrite existing files during 'dump'? - paramNames = FALSE; // check param names during 'diff'? + bool overwrite = false, // overwrite existing files during 'dump'? + paramNames = false; // check param names during 'diff'? for ( int current = 1; current < argc ; current++ ) { // all options have one letter @@ -611,7 +614,7 @@ int HelpGenApp::OnRun() case 'q': // be quiet - wxLog::GetActiveTarget()->SetVerbose(FALSE); + wxLog::GetActiveTarget()->SetVerbose(false); continue; case 'H': @@ -644,7 +647,7 @@ int HelpGenApp::OnRun() break; } - paramNames = TRUE; + paramNames = true; continue; case 'f': @@ -654,7 +657,7 @@ int HelpGenApp::OnRun() break; } - overwrite = TRUE; + overwrite = true; continue; case 'o': @@ -672,7 +675,7 @@ int HelpGenApp::OnRun() } directoryOut = argv[current]; - if ( !!directoryOut ) { + if ( !directoryOut.empty() ) { // terminate with a '/' if it doesn't have it switch ( directoryOut.Last() ) { case '/': @@ -732,7 +735,7 @@ int HelpGenApp::OnRun() // create a parser object and a visitor derivation CJSourceParser parser; HelpGenVisitor visitor(directoryOut, overwrite); - if ( !!ignoreFile && mode == Mode_Dump ) + if ( !ignoreFile.empty() && mode == Mode_Dump ) visitor.GetIgnoreHandler().AddNamesFromFile(ignoreFile); spContext *ctxTop = NULL; @@ -747,14 +750,14 @@ int HelpGenApp::OnRun() header.c_str()); } else if ( mode == Mode_Dump ) { - ((spFile *)ctxTop)->mFileName = header; + ((spFile *)ctxTop)->m_FileName = header; visitor.VisitAll(*ctxTop); visitor.EndVisit(); } #ifdef __WXDEBUG__ if ( 0 && ctxTop ) - ctxTop->Dump(""); + ctxTop->Dump(wxEmptyString); #endif // __WXDEBUG__ } @@ -764,7 +767,7 @@ int HelpGenApp::OnRun() wxLogError("Can't complete diff."); // failure - return FALSE; + return false; } DocManager docman(paramNames); @@ -778,7 +781,7 @@ int HelpGenApp::OnRun() } } - if ( !!ignoreFile ) + if ( !ignoreFile.empty() ) docman.GetIgnoreHandler().AddNamesFromFile(ignoreFile); docman.DumpDifferences(ctxTop); @@ -787,21 +790,6 @@ int HelpGenApp::OnRun() return 0; } -int main(int argc, char **argv) -{ - wxInitializer initializer; - if ( !initializer ) - { - fprintf(stderr, "Failed to initialize the wxWindows library, aborting."); - - return -1; - } - HelpGenApp app; - app.argc = argc; - app.argv = argv; - return app.OnRun(); -} - // ----------------------------------------------------------------------------- // HelpGenVisitor implementation // ----------------------------------------------------------------------------- @@ -819,13 +807,13 @@ void HelpGenVisitor::Reset() { m_inClass = m_inTypesSection = - m_inMethodSection = FALSE; + m_inMethodSection = false; m_classname = m_funcName = m_textFunc = m_textStoredTypedefs = - m_textStoredFunctionComment = ""; + m_textStoredFunctionComment = wxEmptyString; m_arrayFuncDocs.Empty(); @@ -856,7 +844,7 @@ void HelpGenVisitor::InsertEnumDocs() void HelpGenVisitor::InsertDataStructuresHeader() { if ( !m_inTypesSection ) { - m_inTypesSection = TRUE; + m_inTypesSection = true; m_file.WriteVerbatim("\\wxheading{Data structures}\n\n"); } @@ -865,7 +853,7 @@ void HelpGenVisitor::InsertDataStructuresHeader() void HelpGenVisitor::InsertMethodsHeader() { if ( !m_inMethodSection ) { - m_inMethodSection = TRUE; + m_inMethodSection = true; m_file.WriteVerbatim( "\\latexignore{\\rtfignore{\\wxheading{Members}}}\n\n"); } @@ -881,7 +869,7 @@ void HelpGenVisitor::CloseFunction() m_textFunc << "}\n\n"; - if ( !m_textStoredFunctionComment.IsEmpty() ) { + if ( !m_textStoredFunctionComment.empty() ) { m_textFunc << m_textStoredFunctionComment << '\n'; } @@ -893,22 +881,55 @@ void HelpGenVisitor::CloseFunction() void HelpGenVisitor::CloseClass() { - if ( m_inClass ) { + CloseFunction(); + + if ( m_inClass ) + { size_t count = m_arrayFuncDocs.GetCount(); - if ( count ) { + if ( count ) + { + size_t n; FunctionDocEntry::classname = m_classname; + m_arrayFuncDocs.Sort(FunctionDocEntry::Compare); - for ( size_t n = 0; n < count; n++ ) { + // Now examine each first line and if it's been seen, cut it + // off (it's a duplicate \membersection) + wxHashTable membersections(wxKEY_STRING); + + for ( n = 0; n < count; n++ ) + { + wxString section(m_arrayFuncDocs[n].text); + + // Strip leading whitespace + int pos = section.Find(_T("\\membersection")); + if (pos > -1) + { + section = section.Mid(pos); + } + + wxString ms(section.BeforeFirst(wxT('\n'))); + if (membersections.Get(ms)) + { + m_arrayFuncDocs[n].text = section.AfterFirst(wxT('\n')); + } + else + { + membersections.Put(ms.c_str(), & membersections); + } + } + + for ( n = 0; n < count; n++ ) { m_file.WriteTeX(m_arrayFuncDocs[n].text); } m_arrayFuncDocs.Empty(); } - m_inClass = FALSE; + m_inClass = false; m_classname.clear(); } + m_file.FlushAll(); } void HelpGenVisitor::EndVisit() @@ -920,22 +941,33 @@ void HelpGenVisitor::EndVisit() m_fileHeader.Empty(); m_file.FlushAll(); + if (m_file.IsOpened()) + { + m_file.Flush(); + m_file.Close(); + } wxLogVerbose("%s: finished generating for the current file.", - GetCurrentTime("%H:%M:%S")); + GetCurrentTimeFormatted("%H:%M:%S")); } void HelpGenVisitor::VisitFile( spFile& file ) { - m_fileHeader = file.mFileName; + m_fileHeader = file.m_FileName; wxLogVerbose("%s: started generating docs for classes from file '%s'...", - GetCurrentTime("%H:%M:%S"), m_fileHeader.c_str()); + GetCurrentTimeFormatted("%H:%M:%S"), m_fileHeader.c_str()); } void HelpGenVisitor::VisitClass( spClass& cl ) { CloseClass(); + if (m_file.IsOpened()) + { + m_file.Flush(); + m_file.Close(); + } + wxString name = cl.GetName(); if ( m_ignoreNames.IgnoreClass(name) ) { @@ -974,7 +1006,7 @@ void HelpGenVisitor::VisitClass( spClass& cl ) } m_inMethodSection = - m_inTypesSection = FALSE; + m_inTypesSection = false; wxLogInfo("Created new file '%s' for class '%s'.", filename.c_str(), name.c_str()); @@ -990,7 +1022,7 @@ void HelpGenVisitor::VisitClass( spClass& cl ) "\\section{\\class{%s}}\\label{%s}\n\n", GetVersionString().c_str(), m_fileHeader.c_str(), - GetCurrentTime("%d/%b/%y %H:%M:%S"), + GetCurrentTimeFormatted("%d/%b/%y %H:%M:%S"), name.c_str(), wxString(name).MakeLower().c_str()); @@ -1002,7 +1034,7 @@ void HelpGenVisitor::VisitClass( spClass& cl ) // if the header includes other headers they must be related to it... try to // automatically generate the "See also" clause if ( !m_headers.IsEmpty() ) { - // correspondence between wxWindows headers and class names + // correspondence between wxWidgets headers and class names static const char *headers[] = { "object", "defs", @@ -1073,12 +1105,12 @@ void HelpGenVisitor::VisitClass( spClass& cl ) // derived from section wxString derived = "\\wxheading{Derived from}\n\n"; - const StrListT& baseClasses = cl.mSuperClassNames; + const StrListT& baseClasses = cl.m_SuperClassNames; if ( baseClasses.size() == 0 ) { derived << "No base class"; } else { - bool first = TRUE; + bool first = true; for ( StrListT::const_iterator i = baseClasses.begin(); i != baseClasses.end(); i++ ) { @@ -1087,7 +1119,7 @@ void HelpGenVisitor::VisitClass( spClass& cl ) derived << "\\\\\n"; } else { - first = FALSE; + first = false; } wxString baseclass = *i; @@ -1097,6 +1129,12 @@ void HelpGenVisitor::VisitClass( spClass& cl ) } totalText << derived << "\n\n"; + // include file section + wxString includeFile = "\\wxheading{Include files}\n\n"; + includeFile << "<" << m_fileHeader << ">"; + + totalText << includeFile << "\n\n"; + // write all this to file m_file.WriteTeX(totalText); @@ -1104,6 +1142,8 @@ void HelpGenVisitor::VisitClass( spClass& cl ) InsertDataStructuresHeader(); InsertTypedefDocs(); InsertEnumDocs(); + + //m_file.Flush(); } void HelpGenVisitor::VisitEnumeration( spEnumeration& en ) @@ -1123,9 +1163,9 @@ void HelpGenVisitor::VisitEnumeration( spEnumeration& en ) wxString enumeration = GetAllComments(en), enumerationVerb; - enumerationVerb << "\\begin{verbatim}\n" - << en.mEnumContent - << "\n\\end{verbatim}\n"; + enumerationVerb << _T("\\begin{verbatim}\n") + << en.m_EnumContent + << _T("\n\\end{verbatim}\n"); // remember for later use if we're not inside a class yet if ( !m_inClass ) { @@ -1154,14 +1194,14 @@ void HelpGenVisitor::VisitTypeDef( spTypeDef& td ) } wxString typedefdoc; - typedefdoc << "{\\small \\begin{verbatim}\n" - << "typedef " << td.mOriginalType << ' ' << td.GetName() - << "\n\\end{verbatim}}\n" + typedefdoc << _T("{\\small \\begin{verbatim}\n") + << _T("typedef ") << td.m_OriginalType << _T(' ') << td.GetName() + << _T("\n\\end{verbatim}}\n") << GetAllComments(td); // remember for later use if we're not inside a class yet if ( !m_inClass ) { - if ( !m_textStoredTypedefs.IsEmpty() ) { + if ( !m_textStoredTypedefs.empty() ) { m_textStoredTypedefs << '\n'; } @@ -1236,7 +1276,7 @@ void HelpGenVisitor::VisitOperation( spOperation& op ) // save state info m_funcName = funcname; - m_isFirstParam = TRUE; + m_isFirstParam = true; m_textStoredFunctionComment = GetAllComments(op); @@ -1245,21 +1285,30 @@ void HelpGenVisitor::VisitOperation( spOperation& op ) // check for the special case of dtor wxString dtor; - if ( (funcname[0] == '~') && (m_classname == funcname.c_str() + 1) ) { + if ( (funcname[0u] == '~') && (m_classname == funcname.c_str() + 1) ) { dtor.Printf("\\destruct{%s}", m_classname.c_str()); funcname = dtor; } m_textFunc.Printf("\n" - "\\membersection{%s::%s}\\label{%s}\n" - "\n" - "\\%sfunc{%s%s}{%s}{", - m_classname.c_str(), funcname.c_str(), - MakeLabel(m_classname, funcname).c_str(), - op.mIsConstant ? "const" : "", - op.mIsVirtual ? "virtual " : "", - op.mRetType.c_str(), - funcname.c_str()); + "\\membersection{%s::%s}\\label{%s}\n", + m_classname.c_str(), funcname.c_str(), + MakeLabel(m_classname, funcname).c_str()); + + wxString constStr; + if(op.mIsConstant) constStr = _T("const"); + + wxString virtualStr; + if(op.mIsVirtual) virtualStr = _T("virtual "); + + wxString func; + func.Printf(_T("\n") + _T("\\%sfunc{%s%s}{%s}{"), + constStr.c_str(), + virtualStr.c_str(), + op.m_RetType.c_str(), + funcname.c_str()); + m_textFunc += func; } void HelpGenVisitor::VisitParameter( spParameter& param ) @@ -1268,15 +1317,15 @@ void HelpGenVisitor::VisitParameter( spParameter& param ) return; if ( m_isFirstParam ) { - m_isFirstParam = FALSE; + m_isFirstParam = false; } else { m_textFunc << ", "; } - m_textFunc << "\\param{" << param.mType << " }{" << param.GetName(); - wxString defvalue = param.mInitVal; - if ( !defvalue.IsEmpty() ) { + m_textFunc << "\\param{" << param.m_Type << " }{" << param.GetName(); + wxString defvalue = param.m_InitVal; + if ( !defvalue.empty() ) { m_textFunc << " = " << defvalue; } @@ -1347,7 +1396,7 @@ wxString DocManager::ExtractStringBetweenBraces(const char **pp) if ( !SkipSpaceUntil(pp, '{') ) { wxLogWarning("file %s(%d): '{' expected after '\\param'", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); } else { @@ -1355,7 +1404,7 @@ wxString DocManager::ExtractStringBetweenBraces(const char **pp) if ( !SkipUntil(pp, '}') ) { wxLogWarning("file %s(%d): '}' expected after '\\param'", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); } else { result = wxString(startParam, (*pp)++ - startParam); @@ -1371,11 +1420,11 @@ bool DocManager::ParseTeXFile(const wxString& filename) wxFile file(m_filename, wxFile::read); if ( !file.IsOpened() ) - return FALSE; + return false; off_t len = file.Length(); if ( len == wxInvalidOffset ) - return FALSE; + return false; char *buf = new char[len + 1]; buf[len] = '\0'; @@ -1383,18 +1432,18 @@ bool DocManager::ParseTeXFile(const wxString& filename) if ( file.Read(buf, len) == wxInvalidOffset ) { delete [] buf; - return FALSE; + return false; } // reinit everything m_line = 1; wxLogVerbose("%s: starting to parse doc file '%s'.", - GetCurrentTime("%H:%M:%S"), m_filename.c_str()); + GetCurrentTimeFormatted("%H:%M:%S"), m_filename.c_str()); // the name of the class from the last "\membersection" command: we assume // that the following "\func" or "\constfunc" always documents a method of - // this class (and it should always be like that in wxWindows documentation) + // this class (and it should always be like that in wxWidgets documentation) wxString classname; for ( const char *current = buf; current - buf < len; current++ ) { @@ -1453,7 +1502,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) if ( !SkipSpaceUntil(¤t, '{') ) { wxLogWarning("file %s(%d): '{' expected after \\func, " "\\constfunc or \\membersection.", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1465,7 +1514,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) const char *startClass = current; if ( !SkipUntil(¤t, ':') || *(current + 1) != ':' ) { wxLogWarning("file %s(%d): '::' expected after " - "\\membersection.", m_filename.c_str(), m_line); + "\\membersection.", m_filename.c_str(), (int)m_line); } else { classname = wxString(startClass, current - startClass); @@ -1480,7 +1529,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) if ( !SkipUntil(¤t, '}') ) { wxLogWarning("file %s(%d): '}' expected after return type", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1489,9 +1538,9 @@ bool DocManager::ParseTeXFile(const wxString& filename) TeXUnfilter(&returnType); current++; - if ( !SkipSpaceUntil(¤t, '{') ) { + if ( !SkipSpaceUntil(¤t, '{') ) { wxLogWarning("file %s(%d): '{' expected after return type", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1500,7 +1549,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) const char *funcEnd = current; if ( !SkipUntil(&funcEnd, '}') ) { wxLogWarning("file %s(%d): '}' expected after function name", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1509,8 +1558,8 @@ bool DocManager::ParseTeXFile(const wxString& filename) current = funcEnd + 1; // trim spaces from both sides - funcName.Trim(FALSE); - funcName.Trim(TRUE); + funcName.Trim(false); + funcName.Trim(true); // special cases: '$...$' may be used for LaTeX inline math, remove the // '$'s @@ -1529,7 +1578,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) size_t len = strlen("\\destruct{"); if ( funcName(0, len) != "\\destruct{" ) { wxLogWarning("file %s(%d): \\destruct expected", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1539,7 +1588,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) if ( !SkipSpaceUntil(¤t, '}') ) { wxLogWarning("file %s(%d): '}' expected after destructor", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1554,14 +1603,14 @@ bool DocManager::ParseTeXFile(const wxString& filename) if ( !SkipSpaceUntil(¤t, '{') || (current++, !SkipSpaceUntil(¤t, '\\')) ) { wxLogWarning("file %s(%d): '\\param' or '\\void' expected", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } wxArrayString paramNames, paramTypes, paramValues; - bool isVararg = FALSE; + bool isVararg = false; current++; // skip '\\' lenMatch = TryMatch(current, "void"); @@ -1572,9 +1621,9 @@ bool DocManager::ParseTeXFile(const wxString& filename) // now come {paramtype}{paramname} wxString paramType = ExtractStringBetweenBraces(¤t); - if ( !!paramType ) { + if ( !paramType.empty() ) { wxString paramText = ExtractStringBetweenBraces(¤t); - if ( !!paramText ) { + if ( !paramText.empty() ) { // the param declaration may contain default value wxString paramName = paramText.BeforeFirst('='), paramValue = paramText.AfterFirst('='); @@ -1593,7 +1642,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) // vararg function? wxString paramText = ExtractStringBetweenBraces(¤t); if ( paramText == "..." ) { - isVararg = TRUE; + isVararg = true; } else { wxLogWarning("Parameters of '%s::%s' are in " @@ -1611,7 +1660,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) } else { wxLogWarning("file %s(%d): ',' or '}' expected after " - "'\\param'", m_filename.c_str(), m_line); + "'\\param'", m_filename.c_str(), (int)m_line); continue; } @@ -1620,7 +1669,7 @@ bool DocManager::ParseTeXFile(const wxString& filename) // if we got here there was no '\\void', so must have some params if ( paramNames.IsEmpty() ) { wxLogWarning("file %s(%d): '\\param' or '\\void' expected", - m_filename.c_str(), m_line); + m_filename.c_str(), (int)m_line); continue; } @@ -1637,13 +1686,18 @@ bool DocManager::ParseTeXFile(const wxString& filename) paramsAll << paramTypes[param] << ' ' << paramNames[param]; } + wxString constStr; + if (foundCommand == ConstFunc) + constStr = _T(" const"); + wxLogVerbose("file %s(%d): found '%s %s::%s(%s)%s'", - m_filename.c_str(), m_line, + m_filename.c_str(), + (int)m_line, returnType.c_str(), classname.c_str(), funcName.c_str(), paramsAll.c_str(), - foundCommand == ConstFunc ? " const" : ""); + constStr.c_str()); // store the info about the just found function ArrayMethodInfo *methods; @@ -1677,22 +1731,22 @@ bool DocManager::ParseTeXFile(const wxString& filename) delete [] buf; wxLogVerbose("%s: finished parsing doc file '%s'.\n", - GetCurrentTime("%H:%M:%S"), m_filename.c_str()); + GetCurrentTimeFormatted("%H:%M:%S"), m_filename.c_str()); - return TRUE; + return true; } bool DocManager::DumpDifferences(spContext *ctxTop) const { typedef MMemberListT::const_iterator MemberIndex; - bool foundDiff = FALSE; + bool foundDiff = false; // flag telling us whether the given class was found at all in the header size_t nClass, countClassesInDocs = m_classes.GetCount(); bool *classExists = new bool[countClassesInDocs]; for ( nClass = 0; nClass < countClassesInDocs; nClass++ ) { - classExists[nClass] = FALSE; + classExists[nClass] = false; } // ctxTop is normally an spFile @@ -1707,11 +1761,11 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const } spClass *ctxClass = (spClass *)ctx; - const wxString& nameClass = ctxClass->mName; + const wxString& nameClass = ctxClass->m_Name; int index = m_classes.Index(nameClass); if ( index == wxNOT_FOUND ) { if ( !m_ignoreNames.IgnoreClass(nameClass) ) { - foundDiff = TRUE; + foundDiff = true; wxLogError("Class '%s' is not documented at all.", nameClass.c_str()); @@ -1721,7 +1775,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const continue; } else { - classExists[index] = TRUE; + classExists[index] = true; } // array of method descriptions for this class @@ -1731,7 +1785,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const // flags telling if we already processed given function bool *methodExists = new bool[countMethods]; for ( nMethod = 0; nMethod < countMethods; nMethod++ ) { - methodExists[nMethod] = FALSE; + methodExists[nMethod] = false; } wxArrayString aOverloadedMethods; @@ -1743,7 +1797,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const continue; spOperation *ctxMethod = (spOperation *)ctx; - const wxString& nameMethod = ctxMethod->mName; + const wxString& nameMethod = ctxMethod->m_Name; // find all functions with the same name wxArrayInt aMethodsWithSameName; @@ -1754,7 +1808,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const if ( aMethodsWithSameName.IsEmpty() && ctxMethod->IsPublic() ) { if ( !m_ignoreNames.IgnoreMethod(nameClass, nameMethod) ) { - foundDiff = TRUE; + foundDiff = true; wxLogError("'%s::%s' is not documented.", nameClass.c_str(), @@ -1766,7 +1820,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const } else if ( aMethodsWithSameName.GetCount() == 1 ) { index = (size_t)aMethodsWithSameName[0u]; - methodExists[index] = TRUE; + methodExists[index] = true; if ( m_ignoreNames.IgnoreMethod(nameClass, nameMethod) ) continue; @@ -1781,21 +1835,29 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const const MethodInfo& method = *(methods[index]); bool isVirtual = ctxMethod->mIsVirtual; - if ( isVirtual != method.HasFlag(MethodInfo::Virtual) ) { + if ( isVirtual != method.HasFlag(MethodInfo::Virtual) ) + { + wxString virtualStr; + if(isVirtual)virtualStr = _T("not "); + wxLogWarning("'%s::%s' is incorrectly documented as %s" "virtual.", nameClass.c_str(), nameMethod.c_str(), - isVirtual ? "not " : ""); + virtualStr.c_str()); } bool isConst = ctxMethod->mIsConstant; - if ( isConst != method.HasFlag(MethodInfo::Const) ) { + if ( isConst != method.HasFlag(MethodInfo::Const) ) + { + wxString constStr; + if(isConst)constStr = _T("not "); + wxLogWarning("'%s::%s' is incorrectly documented as %s" "constant.", nameClass.c_str(), nameMethod.c_str(), - isConst ? "not " : ""); + constStr.c_str()); } // check that the params match @@ -1806,7 +1868,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const "in the docs: should be %d instead of %d.", nameClass.c_str(), nameMethod.c_str(), - params.size(), method.GetParamCount()); + (int)params.size(), (int)method.GetParamCount()); } else { size_t nParam = 0; @@ -1821,42 +1883,42 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const spParameter *ctxParam = (spParameter *)ctx; const ParamInfo& param = method.GetParam(nParam); if ( m_checkParamNames && - (param.GetName() != ctxParam->mName) ) { - foundDiff = TRUE; + (param.GetName() != ctxParam->m_Name.c_str()) ) { + foundDiff = true; wxLogError("Parameter #%d of '%s::%s' should be " "'%s' and not '%s'.", - nParam + 1, + (int)(nParam + 1), nameClass.c_str(), nameMethod.c_str(), - ctxParam->mName.c_str(), + ctxParam->m_Name.c_str(), param.GetName().c_str()); continue; } - if ( param.GetType() != ctxParam->mType ) { - foundDiff = TRUE; + if ( param.GetType() != ctxParam->m_Type ) { + foundDiff = true; wxLogError("Type of parameter '%s' of '%s::%s' " "should be '%s' and not '%s'.", - ctxParam->mName.c_str(), + ctxParam->m_Name.c_str(), nameClass.c_str(), nameMethod.c_str(), - ctxParam->mType.c_str(), + ctxParam->m_Type.c_str(), param.GetType().GetName().c_str()); continue; } - if ( param.GetDefValue() != ctxParam->mInitVal ) { + if ( param.GetDefValue() != ctxParam->m_InitVal.c_str() ) { wxLogWarning("Default value of parameter '%s' of " "'%s::%s' should be '%s' and not " "'%s'.", - ctxParam->mName.c_str(), + ctxParam->m_Name.c_str(), nameClass.c_str(), nameMethod.c_str(), - ctxParam->mInitVal.c_str(), + ctxParam->m_InitVal.c_str(), param.GetDefValue().c_str()); } } @@ -1872,7 +1934,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const // mark all methods with this name as existing for ( nMethod = 0; nMethod < countMethods; nMethod++ ) { if ( methods[nMethod]->GetName() == nameMethod ) - methodExists[nMethod] = TRUE; + methodExists[nMethod] = true; } aOverloadedMethods.Add(nameMethod); @@ -1891,7 +1953,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const if ( !methodExists[nMethod] ) { const wxString& nameMethod = methods[nMethod]->GetName(); if ( !m_ignoreNames.IgnoreMethod(nameClass, nameMethod) ) { - foundDiff = TRUE; + foundDiff = true; wxLogError("'%s::%s' is documented but doesn't exist.", nameClass.c_str(), @@ -1906,7 +1968,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const // check that all classes we found in the docs really exist for ( nClass = 0; nClass < countClassesInDocs; nClass++ ) { if ( !classExists[nClass] ) { - foundDiff = TRUE; + foundDiff = true; wxLogError("Class '%s' is documented but doesn't exist.", m_classes[nClass].c_str()); @@ -1942,11 +2004,11 @@ bool IgnoreNamesHandler::AddNamesFromFile(const wxString& filename) { wxFile file(filename, wxFile::read); if ( !file.IsOpened() ) - return FALSE; + return false; off_t len = file.Length(); if ( len == wxInvalidOffset ) - return FALSE; + return false; char *buf = new char[len + 1]; buf[len] = '\0'; @@ -1954,7 +2016,7 @@ bool IgnoreNamesHandler::AddNamesFromFile(const wxString& filename) if ( file.Read(buf, len) == wxInvalidOffset ) { delete [] buf; - return FALSE; + return false; } wxString line; @@ -1974,7 +2036,7 @@ bool IgnoreNamesHandler::AddNamesFromFile(const wxString& filename) } else { // entire class - m_ignore.Add(new IgnoreListEntry(line, "")); + m_ignore.Add(new IgnoreListEntry(line, wxEmptyString)); } } //else: comment @@ -1991,7 +2053,7 @@ bool IgnoreNamesHandler::AddNamesFromFile(const wxString& filename) delete [] buf; - return TRUE; + return true; } // ----------------------------------------------------------------------------- @@ -2079,7 +2141,7 @@ static wxString MakeHelpref(const char *argument) static void TeXFilter(wxString* str) { // TeX special which can be quoted (don't include backslash nor braces as - // we generate them + // we generate them static wxRegEx reNonSpecialSpecials("[#$%&_]"), reAccents("[~^]"); @@ -2094,12 +2156,12 @@ static void TeXFilter(wxString* str) static void TeXUnfilter(wxString* str) { // FIXME may be done much more quickly - str->Trim(TRUE); - str->Trim(FALSE); + str->Trim(true); + str->Trim(false); // undo TeXFilter static wxRegEx reNonSpecialSpecials("\\\\([#$%&_{}])"), - reAccents("\\\\verb|([~^])|"); + reAccents("\\\\verb\\|([~^])\\|"); reNonSpecialSpecials.ReplaceAll(str, "\\1"); reAccents.ReplaceAll(str, "\\1"); @@ -2115,8 +2177,8 @@ static wxString GetAllComments(const spContext& ctx) wxString comment = (*i)->GetText(); // don't take comments like "// ----------" &c - comment.Trim(FALSE); - if ( !!comment && + comment.Trim(false); + if ( !comment.empty() && comment == wxString(comment[0u], comment.length() - 1) + '\n' ) comments << "\n"; else @@ -2126,7 +2188,7 @@ static wxString GetAllComments(const spContext& ctx) return comments; } -static const char *GetCurrentTime(const char *timeFormat) +static const char *GetCurrentTimeFormatted(const char *timeFormat) { static char s_timeBuffer[128]; time_t timeNow; @@ -2149,6 +2211,87 @@ static const wxString GetVersionString() /* $Log$ + Revision 1.44 2005/05/31 17:47:45 ABX + More warning and error fixes (work in progress with Tinderbox). + + Revision 1.43 2005/05/31 15:42:43 ABX + More warning and error fixes (work in progress with Tinderbox). + + Revision 1.42 2005/05/31 15:32:49 ABX + More warning and error fixes (work in progress with Tinderbox). + + Revision 1.41 2005/05/30 13:06:15 ABX + More warning and error fixes (work in progress with Tinderbox). + + Revision 1.40 2005/05/30 11:49:32 ABX + More warning and error fixes (work in progress with Tinderbox). + + Revision 1.39 2005/05/30 09:26:42 ABX + More warning and error fixes (work in progress with Tinderbox). + + Revision 1.38 2005/05/24 09:06:20 ABX + More fixes and wxWidgets coding standards. + + Revision 1.37 2005/05/23 15:22:08 ABX + Initial HelpGen source cleaning. + + Revision 1.36 2005/04/07 19:54:58 MW + Workarounds to allow compilation by Sun C++ 5.5 + + Revision 1.35 2004/12/12 11:03:31 VZ + give an error message if we're built in Unicode mode (in response to bug 1079224) + + Revision 1.34 2004/11/23 09:53:31 JS + Changed GPL to wxWindows Licence + + Revision 1.33 2004/11/12 03:30:07 RL + + Cruft cleanup from MJW, strip the tabs out of sound.cpp + + Revision 1.32 2004/11/10 21:02:58 VZ + new set of fixes for problems due to huge files support: drop wxFileSize_t, use wxFileOffset only, make wxInvalidOffset an int (main part of the patch 1063498) + + Revision 1.31 2004/10/05 15:38:29 ABX + Warning fixes found under hardest mode of OpenWatcom. Seems clean in Borland, MinGW and DMC. + + Revision 1.30 2004/06/18 19:25:50 ABX + Small step in making HelpGen up to date unicode application. + + Revision 1.29 2004/06/17 19:00:22 ABX + Warning fixes. Code cleanup. Whitespaces and tabs removed. + + Revision 1.28 2004/05/25 11:19:57 JS + More name changes + + Revision 1.27 2003/10/13 17:21:30 MBN + Compilation fixes. + + Revision 1.26 2003/09/29 15:18:35 MBN + (Blind) compilation fix for Sun compiler. + + Revision 1.25 2003/09/03 17:39:27 MBN + Compilation fixes. + + Revision 1.24 2003/08/13 22:59:37 VZ + compilation fix + + Revision 1.23 2003/06/13 17:05:43 VZ + quote '|' inside regexes (fixes dump mode); fixed crash due to strange HelpGenApp code + + Revision 1.22 2002/01/21 21:18:50 JS + Now adds 'include file' heading + + Revision 1.21 2002/01/04 11:06:09 JS + Fixed missing membersections bug and also bug with functions not being written + in the right class + + Revision 1.20 2002/01/03 14:23:33 JS + Added code to make it not duplicate membersections for overloaded functions + + Revision 1.19 2002/01/03 13:34:12 JS + Added FlushAll to CloseClass, otherwise text was only flushed right at the end, + and appeared in one file. + Revision 1.18 2002/01/03 12:02:47 JS Added main() and corrected VC++ project settings @@ -2234,7 +2377,7 @@ static const wxString GetVersionString() date: 1999/01/08 17:45:55; author: VZ; state: Exp; HelpGen is a prototype of the tool for automatic generation of the .tex files - for wxWindows documentation from C++ headers + for wxWidgets documentation from C++ headers */ /* vi: set tw=80 et ts=4 sw=4: */