rtic_macros/
syntax.rs

Help
1#[allow(unused_extern_crates)]
2extern crate proc_macro;
3
4use proc_macro::TokenStream;
5
6use indexmap::{IndexMap, IndexSet};
7use proc_macro2::TokenStream as TokenStream2;
8use syn::Ident;
9
10use crate::syntax::ast::App;
11
12mod accessors;
13pub mod analyze;
14pub mod ast;
15mod backend;
16mod check;
17mod parse;
18
19/// An ordered map keyed by identifier
20pub type Map<T> = IndexMap<Ident, T>;
21
22/// An order set
23pub type Set<T> = IndexSet<T>;
24
25/// Execution context
26#[derive(Clone, Copy)]
27pub enum Context<'a> {
28    /// The `idle` context
29    Idle,
30
31    /// The `init`-ialization function
32    Init,
33
34    /// A async software task
35    SoftwareTask(&'a Ident),
36
37    /// A hardware task
38    HardwareTask(&'a Ident),
39}
40
41impl<'a> Context<'a> {
42    /// The identifier of this context
43    pub fn ident(&self, app: &'a App) -> &'a Ident {
44        match self {
45            Context::HardwareTask(ident) => ident,
46            Context::Idle => &app.idle.as_ref().unwrap().name,
47            Context::Init => &app.init.name,
48            Context::SoftwareTask(ident) => ident,
49        }
50    }
51
52    /// Is this the `idle` context?
53    pub fn is_idle(&self) -> bool {
54        matches!(self, Context::Idle)
55    }
56
57    /// Is this the `init`-ialization context?
58    pub fn is_init(&self) -> bool {
59        matches!(self, Context::Init)
60    }
61
62    /// Whether this context runs only once
63    pub fn runs_once(&self) -> bool {
64        self.is_init() || self.is_idle()
65    }
66
67    /// Whether this context has shared resources
68    pub fn has_shared_resources(&self, app: &App) -> bool {
69        match *self {
70            Context::HardwareTask(name) => {
71                !app.hardware_tasks[name].args.shared_resources.is_empty()
72            }
73            Context::Idle => !app.idle.as_ref().unwrap().args.shared_resources.is_empty(),
74            Context::Init => false,
75            Context::SoftwareTask(name) => {
76                !app.software_tasks[name].args.shared_resources.is_empty()
77            }
78        }
79    }
80
81    /// Whether this context has local resources
82    pub fn has_local_resources(&self, app: &App) -> bool {
83        match *self {
84            Context::HardwareTask(name) => {
85                !app.hardware_tasks[name].args.local_resources.is_empty()
86            }
87            Context::Idle => !app.idle.as_ref().unwrap().args.local_resources.is_empty(),
88            Context::Init => !app.init.args.local_resources.is_empty(),
89            Context::SoftwareTask(name) => {
90                !app.software_tasks[name].args.local_resources.is_empty()
91            }
92        }
93    }
94}
95
96/// Parses the input of the `#[app]` attribute
97pub fn parse(
98    args: TokenStream,
99    input: TokenStream,
100) -> Result<(ast::App, analyze::Analysis), syn::parse::Error> {
101    parse2(args.into(), input.into())
102}
103
104/// `proc_macro2::TokenStream` version of `parse`
105pub fn parse2(
106    args: TokenStream2,
107    input: TokenStream2,
108) -> Result<(ast::App, analyze::Analysis), syn::parse::Error> {
109    let app = parse::app(args, input)?;
110    check::app(&app)?;
111
112    match analyze::app(&app) {
113        Err(e) => Err(e),
114        // If no errors, return the app and analysis results
115        Ok(analysis) => Ok((app, analysis)),
116    }
117}
118
119enum Either<A, B> {
120    Left(A),
121    Right(B),
122}
rtic_macros/syntax.rs

rtic_macros/
syntax.rs
