using System.Diagnostics;
namespace Terminal.Gui;
///
/// Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete'
/// options.
///
public abstract partial class PopupAutocomplete : AutocompleteBase
{
private bool _closed;
private ColorScheme _colorScheme;
private View _hostControl;
private View _top; // The _hostControl's SuperView
private View _popup;
private int _toRenderLength;
/// Creates a new instance of the class.
public PopupAutocomplete () { PopupInsideContainer = true; }
///
/// The colors to use to render the overlay. Accessing this property before the Application has been initialized
/// will cause an error
///
public override ColorScheme ColorScheme
{
get
{
if (_colorScheme is null)
{
_colorScheme = Colors.ColorSchemes ["Menu"];
}
return _colorScheme;
}
set => _colorScheme = value;
}
/// The host control to handle.
public override View HostControl
{
get => _hostControl;
set
{
if (value == _hostControl)
{
return;
}
_hostControl = value;
if (_hostControl is null)
{
RemovePopupFromTop();
_top.Removed -= _top_Removed;
_top = null;
return;
}
_top = _hostControl.SuperView;
if (_top is { })
{
if (_top.IsInitialized)
{
AddPopupToTop ();
}
else
{
_top.Initialized += _top_Initialized;
}
_top.Removed += _top_Removed;
}
}
}
private void _top_Added (object sender, SuperViewChangedEventArgs e)
{
throw new NotImplementedException ();
}
///
public override void EnsureSelectedIdxIsValid ()
{
base.EnsureSelectedIdxIsValid ();
// if user moved selection up off top of current scroll window
if (SelectedIdx < ScrollOffset)
{
ScrollOffset = SelectedIdx;
}
// if user moved selection down past bottom of current scroll window
while (_toRenderLength > 0 && SelectedIdx >= ScrollOffset + _toRenderLength)
{
ScrollOffset++;
}
}
///
/// Handle mouse events before e.g. to make mouse events like report/click apply to the
/// autocomplete control instead of changing the cursor position in the underlying text view.
///
/// The mouse event.
/// If was called from the popup or from the host.
/// trueif the mouse can be handled falseotherwise.
public override bool OnMouseEvent (MouseEventArgs me, bool fromHost = false)
{
if (fromHost)
{
if (!Visible)
{
return false;
}
// TODO: Revisit this
//GenerateSuggestions ();
if (Visible && Suggestions.Count == 0)
{
Visible = false;
HostControl?.SetNeedsDraw ();
return true;
}
if (!Visible && Suggestions.Count > 0)
{
Visible = true;
HostControl?.SetNeedsDraw ();
Application.UngrabMouse ();
return false;
}
// not in the popup
if (Visible && HostControl is { })
{
Visible = false;
_closed = false;
}
HostControl?.SetNeedsDraw ();
return false;
}
if (_popup is null || Suggestions.Count == 0)
{
//AddPopupToTop ();
//Debug.Fail ("popup is null");
return false;
}
if (me.Flags == MouseFlags.ReportMousePosition)
{
RenderSelectedIdxByMouse (me);
return true;
}
if (me.Flags == MouseFlags.Button1Clicked)
{
SelectedIdx = me.Position.Y - ScrollOffset;
return Select ();
}
if (me.Flags == MouseFlags.WheeledDown)
{
MoveDown ();
return true;
}
if (me.Flags == MouseFlags.WheeledUp)
{
MoveUp ();
return true;
}
return false;
}
///
/// Handle key events before e.g. to make key events like up/down apply to the
/// autocomplete control instead of changing the cursor position in the underlying text view.
///
/// The key event.
/// trueif the key can be handled falseotherwise.
public override bool ProcessKey (Key key)
{
if (SuggestionGenerator.IsWordChar ((Rune)key))
{
Visible = true;
_closed = false;
return false;
}
if (key == Reopen)
{
Context.Canceled = false;
return ReopenSuggestions ();
}
if (_closed || Suggestions.Count == 0)
{
Visible = false;
if (!_closed)
{
Close ();
}
return false;
}
if (key == Key.CursorDown)
{
MoveDown ();
return true;
}
if (key == Key.CursorUp)
{
MoveUp ();
return true;
}
// TODO : Revisit this
/*if (a.ConsoleDriverKey == Key.CursorLeft || a.ConsoleDriverKey == Key.CursorRight) {
GenerateSuggestions (a.ConsoleDriverKey == Key.CursorLeft ? -1 : 1);
if (Suggestions.Count == 0) {
Visible = false;
if (!closed) {
Close ();
}
}
return false;
}*/
if (key == SelectionKey)
{
return Select ();
}
if (key == CloseKey)
{
Close ();
Context.Canceled = true;
return true;
}
return false;
}
/// Renders the autocomplete dialog inside or outside the given at the given point.
///
public override void RenderOverlay (Point renderAt)
{
if (!Context.Canceled && Suggestions.Count > 0 && !Visible && HostControl?.HasFocus == true)
{
ProcessKey (new (Suggestions [0].Title [0]));
}
else if (!Visible || HostControl?.HasFocus == false || Suggestions.Count == 0)
{
LastPopupPos = null;
Visible = false;
if (Suggestions.Count == 0)
{
Context.Canceled = false;
}
return;
}
LastPopupPos = renderAt;
int height, width;
if (PopupInsideContainer)
{
// don't overspill vertically
height = Math.Min (HostControl.Viewport.Height - renderAt.Y, MaxHeight);
// There is no space below, lets see if can popup on top
if (height < Suggestions.Count && HostControl.Viewport.Height - renderAt.Y >= height)
{
// Verifies that the upper limit available is greater than the lower limit
if (renderAt.Y > HostControl.Viewport.Height - renderAt.Y)
{
renderAt.Y = Math.Max (renderAt.Y - Math.Min (Suggestions.Count + 1, MaxHeight + 1), 0);
height = Math.Min (Math.Min (Suggestions.Count, MaxHeight), LastPopupPos.Value.Y - 1);
}
}
}
else
{
// don't overspill vertically
height = Math.Min (Math.Min (_top.Viewport.Height - HostControl.Frame.Bottom, MaxHeight), Suggestions.Count);
// There is no space below, lets see if can popup on top
if (height < Suggestions.Count && HostControl.Frame.Y - _top.Frame.Y >= height)
{
// Verifies that the upper limit available is greater than the lower limit
if (HostControl.Frame.Y > _top.Viewport.Height - HostControl.Frame.Y)
{
renderAt.Y = Math.Max (HostControl.Frame.Y - Math.Min (Suggestions.Count, MaxHeight), 0);
height = Math.Min (Math.Min (Suggestions.Count, MaxHeight), HostControl.Frame.Y);
}
}
else
{
renderAt.Y = HostControl.Frame.Bottom;
}
}
if (ScrollOffset > Suggestions.Count - height)
{
ScrollOffset = 0;
}
Suggestion [] toRender = Suggestions.Skip (ScrollOffset).Take (height).ToArray ();
_toRenderLength = toRender.Length;
if (toRender.Length == 0)
{
return;
}
width = Math.Min (MaxWidth, toRender.Max (s => s.Title.Length));
if (PopupInsideContainer)
{
// don't overspill horizontally, let's see if it can be displayed on the left
if (width > HostControl.Viewport.Width - renderAt.X)
{
// Verifies that the left limit available is greater than the right limit
if (renderAt.X > HostControl.Viewport.Width - renderAt.X)
{
renderAt.X -= Math.Min (width, LastPopupPos.Value.X);
width = Math.Min (width, LastPopupPos.Value.X);
}
else
{
width = Math.Min (width, HostControl.Viewport.Width - renderAt.X);
}
}
}
else
{
// don't overspill horizontally, let's see if it can be displayed on the left
if (width > _top.Viewport.Width - (renderAt.X + HostControl.Frame.X))
{
// Verifies that the left limit available is greater than the right limit
if (renderAt.X + HostControl.Frame.X > _top.Viewport.Width - (renderAt.X + HostControl.Frame.X))
{
renderAt.X -= Math.Min (width, LastPopupPos.Value.X);
width = Math.Min (width, LastPopupPos.Value.X);
}
else
{
width = Math.Min (width, _top.Viewport.Width - renderAt.X);
}
}
}
if (PopupInsideContainer)
{
_popup.Frame = new (
new (HostControl.Frame.X + renderAt.X, HostControl.Frame.Y + renderAt.Y),
new (width, height)
);
}
else
{
_popup.Frame = new (
renderAt with { X = HostControl.Frame.X + renderAt.X },
new (width, height)
);
}
_popup.Move (0, 0);
for (var i = 0; i < toRender.Length; i++)
{
if (i == SelectedIdx - ScrollOffset)
{
_popup.SetAttribute (ColorScheme.Focus);
}
else
{
_popup.SetAttribute (ColorScheme.Normal);
}
_popup.Move (0, i);
string text = TextFormatter.ClipOrPad (toRender [i].Title, width);
Application.Driver?.AddStr (text);
}
}
///
/// When more suggestions are available than can be rendered the user can scroll down the dropdown list. This
/// indicates how far down they have gone
///
public virtual int ScrollOffset { get; set; }
///
/// Closes the Autocomplete context menu if it is showing and
///
protected void Close ()
{
ClearSuggestions ();
Visible = false;
_closed = true;
HostControl?.SetNeedsDraw ();
//RemovePopupFromTop ();
}
/// Deletes the text backwards before insert the selected text in the .
protected abstract void DeleteTextBackwards ();
///
/// Called when the user confirms a selection at the current cursor location in the . The
/// string is the full autocomplete word to be inserted. Typically, a host will have to
/// remove some characters such that the string completes the word instead of simply being
/// appended.
///
///
/// True if the insertion was possible otherwise false
protected virtual bool InsertSelection (Suggestion accepted)
{
SetCursorPosition (Context.CursorPosition + accepted.Remove);
// delete the text
for (var i = 0; i < accepted.Remove; i++)
{
DeleteTextBackwards ();
}
InsertText (accepted.Replacement);
return true;
}
/// Insert the selected text in the .
///
protected abstract void InsertText (string accepted);
/// Moves the selection in the Autocomplete context menu down one
protected void MoveDown ()
{
SelectedIdx++;
if (SelectedIdx > Suggestions.Count - 1)
{
SelectedIdx = 0;
}
EnsureSelectedIdxIsValid ();
HostControl?.SetNeedsDraw ();
}
/// Moves the selection in the Autocomplete context menu up one
protected void MoveUp ()
{
SelectedIdx--;
if (SelectedIdx < 0)
{
SelectedIdx = Suggestions.Count - 1;
}
EnsureSelectedIdxIsValid ();
HostControl?.SetNeedsDraw ();
}
/// Render the current selection in the Autocomplete context menu by the mouse reporting.
///
protected void RenderSelectedIdxByMouse (MouseEventArgs me)
{
if (SelectedIdx != me.Position.Y - ScrollOffset)
{
SelectedIdx = me.Position.Y - ScrollOffset;
if (LastPopupPos is { })
{
RenderOverlay ((Point)LastPopupPos);
}
}
}
/// Reopen the popup after it has been closed.
///
protected bool ReopenSuggestions ()
{
// TODO: Revisit
//GenerateSuggestions ();
if (Suggestions.Count > 0)
{
Visible = true;
_closed = false;
HostControl?.SetNeedsDraw ();
return true;
}
return false;
}
///
/// Completes the autocomplete selection process. Called when user hits the
/// .
///
///
protected bool Select ()
{
if (SelectedIdx >= 0 && SelectedIdx < Suggestions.Count)
{
Suggestion accepted = Suggestions [SelectedIdx];
return InsertSelection (accepted);
}
return false;
}
/// Set the cursor position in the .
///
protected abstract void SetCursorPosition (int column);
#nullable enable
private Point? LastPopupPos { get; set; }
#nullable restore
private void AddPopupToTop ()
{
if (_popup is null)
{
_popup = new Popup (this)
{
CanFocus = false
};
_top?.Add (_popup);
}
}
private void RemovePopupFromTop ()
{
if (_popup is { } && _top.Subviews.Contains (_popup))
{
_top?.Remove (_popup);
_popup.Dispose ();
_popup = null;
}
}
private void _top_Initialized (object sender, EventArgs e)
{
if (_top is null)
{
_top = sender as View;
}
AddPopupToTop ();
}
private void _top_Removed (object sender, SuperViewChangedEventArgs e)
{
Visible = false;
RemovePopupFromTop ();
}
}