#nullable enable
using System.Diagnostics;
using Microsoft.CodeAnalysis;
namespace Terminal.Gui;
public partial class View // Layout APIs
{
#region Frame/Position/Dimension
///
/// Indicates whether the specified SuperView-relative coordinates are within the View's .
///
/// SuperView-relative coordinate
/// if the specified SuperView-relative coordinates are within the View.
public virtual bool Contains (in Point location) { return Frame.Contains (location); }
private Rectangle? _frame;
/// Gets or sets the absolute location and dimension of the view.
///
/// The rectangle describing absolute location and dimension of the view, in coordinates relative to the
/// 's Content, which is bound by .
///
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// Frame is relative to the 's Content, which is bound by
/// .
///
///
/// Setting Frame will set , , , and to absoulte values.
///
///
/// Changing this property will result in and to be set, resulting in the
/// view being laid out and redrawn as appropriate in the next iteration of the .
///
///
public Rectangle Frame
{
get
{
if (_needsLayout)
{
//Debug.WriteLine("Frame_get with _layoutNeeded");
}
return _frame ?? Rectangle.Empty;
}
set
{
// This will set _frame, call SetsNeedsLayout, and raise OnViewportChanged/ViewportChanged
if (SetFrame (value with { Width = Math.Max (value.Width, 0), Height = Math.Max (value.Height, 0) }))
{
// If Frame gets set, set all Pos/Dim to Absolute values.
_x = _frame!.Value.X;
_y = _frame!.Value.Y;
_width = _frame!.Value.Width;
_height = _frame!.Value.Height;
// Implicit layout is ok here because we are setting the Frame directly.
Layout ();
}
}
}
///
/// INTERNAL API - Sets _frame, calls SetsNeedsLayout, and raises OnViewportChanged/ViewportChanged
///
///
/// if the frame was changed.
private bool SetFrame (in Rectangle frame)
{
if (_frame == frame)
{
return false;
}
var oldViewport = Rectangle.Empty;
if (IsInitialized)
{
oldViewport = Viewport;
}
// This is the only place where _frame should be set directly. Use Frame = or SetFrame instead.
_frame = frame;
SetAdornmentFrames ();
SetNeedsDraw ();
SetNeedsLayout ();
// BUGBUG: When SetFrame is called from Frame_set, this event gets raised BEFORE OnResizeNeeded. Is that OK?
OnViewportChanged (new (IsInitialized ? Viewport : Rectangle.Empty, oldViewport));
return true;
}
/// Gets the with a screen-relative location.
/// The location and size of the view in screen-relative coordinates.
public virtual Rectangle FrameToScreen ()
{
Rectangle screen = Frame;
View? current = SuperView;
while (current is { })
{
if (current is Adornment adornment)
{
// Adornments don't have SuperViews; use Adornment.FrameToScreen override
// which will give us the screen coordinates of the parent
Rectangle parentScreen = adornment.FrameToScreen ();
// Now add our Frame location
parentScreen.Offset (screen.X, screen.Y);
return parentScreen with { Size = Frame.Size };
}
Point viewportOffset = current.GetViewportOffsetFromFrame ();
viewportOffset.Offset (current.Frame.X - current.Viewport.X, current.Frame.Y - current.Viewport.Y);
screen.X += viewportOffset.X;
screen.Y += viewportOffset.Y;
current = current.SuperView;
}
return screen;
}
///
/// Converts a screen-relative coordinate to a Frame-relative coordinate. Frame-relative means relative to the
/// View's 's .
///
/// The coordinate relative to the 's .
/// Screen-relative coordinate.
public virtual Point ScreenToFrame (in Point location)
{
if (SuperView is null)
{
return new (location.X - Frame.X, location.Y - Frame.Y);
}
Point superViewViewportOffset = SuperView.GetViewportOffsetFromFrame ();
superViewViewportOffset.Offset (-SuperView.Viewport.X, -SuperView.Viewport.Y);
Point frame = location;
frame.Offset (-superViewViewportOffset.X, -superViewViewportOffset.Y);
frame = SuperView.ScreenToFrame (frame);
frame.Offset (-Frame.X, -Frame.Y);
return frame;
}
// helper for X, Y, Width, Height setters to ensure consistency
private void PosDimSet ()
{
SetNeedsLayout ();
if (_x is PosAbsolute && _y is PosAbsolute && _width is DimAbsolute && _height is DimAbsolute)
{
// Implicit layout is ok here because all Pos/Dim are Absolute values.
Layout ();
if (SuperView is { } || this is Adornment { Parent: null })
{
// Ensure the next Application iteration tries to layout again
SetNeedsLayout ();
}
}
}
private Pos _x = Pos.Absolute (0);
/// Gets or sets the X position for the view (the column).
/// The object representing the X position.
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// The position is relative to the 's Content, which is bound by
/// .
///
///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has been
/// laid out (e.g. has been called).
///
///
/// Changing this property will result in and to be set, resulting in the
/// view being laid out and redrawn as appropriate in the next iteration of the .
///
///
/// Changing this property will cause to be updated.
///
/// The default value is Pos.At (0).
///
public Pos X
{
get => VerifyIsInitialized (_x, nameof (X));
set
{
if (Equals (_x, value))
{
return;
}
_x = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (X)} cannot be null");
PosDimSet ();
}
}
private Pos _y = Pos.Absolute (0);
/// Gets or sets the Y position for the view (the row).
/// The object representing the Y position.
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// The position is relative to the 's Content, which is bound by
/// .
///
///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has been
/// laid out (e.g. has been called).
///
///
/// Changing this property will result in and to be set, resulting in the
/// view being laid out and redrawn as appropriate in the next iteration of the .
///
///
/// Changing this property will cause to be updated.
///
/// The default value is Pos.At (0).
///
public Pos Y
{
get => VerifyIsInitialized (_y, nameof (Y));
set
{
if (Equals (_y, value))
{
return;
}
_y = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Y)} cannot be null");
PosDimSet ();
}
}
private Dim? _height = Dim.Absolute (0);
/// Gets or sets the height dimension of the view.
/// The object representing the height of the view (the number of rows).
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// The dimension is relative to the 's Content, which is bound by
/// .
///
///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has been
/// laid out (e.g. has been called).
///
///
/// Changing this property will result in and to be set, resulting in the
/// view being laid out and redrawn as appropriate in the next iteration of the .
///
///
/// Changing this property will cause to be updated.
///
/// The default value is Dim.Sized (0).
///
public Dim? Height
{
get => VerifyIsInitialized (_height, nameof (Height));
set
{
if (Equals (_height, value))
{
return;
}
_height = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Height)} cannot be null");
// Reset TextFormatter - Will be recalculated in SetTextFormatterSize
TextFormatter.ConstrainToHeight = null;
PosDimSet ();
}
}
private Dim? _width = Dim.Absolute (0);
/// Gets or sets the width dimension of the view.
/// The object representing the width of the view (the number of columns).
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// The dimension is relative to the 's Content, which is bound by
///
/// .
///
///
/// If set to a relative value (e.g. ) the value is indeterminate until the view has been
/// laid out (e.g. has been called).
///
///
/// Changing this property will result in and to be set, resulting in the
/// view being laid out and redrawn as appropriate in the next iteration of the .
///
///
/// Changing this property will cause to be updated.
///
/// The default value is Dim.Sized (0).
///
public Dim? Width
{
get => VerifyIsInitialized (_width, nameof (Width));
set
{
if (Equals (_width, value))
{
return;
}
_width = value ?? throw new ArgumentNullException (nameof (value), @$"{nameof (Width)} cannot be null");
// Reset TextFormatter - Will be recalculated in SetTextFormatterSize
TextFormatter.ConstrainToWidth = null;
PosDimSet ();
}
}
#endregion Frame/Position/Dimension
#region Core Layout API
///
/// Performs layout of the view and its subviews within the specified content size.
///
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// This method is intended to be called by the layout engine to
/// prepare the view for layout and is exposed as a public API primarily for testing purposes.
///
///
///
/// If the view could not be laid out (typically because a dependencies was not ready).
public bool Layout (Size contentSize)
{
if (SetRelativeLayout (contentSize))
{
LayoutSubviews ();
// Debug.Assert(!NeedsLayout);
return true;
}
return false;
}
///
/// Performs layout of the view and its subviews using the content size of either the or .
///
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// This method is intended to be called by the layout engine to
/// prepare the view for layout and is exposed as a public API primarily for testing purposes.
///
///
/// If the view could not be laid out (typically because dependency was not ready).
public bool Layout ()
{
return Layout (GetContainerSize ());
}
///
/// Sets the position and size of this view, relative to the SuperView's ContentSize (nominally the same as
/// this.SuperView.GetContentSize ()) based on the values of , , ,
/// and .
///
///
///
/// If , , , or are
/// absolute, they will be updated to reflect the new size and position of the view. Otherwise, they
/// are left unchanged.
///
///
/// This method does not arrange subviews or adornments. It is intended to be called by the layout engine to
/// prepare the view for layout and is exposed as a public API primarily for testing purposes.
///
///
/// Some subviews may have SetRelativeLayout called on them as a side effect, particularly in DimAuto scenarios.
///
///
///
/// The size of the SuperView's content (nominally the same as this.SuperView.GetContentSize ()).
///
/// if successful. means a dependent View still needs layout.
public bool SetRelativeLayout (Size superviewContentSize)
{
Debug.Assert (_x is { });
Debug.Assert (_y is { });
Debug.Assert (_width is { });
Debug.Assert (_height is { });
CheckDimAuto ();
// TODO: Should move to View.LayoutSubviews?
SetTextFormatterSize ();
int newX, newW, newY, newH;
try
{
// Calculate the new X, Y, Width, and Height
// If the Width or Height is Dim.Auto, calculate the Width or Height first. Otherwise, calculate the X or Y first.
if (_width.Has (out _))
{
newW = _width.Calculate (0, superviewContentSize.Width, this, Dimension.Width);
newX = _x.Calculate (superviewContentSize.Width, newW, this, Dimension.Width);
if (newW != Frame.Width)
{
// Pos.Calculate gave us a new position. We need to redo dimension
newW = _width.Calculate (newX, superviewContentSize.Width, this, Dimension.Width);
}
}
else
{
newX = _x.Calculate (superviewContentSize.Width, _width, this, Dimension.Width);
newW = _width.Calculate (newX, superviewContentSize.Width, this, Dimension.Width);
}
if (_height.Has (out _))
{
newH = _height.Calculate (0, superviewContentSize.Height, this, Dimension.Height);
newY = _y.Calculate (superviewContentSize.Height, newH, this, Dimension.Height);
if (newH != Frame.Height)
{
// Pos.Calculate gave us a new position. We need to redo dimension
newH = _height.Calculate (newY, superviewContentSize.Height, this, Dimension.Height);
}
}
else
{
newY = _y.Calculate (superviewContentSize.Height, _height, this, Dimension.Height);
newH = _height.Calculate (newY, superviewContentSize.Height, this, Dimension.Height);
}
}
catch (LayoutException le)
{
//Debug.WriteLine ($"A Dim/PosFunc function threw (typically this is because a dependent View was not laid out)\n{le}.");
return false;
}
Rectangle newFrame = new (newX, newY, newW, newH);
if (Frame != newFrame)
{
// Set the frame. Do NOT use `Frame` as it overwrites X, Y, Width, and Height
// This will set _frame, call SetsNeedsLayout, and raise OnViewportChanged/ViewportChanged
SetFrame (newFrame);
if (_x is PosAbsolute)
{
_x = Frame.X;
}
if (_y is PosAbsolute)
{
_y = Frame.Y;
}
if (_width is DimAbsolute)
{
_width = Frame.Width;
}
if (_height is DimAbsolute)
{
_height = Frame.Height;
}
if (!string.IsNullOrEmpty (Title))
{
SetTitleTextFormatterSize ();
}
SuperView?.SetNeedsDraw ();
}
if (TextFormatter.ConstrainToWidth is null)
{
TextFormatter.ConstrainToWidth = GetContentSize ().Width;
}
if (TextFormatter.ConstrainToHeight is null)
{
TextFormatter.ConstrainToHeight = GetContentSize ().Height;
}
return true;
}
///
/// INTERNAL API - Causes the view's subviews and adornments to be laid out within the view's content areas. Assumes the view's relative layout has been set via .
///
///
///
/// See the View Layout Deep Dive for more information:
///
///
///
/// The position and dimensions of the view are indeterminate until the view has been initialized. Therefore, the
/// behavior of this method is indeterminate if is .
///
/// Raises the event before it returns.
///
internal void LayoutSubviews ()
{
if (!NeedsLayout)
{
return;
}
CheckDimAuto ();
Size contentSize = GetContentSize ();
OnSubviewLayout (new (contentSize));
SubviewLayout?.Invoke (this, new (contentSize));
// The Adornments already have their Frame's set by SetRelativeLayout so we call LayoutSubViews vs. Layout here.
if (Margin is { Subviews.Count: > 0 })
{
Margin.LayoutSubviews ();
}
if (Border is { Subviews.Count: > 0 })
{
Border.LayoutSubviews ();
}
if (Padding is { Subviews.Count: > 0 })
{
Padding.LayoutSubviews ();
}
// Sort out the dependencies of the X, Y, Width, Height properties
HashSet nodes = new ();
HashSet<(View, View)> edges = new ();
CollectAll (this, ref nodes, ref edges);
List ordered = TopologicalSort (SuperView!, nodes, edges);
List redo = new ();
foreach (View v in ordered)
{
if (!v.Layout (contentSize))
{
redo.Add (v);
}
}
bool layoutStillNeeded = false;
if (redo.Count > 0)
{
foreach (View v in ordered)
{
if (!v.Layout (contentSize))
{
layoutStillNeeded = true;
}
}
}
// If the 'to' is rooted to 'from' it's a special-case.
// Use Layout with the ContentSize of the 'from'.
// See the Nested_SubViews_Ref_Topmost_SuperView unit test
if (edges.Count > 0 && GetTopSuperView () is { })
{
foreach ((View from, View to) in edges)
{
// QUESTION: Do we test this with adornments well enough?
to.Layout (from.GetContentSize ());
}
}
_needsLayout = layoutStillNeeded;
OnSubviewsLaidOut (new (contentSize));
SubviewsLaidOut?.Invoke (this, new (contentSize));
}
///
/// Called from before any subviews
/// have been laid out.
///
///
/// Override to perform tasks when the layout is changing.
///
protected virtual void OnSubviewLayout (LayoutEventArgs args) { }
/// Raised by before any subviews
/// have been laid out.
///
/// Subscribe to this event to perform tasks when the layout is changing.
///
public event EventHandler? SubviewLayout;
///
/// Called from after all sub-views
/// have been laid out.
///
///
/// Override to perform tasks after the has been resized or the layout has
/// otherwise changed.
///
protected virtual void OnSubviewsLaidOut (LayoutEventArgs args) { }
/// Raised after all sub-views have been laid out.
///
/// Subscribe to this event to perform tasks after the has been resized or the layout has
/// otherwise changed.
///
public event EventHandler? SubviewsLaidOut;
#endregion Core Layout API
#region NeedsLayout
// We expose no setter for this to ensure that the ONLY place it's changed is in SetNeedsLayout
private bool _needsLayout = true;
///
/// Indicates the View's Frame or the layout of the View's subviews (including Adornments) have
/// changed since the last time the View was laid out.
///
///
/// Used to prevent from needlessly computing
/// layout.
///
///
///
/// if layout is needed.
///
public bool NeedsLayout => _needsLayout;
///
/// Sets to return , indicating this View and all of it's subviews (including adornments) need to be laid out in the next Application iteration.
///
///
///
/// The will cause to be called on the next so there is normally no reason to call see .
///
///
public void SetNeedsLayout ()
{
_needsLayout = true;
if (Margin is { Subviews.Count: > 0 })
{
Margin.SetNeedsLayout ();
}
if (Border is { Subviews.Count: > 0 })
{
Border.SetNeedsLayout ();
}
if (Padding is { Subviews.Count: > 0 })
{
Padding.SetNeedsLayout ();
}
// Use a stack to avoid recursion
Stack stack = new Stack (Subviews);
while (stack.Count > 0)
{
View current = stack.Pop ();
if (!current.NeedsLayout)
{
current._needsLayout = true;
if (current.Margin is { Subviews.Count: > 0 })
{
current.Margin.SetNeedsLayout ();
}
if (current.Border is { Subviews.Count: > 0 })
{
current.Border.SetNeedsLayout ();
}
if (current.Padding is { Subviews.Count: > 0 })
{
current.Padding.SetNeedsLayout ();
}
foreach (View subview in current.Subviews)
{
stack.Push (subview);
}
}
}
TextFormatter.NeedsFormat = true;
if (SuperView is { NeedsLayout: false })
{
SuperView?.SetNeedsLayout ();
}
if (SuperView is null)
{
foreach (var tl in Application.TopLevels)
{
tl.SetNeedsDraw ();
}
}
if (this is not Adornment adornment)
{
return;
}
if (adornment.Parent is { NeedsLayout: false })
{
adornment.Parent?.SetNeedsLayout ();
}
}
#endregion NeedsLayout
#region Topological Sort
///
/// INTERNAL API - Collects all views and their dependencies from a given starting view for layout purposes. Used by
/// to create an ordered list of views to layout.
///
/// The starting view from which to collect dependencies.
/// A reference to a set of views representing nodes in the layout graph.
///
/// A reference to a set of tuples representing edges in the layout graph, where each tuple consists of a pair of views
/// indicating a dependency.
///
internal void CollectAll (View from, ref HashSet nNodes, ref HashSet<(View, View)> nEdges)
{
foreach (View? v in from.InternalSubviews)
{
nNodes.Add (v);
CollectPos (v.X, v, ref nNodes, ref nEdges);
CollectPos (v.Y, v, ref nNodes, ref nEdges);
CollectDim (v.Width, v, ref nNodes, ref nEdges);
CollectDim (v.Height, v, ref nNodes, ref nEdges);
}
}
///
/// INTERNAL API - Collects dimension (where Width or Height is `DimView`) dependencies for a given view.
///
/// The dimension (width or height) to collect dependencies for.
/// The view for which to collect dimension dependencies.
/// A reference to a set of views representing nodes in the layout graph.
///
/// A reference to a set of tuples representing edges in the layout graph, where each tuple consists of a pair of views
/// indicating a dependency.
///
internal void CollectDim (Dim? dim, View from, ref HashSet nNodes, ref HashSet<(View, View)> nEdges)
{
if (dim!.Has (out DimView dv))
{
if (dv.Target != this)
{
nEdges.Add ((dv.Target!, from));
}
}
if (dim!.Has (out DimCombine dc))
{
CollectDim (dc.Left, from, ref nNodes, ref nEdges);
CollectDim (dc.Right, from, ref nNodes, ref nEdges);
}
}
///
/// INTERNAL API - Collects position (where X or Y is `PosView`) dependencies for a given view.
///
/// The position (X or Y) to collect dependencies for.
/// The view for which to collect position dependencies.
/// A reference to a set of views representing nodes in the layout graph.
///
/// A reference to a set of tuples representing edges in the layout graph, where each tuple consists of a pair of views
/// indicating a dependency.
///
internal void CollectPos (Pos pos, View from, ref HashSet nNodes, ref HashSet<(View, View)> nEdges)
{
// TODO: Use Pos.Has instead.
switch (pos)
{
case PosView pv:
Debug.Assert (pv.Target is { });
if (pv.Target != this)
{
nEdges.Add ((pv.Target!, from));
}
return;
case PosCombine pc:
CollectPos (pc.Left, from, ref nNodes, ref nEdges);
CollectPos (pc.Right, from, ref nNodes, ref nEdges);
break;
}
}
// https://en.wikipedia.org/wiki/Topological_sorting
internal static List TopologicalSort (
View superView,
IEnumerable nodes,
ICollection<(View From, View To)> edges
)
{
List result = new ();
// Set of all nodes with no incoming edges
HashSet noEdgeNodes = new (nodes.Where (n => edges.All (e => !e.To.Equals (n))));
while (noEdgeNodes.Any ())
{
// remove a node n from S
View n = noEdgeNodes.First ();
noEdgeNodes.Remove (n);
// add n to tail of L
if (n != superView)
{
result.Add (n);
}
// for each node m with an edge e from n to m do
foreach ((View From, View To) e in edges.Where (e => e.From.Equals (n)).ToArray ())
{
View m = e.To;
// remove edge e from the graph
edges.Remove (e);
// if m has no other incoming edges then
if (edges.All (me => !me.To.Equals (m)) && m != superView)
{
// insert m into S
noEdgeNodes.Add (m);
}
}
}
if (!edges.Any ())
{
return result;
}
foreach ((View from, View to) in edges)
{
if (from == to)
{
// if not yet added to the result, add it and remove from edge
if (result.Find (v => v == from) is null)
{
result.Add (from);
}
edges.Remove ((from, to));
}
else if (from.SuperView == to.SuperView)
{
// if 'from' is not yet added to the result, add it
if (result.Find (v => v == from) is null)
{
result.Add (from);
}
// if 'to' is not yet added to the result, add it
if (result.Find (v => v == to) is null)
{
result.Add (to);
}
// remove from edge
edges.Remove ((from, to));
}
else if (from != superView?.GetTopSuperView (to, from) && !ReferenceEquals (from, to))
{
if (ReferenceEquals (from.SuperView, to))
{
throw new LayoutException (
$"ComputedLayout for \"{superView}\": \"{to}\" "
+ $"references a SubView (\"{from}\")."
);
}
throw new LayoutException (
$"ComputedLayout for \"{superView}\": \"{from}\" "
+ $"linked with \"{to}\" was not found. Did you forget to add it to {superView}?"
);
}
}
// return L (a topologically sorted order)
return result;
} // TopologicalSort
#endregion Topological Sort
#region Utilities
///
/// INTERNAL API - Gets the size of the SuperView's content (nominally the same as
/// the SuperView's ) or the screen size if there's no SuperView.
///
///
private Size GetContainerSize ()
{
// TODO: Get rid of refs to Top
Size superViewContentSize = SuperView?.GetContentSize () ??
(Application.Top is { } && Application.Top != this && Application.Top.IsInitialized
? Application.Top.GetContentSize ()
: Application.Screen.Size);
return superViewContentSize;
}
// BUGBUG: This method interferes with Dialog/MessageBox default min/max size.
// TODO: Get rid of MenuBar coupling as part of https://github.com/gui-cs/Terminal.Gui/issues/2975
///
/// Gets a new location of the that is within the Viewport of the 's
/// (e.g. for dragging a Window). The `out` parameters are the new X and Y coordinates.
///
///
/// If does not have a or it's SuperView is not
/// the position will be bound by .
///
/// The View that is to be moved.
/// The target x location.
/// The target y location.
/// The new x location that will ensure will be fully visible.
/// The new y location that will ensure will be fully visible.
///
/// Either (if does not have a Super View) or
/// 's SuperView. This can be used to ensure LayoutSubviews is called on the correct View.
///
internal static View? GetLocationEnsuringFullVisibility (
View viewToMove,
int targetX,
int targetY,
out int nx,
out int ny
)
{
int maxDimension;
View? superView;
if (viewToMove is not Toplevel || viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
{
maxDimension = Application.Screen.Width;
superView = Application.Top;
}
else
{
// Use the SuperView's Viewport, not Frame
maxDimension = viewToMove!.SuperView.Viewport.Width;
superView = viewToMove.SuperView;
}
if (superView?.Margin is { } && superView == viewToMove!.SuperView)
{
maxDimension -= superView.GetAdornmentsThickness ().Left + superView.GetAdornmentsThickness ().Right;
}
if (viewToMove!.Frame.Width <= maxDimension)
{
nx = Math.Max (targetX, 0);
nx = nx + viewToMove.Frame.Width > maxDimension ? Math.Max (maxDimension - viewToMove.Frame.Width, 0) : nx;
if (nx > viewToMove.Frame.X + viewToMove.Frame.Width)
{
nx = Math.Max (viewToMove.Frame.Right, 0);
}
}
else
{
nx = targetX;
}
//System.Diagnostics.Debug.WriteLine ($"nx:{nx}, rWidth:{rWidth}");
var menuVisible = false;
var statusVisible = false;
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
{
menuVisible = Application.Top?.MenuBar?.Visible == true;
}
else
{
View? t = viewToMove!.SuperView;
while (t is { } and not Toplevel)
{
t = t.SuperView;
}
if (t is Toplevel topLevel)
{
menuVisible = topLevel.MenuBar?.Visible == true;
}
}
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
{
maxDimension = menuVisible ? 1 : 0;
}
else
{
maxDimension = 0;
}
ny = Math.Max (targetY, maxDimension);
if (viewToMove?.SuperView is null || viewToMove == Application.Top || viewToMove?.SuperView == Application.Top)
{
maxDimension = statusVisible ? Application.Screen.Height - 1 : Application.Screen.Height;
}
else
{
maxDimension = statusVisible ? viewToMove!.SuperView.Viewport.Height - 1 : viewToMove!.SuperView.Viewport.Height;
}
if (superView?.Margin is { } && superView == viewToMove?.SuperView)
{
maxDimension -= superView.GetAdornmentsThickness ().Top + superView.GetAdornmentsThickness ().Bottom;
}
ny = Math.Min (ny, maxDimension);
if (viewToMove?.Frame.Height <= maxDimension)
{
ny = ny + viewToMove.Frame.Height > maxDimension
? Math.Max (maxDimension - viewToMove.Frame.Height, menuVisible ? 1 : 0)
: ny;
if (ny > viewToMove.Frame.Y + viewToMove.Frame.Height)
{
ny = Math.Max (viewToMove.Frame.Bottom, 0);
}
}
//System.Diagnostics.Debug.WriteLine ($"ny:{ny}, rHeight:{rHeight}");
return superView!;
}
#endregion Utilities
#region Diagnostics and Verification
// Diagnostics to highlight when X or Y is read before the view has been initialized
private Pos VerifyIsInitialized (Pos pos, string member)
{
//#if DEBUG
// if (pos.ReferencesOtherViews () && !IsInitialized)
// {
// Debug.WriteLine (
// $"WARNING: {member} = {pos} of {this} is dependent on other views and {member} "
// + $"is being accessed before the View has been initialized. This is likely a bug."
// );
// }
//#endif // DEBUG
return pos;
}
// Diagnostics to highlight when Width or Height is read before the view has been initialized
private Dim? VerifyIsInitialized (Dim? dim, string member)
{
//#if DEBUG
// if (dim.ReferencesOtherViews () && !IsInitialized)
// {
// Debug.WriteLine (
// $"WARNING: {member} = {dim} of {this} is dependent on other views and {member} "
// + $"is being accessed before the View has been initialized. This is likely a bug."
// );
// }
//#endif // DEBUG
return dim;
}
/// Gets or sets whether validation of and occurs.
///
/// Setting this to will enable validation of , ,
/// , and during set operations and in . If invalid
/// settings are discovered exceptions will be thrown indicating the error. This will impose a performance penalty and
/// thus should only be used for debugging.
///
public bool ValidatePosDim { get; set; }
// TODO: Move this logic into the Pos/Dim classes
///
/// Throws an if any SubViews are using Dim objects that depend on this
/// Views dimensions.
///
///
private void CheckDimAuto ()
{
if (!ValidatePosDim || !IsInitialized)
{
return;
}
var widthAuto = Width as DimAuto;
var heightAuto = Height as DimAuto;
// Verify none of the subviews are using Dim objects that depend on the SuperView's dimensions.
foreach (View view in Subviews)
{
if (widthAuto is { } && widthAuto.Style.FastHasFlags (DimAutoStyle.Content) && ContentSizeTracksViewport)
{
ThrowInvalid (view, view.Width, nameof (view.Width));
ThrowInvalid (view, view.X, nameof (view.X));
}
if (heightAuto is { } && heightAuto.Style.FastHasFlags (DimAutoStyle.Content) && ContentSizeTracksViewport)
{
ThrowInvalid (view, view.Height, nameof (view.Height));
ThrowInvalid (view, view.Y, nameof (view.Y));
}
}
return;
void ThrowInvalid (View view, object? checkPosDim, string name)
{
object? bad = null;
switch (checkPosDim)
{
case Pos pos and PosAnchorEnd:
break;
case Pos pos and not PosAbsolute and not PosView and not PosCombine:
bad = pos;
break;
case Pos pos and PosCombine:
// Recursively check for not Absolute or not View
ThrowInvalid (view, (pos as PosCombine)?.Left, name);
ThrowInvalid (view, (pos as PosCombine)?.Right, name);
break;
case Dim dim and DimAuto:
break;
case Dim dim and DimFill:
break;
case Dim dim and not DimAbsolute and not DimView and not DimCombine:
bad = dim;
break;
case Dim dim and DimCombine:
// Recursively check for not Absolute or not View
ThrowInvalid (view, (dim as DimCombine)?.Left, name);
ThrowInvalid (view, (dim as DimCombine)?.Right, name);
break;
}
if (bad != null)
{
throw new LayoutException (
$"{view.GetType ().Name}.{name} = {bad.GetType ().Name} "
+ $"which depends on the SuperView's dimensions and the SuperView uses Dim.Auto."
);
}
}
}
#endregion Diagnostics and Verification
}