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
180
181
182
183
184

//! Test
//! ## Feature flags
#![cfg_attr(
    feature = "docs",
    cfg_attr(doc, doc = ::document_features::document_features!())
)]

#![warn(missing_docs)]

#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(feature = "alloc")]
extern crate alloc;

pub mod compose;

mod env;

pub mod ream;

mod book;

mod real;

pub mod aspects;

mod geometry;

pub use book::*;
// pub use ream::*;
pub use env::*;
// pub use aspects::*;
pub use geometry::*;
pub use real::*;

/// Base trait for all sketches.
///
/// A user does not need to interact with this trait directly.
///
/// A sketch is a type that contains a page from an environment.
/// The sketch is then run within the environment and handles the events it generates.
pub trait Sketch {
    /// Environment the sketch can run in.
    type Env: env::Environment;

    /// Get page for sketch.
    fn get_page(&self) -> &env::PageOf<Self::Env>;

    /// Get page mutabily for sketch.
    fn get_page_mut(&mut self) -> &mut env::PageOf<Self::Env>;

    /// Handle an event from the environment.
    ///
    /// This is called by the ream the sketch is running in.
    fn handle_environment_event(&mut self, event: &env::EventOf<Self::Env>);
}

/// Allow aspect extension traits to be called directly on `S` instead of using the page field.
impl<C, S> compose::AsPart<C> for S
where
    S: Sketch,
    env::PageOf<S::Env>: compose::AsPart<C>,
{
    fn as_part(&self) -> &C {
        self.get_page().as_part()
    }

    fn as_part_mut(&mut self) -> &mut C {
        self.get_page_mut().as_part_mut()
    }
}

/// Trait for setting up a sketch given some input.
pub trait Setup<Input = ()>
where
    Self: Sketch,
{
    /// Setup sketch using a page from the environment and given input.
    fn setup(page: env::PageOf<Self::Env>, input: Input) -> Self;
}

/// Implements the `Sketch` trait for a struct.
///
/// To enable event handlers for aspects put the event in the `aspects` list of the `sketch`
/// attribute.
/// See a spesific aspect's docs for examples of using events.
/// ```
/// # use sketchbook::minimal;
/// # use sketchbook::derive_sketch;
/// derive_sketch! {
///     #[sketch(
///         env = minimal,
///         aspects = (/* aspects go here */),
///     )]
///     struct App {
///         #[page] page: minimal::Page,
///     }
/// }
/// ```
///
/// ## Usage With `macro_rules_attribute`
/// ```
/// # use sketchbook::minimal;
/// # use sketchbook::derive_sketch;
/// # use macro_rules_attribute::apply;
/// #[apply(derive_sketch)]
/// #[sketch(
///     env = minimal,
///     aspects = (/* aspects go here */),
/// )]
/// struct App {
///     #[page] page: minimal::Page,
/// }
/// ```
#[macro_export]
macro_rules! derive_sketch {
    {
        $(#[doc = $docs:literal])?
        #[sketch(env = $env_name:ident $(, aspects = ($($aspect_name:ident),* $(,)?))? $(,)?)]
        $struct_vis:vis
        struct $sketch_name:ident {
            $($($before_vis:vis $before_field_name:ident : $before_field_type:ty),+,)?
            #[page] $page_vis:vis $page_name:ident: $page_type:ty
            $(,$($after_vis:vis $after_field_name:ident : $after_field_type:ty),+)?$(,)?
        }
    } => {
        $(#[doc = $docs])?
        $struct_vis
        struct $sketch_name {
            $($($before_vis $before_field_name : $before_field_type),+,)?
            $page_vis $page_name: $page_type
            $(,$($after_vis $after_field_name : $after_field_type),+)?
        }

        impl $crate::Sketch for $sketch_name {
            type Env = $env_name::Env;

            fn get_page(&self) -> &$crate::PageOf<$env_name::Env> {
                &self.$page_name
            }

            fn get_page_mut(&mut self) -> &mut $crate::PageOf<$env_name::Env> {
                &mut self.$page_name
            }

            fn handle_environment_event(
                &mut self,
                event: &$crate::EventOf<Self::Env>,
            ) {
                $($(<Self as $crate::aspects::Handle<$aspect_name::Event>>::handle(self, event);)*)?
            }
        }

        $($(impl $crate::aspects::HandlerImplementedFor<$aspect_name::Event> for $sketch_name {})*)?
    };
    {
        $(#[doc = $docs:literal])?
        #[sketch(env = $env_name:ident $(, aspects = ($($aspect_name:ident),* $(,)?))? $(,)?)]
        $struct_vis:vis
        struct $sketch_name:ident {
            $($code:tt)*
        }
    } => {
        compile_error!("Missing `#[page]` attribute on field for environment's page.");
    };
    {
        $(#[doc = $docs:literal])?
        $(#[sketch($($attr:tt)*)])?
        $struct_vis:vis
        struct $sketch_name:ident {
            $($code:tt)*
        }
    } => {
        compile_error!("Missing `#[sketch(env = .., aspects = (.., ...))]` attribute.");
    };
    {
        $($tokens:tt)*
    } => {
        compile_error!("Unable to parse struct. See docs for `derive_sketch!` for expected syntax.");
    }
}

#[cfg(feature = "derive")]
pub use macro_rules_attribute::apply;