gfxd-sys 0.1.1

Rust bindings for libgfxd, the N64 display list decompiler library
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

/* SPDX-FileCopyrightText: © 2025 Decompollaborate */
/* SPDX-License-Identifier: MIT */

//! Change or extend decompiled output.
//!
//! The macro handler function is responsible for writing the output of each
//! decompiled macro.
//!
//! The default macro handler is `gfxd_macro_dflt`, but this can be changed
//! with `gfxd_macro_fn`.
//!
//! The new handler can extend the default function by calling
//! `gfxd_macro_dflt` within it, or it can override it completely.

use crate::ffi;

extern "C" {
    /// The default macro handler.
    ///
    /// Outputs the macro name, dynamic display list pointer if one has been
    /// specified, and then each argument in order using the function
    /// registered using [`gfxd_arg_fn`] ([`gfxd_arg_dflt`] by default), and
    /// returns zero.
    ///
    /// Because it is designed to be extended, it only outputs
    /// the macro text, without any whitespace or punctuation before or
    /// after.
    ///
    /// When this function is used as the sole macro handler, it will
    /// output the entire display list on one line without any separation
    /// between macros, which is probably not what you want.
    pub fn gfxd_macro_dflt() -> ffi::c_int;

    /// Set `fn` to be the macro handler function.
    ///
    /// `fn` can be [`None`], in which case the handler is reset to the
    /// default.
    ///
    /// If fn returns a value other than 0, execution stops (see
    /// [`gfxd_execute`]).
    ///
    /// [`gfxd_execute`]: crate::execution::gfxd_execute
    pub fn gfxd_macro_fn(fn_: Option<gfxd_macro_fn_t>);

    /// The default argument handler for [`gfxd_macro_dflt`].
    ///
    /// For the argument with index `arg_num`, calls [`gfxd_arg_callbacks`],
    /// and prints the argument value if the callback returns zero, or if there
    /// is no callback for the given argument.
    ///
    /// [`gfxd_arg_callbacks`]: crate::argument_callbacks::gfxd_arg_callbacks
    pub fn gfxd_arg_dflt(arg_num: ffi::c_int);

    /// Set `fn` to be the argument handler function, called by
    /// [`gfxd_macro_dflt`], for each argument in the current macro, not
    /// counting the dynamic display list pointer if one has been specified.
    ///
    /// `fn` can be [`None`], in which case the handler is reset to the
    /// default.
    ///
    /// This only affects the output of [`gfxd_macro_dflt`], and has no
    /// observable effect if [`gfxd_macro_dflt`] is overridden (not extended).
    pub fn gfxd_arg_fn(fn_: Option<gfxd_arg_fn_t>);
}

pub type gfxd_macro_fn_t = unsafe extern "C" fn() -> ffi::c_int;

pub type gfxd_arg_fn_t = unsafe extern "C" fn(arg_num: ffi::c_int);