Skip to content

Commit

Permalink
Vendor the CPLEX headers to be able to generate the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Matteo Biggio committed Mar 28, 2024
1 parent 85d7093 commit 0df2e2c
Show file tree
Hide file tree
Showing 4 changed files with 6,096 additions and 144 deletions.
1 change: 1 addition & 0 deletions cplex-rs-sys/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ repository.workspace = true
[build-dependencies]
bindgen = "0.69"
glob = "0.3"
once_cell = "1.19"

[dev-dependencies]
libc = "0.2"
165 changes: 21 additions & 144 deletions cplex-rs-sys/build.rs
View file
Original file line number Diff line number Diff line change
@@ -1,54 +1,16 @@
use glob::glob;
use std::collections::HashSet;
use std::env;
use std::path::PathBuf;

use bindgen::callbacks::{MacroParsingBehavior, ParseCallbacks};

const IGNORE_MACROS: [&str; 20] = [
"FE_DIVBYZERO",
"FE_DOWNWARD",
"FE_INEXACT",
"FE_INVALID",
"FE_OVERFLOW",
"FE_TONEAREST",
"FE_TOWARDZERO",
"FE_UNDERFLOW",
"FE_UPWARD",
"FP_INFINITE",
"FP_INT_DOWNWARD",
"FP_INT_TONEAREST",
"FP_INT_TONEARESTFROMZERO",
"FP_INT_TOWARDZERO",
"FP_INT_UPWARD",
"FP_NAN",
"FP_NORMAL",
"FP_SUBNORMAL",
"FP_ZERO",
"IPPORT_RESERVED",
];

#[derive(Debug)]
struct IgnoreMacros(HashSet<String>);

impl ParseCallbacks for IgnoreMacros {
fn will_parse_macro(&self, name: &str) -> MacroParsingBehavior {
if self.0.contains(name) {
MacroParsingBehavior::Ignore
} else {
MacroParsingBehavior::Default
}
}
}

impl IgnoreMacros {
fn new() -> Self {
Self(IGNORE_MACROS.into_iter().map(|s| s.to_owned()).collect())
}
}

