godot-macros 0.5.2

Internal crate used by godot-rust
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

/*
 * Copyright (c) godot-rust; Bromeon and contributors.
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
#[cfg(all(feature = "register-docs", since_api = "4.3"))] #[cfg_attr(published_docs, doc(cfg(all(feature = "register-docs", since_api = "4.3"))))]
mod extract_docs;
#[cfg(all(feature = "register-docs", since_api = "4.3"))] #[cfg_attr(published_docs, doc(cfg(all(feature = "register-docs", since_api = "4.3"))))]
mod markdown_converter;

use proc_macro2::{Ident, TokenStream};

use crate::class::{ConstDefinition, Field, FuncDefinition, SignalDefinition};

#[cfg(all(feature = "register-docs", since_api = "4.3"))] #[cfg_attr(published_docs, doc(cfg(all(feature = "register-docs", since_api = "4.3"))))]
mod docs_generators {
    use quote::quote;

    use super::*;

    pub fn make_struct_docs_registration(
        base: String,
        description: &[venial::Attribute],
        fields: &[Field],
        class_name: &Ident,
        prv: &TokenStream,
    ) -> TokenStream {
        let struct_docs = extract_docs::document_struct(base, description, fields);
        quote! {
            ::godot::sys::plugin_add!(#prv::__GODOT_DOCS_REGISTRY; #prv::DocsPlugin::new::<#class_name>(
                #prv::DocsItem::Struct(
                    #struct_docs
                )
            ));
        }
    }

    pub fn make_trait_docs_registration(
        functions: &[FuncDefinition],
        constants: &[ConstDefinition],
        signals: &[SignalDefinition],
        class_name: &Ident,
        prv: &TokenStream,
    ) -> TokenStream {
        let extract_docs::InherentImplXmlDocs {
            method_xml_elems,
            constant_xml_elems,
            signal_xml_elems,
        } = extract_docs::document_inherent_impl(functions, constants, signals);

        quote! {
            ::godot::sys::plugin_add!(#prv::__GODOT_DOCS_REGISTRY; #prv::DocsPlugin::new::<#class_name>(
                #prv::DocsItem::InherentImpl(#prv::InherentImplDocs {
                    methods_xml: #method_xml_elems,
                    signals_xml: #signal_xml_elems,
                    constants_xml: #constant_xml_elems
                })
            ));
        }
    }

    pub fn make_interface_impl_docs_registration(
        impl_members: &[venial::ImplMember],
        class_name: &Ident,
        prv: &TokenStream,
    ) -> TokenStream {
        let virtual_methods = extract_docs::document_interface_trait_impl(impl_members);

        quote! {
            ::godot::sys::plugin_add!(#prv::__GODOT_DOCS_REGISTRY; #prv::DocsPlugin::new::<#class_name>(
                #prv::DocsItem::ITraitImpl(#virtual_methods)
            ));
        }
    }
}

#[cfg(all(feature = "register-docs", since_api = "4.3"))] #[cfg_attr(published_docs, doc(cfg(all(feature = "register-docs", since_api = "4.3"))))]
pub use docs_generators::*;

#[cfg(not(all(feature = "register-docs", since_api = "4.3")))] #[cfg_attr(published_docs, doc(cfg(not(all(feature = "register-docs", since_api = "4.3")))))]
mod placeholders {
    use super::*;

    pub fn make_struct_docs_registration(
        _base: String,
        _description: &[venial::Attribute],
        _fields: &[Field],
        _class_name: &Ident,
        _prv: &TokenStream,
    ) -> TokenStream {
        TokenStream::new()
    }

    pub fn make_trait_docs_registration(
        _functions: &[FuncDefinition],
        _constants: &[ConstDefinition],
        _signals: &[SignalDefinition],
        _class_name: &Ident,
        _prv: &proc_macro2::TokenStream,
    ) -> TokenStream {
        TokenStream::new()
    }

    pub fn make_interface_impl_docs_registration(
        _impl_members: &[venial::ImplMember],
        _class_name: &Ident,
        _prv: &TokenStream,
    ) -> TokenStream {
        TokenStream::new()
    }
}

#[cfg(not(all(feature = "register-docs", since_api = "4.3")))] #[cfg_attr(published_docs, doc(cfg(not(all(feature = "register-docs", since_api = "4.3")))))]
pub use placeholders::*;