c++ - 评估C++头文件中的所有宏

我需要构建一个自动化系统，以分析其中包含许多#define语句的C++ .h文件，并使用每个#define的值进行处理。 .h文件中除了#define语句外，还有很多其他垃圾。

目的是创建一个键值列表，其中键是#define语句定义的所有关键字，而值是对应于这些定义的宏的求值。 #defines用一系列嵌套的宏定义关键字，这些宏最终解析为编译时整数常量。有些不能解析为编译时整数常量，因此必须跳过这些常量。

.h文件将随着时间的推移而发展，因此该工具不能是将实例化为等于每个关键字的变量的长硬编码程序。我无法控制.h文件的内容。唯一的保证是可以使用标准的C++编译器来构建它，并且将添加但不删除更多的#defines。宏公式可以随时更改。

我为此看到的选项是:

实现部分(或挂接到现有)C++编译器，并在预处理器步骤中拦截宏的值。

使用正则表达式动态生成将消耗当前定义的所有宏的源文件，然后编译并执行源文件以获取所有宏的评估形式。不知何故(？)跳过了不对编译时整数常量求值的宏。 (另外，不确定正则表达式是否具有足够的表现力来捕获所有可能的多行宏定义)

这两种方法都会为该项目的构建过程增加相当大的复杂性和脆弱性，我想避免这种情况。有没有更好的方法来评估C++ .h文件中的所有#define宏？

以下是我要解析的示例:

#ifndef Constants_h
#define Constants_h

namespace Foo
{
#define MAKE_CONSTANT(A, B) (A | (B << 4))
#define MAGIC_NUMBER_BASE 40
#define MAGIC_NUMBER MAGIC_NUMBER_BASE + 0x2
#define MORE_MAGIC_1 345
#define MORE_MAGIC_2 65


    // Other stuff...


#define CONSTANT_1 MAKE_CONSTANT (MAGIC_NUMBER + 564, MORE_MAGIC_1 | MORE_MAGIC_2)
#define CONSTANT_2 MAKE_CONSTANT (MAGIC_NUMBER - 84, MORE_MAGIC_1 & MORE_MAGIC_2 ^ 0xA)
    // etc...

#define SKIP_CONSTANT "What?"

    // More CONSTANT_N mixed with more other stuff and constants which do
    // not resolve to compile-time integers and must be skipped


}

#endif Constants_h

我需要摆脱的是解析为编译时整数常量的所有定义的名称和评估。在这种情况下，对于所示的定义，它将是

MAGIC_NUMBER_BASE 40
MAGIC_NUMBER 42
MORE_MAGIC_1 345
MORE_MAGIC_2 65
CONSTANT_1 1887
CONSTANT_2 -42

只要我可以使用它，只要管道后面的键值对列表就可以了，那么输出的格式并不重要。

最佳答案

一种方法是编写“程序生成器”，该程序生成包含诸如std::cout << "MAGIC_NUMBER" << " " << (MAGIC_NUMBER_BASE + 0x2) << std::endl;之类的语句的程序(printDefines程序)。显然，执行这样的语句将解析相应的宏并打印出它们的值。

头文件中的宏列表可以通过带有g++ cout`语句的-dM -E' option. Feeding this "program generator" with such a list of #defines will generate a "printDefines.cpp" with all the required获得。编译并执行生成的printDefines程序，然后产生最终输出。它将解析所有宏，包括那些本身使用其他宏的宏。

请参阅下面的shell脚本和下面的程序生成器代码，它们一起实现了此方法:

脚本在“someHeaderfile.h”中打印#define语句的值:

#  printDefines.sh
g++ -std=c++11 -dM -E someHeaderfile.h > defines.txt
./generateDefinesCpp someHeaderfile.h defines.txt > defines.cpp
g++ -std=c++11 -o defines.o defines.cpp
./defines.o

程序生成器“generateDefinesCpp”的代码:

#include <stdio.h>
#include <string>
#include <iostream>
#include <fstream>
#include <cstring>

using std::cout;
using std::endl;

/*
 * Argument 1: name of the headerfile to scan
 * Argument 2: name of the cpp-file to generate
 * Note: will crash if parameters are not provided.
 */
int main(int argc, char* argv[])
{
    cout << "#include<iostream>" << endl;
    cout << "#include<stdio.h>" << endl;
    cout << "#include \"" << argv[1] << "\"" << endl;
    cout << "int main() {" << endl;
    std::ifstream headerFile(argv[2], std::ios::in);
    std::string buffer;
    char macroName[1000];
    int macroValuePos;
    while (getline(headerFile,buffer)) {
        const char *bufferCStr = buffer.c_str();
        if (sscanf(bufferCStr, "#define %s %n", macroName, &macroValuePos) == 1) {
            const char* macroValue = bufferCStr+macroValuePos;
            if (macroName[0] != '_' && strchr(macroName, '(') == NULL  && *macroValue) {
                cout << "std::cout << \"" << macroName << "\" << \" \" << (" << macroValue << ") << std::endl;" << std::endl;
            }
        }
    }
    cout << "return 0; }" << endl;

    return 0;
}

可以优化该方法，从而不需要中间文件defines.txt和defines.cpp；但是，出于演示目的，它们很有帮助。当应用于头文件时，defines.txt和defines.cpp的内容如下:

define.txt:

#define CONSTANT_1 MAKE_CONSTANT (MAGIC_NUMBER + 564, MORE_MAGIC_1 | MORE_MAGIC_2)
#define CONSTANT_2 MAKE_CONSTANT (MAGIC_NUMBER - 84, MORE_MAGIC_1 & MORE_MAGIC_2 ^ 0xA)
#define Constants_h
#define MAGIC_NUMBER MAGIC_NUMBER_BASE + 0x2
#define MAGIC_NUMBER_BASE 40
#define MAKE_CONSTANT(A,B) (A | (B << 4))
#define MORE_MAGIC_1 345
#define MORE_MAGIC_2 65
#define OBJC_NEW_PROPERTIES 1
#define SKIP_CONSTANT "What?"
#define _LP64 1
#define __APPLE_CC__ 6000
#define __APPLE__ 1
#define __ATOMIC_ACQUIRE 2
#define __ATOMIC_ACQ_REL 4
...

define.cpp:

#include<iostream>
#include<stdio.h>
#include "someHeaderfile.h"
int main() {
std::cout << "CONSTANT_1" << " " << (MAKE_CONSTANT (MAGIC_NUMBER + 564, MORE_MAGIC_1 | MORE_MAGIC_2)) << std::endl;
std::cout << "CONSTANT_2" << " " << (MAKE_CONSTANT (MAGIC_NUMBER - 84, MORE_MAGIC_1 & MORE_MAGIC_2 ^ 0xA)) << std::endl;
std::cout << "MAGIC_NUMBER" << " " << (MAGIC_NUMBER_BASE + 0x2) << std::endl;
std::cout << "MAGIC_NUMBER_BASE" << " " << (40) << std::endl;
std::cout << "MORE_MAGIC_1" << " " << (345) << std::endl;
std::cout << "MORE_MAGIC_2" << " " << (65) << std::endl;
std::cout << "OBJC_NEW_PROPERTIES" << " " << (1) << std::endl;
std::cout << "SKIP_CONSTANT" << " " << ("What?") << std::endl;
return 0; }

然后执行defines.o的输出为:

CONSTANT_1 1887
CONSTANT_2 -9
MAGIC_NUMBER 42
MAGIC_NUMBER_BASE 40
MORE_MAGIC_1 345
MORE_MAGIC_2 65
OBJC_NEW_PROPERTIES 1
SKIP_CONSTANT What?