rusteron_code_gen/

parser.rs

use crate::generator::{parse_custom_methods, CBinding, CWrapper, Method};
use crate::{Arg, ArgProcessing, CHandler};
use itertools::Itertools;
use quote::ToTokens;
use std::collections::{BTreeMap, BTreeSet};
use std::fs;
use std::path::PathBuf;
use syn::{Attribute, Item, ItemForeignMod, ItemStruct, ItemType, Lit, Meta, MetaNameValue};

/// bindgen maps C `va_list` to platform-specific opaque types (e.g.
/// `__va_list_tag` on Linux, `VaListTag` on some platforms).  These never
/// need a real Rust repr — replace every occurrence with `*mut c_char`
/// so the generated handler wrappers compile everywhere.
fn normalise_va_list(c_type: &str) -> String {
    for needle in &["va_list", "__va_list_tag", "VaListTag", "__builtin_va_list"] {
        if c_type.contains(needle) {
            return "*mut ::std::os::raw::c_char".to_string();
        }
    }
    c_type.to_string()
}

pub fn parse_bindings(out: &PathBuf) -> CBinding {
    parse_bindings_with_custom(out, &[])
}

/// Like [`parse_bindings`], additionally scanning per-crate custom code (appended after the
/// common `aeron_custom.rs`) so its hand-written methods are skipped during generation.
pub fn parse_bindings_with_custom(out: &PathBuf, extra_custom_code: &[&str]) -> CBinding {
    let file_content = fs::read_to_string(out.clone()).expect("Unable to read file");
    let syntax_tree = syn::parse_file(&file_content).expect("Unable to parse file");
    let mut wrappers = BTreeMap::new();
    let mut methods = Vec::new();
    let mut handlers = Vec::new();

    let items = syntax_tree.items;

    for item in &items {
        if let Item::Type(ty) = item {
            process_type(&mut wrappers, &mut handlers, ty);
        }
    }

    let handler_names = handlers
        .iter()
        .filter(|h| {
            !["aeron_udp_channel", "aeron_udp_transport"]
                .iter()
                .any(|&filter| h.type_name.starts_with(filter))
        })
        .map(|handler| handler.type_name.clone())
        .collect();

    for item in &items {
        if let Item::Struct(s) = item {
            process_struct(&mut wrappers, s, &handler_names);
        }
    }

    for item in &items {
        if let Item::ForeignMod(fm) = item {
            process_c_method(&mut wrappers, &mut methods, fm, &handler_names);
        }
    }

    let mut bindings = CBinding {
        wrappers: wrappers
            .into_iter()
            .filter(|(_, wrapper)| {
                // these are from media driver and do not follow convention
                ![
                    "aeron_thread",
                    "aeron_command",
                    "aeron_executor",
                    "aeron_name_resolver",
                    "aeron_udp_channel_transport", // this one I have issues with handlers
                    "aeron_udp_transport",         // this one I have issues with handlers
                ]
                .iter()
                .any(|&filter| wrapper.type_name.starts_with(filter))
            })
            .collect(),
        methods,
        handlers: handlers
            .into_iter()
            .filter(|h| {
                !["aeron_udp_channel", "aeron_udp_transport"]
                    .iter()
                    .any(|&filter| h.type_name.starts_with(filter))
            })
            .collect(),
    };

    let mismatched_types = bindings
        .wrappers
        .iter()
        .filter(|(key, w)| key.as_str() != w.type_name)
        .map(|(a, b)| (a.clone(), b.clone()))
        .collect_vec();
    assert_eq!(Vec::<(String, CWrapper)>::new(), mismatched_types);

    let mut custom = parse_custom_methods(crate::CUSTOM_AERON_CODE);
    for code in extra_custom_code {
        for (class, methods) in parse_custom_methods(code) {
            custom.entry(class).or_default().extend(methods);
        }
    }
    for wrapper in bindings.wrappers.values_mut() {
        if let Some(methods) = custom.get(&wrapper.class_name) {
            wrapper.skipped_methods = methods.clone();
        }
    }

    bindings
}

