graphviz-anywhere 0.2.5

Safe Rust wrapper for the graphviz-anywhere C library with bundled prebuilt binaries (and a wasm32 JS bridge)
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
// Pure mapping functions used by build.rs.
//
// This module is `include!`-d from build.rs so the same logic can be unit-tested
// without duplicating code. Do NOT add dependencies beyond `std` here.

/// Maps a Rust target triple to the GitHub release asset name.
///
/// Returns `None` for targets that are not yet covered (caller should fall back
/// to `GRAPHVIZ_ANYWHERE_DIR` env override or a manual prebuilt drop-in).
pub fn target_triple_to_asset_name(target: &str) -> Option<&'static str> {
    match target {
        // ── Linux ──────────────────────────────────────────────────────────────
        "x86_64-unknown-linux-gnu" => Some("graphviz-native-linux-x86_64.tar.gz"),

        "aarch64-unknown-linux-gnu" => Some("graphviz-native-linux-aarch64.tar.gz"),

        // ── macOS ──────────────────────────────────────────────────────────────
        "x86_64-apple-darwin"
        | "aarch64-apple-darwin"
        | "universal-apple-darwin" => Some("graphviz-native-macos-universal.tar.gz"),

        // ── Android ────────────────────────────────────────────────────────────
        "aarch64-linux-android" => Some("graphviz-native-android-arm64-v8a.tar.gz"),
        "armv7-linux-androideabi" => Some("graphviz-native-android-armeabi-v7a.tar.gz"),
        "x86_64-linux-android" => Some("graphviz-native-android-x86_64.tar.gz"),
        "i686-linux-android" => Some("graphviz-native-android-x86.tar.gz"),

        // ── iOS device ─────────────────────────────────────────────────────────
        "aarch64-apple-ios" => Some("graphviz-native-ios-device-arm64.tar.gz"),

        // ── iOS simulator ──────────────────────────────────────────────────────
        "aarch64-apple-ios-sim" => Some("graphviz-native-ios-sim-arm64.tar.gz"),
        "x86_64-apple-ios" => Some("graphviz-native-ios-sim-x86_64.tar.gz"),

        // ── Windows ────────────────────────────────────────────────────────────
        "x86_64-pc-windows-msvc" => Some("graphviz-native-windows-x86_64.tar.gz"),
        "aarch64-pc-windows-msvc" => Some("graphviz-native-windows-arm64.tar.gz"),

        _ => None,
    }
}

/// Returns the `prebuilt/<triple>/` sub-path (relative to the manifest dir) and
/// the expected lib filename for the given target triple.
///
/// Returns `None` when the triple is unrecognised or wasm (no native link needed).
pub fn target_triple_to_prebuilt_subdir(target: &str) -> Option<(&'static str, &'static str)> {
    // (subdirectory under prebuilt/, lib filename)
    match target {
        "x86_64-unknown-linux-gnu" => {
            Some(("x86_64-unknown-linux-gnu", "libgraphviz_api.a"))
        }

        "aarch64-unknown-linux-gnu" => {
            Some(("aarch64-unknown-linux-gnu", "libgraphviz_api.a"))
        }

        "x86_64-apple-darwin" => Some(("x86_64-apple-darwin", "libgraphviz_api.a")),
        "aarch64-apple-darwin" => Some(("aarch64-apple-darwin", "libgraphviz_api.a")),

        "aarch64-apple-ios" => Some(("aarch64-apple-ios", "libgraphviz_api.a")),
        "aarch64-apple-ios-sim" => Some(("aarch64-apple-ios-sim", "libgraphviz_api.a")),
        "x86_64-apple-ios" => Some(("x86_64-apple-ios", "libgraphviz_api.a")),

        "x86_64-pc-windows-msvc" => {
            Some(("x86_64-pc-windows-msvc", "graphviz_api.lib"))
        }
        "aarch64-pc-windows-msvc" => Some(("aarch64-pc-windows-msvc", "graphviz_api.lib")),

        _ => None,
    }
}

