flutter_rust_bridge_codegen 2.0.0-dev.0

High-level memory-safe binding generator for Flutter/Dart <-> Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use crate::library::commands::cargo_metadata::execute_cargo_metadata;
use crate::library::commands::cbindgen::{cbindgen_raw, default_cbindgen_config};
use crate::library::commands::ffigen::{
    ffigen_raw, FfigenCommandConfig, FfigenCommandConfigHeaders,
};
use crate::utils::path_utils::path_to_string;
use convert_case::{Case, Casing};
use log::info;
use std::collections::HashMap;
use std::env;
use std::path::{Path, PathBuf};

pub fn generate() -> anyhow::Result<()> {
    let repo_base_dir = compute_repo_base_dir()?;
    info!("Determine repo_base_dir={repo_base_dir:?}");

    generate_frb_rust_cbindgen(&repo_base_dir)?;
    generate_allo_isolate_cbindgen(&repo_base_dir)?;

    ffigen(&repo_base_dir)?;

    Ok(())
}

fn compute_repo_base_dir() -> anyhow::Result<PathBuf> {
    Ok(PathBuf::from(env::var("CARGO_MANIFEST_DIR")?)
        .parent()
        .unwrap()
        .to_owned())
}

fn generate_frb_rust_cbindgen(repo_base_dir: &Path) -> anyhow::Result<()> {
    info!("generate_frb_rust_cbindgen");
    let default_config = default_cbindgen_config();
    cbindgen(
        cbindgen::Config {
            export: cbindgen::ExportConfig {
                rename: HashMap::from([("DartCObject".to_owned(), "Dart_CObject".to_owned())]),
                ..Default::default()
            },
            after_includes: Some(
                default_config.after_includes.unwrap()
                    + "\n"
                    + r#"#include "dart_api.h""#
                    + "\n"
                    + r#"#include "dart_native_api.h""#,
            ),
            ..default_config
        },
        repo_base_dir,
        &repo_base_dir.join("frb_rust"),
        "frb_rust",
    )
}

fn generate_allo_isolate_cbindgen(repo_base_dir: &Path) -> anyhow::Result<()> {
    info!("generate_allo_isolate_cbindgen");

    let metadata = execute_cargo_metadata(&repo_base_dir.join("frb_codegen/Cargo.toml"))?;

    let package_name = "allo-isolate";
    let package = (metadata.packages.iter())
        .find(|package| package.name == package_name)
        .unwrap();
    let rust_crate_dir = package.manifest_path.as_std_path().parent().unwrap();

    let default_config = default_cbindgen_config();
    cbindgen(
        cbindgen::Config {
            export: cbindgen::ExportConfig {
                exclude: vec!["DartCObject".to_owned()],
                ..Default::default()
            },
            after_includes: Some(
                default_config.after_includes.unwrap() + "\n" + r#"#include "dart_api.h""#,
            ),
            ..default_config
        },
        repo_base_dir,
        rust_crate_dir,
        "allo_isolate",
    )
}

fn cbindgen(
    config: cbindgen::Config,
    repo_base_dir: &Path,
    rust_crate_dir: &Path,
    name: &str,
) -> anyhow::Result<()> {
    let c_path = repo_base_dir.join(format!(
        "frb_dart/lib/src/ffigen_generated/intermediate/{}.h",
        name.to_case(Case::Snake)
    ));
    cbindgen_raw(config, rust_crate_dir, &c_path)
}

fn ffigen(repo_base_dir: &Path) -> anyhow::Result<()> {
    let dir_dart_api = repo_base_dir.join("frb_rust/src/dart_api");
    let dir_intermediate = repo_base_dir.join("frb_dart/lib/src/ffigen_generated/intermediate");

    let raw_headers = vec![
        dir_dart_api.join("dart_native_api.h"),
        dir_intermediate.join("allo_isolate.h"),
        dir_intermediate.join("frb_rust.h"),
    ];

    ffigen_raw(
        &FfigenCommandConfig {
            output: repo_base_dir.join("frb_dart/lib/src/ffigen_generated/multi_package.dart"),
            name: "MultiPackageCBinding".to_string(),
            headers: FfigenCommandConfigHeaders {
                entry_points: raw_headers.clone(),
                include_directives: raw_headers,
            },
            preamble: FFIGEN_PREAMBLE.to_owned(),
            description: FFIGEN_DESCRIPTION.to_owned(),
            compiler_opts: vec![
                // directory of `#include`
                format!("-I{}", &path_to_string(&dir_dart_api)?),
                format!("-I{}", &path_to_string(&dir_intermediate)?),
            ],
            ..Default::default()
        },
        &repo_base_dir.join("frb_dart"),
    )
}

const FFIGEN_PREAMBLE: &str = "// AUTO-GENERATED BY frb_codegen::internal command\n// ignore_for_file: camel_case_types, non_constant_identifier_names, avoid_positional_boolean_parameters, annotate_overrides, constant_identifier_names, unused_field, library_private_types_in_public_api, unused_element\n";
const FFIGEN_DESCRIPTION: &str = "generated by frb_codegen::internal command";