fn process_c_method(
    wrappers: &mut BTreeMap<String, CWrapper>,
    methods: &mut Vec<Method>,
    fm: &ItemForeignMod,
    handler_names: &BTreeSet<String>,
) {
    // Extract functions inside extern "C" blocks
    if fm.abi.name.is_some() && fm.abi.name.as_ref().unwrap().value() == "C" {
        for foreign_item in &fm.items {
            if let syn::ForeignItem::Fn(f) = foreign_item {
                let docs = get_doc_comments(&f.attrs);
                let fn_name = f.sig.ident.to_string();

                // aeronc.h has a deprecated typo alias:
                //   aeron_async_add_exclusive_exclusive_publication_get_registration_id
                // (note the doubled "exclusive"). It attaches to the same wrapper as the
                // canonical aeron_async_add_exclusive_publication_get_registration_id and
                // would either collide with it or emit a garbled method name. Upstream
                // marks it @deprecated, so drop it outright.
                if fn_name.contains("exclusive_exclusive") {
                    continue;
                }

                // Get function arguments and return type as Rust code
                let args = extract_function_arguments(&f.sig.inputs);
                let ret = extract_return_type(&f.sig.output);

                let option = if let Some(arg) = args
                    .iter()
                    .skip_while(|a| a.is_mut_pointer() && a.is_primitive())
                    .next()
                {
                    let ty = &arg.c_type;
                    let ty = ty.split(' ').last().map(|t| t.to_string()).unwrap();
                    if wrappers.contains_key(&ty) {
                        Some(ty)
                    } else {
                        find_closest_wrapper_from_method_name(wrappers, &fn_name)
                    }
                } else {
                    find_closest_wrapper_from_method_name(wrappers, &fn_name)
                };

                match option {
                    Some(key) => {
                        let wrapper = wrappers.get_mut(&key).unwrap();
                        wrapper.methods.push(Method {
                            fn_name: fn_name.clone(),
                            struct_method_name: fn_name
                                .replace(&wrapper.type_name[..wrapper.type_name.len() - 1], "")
                                .to_string(),
                            return_type: Arg {
                                name: "".to_string(),
                                c_type: ret.clone(),
                                processing: ArgProcessing::Default,
                            },
                            arguments: process_types(args.clone(), Some(handler_names)),
                            docs: docs.clone(),
                        });
                    }
                    None => methods.push(Method {
                        fn_name: fn_name.clone(),
                        struct_method_name: "".to_string(),
                        return_type: Arg {
                            name: "".to_string(),
                            c_type: ret.clone(),
                            processing: ArgProcessing::Default,
                        },
                        arguments: process_types(args.clone(), Some(handler_names)),
                        docs: docs.clone(),
                    }),
                }
            }
        }
    }
}

fn find_closest_wrapper_from_method_name(
    wrappers: &mut BTreeMap<String, CWrapper>,
    fn_name: &String,
) -> Option<String> {
    let type_names = get_possible_wrappers(&fn_name);

    let mut value = None;
    for ty in type_names {
        if wrappers.contains_key(&ty) {
            value = Some(ty);
            break;
        }
    }

    value
}

pub fn get_possible_wrappers(fn_name: &str) -> Vec<String> {
    // Try all possible wrapper names by splitting at underscores
    fn_name
        .char_indices()
        .filter(|(_, c)| *c == '_')
        .map(|(i, _)| format!("{}_t", &fn_name[..i]))
        .rev()
        .collect_vec()
}

fn process_type(wrappers: &mut BTreeMap<String, CWrapper>, handlers: &mut Vec<CHandler>, ty: &ItemType) {
    // Handle type definitions and get docs
    let docs = get_doc_comments(&ty.attrs);

    let type_name = ty.ident.to_string();
    let class_name = snake_to_pascal_case(&type_name);

    if is_struct_typedef(&ty.ty) {
        wrappers
            .entry(type_name.clone())
            .or_insert(CWrapper {
                class_name,
                without_name: type_name[..type_name.len() - 2].to_string(),
                type_name,
                ..Default::default()
            })
            .docs
            .extend(docs);
    } else {
        // Parse the function pointer type -> it is typically used for handlers/callbacks
        if let syn::Type::Path(type_path) = &*ty.ty {
            if let Some(segment) = type_path.path.segments.last() {
                if segment.ident.to_string() == "Option" {
                    if let syn::PathArguments::AngleBracketed(args) = &segment.arguments {
                        if let Some(syn::GenericArgument::Type(syn::Type::BareFn(bare_fn))) = args.args.first() {
                            let args: Vec<Arg> = bare_fn
                                .inputs
                                .iter()
                                .map(|arg| {
                                    let arg_name = match &arg.name {
                                        Some((ident, _)) => ident.to_string(),
                                        None => "".to_string(),
                                    };
                                    let arg_type = arg.ty.to_token_stream().to_string();
                                    (arg_name, arg_type)
                                })
                                .map(|(field_name, field_type)| Arg {
                                    name: field_name,
                                    c_type: normalise_va_list(&field_type),
                                    processing: ArgProcessing::Default,
                                })
                                .collect();
                            let string = bare_fn.output.to_token_stream().to_string();
                            let mut return_type = string.trim();

                            if return_type.starts_with("-> ") {
                                return_type = &return_type[3..];
                            }

                            if return_type.is_empty() {
                                return_type = "()";
                            }

                            if is_handler_typedef(&args) {
                                let value = CHandler {
                                    type_name: ty.ident.to_string(),
                                    args: process_types(args, None),
                                    return_type: Arg {
                                        name: "".to_string(),
                                        c_type: return_type.to_string(),
                                        processing: ArgProcessing::Default,
                                    },
                                    docs: docs.clone(),
                                    fn_mut_signature: Default::default(),
                                    closure_type_name: Default::default(),
                                };
                                handlers.push(value);
                            }
                        }
                    }
                }
            }
        }
    }
}

