MouseBindingsTests.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  1. namespace Terminal.Gui.InputTests;
  2. public class MouseBindingsTests
  3. {
  4. [Fact]
  5. public void Add_Adds ()
  6. {
  7. var mouseBindings = new MouseBindings ();
  8. Command [] commands = [Command.Right, Command.Left];
  9. var flags = MouseFlags.AllEvents;
  10. mouseBindings.Add (flags, commands);
  11. MouseBinding binding = mouseBindings.Get (flags);
  12. Assert.Contains (Command.Right, binding.Commands);
  13. Assert.Contains (Command.Left, binding.Commands);
  14. binding = mouseBindings.Get (flags);
  15. Assert.Contains (Command.Right, binding.Commands);
  16. Assert.Contains (Command.Left, binding.Commands);
  17. Command [] resultCommands = mouseBindings.GetCommands (flags);
  18. Assert.Contains (Command.Right, resultCommands);
  19. Assert.Contains (Command.Left, resultCommands);
  20. }
  21. [Fact]
  22. public void Add_Invalid_Flag_Throws ()
  23. {
  24. var mouseBindings = new MouseBindings ();
  25. List<Command> commands = new ();
  26. Assert.Throws<ArgumentException> (() => mouseBindings.Add (MouseFlags.None, Command.Accept));
  27. Assert.Throws<ArgumentException> (() => mouseBindings.Add ((MouseFlags)0x8ffffff, Command.Accept));
  28. }
  29. [Fact]
  30. public void Add_Multiple_Commands_Adds ()
  31. {
  32. var mouseBindings = new MouseBindings ();
  33. Command [] commands = [Command.Right, Command.Left];
  34. mouseBindings.Add (MouseFlags.Button1Clicked, commands);
  35. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  36. Assert.Contains (Command.Right, resultCommands);
  37. Assert.Contains (Command.Left, resultCommands);
  38. mouseBindings.Add (MouseFlags.Button2Clicked, commands);
  39. resultCommands = mouseBindings.GetCommands (MouseFlags.Button2Clicked);
  40. Assert.Contains (Command.Right, resultCommands);
  41. Assert.Contains (Command.Left, resultCommands);
  42. }
  43. [Fact]
  44. public void Add_No_Commands_Throws ()
  45. {
  46. var mouseBindings = new MouseBindings ();
  47. List<Command> commands = new ();
  48. Assert.Throws<ArgumentException> (() => mouseBindings.Add (MouseFlags.Button1Clicked, commands.ToArray ()));
  49. }
  50. [Fact]
  51. public void Add_Single_Command_Adds ()
  52. {
  53. var mouseBindings = new MouseBindings ();
  54. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  55. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  56. Assert.Contains (Command.HotKey, resultCommands);
  57. mouseBindings.Add (MouseFlags.Button2Clicked, Command.HotKey);
  58. resultCommands = mouseBindings.GetCommands (MouseFlags.Button2Clicked);
  59. Assert.Contains (Command.HotKey, resultCommands);
  60. }
  61. // Add should not allow duplicates
  62. [Fact]
  63. public void Add_Throws_If_Exists ()
  64. {
  65. var mouseBindings = new MouseBindings ();
  66. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  67. Assert.Throws<InvalidOperationException> (() => mouseBindings.Add (MouseFlags.Button1Clicked, Command.Accept));
  68. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  69. Assert.Contains (Command.HotKey, resultCommands);
  70. mouseBindings = new ();
  71. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  72. Assert.Throws<InvalidOperationException> (() => mouseBindings.Add (MouseFlags.Button1Clicked, Command.Accept));
  73. resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  74. Assert.Contains (Command.HotKey, resultCommands);
  75. mouseBindings = new ();
  76. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  77. Assert.Throws<InvalidOperationException> (() => mouseBindings.Add (MouseFlags.Button1Clicked, Command.Accept));
  78. resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  79. Assert.Contains (Command.HotKey, resultCommands);
  80. mouseBindings = new ();
  81. mouseBindings.Add (MouseFlags.Button1Clicked, Command.Accept);
  82. Assert.Throws<InvalidOperationException> (() => mouseBindings.Add (MouseFlags.Button1Clicked, Command.ScrollDown));
  83. resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  84. Assert.Contains (Command.Accept, resultCommands);
  85. mouseBindings = new ();
  86. mouseBindings.Add (MouseFlags.Button1Clicked, new MouseBinding ([Command.HotKey], MouseFlags.Button1Clicked));
  87. Assert.Throws<InvalidOperationException> (
  88. () => mouseBindings.Add (
  89. MouseFlags.Button1Clicked,
  90. new MouseBinding ([Command.Accept], MouseFlags.Button1Clicked)));
  91. resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  92. Assert.Contains (Command.HotKey, resultCommands);
  93. }
  94. // Clear
  95. [Fact]
  96. public void Clear_Clears ()
  97. {
  98. var mouseBindings = new MouseBindings ();
  99. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  100. mouseBindings.Clear ();
  101. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  102. Assert.Empty (resultCommands);
  103. resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  104. Assert.Empty (resultCommands);
  105. }
  106. [Fact]
  107. public void Defaults ()
  108. {
  109. var mouseBindings = new MouseBindings ();
  110. Assert.Empty (mouseBindings.GetBindings ());
  111. Assert.Equal (MouseFlags.None, mouseBindings.GetMouseFlagsFromCommands (Command.Accept));
  112. }
  113. [Fact]
  114. public void Get_Binding_Not_Found_Throws ()
  115. {
  116. var mouseBindings = new MouseBindings ();
  117. Assert.Throws<InvalidOperationException> (() => mouseBindings.Get (MouseFlags.Button1Clicked));
  118. Assert.Throws<InvalidOperationException> (() => mouseBindings.Get (MouseFlags.AllEvents));
  119. }
  120. // GetCommands
  121. [Fact]
  122. public void GetCommands_Unknown_ReturnsEmpty ()
  123. {
  124. var mouseBindings = new MouseBindings ();
  125. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  126. Assert.Empty (resultCommands);
  127. }
  128. [Fact]
  129. public void GetCommands_WithCommands_ReturnsCommands ()
  130. {
  131. var mouseBindings = new MouseBindings ();
  132. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  133. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  134. Assert.Contains (Command.HotKey, resultCommands);
  135. }
  136. [Fact]
  137. public void GetCommands_WithMultipleBindings_ReturnsCommands ()
  138. {
  139. var mouseBindings = new MouseBindings ();
  140. Command [] commands = [Command.Right, Command.Left];
  141. mouseBindings.Add (MouseFlags.Button1Clicked, commands);
  142. mouseBindings.Add (MouseFlags.Button2Clicked, commands);
  143. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  144. Assert.Contains (Command.Right, resultCommands);
  145. Assert.Contains (Command.Left, resultCommands);
  146. resultCommands = mouseBindings.GetCommands (MouseFlags.Button2Clicked);
  147. Assert.Contains (Command.Right, resultCommands);
  148. Assert.Contains (Command.Left, resultCommands);
  149. }
  150. [Fact]
  151. public void GetCommands_WithMultipleCommands_ReturnsCommands ()
  152. {
  153. var mouseBindings = new MouseBindings ();
  154. Command [] commands = [Command.Right, Command.Left];
  155. mouseBindings.Add (MouseFlags.Button1Clicked, commands);
  156. Command [] resultCommands = mouseBindings.GetCommands (MouseFlags.Button1Clicked);
  157. Assert.Contains (Command.Right, resultCommands);
  158. Assert.Contains (Command.Left, resultCommands);
  159. }
  160. [Fact]
  161. public void GetMouseFlagsFromCommands_MultipleCommands ()
  162. {
  163. var mouseBindings = new MouseBindings ();
  164. Command [] commands1 = [Command.Right, Command.Left];
  165. mouseBindings.Add (MouseFlags.Button1Clicked, commands1);
  166. Command [] commands2 = { Command.Up, Command.Down };
  167. mouseBindings.Add (MouseFlags.Button2Clicked, commands2);
  168. MouseFlags mouseFlags = mouseBindings.GetMouseFlagsFromCommands (commands1);
  169. Assert.Equal (MouseFlags.Button1Clicked, mouseFlags);
  170. mouseFlags = mouseBindings.GetMouseFlagsFromCommands (commands2);
  171. Assert.Equal (MouseFlags.Button2Clicked, mouseFlags);
  172. }
  173. [Fact]
  174. public void GetMouseFlagsFromCommands_OneCommand ()
  175. {
  176. var mouseBindings = new MouseBindings ();
  177. mouseBindings.Add (MouseFlags.Button1Clicked, Command.Right);
  178. MouseFlags mouseFlags = mouseBindings.GetMouseFlagsFromCommands (Command.Right);
  179. Assert.Equal (MouseFlags.Button1Clicked, mouseFlags);
  180. }
  181. // GetMouseFlagsFromCommands
  182. [Fact]
  183. public void GetMouseFlagsFromCommands_Unknown_Returns_Key_Empty ()
  184. {
  185. var mouseBindings = new MouseBindings ();
  186. Assert.Equal (MouseFlags.None, mouseBindings.GetMouseFlagsFromCommands (Command.Accept));
  187. }
  188. [Fact]
  189. public void GetMouseFlagsFromCommands_WithCommands_ReturnsKey ()
  190. {
  191. var mouseBindings = new MouseBindings ();
  192. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  193. MouseFlags mouseFlags = mouseBindings.GetMouseFlagsFromCommands (Command.HotKey);
  194. Assert.Equal (MouseFlags.Button1Clicked, mouseFlags);
  195. }
  196. [Fact]
  197. public void ReplaceMouseFlags_Replaces ()
  198. {
  199. var mouseBindings = new MouseBindings ();
  200. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  201. mouseBindings.Add (MouseFlags.Button2Clicked, Command.HotKey);
  202. mouseBindings.Add (MouseFlags.Button3Clicked, Command.HotKey);
  203. mouseBindings.Add (MouseFlags.Button4Clicked, Command.HotKey);
  204. mouseBindings.ReplaceMouseFlag (MouseFlags.Button1Clicked, MouseFlags.Button1DoubleClicked);
  205. Assert.Empty (mouseBindings.GetCommands (MouseFlags.Button1Clicked));
  206. Assert.Contains (Command.HotKey, mouseBindings.GetCommands (MouseFlags.Button1DoubleClicked));
  207. mouseBindings.ReplaceMouseFlag (MouseFlags.Button2Clicked, MouseFlags.Button2DoubleClicked);
  208. Assert.Empty (mouseBindings.GetCommands (MouseFlags.Button2Clicked));
  209. Assert.Contains (Command.HotKey, mouseBindings.GetCommands (MouseFlags.Button2DoubleClicked));
  210. mouseBindings.ReplaceMouseFlag (MouseFlags.Button3Clicked, MouseFlags.Button3DoubleClicked);
  211. Assert.Empty (mouseBindings.GetCommands (MouseFlags.Button3Clicked));
  212. Assert.Contains (Command.HotKey, mouseBindings.GetCommands (MouseFlags.Button3DoubleClicked));
  213. mouseBindings.ReplaceMouseFlag (MouseFlags.Button4Clicked, MouseFlags.Button4DoubleClicked);
  214. Assert.Empty (mouseBindings.GetCommands (MouseFlags.Button4Clicked));
  215. Assert.Contains (Command.HotKey, mouseBindings.GetCommands (MouseFlags.Button4DoubleClicked));
  216. }
  217. [Fact]
  218. public void ReplaceMouseFlags_Replaces_Leaves_Old_Binding ()
  219. {
  220. var mouseBindings = new MouseBindings ();
  221. mouseBindings.Add (MouseFlags.Button1Clicked, Command.Accept);
  222. mouseBindings.Add (MouseFlags.Button2Clicked, Command.HotKey);
  223. mouseBindings.ReplaceMouseFlag (mouseBindings.GetMouseFlagsFromCommands (Command.Accept), MouseFlags.Button3Clicked);
  224. Assert.Empty (mouseBindings.GetCommands (MouseFlags.Button1Clicked));
  225. Assert.Contains (Command.Accept, mouseBindings.GetCommands (MouseFlags.Button3Clicked));
  226. }
  227. [Fact]
  228. public void ReplaceMouseFlags_Adds_If_DoesNotContain_Old ()
  229. {
  230. var mouseBindings = new MouseBindings ();
  231. mouseBindings.ReplaceMouseFlag (MouseFlags.Button1Clicked, MouseFlags.Button2Clicked);
  232. Assert.True (mouseBindings.TryGet (MouseFlags.Button2Clicked, out _));
  233. }
  234. [Fact]
  235. public void ReplaceMouseFlags_Throws_If_New_Is_None ()
  236. {
  237. var mouseBindings = new MouseBindings ();
  238. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  239. Assert.Throws<ArgumentException> (() => mouseBindings.ReplaceMouseFlag (MouseFlags.Button1Clicked, MouseFlags.None));
  240. }
  241. [Fact]
  242. public void Get_Gets ()
  243. {
  244. var mouseBindings = new MouseBindings ();
  245. Command [] commands = [Command.Right, Command.Left];
  246. mouseBindings.Add (MouseFlags.Button1Clicked, commands);
  247. MouseBinding binding = mouseBindings.Get (MouseFlags.Button1Clicked);
  248. Assert.Contains (Command.Right, binding.Commands);
  249. Assert.Contains (Command.Left, binding.Commands);
  250. binding = mouseBindings.Get (MouseFlags.Button1Clicked);
  251. Assert.Contains (Command.Right, binding.Commands);
  252. Assert.Contains (Command.Left, binding.Commands);
  253. }
  254. // TryGet
  255. [Fact]
  256. public void TryGet_Succeeds ()
  257. {
  258. var mouseBindings = new MouseBindings ();
  259. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  260. bool result = mouseBindings.TryGet (MouseFlags.Button1Clicked, out MouseBinding _);
  261. Assert.True (result);
  262. ;
  263. }
  264. [Fact]
  265. public void TryGet_Unknown_ReturnsFalse ()
  266. {
  267. var mouseBindings = new MouseBindings ();
  268. bool result = mouseBindings.TryGet (MouseFlags.Button1Clicked, out MouseBinding _);
  269. Assert.False (result);
  270. }
  271. [Fact]
  272. public void TryGet_WithCommands_ReturnsTrue ()
  273. {
  274. var mouseBindings = new MouseBindings ();
  275. mouseBindings.Add (MouseFlags.Button1Clicked, Command.HotKey);
  276. bool result = mouseBindings.TryGet (MouseFlags.Button1Clicked, out MouseBinding bindings);
  277. Assert.True (result);
  278. Assert.Contains (Command.HotKey, bindings.Commands);
  279. }
  280. [Fact]
  281. public void ReplaceCommands_Replaces ()
  282. {
  283. var mouseBindings = new MouseBindings ();
  284. mouseBindings.Add (MouseFlags.Button1Clicked, Command.Accept);
  285. mouseBindings.ReplaceCommands (MouseFlags.Button1Clicked, Command.Refresh);
  286. bool result = mouseBindings.TryGet (MouseFlags.Button1Clicked, out MouseBinding bindings);
  287. Assert.True (result);
  288. Assert.Contains (Command.Refresh, bindings.Commands);
  289. }
  290. }