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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
//!
//! Module implementing the terminal interface abstraction
//!
use crate::CrLf;
use crate::UnicodeString;
use crate::clear::*;
use crate::cli::Cli;
use crate::cursor::*;
use crate::error::Error;
use crate::keys::Key;
use crate::result::Result;
use cfg_if::cfg_if;
use futures::*;
pub use pad::PadStr;
use regex::Regex;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::sync::{Arc, LockResult, Mutex, MutexGuard};
use workflow_core::channel::{Channel, DuplexChannel, Receiver, Sender, unbounded};
use workflow_core::task::spawn;
use workflow_log::log_error;
const DEFAULT_PARA_WIDTH: usize = 80;
/// State of keyboard modifier keys that were held during an event
/// (such as a link click).
pub struct Modifiers {
/// Whether the Alt key was held.
pub alt: bool,
/// Whether the Shift key was held.
pub shift: bool,
/// Whether the Ctrl key was held.
pub ctrl: bool,
/// Whether the Meta (Command/Windows) key was held.
pub meta: bool,
}
/// Callback invoked when a registered link matcher matches, receiving the
/// active keyboard [`Modifiers`] and the matched text.
pub type LinkMatcherHandlerFn = Arc<Box<dyn Fn(Modifiers, &str)>>;
/// Terminal events emitted to registered event handlers.
#[derive(Debug, Clone)]
pub enum Event {
/// The user requested a copy (e.g. via keyboard shortcut).
Copy,
/// The user requested a paste (e.g. via keyboard shortcut).
Paste,
}
/// Callback invoked when a terminal [`Event`] occurs.
pub type EventHandlerFn = Arc<Box<dyn Fn(Event)>>;
mod options;
pub use options::Options;
pub use options::TargetElement;
pub mod bindings;
/// xterm.js-based terminal interface bindings for WASM/browser targets.
pub mod xterm;
pub use xterm::{Theme, ThemeOption};
cfg_if! {
if #[cfg(target_arch = "wasm32")] {
// pub mod xterm;
// pub mod bindings;
use crate::terminal::xterm::Xterm as Interface;
} else if #[cfg(feature = "termion")] {
pub mod termion;
use crate::terminal::termion::Termion as Interface;
} else {
/// Crossterm-based terminal interface for native targets.
pub mod crossterm;
use crate::terminal::crossterm::Crossterm as Interface;
pub use crate::terminal::crossterm::{disable_raw_mode,init_panic_hook};
}
}
/// Mutable interior state of a [`Terminal`]: the current line buffer,
/// command history, and cursor position.
#[derive(Debug)]
pub struct Inner {
/// The text currently entered on the active input line.
pub buffer: UnicodeString,
history: Vec<UnicodeString>,
/// Cursor position as a character offset within `buffer`.
pub cursor: usize,
history_index: usize,
}
impl Default for Inner {
fn default() -> Self {
Self::new()
}
}
impl Inner {
/// Create empty interior state with an empty buffer and history.
pub fn new() -> Self {
Inner {
buffer: UnicodeString::default(),
history: vec![],
cursor: 0,
history_index: 0,
}
}
/// Clear the current input line buffer and reset the cursor to the start.
pub fn reset_line_buffer(&mut self) {
self.buffer.clear();
self.cursor = 0;
}
}
#[derive(Clone)]
struct UserInput {
prompt: Arc<Mutex<Option<String>>>,
buffer: Arc<Mutex<UnicodeString>>,
enabled: Arc<AtomicBool>,
secret: Arc<AtomicBool>,
kbhit: Arc<AtomicBool>,
terminate: Arc<AtomicBool>,
sender: Sender<String>,
receiver: Receiver<String>,
}
impl UserInput {
pub fn new() -> Self {
let (sender, receiver) = unbounded();
UserInput {
prompt: Arc::new(Mutex::new(None)),
buffer: Arc::new(Mutex::new(UnicodeString::default())),
enabled: Arc::new(AtomicBool::new(false)),
secret: Arc::new(AtomicBool::new(false)),
kbhit: Arc::new(AtomicBool::new(false)),
terminate: Arc::new(AtomicBool::new(false)),
sender,
receiver,
}
}
pub fn get_prompt(&self) -> Option<String> {
self.prompt.lock().unwrap().clone()
}
pub fn get_buffer(&self) -> String {
self.buffer.lock().unwrap().clone().to_string()
}
pub fn open(&self, secret: bool, kbhit: bool, prompt: Option<String>) -> Result<()> {
*self.prompt.lock().unwrap() = prompt;
self.enabled.store(true, Ordering::SeqCst);
self.secret.store(secret, Ordering::SeqCst);
self.kbhit.store(kbhit, Ordering::SeqCst);
self.terminate.store(false, Ordering::SeqCst);
Ok(())
}
pub fn close(&self) -> Result<()> {
let s = {
self.prompt.lock().unwrap().take();
let mut buffer = self.buffer.lock().unwrap();
let s = buffer.clone();
buffer.clear();
s
};
self.enabled.store(false, Ordering::SeqCst);
self.terminate.store(true, Ordering::SeqCst);
self.sender.try_send(s.to_string()).unwrap();
Ok(())
}
pub async fn capture(
&self,
secret: bool,
kbhit: bool,
prompt: Option<String>,
term: &Arc<Terminal>,
) -> Result<String> {
self.open(secret, kbhit, prompt)?;
let term = term.clone();
let terminate = self.terminate.clone();
cfg_if! {
// TODO - refactor
// this is currently a workaround due to DOM
// clipboard API using JsPromise.
if #[cfg(target_arch = "wasm32")] {
workflow_core::task::dispatch(async move {
let _result = term.term().intake(&terminate).await;
});
} else {
workflow_core::task::spawn(async move {
let _result = term.term().intake(&terminate).await;
});
}
}
let string = self.receiver.recv().await?;
Ok(string)
}
fn is_enabled(&self) -> bool {
self.enabled.load(Ordering::SeqCst)
}
fn is_secret(&self) -> bool {
self.secret.load(Ordering::SeqCst)
}
fn is_kbhit(&self) -> bool {
self.kbhit.load(Ordering::SeqCst)
}
fn ingest(&self, key: Key, term: &Arc<Terminal>) -> Result<()> {
match key {
Key::Ctrl('c') => {
self.close()?;
term.abort();
}
Key::Char(ch) => {
self.buffer.lock().unwrap().push(ch);
if !self.is_secret() {
term.write(ch);
}
if self.is_kbhit() {
term.crlf();
self.close()?;
}
}
Key::Backspace => {
self.buffer.lock().unwrap().pop();
if !self.is_secret() {
term.write("\x08 \x08");
}
}
Key::Enter => {
// term.writeln("");
term.crlf();
self.close()?;
}
_ => {}
}
Ok(())
}
#[allow(dead_code)]
pub fn inject<S: ToString>(&self, text: S, term: &Terminal) -> Result<()> {
self.inject_impl(text.to_string().into(), term)?;
Ok(())
}
fn inject_impl(&self, text: UnicodeString, term: &Terminal) -> Result<()> {
let mut buffer = self.buffer.lock().unwrap();
if !self.is_secret() {
text.iter().for_each(|ch| {
term.write(ch);
});
}
buffer.extend(text);
Ok(())
}
}
/// Terminal interface
#[derive(Clone)]
pub struct Terminal {
inner: Arc<Mutex<Inner>>,
/// Set while a submitted command is being processed by the [`Cli`] handler.
pub running: Arc<AtomicBool>,
/// The default prompt string rendered before each input line.
pub prompt: Arc<Mutex<String>>,
/// The underlying platform-specific terminal interface.
pub term: Arc<Interface>,
/// The command-line processor that handles submitted commands.
pub handler: Arc<dyn Cli>,
/// When set, the terminal exits its run loop after the current command.
pub terminate: Arc<AtomicBool>,
user_input: UserInput,
/// Pipe for writing raw text (without newline conversion) to the terminal.
pub pipe_raw: Channel<String>,
/// Pipe for writing lines (terminated with CRLF) to the terminal.
pub pipe_crlf: Channel<String>,
/// Duplex control channel used to start and stop the pipe processing task.
pub pipe_ctl: DuplexChannel<()>,
/// Fallback paragraph wrap width (in columns) when the terminal width is unknown.
pub para_width: Arc<AtomicUsize>,
}
impl Terminal {
/// Create a new default terminal instance bound to the supplied command-line processor [`Cli`].
pub fn try_new(handler: Arc<dyn Cli>, prompt: &str) -> Result<Self> {
let term = Arc::new(Interface::try_new()?);
let terminal = Self {
inner: Arc::new(Mutex::new(Inner::new())),
running: Arc::new(AtomicBool::new(false)),
prompt: Arc::new(Mutex::new(prompt.to_string())),
term,
handler,
terminate: Arc::new(AtomicBool::new(false)),
user_input: UserInput::new(),
pipe_raw: Channel::unbounded(),
pipe_crlf: Channel::unbounded(),
pipe_ctl: DuplexChannel::oneshot(),
para_width: Arc::new(AtomicUsize::new(DEFAULT_PARA_WIDTH)),
};
Ok(terminal)
}
/// Create a new terminal instance bound to the supplied command-line processor [`Cli`].
/// Receives [`options::Options`] that allow terminal customization.
pub fn try_new_with_options(
handler: Arc<dyn Cli>,
// prompt : &str,
options: Options,
) -> Result<Self> {
let term = Arc::new(Interface::try_new_with_options(&options)?);
let terminal = Self {
inner: Arc::new(Mutex::new(Inner::new())),
running: Arc::new(AtomicBool::new(false)),
prompt: Arc::new(Mutex::new(options.prompt())),
term,
handler,
terminate: Arc::new(AtomicBool::new(false)),
user_input: UserInput::new(),
pipe_raw: Channel::unbounded(),
pipe_crlf: Channel::unbounded(),
pipe_ctl: DuplexChannel::oneshot(),
para_width: Arc::new(AtomicUsize::new(DEFAULT_PARA_WIDTH)),
};
Ok(terminal)
}
/// Init the terminal instance
pub async fn init(self: &Arc<Self>) -> Result<()> {
self.term.init(self).await?;
self.handler.clone().init(self)?;
Ok(())
}
/// Access to the underlying terminal instance
pub fn inner(&self) -> LockResult<MutexGuard<'_, Inner>> {
self.inner.lock()
}
/// Get terminal command line history list as `Vec<String>`
pub fn history(&self) -> Vec<UnicodeString> {
let data = self.inner().unwrap();
data.history.clone()
}
/// Clear the current input line buffer and reset the cursor to the start.
pub fn reset_line_buffer(&self) {
self.inner().unwrap().reset_line_buffer();
}
/// Get the current terminal prompt string
pub fn get_prompt(&self) -> String {
if let Some(prompt) = self.handler.prompt() {
prompt
} else {
self.prompt.lock().unwrap().clone()
}
}
/// Render the current prompt in the terminal
pub fn prompt(&self) {
let mut data = self.inner().unwrap();
data.cursor = 0;
data.buffer.clear();
self.term().write(self.get_prompt());
}
/// Output CRLF sequence
pub fn crlf(&self) {
self.term().write("\n\r".to_string());
}
/// Write a string
pub fn write<S>(&self, s: S)
where
S: ToString,
{
self.term().write(s);
}
/// Write a string ending with CRLF sequence
pub fn writeln<S>(&self, s: S)
where
S: ToString,
{
if self.is_running() {
if self.user_input.is_enabled() {
if let Some(prompt) = self.user_input.get_prompt() {
self.write(format!("{}{}\n\r", ClearLine, s.to_string()));
self.write(prompt);
if !self.user_input.secret.load(Ordering::SeqCst) {
self.write(self.user_input.get_buffer());
}
}
} else {
self.write(format!("{}\n\r", s.to_string()));
}
} else {
self.write(format!("{}{}\n\r", ClearLine, s.to_string()));
let data = self.inner().unwrap();
let p = format!("{}{}", self.get_prompt(), data.buffer);
self.write(p);
let l = data.buffer.len() - data.cursor;
for _ in 0..l {
self.write("\x08".to_string());
}
}
}
/// Refreshes the prompt and the user input buffer. This function
/// is useful when the prompt is handled externally and contains
/// data that should be updated.
pub fn refresh_prompt(&self) {
if !self.is_running() {
self.write(format!("{}", ClearLine));
let data = self.inner().unwrap();
let p = format!("{}{}", self.get_prompt(), data.buffer);
self.write(p);
let l = data.buffer.len() - data.cursor;
for _ in 0..l {
self.write("\x08".to_string());
}
}
}
/// Write `text` to the terminal as a paragraph, word-wrapped to the
/// current terminal width (falling back to [`Terminal::para_width`]).
pub fn para<S>(&self, text: S)
where
S: Into<String>,
{
let width = self
.term()
.cols()
.unwrap_or_else(|| self.para_width.load(Ordering::SeqCst));
let options = textwrap::Options::new(width).line_ending(textwrap::LineEnding::CRLF);
textwrap::wrap(text.into().as_str(), options)
.into_iter()
.for_each(|line| self.writeln(line));
}
/// Write `text` to the terminal as a paragraph, word-wrapped using the
/// supplied width or [`textwrap::Options`].
pub fn para_with_options<'a, S, Opt>(&self, width_or_options: Opt, text: S)
where
S: Into<String>,
Opt: Into<textwrap::Options<'a>>,
{
// use textwrap::wrap;
textwrap::wrap(text.into().crlf().as_str(), width_or_options.into())
.into_iter()
.for_each(|line| self.writeln(line));
}
/// Render a formatted, alphabetically-sorted help listing of
/// `(command, description)` pairs, wrapping descriptions to fit the
/// terminal width. `separator` (default a single space) is placed between
/// each command and its description.
pub fn help<S: ToString, H: ToString>(
&self,
list: &[(S, H)],
separator: Option<&str>,
) -> Result<()> {
let mut list = list
.iter()
.map(|(cmd, help)| (cmd.to_string(), help.to_string()))
.collect::<Vec<_>>();
list.sort_by_key(|(cmd, _)| cmd.to_string());
let separator = separator.unwrap_or(" ");
let term_width: usize = self.cols().unwrap_or(80);
let cmd_width = list.iter().map(|(c, _)| c.len()).fold(0, |a, b| a.max(b)) + 2;
let help_width = term_width - cmd_width - 2 - 4 - separator.len();
let cmd_space = "".pad_to_width(cmd_width);
self.writeln("");
for (cmd, help) in list {
let mut first = true;
let options =
textwrap::Options::new(help_width).line_ending(textwrap::LineEnding::CRLF);
textwrap::wrap(help.as_str(), options)
.into_iter()
.for_each(|line| {
if first {
self.writeln(format!(
"{:>4}{}{}{}",
"",
cmd.pad_to_width(cmd_width),
separator,
line
));
first = false;
} else {
self.writeln(format!("{:>4}{cmd_space}{}{}", "", separator, line));
}
});
}
self.writeln("");
Ok(())
}
/// Get a clone of Arc of the underlying terminal instance
pub fn term(&self) -> Arc<Interface> {
Arc::clone(&self.term)
}
async fn pipe_start(self: &Arc<Self>) -> Result<()> {
let self_ = self.clone();
spawn(async move {
loop {
select! {
_ = self_.pipe_ctl.request.receiver.recv().fuse() => {
break;
},
raw = self_.pipe_raw.receiver.recv().fuse() => {
raw.map(|text|self_.write(text)).unwrap_or_else(|err|log_error!("Error writing from raw pipe: {err}"));
},
text = self_.pipe_crlf.receiver.recv().fuse() => {
text.map(|text|self_.writeln(text)).unwrap_or_else(|err|log_error!("Error writing from crlf pipe: {err}"));
},
}
}
self_
.pipe_ctl
.response
.sender
.send(())
.await
.unwrap_or_else(|err| log_error!("Error posting shutdown ctl: {err}"));
});
Ok(())
}
async fn pipe_stop(self: &Arc<Self>) -> Result<()> {
self.pipe_ctl.signal(()).await?;
Ok(())
}
fn pipe_abort(self: &Arc<Self>) -> Result<()> {
self.pipe_ctl.request.try_send(())?;
Ok(())
}
/// Execute the async terminal processing loop.
/// Once started, it should be stopped using
/// [`Terminal::exit`]
pub async fn run(self: &Arc<Self>) -> Result<()> {
// self.prompt();
self.pipe_start().await?;
self.term().run().await
}
/// Exits the async terminal processing loop (async fn)
pub async fn exit(self: &Arc<Self>) {
self.terminate.store(true, Ordering::SeqCst);
self.pipe_stop().await.unwrap_or_else(|err| panic!("{err}"));
self.term.exit();
}
/// Exits the async terminal processing loop (sync fn)
pub fn abort(self: &Arc<Self>) {
self.terminate.store(true, Ordering::SeqCst);
self.pipe_abort().unwrap_or_else(|err| panic!("{err}"));
self.term.exit();
}
/// Ask a question (input a string until CRLF).
/// `secret` argument suppresses echoing of the
/// user input (useful for password entry)
pub async fn ask(self: &Arc<Terminal>, secret: bool, prompt: &str) -> Result<String> {
self.reset_line_buffer();
self.term().write(prompt.to_string());
self.user_input
.capture(secret, false, Some(prompt.to_string()), self)
.await
}
/// Wait for a single keystroke, optionally displaying `prompt` first, and
/// return the captured key without echoing it.
pub async fn kbhit(self: &Arc<Terminal>, prompt: Option<&str>) -> Result<String> {
self.reset_line_buffer();
if let Some(prompt) = prompt {
self.term().write(prompt.to_string());
}
self.user_input
.capture(true, true, prompt.map(String::from), self)
.await
}
/// Inject a string into the current cursor position
pub fn inject_unicode_string(&self, text: UnicodeString) -> Result<()> {
let mut data = self.inner()?;
self.inject_impl(&mut data, text)?;
Ok(())
}
/// Insert `text` into the current input line at the cursor position.
pub fn inject<S: ToString>(&self, text: S) -> Result<()> {
let mut data = self.inner()?;
self.inject_impl(&mut data, text.to_string().into())
}
fn inject_impl(&self, data: &mut Inner, text: UnicodeString) -> Result<()> {
if self.user_input.is_enabled() {
self.user_input.inject_impl(text, self)
} else {
let len = text.len();
data.buffer.insert(data.cursor, text);
self.trail(data.cursor, &data.buffer, true, false, len);
data.cursor += len;
Ok(())
}
}
/// Insert a single character into the current input line at the cursor
/// position.
pub fn inject_char(&self, ch: char) -> Result<()> {
let mut data = self.inner()?;
self.inject_char_impl(&mut data, ch)?;
Ok(())
}
fn inject_char_impl(&self, data: &mut Inner, ch: char) -> Result<()> {
data.buffer.insert_char(data.cursor, ch);
self.trail(data.cursor, &data.buffer, true, false, 1);
data.cursor += 1;
Ok(())
}
async fn ingest(self: &Arc<Terminal>, key: Key, _term_key: String) -> Result<()> {
if self.user_input.is_enabled() {
self.user_input.ingest(key, self)?;
return Ok(());
}
match key {
Key::Backspace => {
let mut data = self.inner()?;
if data.cursor == 0 {
return Ok(());
}
self.write("\x08".to_string());
data.cursor -= 1;
let idx = data.cursor;
data.buffer.remove(idx);
self.trail(data.cursor, &data.buffer, true, true, 0);
}
Key::ArrowUp => {
let mut data = self.inner()?;
if data.history_index == 0 {
return Ok(());
}
let current_buffer = data.buffer.clone();
let index = data.history_index;
//log_trace!("ArrowUp: index {}, data.history.len(): {}", index, data.history.len());
if data.history.len() <= index {
data.history.push(current_buffer);
} else {
data.history[index] = current_buffer;
}
data.history_index -= 1;
data.buffer = data.history[data.history_index].clone();
self.write(format!("{}{}{}", ClearLine, self.get_prompt(), data.buffer));
data.cursor = data.buffer.len();
}
Key::ArrowDown => {
let mut data = self.inner()?;
let len = data.history.len();
if data.history_index >= len {
return Ok(());
}
let index = data.history_index;
data.history[index] = data.buffer.clone();
data.history_index += 1;
if data.history_index == len {
data.buffer.clear();
} else {
data.buffer = data.history[data.history_index].clone();
}
self.write(format!("{}{}{}", ClearLine, self.get_prompt(), data.buffer));
data.cursor = data.buffer.len();
}
Key::ArrowLeft => {
let mut data = self.inner()?;
if data.cursor == 0 {
return Ok(());
}
data.cursor -= 1;
self.write(Left(1));
}
Key::ArrowRight => {
let mut data = self.inner()?;
if data.cursor < data.buffer.len() {
data.cursor += 1;
self.write(Right(1));
}
}
Key::Enter => {
let cmd = {
let mut data = self.inner()?;
let buffer = data.buffer.clone();
let length = data.history.len();
data.buffer.clear();
data.cursor = 0;
if !buffer.is_empty() {
let cmd = buffer.clone();
if length == 0 || !data.history[length - 1].is_empty() {
data.history_index = length;
} else {
data.history_index = length - 1;
}
let index = data.history_index;
if length <= index {
data.history.push(buffer);
} else {
data.history[index] = buffer;
}
data.history_index += 1;
Some(cmd)
} else {
None
}
};
self.crlf();
if let Some(cmd) = cmd {
self.running.store(true, Ordering::SeqCst);
self.exec(cmd).await.ok();
self.running.store(false, Ordering::SeqCst);
} else {
self.prompt();
}
}
Key::Alt(_c) => {
return Ok(());
}
Key::Ctrl('c') => {
cfg_if! {
if #[cfg(not(target_arch = "wasm32"))] {
self.exit().await;
}
}
return Ok(());
}
Key::Ctrl(_c) => {
return Ok(());
}
Key::Char(ch) => {
self.inject_char(ch)?;
}
_ => {
return Ok(());
}
}
Ok(())
}
fn trail(
&self,
cursor: usize,
buffer: &UnicodeString,
rewind: bool,
erase_last: bool,
offset: usize,
) {
let mut tail = UnicodeString::from(&buffer.0[cursor..]); //.to_vec();//.to_string();
if erase_last {
tail.push(' ');
}
self.write(&tail);
if rewind {
let mut l = tail.len();
if offset > 0 {
l -= offset;
}
for _ in 0..l {
self.write("\x08"); // backspace
}
}
}
/// Indicates that the terminal has received command input
/// and has not yet returned from the processing. This flag
/// is set to true when delivering the user command to the
/// [`Cli`] handler and is reset to false when the [`Cli`]
/// handler returns.
#[inline]
pub fn is_running(&self) -> bool {
self.running.load(Ordering::SeqCst)
}
/// Submit `cmd` to the [`Cli`] handler for processing, printing any error
/// it returns and then either exiting (if termination was requested) or
/// re-rendering the prompt.
pub async fn exec<S: ToString>(self: &Arc<Terminal>, cmd: S) -> Result<()> {
if let Err(err) = self
.handler
.clone()
.digest(self.clone(), cmd.to_string())
.await
{
self.writeln(err);
}
if self.terminate.load(Ordering::SeqCst) {
self.term().exit();
} else {
self.prompt();
}
Ok(())
}
/// Apply the supplied color [`Theme`] (effective on the WASM/xterm.js target).
pub fn set_theme(&self, _theme: Theme) -> Result<()> {
#[cfg(target_arch = "wasm32")]
self.term.set_theme(_theme)?;
Ok(())
}
/// Re-apply the current theme to the terminal (effective on the WASM/xterm.js target).
pub fn update_theme(&self) -> Result<()> {
#[cfg(target_arch = "wasm32")]
self.term.update_theme()?;
Ok(())
}
/// Copy the current terminal selection to the system clipboard
/// (effective on the WASM/xterm.js target).
pub fn clipboard_copy(&self) -> Result<()> {
#[cfg(target_arch = "wasm32")]
self.term.clipboard_copy()?;
Ok(())
}
/// Paste the system clipboard contents into the terminal
/// (effective on the WASM/xterm.js target).
pub fn clipboard_paste(&self) -> Result<()> {
#[cfg(target_arch = "wasm32")]
self.term.clipboard_paste()?;
Ok(())
}
/// Increase the terminal font size, returning the new size if applicable.
pub fn increase_font_size(&self) -> Result<Option<f64>> {
self.term.increase_font_size()
}
/// Decrease the terminal font size, returning the new size if applicable.
pub fn decrease_font_size(&self) -> Result<Option<f64>> {
self.term.decrease_font_size()
}
/// Set the terminal font size to `font_size`.
pub fn set_font_size(&self, font_size: f64) -> Result<()> {
self.term.set_font_size(font_size)
}
/// Return the current terminal font size, if known.
pub fn get_font_size(&self) -> Result<Option<f64>> {
self.term.get_font_size()
}
/// Return the terminal width in columns, if known.
pub fn cols(&self) -> Option<usize> {
self.term.cols()
}
/// Prompt the user to choose one item from `list` by its index. Returns
/// `None` for an empty list, the sole item for a single-element list, and
/// otherwise repeatedly displays the choices until a valid index is entered;
/// pressing enter on an empty line aborts with [`Error::UserAbort`].
pub async fn select<T>(self: &Arc<Terminal>, prompt: &str, list: &[T]) -> Result<Option<T>>
where
T: std::fmt::Display + Clone, // + IdT + Clone + Send + Sync + 'static,
{
if list.is_empty() {
Ok(None)
} else if list.len() == 1 {
Ok(list.first().cloned())
} else {
let mut selection = None;
while selection.is_none() {
list.iter().enumerate().for_each(|(seq, item)| {
self.writeln(format!("{seq}: {item}"));
});
let text = self
.ask(
false,
&format!("{prompt} [{}..{}] or <enter> to abort: ", 0, list.len() - 1),
)
.await?
.trim()
.to_string();
if text.is_empty() {
self.writeln("aborting...");
return Err(Error::UserAbort);
} else {
match text.parse::<usize>() {
Ok(seq) if seq < list.len() => selection = list.get(seq).cloned(),
_ => {}
};
}
}
Ok(selection)
}
}
/// Register a handler invoked on terminal [`Event`]s such as copy and paste
/// (effective on the WASM/xterm.js target).
pub fn register_event_handler(self: &Arc<Self>, _handler: EventHandlerFn) -> Result<()> {
#[cfg(target_arch = "wasm32")]
self.term.register_event_handler(_handler)?;
Ok(())
}
/// Register a handler invoked when terminal text matching `_regexp` is
/// clicked (effective on the WASM/xterm.js target).
pub fn register_link_matcher(
&self,
_regexp: &js_sys::RegExp,
_handler: LinkMatcherHandlerFn,
) -> Result<()> {
cfg_if! {
if #[cfg(target_arch = "wasm32")] {
self.term.register_link_matcher(_regexp, _handler)?;
}
}
Ok(())
}
}
/// Utility function to strip multiple white spaces and return a `Vec<String>`
pub fn parse(s: &str) -> Vec<String> {
let regex = Regex::new(r"\s+").unwrap();
let s = regex.replace_all(s.trim(), " ");
s.split(' ').map(|s| s.to_string()).collect::<Vec<String>>()
}