fn is_handler_typedef(args: &[Arg]) -> bool {
    args.iter().filter(|arg| arg.is_c_void()).count() == 1
        || args
            .first()
            .map(|arg| arg.is_c_void() && is_client_data_arg(&arg.name))
            .unwrap_or(false)
}

fn is_client_data_arg(name: &str) -> bool {
    name == "clientd"
        || name == "state"
        || name == "task_clientd"
        || name.ends_with("_clientd")
        || name.ends_with("_state")
}

fn is_struct_typedef(ty: &syn::Type) -> bool {
    if let syn::Type::Path(type_path) = ty {
        if let Some(segment) = type_path.path.segments.last() {
            return segment.ident.to_string().ends_with("_stct");
        }
    }

    false
}

fn process_struct(wrappers: &mut BTreeMap<String, CWrapper>, s: &ItemStruct, handler_names: &BTreeSet<String>) {
    if !matches!(s.fields, syn::Fields::Named(_)) {
        return;
    }

    // Print the struct name and its doc comments
    let docs = get_doc_comments(&s.attrs);
    let type_name = s.ident.to_string().replace("_stct", "_t");
    let class_name = snake_to_pascal_case(&type_name);

    let fields: Vec<Arg> = s
        .fields
        .iter()
        .map(|f| {
            let field_name = f.ident.as_ref().unwrap().to_string();
            let field_type = f.ty.to_token_stream().to_string();
            (field_name, field_type)
        })
        .map(|(field_name, field_type)| Arg {
            name: field_name,
            c_type: field_type,
            processing: ArgProcessing::Default,
        })
        .collect();

    let w = wrappers.entry(type_name.to_string()).or_insert(CWrapper {
        class_name,
        without_name: type_name[..type_name.len() - 2].to_string(),
        type_name,
        ..Default::default()
    });
    w.docs.extend(docs);
    w.fields = process_types(fields, Some(handler_names));
}

fn process_types(mut name_and_type: Vec<Arg>, handler_names: Option<&BTreeSet<String>>) -> Vec<Arg> {
    // now mark arguments which can be reduced
    for i in 1..name_and_type.len() {
        let param1 = &name_and_type[i - 1];
        let param2 = &name_and_type[i];

        let is_int = param2.c_type == "usize" || param2.c_type == "i32";
        // Length fields use varied names across Aeron headers; match the common ones so
        // (buffer, length) pairs merge into a slice rather than leaking two raw params.
        let length_field = matches!(param2.name.as_str(), "length" | "len" | "count" | "capacity")
            || param2.name.ends_with("_length")
            || param2.name.ends_with("_len")
            || param2.name.ends_with("_size");
        if param2.is_c_void()
            && !param1.is_mut_pointer()
            && param1.c_type.ends_with("_t")
            && handler_names
                .map(|handler_names| handler_names.contains(&param1.c_type))
                .unwrap_or(false)
        {
            // closures
            //         handler: aeron_on_available_counter_t,
            //         clientd: *mut ::std::os::raw::c_void,
            let processing = ArgProcessing::Handler(vec![param1.clone(), param2.clone()]);
            name_and_type[i - 1].processing = processing.clone();
            name_and_type[i].processing = processing.clone();
        } else if param1.is_c_string_any() && is_int && length_field {
            //     pub stripped_channel: *mut ::std::os::raw::c_char,
            //     pub stripped_channel_length: usize,
            // `*const` pairs become `&str` arguments; `*mut` pairs are C fill-buffers
            // (snprintf-style) and become `&mut [u8]` arguments / `&str` field reads.
            let processing = ArgProcessing::StringWithLength(vec![param1.clone(), param2.clone()]);
            name_and_type[i - 1].processing = processing.clone();
            name_and_type[i].processing = processing.clone();
        } else if param1.is_byte_array() && is_int && length_field {
            //         key_buffer: *const u8,
            //         key_buffer_length: usize,
            let processing = ArgProcessing::ByteArrayWithLength(vec![param1.clone(), param2.clone()]);
            name_and_type[i - 1].processing = processing.clone();
            name_and_type[i].processing = processing.clone();
        }

        //
    }

    name_and_type
}

