[go: up one dir, main page]

cxx 0.1.2

Safe interop between Rust and C++
Documentation 
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

// Functionality that is shared between the cxxbridge macro and the cmd.

pub mod atom;
mod attrs;
pub mod check;
mod doc;
pub mod error;
pub mod ident;
mod impls;
mod parse;
pub mod set;
mod tokens;
pub mod types;

use proc_macro2::Ident;
use syn::{LitStr, Token};

pub use self::atom::Atom;
pub use self::doc::Doc;
pub use self::parse::parse_items;
pub use self::types::Types;

pub enum Api {
    Include(LitStr),
    Struct(Struct),
    CxxType(ExternType),
    CxxFunction(ExternFn),
    RustType(ExternType),
    RustFunction(ExternFn),
}

pub struct ExternType {
    pub doc: Doc,
    pub type_token: Token![type],
    pub ident: Ident,
}

pub struct Struct {
    pub doc: Doc,
    pub derives: Vec<Ident>,
    pub struct_token: Token![struct],
    pub ident: Ident,
    pub fields: Vec<Var>,
}

pub struct ExternFn {
    pub doc: Doc,
    pub fn_token: Token![fn],
    pub ident: Ident,
    pub receiver: Option<Receiver>,
    pub args: Vec<Var>,
    pub ret: Option<Type>,
    pub semi_token: Token![;],
}

pub struct Var {
    pub ident: Ident,
    pub ty: Type,
}

pub struct Receiver {
    pub mutability: Option<Token![mut]>,
    pub ident: Ident,
}

#[derive(Hash, Eq, PartialEq)]
pub enum Type {
    Ident(Ident),
    RustBox(Box<Ty1>),
    UniquePtr(Box<Ty1>),
    Ref(Box<Ref>),
    Str(Box<Ref>),
}

pub struct Ty1 {
    pub name: Ident,
    pub langle: Token![<],
    pub inner: Type,
    pub rangle: Token![>],
}

pub struct Ref {
    pub ampersand: Token![&],
    pub mutability: Option<Token![mut]>,
    pub inner: Type,
}

#[derive(Copy, Clone, PartialEq)]
pub enum Derive {
    Clone,
    Copy,
}