using NStack; using System; using System.Collections.Generic; using System.Linq; using Terminal.Gui.Graphs; namespace Terminal.Gui { /// /// A consisting of a moveable bar that divides /// the display area into 2 resizeable views. /// public class SplitView : View { private SplitContainerLineView splitterLine; SplitView parentSplitView; /// TODO: Might be able to make Border virtual and override here /// To make this more API friendly /// /// Use this field instead of Border to create an integrated /// Border in which lines connect with subviews and splitters /// seamlessly /// public BorderStyle IntegratedBorder {get;set;} /// /// The showing in the left hand pane of a /// or top of an /// pane. May be another /// if further splitter subdivisions are /// desired (e.g. to create a resizeable grid. /// public View View1 { get; private set; } public int View1MinSize { get; set; } = 1; public ustring View1Title { get; set; } = string.Empty; /// /// The showing in the right hand pane of a /// or bottom of an /// pane. May be another /// if further splitter subdivisions are /// desired (e.g. to create a resizeable grid. /// public View View2 { get; private set; } public int View2MinSize { get; set; } = 1; public ustring View2Title { get; set; } = string.Empty; private Pos splitterDistance = Pos.Percent (50); private Orientation orientation = Orientation.Vertical; /// /// Creates a new instance of the SplitContainer class. /// public SplitView () { splitterLine = new SplitContainerLineView (this); View1 = new View () { Width = Dim.Fill (), Height = Dim.Fill() }; View2 = new View () { Width = Dim.Fill (), Height = Dim.Fill () }; this.Add (View1); this.Add (splitterLine); this.Add (View2); CanFocus = true; } /// /// Invoked when the is changed /// public event SplitterEventHandler SplitterMoved; /// /// Raises the event /// protected virtual void OnSplitterMoved () { SplitterMoved?.Invoke (this, new SplitterEventArgs (this, splitterDistance)); } /// /// Orientation of the dividing line (Horizontal or Vertical). /// public Orientation Orientation { get { return orientation; } set { orientation = value; LayoutSubviews (); } } public override void LayoutSubviews () { var contentArea = Bounds; if(HasBorder()) { // TODO: Bound with Max/Min contentArea = new Rect( contentArea.X + 1, contentArea.Y + 1, Math.Max (0, contentArea.Width - 2), Math.Max (0, contentArea.Height - 2)); } else if(HasAnyTitles() && IsRootSplitContainer()) { // TODO: Bound with Max/Min contentArea = new Rect( contentArea.X, contentArea.Y + 1, contentArea.Width, Math.Max(0,contentArea.Height - 1)); } Setup (contentArea); base.LayoutSubviews (); } /// /// Distance Horizontally or Vertically to the splitter line when /// neither view is collapsed. /// /// Only absolute values (e.g. 10) and percent values (i.e. ) /// are supported for this property. /// public Pos SplitterDistance { get { return splitterDistance; } set { if (!(value is Pos.PosAbsolute) && !(value is Pos.PosFactor)) { throw new ArgumentException ($"Only Percent and Absolute values are supported for {nameof (SplitterDistance)} property. Passed value was {value.GetType ().Name}"); } splitterDistance = value; GetRootSplitContainer ().LayoutSubviews (); OnSplitterMoved (); } } /// public override bool OnEnter (View view) { Driver.SetCursorVisibility (CursorVisibility.Invisible); return base.OnEnter (view); } /// public override void Redraw (Rect bounds) { var childTitles = new List (); Driver.SetAttribute (ColorScheme.Normal); Clear (); base.Redraw (bounds); var lc = new LineCanvas(); var allLines = GetAllChildSplitContainerLineViewRecursively (this); if (IsRootSplitContainer()) { if(HasBorder ()) { lc.AddLine (new Point (0, 0), bounds.Width - 1, Orientation.Horizontal, IntegratedBorder); lc.AddLine (new Point (0, 0), bounds.Height - 1, Orientation.Vertical, IntegratedBorder); lc.AddLine (new Point (bounds.Width - 1, bounds.Height - 1), -bounds.Width + 1, Orientation.Horizontal, IntegratedBorder); lc.AddLine (new Point (bounds.Width - 1, bounds.Height - 1), -bounds.Height + 1, Orientation.Vertical, IntegratedBorder); } foreach (var line in allLines.Where(l=>l.Visible)) { bool isRoot = line == splitterLine; line.ViewToScreen(0,0,out var x1,out var y1); var origin = ScreenToView(x1,y1); var length = line.Orientation == Orientation.Horizontal ? line.Frame.Width - 1 : line.Frame.Height - 1; if(!isRoot) { if(line.Orientation == Orientation.Horizontal) { origin.X -= 1; } else { origin.Y -= 1; } length += 2; childTitles.Add ( new ChildSplitterLine(line)); } lc.AddLine(origin,length,line.Orientation,IntegratedBorder); } } Driver.SetAttribute (ColorScheme.Normal); lc.Draw(this,bounds); // Redraw the lines so that focus/drag symbol renders foreach(var line in allLines) { line.DrawSplitterSymbol (); } foreach(var child in childTitles) { child.DrawTitles (); } // Draw Titles over Border var screen = ViewToScreen (new Rect(0,0,bounds.Width,1)); if (View1.Visible && View1Title.Length > 0) { Driver.SetAttribute (View1.HasFocus ? ColorScheme.HotNormal : ColorScheme.Normal); Driver.DrawWindowTitle (new Rect (screen.X, screen.Y, View1.Frame.Width, 0), View1Title, 0, 0, 0, 0); } if (splitterLine.Visible) { screen = ViewToScreen (splitterLine.Frame); } else { screen.X--; //screen.Y--; } if (Orientation == Orientation.Horizontal) { if (View2.Visible && View2Title?.Length > 0) { Driver.SetAttribute (View2.HasFocus ? ColorScheme.HotNormal : ColorScheme.Normal); Driver.DrawWindowTitle (new Rect (screen.X, screen.Y, View2.Bounds.Width, 1), View2Title, 0, 0, 0, 0); } } else { if (View2.Visible && View2Title?.Length > 0) { Driver.SetAttribute (View2.HasFocus ? ColorScheme.HotNormal : ColorScheme.Normal); Driver.DrawWindowTitle (new Rect (screen.X, screen.Y, View2.Bounds.Width, 1), View2Title, 0, 0, 0, 0); } } } /// /// Converts from a regular /// container to a new nested . If /// is already a then returns false. /// /// After successful splitting, the returned container's /// will contain the original content and (if any) while /// will be empty and available for adding to. /// for adding to. /// The new now showing in /// or the existing one if it was already been converted before. /// if a was converted to a new nested /// . if it was already a nested /// public bool TrySplitView1(out SplitView result) { // when splitting a view into 2 sub views we will need to migrate // the title too var title = View1Title; bool returnValue = TrySplit ( this.View1, (newSplitContainer) => { this.View1 = newSplitContainer; // Move title to new container View1Title = string.Empty; newSplitContainer.View1Title = title; }, out result); return returnValue; } /// /// Converts from a regular /// container to a new nested . If /// is already a then returns false. /// /// After successful splitting, the returned container's /// will contain the original content and (if any) while /// will be empty and available for adding to. /// for adding to. /// The new now showing in /// or the existing one if it was already been converted before. /// if a was converted to a new nested /// . if it was already a nested /// public bool TrySplitView2 (out SplitView result) { // when splitting a view into 2 sub views we will need to migrate // the title too var title = View2Title; bool returnValue = TrySplit ( this.View2, (newSplitContainer) => { this.View2 = newSplitContainer; // Move title to new container View2Title = string.Empty; // Content always goes into View1 of the new container // so that is where the title goes too newSplitContainer.View1Title = title; }, out result); return returnValue; } private bool TrySplit( View toMove, Action newSplitContainerSetter, out SplitView result) { if (toMove is SplitView existing) { result = existing; return false; } var newContainer = new SplitView { Width = Dim.Fill (), Height = Dim.Fill (), parentSplitView = this, }; // Take everything out of the View we are moving var childViews = toMove.Subviews.ToArray(); toMove.RemoveAll (); // Remove the view itself and replace it with the new SplitContainer Remove (toMove); Add (newContainer); newSplitContainerSetter(newContainer); // Add the original content into the first view of the new container foreach(var childView in childViews) { newContainer.View1.Add (childView); } result = newContainer; return true; } private List GetAllChildSplitContainerLineViewRecursively (View v) { var lines = new List(); foreach(var sub in v.Subviews) { if(sub is SplitContainerLineView s) { if(s.Parent.GetRootSplitContainer() == this) { lines.Add (s); } } else { lines.AddRange(GetAllChildSplitContainerLineViewRecursively(sub)); } } return lines; } private bool IsRootSplitContainer () { // TODO: don't want to layout subviews since the parent recursively lays them all out return parentSplitView == null; } private SplitView GetRootSplitContainer () { SplitView root = this; while (root.parentSplitView != null) { root = root.parentSplitView; } return root; } private void Setup (Rect bounds) { splitterLine.Orientation = Orientation; // splitterLine.Text = View2.Title; // TODO: Recursion if (!View1.Visible || !View2.Visible) { View toFullSize = !View1.Visible ? View2 : View1; splitterLine.Visible = false; toFullSize.X = bounds.X; toFullSize.Y = bounds.Y; toFullSize.Width = bounds.Width; toFullSize.Height = bounds.Height; } else { splitterLine.Visible = true; splitterDistance = BoundByMinimumSizes (splitterDistance); View1.X = bounds.X; View1.Y = bounds.Y; switch (Orientation) { case Orientation.Horizontal: splitterLine.X = 0; splitterLine.Y = splitterDistance; splitterLine.Width = Dim.Fill (); splitterLine.Height = 1; splitterLine.LineRune = Driver.HLine; View1.Width = Dim.Fill (HasBorder()? 1:0); View1.Height = new Dim.DimFunc (() => splitterDistance.Anchor (bounds.Height)); View2.Y = Pos.Bottom (splitterLine); View2.X = bounds.X; View2.Width = bounds.Width; View2.Height = Dim.Fill(HasBorder () ? 1 : 0); break; case Orientation.Vertical: splitterLine.X = splitterDistance; splitterLine.Y = 0; splitterLine.Width = 1; splitterLine.Height = Dim.Fill (); splitterLine.LineRune = Driver.VLine; View1.Height = Dim.Fill(); View1.Width = new Dim.DimFunc (() => splitterDistance.Anchor (bounds.Width)); View2.X = Pos.Right (splitterLine); View2.Y = bounds.Y; View2.Height = bounds.Height; View2.Width = Dim.Fill(HasBorder()? 1:0); break; default: throw new ArgumentOutOfRangeException (nameof (orientation)); }; } } /// /// Considers as a candidate for /// then either returns (if valid) or returns adjusted if invalid with respect to the /// of the views. /// /// /// private Pos BoundByMinimumSizes (Pos pos) { // if we are not yet initialized then we don't know // how big we are and therefore cannot sensibly calculate // how big the views will be with a given SplitterDistance if (!IsInitialized) { return pos; } var view1MinSize = View1MinSize; var view2MinSize = View2MinSize; // if there is a border then there is less space // for the views so we need to make size restrictions // tighter. if(HasBorder()) { view1MinSize++; view2MinSize++; } var availableSpace = Orientation == Orientation.Horizontal ? this.Bounds.Height : this.Bounds.Width; // we probably haven't finished layout even if IsInitialized is true :( if(availableSpace <= 0) { return pos; } var idealPosition = pos.Anchor (availableSpace); // bad position because not enough space for View1 if (idealPosition < view1MinSize) { // TODO: we should preserve Absolute/Percent status here not just force it to absolute return (Pos)Math.Min (view1MinSize, availableSpace); } // bad position because not enough space for View2 if (availableSpace - idealPosition <= view2MinSize) { // TODO: we should preserve Absolute/Percent status here not just force it to absolute // +1 is to allow space for the splitter return (Pos)Math.Max (availableSpace - (view2MinSize + 1), 0); } // this splitter position is fine, there is enough space for everyone return pos; } private class SplitContainerLineView : LineView { public SplitView Parent { get; private set; } Point? dragPosition; Pos dragOrignalPos; public Point? moveRuneRenderLocation; public SplitContainerLineView (SplitView parent) { CanFocus = true; TabStop = true; this.Parent = parent; base.AddCommand (Command.Right, () => { return MoveSplitter (1, 0); }); base.AddCommand (Command.Left, () => { return MoveSplitter (-1, 0); }); base.AddCommand (Command.LineUp, () => { return MoveSplitter (0, -1); }); base.AddCommand (Command.LineDown, () => { return MoveSplitter (0, 1); }); AddKeyBinding (Key.CursorRight, Command.Right); AddKeyBinding (Key.CursorLeft, Command.Left); AddKeyBinding (Key.CursorUp, Command.LineUp); AddKeyBinding (Key.CursorDown, Command.LineDown); } public override bool ProcessKey (KeyEvent kb) { if (!CanFocus || !HasFocus) { return base.ProcessKey (kb); } var result = InvokeKeybindings (kb); if (result != null) return (bool)result; return base.ProcessKey (kb); } public override void PositionCursor () { base.PositionCursor (); var location = moveRuneRenderLocation ?? new Point (Bounds.Width / 2, Bounds.Height / 2); Move (location.X, location.Y); } public override bool OnEnter (View view) { Driver.SetCursorVisibility (CursorVisibility.Default); PositionCursor (); return base.OnEnter (view); } public override void Redraw (Rect bounds) { base.Redraw (bounds); DrawSplitterSymbol (); } public void DrawSplitterSymbol() { if (CanFocus && HasFocus) { var location = moveRuneRenderLocation ?? new Point (Bounds.Width / 2, Bounds.Height / 2); AddRune (location.X, location.Y, Driver.Diamond); } } public override bool MouseEvent (MouseEvent mouseEvent) { if (!CanFocus) { return true; } if (!dragPosition.HasValue && (mouseEvent.Flags == MouseFlags.Button1Pressed)) { // Start a Drag SetFocus (); Application.EnsuresTopOnFront (); if (mouseEvent.Flags == MouseFlags.Button1Pressed) { dragPosition = new Point (mouseEvent.X, mouseEvent.Y); dragOrignalPos = Orientation == Orientation.Horizontal ? Y : X; Application.GrabMouse (this); if (Orientation == Orientation.Horizontal) { } else { moveRuneRenderLocation = new Point (0, Math.Max (1, Math.Min (Bounds.Height - 2, mouseEvent.Y))); } } return true; } else if ( dragPosition.HasValue && (mouseEvent.Flags == (MouseFlags.Button1Pressed | MouseFlags.ReportMousePosition))) { // Continue Drag // how far has user dragged from original location? if (Orientation == Orientation.Horizontal) { int dy = mouseEvent.Y - dragPosition.Value.Y; Parent.SplitterDistance = Offset (Y, dy); moveRuneRenderLocation = new Point (mouseEvent.X, 0); } else { int dx = mouseEvent.X - dragPosition.Value.X; Parent.SplitterDistance = Offset (X, dx); moveRuneRenderLocation = new Point (0, Math.Max (1, Math.Min (Bounds.Height - 2, mouseEvent.Y))); } Parent.SetNeedsDisplay (); return true; } if (mouseEvent.Flags.HasFlag (MouseFlags.Button1Released) && dragPosition.HasValue) { // End Drag Application.UngrabMouse (); Driver.UncookMouse (); FinalisePosition ( dragOrignalPos, Orientation == Orientation.Horizontal ? Y : X); dragPosition = null; moveRuneRenderLocation = null; } return false; } private bool MoveSplitter (int distanceX, int distanceY) { if (Orientation == Orientation.Vertical) { // Cannot move in this direction if (distanceX == 0) { return false; } var oldX = X; FinalisePosition (oldX, (Pos)Offset (X, distanceX)); return true; } else { // Cannot move in this direction if (distanceY == 0) { return false; } var oldY = Y; FinalisePosition (oldY, (Pos)Offset (Y, distanceY)); return true; } } private Pos Offset (Pos pos, int delta) { var posAbsolute = pos.Anchor (Orientation == Orientation.Horizontal ? Parent.Bounds.Height : Parent.Bounds.Width); return posAbsolute + delta; } /// /// /// Moves to /// preserving format /// (absolute / relative) that had. /// /// This ensures that if splitter location was e.g. 50% before and you move it /// to absolute 5 then you end up with 10% (assuming a parent had 50 width). /// /// /// private void FinalisePosition (Pos oldValue, Pos newValue) { if (oldValue is Pos.PosFactor) { if (Orientation == Orientation.Horizontal) { Parent.SplitterDistance = ConvertToPosFactor (newValue, Parent.Bounds.Height); } else { Parent.SplitterDistance = ConvertToPosFactor (newValue, Parent.Bounds.Width); } } else { Parent.SplitterDistance = newValue; } } /// /// /// Determines the absolute position of and /// returns a that describes the percentage of that. /// /// Effectively turning any into a /// (as if created with ) /// /// The to convert to /// The Height/Width that lies within /// private Pos ConvertToPosFactor (Pos p, int parentLength) { // calculate position in the 'middle' of the cell at p distance along parentLength float position = p.Anchor (parentLength) + 0.5f; return new Pos.PosFactor (position / parentLength); } } private bool HasBorder () { return IntegratedBorder != BorderStyle.None; } private bool HasAnyTitles() { return View1Title.Length > 0 || View2Title.Length > 0; } private class ChildSplitterLine { readonly SplitContainerLineView currentLine; internal ChildSplitterLine (SplitContainerLineView currentLine) { this.currentLine = currentLine; } internal void DrawTitles () { if(currentLine.Orientation == Orientation.Horizontal) { var screenRect = currentLine.ViewToScreen ( new Rect(0,0,currentLine.Frame.Width,currentLine.Frame.Height)); Driver.DrawWindowTitle (screenRect, currentLine.Parent.View2Title, 0, 0, 0, 0); } } } } /// /// Provides data for events. /// public class SplitterEventArgs : EventArgs { /// /// Creates a new instance of the class. /// /// /// public SplitterEventArgs (SplitView splitContainer, Pos splitterDistance) { SplitterDistance = splitterDistance; SplitContainer = splitContainer; } /// /// New position of the /// public Pos SplitterDistance { get; } /// /// Container (sender) of the event. /// public SplitView SplitContainer { get; } } /// /// Represents a method that will handle splitter events. /// public delegate void SplitterEventHandler (object sender, SplitterEventArgs e); }