libsurfer/
message.rs

1use bytes::Bytes;
2use camino::Utf8PathBuf;
3use derive_more::Debug;
4use egui::DroppedFile;
5use emath::{Pos2, Vec2};
6use ftr_parser::types::Transaction;
7use num::BigInt;
8use serde::Deserialize;
9use std::path::PathBuf;
10use std::sync::Arc;
11use surver::SurverStatus;
12
13use crate::async_util::AsyncJob;
14use crate::config::{PrimaryMouseDrag, TransitionValue};
15use crate::displayed_item_tree::{ItemIndex, VisibleItemIndex};
16use crate::graphics::{Graphic, GraphicId};
17use crate::hierarchy::{ParameterDisplayLocation, ScopeExpandType};
18use crate::state::UserState;
19use crate::transaction_container::{
20    StreamScopeRef, TransactionContainer, TransactionRef, TransactionStreamRef,
21};
22use crate::translation::DynTranslator;
23use crate::viewport::ViewportStrategy;
24use crate::wave_data::ScopeType;
25use crate::{
26    MoveDir, VariableNameFilterType, WaveSource,
27    clock_highlighting::ClockHighlightType,
28    config::ArrowKeyBindings,
29    dialog::{OpenSiblingStateFileDialog, ReloadWaveformDialog},
30    displayed_item::{DisplayedFieldRef, DisplayedItemRef},
31    file_dialog::OpenMode,
32    hierarchy::HierarchyStyle,
33    time::{TimeStringFormatting, TimeUnit},
34    variable_filter::VariableIOFilterType,
35    variable_name_type::VariableNameType,
36    wave_container::{AnalogCacheKey, ScopeRef, VariableRef, WaveContainer},
37    wave_source::{CxxrtlKind, LoadOptions, WaveFormat},
38    wellen::{BodyResult, HeaderResult, LoadSignalsResult},
39};
40
41type CommandCount = usize;
42
43/// Encapsulates either a specific variable or all selected variables
44#[derive(Debug, Deserialize, Clone)]
45pub enum MessageTarget<T> {
46    Explicit(T),
47    CurrentSelection,
48}
49
50impl<T> From<MessageTarget<T>> for Option<T> {
51    fn from(value: MessageTarget<T>) -> Self {
52        match value {
53            MessageTarget::Explicit(val) => Some(val),
54            MessageTarget::CurrentSelection => None,
55        }
56    }
57}
58
59impl<T> From<Option<T>> for MessageTarget<T> {
60    fn from(value: Option<T>) -> Self {
61        match value {
62            Some(val) => Self::Explicit(val),
63            None => Self::CurrentSelection,
64        }
65    }
66}
67
68impl<T: Copy> Copy for MessageTarget<T> {}
69
70#[derive(Debug, Deserialize)]
71/// The design of Surfer relies on sending messages to trigger actions.
72pub enum Message {
73    /// Set active scope, None corresponds to the top-level scope.
74    SetActiveScope(Option<ScopeType>),
75    ExpandScope(ScopeExpandType),
76    /// Add one or more variables to wave view.
77    AddVariables(Vec<VariableRef>),
78    /// Add scope to wave view. If second argument is true, add subscopes recursively.
79    AddScope(ScopeRef, bool),
80    /// Add scope to wave view as a group. If second argument is true, add subscopes recursively.
81    AddScopeAsGroup(ScopeRef, bool),
82    /// Add a character to the repeat command counter.
83    AddCount(char),
84    AddStreamOrGenerator(TransactionStreamRef),
85    AddStreamOrGeneratorFromName(Option<StreamScopeRef>, String),
86    AddAllFromStreamScope(String),
87    /// Reset the repeat command counter.
88    InvalidateCount,
89    RemoveVisibleItems(MessageTarget<VisibleItemIndex>),
90    RemoveItems(Vec<DisplayedItemRef>),
91    /// Focus a wave/item.
92    FocusItem(VisibleItemIndex),
93    ItemSelectRange(VisibleItemIndex),
94    /// Select all waves/items.
95    ItemSelectAll,
96    SetItemSelected(VisibleItemIndex, bool),
97    /// Unfocus a wave/item.
98    UnfocusItem,
99    MoveFocus(MoveDir, CommandCount, bool),
100    MoveFocusedItem(MoveDir, CommandCount),
101    FocusTransaction(Option<TransactionRef>, Option<Transaction>),
102    VerticalScroll(MoveDir, CommandCount),
103    /// Scroll in vertical direction so that the item at a given location in the list is at the top (or visible).
104    ScrollToItem(usize),
105    SetScrollOffset(f32),
106    /// Change format (translator) of a variable. Passing None as first element means all selected variables.
107    VariableFormatChange(MessageTarget<DisplayedFieldRef>, String),
108    ItemSelectionClear,
109    /// Change color of waves/items. If first argument is None, change for selected items. If second argument is None, change to default value.
110    ItemColorChange(MessageTarget<VisibleItemIndex>, Option<String>),
111    /// Change background color of waves/items. If first argument is None, change for selected items. If second argument is None, change to default value.
112    ItemBackgroundColorChange(MessageTarget<VisibleItemIndex>, Option<String>),
113    ItemNameChange(Option<VisibleItemIndex>, Option<String>),
114    ItemNameReset(MessageTarget<VisibleItemIndex>),
115    /// Change scaling factor/height of waves/items. If first argument is None, change for selected items.
116    ItemHeightScalingFactorChange(MessageTarget<VisibleItemIndex>, f32),
117    /// Change variable name type of waves/items. If first argument is None, change for selected items.
118    ChangeVariableNameType(MessageTarget<VisibleItemIndex>, VariableNameType),
119    ForceVariableNameTypes(VariableNameType),
120    /// Set or unset right alignment of names
121    SetNameAlignRight(bool),
122    SetClockHighlightType(ClockHighlightType),
123    SetFillHighValues(bool),
124    SetDinotraceStyle(bool),
125    // Reset the translator for this variable back to default. Sub-variables,
126    // i.e. those with the variable idx and a shared path are also reset
127    ResetVariableFormat(DisplayedFieldRef),
128    CanvasScroll {
129        delta: Vec2,
130        viewport_idx: usize,
131    },
132    CanvasZoom {
133        mouse_ptr: Option<BigInt>,
134        delta: f32,
135        viewport_idx: usize,
136    },
137    ZoomToRange {
138        start: BigInt,
139        end: BigInt,
140        viewport_idx: usize,
141    },
142    /// Set cursor at time.
143    CursorSet(BigInt),
144    #[serde(skip)]
145    SetSurverStatus(web_time::Instant, String, SurverStatus),
146    /// Load file from file path.
147    LoadFile(Utf8PathBuf, LoadOptions),
148    /// Load file from URL.
149    LoadWaveformFileFromUrl(String, LoadOptions),
150    /// Load file from data.
151    LoadFromData(Vec<u8>, LoadOptions),
152    #[cfg(feature = "python")]
153    /// Load translator from Python file path.
154    LoadPythonTranslator(Utf8PathBuf),
155    /// Load a web assembly translator from file. This is loaded in addition to the
156    /// translators loaded on startup.
157    #[cfg(all(not(target_arch = "wasm32"), feature = "wasm_plugins"))]
158    LoadWasmTranslator(Utf8PathBuf),
159    /// Load command file from file path.
160    LoadCommandFile(Utf8PathBuf),
161    /// Load commands from data.
162    LoadCommandFromData(Vec<u8>),
163    /// Load command file from URL.
164    LoadCommandFileFromUrl(String),
165    SetupCxxrtl(CxxrtlKind),
166    #[serde(skip)]
167    /// Message sent when waveform file header is loaded.
168    WaveHeaderLoaded(
169        web_time::Instant,
170        WaveSource,
171        LoadOptions,
172        #[debug(skip)] HeaderResult,
173    ),
174    #[serde(skip)]
175    /// Message sent when waveform file body is loaded.
176    WaveBodyLoaded(web_time::Instant, WaveSource, #[debug(skip)] BodyResult),
177    #[serde(skip)]
178    WavesLoaded(
179        WaveSource,
180        WaveFormat,
181        #[debug(skip)] Box<WaveContainer>,
182        LoadOptions,
183    ),
184    #[serde(skip)]
185    SignalsLoaded(web_time::Instant, #[debug(skip)] LoadSignalsResult),
186    #[serde(skip)]
187    TransactionStreamsLoaded(
188        WaveSource,
189        WaveFormat,
190        #[debug(skip)] TransactionContainer,
191        LoadOptions,
192    ),
193    #[serde(skip)]
194    Error(eyre::Error),
195    #[serde(skip)]
196    TranslatorLoaded(#[debug(skip)] Arc<DynTranslator>),
197    /// Take note that the specified translator errored on a `translates` call on the
198    /// specified variable
199    BlacklistTranslator(VariableRef, String),
200    HideCommandPrompt,
201    ShowCommandPrompt(String, Option<String>),
202    /// Message sent when file is loadedropped onto Surfer.
203    FileDropped(DroppedFile),
204    #[serde(skip)]
205    /// Message sent when download of a waveform file is complete.
206    FileDownloaded(String, Bytes, LoadOptions),
207    #[serde(skip)]
208    /// Message sent when download of a command file is complete.
209    CommandFileDownloaded(String, Bytes),
210    ReloadConfig,
211    ReloadWaveform(bool),
212    /// Suggest reloading the current waveform as the file on disk has changed.
213    /// This should first take the user's confirmation before reloading the waveform.
214    /// However, there is a configuration setting that the user can overwrite.
215    #[serde(skip)]
216    SuggestReloadWaveform,
217    /// Close the '`reload_waveform`' dialog.
218    /// The `reload_file` boolean is the return value of the dialog.
219    /// If `do_not_show_again` is true, the `reload_file` setting will be persisted.
220    #[serde(skip)]
221    CloseReloadWaveformDialog {
222        reload_file: bool,
223        do_not_show_again: bool,
224    },
225    /// Update the waveform dialog UI with the provided dialog model.
226    #[serde(skip)]
227    UpdateReloadWaveformDialog(ReloadWaveformDialog),
228    // When a file is open, suggest opening state files in the same directory
229    OpenSiblingStateFile(bool),
230    #[serde(skip)]
231    SuggestOpenSiblingStateFile,
232    #[serde(skip)]
233    CloseOpenSiblingStateFileDialog {
234        load_state: bool,
235        do_not_show_again: bool,
236    },
237    #[serde(skip)]
238    UpdateOpenSiblingStateFileDialog(OpenSiblingStateFileDialog),
239    RemovePlaceholders,
240    ZoomToFit {
241        viewport_idx: usize,
242    },
243    GoToStart {
244        viewport_idx: usize,
245    },
246    GoToEnd {
247        viewport_idx: usize,
248    },
249    GoToTime(Option<BigInt>, usize),
250    SetMenuVisible(bool),
251    ToggleMenu,
252    SetToolbarVisible(bool),
253    SetOverviewVisible(bool),
254    SetStatusbarVisible(bool),
255    SetShowIndices(bool),
256    SetShowVariableDirection(bool),
257    SetShowEmptyScopes(bool),
258    SetShowHierarchyIcons(bool),
259    SetParameterDisplayLocation(ParameterDisplayLocation),
260    SetSidePanelVisible(bool),
261    ToggleItemSelected(Option<VisibleItemIndex>),
262    SetDefaultTimeline(bool),
263    SetTickLines(bool),
264    SetVariableTooltip(bool),
265    SetScopeTooltip(bool),
266    SetSurverFileWindowVisible(bool),
267    LoadSurverFileByIndex(Option<usize>, LoadOptions),
268    LoadSurverFileByName(String, LoadOptions),
269    SetTransitionValue(TransitionValue),
270    ToggleFullscreen,
271    StopProgressTracker,
272    /// Set which time unit to use.
273    SetTimeUnit(TimeUnit),
274    /// Set how to format the time strings. Passing None resets it to default.
275    SetTimeStringFormatting(Option<TimeStringFormatting>),
276    SetHighlightFocused(bool),
277    CommandPromptClear,
278    CommandPromptUpdate {
279        suggestions: Vec<(String, Vec<bool>)>,
280    },
281    CommandPromptPushPrevious(String),
282    SelectPrevCommand,
283    SelectNextCommand,
284    OpenFileDialog(OpenMode),
285    OpenCommandFileDialog,
286    #[cfg(feature = "python")]
287    OpenPythonPluginDialog,
288    #[cfg(feature = "python")]
289    ReloadPythonPlugin,
290    SaveStateFile(Option<PathBuf>),
291    /// Load state from data.
292    /// Note: the internal state is not a stable format and this should not be
293    /// relied on to work across revisions.
294    LoadStateFromData(Vec<u8>),
295    LoadStateFile(Option<PathBuf>),
296    LoadState(Box<UserState>, Option<PathBuf>),
297    SetStateFile(PathBuf),
298    SetAboutVisible(bool),
299    SetKeyHelpVisible(bool),
300    SetGestureHelpVisible(bool),
301    SetQuickStartVisible(bool),
302    #[serde(skip)]
303    SetUrlEntryVisible(
304        bool,
305        #[debug(skip)] Option<Box<dyn Fn(String) -> Message + Send + 'static>>,
306    ),
307    SetLicenseVisible(bool),
308    SetLogsVisible(bool),
309    SetFrameBufferVariable(VariableRef),
310    SetFrameBufferVisibleVariable(Option<VisibleItemIndex>),
311    SetFrameBufferArray(ScopeRef),
312    SetMouseGestureDragStart(Option<Pos2>),
313    SetMeasureDragStart(Option<Pos2>),
314    SetFilterFocused(bool),
315    SetTimeEditFocused(bool),
316    SetRequestTimeEditFocus(bool),
317    SetVariableNameFilterType(VariableNameFilterType),
318    SetVariableNameFilterCaseInsensitive(bool),
319    SetVariableIOFilter(VariableIOFilterType, bool),
320    SetVariableGroupByDirection(bool),
321    SetUIZoomFactor(f32),
322    SetPerformanceVisible(bool),
323    SetContinuousRedraw(bool),
324    SetCursorWindowVisible(bool),
325    SetHierarchyStyle(HierarchyStyle),
326    SetArrowKeyBindings(ArrowKeyBindings),
327    SetPrimaryMouseDragBehavior(PrimaryMouseDrag),
328    // Second argument is position to insert after, None inserts after focused item,
329    // or last if no focused item
330    AddDivider(Option<String>, Option<VisibleItemIndex>),
331    // Argument is position to insert after, None inserts after focused item,
332    // or last if no focused item
333    AddTimeLine(Option<VisibleItemIndex>),
334    AddMarker {
335        time: BigInt,
336        name: Option<String>,
337        move_focus: bool,
338    },
339    /// Set a marker at a specific position. If it doesn't exist, it will be created
340    SetMarker {
341        id: u8,
342        time: BigInt,
343    },
344    /// Remove marker.
345    RemoveMarker(u8),
346    /// Set or move a marker to the position of the current cursor.
347    MoveMarkerToCursor(u8),
348    /// Scroll in horizontal direction so that the cursor is visible.
349    GoToCursorIfNotInView,
350    GoToMarkerPosition(u8, usize),
351    MoveCursorToTransition {
352        next: bool,
353        variable: Option<VisibleItemIndex>,
354        skip_zero: bool,
355    },
356    MoveTransaction {
357        next: bool,
358    },
359    VariableValueToClipbord(MessageTarget<VisibleItemIndex>),
360    VariableNameToClipboard(MessageTarget<VisibleItemIndex>),
361    VariableFullNameToClipboard(MessageTarget<VisibleItemIndex>),
362    InvalidateDrawCommands,
363    AddGraphic(GraphicId, Graphic),
364    RemoveGraphic(GraphicId),
365
366    /// Variable dragging messages
367    VariableDragStarted(VisibleItemIndex),
368    VariableDragTargetChanged(crate::displayed_item_tree::TargetPosition),
369    VariableDragFinished,
370    AddDraggedVariables(Vec<VariableRef>),
371    /// Unpauses the simulation if the wave source supports this kind of interactivity. Otherwise
372    /// does nothing
373    UnpauseSimulation,
374    /// Pause the simulation if the wave source supports this kind of interactivity. Otherwise
375    /// does nothing
376    PauseSimulation,
377    /// Expand the displayed item into subfields. Levels controls how many layers of subfields
378    /// are expanded. 0 unexpands it completely
379    ExpandDrawnItem {
380        item: DisplayedItemRef,
381        levels: usize,
382    },
383    SetAnalogSettings(
384        MessageTarget<VisibleItemIndex>,
385        Option<crate::displayed_item::AnalogSettings>,
386    ),
387    BuildAnalogCache {
388        display_id: DisplayedItemRef,
389        cache_key: AnalogCacheKey,
390    },
391    #[serde(skip)]
392    AnalogCacheBuilt {
393        #[debug(skip)]
394        entry: Arc<crate::analog_signal_cache::AnalogCacheEntry>,
395        #[debug(skip)]
396        result: Result<crate::analog_signal_cache::AnalogSignalCache, String>,
397    },
398
399    SetViewportStrategy(ViewportStrategy),
400    SetConfigFromString(String),
401    AddCharToPrompt(char),
402
403    /// Run more than one message in sequence
404    Batch(Vec<Message>),
405    AddViewport,
406    RemoveViewport,
407    /// Select Theme
408    SelectTheme(Option<String>),
409    /// Enable animations
410    EnableAnimations(bool),
411    /// Undo the last n changes
412    Undo(usize),
413    /// Redo the last n changes
414    Redo(usize),
415    DumpTree,
416    GroupNew {
417        name: Option<String>,
418        before: Option<ItemIndex>,
419        items: Option<Vec<DisplayedItemRef>>,
420    },
421    GroupDissolve(Option<DisplayedItemRef>),
422    GroupFold(Option<DisplayedItemRef>),
423    GroupUnfold(Option<DisplayedItemRef>),
424    GroupFoldRecursive(Option<DisplayedItemRef>),
425    GroupUnfoldRecursive(Option<DisplayedItemRef>),
426    GroupFoldAll,
427    GroupUnfoldAll,
428    /// WCP Server
429    StartWcpServer {
430        address: Option<String>,
431        initiate: bool,
432    },
433    StopWcpServer,
434    /// Configures the WCP system to listen for messages over internal channels.
435    /// This is used to start WCP on wasm
436    SetupChannelWCP,
437    /// Exit the application. This has no effect on wasm and closes the window
438    /// on other platforms
439    Exit,
440    /// Should only used for tests. Expands the parameter section so that one can test the rendering.
441    ExpandParameterSection,
442    AsyncDone(AsyncJob),
443}
libsurfer/message.rs

libsurfer/
message.rs
