ViewLayout.cs 65 KB

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