如何使用libclang获取C++废弃属性的原因文本

优先方案：直接从DeprecatedAttr提取消息 #

你遇到的核心问题是InheritableAttr基类未暴露废弃消息属性，但对应具体类型DeprecatedAttr（匹配CX_AttrKind_Deprecated）可通过ClangSharp封装属性或原生libclang API获取消息。

修改你的C#代码如下：

using ClangSharp;
using ClangSharp.Interop;

string GetDeprecatedText(Decl decl)
{
    foreach (Attr attribute in decl.Attrs)
    {
        if (attribute.Kind == CX_AttrKind.CX_AttrKind_Deprecated)
        {
            // 尝试强转为具体的DeprecatedAttr类型
            if (attribute is DeprecatedAttr deprecatedAttr)
            {
                // ClangSharp 16+版本可能已封装Message属性
                return deprecatedAttr.Message?.ToString();
            }
            // 若未封装，直接调用libclang原生API
            unsafe
            {
                CXAttr cxAttr = (CXAttr)attribute.Handle;
                CXString cxMessage = clang_getDeprecatedAttrMessage(cxAttr);
                string message = cxMessage.ToString();
                clang_disposeString(cxMessage); // 必须释放CXString避免内存泄漏
                return message;
            }
        }
    }
    return null;
}

说明 #

• ClangSharp对libclang的API封装可能存在滞后，若DeprecatedAttr.Message不存在，直接调用原生clang_getDeprecatedAttrMessage是可靠方案。
• 务必调用clang_disposeString释放返回的CXString，防止内存泄漏。

备选方案：通过源码位置与宏展开获取文本 #

如果直接从属性获取失败，可通过以下步骤处理宏展开的文本：

1. 从源码位置提取原始文本 #

无需自行读取文件，利用Clang的源码范围API直接提取属性位置的文本：

unsafe string GetTextFromSourceRange(SourceLocation startLoc, SourceLocation endLoc, TranslationUnit tu)
{
    CXSourceRange cxRange = clang_getRange((CXSourceLocation)startLoc.Handle, (CXSourceLocation)endLoc.Handle);
    CXString cxText = clang_getRangeSpelling(tu.Handle, cxRange);
    string text = cxText.ToString();
    clang_disposeString(cxText);
    return text;
}

// 使用示例：遍历Attr时调用
if (attribute.Kind == CX_AttrKind.CX_AttrKind_Deprecated)
{
    string rawAttrText = GetTextFromSourceRange(attribute.Location, attribute.EndLocation, decl.TranslationUnit);
    // 此时rawAttrText为宏名（如"DEPRECATED_ENUM"），需进一步展开
}

2. 展开宏获取完整文本 #

找到宏定义后，通过预处理器递归展开所有嵌套宏：

unsafe string GetFullyExpandedMacro(MacroDefinitionRecord macroDef, Preprocessor pp)
{
    // 获取宏的原始定义体
    CXString cxMacroBody = clang_getMacroDefinitionSpelling((CXMacroDefinition)macroDef.Handle);
    string macroBody = cxMacroBody.ToString();
    clang_disposeString(cxMacroBody);

    // 分词并递归展开嵌套宏
    using Lexer lexer = Lexer.Create(macroDef.Location, pp.TranslationUnit, macroDef.SourceFile);
    System.Text.StringBuilder expandedText = new();
    Token token;

    while (lexer.Lex(out token))
    {
        if (token.Kind == CXTokenKind.CXToken_Identifier)
        {
            string tokenSpelling = token.Spelling.ToString();
            MacroDefinitionRecord nestedMacro = pp.GetMacroDefinition(tokenSpelling);
            if (nestedMacro != null && nestedMacro != macroDef) // 避免递归死循环
            {
                expandedText.Append(GetFullyExpandedMacro(nestedMacro, pp));
                continue;
            }
        }
        expandedText.Append(token.Spelling).Append(" ");
    }

    return expandedText.ToString().Trim();
}

// 使用示例：获取宏名后展开
Cursor macroCursor = clang_getCursor((CXSourceLocation)attribute.Location.Handle);
if (macroCursor.Kind == CXCursorKind.CXCursor_MacroDefinition)
{
    MacroDefinitionRecord macroDef = (MacroDefinitionRecord)Cursor.Create(decl.TranslationUnit, macroCursor);
    string expandedText = GetFullyExpandedMacro(macroDef, decl.TranslationUnit.Preprocessor);
    // expandedText即为宏完全展开后的内容，可进一步提取deprecated参数文本
}

说明 #

• 宏展开需处理递归引用，代码中加入了基础循环检测。
• 该方法依赖预处理器上下文，适用于直接获取属性消息不可行的场景。

内容的提问来源于stack exchange，提问作者Marcel V.