ViewLayout.cs 59 KB

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