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
use std::marker::PhantomData;
use std::sync::Mutex;
use super::Error;
use super::ErrorKind;
use super::Handle;
use super::RuntimeManager;
use super::Theme;
use super::ThemeMethods;
use crate::graphics::Size;
use crate::backend::Type;
use crate::ui::common::traits::*;
static APP_CREATED_MUTEX: Mutex<bool> = Mutex::new(false);
/// HTML message displayed at the end of the application for WASM targets.
#[cfg(target_arch = "wasm32")]
const WEBTERMINAL_END_MESSAGE_HTML: &str = "<h1>{} has ended</h1><p>To re-start the application, please refresh the page.</p>";
/// Represents the main application object for AppCUI.
///
/// This struct is used to create and manage the main application. It provides methods to add windows, set the theme, and run the application.
pub struct App {
_phantom: PhantomData<*mut ()>,
}
impl App {
pub(super) fn is_created() -> bool {
let app_created = APP_CREATED_MUTEX.lock().unwrap();
*app_created
}
pub(super) fn create(builder: crate::system::Builder) -> Result<Self, Error> {
if APP_CREATED_MUTEX.is_poisoned() {
APP_CREATED_MUTEX.clear_poison();
}
let mut app_created = APP_CREATED_MUTEX.lock().unwrap();
if *app_created {
return Err(Error::new(
ErrorKind::InitializationFailure,
"App has already been created ! There can only be one instance of an Application at one time. If you have more, make sure that you have only one !".to_string(),
));
}
RuntimeManager::create(builder)?;
*app_created = true;
Ok(App {
_phantom: Default::default(),
})
}
/// Creates a new builder object using the default terminal for the current operating system
#[allow(clippy::new_ret_no_self)]
pub fn new() -> crate::system::Builder {
crate::system::Builder::new()
}
/// Creates a new builder object using a specified terminal from the list of terminals available
/// for the current operating system.
pub fn with_backend(backend: Type) -> crate::system::Builder {
let mut builder = crate::system::Builder::new();
builder.backend = Some(backend);
builder
}
/// Creates a builder designed for unit testing.
/// The provided parameters indicated:
/// * `width` and `height` : the size of the simulated terminal
/// * `script` : a script with multiple commands (one command per line) that will be executed one after another simulating events that could be send to the AppCUI. Once all commands are being executed, the application will end.
///
/// ## Debug commands
/// The following list of commands are supported for the script:
///
/// **Mouse related commands**
/// * `Mouse.Hold(x,y,button)` simulates an event where the mouse button is being pressed while the mouse is located at a specific position on screen. The parameters `x` and `y` are a screen position, while the parameter `button` is one of `left`, `right` or `center`
/// * `Mouse.Release(x,y)` simulates the release of all mouse buttons while the mouse is located at a specific screen position.
/// * `Mouse.Click(x,y,button)` simulates a click (hold an release)
/// * `Mouse.Move(x,y)` simulates the movement of a mouse to coordonates (x,y). No mouse button are being pressed.
/// * `Mouse.Drag(x1,y1,x2,y2)` simulates the movement of a mouse from (x1,y1) to (x2,y2) while the left button is being pressed
/// * `Mouse.Wheel(x,y,direction,times)` simulates the wheel mouse being rotated into a direction (one of `top`, `bottom`, `left`, `right`) for a number of times. The `times` parameter must be biggen than 0.
///
/// **Key related commands**
/// * `Key.Pressed(key)` where key can be any combination of keys
///
/// **Paint related commands**
/// * `Paint(name)` paints the current virtual screen into the current screen using ANSI codes.
/// * `Paint.Enable(value)` enables or disables painting. `value` is a boolean value (**true** or **false**). If set to **false** all subsequent calls to command `Paint` will be ignored.
///
/// **System events**
/// * `Resize(width,height)` simulates a resize of the virtual terminal to the size represented by `width` and `height` parameters
///
/// **Validation commands**
/// * `CheckHash(hash)` checks if the hash computer over the current virtual screen is as expected. If not it will panic. This is useful for unit testing.
pub fn debug(width: u16, height: u16, script: &str) -> crate::system::Builder {
let mut builder = crate::system::Builder::new();
builder.size = Some(Size::new(width as u32, height as u32));
builder.debug_script = Some(String::from(script));
builder
}
/// Runs the current appcui application. This command will display all windows, and allow you to run the cod that perform the event logic for every control.
pub fn run(self) {
#[cfg(target_arch = "wasm32")]
#[allow(unused_imports)]
{
use wasm_bindgen_rayon::init_thread_pool; // Explicitly import for WASM to export this function
console_error_panic_hook::set_once();
}
// must pe self so that after a run a second call will not be possible
RuntimeManager::get().run();
// close the backend
RuntimeManager::get().backend_mut().on_close();
// clear the mutex from open_save_dialog to clear the last path
crate::dialogs::clear_last_path();
// clear the mutex so that other apps can be created after this step
#[cfg(not(target_arch = "wasm32"))]
{
RuntimeManager::destroy();
let mut app_created = APP_CREATED_MUTEX.lock().unwrap();
*app_created = false;
}
// For WASM, APP_CREATED_MUTEX is reset via drop_app
// called from RuntimeManager's animation loop when it terminates.
}
/// Adds a new window to AppCUI framework and returns a Handle towords it.
/// Later on you can use that handle to manipulate that window in a safe way.
pub fn add_window<T>(&mut self, window: T) -> Handle<T>
where
T: Control + WindowControl + NotModalWindow + 'static,
{
RuntimeManager::get().add_window(window)
}
/// Sets the theme for the current application.
pub fn set_theme(theme: Theme) {
if !App::is_created() {
panic!("App::set_theme can only be called after the App has been created !");
}
RuntimeManager::get().set_theme(theme);
}
pub(crate) fn drop_app() {
if APP_CREATED_MUTEX.is_poisoned() {
APP_CREATED_MUTEX.clear_poison();
}
if RuntimeManager::is_instantiated() {
RuntimeManager::destroy();
}
let mut app_created = APP_CREATED_MUTEX.lock().unwrap();
*app_created = false;
#[cfg(target_arch = "wasm32")]
{
use web_sys::window;
if let Some(win) = window() {
if let Some(doc) = win.document() {
if let Some(body) = doc.body() {
body.set_inner_html(&WEBTERMINAL_END_MESSAGE_HTML.replace("{}", &doc.title()));
}
}
}
}
}
}
#[cfg(not(target_arch = "wasm32"))]
impl Drop for App {
fn drop(&mut self) {
Self::drop_app();
}
}