ViewLayout.cs 57 KB

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