Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning bar indicating why a selected device is unusable #107

Merged
merged 2 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/backend/cynthion.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
use std::cmp::Ordering;
use std::collections::VecDeque;
use std::thread::{spawn, sleep, JoinHandle};
use std::time::Duration;
Expand Down Expand Up @@ -179,9 +180,13 @@ fn check_device(device_info: &DeviceInfo)

// Check protocol version.
let protocol = alt_setting.protocol();
if protocol != PROTOCOL {
bail!("Wrong protocol version: {} supported, {} found",
PROTOCOL, protocol);
#[allow(clippy::absurd_extreme_comparisons)]
match PROTOCOL.cmp(&protocol) {
Ordering::Less =>
bail!("Analyzer gateware is newer (v{}) than supported by this version of Packetry (v{}). Please update Packetry.", protocol, PROTOCOL),
Ordering::Greater =>
bail!("Analyzer gateware is older (v{}) than supported by this version of Packetry (v{}). Please update gateware.", protocol, PROTOCOL),
Ordering::Equal => {}
}

// Try to claim the interface.
Expand Down
58 changes: 57 additions & 1 deletion src/ui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,14 @@ use gtk::{
ApplicationWindow,
Button,
DropDown,
InfoBar,
Label,
ListItem,
ColumnView,
ColumnViewColumn,
MessageType,
ProgressBar,
ResponseType,
ScrolledWindow,
Separator,
SignalListItemFactory,
Expand All @@ -41,7 +44,6 @@ use gtk::{
use gtk::{
MessageDialog,
DialogFlags,
MessageType,
ButtonsType,
};

Expand Down Expand Up @@ -159,6 +161,16 @@ impl DeviceSelector {
}
}

fn device_unusable(&self) -> Option<&str> {
match self.current_device() {
None => None,
Some(device) => match &device.usability {
Usable(..) => None,
Unusable(string) => Some(string),
}
}
}

fn set_sensitive(&mut self, sensitive: bool) {
if sensitive {
self.dev_dropdown.set_sensitive(!self.devices.is_empty());
Expand Down Expand Up @@ -251,6 +263,41 @@ impl DeviceSelector {
}
}

struct DeviceWarning {
info_bar: InfoBar,
label: Label,
}

impl DeviceWarning {
fn new() -> DeviceWarning {
let info_bar = InfoBar::new();
info_bar.set_show_close_button(true);
info_bar.connect_response(|info_bar, response| {
if response == ResponseType::Close {
info_bar.set_revealed(false);
}
});
let label = Label::new(None);
label.set_wrap(true);
info_bar.add_child(&label);
DeviceWarning {
info_bar,
label,
}
}

fn update(&self, warning: Option<&str>) {
if let Some(reason) = warning {
self.info_bar.set_message_type(MessageType::Warning);
self.label.set_text(&format!(
"This device is not usable because: {reason}"));
self.info_bar.set_revealed(true);
} else {
self.info_bar.set_revealed(false);
}
}
}

pub struct UserInterface {
pub capture: CaptureReader,
selector: DeviceSelector,
Expand All @@ -272,6 +319,7 @@ pub struct UserInterface {
capture_button: Button,
stop_button: Button,
status_label: Label,
warning: DeviceWarning,
#[cfg(any(test, feature="record-ui-test"))]
pub recording: Rc<RefCell<Recording>>,
}
Expand Down Expand Up @@ -336,6 +384,9 @@ pub fn activate(application: &Application) -> Result<(), Error> {
action_bar.pack_start(&stop_button);
action_bar.pack_start(&selector.container);

let warning = DeviceWarning::new();
warning.update(selector.device_unusable());

#[cfg(not(test))]
window.show();
WINDOW.with(|win_opt| win_opt.replace(Some(window.clone())));
Expand Down Expand Up @@ -388,6 +439,8 @@ pub fn activate(application: &Application) -> Result<(), Error> {

vbox.append(&action_bar);
vbox.append(&gtk::Separator::new(Orientation::Horizontal));
vbox.append(&warning.info_bar);
vbox.append(&gtk::Separator::new(Orientation::Horizontal));
vbox.append(&paned);
vbox.append(&gtk::Separator::new(Orientation::Horizontal));
vbox.append(&status_label);
Expand Down Expand Up @@ -426,6 +479,7 @@ pub fn activate(application: &Application) -> Result<(), Error> {
capture_button,
stop_button,
status_label,
warning,
}
)
});
Expand Down Expand Up @@ -842,13 +896,15 @@ fn detect_hardware() -> Result<(), Error> {
with_ui(|ui| {
ui.selector.scan()?;
ui.capture_button.set_sensitive(ui.selector.device_available());
ui.warning.update(ui.selector.device_unusable());
Ok(())
})
}

fn device_selection_changed() -> Result<(), Error> {
with_ui(|ui| {
ui.capture_button.set_sensitive(ui.selector.device_available());
ui.warning.update(ui.selector.device_unusable());
ui.selector.update_speeds();
Ok(())
})
Expand Down
Loading