More warning and error fixes (work in progress with Tinderbox).

[wxWidgets.git] / utils / HelpGen / src / HelpGen.cpp

diff --git a/utils/HelpGen/src/HelpGen.cpp b/utils/HelpGen/src/HelpGen.cpp
index 01ca91cc7532bda2b80834ae545e715aca00fae0..d26af0382a5322769b8bd4fddd02583082f8b434 100644 (file)
--- a/utils/HelpGen/src/HelpGen.cpp
+++ b/utils/HelpGen/src/HelpGen.cpp
@@ -426,6 +426,8 @@ protected:
     // information about all functions documented in the TeX file(s)
     // -------------------------------------------------------------
 
     // 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
     // info about a type: for now stored as text string, but must be parsed
     // further later (to know that "char *" == "char []" - TODO)
     class TypeInfo


@@ -673,7 +675,7 @@ int main(int argc, char **argv)
                         }
 
                         directoryOut = argv[current];
                         }
 
                         directoryOut = argv[current];

-                        if ( !directoryOut.IsEmpty() ) {
+                        if ( !directoryOut.empty() ) {

                             // terminate with a '/' if it doesn't have it
                             switch ( directoryOut.Last() ) {
                                 case '/':
                             // terminate with a '/' if it doesn't have it
                             switch ( directoryOut.Last() ) {
                                 case '/':


@@ -733,7 +735,7 @@ int main(int argc, char **argv)
     // create a parser object and a visitor derivation
     CJSourceParser parser;
     HelpGenVisitor visitor(directoryOut, overwrite);
     // create a parser object and a visitor derivation
     CJSourceParser parser;
     HelpGenVisitor visitor(directoryOut, overwrite);

-    if ( !ignoreFile.IsEmpty() && mode == Mode_Dump )
+    if ( !ignoreFile.empty() && mode == Mode_Dump )

         visitor.GetIgnoreHandler().AddNamesFromFile(ignoreFile);
 
     spContext *ctxTop = NULL;
         visitor.GetIgnoreHandler().AddNamesFromFile(ignoreFile);
 
     spContext *ctxTop = NULL;


@@ -779,7 +781,7 @@ int main(int argc, char **argv)
             }
         }
 
             }
         }
 

-        if ( !ignoreFile.IsEmpty() )
+        if ( !ignoreFile.empty() )

             docman.GetIgnoreHandler().AddNamesFromFile(ignoreFile);
 
         docman.DumpDifferences(ctxTop);
             docman.GetIgnoreHandler().AddNamesFromFile(ignoreFile);
 
         docman.DumpDifferences(ctxTop);


@@ -867,7 +869,7 @@ void HelpGenVisitor::CloseFunction()
 
         m_textFunc << "}\n\n";
 
 
         m_textFunc << "}\n\n";
 

-        if ( !m_textStoredFunctionComment.IsEmpty() ) {
+        if ( !m_textStoredFunctionComment.empty() ) {

             m_textFunc << m_textStoredFunctionComment << '\n';
         }
 
             m_textFunc << m_textStoredFunctionComment << '\n';
         }
 


@@ -913,7 +915,7 @@ void HelpGenVisitor::CloseClass()
                 }
                 else
                 {
                 }
                 else
                 {

-                    membersections.Put(ms, & membersections);
+                    membersections.Put(ms.c_str(), & membersections);

                 }
             }
 
                 }
             }
 


@@ -1161,9 +1163,9 @@ void HelpGenVisitor::VisitEnumeration( spEnumeration& en )
     wxString enumeration = GetAllComments(en),
              enumerationVerb;
 
     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 ) {
 
     // remember for later use if we're not inside a class yet
     if ( !m_inClass ) {


@@ -1192,14 +1194,14 @@ void HelpGenVisitor::VisitTypeDef( spTypeDef& td )
     }
 
     wxString typedefdoc;
     }
 
     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 ) {
                << 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';
         }
 
             m_textStoredTypedefs << '\n';
         }
 


@@ -1298,7 +1300,7 @@ void HelpGenVisitor::VisitOperation( spOperation& op )
                       "\\%sfunc{%s%s}{%s}{",
                       op.mIsConstant ? "const" : "",
                       op.mIsVirtual ? "virtual " : "",
                       "\\%sfunc{%s%s}{%s}{",
                       op.mIsConstant ? "const" : "",
                       op.mIsVirtual ? "virtual " : "",

-                      op.mRetType.c_str(),
+                      op.m_RetType.c_str(),

                       funcname.c_str());
     m_textFunc += func;
 }
                       funcname.c_str());
     m_textFunc += func;
 }


@@ -1315,9 +1317,9 @@ void HelpGenVisitor::VisitParameter( spParameter& param )
         m_textFunc << ", ";
     }
 
         m_textFunc << ", ";
     }
 

-    m_textFunc << "\\param{" << param.mType << " }{" << param.GetName();
+    m_textFunc << "\\param{" << param.m_Type << " }{" << param.GetName();

     wxString defvalue = param.mInitVal;
     wxString defvalue = param.mInitVal;

