ViewLayout.cs 47 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318
  1. using System;
  2. using System.Collections.Generic;
  3. using System.ComponentModel;
  4. using System.Diagnostics;
  5. using System.Linq;
  6. namespace Terminal.Gui;
  7. /// <summary>
  8. /// Determines the LayoutStyle for a <see cref="View"/>, if Absolute, during <see cref="View.LayoutSubviews"/>, the
  9. /// value from the <see cref="View.Frame"/> will be used, if the value is Computed, then <see cref="View.Frame"/>
  10. /// will be updated from the X, Y <see cref="Pos"/> objects and the Width and Height <see cref="Dim"/> objects.
  11. /// </summary>
  12. public enum LayoutStyle {
  13. /// <summary>
  14. /// The position and size of the view are based <see cref="View.Frame"/>.
  15. /// </summary>
  16. Absolute,
  17. /// <summary>
  18. /// The position and size of the view will be computed based on
  19. /// <see cref="View.X"/>, <see cref="View.Y"/>, <see cref="View.Width"/>, and <see cref="View.Height"/>. <see cref="View.Frame"/> will
  20. /// provide the absolute computed values.
  21. /// </summary>
  22. Computed
  23. }
  24. public partial class View {
  25. // The frame for the object. Relative to the SuperView's Bounds.
  26. Rect _frame;
  27. /// <summary>
  28. /// Gets or sets the frame for the view. The frame is relative to the <see cref="SuperView"/>'s <see cref="Bounds"/>.
  29. /// </summary>
  30. /// <value>The frame.</value>
  31. /// <remarks>
  32. /// <para>
  33. /// Change the Frame when using the <see cref="Terminal.Gui.LayoutStyle.Absolute"/> layout style to move or resize views.
  34. /// </para>
  35. /// <para>
  36. /// Altering the Frame of a view will trigger the redrawing of the
  37. /// view as well as the redrawing of the affected regions of the <see cref="SuperView"/>.
  38. /// </para>
  39. /// </remarks>
  40. public virtual Rect Frame {
  41. get => _frame;
  42. set {
  43. _frame = new Rect (value.X, value.Y, Math.Max (value.Width, 0), Math.Max (value.Height, 0));
  44. if (IsInitialized || LayoutStyle == LayoutStyle.Absolute) {
  45. LayoutFrames ();
  46. TextFormatter.Size = GetTextFormatterSizeNeededForTextAndHotKey ();
  47. SetNeedsLayout ();
  48. SetNeedsDisplay ();
  49. }
  50. }
  51. }
  52. /// <summary>
  53. /// The frame (specified as a <see cref="Thickness"/>) that separates a View from other SubViews of the same SuperView.
  54. /// The margin offsets the <see cref="Bounds"/> from the <see cref="Frame"/>.
  55. /// </summary>
  56. /// <remarks>
  57. /// <para>
  58. /// The frames (<see cref="Margin"/>, <see cref="Border"/>, and <see cref="Padding"/>) are not part of the View's content
  59. /// and are not clipped by the View's Clip Area.
  60. /// </para>
  61. /// <para>
  62. /// Changing the size of a frame (<see cref="Margin"/>, <see cref="Border"/>, or <see cref="Padding"/>)
  63. /// will change the size of the <see cref="Frame"/> and trigger <see cref="LayoutSubviews"/> to update the layout of the
  64. /// <see cref="SuperView"/> and its <see cref="Subviews"/>.
  65. /// </para>
  66. /// </remarks>
  67. public Frame Margin { get; private set; }
  68. /// <summary>
  69. /// The frame (specified as a <see cref="Thickness"/>) inside of the view that offsets the <see cref="Bounds"/> from the <see cref="Margin"/>.
  70. /// The Border provides the space for a visual border (drawn using line-drawing glyphs) and the Title.
  71. /// The Border expands inward; in other words if `Border.Thickness.Top == 2` the border and
  72. /// title will take up the first row and the second row will be filled with spaces.
  73. /// </summary>
  74. /// <remarks>
  75. /// <para>
  76. /// <see cref="BorderStyle"/> provides a simple helper for turning a simple border frame on or off.
  77. /// </para>
  78. /// <para>
  79. /// The frames (<see cref="Margin"/>, <see cref="Border"/>, and <see cref="Padding"/>) are not part of the View's content
  80. /// and are not clipped by the View's Clip Area.
  81. /// </para>
  82. /// <para>
  83. /// Changing the size of a frame (<see cref="Margin"/>, <see cref="Border"/>, or <see cref="Padding"/>)
  84. /// will change the size of the <see cref="Frame"/> and trigger <see cref="LayoutSubviews"/> to update the layout of the
  85. /// <see cref="SuperView"/> and its <see cref="Subviews"/>.
  86. /// </para>
  87. /// </remarks>
  88. public Frame Border { get; private set; }
  89. /// <summary>
  90. /// Gets or sets whether the view has a one row/col thick border.
  91. /// </summary>
  92. /// <remarks>
  93. /// <para>
  94. /// This is a helper for manipulating the view's <see cref="Border"/>. Setting this property to any value other than
  95. /// <see cref="LineStyle.None"/> is equivalent to setting <see cref="Border"/>'s <see cref="Frame.Thickness"/>
  96. /// to `1` and <see cref="BorderStyle"/> to the value.
  97. /// </para>
  98. /// <para>
  99. /// Setting this property to <see cref="LineStyle.None"/> is equivalent to setting <see cref="Border"/>'s <see cref="Frame.Thickness"/>
  100. /// to `0` and <see cref="BorderStyle"/> to <see cref="LineStyle.None"/>.
  101. /// </para>
  102. /// <para>
  103. /// For more advanced customization of the view's border, manipulate see <see cref="Border"/> directly.
  104. /// </para>
  105. /// </remarks>
  106. public LineStyle BorderStyle {
  107. get => Border?.BorderStyle ?? LineStyle.None;
  108. set {
  109. if (Border == null) {
  110. throw new InvalidOperationException ("Border is null; this is likely a bug.");
  111. }
  112. if (value != LineStyle.None) {
  113. Border.Thickness = new Thickness (1);
  114. } else {
  115. Border.Thickness = new Thickness (0);
  116. }
  117. Border.BorderStyle = value;
  118. LayoutFrames ();
  119. SetNeedsLayout ();
  120. }
  121. }
  122. /// <summary>
  123. /// The frame (specified as a <see cref="Thickness"/>) inside of the view that offsets the <see cref="Bounds"/> from the <see cref="Border"/>.
  124. /// </summary>
  125. /// <remarks>
  126. /// <para>
  127. /// The frames (<see cref="Margin"/>, <see cref="Border"/>, and <see cref="Padding"/>) are not part of the View's content
  128. /// and are not clipped by the View's Clip Area.
  129. /// </para>
  130. /// <para>
  131. /// Changing the size of a frame (<see cref="Margin"/>, <see cref="Border"/>, or <see cref="Padding"/>)
  132. /// will change the size of the <see cref="Frame"/> and trigger <see cref="LayoutSubviews"/> to update the layout of the
  133. /// <see cref="SuperView"/> and its <see cref="Subviews"/>.
  134. /// </para>
  135. /// </remarks>
  136. public Frame Padding { get; private set; }
  137. /// <summary>
  138. /// Helper to get the total thickness of the <see cref="Margin"/>, <see cref="Border"/>, and <see cref="Padding"/>.
  139. /// </summary>
  140. /// <returns>A thickness that describes the sum of the Frames' thicknesses.</returns>
  141. public Thickness GetFramesThickness ()
  142. {
  143. int left = Margin.Thickness.Left + Border.Thickness.Left + Padding.Thickness.Left;
  144. int top = Margin.Thickness.Top + Border.Thickness.Top + Padding.Thickness.Top;
  145. int right = Margin.Thickness.Right + Border.Thickness.Right + Padding.Thickness.Right;
  146. int bottom = Margin.Thickness.Bottom + Border.Thickness.Bottom + Padding.Thickness.Bottom;
  147. return new Thickness (left, top, right, bottom);
  148. }
  149. /// <summary>
  150. /// Helper to get the X and Y offset of the Bounds from the Frame. This is the sum of the Left and Top properties of
  151. /// <see cref="Margin"/>, <see cref="Border"/> and <see cref="Padding"/>.
  152. /// </summary>
  153. public Point GetBoundsOffset () => new Point (Padding?.Thickness.GetInside (Padding.Frame).X ?? 0, Padding?.Thickness.GetInside (Padding.Frame).Y ?? 0);
  154. /// <summary>
  155. /// Creates the view's <see cref="Frame"/> objects. This internal method is overridden by Frame to do nothing
  156. /// to prevent recursion during View construction.
  157. /// </summary>
  158. internal virtual void CreateFrames ()
  159. {
  160. void ThicknessChangedHandler (object sender, EventArgs e)
  161. {
  162. LayoutFrames ();
  163. SetNeedsLayout ();
  164. SetNeedsDisplay ();
  165. }
  166. if (Margin != null) {
  167. Margin.ThicknessChanged -= ThicknessChangedHandler;
  168. Margin.Dispose ();
  169. }
  170. Margin = new Frame () { Id = "Margin", Thickness = new Thickness (0) };
  171. Margin.ThicknessChanged += ThicknessChangedHandler;
  172. Margin.Parent = this;
  173. if (Border != null) {
  174. Border.ThicknessChanged -= ThicknessChangedHandler;
  175. Border.Dispose ();
  176. }
  177. Border = new Frame () { Id = "Border", Thickness = new Thickness (0) };
  178. Border.ThicknessChanged += ThicknessChangedHandler;
  179. Border.Parent = this;
  180. // TODO: Create View.AddAdornment
  181. if (Padding != null) {
  182. Padding.ThicknessChanged -= ThicknessChangedHandler;
  183. Padding.Dispose ();
  184. }
  185. Padding = new Frame () { Id = "Padding", Thickness = new Thickness (0) };
  186. Padding.ThicknessChanged += ThicknessChangedHandler;
  187. Padding.Parent = this;
  188. }
  189. LayoutStyle _layoutStyle;
  190. /// <summary>
  191. /// Controls how the View's <see cref="Frame"/> is computed during <see cref="LayoutSubviews"/>. If the style is set to
  192. /// <see cref="LayoutStyle.Absolute"/>,
  193. /// LayoutSubviews does not change the <see cref="Frame"/>. If the style is <see cref="LayoutStyle.Computed"/>
  194. /// the <see cref="Frame"/> is updated using
  195. /// the <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/> properties.
  196. /// </summary>
  197. /// <value>The layout style.</value>
  198. public LayoutStyle LayoutStyle {
  199. get => _layoutStyle;
  200. set {
  201. _layoutStyle = value;
  202. SetNeedsLayout ();
  203. }
  204. }
  205. /// <summary>
  206. /// The view's content area.
  207. /// <para>
  208. /// SubViews are positioned relative to Bounds.
  209. /// </para>
  210. /// <para>
  211. /// Drawing is clipped to Bounds (<see cref="Draw()"/> clips drawing to Bounds.<see cref="Rect.Size">Size</see>).
  212. /// </para>
  213. /// <para>
  214. /// Mouse events are reported relative to Bounds.
  215. /// </para>
  216. /// </summary>
  217. /// <value>The view's content area.</value>
  218. /// <remarks>
  219. /// <para>
  220. /// The <see cref="Rect.Location"/> of Bounds is always (0, 0). To obtain the offset of the Bounds from the Frame use
  221. /// <see cref="GetBoundsOffset"/>.
  222. /// </para>
  223. /// <para>
  224. /// When using <see cref="LayoutStyle.Computed"/>, Bounds is not valid until after the view has been initialized (after <see cref="EndInit"/> has been called and <see cref="Initialized"/>
  225. /// has fired). Accessing this property before the view is initialized is considered an error./>
  226. /// </para>
  227. /// </remarks>
  228. public virtual Rect Bounds {
  229. get {
  230. #if DEBUG
  231. if (LayoutStyle == LayoutStyle.Computed && !IsInitialized) {
  232. Debug.WriteLine ($"WARNING: Bounds is being accessed before the View has been initialized. This is likely a bug in {this}");
  233. Debug.WriteLine ($"The Frame is set before the View has been initialized. So it isn't a bug.Is by design.");
  234. }
  235. #endif // DEBUG
  236. //var frameRelativeBounds = Padding?.Thickness.GetInside (Padding.Frame) ?? new Rect (default, Frame.Size);
  237. var frameRelativeBounds = FrameGetInsideBounds ();
  238. return new Rect (default, frameRelativeBounds.Size);
  239. }
  240. set {
  241. // BUGBUG: Margin etc.. can be null (if typeof(Frame))
  242. Frame = new Rect (Frame.Location,
  243. new Size (
  244. value.Size.Width + Margin.Thickness.Horizontal + Border.Thickness.Horizontal + Padding.Thickness.Horizontal,
  245. value.Size.Height + Margin.Thickness.Vertical + Border.Thickness.Vertical + Padding.Thickness.Vertical
  246. )
  247. );
  248. }
  249. }
  250. Rect FrameGetInsideBounds ()
  251. {
  252. if (Margin == null || Border == null || Padding == null) {
  253. return new Rect (default, Frame.Size);
  254. }
  255. int width = Math.Max (0, Frame.Size.Width - Margin.Thickness.Horizontal - Border.Thickness.Horizontal - Padding.Thickness.Horizontal);
  256. int height = Math.Max (0, Frame.Size.Height - Margin.Thickness.Vertical - Border.Thickness.Vertical - Padding.Thickness.Vertical);
  257. return new Rect (Point.Empty, new Size (width, height));
  258. }
  259. Pos _x, _y;
  260. /// <summary>
  261. /// Gets or sets the X position for the view (the column). Only used if the <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
  262. /// </summary>
  263. /// <value>The X Position.</value>
  264. /// <remarks>
  265. /// <para>
  266. /// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  267. /// </para>
  268. /// <para>
  269. /// <see langword="null"/> is the same as <c>Pos.Absolute(0)</c>.
  270. /// </para>
  271. /// </remarks>
  272. public Pos X {
  273. get => VerifyIsInitialized (_x);
  274. set {
  275. // BUGBUG: null is the sames a Pos.Absolute(0). Should we be explicit and set it?
  276. if (ValidatePosDim && LayoutStyle == LayoutStyle.Computed) {
  277. CheckAbsolute (nameof (X), _x, value);
  278. }
  279. _x = value;
  280. OnResizeNeeded ();
  281. }
  282. }
  283. /// <summary>
  284. /// 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"/>.
  285. /// </summary>
  286. /// <value>The X Position.</value>
  287. /// <remarks>
  288. /// <para>
  289. /// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property has no effect and its value is indeterminate.
  290. /// </para>
  291. /// <para>
  292. /// <see langword="null"/> is the same as <c>Pos.Absolute(0)</c>.
  293. /// </para>
  294. /// </remarks>
  295. public Pos Y {
  296. get => VerifyIsInitialized (_y);
  297. set {
  298. // BUGBUG: null is the sames a Pos.Absolute(0). Should we be explicit and set it?
  299. if (ValidatePosDim && LayoutStyle == LayoutStyle.Computed) {
  300. CheckAbsolute (nameof (Y), _y, value);
  301. }
  302. _y = value;
  303. OnResizeNeeded ();
  304. }
  305. }
  306. Dim _width, _height;
  307. /// <summary>
  308. /// Gets or sets the width of the view. Only used when <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
  309. /// </summary>
  310. /// <value>The width.</value>
  311. /// <remarks>
  312. /// <para>
  313. /// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property
  314. /// has no effect and its value is indeterminate.
  315. /// </para>
  316. /// <para>
  317. /// <see langword="null"/> is the same as <c>Dim.Fill (0)</c>.
  318. /// </para>
  319. /// </remarks>
  320. public Dim Width {
  321. get => VerifyIsInitialized (_width);
  322. set {
  323. // BUGBUG: null is the sames a Dim.Fill(0). Should we be explicit and set it?
  324. if (ValidatePosDim) {
  325. CheckDimAuto ();
  326. if (LayoutStyle == LayoutStyle.Computed) {
  327. CheckAbsolute (nameof (Width), _width, value);
  328. }
  329. }
  330. _width = value;
  331. if (ValidatePosDim) {
  332. bool isValidNewAutSize = AutoSize && IsValidAutoSizeWidth (_width);
  333. if (IsAdded && AutoSize && !isValidNewAutSize) {
  334. throw new InvalidOperationException ("Must set AutoSize to false before set the Width.");
  335. }
  336. }
  337. OnResizeNeeded ();
  338. }
  339. }
  340. /// <summary>
  341. /// Gets or sets the height of the view. Only used when <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Computed"/>.
  342. /// </summary>
  343. /// <value>The width.</value>
  344. /// <remarks>
  345. /// <para>
  346. /// If <see cref="LayoutStyle"/> is <see cref="Terminal.Gui.LayoutStyle.Absolute"/> changing this property
  347. /// has no effect and its value is indeterminate.
  348. /// </para>
  349. /// <para>
  350. /// <see langword="null"/> is the same as <c>Dim.Fill (0)</c>.
  351. /// </para>
  352. /// </remarks>
  353. public Dim Height {
  354. get => VerifyIsInitialized (_height);
  355. set {
  356. // BUGBUG: null is the sames a Dim.Fill(0). Should we be explicit and set it?
  357. if (ValidatePosDim) {
  358. CheckDimAuto ();
  359. if (LayoutStyle == LayoutStyle.Computed) {
  360. CheckAbsolute (nameof (Height), _height, value);
  361. }
  362. }
  363. _height = value;
  364. if (ValidatePosDim) {
  365. bool isValidNewAutSize = AutoSize && IsValidAutoSizeHeight (_height);
  366. if (IsAdded && AutoSize && !isValidNewAutSize) {
  367. throw new InvalidOperationException ("Must set AutoSize to false before setting the Height.");
  368. }
  369. }
  370. OnResizeNeeded ();
  371. }
  372. }
  373. // Diagnostics to highlight when X or Y is read before the view has been initialized
  374. Pos VerifyIsInitialized (Pos pos)
  375. {
  376. #if DEBUG
  377. if (LayoutStyle == LayoutStyle.Computed && !IsInitialized) {
  378. Debug.WriteLine ($"WARNING: \"{this}\" has not been initialized; position is indeterminate {pos}. This is likely a bug.");
  379. }
  380. #endif // DEBUG
  381. return pos;
  382. }
  383. // Diagnostics to highlight when Width or Height is read before the view has been initialized
  384. Dim VerifyIsInitialized (Dim dim)
  385. {
  386. #if DEBUG
  387. if (LayoutStyle == LayoutStyle.Computed && !IsInitialized) {
  388. Debug.WriteLine ($"WARNING: \"{this}\" has not been initialized; dimension is indeterminate: {dim}. This is likely a bug.");
  389. }
  390. #endif // DEBUG
  391. return dim;
  392. }
  393. /// <summary>
  394. /// Gets or sets whether validation of <see cref="Pos"/> and <see cref="Dim"/> occurs.
  395. /// </summary>
  396. /// <remarks>
  397. /// Setting this to <see langword="true"/> will enable validation of <see cref="X"/>, <see cref="Y"/>, <see cref="Width"/>, and <see cref="Height"/>
  398. /// during set operations and in <see cref="LayoutSubviews"/>.If invalid settings are discovered exceptions will be thrown indicating the error.
  399. /// This will impose a performance penalty and thus should only be used for debugging.
  400. /// </remarks>
  401. public bool ValidatePosDim { get; set; }
  402. /// <summary>
  403. /// Throws an <see cref="InvalidOperationException"/> if any of the SubViews are using Dim objects that depend on this Views dimensions.
  404. /// </summary>
  405. /// <exception cref="InvalidOperationException"></exception>
  406. void CheckDimAuto ()
  407. {
  408. if (!ValidatePosDim || !IsInitialized || Width is not Dim.DimAuto && Height is not Dim.DimAuto) {
  409. return;
  410. }
  411. void ThrowInvalid (View view, object checkPosDim, string name)
  412. {
  413. // TODO: Figure out how to make CheckDimAuto deal with PosCombine
  414. object bad = null;
  415. switch (checkPosDim) {
  416. case Pos pos and not Pos.PosAbsolute and not Pos.PosView and not Pos.PosCombine:
  417. bad = pos;
  418. break;
  419. case Pos pos and Pos.PosCombine:
  420. // Recursively check for not Absolute or not View
  421. ThrowInvalid (view, (pos as Pos.PosCombine)._left, name);
  422. ThrowInvalid (view, (pos as Pos.PosCombine)._right, name);
  423. break;
  424. case Dim dim and not Dim.DimAbsolute and not Dim.DimView and not Dim.DimCombine:
  425. bad = dim;
  426. break;
  427. case Dim dim and Dim.DimCombine:
  428. // Recursively check for not Absolute or not View
  429. ThrowInvalid (view, (dim as Dim.DimCombine)._left, name);
  430. ThrowInvalid (view, (dim as Dim.DimCombine)._right, name);
  431. break;
  432. }
  433. if (bad != null) {
  434. throw new InvalidOperationException (@$"{view.GetType ().Name}.{name} = {bad.GetType ().Name} which depends on the SuperView's dimensions and the SuperView uses Dim.Auto.");
  435. }
  436. }
  437. // Verify none of the subviews are using Dim objects that depend on the SuperView's dimensions.
  438. foreach (var view in Subviews) {
  439. if (Width is Dim.DimAuto { _min: null }) {
  440. ThrowInvalid (view, view.Width, nameof (view.Width));
  441. ThrowInvalid (view, view.X, nameof (view.X));
  442. }
  443. if (Height is Dim.DimAuto { _min: null }) {
  444. ThrowInvalid (view, view.Height, nameof (view.Height));
  445. ThrowInvalid (view, view.Y, nameof (view.Y));
  446. }
  447. }
  448. }
  449. /// <summary>
  450. /// Throws an <see cref="ArgumentException"/> if <paramref name="newValue"/> is <see cref="Pos.PosAbsolute"/> or <see cref="Dim.DimAbsolute"/>.
  451. /// Used when <see cref="ValidatePosDim"/> is turned on to verify correct <see cref="LayoutStyle.Computed"/> behavior.
  452. /// </summary>
  453. /// <remarks>
  454. /// Does not verify if this view is Toplevel (WHY??!?).
  455. /// </remarks>
  456. /// <param name="prop">The property name.</param>
  457. /// <param name="oldValue"></param>
  458. /// <param name="newValue"></param>
  459. void CheckAbsolute (string prop, object oldValue, object newValue)
  460. {
  461. if (!IsInitialized || !ValidatePosDim || oldValue == null || oldValue.GetType () == newValue.GetType () || this is Toplevel) {
  462. return;
  463. }
  464. if (oldValue.GetType () != newValue.GetType () && newValue is (Pos.PosAbsolute or Dim.DimAbsolute)) {
  465. throw new ArgumentException ($@"{prop} must not be Absolute if LayoutStyle is Computed", prop);
  466. }
  467. }
  468. /// <summary>
  469. /// Called whenever the view needs to be resized. Sets <see cref="Frame"/> and
  470. /// triggers a <see cref="LayoutSubviews()"/> call.
  471. /// </summary>
  472. /// <remarks>
  473. /// Can be overridden if the view resize behavior is different than the default.
  474. /// </remarks>
  475. protected virtual void OnResizeNeeded ()
  476. {
  477. int actX = _x is Pos.PosAbsolute ? _x.Anchor (0) : _frame.X;
  478. int actY = _y is Pos.PosAbsolute ? _y.Anchor (0) : _frame.Y;
  479. if (AutoSize) {
  480. //if (TextAlignment == TextAlignment.Justified) {
  481. // throw new InvalidOperationException ("TextAlignment.Justified cannot be used with AutoSize");
  482. //}
  483. var s = GetAutoSize ();
  484. int w = _width is Dim.DimAbsolute && _width.Anchor (0) > s.Width ? _width.Anchor (0) : s.Width;
  485. int h = _height is Dim.DimAbsolute && _height.Anchor (0) > s.Height ? _height.Anchor (0) : s.Height;
  486. _frame = new Rect (new Point (actX, actY), new Size (w, h)); // Set frame, not Frame!
  487. } else {
  488. int w = _width is Dim.DimAbsolute ? _width.Anchor (0) : _frame.Width;
  489. int h = _height is Dim.DimAbsolute ? _height.Anchor (0) : _frame.Height;
  490. // BUGBUG: v2 - ? - If layoutstyle is absolute, this overwrites the current frame h/w with 0. Hmmm...
  491. // This is needed for DimAbsolute values by setting the frame before LayoutSubViews.
  492. _frame = new Rect (new Point (actX, actY), new Size (w, h)); // Set frame, not Frame!
  493. }
  494. //// BUGBUG: I think these calls are redundant or should be moved into just the AutoSize case
  495. if (IsInitialized || LayoutStyle == LayoutStyle.Absolute) {
  496. SetFrameToFitText ();
  497. LayoutFrames ();
  498. TextFormatter.Size = GetTextFormatterSizeNeededForTextAndHotKey ();
  499. SetNeedsLayout ();
  500. SetNeedsDisplay ();
  501. }
  502. if (IsInitialized
  503. && SuperView != null
  504. && LayoutStyle == LayoutStyle.Computed && (SuperView?.Height is Dim.DimAuto || SuperView?.Width is Dim.DimAuto)) {
  505. // DimAuto is in play, force a layout.
  506. // BUGBUG: This can cause LayoutSubviews to be called recursively resulting in a deadlock.
  507. // SetNeedsLayout should be sufficient, but it's not.
  508. SuperView.LayoutSubviews ();
  509. }
  510. }
  511. internal bool LayoutNeeded { get; private set; } = true;
  512. internal void SetNeedsLayout ()
  513. {
  514. if (LayoutNeeded) {
  515. return;
  516. }
  517. LayoutNeeded = true;
  518. foreach (var view in Subviews) {
  519. view.SetNeedsLayout ();
  520. }
  521. TextFormatter.NeedsFormat = true;
  522. SuperView?.SetNeedsLayout ();
  523. }
  524. /// <summary>
  525. /// Indicates that the view does not need to be laid out.
  526. /// </summary>
  527. protected void ClearLayoutNeeded () => LayoutNeeded = false;
  528. /// <summary>
  529. /// Converts a screen-relative coordinate to a Frame-relative coordinate. Frame-relative means
  530. /// relative to the View's <see cref="SuperView"/>'s <see cref="Bounds"/>.
  531. /// </summary>
  532. /// <returns>The coordinate relative to the <see cref="SuperView"/>'s <see cref="Bounds"/>.</returns>
  533. /// <param name="x">Screen-relative column.</param>
  534. /// <param name="y">Screen-relative row.</param>
  535. public Point ScreenToFrame (int x, int y)
  536. {
  537. var superViewBoundsOffset = SuperView?.GetBoundsOffset () ?? Point.Empty;
  538. var ret = new Point (x - Frame.X - superViewBoundsOffset.X, y - Frame.Y - superViewBoundsOffset.Y);
  539. if (SuperView != null) {
  540. var superFrame = SuperView.ScreenToFrame (x - superViewBoundsOffset.X, y - superViewBoundsOffset.Y);
  541. ret = new Point (superFrame.X - Frame.X, superFrame.Y - Frame.Y);
  542. }
  543. return ret;
  544. }
  545. /// <summary>
  546. /// Converts a screen-relative coordinate to a bounds-relative coordinate.
  547. /// </summary>
  548. /// <returns>The coordinate relative to this view's <see cref="Bounds"/>.</returns>
  549. /// <param name="x">Screen-relative column.</param>
  550. /// <param name="y">Screen-relative row.</param>
  551. public Point ScreenToBounds (int x, int y)
  552. {
  553. var screen = ScreenToFrame (x, y);
  554. var boundsOffset = GetBoundsOffset ();
  555. return new Point (screen.X - boundsOffset.X, screen.Y - boundsOffset.Y);
  556. }
  557. /// <summary>
  558. /// Converts a <see cref="Bounds"/>-relative coordinate to a screen-relative coordinate. The output is optionally clamped to the screen dimensions.
  559. /// </summary>
  560. /// <param name="x"><see cref="Bounds"/>-relative column.</param>
  561. /// <param name="y"><see cref="Bounds"/>-relative row.</param>
  562. /// <param name="rx">Absolute column; screen-relative.</param>
  563. /// <param name="ry">Absolute row; screen-relative.</param>
  564. /// <param name="clamped">If <see langword="true"/>, <paramref name="rx"/> and <paramref name="ry"/> will be clamped to the
  565. /// screen dimensions (will never be negative and will always be less than <see cref="ConsoleDriver.Cols"/> and
  566. /// <see cref="ConsoleDriver.Rows"/>, respectively.</param>
  567. public virtual void BoundsToScreen (int x, int y, out int rx, out int ry, bool clamped = true)
  568. {
  569. var boundsOffset = GetBoundsOffset ();
  570. rx = x + Frame.X + boundsOffset.X;
  571. ry = y + Frame.Y + boundsOffset.Y;
  572. var super = SuperView;
  573. while (super != null) {
  574. boundsOffset = super.GetBoundsOffset ();
  575. rx += super.Frame.X + boundsOffset.X;
  576. ry += super.Frame.Y + boundsOffset.Y;
  577. super = super.SuperView;
  578. }
  579. // The following ensures that the cursor is always in the screen boundaries.
  580. if (clamped) {
  581. ry = Math.Min (ry, Driver.Rows - 1);
  582. rx = Math.Min (rx, Driver.Cols - 1);
  583. }
  584. }
  585. /// <summary>
  586. /// Converts a <see cref="Bounds"/>-relative region to a screen-relative region.
  587. /// </summary>
  588. public Rect BoundsToScreen (Rect region)
  589. {
  590. BoundsToScreen (region.X, region.Y, out int x, out int y, false);
  591. return new Rect (x, y, region.Width, region.Height);
  592. }
  593. /// <summary>
  594. /// Gets the <see cref="Frame"/> with a screen-relative location.
  595. /// </summary>
  596. /// <returns>The location and size of the view in screen-relative coordinates.</returns>
  597. public virtual Rect FrameToScreen ()
  598. {
  599. var ret = Frame;
  600. var super = SuperView;
  601. while (super != null) {
  602. var boundsOffset = super.GetBoundsOffset ();
  603. ret.X += super.Frame.X + boundsOffset.X;
  604. ret.Y += super.Frame.Y + boundsOffset.Y;
  605. super = super.SuperView;
  606. }
  607. return ret;
  608. }
  609. // TODO: Come up with a better name for this method. "SetRelativeLayout" lacks clarity and confuses. AdjustSizeAndPosition?
  610. /// <summary>
  611. /// Applies the view's position (<see cref="X"/>, <see cref="Y"/>) and dimension (<see cref="Width"/>, and <see cref="Height"/>) to
  612. /// <see cref="Frame"/>, given a rectangle describing the SuperView's Bounds (nominally the same as <c>this.SuperView.Bounds</c>).
  613. /// </summary>
  614. /// <param name="superviewBounds">The rectangle describing the SuperView's Bounds (nominally the same as <c>this.SuperView.Bounds</c>).</param>
  615. internal void SetRelativeLayout (Rect superviewBounds)
  616. {
  617. int newX, newW, newY, newH;
  618. var autosize = Size.Empty;
  619. if (AutoSize) {
  620. // Note this is global to this function and used as such within the local functions defined
  621. // below. In v2 AutoSize will be re-factored to not need to be dealt with in this function.
  622. autosize = GetAutoSize ();
  623. }
  624. // Returns the new dimension (width or height) and location (x or y) for the View given
  625. // the superview's Bounds
  626. // the current Pos (View.X or View.Y)
  627. // the current Dim (View.Width or View.Height)
  628. // This method is called recursively if pos is Pos.PosCombine
  629. (int newLocation, int newDimension) GetNewLocationAndDimension (bool width, Rect superviewBounds, Pos pos, Dim dim, int autosizeDimension)
  630. {
  631. // Gets the new dimension (width or height, dependent on `width`) of the given Dim given:
  632. // location: the current location (x or y)
  633. // dimension: the current dimension (width or height)
  634. // autosize: the size to use if autosize = true
  635. // This mehod is recursive if d is Dim.DimCombine
  636. int GetNewDimension (Dim d, int location, int dimension, int autosize)
  637. {
  638. int newDimension;
  639. switch (d) {
  640. case null:
  641. // dim == null is the same as dim == Dim.FIll (0)
  642. newDimension = AutoSize ? autosize : dimension;
  643. break;
  644. case Dim.DimCombine combine:
  645. int leftNewDim = GetNewDimension (combine._left, location, dimension, autosize);
  646. int rightNewDim = GetNewDimension (combine._right, location, dimension, autosize);
  647. if (combine._add) {
  648. newDimension = leftNewDim + rightNewDim;
  649. } else {
  650. newDimension = leftNewDim - rightNewDim;
  651. }
  652. newDimension = AutoSize && autosize > newDimension ? autosize : newDimension;
  653. break;
  654. case Dim.DimFactor factor when !factor.IsFromRemaining ():
  655. newDimension = d.Anchor (dimension);
  656. newDimension = AutoSize && autosize > newDimension ? autosize : newDimension;
  657. break;
  658. case Dim.DimAuto auto:
  659. var thickness = GetFramesThickness ();
  660. newDimension = GetNewDimension (auto._min, location, dimension, autosize);
  661. if (width) {
  662. int furthestRight = Subviews.Count == 0 ? 0 : Subviews.Max (v => v.Frame.X + v.Frame.Width);
  663. //Debug.Assert(superviewBounds.Width == (SuperView?.Bounds.Width ?? 0));
  664. newDimension = int.Max (furthestRight + thickness.Left + thickness.Right, auto._min?.Anchor (superviewBounds.Width) ?? 0);
  665. } else {
  666. int furthestBottom = Subviews.Count == 0 ? 0 : Subviews.Max (v => v.Frame.Y + v.Frame.Height);
  667. //Debug.Assert (superviewBounds.Height == (SuperView?.Bounds.Height ?? 0));
  668. newDimension = int.Max (furthestBottom + thickness.Top + thickness.Bottom, auto._min?.Anchor (superviewBounds.Height) ?? 0);
  669. }
  670. break;
  671. case Dim.DimFill:
  672. default:
  673. newDimension = Math.Max (d.Anchor (dimension - location), 0);
  674. newDimension = AutoSize && autosize > newDimension ? autosize : newDimension;
  675. break;
  676. }
  677. return newDimension;
  678. }
  679. int newDimension, newLocation;
  680. int superviewDimension = width ? superviewBounds.Width : superviewBounds.Height;
  681. // Determine new location
  682. switch (pos) {
  683. case Pos.PosCenter posCenter:
  684. if (dim == null) {
  685. // BUGBUG: In what situation is dim == null here? None that I can find.
  686. // dim == null is the same as dim == Dim.FIll (0)
  687. throw new ArgumentException ();
  688. newDimension = AutoSize ? autosizeDimension : superviewDimension;
  689. newLocation = posCenter.Anchor (superviewDimension - newDimension);
  690. } else {
  691. //newLocation = posCenter?.Anchor (superviewDimension) ?? 0;
  692. //newDimension = Math.Max (GetNewDimension (dim, newLocation, superviewDimension, autosizeDimension), 0);
  693. newDimension = posCenter.Anchor (superviewDimension);
  694. newDimension = AutoSize && autosizeDimension > newDimension ? autosizeDimension : newDimension;
  695. newLocation = posCenter.Anchor (superviewDimension - newDimension);
  696. }
  697. break;
  698. case Pos.PosCombine combine:
  699. int left, right;
  700. (left, newDimension) = GetNewLocationAndDimension (width, superviewBounds, combine._left, dim, autosizeDimension);
  701. (right, newDimension) = GetNewLocationAndDimension (width, superviewBounds, combine._right, dim, autosizeDimension);
  702. if (combine._add) {
  703. newLocation = left + right;
  704. } else {
  705. newLocation = left - right;
  706. }
  707. newDimension = Math.Max (GetNewDimension (dim, newLocation, superviewDimension, autosizeDimension), 0);
  708. break;
  709. case Pos.PosAnchorEnd:
  710. case Pos.PosAbsolute:
  711. case null:
  712. case Pos.PosFactor:
  713. case Pos.PosFunc:
  714. case Pos.PosView:
  715. default:
  716. newLocation = pos?.Anchor (superviewDimension) ?? 0;
  717. newDimension = Math.Max (GetNewDimension (dim, newLocation, superviewDimension, autosizeDimension), 0);
  718. break;
  719. }
  720. return (newLocation, newDimension);
  721. }
  722. // horizontal/width
  723. (newX, newW) = GetNewLocationAndDimension (true, superviewBounds, _x, _width, autosize.Width);
  724. // vertical/height
  725. (newY, newH) = GetNewLocationAndDimension (false, superviewBounds, _y, _height, autosize.Height);
  726. var r = new Rect (newX, newY, newW, newH);
  727. if (Frame != r) {
  728. Frame = r;
  729. // BUGBUG: Why is this AFTER setting Frame? Seems duplicative.
  730. if (!SetFrameToFitText ()) {
  731. TextFormatter.Size = GetTextFormatterSizeNeededForTextAndHotKey ();
  732. }
  733. }
  734. }
  735. /// <summary>
  736. /// Fired after the View's <see cref="LayoutSubviews"/> method has completed.
  737. /// </summary>
  738. /// <remarks>
  739. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  740. /// </remarks>
  741. public event EventHandler<LayoutEventArgs> LayoutStarted;
  742. /// <summary>
  743. /// Raises the <see cref="LayoutStarted"/> event. Called from <see cref="LayoutSubviews"/> before any subviews have been laid out.
  744. /// </summary>
  745. internal virtual void OnLayoutStarted (LayoutEventArgs args) => LayoutStarted?.Invoke (this, args);
  746. /// <summary>
  747. /// Fired after the View's <see cref="LayoutSubviews"/> method has completed.
  748. /// </summary>
  749. /// <remarks>
  750. /// Subscribe to this event to perform tasks when the <see cref="View"/> has been resized or the layout has otherwise changed.
  751. /// </remarks>
  752. public event EventHandler<LayoutEventArgs> LayoutComplete;
  753. /// <summary>
  754. /// Event called only once when the <see cref="View"/> is being initialized for the first time.
  755. /// Allows configurations and assignments to be performed before the <see cref="View"/> being shown.
  756. /// This derived from <see cref="ISupportInitializeNotification"/> to allow notify all the views that are being initialized.
  757. /// </summary>
  758. public event EventHandler Initialized;
  759. /// <summary>
  760. /// Raises the <see cref="LayoutComplete"/> event. Called from <see cref="LayoutSubviews"/> before all sub-views have been laid out.
  761. /// </summary>
  762. internal virtual void OnLayoutComplete (LayoutEventArgs args) => LayoutComplete?.Invoke (this, args);
  763. internal void CollectPos (Pos pos, View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  764. {
  765. switch (pos) {
  766. case Pos.PosView pv:
  767. // See #2461
  768. //if (!from.InternalSubviews.Contains (pv.Target)) {
  769. // throw new InvalidOperationException ($"View {pv.Target} is not a subview of {from}");
  770. //}
  771. if (pv.Target != this) {
  772. nEdges.Add ((pv.Target, from));
  773. }
  774. return;
  775. case Pos.PosCombine pc:
  776. CollectPos (pc._left, from, ref nNodes, ref nEdges);
  777. CollectPos (pc._right, from, ref nNodes, ref nEdges);
  778. break;
  779. }
  780. }
  781. internal void CollectDim (Dim dim, View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  782. {
  783. switch (dim) {
  784. case Dim.DimView dv:
  785. // See #2461
  786. //if (!from.InternalSubviews.Contains (dv.Target)) {
  787. // throw new InvalidOperationException ($"View {dv.Target} is not a subview of {from}");
  788. //}
  789. if (dv.Target != this) {
  790. nEdges.Add ((dv.Target, from));
  791. }
  792. return;
  793. case Dim.DimCombine dc:
  794. CollectDim (dc._left, from, ref nNodes, ref nEdges);
  795. CollectDim (dc._right, from, ref nNodes, ref nEdges);
  796. break;
  797. }
  798. }
  799. internal void CollectAll (View from, ref HashSet<View> nNodes, ref HashSet<(View, View)> nEdges)
  800. {
  801. // BUGBUG: This should really only work on initialized subviews
  802. foreach (var v in from.InternalSubviews /*.Where(v => v.IsInitialized)*/) {
  803. nNodes.Add (v);
  804. if (v._layoutStyle != LayoutStyle.Computed) {
  805. continue;
  806. }
  807. CollectPos (v.X, v, ref nNodes, ref nEdges);
  808. CollectPos (v.Y, v, ref nNodes, ref nEdges);
  809. CollectDim (v.Width, v, ref nNodes, ref nEdges);
  810. CollectDim (v.Height, v, ref nNodes, ref nEdges);
  811. }
  812. }
  813. // https://en.wikipedia.org/wiki/Topological_sorting
  814. internal static List<View> TopologicalSort (View superView, IEnumerable<View> nodes, ICollection<(View From, View To)> edges)
  815. {
  816. var result = new List<View> ();
  817. // Set of all nodes with no incoming edges
  818. var noEdgeNodes = new HashSet<View> (nodes.Where (n => edges.All (e => !e.To.Equals (n))));
  819. while (noEdgeNodes.Any ()) {
  820. // remove a node n from S
  821. var n = noEdgeNodes.First ();
  822. noEdgeNodes.Remove (n);
  823. // add n to tail of L
  824. if (n != superView) {
  825. result.Add (n);
  826. }
  827. // for each node m with an edge e from n to m do
  828. foreach (var e in edges.Where (e => e.From.Equals (n)).ToArray ()) {
  829. var m = e.To;
  830. // remove edge e from the graph
  831. edges.Remove (e);
  832. // if m has no other incoming edges then
  833. if (edges.All (me => !me.To.Equals (m)) && m != superView) {
  834. // insert m into S
  835. noEdgeNodes.Add (m);
  836. }
  837. }
  838. }
  839. if (!edges.Any ()) {
  840. return result;
  841. }
  842. foreach ((var from, var to) in edges) {
  843. if (from == to) {
  844. // if not yet added to the result, add it and remove from edge
  845. if (result.Find (v => v == from) == null) {
  846. result.Add (from);
  847. }
  848. edges.Remove ((from, to));
  849. } else if (from.SuperView == to.SuperView) {
  850. // if 'from' is not yet added to the result, add it
  851. if (result.Find (v => v == from) == null) {
  852. result.Add (from);
  853. }
  854. // if 'to' is not yet added to the result, add it
  855. if (result.Find (v => v == to) == null) {
  856. result.Add (to);
  857. }
  858. // remove from edge
  859. edges.Remove ((from, to));
  860. } else if (from != superView?.GetTopSuperView (to, from) && !ReferenceEquals (from, to)) {
  861. if (ReferenceEquals (from.SuperView, to)) {
  862. throw new InvalidOperationException ($"ComputedLayout for \"{superView}\": \"{to}\" references a SubView (\"{from}\").");
  863. } else {
  864. throw new InvalidOperationException ($"ComputedLayout for \"{superView}\": \"{from}\" linked with \"{to}\" was not found. Did you forget to add it to {superView}?");
  865. }
  866. }
  867. }
  868. // return L (a topologically sorted order)
  869. return result;
  870. } // TopologicalSort
  871. /// <summary>
  872. /// Overriden by <see cref="Frame"/> to do nothing, as the <see cref="Frame"/> does not have frames.
  873. /// </summary>
  874. internal virtual void LayoutFrames ()
  875. {
  876. if (Margin == null) {
  877. return; // CreateFrames() has not been called yet
  878. }
  879. if (Margin.Frame.Size != Frame.Size) {
  880. Margin._frame = new Rect (Point.Empty, Frame.Size);
  881. Margin.X = 0;
  882. Margin.Y = 0;
  883. Margin.Width = Frame.Size.Width;
  884. Margin.Height = Frame.Size.Height;
  885. Margin.SetNeedsLayout ();
  886. Margin.LayoutSubviews ();
  887. Margin.SetNeedsDisplay ();
  888. }
  889. var border = Margin.Thickness.GetInside (Margin.Frame);
  890. if (border != Border.Frame) {
  891. Border._frame = new Rect (new Point (border.Location.X, border.Location.Y), border.Size);
  892. Border.X = border.Location.X;
  893. Border.Y = border.Location.Y;
  894. Border.Width = border.Size.Width;
  895. Border.Height = border.Size.Height;
  896. Border.SetNeedsLayout ();
  897. Border.LayoutSubviews ();
  898. Border.SetNeedsDisplay ();
  899. }
  900. var padding = Border.Thickness.GetInside (Border.Frame);
  901. if (padding != Padding.Frame) {
  902. Padding._frame = new Rect (new Point (padding.Location.X, padding.Location.Y), padding.Size);
  903. Padding.X = padding.Location.X;
  904. Padding.Y = padding.Location.Y;
  905. Padding.Width = padding.Size.Width;
  906. Padding.Height = padding.Size.Height;
  907. Padding.SetNeedsLayout ();
  908. Padding.LayoutSubviews ();
  909. Padding.SetNeedsDisplay ();
  910. }
  911. }
  912. /// <summary>
  913. /// Invoked when a view starts executing or when the dimensions of the view have changed, for example in
  914. /// response to the container view or terminal resizing.
  915. /// </summary>
  916. /// <remarks>
  917. /// Raises the <see cref="LayoutComplete"/> event) before it returns.
  918. /// </remarks>
  919. public virtual void LayoutSubviews ()
  920. {
  921. if (!IsInitialized) {
  922. Debug.WriteLine ($"WARNING: LayoutSubviews called before view has been initialized. This is likely a bug in {this}");
  923. }
  924. if (!LayoutNeeded) {
  925. return;
  926. }
  927. CheckDimAuto ();
  928. LayoutFrames ();
  929. var oldBounds = Bounds;
  930. OnLayoutStarted (new LayoutEventArgs () { OldBounds = oldBounds });
  931. TextFormatter.Size = GetTextFormatterSizeNeededForTextAndHotKey ();
  932. // Sort out the dependencies of the X, Y, Width, Height properties
  933. var nodes = new HashSet<View> ();
  934. var edges = new HashSet<(View, View)> ();
  935. CollectAll (this, ref nodes, ref edges);
  936. var ordered = TopologicalSort (SuperView, nodes, edges);
  937. foreach (var v in ordered) {
  938. if (v.Width is Dim.DimAuto || v.Height is Dim.DimAuto) {
  939. // If the view is auto-sized...
  940. var f = v.Frame;
  941. LayoutSubview (v, new Rect (GetBoundsOffset (), Bounds.Size));
  942. if (v.Frame != f) {
  943. // The subviews changed; do it again
  944. v.LayoutNeeded = true;
  945. LayoutSubview (v, new Rect (GetBoundsOffset (), Bounds.Size));
  946. }
  947. } else {
  948. LayoutSubview (v, new Rect (GetBoundsOffset (), Bounds.Size));
  949. }
  950. }
  951. // If the 'to' is rooted to 'from' and the layoutstyle is Computed it's a special-case.
  952. // Use LayoutSubview with the Frame of the 'from'
  953. if (SuperView != null && GetTopSuperView () != null && LayoutNeeded && edges.Count > 0) {
  954. foreach ((var from, var to) in edges) {
  955. LayoutSubview (to, from.Frame);
  956. }
  957. }
  958. LayoutNeeded = false;
  959. OnLayoutComplete (new LayoutEventArgs () { OldBounds = oldBounds });
  960. }
  961. void LayoutSubview (View v, Rect contentArea)
  962. {
  963. if (v.LayoutStyle == LayoutStyle.Computed) {
  964. v.SetRelativeLayout (contentArea);
  965. }
  966. v.LayoutSubviews ();
  967. v.LayoutNeeded = false;
  968. }
  969. bool _autoSize;
  970. /// <summary>
  971. /// Gets or sets a flag that determines whether the View will be automatically resized to fit the <see cref="Text"/>
  972. /// within <see cref="Bounds"/>
  973. /// <para>
  974. /// The default is <see langword="false"/>. Set to <see langword="true"/> to turn on AutoSize. If <see langword="true"/> then
  975. /// <see cref="Width"/> and <see cref="Height"/> will be used if <see cref="Text"/> can fit;
  976. /// if <see cref="Text"/> won't fit the view will be resized as needed.
  977. /// </para>
  978. /// <para>
  979. /// In addition, if <see cref="ValidatePosDim"/> is <see langword="true"/> the new values of <see cref="Width"/> and
  980. /// <see cref="Height"/> must be of the same types of the existing one to avoid breaking the <see cref="Dim"/> settings.
  981. /// </para>
  982. /// </summary>
  983. public virtual bool AutoSize {
  984. get => _autoSize;
  985. set {
  986. bool v = ResizeView (value);
  987. TextFormatter.AutoSize = v;
  988. if (_autoSize != v) {
  989. _autoSize = v;
  990. TextFormatter.NeedsFormat = true;
  991. UpdateTextFormatterText ();
  992. OnResizeNeeded ();
  993. }
  994. }
  995. }
  996. bool ResizeView (bool autoSize)
  997. {
  998. if (!autoSize) {
  999. return false;
  1000. }
  1001. bool boundsChanged = true;
  1002. var newFrameSize = GetAutoSize ();
  1003. if (IsInitialized && newFrameSize != Frame.Size) {
  1004. if (ValidatePosDim) {
  1005. // BUGBUG: This ain't right, obviously. We need to figure out how to handle this.
  1006. boundsChanged = ResizeBoundsToFit (newFrameSize);
  1007. } else {
  1008. Height = newFrameSize.Height;
  1009. Width = newFrameSize.Width;
  1010. }
  1011. }
  1012. // BUGBUG: This call may be redundant
  1013. TextFormatter.Size = GetTextFormatterSizeNeededForTextAndHotKey ();
  1014. return boundsChanged;
  1015. }
  1016. /// <summary>
  1017. /// Resizes the View to fit the specified size. Factors in the HotKey.
  1018. /// </summary>
  1019. /// <param name="size"></param>
  1020. /// <returns>whether the Bounds was changed or not</returns>
  1021. bool ResizeBoundsToFit (Size size)
  1022. {
  1023. bool boundsChanged = false;
  1024. bool canSizeW = TrySetWidth (size.Width - GetHotKeySpecifierLength (), out int rW);
  1025. bool canSizeH = TrySetHeight (size.Height - GetHotKeySpecifierLength (false), out int rH);
  1026. if (canSizeW) {
  1027. boundsChanged = true;
  1028. _width = rW;
  1029. }
  1030. if (canSizeH) {
  1031. boundsChanged = true;
  1032. _height = rH;
  1033. }
  1034. if (boundsChanged) {
  1035. Bounds = new Rect (Bounds.X, Bounds.Y, canSizeW ? rW : Bounds.Width, canSizeH ? rH : Bounds.Height);
  1036. }
  1037. return boundsChanged;
  1038. }
  1039. /// <summary>
  1040. /// Gets the Frame dimensions required to fit <see cref="Text"/> within <see cref="Bounds"/> using the text <see cref="Direction"/> specified by the
  1041. /// <see cref="TextFormatter"/> property and accounting for any <see cref="HotKeySpecifier"/> characters.
  1042. /// </summary>
  1043. /// <returns>The <see cref="Size"/> of the view required to fit the text.</returns>
  1044. public Size GetAutoSize ()
  1045. {
  1046. int x = 0;
  1047. int y = 0;
  1048. if (IsInitialized) {
  1049. x = Bounds.X;
  1050. y = Bounds.Y;
  1051. }
  1052. var rect = TextFormatter.CalcRect (x, y, TextFormatter.Text, TextFormatter.Direction);
  1053. int newWidth = rect.Size.Width - GetHotKeySpecifierLength () + Margin.Thickness.Horizontal + Border.Thickness.Horizontal + Padding.Thickness.Horizontal;
  1054. int newHeight = rect.Size.Height - GetHotKeySpecifierLength (false) + Margin.Thickness.Vertical + Border.Thickness.Vertical + Padding.Thickness.Vertical;
  1055. return new Size (newWidth, newHeight);
  1056. }
  1057. bool IsValidAutoSize (out Size autoSize)
  1058. {
  1059. var rect = TextFormatter.CalcRect (_frame.X, _frame.Y, TextFormatter.Text, TextDirection);
  1060. autoSize = new Size (rect.Size.Width - GetHotKeySpecifierLength (),
  1061. rect.Size.Height - GetHotKeySpecifierLength (false));
  1062. return !(ValidatePosDim && (!(Width is Dim.DimAbsolute) || !(Height is Dim.DimAbsolute))
  1063. || _frame.Size.Width != rect.Size.Width - GetHotKeySpecifierLength ()
  1064. || _frame.Size.Height != rect.Size.Height - GetHotKeySpecifierLength (false));
  1065. }
  1066. bool IsValidAutoSizeWidth (Dim width)
  1067. {
  1068. var rect = TextFormatter.CalcRect (_frame.X, _frame.Y, TextFormatter.Text, TextDirection);
  1069. int dimValue = width.Anchor (0);
  1070. return !(ValidatePosDim && !(width is Dim.DimAbsolute) || dimValue != rect.Size.Width
  1071. - GetHotKeySpecifierLength ());
  1072. }
  1073. bool IsValidAutoSizeHeight (Dim height)
  1074. {
  1075. var rect = TextFormatter.CalcRect (_frame.X, _frame.Y, TextFormatter.Text, TextDirection);
  1076. int dimValue = height.Anchor (0);
  1077. return !(ValidatePosDim && !(height is Dim.DimAbsolute) || dimValue != rect.Size.Height
  1078. - GetHotKeySpecifierLength (false));
  1079. }
  1080. /// <summary>
  1081. /// Determines if the View's <see cref="Width"/> can be set to a new value.
  1082. /// </summary>
  1083. /// <param name="desiredWidth"></param>
  1084. /// <param name="resultWidth">Contains the width that would result if <see cref="Width"/> were set to <paramref name="desiredWidth"/>"/> </param>
  1085. /// <returns><see langword="true"/> if the View's <see cref="Width"/> can be changed to the specified value. False otherwise.</returns>
  1086. internal bool TrySetWidth (int desiredWidth, out int resultWidth)
  1087. {
  1088. int w = desiredWidth;
  1089. bool canSetWidth;
  1090. switch (Width) {
  1091. case Dim.DimCombine _:
  1092. case Dim.DimView _:
  1093. case Dim.DimFill _:
  1094. // It's a Dim.DimCombine and so can't be assigned. Let it have it's Width anchored.
  1095. w = Width.Anchor (w);
  1096. canSetWidth = !ValidatePosDim;
  1097. break;
  1098. case Dim.DimFactor factor:
  1099. // Tries to get the SuperView Width otherwise the view Width.
  1100. int sw = SuperView != null ? SuperView.Frame.Width : w;
  1101. if (factor.IsFromRemaining ()) {
  1102. sw -= Frame.X;
  1103. }
  1104. w = Width.Anchor (sw);
  1105. canSetWidth = !ValidatePosDim;
  1106. break;
  1107. default:
  1108. canSetWidth = true;
  1109. break;
  1110. }
  1111. resultWidth = w;
  1112. return canSetWidth;
  1113. }
  1114. /// <summary>
  1115. /// Determines if the View's <see cref="Height"/> can be set to a new value.
  1116. /// </summary>
  1117. /// <param name="desiredHeight"></param>
  1118. /// <param name="resultHeight">Contains the width that would result if <see cref="Height"/> were set to <paramref name="desiredHeight"/>"/> </param>
  1119. /// <returns><see langword="true"/> if the View's <see cref="Height"/> can be changed to the specified value. False otherwise.</returns>
  1120. internal bool TrySetHeight (int desiredHeight, out int resultHeight)
  1121. {
  1122. int h = desiredHeight;
  1123. bool canSetHeight;
  1124. switch (Height) {
  1125. case Dim.DimCombine _:
  1126. case Dim.DimView _:
  1127. case Dim.DimFill _:
  1128. // It's a Dim.DimCombine and so can't be assigned. Let it have it's height anchored.
  1129. h = Height.Anchor (h);
  1130. canSetHeight = !ValidatePosDim;
  1131. break;
  1132. case Dim.DimFactor factor:
  1133. // Tries to get the SuperView height otherwise the view height.
  1134. int sh = SuperView != null ? SuperView.Frame.Height : h;
  1135. if (factor.IsFromRemaining ()) {
  1136. sh -= Frame.Y;
  1137. }
  1138. h = Height.Anchor (sh);
  1139. canSetHeight = !ValidatePosDim;
  1140. break;
  1141. default:
  1142. canSetHeight = true;
  1143. break;
  1144. }
  1145. resultHeight = h;
  1146. return canSetHeight;
  1147. }
  1148. /// <summary>
  1149. /// Finds which view that belong to the <paramref name="start"/> superview at the provided location.
  1150. /// </summary>
  1151. /// <param name="start">The superview where to look for.</param>
  1152. /// <param name="x">The column location in the superview.</param>
  1153. /// <param name="y">The row location in the superview.</param>
  1154. /// <param name="resx">The found view screen relative column location.</param>
  1155. /// <param name="resy">The found view screen relative row location.</param>
  1156. /// <returns>
  1157. /// The view that was found at the <praramref name="x"/> and <praramref name="y"/> coordinates.
  1158. /// <see langword="null"/> if no view was found.
  1159. /// </returns>
  1160. public static View FindDeepestView (View start, int x, int y, out int resx, out int resy)
  1161. {
  1162. resy = resx = 0;
  1163. if (start == null || !start.Frame.Contains (x, y)) {
  1164. return null;
  1165. }
  1166. var startFrame = start.Frame;
  1167. if (start.InternalSubviews != null) {
  1168. int count = start.InternalSubviews.Count;
  1169. if (count > 0) {
  1170. var boundsOffset = start.GetBoundsOffset ();
  1171. int rx = x - (startFrame.X + boundsOffset.X);
  1172. int ry = y - (startFrame.Y + boundsOffset.Y);
  1173. for (int i = count - 1; i >= 0; i--) {
  1174. var v = start.InternalSubviews [i];
  1175. if (v.Visible && v.Frame.Contains (rx, ry)) {
  1176. var deep = FindDeepestView (v, rx, ry, out resx, out resy);
  1177. if (deep == null) {
  1178. return v;
  1179. }
  1180. return deep;
  1181. }
  1182. }
  1183. }
  1184. }
  1185. resx = x - startFrame.X;
  1186. resy = y - startFrame.Y;
  1187. return start;
  1188. }
  1189. }