      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
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179

    extern crate libloading;

    pub use libloading::{Library, Symbol};

    #[cfg(feature = "dlopen")]
    #[macro_export]
    macro_rules! ffi_dispatch(
        ($handle: ident, $func: ident, $($arg: expr),*) => (
            ($handle.$func)($($arg),*)
        )
    );

    #[cfg(not(feature = "dlopen"))]
    #[macro_export]
    macro_rules! ffi_dispatch(
        ($handle: ident, $func: ident, $($arg: expr),*) => (
            $func($($arg),*)
        )
    );

    #[cfg(feature = "dlopen")]
    #[macro_export]
    macro_rules! ffi_dispatch_static(
        ($handle: ident, $name: ident) => (
            $handle.$name
        )
    );

    #[cfg(not(feature = "dlopen"))]
    #[macro_export]
    macro_rules! ffi_dispatch_static(
        ($handle: ident, $name: ident) => (
            &$name
        )
    );

    #[macro_export]
    macro_rules! link_external_library(
        ($link: expr,
            $(statics: $($sname: ident: $stype: ty),+,)|*
            $(functions: $(fn $fname: ident($($farg: ty),*) -> $fret:ty),+,)|*
            $(varargs: $(fn $vname: ident($($vargs: ty),+) -> $vret: ty),+,)|*
        ) => (
            #[link(name = $link)]
            extern "C" {
                $($(
                    pub static $sname: $stype;
                )+)*
                $($(
                    pub fn $fname($(_: $farg),*) -> $fret;
                )+)*
                $($(
                    pub fn $vname($(_: $vargs),+ , ...) -> $vret;
                )+)*
            }
        );
    );

    pub enum DlError {
        NotFound,
        MissingSymbol(&'static str)
    }

    #[macro_export]
    macro_rules! dlopen_external_library(
        (__struct, $structname: ident,
            $(statics: $($sname: ident: $stype: ty),+,)|*
            $(functions: $(fn $fname: ident($($farg: ty),*) -> $fret:ty),+,)|*
            $(varargs: $(fn $vname: ident($($vargs: ty),+) -> $vret: ty),+,)|*
        ) => (
            pub struct $structname {
                __lib: $crate::Library,
                $($(
                    pub $sname: $crate::Symbol<'static, &'static $stype>,
                )+)*
                $($(
                    pub $fname: $crate::Symbol<'static, unsafe extern "C" fn($($farg),*) -> $fret>,
                )+)*
                $($(
                    pub $vname: $crate::Symbol<'static, unsafe extern "C" fn($($vargs),+ , ...) -> $vret>,
                )+)*
            }
        );
        (__impl, $structname: ident,
            $(statics: $($sname: ident: $stype: ty),+,)|*
            $(functions: $(fn $fname: ident($($farg: ty),*) -> $fret:ty),+,)|*
            $(varargs: $(fn $vname: ident($($vargs: ty),+) -> $vret: ty),+,)|*
        ) => (
        impl $structname {
            pub fn open(name: &str) -> Result<$structname, $crate::DlError> {
                // we use it to ensure the 'static lifetime
                use std::mem::transmute;
                let lib = match $crate::Library::new(name) {
                    Ok(l) => l,
                    Err(_) => return Err($crate::DlError::NotFound)
                };
                unsafe {
                    let s = $structname {
                        $($($sname: {
                            let s_name = concat!(stringify!($sname), "\0");
                            transmute(match lib.get::<&'static $stype>(s_name.as_bytes()) {
                                Ok(s) => s,
                                Err(_) => return Err($crate::DlError::MissingSymbol(s_name))
                            })
                        },
                        )+)*
                        $($($fname: {
                            let s_name = concat!(stringify!($fname), "\0");
                            transmute(match lib.get::<unsafe extern "C" fn($($farg),*) -> $fret>(s_name.as_bytes()) {
                                Ok(s) => s,
                                Err(_) => return Err($crate::DlError::MissingSymbol(s_name))
                            })
                        },
                        )+)*
                        $($($vname: {
                            let s_name = concat!(stringify!($vname), "\0");
                            transmute(match lib.get::<unsafe extern "C" fn($($vargs),+ , ...) -> $vret>(s_name.as_bytes()) {
                                Ok(s) => s,
                                Err(_) => return Err($crate::DlError::MissingSymbol(s_name))
                            })
                        },
                        )+)*
                        __lib: lib
                    };
                    Ok(s)
                }
            }
        }
        );
        ($structname: ident,
            $(statics: $($sname: ident: $stype: ty),+,)|*
            $(functions: $(fn $fname: ident($($farg: ty),*) -> $fret:ty),+,)|*
            $(varargs: $(fn $vname: ident($($vargs: ty),+) -> $vret: ty),+,)|*
        ) => (
            dlopen_external_library!(__struct,
                $structname, $(statics: $($sname: $stype),+,)|*
                $(functions: $(fn $fname($($farg),*) -> $fret),+,)|*
                $(varargs: $(fn $vname($($vargs),+) -> $vret),+,)|*
            );
            dlopen_external_library!(__impl,
                $structname, $(statics: $($sname: $stype),+,)|*
                $(functions: $(fn $fname($($farg),*) -> $fret),+,)|*
                $(varargs: $(fn $vname($($vargs),+) -> $vret),+,)|*
            );
            unsafe impl Sync for $structname { }
        );
    );

    #[cfg(not(feature = "dlopen"))]
    #[macro_export]
    macro_rules! external_library(
        ($structname: ident, $link: expr,
            $(statics: $($sname: ident: $stype: ty),+,)|*
            $(functions: $(fn $fname: ident($($farg: ty),*) -> $fret:ty),+,)|*
            $(varargs: $(fn $vname: ident($($vargs: ty),+) -> $vret: ty),+,)|*
        ) => (
            link_external_library!(
                $link, $(statics: $($sname: $stype),+,)|*
                $(functions: $(fn $fname($($farg),*) -> $fret),+,)|*
                $(varargs: $(fn $vname($($vargs),+) -> $vret),+,)|*
            );
        );
    );

    #[cfg(feature = "dlopen")]
    #[macro_export]
    macro_rules! external_library(
        ($structname: ident, $link: expr,
            $(statics: $($sname: ident: $stype: ty),+,)|*
            $(functions: $(fn $fname: ident($($farg: ty),*) -> $fret:ty),+,)|*
            $(varargs: $(fn $vname: ident($($vargs: ty),+) -> $vret: ty),+,)|*
        ) => (
            dlopen_external_library!(
                $structname, $(statics: $($sname: $stype),+,)|*
                $(functions: $(fn $fname($($farg),*) -> $fret),+,)|*
                $(varargs: $(fn $vname($($vargs),+) -> $vret),+,)|*
            );
        );
    );

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)