-    if ( !defvalue.IsEmpty() ) {
+    if ( !defvalue.empty() ) {

         m_textFunc << " = " << defvalue;
     }
 
         m_textFunc << " = " << defvalue;
     }
 


@@ -1388,7 +1390,7 @@ wxString DocManager::ExtractStringBetweenBraces(const char **pp)
 
     if ( !SkipSpaceUntil(pp, '{') ) {
         wxLogWarning("file %s(%d): '{' expected after '\\param'",
 
     if ( !SkipSpaceUntil(pp, '{') ) {
         wxLogWarning("file %s(%d): '{' expected after '\\param'",

-                     m_filename.c_str(), m_line);
+                     m_filename.c_str(), (int)m_line);

 
     }
     else {
 
     }
     else {


@@ -1396,7 +1398,7 @@ wxString DocManager::ExtractStringBetweenBraces(const char **pp)
 
         if ( !SkipUntil(pp, '}') ) {
             wxLogWarning("file %s(%d): '}' expected after '\\param'",
 
         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);
         }
         else {
             result = wxString(startParam, (*pp)++ - startParam);


@@ -1494,7 +1496,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
         if ( !SkipSpaceUntil(&current, '{') ) {
             wxLogWarning("file %s(%d): '{' expected after \\func, "
                          "\\constfunc or \\membersection.",
         if ( !SkipSpaceUntil(&current, '{') ) {
             wxLogWarning("file %s(%d): '{' expected after \\func, "
                          "\\constfunc or \\membersection.",

-                         m_filename.c_str(), m_line);
+                         m_filename.c_str(), (int)m_line);

 
             continue;
         }
 
             continue;
         }


@@ -1506,7 +1508,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
             const char *startClass = current;
             if ( !SkipUntil(&current, ':') || *(current + 1) != ':' ) {
                 wxLogWarning("file %s(%d): '::' expected after "
             const char *startClass = current;
             if ( !SkipUntil(&current, ':') || *(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);
             }
             else {
                 classname = wxString(startClass, current - startClass);


@@ -1521,7 +1523,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
 
         if ( !SkipUntil(&current, '}') ) {
             wxLogWarning("file %s(%d): '}' expected after return type",
 
         if ( !SkipUntil(&current, '}') ) {
             wxLogWarning("file %s(%d): '}' expected after return type",

-                         m_filename.c_str(), m_line);
+                         m_filename.c_str(), (int)m_line);

 
             continue;
         }
 
             continue;
         }


@@ -1532,7 +1534,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
         current++;
         if ( !SkipSpaceUntil(&current, '{') ) {
             wxLogWarning("file %s(%d): '{' expected after return type",
         current++;
         if ( !SkipSpaceUntil(&current, '{') ) {
             wxLogWarning("file %s(%d): '{' expected after return type",

-                         m_filename.c_str(), m_line);
+                         m_filename.c_str(), (int)m_line);

 
             continue;
         }
 
             continue;
         }


@@ -1541,7 +1543,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
         const char *funcEnd = current;
         if ( !SkipUntil(&funcEnd, '}') ) {
             wxLogWarning("file %s(%d): '}' expected after function name",
         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;
         }
 
             continue;
         }


@@ -1570,7 +1572,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
             size_t len = strlen("\\destruct{");
             if ( funcName(0, len) != "\\destruct{" ) {
                 wxLogWarning("file %s(%d): \\destruct expected",
             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;
             }
 
                 continue;
             }


@@ -1580,7 +1582,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
 
             if ( !SkipSpaceUntil(&current, '}') ) {
                 wxLogWarning("file %s(%d): '}' expected after destructor",
 
             if ( !SkipSpaceUntil(&current, '}') ) {
                 wxLogWarning("file %s(%d): '}' expected after destructor",

-                             m_filename.c_str(), m_line);
+                             m_filename.c_str(), (int)m_line);

 
                 continue;
             }
 
                 continue;
             }


@@ -1595,7 +1597,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
         if ( !SkipSpaceUntil(&current, '{') ||
              (current++, !SkipSpaceUntil(&current, '\\')) ) {
             wxLogWarning("file %s(%d): '\\param' or '\\void' expected",
         if ( !SkipSpaceUntil(&current, '{') ||
              (current++, !SkipSpaceUntil(&current, '\\')) ) {
             wxLogWarning("file %s(%d): '\\param' or '\\void' expected",

-                         m_filename.c_str(), m_line);
+                         m_filename.c_str(), (int)m_line);

 
             continue;
         }
 
             continue;
         }


@@ -1613,9 +1615,9 @@ bool DocManager::ParseTeXFile(const wxString& filename)
 
                 // now come {paramtype}{paramname}
                 wxString paramType = ExtractStringBetweenBraces(&current);
 
                 // now come {paramtype}{paramname}
                 wxString paramType = ExtractStringBetweenBraces(&current);

-                if ( !!paramType ) {
+                if ( !paramType.empty() ) {

                     wxString paramText = ExtractStringBetweenBraces(&current);
                     wxString paramText = ExtractStringBetweenBraces(&current);

-                    if ( !!paramText ) {
+                    if ( !paramText.empty() ) {

                         // the param declaration may contain default value
                         wxString paramName = paramText.BeforeFirst('='),
                                  paramValue = paramText.AfterFirst('=');
                         // the param declaration may contain default value
                         wxString paramName = paramText.BeforeFirst('='),
                                  paramValue = paramText.AfterFirst('=');


@@ -1652,7 +1654,7 @@ bool DocManager::ParseTeXFile(const wxString& filename)
                 }
                 else {
                     wxLogWarning("file %s(%d): ',' or '}' expected after "
                 }
                 else {
                     wxLogWarning("file %s(%d): ',' or '}' expected after "

-                                 "'\\param'", m_filename.c_str(), m_line);
+                                 "'\\param'", m_filename.c_str(), (int)m_line);

 
                     continue;
                 }
 
                     continue;
                 }


@@ -1661,7 +1663,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",
             // 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;
             }
 
                 continue;
             }


@@ -1678,13 +1680,18 @@ bool DocManager::ParseTeXFile(const wxString& filename)
             paramsAll << paramTypes[param] << ' ' << paramNames[param];
         }
 
             paramsAll << paramTypes[param] << ' ' << paramNames[param];
         }
 

+        wxString constStr;
+        if (foundCommand == ConstFunc)
+            constStr = _T(" const");
+

         wxLogVerbose("file %s(%d): found '%s %s::%s(%s)%s'",
         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(),
                      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;
 
         // store the info about the just found function
         ArrayMethodInfo *methods;


@@ -1748,7 +1755,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const
         }
 
         spClass *ctxClass = (spClass *)ctx;
         }
 
         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) ) {
         int index = m_classes.Index(nameClass);
         if ( index == wxNOT_FOUND ) {
             if ( !m_ignoreNames.IgnoreClass(nameClass) ) {


@@ -1784,7 +1791,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const
                 continue;
 
             spOperation *ctxMethod = (spOperation *)ctx;
                 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;
 
             // find all functions with the same name
             wxArrayInt aMethodsWithSameName;


@@ -1847,7 +1854,7 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const
                                "in the docs: should be %d instead of %d.",
                                nameClass.c_str(),
                                nameMethod.c_str(),
                                "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;
                 }
                 else {
                     size_t nParam = 0;


@@ -1862,39 +1869,39 @@ bool DocManager::DumpDifferences(spContext *ctxTop) const
                         spParameter *ctxParam = (spParameter *)ctx;
                         const ParamInfo& param = method.GetParam(nParam);
                         if ( m_checkParamNames &&
                         spParameter *ctxParam = (spParameter *)ctx;
                         const ParamInfo& param = method.GetParam(nParam);
                         if ( m_checkParamNames &&

-                             (param.GetName() != ctxParam->mName) ) {
+                             (param.GetName() != ctxParam->m_Name.c_str()) ) {

                             foundDiff = true;
 
                             wxLogError("Parameter #%d of '%s::%s' should be "
                                        "'%s' and not '%s'.",
                             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(),
                                        nameClass.c_str(),
                                        nameMethod.c_str(),

-                                       ctxParam->mName.c_str(),
+                                       ctxParam->m_Name.c_str(),

                                        param.GetName().c_str());
 
                             continue;
                         }
 
                                        param.GetName().c_str());
 
                             continue;
                         }
 

-                        if ( param.GetType() != ctxParam->mType ) {
+                        if ( param.GetType() != ctxParam->m_Type ) {

                             foundDiff = true;
 
                             wxLogError("Type of parameter '%s' of '%s::%s' "
                                        "should be '%s' and not '%s'.",
                             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(),
                                        nameClass.c_str(),
                                        nameMethod.c_str(),

-                                       ctxParam->mType.c_str(),
+                                       ctxParam->m_Type.c_str(),

                                        param.GetType().GetName().c_str());
 
                             continue;
                         }
 
                                        param.GetType().GetName().c_str());
 
                             continue;
                         }
 

-                        if ( param.GetDefValue() != ctxParam->mInitVal ) {
+                        if ( param.GetDefValue() != ctxParam->mInitVal.c_str() ) {

                             wxLogWarning("Default value of parameter '%s' of "
                                          "'%s::%s' should be '%s' and not "
                                          "'%s'.",
                             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(),
                                          nameClass.c_str(),
                                          nameMethod.c_str(),
                                          ctxParam->mInitVal.c_str(),


@@ -2157,7 +2164,7 @@ static wxString GetAllComments(const spContext& ctx)
 
         // don't take comments like "// ----------" &c
         comment.Trim(false);
 
         // don't take comments like "// ----------" &c
         comment.Trim(false);

-        if ( !!comment &&
+        if ( !comment.empty() &&

               comment == wxString(comment[0u], comment.length() - 1) + '\n' )
             comments << "\n";
         else
               comment == wxString(comment[0u], comment.length() - 1) + '\n' )
             comments << "\n";
         else


@@ -2190,6 +2197,24 @@ static const wxString GetVersionString()
 
 /*
    $Log$
 
 /*
    $Log$

+   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.35  2004/12/12 11:03:31  VZ
    give an error message if we're built in Unicode mode (in response to bug 1079224)