surfer/
main.rs

1#![cfg_attr(not(target_arch = "wasm32"), deny(unused_crate_dependencies))]
2
3#[cfg(not(target_arch = "wasm32"))]
4mod main_impl {
5    use camino::Utf8PathBuf;
6    use clap::Parser;
7    use egui::Vec2;
8    use eyre::Context;
9    use eyre::Result;
10    use libsurfer::{
11        batch_commands::read_command_file,
12        file_watcher::FileWatcher,
13        logs,
14        message::Message,
15        run_egui,
16        wave_source::{string_to_wavesource, WaveSource},
17        StartupParams, SystemState,
18    };
19    use log::error;
20
21    #[derive(clap::Subcommand)]
22    enum Commands {
23        #[cfg(not(target_arch = "wasm32"))]
24        /// starts surfer in headless mode so that a user can connect to it
25        Server {
26            /// port on which server will listen
27            #[clap(long)]
28            port: Option<u16>,
29            /// token used by the client to authenticate to the server
30            #[clap(long)]
31            token: Option<String>,
32            /// waveform file that we want to serve
33            #[arg(long)]
34            file: String,
35        },
36    }
37
38    #[derive(clap::Parser, Default)]
39    #[command(version, about)]
40    struct Args {
41        /// Waveform file in VCD, FST, or GHW format.
42        wave_file: Option<String>,
43        /// Path to a file containing 'commands' to run after a waveform has been loaded.
44        /// The commands are the same as those used in the command line interface inside the program.
45        /// Commands are separated by lines or ;. Empty lines are ignored. Line comments starting with
46        /// `#` are supported
47        /// NOTE: This feature is not permanent, it will be removed once a solid scripting system
48        /// is implemented.
49        #[clap(long, short, verbatim_doc_comment)]
50        command_file: Option<Utf8PathBuf>,
51        /// Alias for --command_file to support VUnit
52        #[clap(long)]
53        script: Option<Utf8PathBuf>,
54
55        #[clap(long, short)]
56        /// Load previously saved state file
57        state_file: Option<Utf8PathBuf>,
58
59        #[clap(long, action)]
60        /// Port for WCP to connect to
61        wcp_initiate: Option<u16>,
62
63        #[command(subcommand)]
64        command: Option<Commands>,
65    }
66
67    impl Args {
68        pub fn command_file(&self) -> &Option<Utf8PathBuf> {
69            if self.script.is_some() && self.command_file.is_some() {
70                error!("At most one of --command_file and --script can be used");
71                return &None;
72            }
73            if self.command_file.is_some() {
74                &self.command_file
75            } else {
76                &self.script
77            }
78        }
79    }
80
81    #[allow(dead_code)] // NOTE: Only used in desktop version
82    fn startup_params_from_args(args: Args) -> StartupParams {
83        let startup_commands = if let Some(cmd_file) = args.command_file() {
84            read_command_file(cmd_file)
85        } else {
86            vec![]
87        };
88        StartupParams {
89            waves: args.wave_file.map(|s| string_to_wavesource(&s)),
90            wcp_initiate: args.wcp_initiate,
91            startup_commands,
92        }
93    }
94
95    #[cfg(not(target_arch = "wasm32"))]
96    pub(crate) fn main() -> Result<()> {
97        use libsurfer::state::UserState;
98        #[cfg(feature = "wasm_plugins")]
99        use libsurfer::translation::wasm_translator::discover_wasm_translators;
100        simple_eyre::install()?;
101
102        logs::start_logging()?;
103
104        // https://tokio.rs/tokio/topics/bridging
105        // We want to run the gui in the main thread, but some long running tasks like
106        // loading VCDs should be done asynchronously. We can't just use std::thread to
107        // do that due to wasm support, so we'll start a tokio runtime
108        let runtime = tokio::runtime::Builder::new_current_thread()
109            .worker_threads(1)
110            .enable_all()
111            .build()
112            .unwrap();
113
114        // parse arguments
115        let args = Args::parse();
116        #[cfg(not(target_arch = "wasm32"))]
117        if let Some(Commands::Server { port, token, file }) = args.command {
118            let default_port = 8911; // FIXME: make this more configurable
119            let res = runtime.block_on(surver::server_main(
120                port.unwrap_or(default_port),
121                token,
122                file,
123                None,
124            ));
125            return res;
126        }
127
128        let _enter = runtime.enter();
129
130        std::thread::spawn(move || {
131            runtime.block_on(async {
132                loop {
133                    tokio::time::sleep(tokio::time::Duration::from_secs(3600)).await;
134                }
135            });
136        });
137
138        let state_file = args.state_file.clone();
139        let startup_params = startup_params_from_args(args);
140        let waves = startup_params.waves.clone();
141
142        let state = match &state_file {
143            Some(file) => std::fs::read_to_string(file)
144                .with_context(|| format!("Failed to read state from {file}"))
145                .and_then(|content| {
146                    ron::from_str::<UserState>(&content)
147                        .with_context(|| format!("Failed to decode state from {file}"))
148                })
149                .map(SystemState::from)
150                .map(|mut s| {
151                    s.user.state_file = Some(file.into());
152                    s
153                })
154                .or_else(|e| {
155                    error!("Failed to read state file. Opening fresh session\n{e:#?}");
156                    SystemState::new()
157                })?,
158            None => SystemState::new()?,
159        }
160        .with_params(startup_params);
161
162        #[cfg(feature = "wasm_plugins")]
163        {
164            // Not using batch commands here as we want to start processing wasm plugins
165            // as soon as we start up, no need to wait for the waveform to load
166            let sender = state.channels.msg_sender.clone();
167            for message in discover_wasm_translators() {
168                sender.send(message).unwrap();
169            }
170        }
171        // install a file watcher that emits a `SuggestReloadWaveform` message
172        // whenever the user-provided file changes.
173        let _watcher = match waves {
174            Some(WaveSource::File(path)) => {
175                let sender = state.channels.msg_sender.clone();
176                FileWatcher::new(&path, move || {
177                    match sender.send(Message::SuggestReloadWaveform) {
178                        Ok(_) => {}
179                        Err(err) => {
180                            error!("Message ReloadWaveform did not send:\n{err}")
181                        }
182                    }
183                })
184                .inspect_err(|err| error!("Cannot set up the file watcher:\n{err}"))
185                .ok()
186            }
187            _ => None,
188        };
189
190        let options = eframe::NativeOptions {
191            viewport: egui::ViewportBuilder::default()
192                .with_app_id("org.surfer-project.surfer")
193                .with_title("Surfer")
194                .with_inner_size(Vec2::new(
195                    state.user.config.layout.window_width as f32,
196                    state.user.config.layout.window_height as f32,
197                )),
198            ..Default::default()
199        };
200
201        eframe::run_native("Surfer", options, Box::new(|cc| Ok(run_egui(cc, state)?))).unwrap();
202
203        Ok(())
204    }
205}
206
207#[cfg(target_arch = "wasm32")]
208mod main_impl {
209    use eframe::wasm_bindgen::JsCast;
210    use eframe::web_sys;
211    use libsurfer::wasm_api::WebHandle;
212
213    // Calling main is not the intended way to start surfer, instead, it should be
214    // started by `wasm_api::WebHandle`
215    pub(crate) fn main() -> eyre::Result<()> {
216        simple_eyre::install()?;
217        let document = web_sys::window()
218            .expect("No window")
219            .document()
220            .expect("No document");
221        let canvas = document
222            .get_element_by_id("the_canvas_id")
223            .expect("Failed to find the_canvas_id")
224            .dyn_into::<web_sys::HtmlCanvasElement>()
225            .expect("the_canvas_id was not a HtmlCanvasElement");
226
227        wasm_bindgen_futures::spawn_local(async {
228            let wh = WebHandle::new();
229            wh.start(canvas).await.expect("Failed to start surfer");
230        });
231
232        Ok(())
233    }
234}
235
236fn main() -> eyre::Result<()> {
237    main_impl::main()
238}
surfer/main.rs

surfer/
main.rs
