hyperlight_component_util/
util.rs

1/*
2Copyright 2025 The Hyperlight Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8    http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15 */
16
17//! General utilities for bindgen macros
18use crate::etypes;
19
20/// Read and parse a WIT type encapsulated in a wasm file from the
21/// given filename, relative to the cargo manifest directory.
22pub fn read_wit_type_from_file<R, F: FnMut(String, &etypes::Component) -> R>(
23    filename: impl AsRef<std::ffi::OsStr>,
24    world_name: Option<String>,
25    mut cb: F,
26) -> R {
27    let path = std::path::Path::new(&filename);
28    let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap();
29    let manifest_dir = std::path::Path::new(&manifest_dir);
30    let path = manifest_dir.join(path);
31
32    let bytes = std::fs::read(path).unwrap();
33    let i = wasmparser::Parser::new(0).parse_all(&bytes);
34    let ct = crate::component::read_component_single_exported_type(i, world_name);
35
36    // because of the two-level encapsulation scheme, we need to look
37    // for the single export of the component type that we just read
38    if !ct.uvars.is_empty()
39        || !ct.imports.is_empty()
40        || !ct.instance.evars.is_empty()
41        || ct.instance.unqualified.exports.len() != 1
42    {
43        panic!("malformed component type container for wit type");
44    };
45    let export = &ct.instance.unqualified.exports[0];
46    use etypes::ExternDesc;
47    let ExternDesc::Component(ct) = &export.desc else {
48        panic!("malformed component type container: does not contain component type");
49    };
50    tracing::debug!("hcm: considering component type {:?}", ct);
51    cb(export.kebab_name.to_string(), ct)
52}
53
54/// Deal with `$HYPERLIGHT_COMPONENT_MACRO_DEBUG`: if it is present,
55/// save the given token stream (representing the result of
56/// macroexpansion) to the debug file and then return the token stream
57pub fn emit_decls(decls: proc_macro2::TokenStream) -> proc_macro2::TokenStream {
58    if let Ok(dbg_out) = std::env::var("HYPERLIGHT_COMPONENT_MACRO_DEBUG") {
59        if let Ok(file) = syn::parse2(decls.clone()) {
60            std::fs::write(&dbg_out, prettyplease::unparse(&file)).unwrap();
61        } else {
62            let decls = format!("{}", &decls);
63            std::fs::write(&dbg_out, &decls).unwrap();
64        }
65        quote::quote! { include!(#dbg_out); }
66    } else {
67        decls
68    }
69}
hyperlight_component_util/util.rs

hyperlight_component_util/
util.rs
