libnotcurses-sys 3.3.0

Low-level Rust bindings for the notcurses C 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
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

//! libnotcurses-sys build script

extern crate bindgen;
extern crate pkg_config;

mod csource;

/// The notcurses version that we are aiming to support in the current release.
const NC_VERSION: &str = "3.0.7";

fn main() {
    let nc_src = csource::NcCSource::new(NC_VERSION);

    // vendor the C source code?
    if cfg!(feature = "vendor_csource") {
        nc_src.vendor_csource();
    }

    // keep the vendored files?
    if cfg!(feature = "keep_vendored") {
        // println!("cargo:warning=Keeping vendored files…");
    } else {
        // println!("cargo:warning=Deleting vendored files…");
        nc_src.delete_vendored();
    }

    // compile the C source code?
    if cfg!(feature = "compile_csource") {
        nc_src.compile_csource();
    }

    // deploy the vendored bindings?
    if cfg!(feature = "use_vendored_bindings") {
        nc_src.use_vendored_bindings();

    // if not, try to generate the bindings from the C source code
    } else {
        let plib = pkg_config::Config::new()
            .atleast_version(NC_VERSION)
            .probe("notcurses")
            .expect("pkg-config couldn't find the notcurses library");

        // tell cargo to invalidate the built crate whenever the wrapper changes
        println!("cargo:rerun-if-changed=build/wrapper.h");

        let mut builder = bindgen::Builder::default()
            .use_core()
            .ctypes_prefix("cty")
            .clang_arg("-D_XOPEN_SOURCE")
            .clang_arg(&nc_src.headers_include_string())
            // the input header we would like to generate builder for
            .header("build/wrapper.h")
            // generate comments, also from headers and not just doc comments (///)
            .generate_comments(true)
            .clang_arg("-fretain-comments-from-system-headers")
            .clang_arg("-fparse-all-comments")
            // https://github.com/dankamongmen/notcurses/pull/2331#issuecomment-966211120
            .size_t_is_usize(true)
            // Remove warnings about improper_ctypes
            .blocklist_function("strtold")
            .blocklist_function("wcstold")
            .blocklist_function("socketpair")
            // only import functions from notcurses public API
            .blocklist_function("[^ns].*")
            .blocklist_function("n[^co].*")
            .blocklist_function("s[^i].*") // allow sig*
            // clean more unneeded types
            .blocklist_item("B[0-9]+")
            .blocklist_item("_BITS.*")
            .blocklist_item("_POSIX.*")
            .blocklist_item("__[A-Z].*")
            .blocklist_item("[ADHJ-MQ-Z].*")
            .blocklist_item("IN.*")
            .blocklist_item("IP[^R].*")
            .blocklist_item("ip.*")
            .blocklist_item("m.*")
            .blocklist_item("PF.*")
            .blocklist_item("MSG_.*")
            .blocklist_item("N[^C].*")
            .blocklist_type("_bindgen.*")
            // https://github.com/dankamongmen/notcurses/pull/1937
            // https://github.com/rust-lang/rust-bindgen/issues/1651
            .layout_tests(false)
            // Don't derive the Copy trait on types with destructors
            .no_copy("ncdirect")
            .no_copy("ncdplot")
            .no_copy("ncfdplane")
            .no_copy("ncmenu")
            .no_copy("ncmenu_item")
            .no_copy("ncmenu_section")
            .no_copy("ncmenu_options")
            .no_copy("ncmultiselector")
            .no_copy("ncmultiselector_options")
            .no_copy("ncmselector_item")
            .no_copy("ncplane")
            .no_copy("ncplane_options")
            .no_copy("ncprogbar")
            .no_copy("ncreader")
            .no_copy("ncreel")
            .no_copy("ncselector")
            .no_copy("ncselector_item")
            .no_copy("ncselector_options")
            .no_copy("ncuplot")
            .no_copy("ncdplot")
            .no_copy("ncsubproc")
            .no_copy("nctab")
            .no_copy("nctabbed")
            .no_copy("nctabbed_options")
            .no_copy("nctree")
            .no_copy("nctree_item")
            .no_copy("nctree_options")
            .no_copy("ncvisual")
            .no_copy("ncvisual_options")
            .no_copy("notcurses")
            .no_copy("notcurses_options")
            .no_partialeq("ncinput")
            // try to derive more traits
            .derive_default(true)
            .derive_hash(true)
            .derive_partialord(true)
            .derive_ord(true)
            .derive_partialeq(true)
            .derive_eq(true)
            // Tell cargo to invalidate the built crate whenever any of the
            // included header files changed
            .parse_callbacks(Box::new(bindgen::CargoCallbacks));

        for d in plib.include_paths {
            builder = builder.clang_arg(format!("-I{}", d.to_string_lossy()));
        }

        // finish the builder and generate the builder
        let bindings = builder.generate().expect("Unable to generate bindings");

        // write the bindings out to the $OUT_DIR directory
        bindings
            .write_to_file(nc_src.deployed_bindings())
            .expect("Couldn't write bindings!");

        // vendor the bindgen bindings?
        if cfg!(feature = "vendor_bindings") {
            nc_src.vendor_bindings();
        }
    }
}