產生的程式碼輸出指南

本文件概述查看產生的 FIDL 繫結程式碼的可用方法。如需關於 FIDL 定義如何轉換為目標語言代碼的一般資訊,請參閱繫結參考資料

執行中的範例全程都會使用 FIDL 程式庫 fuchsia.io。定義位於 //sdk/fidl/fuchsia.io

查看產生的程式碼

本節說明如何直接存取產生的程式碼檔案。

GN 版本

如要查看 Fuchsia 版本中特定目標產生的輸出內容,您可以先建構有問題的目標,然後在建構輸出內容中檢查產生的檔案。本節的操作說明假設目標是以標準 fidl GN 範本定義,且建構目錄已設為預設路徑 (out/default)。fx status 可用來尋找目前的建構目錄。

您可以在 fidling 工具鍊的 GN 版本中找到大部分的 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
   ├── fuchsia.io.fidl
   │  └── impl.go
   ├── 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

查看

Go 繫結會在根目錄中以 ${target_name}/${library_name}.fidl/impl.go 的形式產生。例如,使用 fuchsia.io

out/default/fidling/gen/sdk/fidl/fuchsia.io/fuchsia.io/fuchsia.io.fidl/impl.go

C++

新的 C++ 繫結會在根目錄的子目錄中使用來源版面配置,遵循以下模式:${target_name}/${binding_flavor}/fuchsia.io/cpp

透過 C++,C++ 會輸出 wire_types.hwire_types.ccwire_messaging.hwire_messaging.ccwire.hwire_test_base.h (使用線類型),以及 natural_types.hnatural_types.ccnatural_messaging.hnatural_messaging.cctest_base.hfidl.h (用於搭配自然類型和線材類型)。

線路和自然型別會共用 common_types.hmarkers.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.cccpp/fidl.hcpp/fidl_test_base.h
  • C 會輸出 c/fidl.client.cc/fidl.server.cfidl.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 繫結) 均在線上託管:fuchsia-docs.firebaseapp.com。您可以使用 fx rustdoc 產生離線說明文件。