// Helper function to extract doc comments
fn get_doc_comments(attrs: &[Attribute]) -> BTreeSet<String> {
    attrs
        .iter()
        .filter_map(|attr| {
            // Parse the attribute meta to check if it is a `Meta::NameValue`
            if let Meta::NameValue(MetaNameValue {
                path,
                value: syn::Expr::Lit(expr_lit),
                ..
            }) = &attr.meta
            {
                // Check if the path is "doc"
                if path.is_ident("doc") {
                    // Check if the literal is a string and return its value
                    if let Lit::Str(lit_str) = &expr_lit.lit {
                        return Some(lit_str.value().trim().to_string());
                    }
                }
            }
            None
        })
        .collect()
}

pub fn snake_to_pascal_case(mut snake: &str) -> String {
    if snake.ends_with("_t") {
        snake = &snake[..snake.len() - 2];
    }
    snake
        .split('_')
        .filter(|x| *x != "on") // Split the string by underscores
        .map(|word| {
            let mut chars = word.chars();
            // Capitalize the first letter and collect the rest of the letters
            match chars.next() {
                Some(c) => c.to_uppercase().collect::<String>() + chars.as_str(),
                None => String::new(),
            }
        })
        .collect()
}

// Helper function to extract function arguments as Rust code
fn extract_function_arguments(inputs: &syn::punctuated::Punctuated<syn::FnArg, syn::token::Comma>) -> Vec<Arg> {
    inputs
        .iter()
        .map(|arg| match arg {
            syn::FnArg::Receiver(_) => "self".to_string(), // Handle self receiver
            syn::FnArg::Typed(pat_type) => pat_type.to_token_stream().to_string(), // Convert the pattern and type to Rust code
        })
        .map(|arg| {
            arg.splitn(2, ':')
                .map(|s| s.trim().to_string())
                .collect_tuple()
                .unwrap()
        })
        .map(|(name, ty)| Arg {
            name,
            c_type: ty,
            processing: ArgProcessing::Default,
        })
        .collect_vec()
}

// Helper function to extract return type as Rust code
fn extract_return_type(output: &syn::ReturnType) -> String {
    match output {
        syn::ReturnType::Default => "()".to_string(), // No return type, equivalent to ()
        syn::ReturnType::Type(_, ty) => ty.to_token_stream().to_string(), // Convert the type to Rust code
    }
}

#[cfg(test)]
mod tests {
    use crate::parser::parse_bindings;
    use crate::ArgProcessing;
    use std::path::PathBuf;

    fn running_under_valgrind() -> bool {
        std::env::var_os("RUSTERON_VALGRIND").is_some()
    }

    #[test]
    fn media_driver() {
        if running_under_valgrind() {
            return;
        }

        let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("bindings")
            .join("media-driver.rs");
        let bindings = parse_bindings(&path);
        assert_eq!(
            "AeronImageFragmentAssembler",
            bindings
                .wrappers
                .get("aeron_image_fragment_assembler_t")
                .unwrap()
                .class_name
        );
    }
    #[test]
    fn client() {
        if running_under_valgrind() {
            return;
        }

        let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("bindings")
            .join("client.rs");
        let bindings = parse_bindings(&path);
        assert_eq!(
            "AeronImageFragmentAssembler",
            bindings
                .wrappers
                .get("aeron_image_fragment_assembler_t")
                .unwrap()
                .class_name
        );
        assert!(bindings.handlers.len() > 1);
    }

    /// `(buffer, frame_length)` must merge into one slice; old heuristic missed `frame_length`.
    #[test]
    fn reserved_value_supplier_buffer_merges_with_frame_length() {
        if running_under_valgrind() {
            return;
        }

        let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("bindings")
            .join("client.rs");
        let bindings = parse_bindings(&path);
        let handler = bindings
            .handlers
            .iter()
            .find(|h| h.type_name == "aeron_reserved_value_supplier_t")
            .expect("reserved value supplier handler missing");
        let buffer = handler.args.iter().find(|a| a.name == "buffer").unwrap();
        assert!(
            matches!(buffer.processing, ArgProcessing::ByteArrayWithLength(_)),
            "buffer must merge with frame_length into a slice, got {:?}",
            buffer.processing
        );
    }

    /// `*mut c_char` fill-buffers must merge so the wrapper takes `&mut [u8]`.
    #[test]
    fn mut_string_fill_buffer_merges() {
        if running_under_valgrind() {
            return;
        }

        let path = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
            .join("bindings")
            .join("client.rs");
        let bindings = parse_bindings(&path);
        let reader = bindings.wrappers.get("aeron_counters_reader_t").unwrap();
        let method = reader
            .methods
            .iter()
            .find(|m| m.fn_name == "aeron_counters_reader_counter_label")
            .expect("counter_label method missing");
        let buffer = method.arguments.iter().find(|a| a.name == "buffer").unwrap();
        assert!(
            matches!(buffer.processing, ArgProcessing::StringWithLength(_)),
            "mut string buffer must merge with its length, got {:?}",
            buffer.processing
        );
    }
}