如何用Java CDT解析器提取C头文件宏定义的名称与值并输出

问题描述 #

我有一个包含若干值定义宏的C头文件header.h，示例代码如下：

#define MACRO1 value1
#define MACRO2 value2

我希望用Java CDT解析器解析这些宏，提取宏的名称和对应值并存入Map，最终遍历Map输出如下格式：

MACRO1 = value1
MACRO2 = value2

但查阅资料后仅找到提取宏名称的方法，求完整实现方案。

实现方案 #

1. 添加CDT依赖 #

如果使用Maven构建项目，在pom.xml中加入以下依赖（版本可根据实际环境调整）：

<dependency>
    <groupId>org.eclipse.cdt</groupId>
    <artifactId>org.eclipse.cdt.core</artifactId>
    <version>11.0.0</version>
</dependency>
<dependency>
    <groupId>org.eclipse.cdt</groupId>
    <artifactId>org.eclipse.cdt.core.parser</artifactId>
    <version>11.0.0</version>
</dependency>

2. 核心解析代码 #

以下是完整的Java实现，包含文件读取、宏提取、结果输出全流程：

import org.eclipse.cdt.core.CCorePlugin;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorDefineStatement;
import org.eclipse.cdt.core.dom.ast.IASTPreprocessorStatement;
import org.eclipse.cdt.core.dom.ast.gnu.cpp.GPPLanguage;
import org.eclipse.cdt.core.dom.parser.IScannerExtensionConfiguration;
import org.eclipse.cdt.core.dom.parser.cpp.GPPScannerExtensionConfiguration;
import org.eclipse.cdt.core.index.IIndex;
import org.eclipse.cdt.core.parser.*;
import org.eclipse.cdt.core.parser.util.CharArrayUtils;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;

public class CMacroParser {
    public static void main(String[] args) throws IOException {
        // 替换为你的头文件路径
        File headerFile = new File("path/to/your/header.h");
        Map<String, String> macroMap = extractMacros(headerFile);

        // 按要求格式输出宏定义
        for (Map.Entry<String, String> entry : macroMap.entrySet()) {
            System.out.printf("%s = %s%n", entry.getKey(), entry.getValue());
        }
    }

    private static Map<String, String> extractMacros(File headerFile) throws IOException {
        Map<String, String> macroMap = new HashMap<>();

        // 读取头文件内容为字符数组
        byte[] fileBytes = new byte[(int) headerFile.length()];
        try (FileInputStream fis = new FileInputStream(headerFile)) {
            fis.read(fileBytes);
        }
        char[] fileContent = new String(fileBytes, StandardCharsets.UTF_8).toCharArray();

        // 配置CDT预处理器
        IScannerExtensionConfiguration scannerConfig = GPPScannerExtensionConfiguration.getInstance();
        IIndex emptyIndex = CCorePlugin.getIndexManager().getEmptyIndex();
        ParserLanguage language = ParserLanguage.CPP;
        int parserOptions = IParserSettings.SCAN_FOR_INCLUDES | IParserSettings.EVALUATE_INCLUDES;

        // 创建预处理器实例
        IPreprocessor preprocessor = GPPLanguage.getDefault().createPreprocessor(
            new DefaultLogService(),
            emptyIndex,
            scannerConfig,
            language,
            parserOptions
        );

        // 设置预处理器输入
        preprocessor.setInput(new StringCharArray(fileContent, headerFile.getAbsolutePath()));

        // 遍历预处理语句，提取宏定义
        IASTPreprocessorStatement stmt;
        while ((stmt = preprocessor.next()) != null) {
            if (stmt instanceof IASTPreprocessorDefineStatement) {
                IASTPreprocessorDefineStatement defineStmt = (IASTPreprocessorDefineStatement) stmt;
                String macroName = defineStmt.getName().toString();
                // 提取宏值，去除首尾空格
                char[] macroValueChars = defineStmt.getBody();
                String macroValue = macroValueChars != null ? CharArrayUtils.toString(macroValueChars).trim() : "";
                macroMap.put(macroName, macroValue);
            }
        }

        return macroMap;
    }
}

3. 关键说明 #

• 代码针对无参数的宏定义设计，若需处理带参数的宏（如#define ADD(a,b) (a+b)），可通过defineStmt.getParameters()方法单独提取参数列表，再结合getBody()获取宏体内容。
• 预处理器配置为C++解析模式，完全兼容C头文件的语法规则。
• 读取文件时使用UTF-8编码，若你的头文件使用其他编码，需对应调整字符集。

内容的提问来源于stack exchange，提问作者hyvuonggia