added various TODOs [skip ci] (danmar#6897)

Author: firewave

.github/workflows/scriptcheck.yml

@@ -58,6 +58,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      # TODO: bailout on error
       - name: Restore Cppcheck
         uses: actions/cache@v4
         with:

CMakeLists.txt

@@ -69,6 +69,12 @@ if(LIBXML2_XMLLINT_EXECUTABLE)
     add_custom_target(validateRules ${LIBXML2_XMLLINT_EXECUTABLE} --noout ${CMAKE_SOURCE_DIR}/rules/*.xml)
 endif()
 
+# TODO: add the following Makefile features:
+# - "man/cppcheck.1" target
+# - "tags" target
+# - Cygwin handling
+# - MinGW handling
+
 if(BUILD_TESTS)
     enable_testing()
 endif()

addons/naming.py

@@ -37,6 +37,7 @@ def validate_regex(expr):
     elif arg[:11] == '--function=':
         RE_FUNCTIONNAME = arg[11:]
         validate_regex(RE_FUNCTIONNAME)
+    # TODO: bail out on unknown parameter
 
 
 def reportError(token, severity, msg, errorId):

cli/cmdlineparser.cpp

@@ -1094,6 +1094,7 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
             // --project-configuration
             else if (std::strncmp(argv[i], "--project-configuration=", 24) == 0) {
                 mVSConfig = argv[i] + 24;
+                // TODO: provide error when this does nothing
                 if (!mVSConfig.empty() && (project.projectType == ImportProject::Type::VS_SLN || project.projectType == ImportProject::Type::VS_VCXPROJ))
                     project.ignoreOtherConfigs(mVSConfig);
             }

gui/projectfile.h

@@ -224,6 +224,7 @@ class ProjectFile : public QObject {
     QStringList getAddonsAndTools() const;
 
     bool getClangAnalyzer() const {
+        // TODO
         return false; //mClangAnalyzer;
     }
 

lib/check.cpp

@@ -63,6 +63,7 @@ void Check::writeToErrorList(const ErrorMessage &errmsg)
 
 void Check::reportError(const std::list<const Token *> &callstack, Severity severity, const std::string &id, const std::string &msg, const CWE &cwe, Certainty certainty)
 {
+    // TODO: report debug warning when error is for a disabled severity
     const ErrorMessage errmsg(callstack, mTokenizer ? &mTokenizer->list : nullptr, severity, id, msg, cwe, certainty);
     if (mErrorLogger)
         mErrorLogger->reportErr(errmsg);
@@ -72,6 +73,7 @@ void Check::reportError(const std::list<const Token *> &callstack, Severity seve
 
 void Check::reportError(const ErrorPath &errorPath, Severity severity, const char id[], const std::string &msg, const CWE &cwe, Certainty certainty)
 {
+    // TODO: report debug warning when error is for a disabled severity
     const ErrorMessage errmsg(errorPath, mTokenizer ? &mTokenizer->list : nullptr, severity, id, msg, cwe, certainty);
     if (mErrorLogger)
         mErrorLogger->reportErr(errmsg);

lib/cppcheck.cpp

@@ -493,14 +493,14 @@ unsigned int CppCheck::checkClang(const FileWithDetails &file)
             reportErr(errorMessage);
         };
         if (reportClangErrors(fin, reportError, compilerWarnings))
-            return 0;
+            return 0; // TODO: report as failure?
     } else {
         std::istringstream istr(output2);
         auto reportError = [this](const ErrorMessage& errorMessage) {
             reportErr(errorMessage);
         };
         if (reportClangErrors(istr, reportError, compilerWarnings))
-            return 0;
+            return 0; // TODO: report as failure?
     }
 
     if (!mSettings.buildDir.empty()) {
@@ -1056,6 +1056,7 @@ void CppCheck::checkNormalTokens(const Tokenizer &tokenizer)
     CheckUnusedFunctions unusedFunctionsChecker;
 
     // TODO: this should actually be the behavior if only "--enable=unusedFunction" is specified - see #10648
+    // TODO: log message when this is active?
     const char* unusedFunctionOnly = std::getenv("UNUSEDFUNCTION_ONLY");
     const bool doUnusedFunctionOnly = unusedFunctionOnly && (std::strcmp(unusedFunctionOnly, "1") == 0);
 

lib/path.cpp

@@ -61,6 +61,7 @@ static constexpr bool caseInsensitiveFilesystem()
     return true;
 #else
     // TODO: Non-windows filesystems might be case insensitive
+    // needs to be determined per filesystem and location - e.g. /sys/fs/ext4/features/casefold
     return false;
 #endif
 }

lib/symboldatabase.cpp

@@ -2320,7 +2320,6 @@ void Variable::evaluate(const Settings& settings)
 
     const Library & lib = settings.library;
 
-    // TODO: ValueType::parseDecl() is also performing a container lookup
     bool isContainer = false;
     if (mNameToken)
         setFlag(fIsArray, arrayDimensions(settings, isContainer));

lib/tokenize.cpp

@@ -1180,6 +1180,7 @@ void Tokenizer::simplifyTypedef()
     simplifyTypedefCpp();
 }
 
+// TODO: rename - it is not C++ specific
 void Tokenizer::simplifyTypedefCpp()
 {
     const bool cpp = isCPP();
@@ -3477,6 +3478,7 @@ bool Tokenizer::simplifyTokens1(const std::string &configuration)
 
     // TODO: apply this through Settings::ValueFlowOptions
     // TODO: do not run valueflow if no checks are being performed at all - e.g. unusedFunctions only
+    // TODO: log message when this is active?
     const char* disableValueflowEnv = std::getenv("DISABLE_VALUEFLOW");
     const bool doValueFlow = !disableValueflowEnv || (std::strcmp(disableValueflowEnv, "1") != 0);