-
Notifications
You must be signed in to change notification settings - Fork 673
/
TextValidateField.cs
653 lines (562 loc) · 15.1 KB
/
TextValidateField.cs
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
//
// TextValidateField.cs: single-line text editor with validation through providers.
//
// Authors:
// José Miguel Perricone (jmperricone@hotmail.com)
//
using NStack;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Text.RegularExpressions;
using Terminal.Gui.TextValidateProviders;
namespace Terminal.Gui {
namespace TextValidateProviders {
/// <summary>
/// TextValidateField Providers Interface.
/// All TextValidateField are created with a ITextValidateProvider.
/// </summary>
public interface ITextValidateProvider {
/// <summary>
/// Set that this provider uses a fixed width.
/// e.g. Masked ones are fixed.
/// </summary>
bool Fixed { get; }
/// <summary>
/// Set Cursor position to <paramref name="pos"/>.
/// </summary>
/// <param name="pos"></param>
/// <returns>Return first valid position.</returns>
int Cursor (int pos);
/// <summary>
/// First valid position before <paramref name="pos"/>.
/// </summary>
/// <param name="pos"></param>
/// <returns>New cursor position if any, otherwise returns <paramref name="pos"/></returns>
int CursorLeft (int pos);
/// <summary>
/// First valid position after <paramref name="pos"/>.
/// </summary>
/// <param name="pos">Current position.</param>
/// <returns>New cursor position if any, otherwise returns <paramref name="pos"/></returns>
int CursorRight (int pos);
/// <summary>
/// Find the first valid character position.
/// </summary>
/// <returns>New cursor position.</returns>
int CursorStart ();
/// <summary>
/// Find the last valid character position.
/// </summary>
/// <returns>New cursor position.</returns>
int CursorEnd ();
/// <summary>
/// Deletes the current character in <paramref name="pos"/>.
/// </summary>
/// <param name="pos"></param>
/// <returns>true if the character was successfully removed, otherwise false.</returns>
bool Delete (int pos);
/// <summary>
/// Insert character <paramref name="ch"/> in position <paramref name="pos"/>.
/// </summary>
/// <param name="ch"></param>
/// <param name="pos"></param>
/// <returns>true if the character was successfully inserted, otherwise false.</returns>
bool InsertAt (char ch, int pos);
/// <summary>
/// True if the input is valid, otherwise false.
/// </summary>
bool IsValid { get; }
/// <summary>
/// Set the input text and get the current value.
/// </summary>
ustring Text { get; set; }
/// <summary>
/// Gets the formatted string for display.
/// </summary>
ustring DisplayText { get; }
}
//////////////////////////////////////////////////////////////////////////////
// PROVIDERS
//////////////////////////////////////////////////////////////////////////////
#region NetMaskedTextProvider
/// <summary>
/// .Net MaskedTextProvider Provider for TextValidateField.
/// <para></para>
/// <para><a href="https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.maskedtextprovider?view=net-5.0">Wrapper around MaskedTextProvider</a></para>
/// <para><a href="https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.maskedtextbox.mask?view=net-5.0">Masking elements</a></para>
/// </summary>
public class NetMaskedTextProvider : ITextValidateProvider {
MaskedTextProvider provider;
/// <summary>
/// Empty Constructor
/// </summary>
public NetMaskedTextProvider (string mask)
{
Mask = mask;
}
/// <summary>
/// Mask property
/// </summary>
public ustring Mask {
get {
return provider?.Mask;
}
set {
var current = provider != null ? provider.ToString (false, false) : string.Empty;
provider = new MaskedTextProvider (value == ustring.Empty ? "&&&&&&" : value.ToString ());
if (string.IsNullOrEmpty (current) == false) {
provider.Set (current);
}
}
}
///<inheritdoc/>
public ustring Text {
get {
return provider.ToString ();
}
set {
provider.Set (value.ToString ());
}
}
///<inheritdoc/>
public bool IsValid => provider.MaskCompleted;
///<inheritdoc/>
public bool Fixed => true;
///<inheritdoc/>
public ustring DisplayText => provider.ToDisplayString ();
///<inheritdoc/>
public int Cursor (int pos)
{
if (pos < 0) {
return CursorStart ();
} else if (pos > provider.Length) {
return CursorEnd ();
} else {
var p = provider.FindEditPositionFrom (pos, false);
if (p == -1) p = provider.FindEditPositionFrom (pos, true);
return p;
}
}
///<inheritdoc/>
public int CursorStart ()
{
return
provider.IsEditPosition (0)
? 0
: provider.FindEditPositionFrom (0, true);
}
///<inheritdoc/>
public int CursorEnd ()
{
return
provider.IsEditPosition (provider.Length - 1)
? provider.Length - 1
: provider.FindEditPositionFrom (provider.Length, false);
}
///<inheritdoc/>
public int CursorLeft (int pos)
{
var c = provider.FindEditPositionFrom (pos - 1, false);
return c == -1 ? pos : c;
}
///<inheritdoc/>
public int CursorRight (int pos)
{
var c = provider.FindEditPositionFrom (pos + 1, true);
return c == -1 ? pos : c;
}
///<inheritdoc/>
public bool Delete (int pos)
{
return provider.Replace (' ', pos);// .RemoveAt (pos);
}
///<inheritdoc/>
public bool InsertAt (char ch, int pos)
{
return provider.Replace (ch, pos);
}
}
#endregion
#region TextRegexProvider
/// <summary>
/// Regex Provider for TextValidateField.
/// </summary>
public class TextRegexProvider : ITextValidateProvider {
Regex regex;
List<Rune> text;
List<Rune> pattern;
/// <summary>
/// Empty Constructor.
/// </summary>
public TextRegexProvider (string pattern)
{
Pattern = pattern;
}
/// <summary>
/// Regex pattern property.
/// </summary>
public ustring Pattern {
get {
return ustring.Make (pattern);
}
set {
pattern = value.ToRuneList ();
CompileMask ();
SetupText ();
}
}
///<inheritdoc/>
public ustring Text {
get {
return ustring.Make (text);
}
set {
text = value != ustring.Empty ? value.ToRuneList () : null;
SetupText ();
}
}
///<inheritdoc/>
public ustring DisplayText => Text;
///<inheritdoc/>
public bool IsValid {
get {
return Validate (text);
}
}
///<inheritdoc/>
public bool Fixed => false;
/// <summary>
/// When true, validates with the regex pattern on each input, preventing the input if it's not valid.
/// </summary>
public bool ValidateOnInput { get; set; } = true;
bool Validate (List<Rune> text)
{
var match = regex.Match (ustring.Make (text).ToString ());
return match.Success;
}
///<inheritdoc/>
public int Cursor (int pos)
{
if (pos < 0) {
return CursorStart ();
} else if (pos >= text.Count) {
return CursorEnd ();
} else {
return pos;
}
}
///<inheritdoc/>
public int CursorStart ()
{
return 0;
}
///<inheritdoc/>
public int CursorEnd ()
{
return text.Count;
}
///<inheritdoc/>
public int CursorLeft (int pos)
{
if (pos > 0) {
return pos - 1;
}
return pos;
}
///<inheritdoc/>
public int CursorRight (int pos)
{
if (pos < text.Count) {
return pos + 1;
}
return pos;
}
///<inheritdoc/>
public bool Delete (int pos)
{
if (text.Count > 0 && pos < text.Count) {
text.RemoveAt (pos);
}
return true;
}
///<inheritdoc/>
public bool InsertAt (char ch, int pos)
{
var aux = text.ToList ();
aux.Insert (pos, ch);
if (Validate (aux) || ValidateOnInput == false) {
text.Insert (pos, ch);
return true;
}
return false;
}
void SetupText ()
{
if (text != null && IsValid) {
return;
}
text = new List<Rune> ();
}
/// <summary>
/// Compiles the regex pattern for validation./>
/// </summary>
private void CompileMask ()
{
regex = new Regex (ustring.Make (pattern).ToString (), RegexOptions.Compiled);
}
}
#endregion
}
/// <summary>
/// Text field that validates input through a <see cref="ITextValidateProvider"/>
/// </summary>
public class TextValidateField : View {
ITextValidateProvider provider;
int cursorPosition = 0;
/// <summary>
/// Initializes a new instance of the <see cref="TextValidateField"/> class using <see cref="LayoutStyle.Computed"/> positioning.
/// </summary>
public TextValidateField () : this (null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="TextValidateField"/> class using <see cref="LayoutStyle.Computed"/> positioning.
/// </summary>
public TextValidateField (ITextValidateProvider provider)
{
if (provider != null) {
Provider = provider;
}
Initialize ();
}
void Initialize ()
{
Height = 1;
CanFocus = true;
// Things this view knows how to do
AddCommand (Command.LeftHome, () => { HomeKeyHandler (); return true; });
AddCommand (Command.RightEnd, () => { EndKeyHandler (); return true; });
AddCommand (Command.DeleteCharRight, () => { DeleteKeyHandler (); return true; });
AddCommand (Command.DeleteCharLeft, () => { BackspaceKeyHandler (); return true; });
AddCommand (Command.Left, () => { CursorLeft (); return true; });
AddCommand (Command.Right, () => { CursorRight (); return true; });
// Default keybindings for this view
AddKeyBinding (Key.Home, Command.LeftHome);
AddKeyBinding (Key.End, Command.RightEnd);
AddKeyBinding (Key.Delete, Command.DeleteCharRight);
AddKeyBinding (Key.DeleteChar, Command.DeleteCharRight);
AddKeyBinding (Key.Backspace, Command.DeleteCharLeft);
AddKeyBinding (Key.CursorLeft, Command.Left);
AddKeyBinding (Key.CursorRight, Command.Right);
}
/// <summary>
/// Provider
/// </summary>
public ITextValidateProvider Provider {
get => provider;
set {
provider = value;
if (provider.Fixed == true) {
this.Width = provider.DisplayText == ustring.Empty ? 10 : Text.Length;
}
HomeKeyHandler ();
SetNeedsDisplay ();
}
}
///<inheritdoc/>
public override bool MouseEvent (MouseEvent mouseEvent)
{
if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed)) {
var c = provider.Cursor (mouseEvent.X - GetMargins (Frame.Width).left);
if (provider.Fixed == false && TextAlignment == TextAlignment.Right && Text.Length > 0) {
c += 1;
}
cursorPosition = c;
SetFocus ();
SetNeedsDisplay ();
return true;
}
return false;
}
/// <summary>
/// Text
/// </summary>
public new ustring Text {
get {
if (provider == null) {
return ustring.Empty;
}
return provider.Text;
}
set {
if (provider == null) {
return;
}
provider.Text = value;
SetNeedsDisplay ();
}
}
///<inheritdoc/>
public override void PositionCursor ()
{
var (left, _) = GetMargins (Frame.Width);
// Fixed = true, is for inputs thar have fixed width, like masked ones.
// Fixed = false, is for normal input.
// When it's right-aligned and it's a normal input, the cursor behaves differently.
if (provider?.Fixed == false && TextAlignment == TextAlignment.Right) {
Move (cursorPosition + left - 1, 0);
} else {
Move (cursorPosition + left, 0);
}
}
/// <summary>
/// Margins for text alignment.
/// </summary>
/// <param name="width">Total width</param>
/// <returns>Left and right margins</returns>
(int left, int right) GetMargins (int width)
{
var count = Text.Length;
var total = width - count;
switch (TextAlignment) {
case TextAlignment.Left:
return (0, total);
case TextAlignment.Centered:
return (total / 2, (total / 2) + (total % 2));
case TextAlignment.Right:
return (total, 0);
default:
return (0, total);
}
}
///<inheritdoc/>
public override void Redraw (Rect bounds)
{
if (provider == null) {
Move (0, 0);
Driver.AddStr ("Error: ITextValidateProvider not set!");
return;
}
var bgcolor = !IsValid ? Color.BrightRed : ColorScheme.Focus.Background;
var textColor = new Attribute (ColorScheme.Focus.Foreground, bgcolor);
var (margin_left, margin_right) = GetMargins (bounds.Width);
Move (0, 0);
// Left Margin
Driver.SetAttribute (textColor);
for (int i = 0; i < margin_left; i++) {
Driver.AddRune (' ');
}
// Content
Driver.SetAttribute (textColor);
// Content
for (int i = 0; i < provider.DisplayText.Length; i++) {
Driver.AddRune (provider.DisplayText [i]);
}
// Right Margin
Driver.SetAttribute (textColor);
for (int i = 0; i < margin_right; i++) {
Driver.AddRune (' ');
}
}
/// <summary>
/// Try to move the cursor to the left.
/// </summary>
/// <returns>True if moved.</returns>
bool CursorLeft ()
{
var current = cursorPosition;
cursorPosition = provider.CursorLeft (cursorPosition);
SetNeedsDisplay ();
return current != cursorPosition;
}
/// <summary>
/// Try to move the cursor to the right.
/// </summary>
/// <returns>True if moved.</returns>
bool CursorRight ()
{
var current = cursorPosition;
cursorPosition = provider.CursorRight (cursorPosition);
SetNeedsDisplay ();
return current != cursorPosition;
}
/// <summary>
/// Delete char at cursor position - 1, moving the cursor.
/// </summary>
/// <returns></returns>
bool BackspaceKeyHandler ()
{
if (provider.Fixed == false && TextAlignment == TextAlignment.Right && cursorPosition <= 1) {
return false;
}
cursorPosition = provider.CursorLeft (cursorPosition);
provider.Delete (cursorPosition);
SetNeedsDisplay ();
return true;
}
/// <summary>
/// Deletes char at current position.
/// </summary>
/// <returns></returns>
bool DeleteKeyHandler ()
{
if (provider.Fixed == false && TextAlignment == TextAlignment.Right) {
cursorPosition = provider.CursorLeft (cursorPosition);
}
provider.Delete (cursorPosition);
SetNeedsDisplay ();
return true;
}
/// <summary>
/// Moves the cursor to first char.
/// </summary>
/// <returns></returns>
bool HomeKeyHandler ()
{
cursorPosition = provider.CursorStart ();
SetNeedsDisplay ();
return true;
}
/// <summary>
/// Moves the cursor to the last char.
/// </summary>
/// <returns></returns>
bool EndKeyHandler ()
{
cursorPosition = provider.CursorEnd ();
SetNeedsDisplay ();
return true;
}
///<inheritdoc/>
public override bool ProcessKey (KeyEvent kb)
{
if (provider == null) {
return false;
}
var result = InvokeKeybindings (kb);
if (result != null)
return (bool)result;
if (kb.Key < Key.Space || kb.Key > Key.CharMask)
return false;
var key = new Rune ((uint)kb.KeyValue);
var inserted = provider.InsertAt ((char)key, cursorPosition);
if (inserted) {
CursorRight ();
}
return true;
}
/// <summary>
/// This property returns true if the input is valid.
/// </summary>
public virtual bool IsValid {
get {
if (provider == null) {
return false;
}
return provider.IsValid;
}
}
}
}