/// Maps a Rust target triple to the expected `output/` sub-paths (relative to
/// repo root) where the CI / script build places the library.
///
/// Returns an empty slice for unrecognised targets; the caller should treat that
/// as "not found".
pub fn target_triple_to_output_dirs(target: &str) -> &'static [&'static str] {
    match target {
        "x86_64-unknown-linux-gnu" => &["output/linux-x86_64/lib", "output/linux/lib"],

        "aarch64-unknown-linux-gnu" => &["output/linux-aarch64/lib", "output/linux/lib"],

        "x86_64-apple-darwin"
        | "aarch64-apple-darwin"
        | "universal-apple-darwin" => &["output/macos-universal/lib"],

        "aarch64-linux-android" => &["output/android/arm64-v8a/lib"],
        "armv7-linux-androideabi" => &["output/android/armeabi-v7a/lib"],
        "x86_64-linux-android" => &["output/android/x86_64/lib"],
        "i686-linux-android" => &["output/android/x86/lib"],

        "aarch64-apple-ios" => &["output/ios/iphoneos-arm64/lib"],
        "aarch64-apple-ios-sim" => &["output/ios/iphonesimulator-arm64/lib"],
        "x86_64-apple-ios" => &["output/ios/iphonesimulator-x86_64/lib"],

        "x86_64-pc-windows-msvc" => &[
            "output/windows-x86_64/lib",
            "output/windows-x86_64/bin",
        ],
        "aarch64-pc-windows-msvc" => &[
            "output/windows-arm64/lib",
            "output/windows-arm64/bin",
        ],

        _ => &[],
    }
}

/// Returns `true` for iOS targets (both device and simulator).
pub fn is_ios_target(target: &str) -> bool {
    matches!(
        target,
        "aarch64-apple-ios" | "aarch64-apple-ios-sim" | "x86_64-apple-ios"
    )
}

/// Returns whether the legacy per-OS prebuilt layout is safe to use.
///
/// Legacy directories do not encode an architecture, so they are only valid
/// for a native build where Cargo's host and target triples match exactly.
/// Missing host metadata must fail closed rather than risk linking a host
/// archive into a cross-compiled binary.
pub fn legacy_prebuilt_is_compatible(host: &str, target: &str) -> bool {
    !host.is_empty() && host == target
}

/// Returns `true` when the default native link is static.
///
/// Desktop and iOS executables must be self-contained: a Cargo build-script
/// rpath is not propagated to final downstream binaries, and a same-named
/// system library can otherwise be selected at process launch. Android keeps
/// the shared library because the application package owns JNI library
/// staging and loading.
pub fn asset_is_static(target: &str) -> bool {
    is_ios_target(target)
        || target.contains("windows-msvc")
        || target.contains("unknown-linux-gnu")
        || target.contains("apple-darwin")
}

/// Returns the lib filename to expect inside the extracted release archive.
pub fn asset_lib_filename(target: &str) -> &'static str {
    match target {
        "x86_64-apple-darwin"
        | "aarch64-apple-darwin"
        | "universal-apple-darwin" => "libgraphviz_api.a",
        t if is_ios_target(t) => "libgraphviz_api.a",
        t if t.contains("windows-msvc") => "graphviz_api.lib",
        t if t.contains("unknown-linux-gnu") => "libgraphviz_api.a",
        _ => "libgraphviz_api.so",
    }
}

/// Resolve a static library from an explicit override's candidate directories.
///
/// Windows source builds place a DLL import library and the merged static
/// archive beside one another. `graphviz_api_static.lib` always wins. The
/// canonical `graphviz_api.lib` is accepted only when no adjacent DLL proves
/// that it is an import library (the canonical name is used by release assets).
pub fn find_static_override(
    lib_dirs: &[std::path::PathBuf],
    target_os: &str,
) -> Option<(std::path::PathBuf, &'static str)> {
    if target_os != "windows" {
        return lib_dirs
            .iter()
            .map(|dir| dir.join("libgraphviz_api.a"))
            .find(|path| path.is_file())
            .map(|path| (path, "graphviz_api"));
    }

    if let Some(path) = lib_dirs
        .iter()
        .map(|dir| dir.join("graphviz_api_static.lib"))
        .find(|path| path.is_file())
    {
        return Some((path, "graphviz_api_static"));
    }

    let has_dll = lib_dirs.iter().any(|lib_dir| {
        lib_dir.join("graphviz_api.dll").is_file()
            || lib_dir
                .parent()
                .map_or(false, |parent| parent.join("bin/graphviz_api.dll").is_file())
    });
    if has_dll {
        return None;
    }

    lib_dirs
        .iter()
        .map(|dir| dir.join("graphviz_api.lib"))
        .find(|path| path.is_file())
        .map(|path| (path, "graphviz_api"))
}

