//
// TimeField.cs: text entry for time
//
// Author: Jörg Preiß
//
// Licensed under the MIT license
using System;
using System.Globalization;
using System.Linq;
using System.Text;
namespace Terminal.Gui;
///
/// Time editing
///
///
/// The provides time editing functionality with mouse support.
///
public class TimeField : TextField {
TimeSpan _time;
bool _isShort;
int _longFieldLen = 8;
int _shortFieldLen = 5;
string _sepChar;
string _longFormat;
string _shortFormat;
int _fieldLen => _isShort ? _shortFieldLen : _longFieldLen;
string _format => _isShort ? _shortFormat : _longFormat;
///
/// TimeChanged event, raised when the Date has changed.
///
///
/// This event is raised when the changes.
///
///
/// The passed is a containing the old value, new value, and format string.
///
public event EventHandler> TimeChanged;
///
/// Initializes a new instance of using positioning.
///
/// The x coordinate.
/// The y coordinate.
/// Initial time.
/// If true, the seconds are hidden. Sets the property.
public TimeField (int x, int y, TimeSpan time, bool isShort = false) : base (x, y, isShort ? 7 : 10, "")
{
SetInitialProperties (time, isShort);
}
///
/// Initializes a new instance of using positioning.
///
/// Initial time
public TimeField (TimeSpan time) : base (string.Empty)
{
Width = _fieldLen + 2;
SetInitialProperties (time);
}
///
/// Initializes a new instance of using positioning.
///
public TimeField () : this (time: TimeSpan.MinValue) { }
void SetInitialProperties (TimeSpan time, bool isShort = false)
{
CultureInfo cultureInfo = CultureInfo.CurrentCulture;
_sepChar = cultureInfo.DateTimeFormat.TimeSeparator;
_longFormat = $" hh\\{_sepChar}mm\\{_sepChar}ss";
_shortFormat = $" hh\\{_sepChar}mm";
this._isShort = isShort;
Time = time;
CursorPosition = 1;
TextChanging += TextField_TextChanging;
// Things this view knows how to do
AddCommand (Command.DeleteCharRight, () => { DeleteCharRight (); return true; });
AddCommand (Command.DeleteCharLeft, () => { DeleteCharLeft (false); return true; });
AddCommand (Command.LeftHome, () => MoveHome ());
AddCommand (Command.Left, () => MoveLeft ());
AddCommand (Command.RightEnd, () => MoveEnd ());
AddCommand (Command.Right, () => MoveRight ());
// Default keybindings for this view
KeyBindings.Add (KeyCode.Delete, Command.DeleteCharRight);
KeyBindings.Add (Key.D.WithCtrl, Command.DeleteCharRight);
KeyBindings.Add (Key.Backspace, Command.DeleteCharLeft);
KeyBindings.Add (Key.D.WithAlt, Command.DeleteCharLeft);
KeyBindings.Add (Key.Home, Command.LeftHome);
KeyBindings.Add (Key.A.WithCtrl, Command.LeftHome);
KeyBindings.Add (Key.CursorLeft, Command.Left);
KeyBindings.Add (Key.B.WithCtrl, Command.Left);
KeyBindings.Add (Key.End, Command.RightEnd);
KeyBindings.Add (Key.E.WithCtrl, Command.RightEnd);
KeyBindings.Add (Key.CursorRight, Command.Right);
KeyBindings.Add (Key.F.WithCtrl, Command.Right);
}
void TextField_TextChanging (object sender, TextChangingEventArgs e)
{
try {
int spaces = 0;
for (int i = 0; i < e.NewText.Length; i++) {
if (e.NewText [i] == ' ') {
spaces++;
} else {
break;
}
}
spaces += _fieldLen;
string trimedText = e.NewText [..spaces];
spaces -= _fieldLen;
trimedText = trimedText.Replace (new string (' ', spaces), " ");
if (trimedText != e.NewText) {
e.NewText = trimedText;
}
if (!TimeSpan.TryParseExact (e.NewText.Trim (), _format.Trim (), CultureInfo.CurrentCulture, TimeSpanStyles.None, out TimeSpan result)) {
e.Cancel = true;
}
AdjCursorPosition (CursorPosition, true);
} catch (Exception) {
e.Cancel = true;
}
}
///
/// Gets or sets the time of the .
///
///
///
public TimeSpan Time {
get {
return _time;
}
set {
if (ReadOnly)
return;
var oldTime = _time;
_time = value;
this.Text = " " + value.ToString (_format.Trim ());
var args = new DateTimeEventArgs (oldTime, value, _format);
if (oldTime != value) {
OnTimeChanged (args);
}
}
}
///
/// Get or sets whether uses the short or long time format.
///
public bool IsShortFormat {
get => _isShort;
set {
_isShort = value;
if (_isShort)
Width = 7;
else
Width = 10;
var ro = ReadOnly;
if (ro)
ReadOnly = false;
SetText (Text);
ReadOnly = ro;
SetNeedsDisplay ();
}
}
///
public override int CursorPosition {
get => base.CursorPosition;
set {
base.CursorPosition = Math.Max (Math.Min (value, _fieldLen), 1);
}
}
bool SetText (Rune key)
{
var text = Text.EnumerateRunes ().ToList ();
var newText = text.GetRange (0, CursorPosition);
newText.Add (key);
if (CursorPosition < _fieldLen)
newText = [.. newText, .. text.GetRange (CursorPosition + 1, text.Count - (CursorPosition + 1))];
return SetText (StringExtensions.ToString (newText));
}
bool SetText (string text)
{
if (string.IsNullOrEmpty (text)) {
return false;
}
text = NormalizeFormat (text);
string [] vals = text.Split (_sepChar);
bool isValidTime = true;
int hour = Int32.Parse (vals [0]);
int minute = Int32.Parse (vals [1]);
int second = _isShort ? 0 : vals.Length > 2 ? Int32.Parse (vals [2]) : 0;
if (hour < 0) {
isValidTime = false;
hour = 0;
vals [0] = "0";
} else if (hour > 23) {
isValidTime = false;
hour = 23;
vals [0] = "23";
}
if (minute < 0) {
isValidTime = false;
minute = 0;
vals [1] = "0";
} else if (minute > 59) {
isValidTime = false;
minute = 59;
vals [1] = "59";
}
if (second < 0) {
isValidTime = false;
second = 0;
vals [2] = "0";
} else if (second > 59) {
isValidTime = false;
second = 59;
vals [2] = "59";
}
string t = _isShort ? $" {hour,2:00}{_sepChar}{minute,2:00}" : $" {hour,2:00}{_sepChar}{minute,2:00}{_sepChar}{second,2:00}";
if (!TimeSpan.TryParseExact (t.Trim (), _format.Trim (), CultureInfo.CurrentCulture, TimeSpanStyles.None, out TimeSpan result) ||
!isValidTime) {
return false;
}
Time = result;
return true;
}
string NormalizeFormat (string text, string fmt = null, string sepChar = null)
{
if (string.IsNullOrEmpty (fmt)) {
fmt = _format;
}
fmt = fmt.Replace ("\\", "");
if (string.IsNullOrEmpty (sepChar)) {
sepChar = _sepChar;
}
if (fmt.Length != text.Length) {
return text;
}
var fmtText = text.ToCharArray ();
for (int i = 0; i < text.Length; i++) {
var c = fmt [i];
if (c.ToString () == sepChar && text [i].ToString () != sepChar) {
fmtText [i] = c;
}
}
return new string (fmtText);
}
void IncCursorPosition ()
{
if (CursorPosition >= _fieldLen) {
CursorPosition = _fieldLen;
return;
}
CursorPosition++;
AdjCursorPosition (CursorPosition);
}
void DecCursorPosition ()
{
if (CursorPosition <= 1) {
CursorPosition = 1;
return;
}
CursorPosition--;
AdjCursorPosition (CursorPosition, false);
}
void AdjCursorPosition (int point, bool increment = true)
{
var newPoint = point;
if (point > _fieldLen) {
newPoint = _fieldLen;
}
if (point < 1) {
newPoint = 1;
}
if (newPoint != point) {
CursorPosition = newPoint;
}
while (Text [CursorPosition] == _sepChar [0]) {
if (increment) {
CursorPosition++;
} else {
CursorPosition--;
}
}
}
///
public override bool OnProcessKeyDown (Key a)
{
// Ignore non-numeric characters.
if (a.KeyCode is >= (KeyCode)(int)KeyCode.D0 and <= (KeyCode)(int)KeyCode.D9) {
if (!ReadOnly) {
if (SetText ((Rune)a)) {
IncCursorPosition ();
}
}
return true;
}
return false;
}
bool MoveRight ()
{
ClearAllSelection ();
IncCursorPosition ();
return true;
}
new bool MoveEnd ()
{
ClearAllSelection ();
CursorPosition = _fieldLen;
return true;
}
bool MoveLeft ()
{
ClearAllSelection ();
DecCursorPosition ();
return true;
}
bool MoveHome ()
{
// Home, C-A
ClearAllSelection ();
CursorPosition = 1;
return true;
}
///
public override void DeleteCharLeft (bool useOldCursorPos = true)
{
if (ReadOnly) {
return;
}
ClearAllSelection ();
SetText ((Rune)'0');
DecCursorPosition ();
return;
}
///
public override void DeleteCharRight ()
{
if (ReadOnly) {
return;
}
ClearAllSelection ();
SetText ((Rune)'0');
return;
}
///
public override bool MouseEvent (MouseEvent ev)
{
var result = base.MouseEvent (ev);
if (result && SelectedLength == 0 && ev.Flags.HasFlag (MouseFlags.Button1Pressed)) {
int point = ev.X;
AdjCursorPosition (point, true);
}
return result;
}
///
/// Event firing method that invokes the event.
///
/// The event arguments
public virtual void OnTimeChanged (DateTimeEventArgs args)
{
TimeChanged?.Invoke (this, args);
}
}