use std::env;
use std::path::Path;
fn main() {
let out_dir = env::var("OUT_DIR").unwrap();
let out_path = Path::new(&out_dir).join("bindgen.rs");
if cfg!(feature = "in_gecko") {
std::fs::copy("sqlite3/bindgen_bundled_version.rs", out_path)
.expect("Could not copy bindings to output directory");
return;
}
if cfg!(feature = "sqlcipher") {
if cfg!(any(
feature = "bundled",
all(windows, feature = "bundled-windows")
)) {
println!(
"cargo:warning=Builds with bundled SQLCipher are not supported. Searching for SQLCipher to link against. \
This can lead to issues if your version of SQLCipher is not up to date!");
}
build_linked::main(&out_dir, &out_path)
} else if cfg!(feature = "loadable_extension") {
build_loadable_extension::main(&out_dir, &out_path)
} else {
#[cfg(any(feature = "bundled", all(windows, feature = "bundled-windows")))]
{
build_bundled::main(&out_dir, &out_path)
}
#[cfg(not(any(feature = "bundled", all(windows, feature = "bundled-windows"))))]
{
build_linked::main(&out_dir, &out_path)
}
}
}
#[cfg(any(feature = "bundled", all(windows, feature = "bundled-windows")))]
mod build_bundled {
use std::env;
use std::path::Path;
pub fn main(out_dir: &str, out_path: &Path) {
if cfg!(feature = "sqlcipher") {
panic!("Builds with bundled SQLCipher are not supported");
}
#[cfg(feature = "buildtime_bindgen")]
{
use super::{bindings, header_file, HeaderLocation};
let header = HeaderLocation::FromPath(format!("sqlite3/{}", header_file()));
bindings::write_to_out_dir(header, out_path);
}
#[cfg(not(feature = "buildtime_bindgen"))]
{
use std::fs;
fs::copy("sqlite3/bindgen_bundled_version.rs", out_path)
.expect("Could not copy bindings to output directory");
}
println!("cargo:rerun-if-changed=sqlite3/sqlite3.c");
println!("cargo:rerun-if-changed=sqlite3/wasm32-wasi-vfs.c");
let mut cfg = cc::Build::new();
cfg.file("sqlite3/sqlite3.c")
.flag("-DSQLITE_CORE")
.flag("-DSQLITE_DEFAULT_FOREIGN_KEYS=1")
.flag("-DSQLITE_ENABLE_API_ARMOR")
.flag("-DSQLITE_ENABLE_COLUMN_METADATA")
.flag("-DSQLITE_ENABLE_DBSTAT_VTAB")
.flag("-DSQLITE_ENABLE_FTS3")
.flag("-DSQLITE_ENABLE_FTS3_PARENTHESIS")
.flag("-DSQLITE_ENABLE_FTS5")
.flag("-DSQLITE_ENABLE_JSON1")
.flag("-DSQLITE_ENABLE_LOAD_EXTENSION=1")
.flag("-DSQLITE_ENABLE_MEMORY_MANAGEMENT")
.flag("-DSQLITE_ENABLE_RTREE")
.flag("-DSQLITE_ENABLE_STAT2")
.flag("-DSQLITE_ENABLE_STAT4")
.flag("-DSQLITE_SOUNDEX")
.flag("-DSQLITE_THREADSAFE=1")
.flag("-DSQLITE_USE_URI")
.flag("-DHAVE_USLEEP=1")
.flag("-D_POSIX_THREAD_SAFE_FUNCTIONS") .warnings(false);
if cfg!(feature = "with-asan") {
cfg.flag("-fsanitize=address");
}
if cfg!(target_env = "msvc") {
use cc::windows_registry::{find_vs_version, VsVers};
let vs_has_nan = match find_vs_version() {
Ok(ver) => ver != VsVers::Vs12,
Err(_msg) => false,
};
if vs_has_nan {
cfg.flag("-DHAVE_ISNAN");
}
} else {
cfg.flag("-DHAVE_ISNAN");
}
if cfg!(not(target_os = "windows")) {
cfg.flag("-DHAVE_LOCALTIME_R");
}
if env::var("TARGET") == Ok("wasm32-wasi".to_string()) {
cfg.flag("-DSQLITE_OS_OTHER")
.flag("-DLONGDOUBLE_TYPE=double");
if cfg!(feature = "wasm32-wasi-vfs") {
cfg.file("sqlite3/wasm32-wasi-vfs.c");
}
}
if cfg!(feature = "unlock_notify") {
cfg.flag("-DSQLITE_ENABLE_UNLOCK_NOTIFY");
}
if cfg!(feature = "preupdate_hook") {
cfg.flag("-DSQLITE_ENABLE_PREUPDATE_HOOK");
}
if cfg!(feature = "session") {
cfg.flag("-DSQLITE_ENABLE_SESSION");
}
if let Ok(limit) = env::var("SQLITE_MAX_VARIABLE_NUMBER") {
cfg.flag(&format!("-DSQLITE_MAX_VARIABLE_NUMBER={}", limit));
}
println!("cargo:rerun-if-env-changed=SQLITE_MAX_VARIABLE_NUMBER");
if let Ok(limit) = env::var("SQLITE_MAX_EXPR_DEPTH") {
cfg.flag(&format!("-DSQLITE_MAX_EXPR_DEPTH={}", limit));
}
println!("cargo:rerun-if-env-changed=SQLITE_MAX_EXPR_DEPTH");
if let Ok(extras) = env::var("LIBSQLITE3_FLAGS") {
for extra in extras.split_whitespace() {
if extra.starts_with("-D") || extra.starts_with("-U") {
cfg.flag(extra);
} else if extra.starts_with("SQLITE_") {
cfg.flag(&format!("-D{}", extra));
} else {
panic!("Don't understand {} in LIBSQLITE3_FLAGS", extra);
}
}
}
println!("cargo:rerun-if-env-changed=LIBSQLITE3_FLAGS");
cfg.compile("libsqlite3.a");
println!("cargo:lib_dir={}", out_dir);
}
}
fn env_prefix() -> &'static str {
if cfg!(feature = "sqlcipher") {
"SQLCIPHER"
} else {
"SQLITE3"
}
}
fn header_file() -> &'static str {
if cfg!(feature = "loadable_extension") {
"sqlite3ext.h"
} else {
"sqlite3.h"
}
}
fn wrapper_file() -> &'static str {
if cfg!(feature = "loadable_extension") {
"wrapper-ext.h"
} else {
"wrapper.h"
}
}
pub enum HeaderLocation {
FromEnvironment,
Wrapper,
FromPath(String),
}
impl From<HeaderLocation> for String {
fn from(header: HeaderLocation) -> String {
match header {
HeaderLocation::FromEnvironment => {
let prefix = env_prefix();
let mut header = env::var(format!("{}_INCLUDE_DIR", prefix)).unwrap_or_else(|_| {
panic!(
"{}_INCLUDE_DIR must be set if {}_LIB_DIR is set",
prefix, prefix
)
});
header.push_str("/");
header.push_str(header_file());
header
}
HeaderLocation::Wrapper => wrapper_file().into(),
HeaderLocation::FromPath(path) => path,
}
}
}
mod build_linked {
use super::{bindings, env_prefix, header_file, HeaderLocation};
use std::env;
use std::path::Path;
pub fn main(_out_dir: &str, out_path: &Path) {
let header = find_sqlite();
bindings::write_to_out_dir(header, out_path);
}
fn find_link_mode() -> &'static str {
match &env::var(format!("{}_STATIC", env_prefix())) {
Ok(v) if v != "0" => "static",
_ => "dylib",
}
}
fn find_sqlite() -> HeaderLocation {
let link_lib = link_lib();
println!("cargo:rerun-if-env-changed={}_INCLUDE_DIR", env_prefix());
println!("cargo:rerun-if-env-changed={}_LIB_DIR", env_prefix());
println!("cargo:rerun-if-env-changed={}_STATIC", env_prefix());
if cfg!(all(feature = "vcpkg", target_env = "msvc")) {
println!("cargo:rerun-if-env-changed=VCPKGRS_DYNAMIC");
}
println!("cargo:link-target={}", link_lib);
if cfg!(all(windows, feature = "winsqlite3")) {
println!("cargo:rustc-link-lib=dylib={}", link_lib);
return HeaderLocation::Wrapper;
}
if let Ok(dir) = env::var(format!("{}_LIB_DIR", env_prefix())) {
let pkgconfig_path = Path::new(&dir).join("pkgconfig");
env::set_var("PKG_CONFIG_PATH", pkgconfig_path);
if pkg_config::Config::new().probe(link_lib).is_err() {
println!("cargo:rustc-link-lib={}={}", find_link_mode(), link_lib);
println!("cargo:rustc-link-search={}", dir);
}
return HeaderLocation::FromEnvironment;
}
if let Some(header) = try_vcpkg() {
return header;
}
match pkg_config::Config::new()
.print_system_libs(false)
.probe(link_lib)
{
Ok(mut lib) => {
if let Some(mut header) = lib.include_paths.pop() {
header.push(header_file());
HeaderLocation::FromPath(header.to_string_lossy().into())
} else {
HeaderLocation::Wrapper
}
}
Err(_) => {
println!("cargo:rustc-link-lib={}={}", find_link_mode(), link_lib);
HeaderLocation::Wrapper
}
}
}
#[cfg(all(feature = "vcpkg", target_env = "msvc"))]
fn try_vcpkg() -> Option<HeaderLocation> {
if let Ok(mut lib) = vcpkg::Config::new().probe(link_lib()) {
if let Some(mut header) = lib.include_paths.pop() {
header.push(header_file());
return Some(HeaderLocation::FromPath(header.to_string_lossy().into()));
}
}
None
}
#[cfg(not(all(feature = "vcpkg", target_env = "msvc")))]
fn try_vcpkg() -> Option<HeaderLocation> {
None
}
fn link_lib() -> &'static str {
if cfg!(feature = "sqlcipher") {
"sqlcipher"
} else if cfg!(all(windows, feature = "winsqlite3")) {
"winsqlite3"
} else {
"sqlite3"
}
}
}
mod build_loadable_extension {
use super::{bindings, env_prefix, header_file, HeaderLocation};
use std::env;
use std::path::Path;
pub fn main(_out_dir: &str, out_path: &Path) {
let header = find_sqlite();
bindings::write_to_out_dir(header, out_path);
}
fn find_sqlite() -> HeaderLocation {
let link_lib = "sqlite3";
println!("cargo:rerun-if-env-changed={}_INCLUDE_DIR", env_prefix());
println!("cargo:rerun-if-env-changed={}_LIB_DIR", env_prefix());
println!("cargo:rerun-if-env-changed={}_STATIC", env_prefix());
if cfg!(all(feature = "vcpkg", target_env = "msvc")) {
println!("cargo:rerun-if-env-changed=VCPKGRS_DYNAMIC");
}
if let Ok(dir) = env::var(format!("{}_LIB_DIR", env_prefix())) {
let pkgconfig_path = Path::new(&dir).join("pkgconfig");
env::set_var("PKG_CONFIG_PATH", pkgconfig_path);
return HeaderLocation::FromEnvironment;
}
if let Some(header) = try_vcpkg() {
return header;
}
match pkg_config::Config::new()
.print_system_libs(false)
.probe(link_lib)
{
Ok(mut lib) => {
if let Some(mut header) = lib.include_paths.pop() {
header.push(header_file());
HeaderLocation::FromPath(header.to_string_lossy().into())
} else {
HeaderLocation::Wrapper
}
}
Err(_) => HeaderLocation::Wrapper,
}
}
#[cfg(all(feature = "vcpkg", target_env = "msvc"))]
fn try_vcpkg() -> Option<HeaderLocation> {
let link_lib = "sqlite3";
if let Ok(mut lib) = vcpkg::Config::new().probe(link_lib) {
if let Some(mut header) = lib.include_paths.pop() {
header.push(header_file());
return Some(HeaderLocation::FromPath(header.to_string_lossy().into()));
}
}
None
}
#[cfg(not(all(feature = "vcpkg", target_env = "msvc")))]
fn try_vcpkg() -> Option<HeaderLocation> {
None
}
}
#[cfg(not(feature = "buildtime_bindgen"))]
mod bindings {
use super::HeaderLocation;
use std::fs;
use std::path::Path;
static PREBUILT_BINDGEN_PATHS: &[&str] = &[
"bindgen-bindings/bindgen_3.6.8",
#[cfg(feature = "min_sqlite_version_3_7_16")]
"bindgen-bindings/bindgen_3.7.16",
#[cfg(any(
feature = "bundled_bindings",
feature = "bundled",
all(windows, feature = "bundled-windows")
))]
"sqlite3/bindgen_bundled_version",
];
pub fn write_to_out_dir(_header: HeaderLocation, out_path: &Path) {
let in_path = format!(
"{}{}.rs",
PREBUILT_BINDGEN_PATHS[PREBUILT_BINDGEN_PATHS.len() - 1],
prebuilt_bindgen_ext()
);
fs::copy(in_path.to_owned(), out_path).unwrap_or_else(|_| {
panic!(
"Could not copy bindings to output directory from {}",
in_path
)
});
}
fn prebuilt_bindgen_ext() -> &'static str {
if cfg!(feature = "loadable_extension") {
"-ext"
} else {
""
}
}
}
#[cfg(feature = "buildtime_bindgen")]
mod bindings {
use super::HeaderLocation;
use bindgen::callbacks::{IntKind, ParseCallbacks};
use std::fs::OpenOptions;
use std::io::Write;
use std::path::Path;
#[derive(Debug)]
struct SqliteTypeChooser;
impl ParseCallbacks for SqliteTypeChooser {
fn int_macro(&self, _name: &str, value: i64) -> Option<IntKind> {
if value >= i32::min_value() as i64 && value <= i32::max_value() as i64 {
Some(IntKind::I32)
} else {
None
}
}
}
fn generating_bundled_bindings() -> bool {
println!("cargo:rerun-if-env-changed=LIBSQLITE3_SYS_BUNDLING");
matches!(std::env::var("LIBSQLITE3_SYS_BUNDLING"), Ok(v) if v != "0")
}
pub fn write_to_out_dir(header: HeaderLocation, out_path: &Path) {
let header: String = header.into();
let mut output = Vec::new();
let mut bindings = bindgen::builder()
.header(header.clone())
.parse_callbacks(Box::new(SqliteTypeChooser))
.rustfmt_bindings(true);
if cfg!(feature = "unlock_notify") {
bindings = bindings.clang_arg("-DSQLITE_ENABLE_UNLOCK_NOTIFY");
}
if cfg!(feature = "preupdate_hook") {
bindings = bindings.clang_arg("-DSQLITE_ENABLE_PREUPDATE_HOOK");
}
if cfg!(feature = "session") {
bindings = bindings.clang_arg("-DSQLITE_ENABLE_SESSION");
}
if cfg!(all(windows, feature = "winsqlite3")) {
bindings = bindings
.clang_arg("-DBINDGEN_USE_WINSQLITE3")
.blacklist_item("NTDDI_.+")
.blacklist_item("WINAPI_FAMILY.*")
.blacklist_item("_WIN32_.+")
.blacklist_item("_VCRT_COMPILER_PREPROCESSOR")
.blacklist_item("_SAL_VERSION")
.blacklist_item("__SAL_H_VERSION")
.blacklist_item("_USE_DECLSPECS_FOR_SAL")
.blacklist_item("_USE_ATTRIBUTES_FOR_SAL")
.blacklist_item("_CRT_PACKING")
.blacklist_item("_HAS_EXCEPTIONS")
.blacklist_item("_STL_LANG")
.blacklist_item("_HAS_CXX17")
.blacklist_item("_HAS_CXX20")
.blacklist_item("_HAS_NODISCARD")
.blacklist_item("WDK_NTDDI_VERSION")
.blacklist_item("OSVERSION_MASK")
.blacklist_item("SPVERSION_MASK")
.blacklist_item("SUBVERSION_MASK")
.blacklist_item("WINVER")
.blacklist_item("__security_cookie")
.blacklist_type("size_t")
.blacklist_type("__vcrt_bool")
.blacklist_type("wchar_t")
.blacklist_function("__security_init_cookie")
.blacklist_function("__report_gsfailure")
.blacklist_function("__va_start");
}
let target_arch = std::env::var("TARGET").unwrap();
let host_arch = std::env::var("HOST").unwrap();
let is_cross_compiling = target_arch != host_arch;
#[cfg(not(feature = "loadable_extension"))]
if generating_bundled_bindings() || is_cross_compiling {
bindings = bindings
.blacklist_function("sqlite3_vmprintf")
.blacklist_function("sqlite3_vsnprintf")
.blacklist_function("sqlite3_str_vappendf")
.blacklist_type("va_list")
.blacklist_type("__builtin_va_list")
.blacklist_type("__gnuc_va_list")
.blacklist_type("__va_list_tag")
.blacklist_item("__GNUC_VA_LIST");
}
#[cfg(feature = "loadable_extension")]
{
bindings = bindings.blacklist_function(".*");
}
bindings
.generate()
.unwrap_or_else(|_| panic!("could not run bindgen on header {}", header))
.write(Box::new(&mut output))
.expect("could not write output of bindgen");
let mut output = String::from_utf8(output).expect("bindgen output was not UTF-8?!");
#[cfg(feature = "loadable_extension")]
{
let api_routines_struct_name = "sqlite3_api_routines".to_owned();
let api_routines_struct = match get_struct_by_name(&output, &api_routines_struct_name) {
Some(s) => s,
None => {
panic!(
"Failed to find struct {} in early bindgen output",
api_routines_struct_name
);
}
};
#[cfg(feature = "loadable_extension")]
{
output.push_str(
r#"
// sqlite3_api is defined in lib.rs as either a static or an extern when compiled as a loadable_extension
#[cfg(feature = "loadable_extension")]
use crate::sqlite3_api;
"#,
);
}
output.push_str(
r"
// sqlite3 API wrappers to support loadable extensions (Note: these were generated from build.rs - not by rust-bindgen)
");
for field in &api_routines_struct.fields {
let ident = match &field.ident {
Some(ident) => ident,
None => {
panic!("Unexpected anonymous field in sqlite");
}
};
let field_type = &field.ty;
let api_fn_name = format!("sqlite3_{}", ident);
let wrapper = generate_wrapper(ident, field_type, &api_fn_name);
output.push_str(&wrapper);
}
output.push_str("\n");
}
let mut file = OpenOptions::new()
.write(true)
.truncate(true)
.create(true)
.open(out_path)
.unwrap_or_else(|_| panic!("Could not write to {:?}", out_path));
file.write_all(output.as_bytes())
.unwrap_or_else(|_| panic!("Could not write to {:?}", out_path));
}
#[cfg(feature = "loadable_extension")]
fn get_struct_by_name(bindgen_sources: &str, name: &str) -> Option<syn::ItemStruct> {
let file = syn::parse_file(&bindgen_sources).expect("unable to parse early bindgen output");
for item in &file.items {
if let syn::Item::Struct(s) = item {
if s.ident == name {
return Some(s.to_owned());
}
}
}
None
}
#[cfg(feature = "loadable_extension")]
fn bare_fn_from_type_path(t: &syn::Type) -> syn::TypeBareFn {
let path = match t {
syn::Type::Path(tp) => &tp.path,
_ => {
panic!("type was not a type path");
}
};
let mut path_args: Option<syn::PathArguments> = None;
for segment in &path.segments {
if segment.arguments.is_empty() {
continue;
}
path_args = Some(segment.arguments.to_owned());
break;
}
match path_args {
Some(syn::PathArguments::AngleBracketed(p)) => {
for gen_arg in p.args {
match gen_arg {
syn::GenericArgument::Type(syn::Type::BareFn(bf)) => {
return bf;
}
_ => {
panic!("parsed type was not a bare function as expected");
}
};
}
}
_ => {
panic!("parsed path args were not angle bracketed as expected");
}
};
panic!("unexpected failure to parse bare function");
}
#[cfg(feature = "loadable_extension")]
fn generate_wrapper(
field_ident: &syn::Ident,
syn_type: &syn::Type,
api_fn_name: &str,
) -> String {
use quote::quote;
use syn::Token;
let field_name = field_ident.to_string();
let api_fn_ident = syn::Ident::new(&api_fn_name, field_ident.span());
let bare_fn = bare_fn_from_type_path(syn_type);
let api_fn_output = &bare_fn.output;
let mut api_fn_inputs = bare_fn.inputs.clone();
if bare_fn.variadic.is_some() {
let var_arg_types: Vec<Option<syn::Type>> = match api_fn_name {
"sqlite3_db_config" => {
let mut_int_type: syn::TypeReference = syn::parse2(quote!(&mut i32))
.expect("failed to parse mutable integer reference");
vec![None, Some(syn::Type::Reference(mut_int_type))]
}
_ => vec![None],
};
for (index, var_arg_type) in var_arg_types.iter().enumerate() {
let mut input = api_fn_inputs[api_fn_inputs.len() - 1].clone();
let input_ident =
syn::Ident::new(&format!("vararg{}", index + 1), field_ident.span());
let colon = Token);
input.name = Some((input_ident, colon));
if let Some(t) = var_arg_type.to_owned() {
input.ty = t;
}
api_fn_inputs.push(input);
}
}
let api_fn_input_idents: Vec<syn::Ident> = (&api_fn_inputs)
.into_iter()
.map(|input| match &input.name {
Some((ident, _)) => ident.to_owned(),
_ => {
panic!("Input has no name {:#?}", input);
}
})
.collect();
let wrapper_tokens = quote! {
pub unsafe fn #api_fn_ident(#api_fn_inputs) #api_fn_output {
if sqlite3_api.is_null() {
panic!("sqlite3_api is null");
}
((*sqlite3_api).#field_ident
.expect(stringify!("sqlite3_api contains null pointer for ", #field_name, " function")))(
#(#api_fn_input_idents),*
)
}
};
return format!("{}\n\n", wrapper_tokens.to_string());
}
}