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
#[macro_export]
macro_rules! derive_text_widget {
($state:ty) => {
derive_text_widget!(BASE $state);
};
(BASE $state:ty) => {
impl <'a> $state {
/// Set the combined style.
#[inline]
pub fn styles(mut self, style: TextStyle) -> Self {
self.widget = self.widget.styles(style);
self
}
/// Base text style.
#[inline]
pub fn style(mut self, style: impl Into<Style>) -> Self {
self.widget = self.widget.style(style);
self
}
/// Style when focused.
#[inline]
pub fn focus_style(mut self, style: impl Into<Style>) -> Self {
self.widget = self.widget.focus_style(style);
self
}
/// Style for selection
#[inline]
pub fn select_style(mut self, style: impl Into<Style>) -> Self {
self.widget = self.widget.select_style(style);
self
}
/// Style for the invalid indicator.
#[inline]
pub fn invalid_style(mut self, style: impl Into<Style>) -> Self {
self.widget = self.widget.invalid_style(style);
self
}
/// Block
#[inline]
pub fn block(mut self, block: ratatui_widgets::block::Block<'a>) -> Self {
self.widget = self.widget.block(block);
self
}
/// Focus behaviour
#[inline]
pub fn on_focus_gained(mut self, of: TextFocusGained) -> Self {
self.widget = self.widget.on_focus_gained(of);
self
}
/// Focus behaviour
#[inline]
pub fn on_focus_lost(mut self, of: TextFocusLost) -> Self {
self.widget = self.widget.on_focus_lost(of);
self
}
/// `Tab` behaviour
#[inline]
pub fn on_tab(mut self, of: TextTab) -> Self {
self.widget = self.widget.on_tab(of);
self
}
}
}
}
#[macro_export]
macro_rules! derive_text_widget_state {
($state:ty) => {
derive_text_widget_state!(BASE $state);
derive_text_widget_state!(CLIPBOARD $state);
derive_text_widget_state!(UNDO $state);
derive_text_widget_state!(STYLE $state);
derive_text_widget_state!(OFFSET $state);
derive_text_widget_state!(EDIT $state);
derive_text_widget_state!(MOVE $state);
derive_text_widget_state!(FOCUS $state);
derive_text_widget_state!(SCREENCURSOR $state);
derive_text_widget_state!(RELOCATE $state);
};
(BASE $state:ty) => {
impl $state {
/// Empty
#[inline]
pub fn is_empty(&self) -> bool {
self.widget.is_empty()
}
/// Length in grapheme count.
#[inline]
pub fn len(&self) -> $crate::upos_type {
self.widget.len()
}
/// Length as grapheme count.
#[inline]
pub fn line_width(&self) -> $crate::upos_type {
self.widget.line_width()
}
/// Renders the widget in invalid style.
#[inline]
pub fn set_invalid(&mut self, invalid: bool) {
self.widget.invalid = invalid;
}
/// Renders the widget in invalid style.
#[inline]
pub fn get_invalid(&self) -> bool {
self.widget.invalid
}
/// The next edit operation will overwrite the current content
/// instead of adding text. Any move operations will cancel
/// this overwrite.
#[inline]
pub fn set_overwrite(&mut self, overwrite: bool) {
self.widget.set_overwrite(overwrite);
}
/// Will the next edit operation overwrite the content?
#[inline]
pub fn overwrite(&self) -> bool {
self.widget.overwrite()
}
}
};
(CLIPBOARD $state:ty) => {
impl $state {
/// Clipboard used.
/// Default is to use the [global_clipboard](crate::clipboard::global_clipboard).
#[inline]
pub fn set_clipboard(&mut self, clip: Option<impl $crate::clipboard::Clipboard + 'static>) {
self.widget.set_clipboard(clip);
}
/// Clipboard used.
/// Default is to use the [global_clipboard](crate::clipboard::global_clipboard).
#[inline]
pub fn clipboard(&self) -> Option<&dyn $crate::clipboard::Clipboard> {
self.widget.clipboard()
}
/// Copy to clipboard
#[inline]
pub fn copy_to_clip(&mut self) -> bool {
self.widget.copy_to_clip()
}
/// Cut to clipboard
#[inline]
pub fn cut_to_clip(&mut self) -> bool {
self.widget.cut_to_clip()
}
/// Paste from clipboard.
#[inline]
pub fn paste_from_clip(&mut self) -> bool {
self.widget.paste_from_clip()
}
}
};
(UNDO $state:ty) => {
impl $state {
/// Set undo buffer.
#[inline]
pub fn set_undo_buffer(&mut self, undo: Option<impl $crate::undo_buffer::UndoBuffer + 'static>) {
self.widget.set_undo_buffer(undo);
}
/// Undo
#[inline]
pub fn undo_buffer(&self) -> Option<&dyn $crate::undo_buffer::UndoBuffer> {
self.widget.undo_buffer()
}
/// Undo
#[inline]
pub fn undo_buffer_mut(&mut self) -> Option<&mut dyn $crate::undo_buffer::UndoBuffer> {
self.widget.undo_buffer_mut()
}
/// Get all recent replay recordings.
#[inline]
pub fn recent_replay_log(&mut self) -> Vec<$crate::undo_buffer::UndoEntry> {
self.widget.recent_replay_log()
}
/// Apply the replay recording.
#[inline]
pub fn replay_log(&mut self, replay: &[$crate::undo_buffer::UndoEntry]) {
self.widget.replay_log(replay)
}
/// Undo operation
#[inline]
pub fn undo(&mut self) -> bool {
self.widget.undo()
}
/// Redo operation
#[inline]
pub fn redo(&mut self) -> bool {
self.widget.redo()
}
}
};
(STYLE $state:ty) => {
impl $state {
/// Set and replace all styles.
#[inline]
pub fn set_styles(&mut self, styles: Vec<(std::ops::Range<usize>, usize)>) {
self.widget.set_styles(styles);
}
/// Add a style for a byte-range.
#[inline]
pub fn add_style(&mut self, range: std::ops::Range<usize>, style: usize) {
self.widget.add_style(range, style);
}
/// Add a style for a `Range<upos_type>` .
/// The style-nr refers to one of the styles set with the widget.
#[inline]
pub fn add_range_style(
&mut self,
range: std::ops::Range<$crate::upos_type>,
style: usize,
) -> Result<(), $crate::TextError> {
self.widget.add_range_style(range, style)
}
/// Remove the exact TextRange and style.
#[inline]
pub fn remove_style(&mut self, range: std::ops::Range<usize>, style: usize) {
self.widget.remove_style(range, style);
}
/// Remove the exact `Range<upos_type>` and style.
#[inline]
pub fn remove_range_style(
&mut self,
range: std::ops::Range<$crate::upos_type>,
style: usize,
) -> Result<(), $crate::TextError> {
self.widget.remove_range_style(range, style)
}
/// Find all styles that touch the given range.
pub fn styles_in(&self, range: std::ops::Range<usize>, buf: &mut Vec<(std::ops::Range<usize>, usize)>) {
self.widget.styles_in(range, buf)
}
/// All styles active at the given position.
#[inline]
pub fn styles_at(&self, byte_pos: usize, buf: &mut Vec<(std::ops::Range<usize>, usize)>) {
self.widget.styles_at(byte_pos, buf)
}
/// Check if the given style applies at the position and
/// return the complete range for the style.
#[inline]
pub fn style_match(&self, byte_pos: usize, style: usize) -> Option<std::ops::Range<usize>> {
self.widget.styles_at_match(byte_pos, style)
}
/// List of all styles.
#[inline]
pub fn styles(&self) -> Option<impl Iterator<Item = (std::ops::Range<usize>, usize)> + '_> {
self.widget.styles()
}
}
};
(OFFSET $state:ty) => {
impl $state {
/// Offset shown.
#[inline]
pub fn offset(&self) -> $crate::upos_type {
self.widget.offset()
}
/// Offset shown. This is corrected if the cursor wouldn't be visible.
#[inline]
pub fn set_offset(&mut self, offset: $crate::upos_type) {
self.widget.set_offset(offset)
}
/// Cursor position
#[inline]
pub fn cursor(&self) -> $crate::upos_type {
self.widget.cursor()
}
/// Set the cursor position, reset selection.
#[inline]
pub fn set_cursor(&mut self, cursor: $crate::upos_type, extend_selection: bool) -> bool {
self.widget.set_cursor(cursor, extend_selection)
}
/// Place cursor at some sensible position according to the mask.
#[inline]
pub fn set_default_cursor(&mut self) {
self.widget.set_default_cursor()
}
/// Selection anchor.
#[inline]
pub fn anchor(&self) -> $crate::upos_type {
self.widget.anchor()
}
/// Selection
#[inline]
pub fn has_selection(&self) -> bool {
self.widget.has_selection()
}
/// Selection
#[inline]
pub fn selection(&self) -> std::ops::Range<$crate::upos_type> {
self.widget.selection()
}
/// Selection
#[inline]
pub fn set_selection(&mut self, anchor: $crate::upos_type, cursor: $crate::upos_type) -> bool {
self.widget.set_selection(anchor, cursor)
}
/// Select all text.
#[inline]
pub fn select_all(&mut self) {
self.widget.select_all();
}
/// Selection
#[inline]
pub fn selected_text(&self) -> &str {
self.widget.selected_text()
}
}
};
(EDIT $state:ty) => {
impl $state {
/// Insert a char at the current position.
#[inline]
pub fn insert_char(&mut self, c: char) -> bool {
self.widget.insert_char(c)
}
/// Remove the selected range. The text will be replaced with the default value
/// as defined by the mask.
#[inline]
pub fn delete_range(&mut self, range: std::ops::Range<$crate::upos_type>) -> bool {
self.widget.delete_range(range)
}
/// Remove the selected range. The text will be replaced with the default value
/// as defined by the mask.
#[inline]
pub fn try_delete_range(&mut self, range: std::ops::Range<$crate::upos_type>) -> Result<bool, $crate::TextError> {
self.widget.try_delete_range(range)
}
// Delete the char after the cursor.
#[inline]
pub fn delete_next_char(&mut self) -> bool {
self.widget.delete_next_char()
}
/// Delete the char before the cursor.
#[inline]
pub fn delete_prev_char(&mut self) -> bool {
self.widget.delete_prev_char()
}
}
};
(MOVE $state:ty) => {
impl $state {
/// Move to the next char.
#[inline]
pub fn move_right(&mut self, extend_selection: bool) -> bool {
self.widget.move_right(extend_selection)
}
/// Move to the previous char.
#[inline]
pub fn move_left(&mut self, extend_selection: bool) -> bool {
self.widget.move_left(extend_selection)
}
/// Start of line
#[inline]
pub fn move_to_line_start(&mut self, extend_selection: bool) -> bool {
self.widget.move_to_line_start(extend_selection)
}
/// End of line
#[inline]
pub fn move_to_line_end(&mut self, extend_selection: bool) -> bool {
self.widget.move_to_line_end(extend_selection)
}
}
};
(FOCUS $state:ty) => {
impl rat_focus::HasFocus for $state {
fn build(&self, builder: &mut rat_focus::FocusBuilder) {
builder.leaf_widget(self);
}
#[inline]
fn focus(&self) -> rat_focus::FocusFlag {
self.widget.focus.clone()
}
#[inline]
fn area(&self) -> Rect {
self.widget.area
}
#[inline]
fn navigable(&self) -> rat_focus::Navigation {
self.widget.navigable()
}
}
};
(SCREENCURSOR $state:ty) => {
impl $crate::HasScreenCursor for $state {
/// The current text cursor as an absolute screen position.
#[inline]
fn screen_cursor(&self) -> Option<(u16, u16)> {
self.widget.screen_cursor()
}
}
impl $state {
/// Converts a grapheme based position to a screen position
/// relative to the widget area.
#[inline]
pub fn col_to_screen(&self, pos: $crate::upos_type) -> Option<u16> {
self.widget.col_to_screen(pos)
}
/// Converts from a widget relative screen coordinate to a grapheme index.
/// x is the relative screen position.
#[inline]
pub fn screen_to_col(&self, scx: i16) -> $crate::upos_type {
self.widget.screen_to_col(scx)
}
/// Set the cursor position from a screen position relative to the origin
/// of the widget. This value can be negative, which selects a currently
/// not visible position and scrolls to it.
#[inline]
pub fn set_screen_cursor(&mut self, cursor: i16, extend_selection: bool) -> bool {
self.widget.set_screen_cursor(cursor, extend_selection)
}
}
};
(RELOCATE $state:ty) => {
impl rat_reloc::RelocatableState for $state {
fn relocate(&mut self, shift: (i16, i16), clip: Rect) {
self.area.relocate(shift, clip);
self.inner.relocate(shift, clip);
self.widget.relocate(shift, clip);
}
}
};
}