本文档概述了查看生成的 FIDL 绑定代码的可用方法。如需了解 FIDL 定义如何转换为目标语言代码的一般信息,请参阅绑定参考文档。
FIDL 库 fuchsia.io 在整个过程中用作运行示例。它在 //sdk/fidl/fuchsia.io 中定义。
查看生成的代码
本部分介绍了如何直接访问生成的代码文件。
GN build
如果您想查看 Fuchsia build 中特定目标的生成输出,可以先构建相关目标,然后检查 build 输出中生成的文件。本部分中的说明假定目标是使用标准 fidl GN 模板定义的,并且 build 目录设置为默认路径 (out/default)。fx status 可用于查找当前 build 目录。
您可以在 fidling 工具链中找到 GN build 中的大多数 FIDL 输出。对于 fuchsia.io,输出的根目录为 out/default/fidling/gen/sdk/fidl/fuchsia.io。本文档的其余部分将此目录称为根目录。其结构如下:
out/default/fidling/gen/sdk/fidl/fuchsia.io
├── fuchsia.io.fidl.json
└── fuchsia.io
├── fidl_fuchsia_io.rs
├── c
│ └── fuchsia
│ └── io
│ └── c
│ ├── fidl.h
│ ├── fidl.client.c
│ └── fidl.server.c
├── cpp
│ └── fidl
│ └── fuchsia.io
│ └── cpp
│ ├── common_types.cc
│ ├── common_types.h
│ ├── driver
│ │ ├── fidl.h
│ │ ├── natural_messaging.cc
│ │ ├── natural_messaging.h
│ │ ├── wire.h
│ │ ├── wire_messaging.cc
│ │ └── wire_messaging.h
│ ├── fidl.h
│ ├── hlcpp_conversion.h
│ ├── markers.h
│ ├── natural_messaging.cc
│ ├── natural_messaging.h
│ ├── natural_types.cc
│ ├── natural_types.h
| ├── test_base.h
│ ├── type_conversions.cc
│ ├── type_conversions.h
│ ├── wire.h
│ ├── wire_messaging.cc
│ ├── wire_messaging.h
│ ├── wire_test_base.h
│ ├── wire_types.cc
│ └── wire_types.h
└── hlcpp
└── fuchsia
└── io
└── cpp
├── fidl.h
├── fidl.cc
└── fidl_test_base.h
许多生成的代码路径似乎都包含重复的目录名称,例如 .../fuchsia.io/fuchsia.io/...。发生这种情况是因为 FIDL 库通常在以库命名的目录中定义,且目标以库命名。第一个 fuchsia.io 来自目录,第二个来自 GN 目标名称。
JSON IR
JSON IR 在根目录中生成为 ${target_name}.fidl.json。
例如,对于 fuchsia.io:
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io.fidl.json
Rust
Rust 绑定在根目录中生成为 ${target_name}/${rust_name}.rs,其中 ${rust_name} 是通过将库名称中的点替换为下划线而派生出来的。例如,对于 fuchsia.io:
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/fidl_fuchsia_io.rs
C++
新的 C++ 绑定使用根目录子目录中的源代码布局,遵循以下模式:${target_name}/${binding_flavor}/fuchsia.io/cpp。
然后,C++ 会输出 wire_types.h、wire_types.cc、wire_messaging.h、wire_messaging.cc、wire.h 和 wire_test_base.h(用于使用传输类型),以及 natural_types.h、natural_types.cc、natural_messaging.h、natural_messaging.cc、test_base.h、fidl.h(用于将自然类型与传输类型搭配使用)。
common_types.h 和 markers.h 在有线类型和自然类型之间共享。
例如,将 fuchsia.io 与 C++ 绑定搭配使用会创建以下文件:
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/markers.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/common_types.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/common_types.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/wire_types.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/wire_types.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/wire_messaging.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/wire_messaging.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/wire.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/wire_test_base.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/natural_types.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/natural_types.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/natural_messaging.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/natural_messaging.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/test_base.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/type_conversions.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/type_conversions.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/hlcpp_conversion.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/cpp/fidl/fuchsia.io/cpp/fidl.h
随着新的 C++ 绑定逐渐成形,更多绑定将遵循此模式。请参阅下文,了解如何生成尚未统一的绑定。
HLCPP 和 C
HLCPP 和 C 绑定在根目录的子目录中生成,遵循 ${target_name}/${binding_flavor}/fuchsia/io 模式。在这里,
- HLCPP 会输出
cpp/fidl.cc、cpp/fidl.h和cpp/fidl_test_base.h。 - C 输出
c/fidl.client.c、c/fidl.server.c和fidl.h。
例如,将 fuchsia.io 与 HLCPP 绑定搭配使用会创建以下文件:
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/hlcpp/fuchsia/io/cpp/fidl.cc
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/hlcpp/fuchsia/io/cpp/fidl.h
out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/hlcpp/fuchsia/io/cpp/fidl_test_base.h
查看生成的文档
Rust
Fuchsia 中使用的所有 Rust crate(包括 FIDL 库的 Rust 绑定)的文档均在线托管在 https://fuchsia.dev/go/rustdoc。您可以使用 fx rustdoc-link 生成离线文档。