TreeViewFileSystem.cs 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. using System;
  2. using System.Collections.Generic;
  3. using System.IO;
  4. using System.Linq;
  5. using Terminal.Gui;
  6. using Terminal.Gui.Trees;
  7. namespace UICatalog.Scenarios {
  8. [ScenarioMetadata (Name: "TreeViewFileSystem", Description: "Hierarchical file system explorer based on TreeView.")]
  9. [ScenarioCategory ("Controls"), ScenarioCategory ("TreeView"), ScenarioCategory ("Files and IO")]
  10. public class TreeViewFileSystem : Scenario {
  11. /// <summary>
  12. /// A tree view where nodes are files and folders
  13. /// </summary>
  14. TreeView<FileSystemInfo> treeViewFiles;
  15. MenuItem miShowLines;
  16. private MenuItem miPlusMinus;
  17. private MenuItem miArrowSymbols;
  18. private MenuItem miNoSymbols;
  19. private MenuItem miColoredSymbols;
  20. private MenuItem miInvertSymbols;
  21. private MenuItem miUnicodeSymbols;
  22. private MenuItem miFullPaths;
  23. private MenuItem miLeaveLastRow;
  24. private MenuItem miCustomColors;
  25. private Terminal.Gui.Attribute green;
  26. private Terminal.Gui.Attribute red;
  27. public override void Setup ()
  28. {
  29. Win.Title = this.GetName ();
  30. Win.Y = 1; // menu
  31. Win.Height = Dim.Fill (1); // status bar
  32. Top.LayoutSubviews ();
  33. var menu = new MenuBar (new MenuBarItem [] {
  34. new MenuBarItem ("_File", new MenuItem [] {
  35. new MenuItem ("_Quit", "", () => Quit()),
  36. }),
  37. new MenuBarItem ("_View", new MenuItem [] {
  38. miShowLines = new MenuItem ("_ShowLines", "", () => ShowLines()){
  39. Checked = true, CheckType = MenuItemCheckStyle.Checked
  40. },
  41. null /*separator*/,
  42. miPlusMinus = new MenuItem ("_PlusMinusSymbols", "", () => SetExpandableSymbols('+','-')){Checked = true, CheckType = MenuItemCheckStyle.Radio},
  43. miArrowSymbols = new MenuItem ("_ArrowSymbols", "", () => SetExpandableSymbols('>','v')){Checked = false, CheckType = MenuItemCheckStyle.Radio},
  44. miNoSymbols = new MenuItem ("_NoSymbols", "", () => SetExpandableSymbols(null,null)){Checked = false, CheckType = MenuItemCheckStyle.Radio},
  45. miUnicodeSymbols = new MenuItem ("_Unicode", "", () => SetExpandableSymbols('ஹ','﷽')){Checked = false, CheckType = MenuItemCheckStyle.Radio},
  46. null /*separator*/,
  47. miColoredSymbols = new MenuItem ("_ColoredSymbols", "", () => ShowColoredExpandableSymbols()){Checked = false, CheckType = MenuItemCheckStyle.Checked},
  48. miInvertSymbols = new MenuItem ("_InvertSymbols", "", () => InvertExpandableSymbols()){Checked = false, CheckType = MenuItemCheckStyle.Checked},
  49. miFullPaths = new MenuItem ("_FullPaths", "", () => SetFullName()){Checked = false, CheckType = MenuItemCheckStyle.Checked},
  50. miLeaveLastRow = new MenuItem ("_LeaveLastRow", "", () => SetLeaveLastRow()){Checked = true, CheckType = MenuItemCheckStyle.Checked},
  51. miCustomColors = new MenuItem ("C_ustomColors", "", () => SetCustomColors()){Checked = false, CheckType = MenuItemCheckStyle.Checked},
  52. }),
  53. });
  54. Top.Add (menu);
  55. var statusBar = new StatusBar (new StatusItem [] {
  56. new StatusItem(Key.CtrlMask | Key.Q, "~^Q~ Quit", () => Quit()),
  57. });
  58. Top.Add (statusBar);
  59. var lblFiles = new Label ("File Tree:") {
  60. X = 0,
  61. Y = 1
  62. };
  63. Win.Add (lblFiles);
  64. treeViewFiles = new TreeView<FileSystemInfo> () {
  65. X = 0,
  66. Y = Pos.Bottom (lblFiles),
  67. Width = Dim.Fill (),
  68. Height = Dim.Fill (),
  69. };
  70. treeViewFiles.ObjectActivated += TreeViewFiles_ObjectActivated;
  71. treeViewFiles.MouseClick += TreeViewFiles_MouseClick;
  72. treeViewFiles.KeyPress += TreeViewFiles_KeyPress;
  73. SetupFileTree ();
  74. Win.Add (treeViewFiles);
  75. SetupScrollBar ();
  76. green = Application.Driver.MakeAttribute (Color.Green, Color.Blue);
  77. red = Application.Driver.MakeAttribute (Color.Red, Color.Blue);
  78. }
  79. private void TreeViewFiles_KeyPress (View.KeyEventEventArgs obj)
  80. {
  81. if(obj.KeyEvent.Key == (Key.R | Key.CtrlMask)) {
  82. var selected = treeViewFiles.SelectedObject;
  83. // nothing is selected
  84. if (selected == null)
  85. return;
  86. var location = treeViewFiles.IndexOf (selected);
  87. //selected object is offscreen or somehow not found
  88. if (location == null || location < 0 || location > treeViewFiles.Frame.Height)
  89. return;
  90. ShowContextMenu (new Point (
  91. 5 + treeViewFiles.Frame.X,
  92. location.Value + treeViewFiles.Frame.Y + 2),
  93. selected);
  94. }
  95. }
  96. private void TreeViewFiles_MouseClick (View.MouseEventArgs obj)
  97. {
  98. // if user right clicks
  99. if (obj.MouseEvent.Flags.HasFlag(MouseFlags.Button3Clicked)) {
  100. var rightClicked = treeViewFiles.HitTest (new Point (obj.MouseEvent.X, obj.MouseEvent.Y));
  101. // nothing was clicked
  102. if (rightClicked == null)
  103. return;
  104. ShowContextMenu (new Point (
  105. obj.MouseEvent.X + treeViewFiles.Frame.X,
  106. obj.MouseEvent.Y + treeViewFiles.Frame.Y + 2),
  107. rightClicked);
  108. }
  109. }
  110. private void ShowContextMenu (Point screenPoint, FileSystemInfo forObject)
  111. {
  112. var menu = new ContextMenu ();
  113. menu.Position = screenPoint;
  114. menu.MenuItems = new MenuBarItem (new [] { new MenuItem ("Properties", null, () => ShowPropertiesOf (forObject)) });
  115. Application.MainLoop.Invoke(menu.Show);
  116. }
  117. private void ShowPropertiesOf (FileSystemInfo fileSystemInfo)
  118. {
  119. if (fileSystemInfo is FileInfo f) {
  120. System.Text.StringBuilder sb = new System.Text.StringBuilder ();
  121. sb.AppendLine ($"Path:{f.DirectoryName}");
  122. sb.AppendLine ($"Size:{f.Length:N0} bytes");
  123. sb.AppendLine ($"Modified:{ f.LastWriteTime}");
  124. sb.AppendLine ($"Created:{ f.CreationTime}");
  125. MessageBox.Query (f.Name, sb.ToString (), "Close");
  126. }
  127. if (fileSystemInfo is DirectoryInfo dir) {
  128. System.Text.StringBuilder sb = new System.Text.StringBuilder ();
  129. sb.AppendLine ($"Path:{dir.Parent?.FullName}");
  130. sb.AppendLine ($"Modified:{ dir.LastWriteTime}");
  131. sb.AppendLine ($"Created:{ dir.CreationTime}");
  132. MessageBox.Query (dir.Name, sb.ToString (), "Close");
  133. }
  134. }
  135. private void SetupScrollBar ()
  136. {
  137. // When using scroll bar leave the last row of the control free (for over-rendering with scroll bar)
  138. treeViewFiles.Style.LeaveLastRow = true;
  139. var _scrollBar = new ScrollBarView (treeViewFiles, true);
  140. _scrollBar.ChangedPosition += () => {
  141. treeViewFiles.ScrollOffsetVertical = _scrollBar.Position;
  142. if (treeViewFiles.ScrollOffsetVertical != _scrollBar.Position) {
  143. _scrollBar.Position = treeViewFiles.ScrollOffsetVertical;
  144. }
  145. treeViewFiles.SetNeedsDisplay ();
  146. };
  147. _scrollBar.OtherScrollBarView.ChangedPosition += () => {
  148. treeViewFiles.ScrollOffsetHorizontal = _scrollBar.OtherScrollBarView.Position;
  149. if (treeViewFiles.ScrollOffsetHorizontal != _scrollBar.OtherScrollBarView.Position) {
  150. _scrollBar.OtherScrollBarView.Position = treeViewFiles.ScrollOffsetHorizontal;
  151. }
  152. treeViewFiles.SetNeedsDisplay ();
  153. };
  154. treeViewFiles.DrawContent += (e) => {
  155. _scrollBar.Size = treeViewFiles.ContentHeight;
  156. _scrollBar.Position = treeViewFiles.ScrollOffsetVertical;
  157. _scrollBar.OtherScrollBarView.Size = treeViewFiles.GetContentWidth (true);
  158. _scrollBar.OtherScrollBarView.Position = treeViewFiles.ScrollOffsetHorizontal;
  159. _scrollBar.Refresh ();
  160. };
  161. }
  162. private void SetupFileTree ()
  163. {
  164. // setup delegates
  165. treeViewFiles.TreeBuilder = new DelegateTreeBuilder<FileSystemInfo> (
  166. // Determines how to compute children of any given branch
  167. GetChildren,
  168. // As a shortcut to enumerating half the file system, tell tree that all directories are expandable (even if they turn out to be empty later on)
  169. (o) => o is DirectoryInfo
  170. );
  171. // Determines how to represent objects as strings on the screen
  172. treeViewFiles.AspectGetter = FileSystemAspectGetter;
  173. treeViewFiles.AddObjects (DriveInfo.GetDrives ().Select (d => d.RootDirectory));
  174. }
  175. private void TreeViewFiles_ObjectActivated (ObjectActivatedEventArgs<FileSystemInfo> obj)
  176. {
  177. ShowPropertiesOf (obj.ActivatedObject);
  178. }
  179. private void ShowLines ()
  180. {
  181. miShowLines.Checked = !miShowLines.Checked;
  182. treeViewFiles.Style.ShowBranchLines = miShowLines.Checked;
  183. treeViewFiles.SetNeedsDisplay ();
  184. }
  185. private void SetExpandableSymbols (Rune? expand, Rune? collapse)
  186. {
  187. miPlusMinus.Checked = expand == '+';
  188. miArrowSymbols.Checked = expand == '>';
  189. miNoSymbols.Checked = expand == null;
  190. miUnicodeSymbols.Checked = expand == 'ஹ';
  191. treeViewFiles.Style.ExpandableSymbol = expand;
  192. treeViewFiles.Style.CollapseableSymbol = collapse;
  193. treeViewFiles.SetNeedsDisplay ();
  194. }
  195. private void ShowColoredExpandableSymbols ()
  196. {
  197. miColoredSymbols.Checked = !miColoredSymbols.Checked;
  198. treeViewFiles.Style.ColorExpandSymbol = miColoredSymbols.Checked;
  199. treeViewFiles.SetNeedsDisplay ();
  200. }
  201. private void InvertExpandableSymbols ()
  202. {
  203. miInvertSymbols.Checked = !miInvertSymbols.Checked;
  204. treeViewFiles.Style.InvertExpandSymbolColors = miInvertSymbols.Checked;
  205. treeViewFiles.SetNeedsDisplay ();
  206. }
  207. private void SetFullName ()
  208. {
  209. miFullPaths.Checked = !miFullPaths.Checked;
  210. if (miFullPaths.Checked) {
  211. treeViewFiles.AspectGetter = (f) => f.FullName;
  212. } else {
  213. treeViewFiles.AspectGetter = (f) => f.Name;
  214. }
  215. }
  216. private void SetLeaveLastRow ()
  217. {
  218. miLeaveLastRow.Checked = !miLeaveLastRow.Checked;
  219. treeViewFiles.Style.LeaveLastRow = miLeaveLastRow.Checked;
  220. }
  221. private void SetCustomColors()
  222. {
  223. var yellow = new ColorScheme
  224. {
  225. Focus = new Terminal.Gui.Attribute(Color.BrightYellow,treeViewFiles.ColorScheme.Focus.Background),
  226. Normal = new Terminal.Gui.Attribute (Color.BrightYellow,treeViewFiles.ColorScheme.Normal.Background),
  227. };
  228. miCustomColors.Checked = !miCustomColors.Checked;
  229. if(miCustomColors.Checked)
  230. {
  231. treeViewFiles.ColorGetter = (m)=>
  232. {
  233. return m is DirectoryInfo ? yellow : null;
  234. };
  235. }
  236. else
  237. {
  238. treeViewFiles.ColorGetter = null;
  239. }
  240. }
  241. private IEnumerable<FileSystemInfo> GetChildren (FileSystemInfo model)
  242. {
  243. // If it is a directory it's children are all contained files and dirs
  244. if (model is DirectoryInfo d) {
  245. try {
  246. return d.GetFileSystemInfos ()
  247. //show directories first
  248. .OrderBy (a => a is DirectoryInfo ? 0 : 1)
  249. .ThenBy (b => b.Name);
  250. } catch (SystemException) {
  251. // Access violation or other error getting the file list for directory
  252. return Enumerable.Empty<FileSystemInfo> ();
  253. }
  254. }
  255. return Enumerable.Empty<FileSystemInfo> (); ;
  256. }
  257. private string FileSystemAspectGetter (FileSystemInfo model)
  258. {
  259. if (model is DirectoryInfo d) {
  260. return d.Name;
  261. }
  262. if (model is FileInfo f) {
  263. return f.Name;
  264. }
  265. return model.ToString ();
  266. }
  267. private void Quit ()
  268. {
  269. Application.RequestStop ();
  270. }
  271. }
  272. }