ViewLayout.cs 50 KB

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