c++ - 计算 C++ 头文件中的所有宏

Question

我需要构建一个自动化系统来解析包含大量 #define 的 C++ .h 文件其中的语句并使用每个 #define 的值做一些事情工作到。除了 #define 之外，.h 文件中还有很多其他垃圾。声明。

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

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

我看到的选项是:

1. 实现部分(或连接到现有的)C++ 编译器并在预处理器步骤中拦截宏的值。
2. 使用正则表达式动态构建一个源文件，该文件将使用当前定义的所有宏，然后编译并执行源文件以获得所有宏的评估形式。不知何故(？)跳过不计算为编译时整数常量的宏。 (另外，不确定正则表达式是否足够表达以捕获所有可能的多行宏定义)

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

下面是我要解析的示例:

#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

只要我可以将它作为键值对列表在管道中进一步处理，这个输出的格式并不重要。

Answer 1

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

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

请参阅以下共同实现此方法的 shell 脚本和以下程序生成器代码:

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

#  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将如下所示:

定义.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
...

定义.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?