// ── Tests ──────────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;

    // ── target_triple_to_asset_name ────────────────────────────────────────────

    #[test]
    fn linux_x86_64_asset() {
        assert_eq!(
            target_triple_to_asset_name("x86_64-unknown-linux-gnu"),
            Some("graphviz-native-linux-x86_64.tar.gz")
        );
    }

    #[test]
    fn linux_aarch64_asset() {
        assert_eq!(
            target_triple_to_asset_name("aarch64-unknown-linux-gnu"),
            Some("graphviz-native-linux-aarch64.tar.gz")
        );
    }

    #[test]
    fn macos_asset_universal() {
        assert_eq!(
            target_triple_to_asset_name("x86_64-apple-darwin"),
            Some("graphviz-native-macos-universal.tar.gz")
        );
        assert_eq!(
            target_triple_to_asset_name("aarch64-apple-darwin"),
            Some("graphviz-native-macos-universal.tar.gz")
        );
    }

    #[test]
    fn android_assets() {
        assert_eq!(
            target_triple_to_asset_name("aarch64-linux-android"),
            Some("graphviz-native-android-arm64-v8a.tar.gz")
        );
        assert_eq!(
            target_triple_to_asset_name("armv7-linux-androideabi"),
            Some("graphviz-native-android-armeabi-v7a.tar.gz")
        );
        assert_eq!(
            target_triple_to_asset_name("x86_64-linux-android"),
            Some("graphviz-native-android-x86_64.tar.gz")
        );
        assert_eq!(
            target_triple_to_asset_name("i686-linux-android"),
            Some("graphviz-native-android-x86.tar.gz")
        );
    }

    #[test]
    fn ios_device_asset() {
        assert_eq!(
            target_triple_to_asset_name("aarch64-apple-ios"),
            Some("graphviz-native-ios-device-arm64.tar.gz")
        );
    }

    #[test]
    fn ios_simulator_assets() {
        assert_eq!(
            target_triple_to_asset_name("aarch64-apple-ios-sim"),
            Some("graphviz-native-ios-sim-arm64.tar.gz")
        );
        assert_eq!(
            target_triple_to_asset_name("x86_64-apple-ios"),
            Some("graphviz-native-ios-sim-x86_64.tar.gz")
        );
    }

    #[test]
    fn windows_arm64_asset() {
        assert_eq!(
            target_triple_to_asset_name("aarch64-pc-windows-msvc"),
            Some("graphviz-native-windows-arm64.tar.gz")
        );
    }

    #[test]
    fn windows_x86_64_asset() {
        assert_eq!(
            target_triple_to_asset_name("x86_64-pc-windows-msvc"),
            Some("graphviz-native-windows-x86_64.tar.gz")
        );
    }

    #[test]
    fn unknown_target_returns_none() {
        assert_eq!(target_triple_to_asset_name("wasm32-unknown-unknown"), None);
        assert_eq!(target_triple_to_asset_name("riscv64gc-unknown-linux-gnu"), None);
    }

    // ── target_triple_to_prebuilt_subdir ────────────────────────────────────────

    #[test]
    fn prebuilt_subdir_ios_device() {
        let (subdir, lib) = target_triple_to_prebuilt_subdir("aarch64-apple-ios").unwrap();
        assert_eq!(subdir, "aarch64-apple-ios");
        assert_eq!(lib, "libgraphviz_api.a");
    }

    #[test]
    fn prebuilt_subdir_ios_sim_arm64() {
        let (subdir, lib) = target_triple_to_prebuilt_subdir("aarch64-apple-ios-sim").unwrap();
        assert_eq!(subdir, "aarch64-apple-ios-sim");
        assert_eq!(lib, "libgraphviz_api.a");
    }

    #[test]
    fn prebuilt_subdir_linux_aarch64() {
        let (subdir, lib) = target_triple_to_prebuilt_subdir("aarch64-unknown-linux-gnu").unwrap();
        assert_eq!(subdir, "aarch64-unknown-linux-gnu");
        assert_eq!(lib, "libgraphviz_api.a");
    }

    #[test]
    fn prebuilt_subdir_android_x86() {
        assert_eq!(target_triple_to_prebuilt_subdir("i686-linux-android"), None);
    }

    #[test]
    fn prebuilt_subdir_windows_arm64() {
        let (subdir, lib) = target_triple_to_prebuilt_subdir("aarch64-pc-windows-msvc").unwrap();
        assert_eq!(subdir, "aarch64-pc-windows-msvc");
        assert_eq!(lib, "graphviz_api.lib");
    }

    // ── target_triple_to_output_dirs ────────────────────────────────────────────

    #[test]
    fn output_dirs_ios_device() {
        let dirs = target_triple_to_output_dirs("aarch64-apple-ios");
        assert_eq!(dirs, &["output/ios/iphoneos-arm64/lib"]);
    }

    #[test]
    fn output_dirs_ios_sim_arm64() {
        let dirs = target_triple_to_output_dirs("aarch64-apple-ios-sim");
        assert_eq!(dirs, &["output/ios/iphonesimulator-arm64/lib"]);
    }

    #[test]
    fn output_dirs_ios_sim_x86_64() {
        let dirs = target_triple_to_output_dirs("x86_64-apple-ios");
        assert_eq!(dirs, &["output/ios/iphonesimulator-x86_64/lib"]);
    }

    #[test]
    fn output_dirs_linux_aarch64() {
        let dirs = target_triple_to_output_dirs("aarch64-unknown-linux-gnu");
        assert!(dirs.contains(&"output/linux-aarch64/lib"));
    }

    #[test]
    fn output_dirs_android_x86() {
        let dirs = target_triple_to_output_dirs("i686-linux-android");
        assert_eq!(dirs, &["output/android/x86/lib"]);
    }

    // ── asset_lib_filename ───────────────────────────────────────────────────────

    #[test]
    fn asset_lib_filename_ios_is_static() {
        assert_eq!(asset_lib_filename("aarch64-apple-ios"), "libgraphviz_api.a");
        assert_eq!(asset_lib_filename("aarch64-apple-ios-sim"), "libgraphviz_api.a");
        assert_eq!(asset_lib_filename("x86_64-apple-ios"), "libgraphviz_api.a");
    }

    #[test]
    fn asset_lib_filename_macos_is_static() {
        assert_eq!(asset_lib_filename("aarch64-apple-darwin"), "libgraphviz_api.a");
    }

    #[test]
    fn asset_lib_filename_linux_is_static() {
        assert_eq!(asset_lib_filename("x86_64-unknown-linux-gnu"), "libgraphviz_api.a");
    }

    #[test]
    fn asset_lib_filename_windows_is_static_import_name() {
        assert_eq!(asset_lib_filename("x86_64-pc-windows-msvc"), "graphviz_api.lib");
    }

    // ── is_ios_target ────────────────────────────────────────────────────────────

    #[test]
    fn is_ios_target_recognition() {
        assert!(is_ios_target("aarch64-apple-ios"));
        assert!(is_ios_target("aarch64-apple-ios-sim"));
        assert!(is_ios_target("x86_64-apple-ios"));
        assert!(!is_ios_target("aarch64-apple-darwin"));
        assert!(!is_ios_target("aarch64-linux-android"));
    }

    #[test]
    fn legacy_prebuilt_is_native_only() {
        assert!(legacy_prebuilt_is_compatible(
            "aarch64-apple-darwin",
            "aarch64-apple-darwin"
        ));
        assert!(!legacy_prebuilt_is_compatible(
            "aarch64-apple-darwin",
            "x86_64-apple-darwin"
        ));
        assert!(!legacy_prebuilt_is_compatible(
            "x86_64-unknown-linux-gnu",
            "aarch64-unknown-linux-gnu"
        ));
        assert!(!legacy_prebuilt_is_compatible(
            "",
            "x86_64-pc-windows-msvc"
        ));
    }

    // ── asset_is_static (static vs. dynamic link policy) ─────────────────────────

    #[test]
    fn asset_is_static_for_desktop_and_ios() {
        assert!(asset_is_static("aarch64-apple-ios"));
        assert!(asset_is_static("aarch64-apple-ios-sim"));
        assert!(asset_is_static("x86_64-apple-ios"));
        assert!(asset_is_static("x86_64-pc-windows-msvc"));
        assert!(asset_is_static("x86_64-unknown-linux-gnu"));
        assert!(asset_is_static("aarch64-unknown-linux-gnu"));
        assert!(asset_is_static("aarch64-apple-darwin"));
        assert!(asset_is_static("x86_64-apple-darwin"));
        assert!(!asset_is_static("aarch64-linux-android"));
    }

    #[test]
    fn incompatible_abi_assets_are_not_auto_selected() {
        assert_eq!(target_triple_to_asset_name("x86_64-unknown-linux-musl"), None);
        assert_eq!(target_triple_to_asset_name("aarch64-unknown-linux-musl"), None);
        assert_eq!(target_triple_to_asset_name("x86_64-pc-windows-gnu"), None);
        assert_eq!(target_triple_to_prebuilt_subdir("x86_64-unknown-linux-musl"), None);
        assert_eq!(target_triple_to_prebuilt_subdir("x86_64-pc-windows-gnu"), None);
        assert!(target_triple_to_output_dirs("aarch64-unknown-linux-musl").is_empty());
        assert!(target_triple_to_output_dirs("x86_64-pc-windows-gnu").is_empty());
    }

    #[test]
    fn windows_override_prefers_merged_static_archive() {
        let root = std::env::temp_dir().join(format!(
            "graphviz-anywhere-static-override-{}",
            std::process::id()
        ));
        let lib = root.join("lib");
        let bin = root.join("bin");
        std::fs::create_dir_all(&lib).unwrap();
        std::fs::create_dir_all(&bin).unwrap();
        std::fs::write(lib.join("graphviz_api.lib"), b"import").unwrap();
        std::fs::write(lib.join("graphviz_api_static.lib"), b"static").unwrap();
        std::fs::write(bin.join("graphviz_api.dll"), b"dll").unwrap();

        let resolved = find_static_override(std::slice::from_ref(&lib), "windows").unwrap();
        assert_eq!(resolved.0, lib.join("graphviz_api_static.lib"));
        assert_eq!(resolved.1, "graphviz_api_static");

        std::fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn windows_override_rejects_import_library_as_static() {
        let root = std::env::temp_dir().join(format!(
            "graphviz-anywhere-import-override-{}",
            std::process::id()
        ));
        let lib = root.join("lib");
        let bin = root.join("bin");
        std::fs::create_dir_all(&lib).unwrap();
        std::fs::create_dir_all(&bin).unwrap();
        std::fs::write(lib.join("graphviz_api.lib"), b"import").unwrap();
        std::fs::write(bin.join("graphviz_api.dll"), b"dll").unwrap();

        assert!(find_static_override(&[lib], "windows").is_none());

        std::fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn windows_release_canonical_library_is_static_without_dll() {
        let root = std::env::temp_dir().join(format!(
            "graphviz-anywhere-release-override-{}",
            std::process::id()
        ));
        let lib = root.join("lib");
        std::fs::create_dir_all(&lib).unwrap();
        std::fs::write(lib.join("graphviz_api.lib"), b"static").unwrap();

        let resolved = find_static_override(std::slice::from_ref(&lib), "windows").unwrap();
        assert_eq!(resolved.0, lib.join("graphviz_api.lib"));
        assert_eq!(resolved.1, "graphviz_api");

        std::fs::remove_dir_all(root).unwrap();
    }

    #[test]
    fn asset_is_static_agrees_with_lib_filename() {
        // The link policy must match the expected library file: static targets
        // ship a `.a`, dynamic targets a `.so` / `.dylib`.
        for target in [
            "aarch64-apple-ios",
            "x86_64-unknown-linux-gnu",
            "aarch64-apple-darwin",
            "aarch64-linux-android",
            "x86_64-pc-windows-msvc",
        ] {
            let lib_name = asset_lib_filename(target);
            let ships_archive = lib_name.ends_with(".a") || lib_name.ends_with(".lib");
            assert_eq!(
                asset_is_static(target),
                ships_archive,
                "asset_is_static and asset_lib_filename disagree for {target}"
            );
        }
    }
}