mirror of
https://github.com/nushell/nushell.git
synced 2024-12-25 00:19:39 +01:00
1cd0544a3f
This PR will close #13501 # Description This PR expands on [the relay of signals to running plugin processes](https://github.com/nushell/nushell/pull/13181). The Ctrlc relay has been generalized to SignalAction::Interrupt and when reset_signal is called on the main EngineState, a SignalAction::Reset is now relayed to running plugins. # User-Facing Changes The signal handler closure now takes a `signals::SignalAction`, while previously it took no arguments. The handler will now be called on both interrupt and reset. The method to register a handler on the plugin side is now called `register_signal_handler` instead of `register_ctrlc_handler` [example](https://github.com/nushell/nushell/pull/13510/files#diff-3e04dff88fd0780a49778a3d1eede092ec729a1264b4ef07ca0d2baa859dad05L38). This will only affect plugin authors who have started making use of https://github.com/nushell/nushell/pull/13181, which isn't currently part of an official release. The change will also require all of user's plugins to be recompiled in order that they don't error when a signal is received on the PluginInterface. # Testing ``` : example ctrlc interrupt status: false waiting for interrupt signal... ^Cinterrupt status: true peace. Error: × Operation interrupted ╭─[display_output hook:1:1] 1 │ if (term size).columns >= 100 { table -e } else { table } · ─┬ · ╰── This operation was interrupted ╰──── : example ctrlc interrupt status: false <-- NOTE status is false waiting for interrupt signal... ^Cinterrupt status: true peace. Error: × Operation interrupted ╭─[display_output hook:1:1] 1 │ if (term size).columns >= 100 { table -e } else { table } · ─┬ · ╰── This operation was interrupted ╰──── ```
20 lines
623 B
Rust
20 lines
623 B
Rust
use nu_protocol::{engine::EngineState, Handlers, SignalAction, Signals};
|
|
use std::sync::{
|
|
atomic::{AtomicBool, Ordering},
|
|
Arc,
|
|
};
|
|
|
|
pub(crate) fn ctrlc_protection(engine_state: &mut EngineState) {
|
|
let interrupt = Arc::new(AtomicBool::new(false));
|
|
engine_state.set_signals(Signals::new(interrupt.clone()));
|
|
|
|
let signal_handlers = Handlers::new();
|
|
engine_state.signal_handlers = Some(signal_handlers.clone());
|
|
|
|
ctrlc::set_handler(move || {
|
|
interrupt.store(true, Ordering::Relaxed);
|
|
signal_handlers.run(SignalAction::Interrupt);
|
|
})
|
|
.expect("Error setting Ctrl-C handler");
|
|
}
|