ViewLayout.cs 59 KB

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