xll-utils 0.1.0

PE/COFF parsing and export verification utilities for Excel XLL development
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

//! Build script helpers for verifying XLL exports at compile time.
//!
//! This module provides utilities for use in other crates' `build.rs` scripts
//! to verify DLL/XLL exports during the build process.

use std::path::Path;

use crate::error::{Error, Result};

/// Verify that a DLL/XLL contains all expected exports.
///
/// Returns `Ok(())` if all expected exports are present, or an error
/// listing the missing exports. Intended for use in `build.rs` scripts.
///
/// # Example
///
/// ```no_run
/// fn main() {
///     xll_utils::build::verify_exports_in_build(
///         "target/release/my_xll.xll",
///         &["xlAutoOpen", "xlAutoClose", "xlAutoFree12"],
///     ).expect("XLL export verification failed");
/// }
/// ```
pub fn verify_exports_in_build(dll_path: impl AsRef<Path>, expected: &[&str]) -> Result<()> {
    let dll_path = dll_path.as_ref();
    let report = crate::exports::verify_dll_exports(dll_path, expected)?;

    if !report.complete {
        return Err(Error::MissingExport(format!(
            "Missing exports from {}: {}",
            dll_path.display(),
            report.missing.join(", ")
        )));
    }

    Ok(())
}

/// Emit a `cargo:rerun-if-changed` directive for a DLL/XLL file.
///
/// Call this in `build.rs` to ensure rebuilds happen when the DLL changes.
pub fn rerun_if_dll_changed(dll_path: impl AsRef<Path>) {
    println!("cargo:rerun-if-changed={}", dll_path.as_ref().display());
}