cppcheck 为宏查找“冗余代码：找到以数字常量开头的语句”

Posted 2023-02-16

【中文标题】cppcheck 为宏查找“冗余代码：找到以数字常量开头的语句”

【英文标题】：cppcheck finding "redundant code: found a statement that begins with numeric constant" for macro

【发布时间】：2015-09-17 13:52:59

【问题描述】：

我们正在尝试使用 cppcheck 对使用 jenkins 插件的 linux 代码库进行静态分析。出于某种原因，它发现了以下类型的许多错误：

CREATE_DERIVED_EXCEPTION_CLASS(ExceptionOSApiError, 5)

还有：

CREATE_EXCEPTION_CLASS_DERIVED_FROM_SPECIFIC_BASE(ExceptionFileApiError, ExceptionOSApiError, 6)

它被定义为（但没有给出错误的行）：

#define CREATE_DERIVED_EXCEPTION_CLASS( new_exception_name, unique_numeric_code ) \
    CREATE_EXCEPTION_CLASS_DERIVED_FROM_SPECIFIC_BASE( new_exception_name, Exception, unique_numeric_code )

#ifdef _IN_EXCEPTION_CPP

    #define CREATE_EXCEPTION_CLASS_DERIVED_FROM_SPECIFIC_BASE( new_exception_name, base_exception_name, unique_numeric_code ) \
        new_exception_name::new_exception_name( const char *message, LASTERROR_TYPE lastError, const IDebugContext& debugContextWhereThrown ) \
            : base_exception_name( message, lastError, debugContextWhereThrown )  \
        new_exception_name::new_exception_name( std::string&& message, LASTERROR_TYPE lastError, const IDebugContext& debugContextWhereThrown ) \
            : base_exception_name( std::move(message), lastError, debugContextWhereThrown )  \
        new_exception_name::new_exception_name( LASTERROR_TYPE lastError, const IDebugContext& debugContextWhereThrown ) \
            : base_exception_name( lastError, debugContextWhereThrown )  \
        new_exception_name::new_exception_name(new_exception_name&& source) \
            : base_exception_name(std::move(source))  \
        new_exception_name& new_exception_name::operator=(new_exception_name&& rightHandSide) \
             \
                if (this != &rightHandSide) \
                 \
                    base_exception_name::operator=(std::move(rightHandSide)); \
                    /* No derived class data members to move */ \
                 \
                return(*this); \
             \
        UTILDLL_EXPORT int new_exception_name::getExceptionTypeByNumericCode() const \
             \
               return( unique_numeric_code ); /* This must be UNIQUE! */ \
            

#else // !_IN_CPEXCEPTION_CPP
#define CREATE_EXCEPTION_CLASS_DERIVED_FROM_SPECIFIC_BASE( new_exception_name, base_exception_name, unique_numeric_code ) \
    class UTILDLL_EXPORT new_exception_name : public base_exception_name \
     \
    public: \
        new_exception_name( const char *message, LASTERROR_TYPE lastError, const IDebugContext& debugContextWhereThrown ); \
        new_exception_name( std::string&& message, LASTERROR_TYPE lastError, const IDebugContext& debugContextWhereThrown ); \
        new_exception_name( LASTERROR_TYPE lastError, const IDebugContext& debugContextWhereThrown ); \
        new_exception_name( const new_exception_name& source ) = default; \
        new_exception_name& operator=(const new_exception_name& rightHandSide) = default; \
        new_exception_name(new_exception_name&& source); \
        new_exception_name& operator=(new_exception_name&& rightHandSide); \
        virtual ~new_exception_name() = default; \
        virtual int getExceptionTypeByNumericCode() const; \
    ;
#endif // !_IN_EXCEPTION_CPP

有什么想法吗？

我在网上找到了这类信息： redundant with pragma once ==（看起来 cppcheck 和 #pragma once 存在一个已知问题（#ifndef #define 是解决方法，但我认为我们不希望这样做）。我想如果它出现，我们会看到更多这个问题曾经是#pragma。

下面是冗余代码问题的第二个简介： enum or ifndef for redundant code issue ==（我认为这不是枚举问题）（可能是我们没有 #ifndef #define the .h ...我没看到） cppcheck 认为我有“冗余代码：找到以数字常量开头的语句”

定义这些的整个 .h 文件仅包含宏和宏的使用。所有者认为他不需要在#define 周围加上#ifndef，因为cppcheck 抱怨#define 下所有使用宏的行。

另外：整个.h文件周围没有#ifndef，但所有者认为不需要。

构建信息： 对于我们的正常构建：

g++ -std=c++11 -ggdb -Wall -Wextra -Werror -pedantic -fdiagnostic-show-option -fPIC -DLinuxx86_64

我在 jenkins 中看到的 cppcheck 设置：

cppcheck --enable=all --xml --xml-version=2 -DLinuxx86_64 --platform=unix64 --include=Src/Headers/CommonPrecomp.h -v --report-progress -DOPTIMUS_CDECL -DUTILDLL_EXPORT -DOPTIMUS_COREDLL_EXPORT -DREADERDLL_EXPORT -DWRITERDLL_EXPORT -E Src 2> cppcheck.xml

我不确定它在 jenkins 中对 cppcheck 的构建是否与我们正常构建的相同。

还有其他想法吗？谢谢！

【问题讨论】：

我们还需要CREATE_EXCEPTION_CLASS_DERIVED_FROM_SPECIFIC_BASE 定义来锻炼生成的代码。还可以尝试保留预处理文件（如果宏扩展过于复杂）。

看不到unique_numeric_code 的使用位置。这不仅仅是观察的问题。

我在原始问题的上方添加了 CREATE_EXCEPTION_CLASS_DERIVED_FROM_SPECIFIC_BASE。

我刚刚找到#else 的更多信息并将其添加到代码部分。

尝试使用 gcc 的 -E 开关编译您的代码，以扩展所有预处理器宏（其他编译器可能有类似的开关），并在生成的文件上运行 cppcheck。

【参考方案1】：

看起来问题在于它没有进入我们的包含目录。我们让他们从档案中带进来。我们必须将它们添加到 jenkins 构建设置中：

cppcheck -j 2 --xml --xml-version=1 --enable=all -DLinuxx86_64 --platform=unix64 -v --report-progress --suppress=missingIncludeSystem --include=Sr/Head/Common.h -i Sr/Doc/Win.cpp -i Sr/P/S/S.cpp -DOPT_CDECL -DUTILDLL_EXPORT -DOPT_COREDLL_EXPORT -DREADLL_EXPORT -DWDLL_EXPORT -ISr/Head -ISr/Head/libopc -ISr/Head/lib/config -ISrc/Head/lib/lib2 -ISr/Snot -ISr/Doc -ISr/Doc -ISr/PDers/XP -ISr/PDers/Ca -ISr/PDers/Ca/Head -IVersionAndBuildConfig -ISr/Head/GoogleTest/include -ISr/Head/GoogleTest/include/gtest Sr/Doc > cppcheck.xml