use serde::Deserialize;

pub type Node = clang_ast::Node<Clang>;

#[derive(Deserialize)]
pub struct Clang {
    pub kind: String,  // or clang_ast::Kind
    pub loc: Option<clang_ast::SourceLocation>,
    pub range: Option<clang_ast::SourceRange>,
}

如果真的需要，也可以通过一个弱类型的 Map<String, Value> 和 Serde 的 flatten 属性来存储关于每个节点的每个键/值信息。

use serde::Deserialize;
use serde_json::{Map, Value};

#[derive(Deserialize)]
pub struct Clang {
    pub kind: String,  // or clang_ast::Kind
    #[serde(flatten)]
    pub data: Map<String, Value>,
}

混合方法

为了反序列化关于一组固定节点类型的特定信息，以及关于其他所有类型节点的一些统一信息，你可以通过给 Other / Unknown 回退变体一些字段，使用两种方法的混合。

use serde::Deserialize;

pub type Node = clang_ast::Node<Clang>;

#[derive(Deserialize)]
pub enum Clang {
    NamespaceDecl(NamespaceDecl),
    EnumDecl(EnumDecl),
    Other {
        kind: clang_ast::Kind,
    },
}

源位置

许多节点类型公开了相应源代码标记的源位置，包括

• 它们所在的文件路径；
• 将文件引入翻译单元的 #include 链；
• 源文件中的行/列位置；
• 由 C 预处理器宏的展开构建的标记的宏展开跟踪。

你可以在 JSON 表示中的 "loc" 和/或 "range" 字段中找到这些信息。

{
  "id": "0x1251428",
  "kind": "NamespaceDecl",
  "loc": {                           //<--
    "offset": 7004,
    "file": "/usr/include/x86_64-linux-gnu/c++/10/bits/c++config.h",
    "line": 258,
    "col": 11,
    "tokLen": 3,
    "includedFrom": {
      "file": "/usr/include/c++/10/utility"
    }
  },
  "range": {                         //<--
    "begin": {
      "offset": 6994,
      "col": 1,
      "tokLen": 9
    },
    "end": {
      "offset": 7155,
      "line": 266,
      "col": 1,
      "tokLen": 1
    }
  },
  ...
}

由于 Clang 使用省略字段表示“与上一个相同”，因此这些结构的简单反序列化难以处理。所以如果 "loc" 没有在内部打印 "file"，则表示该位置与序列化顺序中立即前一个位置相同的文件中。

clang-ast crate 提供了反序列化这种源位置信息的类型，以产生可能跨多个源位置共享的文件路径的 Arc<str> 类型。

use serde::Deserialize;

pub type Node = clang_ast::Node<Clang>;

#[derive(Deserialize)]
pub enum Clang {
    NamespaceDecl(NamespaceDecl),
    Other,
}

#[derive(Deserialize, Debug)]
pub struct NamespaceDecl {
    pub name: Option<String>,
    pub loc: clang_ast::SourceLocation,    //<--
    pub range: clang_ast::SourceRange,     //<--
}

节点标识符

每个语法树节点都有一个 "id"。在 JSON 中，它是 Clang 为该节点分配的内部内存地址，序列化为十六进制字符串。

AST 输出使用 id 作为有向无环图中节点的回引用。例如，以下 MemberExpr 节点是 operator bool 转换调用的组成部分，因此其语法树引用了解析的 operator bool 转换函数声明

{
  "id": "0x9918b88",
  "kind": "MemberExpr",
  "valueCategory": "rvalue",
  "referencedMemberDecl": "0x12d8330",     //<--
  ...
}

它引用的节点，内存地址为 0x12d8330，可以在语法树中的某个地方找到

{
  "id": "0x12d8330",                       //<--
  "kind": "CXXConversionDecl",
  "name": "operator bool",
  "mangledName": "_ZNKSt17integral_constantIbLb1EEcvbEv",
  "type": {
    "qualType": "std::integral_constant<bool, true>::value_type () const noexcept"
  },
  "constexpr": true,
  ...
}

由于 id 在回引用中的普遍使用，将其反序列化为 64 位整数而不是字符串很有价值。clang-ast crate 提供了一个 Id 类型用于此目的，它具有较低的拷贝成本、可哈希性，并且比字符串更便宜地可比较。你可能会有很多以 Id 为键的散列表。

许可证