fn main() {
let cplex_installation_path = env::var("CPLEX_PATH")
#[cfg(docsrs)]
let cplex_include_path = Path::from(env!("CARGO_MANIFEST_DIR"))
.join("include")
.join("22010000");

#[cfg(not(docsrs))]
let cplex_include_path = {
let cplex_installation_path = env::var("CPLEX_PATH")
.map(PathBuf::from)
.unwrap_or_else(|_| {
glob("/opt/ibm/ILOG/*/cplex")
Expand All @@ -58,20 +20,21 @@ fn main() {
.expect("No valid CPLEX installation path found. Please set the env variable 'CPLEX_PATH' with the CPLEX installation directory or install CPLEX in the default location.")
});

let cplex_include_path = cplex_installation_path.join("include");
// For now we support only static linking on linux x86-64
let cplex_lib_path = cplex_installation_path.join("lib/x86-64_linux/static_pic");

// For now we support only static linking on linux x86-64
let cplex_lib_path = cplex_installation_path.join("lib/x86-64_linux/static_pic");
// Tell cargo to look for shared libraries in the specified directory
println!(
"cargo:rustc-link-search={}",
cplex_lib_path.as_os_str().to_string_lossy()
);

// Tell cargo to look for shared libraries in the specified directory
println!(
"cargo:rustc-link-search={}",
cplex_lib_path.as_os_str().to_string_lossy()
);
// Tell cargo to tell rustc to link the system cplex
// static library.
println!("cargo:rustc-link-lib=cplex");

// Tell cargo to tell rustc to link the system cplex
// static library.
println!("cargo:rustc-link-lib=cplex");
cplex_installation_path.join("include")
};

// The bindgen::Builder is the main entry point
// to bindgen, and lets you build up options for
Expand All @@ -87,93 +50,7 @@ fn main() {
// Tell cargo to invalidate the built crate whenever any of the
// included header files changed.
.parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
// See https://github.com/rust-lang/rust-bindgen/issues/687
.parse_callbacks(Box::new(IgnoreMacros::new()))
// Rust doesn't support long double, and bindgen can't skip it
// https://github.com/rust-lang/rust-bindgen/issues/1549
.blocklist_function("__fpclassifyl")
.blocklist_function("__infl")
.blocklist_function(".*acoshl")
.blocklist_function(".*acosl")
.blocklist_function(".*asinhl")
.blocklist_function(".*asinl")
.blocklist_function(".*atan2l")
.blocklist_function(".*atanhl")
.blocklist_function(".*atanl")
.blocklist_function(".*cbrtl")
.blocklist_function(".*ceill")
.blocklist_function(".*copysignl")
.blocklist_function(".*coshl")
.blocklist_function(".*cosl")
.blocklist_function(".*dreml")
.blocklist_function(".*erfcl")
.blocklist_function(".*erfl")
.blocklist_function(".*exp2l")
.blocklist_function(".*expl")
.blocklist_function(".*expm1l")
.blocklist_function(".*fabsl")
.blocklist_function(".*fdiml")
.blocklist_function(".*floorl")
.blocklist_function(".*finitel")
.blocklist_function(".*fmal")
.blocklist_function(".*fmaxl")
.blocklist_function(".*fminl")
.blocklist_function(".*fmodl")
.blocklist_function(".*frexpl")
.blocklist_function(".*gammal")
.blocklist_function(".*hypotl")
.blocklist_function(".*ilogbl")
.blocklist_function(".*j0l")
.blocklist_function(".*j1l")
.blocklist_function(".*jnl")
.blocklist_function(".*ldexpl")
.blocklist_function(".*lgammal")
.blocklist_function(".*lgammal_r")
.blocklist_function(".*llrintl")
.blocklist_function(".*llroundl")
.blocklist_function(".*iseqsigl")
.blocklist_function(".*issignalingl")
.blocklist_function(".*isinfl")
.blocklist_function(".*log10l")
.blocklist_function(".*log1pl")
.blocklist_function(".*log2l")
.blocklist_function(".*logbl")
.blocklist_function(".*logl")
.blocklist_function(".*lrintl")
.blocklist_function(".*lroundl")
.blocklist_function(".*modfl")
.blocklist_function(".*nanl")
.blocklist_function(".*nearbyintl")
.blocklist_function(".*nextafterl")
.blocklist_function(".*nexttoward")
.blocklist_function(".*nexttowardf")
.blocklist_function(".*nexttowardl")
.blocklist_function(".*powl")
.blocklist_function(".*qecvt")
.blocklist_function(".*qecvt_r")
.blocklist_function(".*qfcvt")
.blocklist_function(".*qfcvt_r")
.blocklist_function(".*qgcvt")
.blocklist_function(".*remainderl")
.blocklist_function(".*remquol")
.blocklist_function(".*rintl")
.blocklist_function(".*roundl")
.blocklist_function(".*scalbl")
.blocklist_function(".*scalblnl")
.blocklist_function(".*scalbnl")
.blocklist_function(".*signbitl")
.blocklist_function(".*significandl")
.blocklist_function(".*sinhl")
.blocklist_function(".*sinl")
.blocklist_function(".*sqrtl")
.blocklist_function(".*strtold")
.blocklist_function(".*tanhl")
.blocklist_function(".*tanl")
.blocklist_function(".*tgammal")
.blocklist_function(".*truncl")
.blocklist_function(".*y0l")
.blocklist_function(".*y1l")
.blocklist_function(".*ynl")
.allowlist_item("CPX.*")
// Finish the builder and generate the bindings.
.generate()
// Unwrap the Result and panic on failure.
Expand Down
Loading

0 comments on commit 0df2e2c

Please sign in to comment.