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
//! Synchronous robot code trait for [pros-rs](https://crates.io/crates/pros).
#![no_std]
use pros_core::error::Result;
/// A trait for robot code that runs without the async executor spun up.
/// This trait isn't recommended. See `AsyncRobot` in [pros-async](https://crates.io/crates/pros-async) for the preferred trait to run robot code.
pub trait SyncRobot {
/// Runs during the operator control period.
/// This function may be called more than once.
/// For that reason, do not use `Peripherals::take` in this function.
fn opcontrol(&mut self) -> Result {
Ok(())
}
/// Runs during the autonomous period.
fn auto(&mut self) -> Result {
Ok(())
}
/// Runs continuously during the disabled period.
fn disabled(&mut self) -> Result {
Ok(())
}
/// Runs once when the competition system is initialized.
fn comp_init(&mut self) -> Result {
Ok(())
}
}
#[doc(hidden)]
#[macro_export]
macro_rules! __gen_sync_exports {
($rbt:ty) => {
pub static mut ROBOT: Option<$rbt> = None;
#[doc(hidden)]
#[no_mangle]
extern "C" fn opcontrol() {
<$rbt as $crate::SyncRobot>::opcontrol(unsafe {
ROBOT
.as_mut()
.expect("Expected initialize to run before opcontrol")
})
.unwrap();
}
#[doc(hidden)]
#[no_mangle]
extern "C" fn autonomous() {
<$rbt as $crate::SyncRobot>::auto(unsafe {
ROBOT
.as_mut()
.expect("Expected initialize to run before opcontrol")
})
.unwrap();
}
#[doc(hidden)]
#[no_mangle]
extern "C" fn disabled() {
<$rbt as $crate::SyncRobot>::disabled(unsafe {
ROBOT
.as_mut()
.expect("Expected initialize to run before opcontrol")
})
.unwrap();
}
#[doc(hidden)]
#[no_mangle]
extern "C" fn competition_initialize() {
<$rbt as $crate::SyncRobot>::comp_init(unsafe {
ROBOT
.as_mut()
.expect("Expected initialize to run before opcontrol")
})
.unwrap();
}
};
}
/// Allows your sync robot code to be executed by the pros kernel.
/// If your robot struct implements Default then you can just supply this macro with its type.
/// If not, you can supply an expression that returns your robot type to initialize your robot struct.
/// The code that runs to create your robot struct will run in the initialize function in PROS.
///
/// Example of using the macro with a struct that implements Default:
/// ```rust
/// use pros::prelude::*;
/// #[derive(Default)]
/// struct ExampleRobot;
/// impl SyncRobot for ExampleRobot {
/// asnyc fn opcontrol(&mut self) -> pros::Result {
/// println!("Hello, world!");
/// Ok(())
/// }
/// }
/// sync_robot!(ExampleRobot);
/// ```
///
/// Example of using the macro with a struct that does not implement Default:
/// ```rust
/// use pros::prelude::*;
/// struct ExampleRobot {
/// x: i32,
/// }
/// impl SyncRobot for ExampleRobot {
/// async fn opcontrol(&mut self) -> pros::Result {
/// println!("Hello, world! {}", self.x);
/// Ok(())
/// }
/// }
/// impl ExampleRobot {
/// pub fn new() -> Self {
/// Self { x: 5 }
/// }
/// }
/// sync_robot!(ExampleRobot, ExampleRobot::new());
#[macro_export]
macro_rules! sync_robot {
($rbt:ty) => {
$crate::__gen_sync_exports!($rbt);
#[no_mangle]
extern "C" fn initialize() {
unsafe {
ROBOT = Some(Default::default());
}
}
};
($rbt:ty, $init:expr) => {
$crate::__gen_sync_exports!($rbt);
#[no_mangle]
extern "C" fn initialize() {
unsafe {
ROBOT = Some($init);
}
}
};
}