Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-01 00:46:39 +01:00
Code Issues Packages Projects Releases Wiki Activity

Better documented existing SetRelativeLayout behavior + unit tess

Browse Source
This commit is contained in:
Tig Kindel
2023-12-21 16:42:26 -07:00
parent ef00373726
commit eb037b528c
4 changed files with 188 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Terminal.Gui/Application.cs
View File

@@ -317,6 +317,8 @@ public static partial class Application {
} else if (Top != null && Toplevel != Top && _topLevels.Contains (Top)) {
Top.OnLeave (Toplevel);
}
// BUGBUG: We should not depend on `Id` internally.
// BUGBUG: It is super unclear what this code does anyway.
if (string.IsNullOrEmpty (Toplevel.Id)) {
int count = 1;
string id = (_topLevels.Count + count).ToString ();
@@ -836,6 +838,12 @@ public static partial class Application {
#endregion Run (Begin, Run, End)
#region Toplevel handling
/// <summary>
/// Holds the stack of TopLevel views.
/// </summary>
// BUGBUG: Techncally, this is not the full lst of TopLevels. THere be dragons hwre. E.g. see how Toplevel.Id is used. What
// about TopLevels that are just a SubView of another View?
static readonly Stack<Toplevel> _topLevels = new ();
/// <summary>

61
Terminal.Gui/View/Layout/ViewLayout.cs
View File

@@ -284,11 +284,18 @@ public partial class View {
/// </summary>
/// <value>The X Position.</value>
/// <remarks>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
/// <para>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
/// </para>
/// <para>
/// <see langword="null"/> is the same as <c>Pos.Absolute(0)</c>.
/// </para>
/// </remarks>
public Pos X {
get => VerifyIsInitialized (_x);
set {
// BUGBUG: null is the sames a Pos.Absolute(0). Should we be explicit and set it?
if (ValidatePosDim && LayoutStyle == LayoutStyle.Computed) {
CheckAbsolute (nameof (X), _x, value);
}
@@ -299,16 +306,24 @@ public partial class View {
}
}
/// <summary>
/// Gets or sets the Y position for the view (the row). Only used if the <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
/// </summary>
/// <value>The y position (line).</value>
/// <value>The X Position.</value>
/// <remarks>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
/// <para>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
/// </para>
/// <para>
/// <see langword="null"/> is the same as <c>Pos.Absolute(0)</c>.
/// </para>
/// </remarks>
public Pos Y {
get => VerifyIsInitialized (_y);
set {
// BUGBUG: null is the sames a Pos.Absolute(0). Should we be explicit and set it?
if (ValidatePosDim && LayoutStyle == LayoutStyle.Computed) {
CheckAbsolute (nameof (Y), _y, value);
}
@@ -321,15 +336,22 @@ public partial class View {
Dim _width, _height;
/// <summary>
/// Gets or sets the width of the view. Only used the <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
/// Gets or sets the width of the view. Only used when <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
/// </summary>
/// <value>The width.</value>
/// <remarks>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
/// <para>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property
/// has no effect and its value is indeterminate.
/// </para>
/// <para>
/// <see langword="null"/> is the same as <c>Dim.Fill (0)</c>.
/// </para>
/// </remarks>
public Dim Width {
get => VerifyIsInitialized (_width);
set {
// BUGBUG: null is the sames a Dim.Fill(0). Should we be explicit and set it?
if (ValidatePosDim) {
CheckDimAuto ();
if (LayoutStyle == LayoutStyle.Computed) {
@@ -351,13 +373,22 @@ public partial class View {
}
/// <summary>
/// Gets or sets the height of the view. Only used the <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
/// Gets or sets the height of the view. Only used when <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
/// </summary>
/// <value>The height.</value>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
/// <value>The width.</value>
/// <remarks>
/// <para>
/// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property
/// has no effect and its value is indeterminate.
/// </para>
/// <para>
/// <see langword="null"/> is the same as <c>Dim.Fill (0)</c>.
/// </para>
/// </remarks>
public Dim Height {
get => VerifyIsInitialized (_height);
set {
// BUGBUG: null is the sames a Dim.Fill(0). Should we be explicit and set it?
if (ValidatePosDim) {
CheckDimAuto ();
if (LayoutStyle == LayoutStyle.Computed) {
@@ -639,7 +670,8 @@ public partial class View {
// TODO: Come up with a better name for this method. "SetRelativeLayout" lacks clarity and confuses. AdjustSizeAndPosition?
/// <summary>
/// Sets the View's position and dimensions (<see cref="Frame"/>) based on <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/>.
/// Applies the view's position (<see cref="X"/>, <see cref="Y"/>) and dimension (<see cref="Width"/>, and <see cref="Height"/>) to
/// <see cref="Frame"/>, given a rectangle describing the SuperView's Bounds (nominally the same as <c>this.SuperView.Bounds</c>).
/// </summary>
/// <param name="superviewBounds">The rectangle describing the SuperView's Bounds (nominally the same as <c>this.SuperView.Bounds</c>).</param>
internal void SetRelativeLayout (Rect superviewBounds)
@@ -670,6 +702,7 @@ public partial class View {
int newDimension;
switch (d) {
case null:
// dim == null is the same as dim == Dim.FIll (0)
newDimension = AutoSize ? autosize : dimension;
break;
@@ -694,10 +727,12 @@ public partial class View {
newDimension = GetNewDimension (auto._min, location, dimension, autosize);
if (width) {
int furthestRight = Subviews.Count == 0 ? 0 : Subviews.Max (v => v.Frame.X + v.Frame.Width);
newDimension = int.Max (furthestRight + thickness.Left + thickness.Right, auto._min?.Anchor (SuperView?.Bounds.Width ?? 0) ?? 0);
//Debug.Assert(superviewBounds.Width == (SuperView?.Bounds.Width ?? 0));
newDimension = int.Max (furthestRight + thickness.Left + thickness.Right, auto._min?.Anchor (superviewBounds.Width) ?? 0);
} else {
int furthestBottom = Subviews.Count == 0 ? 0 : Subviews.Max (v => v.Frame.Y + v.Frame.Height);
newDimension = int.Max (furthestBottom + thickness.Top + thickness.Bottom, auto._min?.Anchor (SuperView?.Bounds.Height ?? 0) ?? 0);
//Debug.Assert (superviewBounds.Height == (SuperView?.Bounds.Height ?? 0));
newDimension = int.Max (furthestBottom + thickness.Top + thickness.Bottom, auto._min?.Anchor (superviewBounds.Height) ?? 0);
}
break;
@@ -718,6 +753,7 @@ public partial class View {
switch (pos) {
case Pos.PosCenter posCenter:
if (dim == null) {
// dim == null is the same as dim == Dim.FIll (0)
throw new ArgumentException ();
newDimension = AutoSize ? autosizeDimension : superviewDimension;
newLocation = posCenter.Anchor (superviewDimension - newDimension);
@@ -753,10 +789,11 @@ public partial class View {
case Pos.PosAnchorEnd:
case Pos.PosAbsolute:
case null:
case Pos.PosFactor:
case Pos.PosFunc:
case Pos.PosView:
default:
default:
newLocation = pos?.Anchor (superviewDimension) ?? 0;
newDimension = Math.Max (GetNewDimension (dim, newLocation, superviewDimension, autosizeDimension), 0);
break;

2
Terminal.Gui/Views/Dialog.cs
View File

@@ -78,6 +78,8 @@ public class Dialog : Window {
}
bool inLayout = false;
/// <inheritdoc />
public override void LayoutSubviews ()
{
if (inLayout) {

130
UnitTests/View/Layout/SetRelativeLayoutTests.cs
View File

@@ -10,8 +10,136 @@ public class SetRelativeLayoutTests {
public SetRelativeLayoutTests (ITestOutputHelper output) => _output = output;
[Fact]
public void Null_Pos_Is_Same_As_PosAbsolute0 ()
{
var view = new View () {
X = null,
Y = null,
};
// Default layout style is Computed
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.Null (view.X);
Assert.Null (view.Y);
view.BeginInit(); view.EndInit();
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.Null (view.X);
Assert.Null (view.Y);
view.SetRelativeLayout(new Rect(5, 5, 10, 10));
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.Null (view.X);
Assert.Null (view.Y);
Assert.Equal (0, view.Frame.X);
Assert.Equal (0, view.Frame.Y);
}
[Theory]
[InlineData (1, 1)]
[InlineData (0, 0)]
public void NonNull_Pos (int pos, int expectedPos)
{
var view = new View () {
X = pos,
Y = pos,
};
// Default layout style is Computed
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.NotNull (view.X);
Assert.NotNull (view.Y);
view.BeginInit (); view.EndInit ();
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.NotNull (view.X);
Assert.NotNull (view.Y);
view.SetRelativeLayout (new Rect (5, 5, 10, 10));
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.NotNull (view.X);
Assert.NotNull (view.Y);
Assert.Equal (expectedPos, view.Frame.X);
Assert.Equal (expectedPos, view.Frame.Y);
}
[Fact]
public void Null_Dim_Is_Same_As_DimFill0 ()
{
var view = new View () {
Width = null,
Height = null,
};
// Default layout style is Computed
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.Null (view.Width);
Assert.Null (view.Height);
view.BeginInit (); view.EndInit ();
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.Null (view.Width);
Assert.Null (view.Height);
view.SetRelativeLayout (new Rect (5, 5, 10, 10));
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.Null (view.Width);
Assert.Null (view.Height);
Assert.Equal (0, view.Frame.X);
Assert.Equal (0, view.Frame.Y);
Assert.Equal (10, view.Frame.Width);
Assert.Equal (10, view.Frame.Height);
view.Width = Dim.Fill (0);
view.Height = Dim.Fill (0);
view.SetRelativeLayout (new Rect (5, 5, 10, 10));
Assert.Equal (10, view.Frame.Width);
Assert.Equal (10, view.Frame.Height);
}
[Theory]
[InlineData(1, 1)]
[InlineData (0, 0)]
public void NonNull_Dim (int dim, int expectedDim)
{
var view = new View () {
Width = dim,
Height = dim,
};
// Default layout style is Computed
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.NotNull (view.Width);
Assert.NotNull (view.Height);
view.BeginInit (); view.EndInit ();
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.NotNull (view.Width);
Assert.NotNull (view.Height);
view.SetRelativeLayout (new Rect (5, 5, 10, 10));
Assert.Equal (view.LayoutStyle, LayoutStyle.Computed);
Assert.NotNull (view.Width);
Assert.NotNull (view.Height);
Assert.Equal (0, view.Frame.X);
Assert.Equal (0, view.Frame.Y);
// BUGBUG: Width == null is same as Dim.Absolute (0) (or should be). Thus this is a bug.
Assert.Equal (expectedDim, view.Frame.Width);
Assert.Equal (expectedDim, view.Frame.Height);
}
[Fact] [TestRespondersDisposed]
public void SetRelativeLayout_PosCombine_Center_Plus_Absolute ()
public void PosCombine_Center_Plus_Absolute ()
{
var superView = new View () {
AutoSize = false,