Skip to content

Generated name override #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/callbacks.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ pub trait ParseCallbacks: fmt::Debug + UnwindSafe {
MacroParsingBehavior::Default
}

/// This function will run for every function. The returned value determines the name visible
/// in the bindings.
fn generated_name_override(&self, _function_name: &str) -> Option<String> {
None
}

/// The integer kind an integer macro should have, given a name and the
/// value of that macro, or `None` if you want the default to be chosen.
fn int_macro(&self, _name: &str, _value: i64) -> Option<IntKind> {
Expand Down
6 changes: 6 additions & 0 deletions src/ir/function.rs
Original file line number Diff line number Diff line change
Expand Up @@ -635,6 +635,12 @@ impl ClangSubItemParser for Function {
// but seems easy enough to handle it here.
name.push_str("_destructor");
}
if let Some(callbacks) = context.parse_callbacks() {
if let Some(nm) = callbacks.generated_name_override(&name) {
name = nm;
}
}
assert!(!name.is_empty(), "Empty function name.");

let mangled_name = cursor_mangling(context, &cursor);
let comment = cursor.raw_comment();
Expand Down
11 changes: 11 additions & 0 deletions tests/expectations/tests/issue-1375-prefixed-functions.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#![allow(
dead_code,
non_snake_case,
non_camel_case_types,
non_upper_case_globals
)]

extern "C" {
#[link_name = "\u{1}my_custom_prefix_function_name"]
pub fn function_name(x: ::std::os::raw::c_int);
}
4 changes: 4 additions & 0 deletions tests/headers/issue-1375-prefixed-functions.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// bindgen-parse-callbacks: remove-function-prefix-my_custom_prefix_

void my_custom_prefix_function_name(const int x);

38 changes: 37 additions & 1 deletion tests/parse_callbacks/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
use bindgen::callbacks::*;

#[derive(Debug)]
pub struct RemoveFunctionPrefixParseCallback {
pub remove_function_prefix: Option<String>,
}

impl RemoveFunctionPrefixParseCallback {
pub fn new(prefix: &str) -> Self {
RemoveFunctionPrefixParseCallback {
remove_function_prefix: Some(prefix.to_string()),
}
}
}

impl ParseCallbacks for RemoveFunctionPrefixParseCallback {
fn generated_name_override(&self, function_name: &str) -> Option<String> {
if let Some(prefix) = &self.remove_function_prefix {
if function_name.starts_with(prefix) {
return Some(function_name[prefix.len()..].to_string());
}
}
None
}
}

#[derive(Debug)]
struct EnumVariantRename;

Expand Down Expand Up @@ -37,6 +61,18 @@ pub fn lookup(cb: &str) -> Box<dyn ParseCallbacks> {
"blocklisted-type-implements-trait" => {
Box::new(BlocklistedTypeImplementsTrait)
}
_ => panic!("Couldn't find name ParseCallbacks: {}", cb),
call_back => {
if call_back.starts_with("remove-function-prefix-") {
let prefix = call_back
.split("remove-function-prefix-")
.last()
.to_owned();
let lnopc =
RemoveFunctionPrefixParseCallback::new(prefix.unwrap());
Box::new(lnopc)
} else {
panic!("Couldn't find name ParseCallbacks: {}", cb)
}
}
}
}