PendingChangesOptionsDialog.cs 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584
  1. using UnityEditor;
  2. using UnityEngine;
  3. using Codice.Client.Commands;
  4. using Codice.Client.Common.FsNodeReaders;
  5. using Codice.Client.Common.Threading;
  6. using Codice.CM.Common;
  7. using Codice.Utils;
  8. using PlasticGui;
  9. using PlasticGui.WorkspaceWindow.PendingChanges;
  10. using Unity.PlasticSCM.Editor.UI;
  11. namespace Unity.PlasticSCM.Editor.Views.PendingChanges.Dialogs
  12. {
  13. internal class PendingChangesOptionsDialog : PlasticDialog
  14. {
  15. internal interface IAutorefreshView
  16. {
  17. void DisableAutorefresh();
  18. void EnableAutorefresh();
  19. }
  20. protected override Rect DefaultRect
  21. {
  22. get
  23. {
  24. var baseRect = base.DefaultRect;
  25. return new Rect(baseRect.x, baseRect.y, 667, 660);
  26. }
  27. }
  28. internal static void ChangeOptions(
  29. WorkspaceInfo wkInfo,
  30. IRefreshableView view,
  31. EditorWindow window)
  32. {
  33. PendingChangesOptionsDialog dialog = Build(wkInfo);
  34. ((PendingChangesOptionsDialog.IAutorefreshView)(view)).DisableAutorefresh();
  35. bool isDialogDirty = false;
  36. try
  37. {
  38. if (dialog.RunModal(window) != ResponseType.Ok)
  39. return;
  40. PendingChangesOptions currentOptions = dialog.GetOptions();
  41. isDialogDirty = dialog.IsDirty(currentOptions);
  42. if (!isDialogDirty)
  43. return;
  44. currentOptions.SavePreferences();
  45. }
  46. finally
  47. {
  48. ((PendingChangesOptionsDialog.IAutorefreshView)(view)).EnableAutorefresh();
  49. if (isDialogDirty)
  50. view.Refresh();
  51. }
  52. }
  53. protected override void OnModalGUI()
  54. {
  55. DoToolbarArea();
  56. DoOptionsArea();
  57. DoButtonsArea();
  58. }
  59. protected override string GetTitle()
  60. {
  61. return PlasticLocalization.GetString(
  62. PlasticLocalization.Name.PendingChangesOptionsTitle);
  63. }
  64. void DoToolbarArea()
  65. {
  66. var toolbarRect = GUILayoutUtility.GetRect(0, position.width, BOX_TOOLBAR_HEIGHT, BOX_TOOLBAR_HEIGHT);
  67. GUI.Box(new Rect(toolbarRect.x, toolbarRect.y + toolbarRect.height / 2, toolbarRect.width, BOX_HEIGHT), GUIContent.none);
  68. EditorGUI.BeginChangeCheck();
  69. mSelectedTab = (Tab)GUI.Toolbar(toolbarRect, (int)mSelectedTab, new string[]{
  70. PlasticLocalization.GetString(PlasticLocalization.Name.PendingChangesWhatToFindTab),
  71. PlasticLocalization.GetString(PlasticLocalization.Name.PendingChangesWhatToShowTab),
  72. PlasticLocalization.GetString(PlasticLocalization.Name.PendingChangesMoveDetectionTab)
  73. });
  74. if (EditorGUI.EndChangeCheck())
  75. EditorGUIUtility.keyboardControl = -1;
  76. }
  77. void DoOptionsArea()
  78. {
  79. using (new EditorGUILayout.HorizontalScope())
  80. {
  81. GUILayout.Space(BOX_PADDING);
  82. using (new EditorGUILayout.VerticalScope(GUILayout.Height(BOX_HEIGHT)))
  83. {
  84. GUILayout.Space(BOX_PADDING);
  85. switch (mSelectedTab)
  86. {
  87. case Tab.WhatToFind:
  88. DoWhatToFindTab();
  89. break;
  90. case Tab.WhatToShow:
  91. DoWhatToShowTab();
  92. break;
  93. case Tab.MoveDetection:
  94. DoMoveDetectionTab();
  95. break;
  96. }
  97. GUILayout.Space(BOX_PADDING);
  98. }
  99. GUILayout.Space(BOX_PADDING);
  100. }
  101. }
  102. void DoWhatToFindTab()
  103. {
  104. mCanShowCheckouts = TitleToggle(PlasticLocalization.GetString(
  105. PlasticLocalization.Name.PendingChangesShowCheckouts), mCanShowCheckouts);
  106. using (new EditorGUILayout.HorizontalScope())
  107. {
  108. GUILayout.Space(20);
  109. Paragraph(PlasticLocalization.GetString(
  110. PlasticLocalization.Name.PendingChangesShowCheckoutsExplanation));
  111. }
  112. GUILayout.Space(5);
  113. mCanFindChanged = TitleToggle(PlasticLocalization.GetString(
  114. PlasticLocalization.Name.PendingChangesFindChanged), mCanFindChanged);
  115. using (new EditorGUILayout.HorizontalScope())
  116. {
  117. GUILayout.Space(20);
  118. Paragraph(PlasticLocalization.GetString(
  119. PlasticLocalization.Name.PendingChangesFindChangedExplanation));
  120. }
  121. GUILayout.Space(5);
  122. mCanCheckFileContent = TitleToggle(PlasticLocalization.GetString(
  123. PlasticLocalization.Name.PendingChangesCheckFileContent), mCanCheckFileContent);
  124. using (new EditorGUILayout.HorizontalScope())
  125. {
  126. GUILayout.Space(20);
  127. Paragraph(PlasticLocalization.GetString(
  128. PlasticLocalization.Name.PendingChangesCheckFileContentExplanation));
  129. }
  130. GUILayout.Space(60);
  131. DoFsWatcherMessage(mIsFileSystemWatcherEnabled);
  132. }
  133. void DoWhatToShowTab()
  134. {
  135. mCanAutoRefresh = TitleToggle(PlasticLocalization.GetString(
  136. PlasticLocalization.Name.PendingChangesAutoRefresh), mCanAutoRefresh);
  137. using (new EditorGUILayout.HorizontalScope())
  138. {
  139. GUILayout.Space(20);
  140. Paragraph(PlasticLocalization.GetString(
  141. PlasticLocalization.Name.PendingChangesAutoRefreshExplanation));
  142. }
  143. GUILayout.Space(5);
  144. mCanShowPrivateFields = TitleToggle(PlasticLocalization.GetString(
  145. PlasticLocalization.Name.PendingChangesShowPrivateFiles), mCanShowPrivateFields);
  146. using (new EditorGUILayout.HorizontalScope())
  147. {
  148. GUILayout.Space(20);
  149. Paragraph(PlasticLocalization.GetString(
  150. PlasticLocalization.Name.PendingChangesShowPrivateFilesExplanation));
  151. }
  152. GUILayout.Space(5);
  153. mCanShowIgnoredFiles = TitleToggle(PlasticLocalization.GetString(
  154. PlasticLocalization.Name.PendingChangesShowIgnoredFiles), mCanShowIgnoredFiles);
  155. using (new EditorGUILayout.HorizontalScope())
  156. {
  157. GUILayout.Space(20);
  158. Paragraph(PlasticLocalization.GetString(
  159. PlasticLocalization.Name.PendingChangesShowIgnoredFilesExplanation));
  160. }
  161. GUILayout.Space(5);
  162. mCanShowHiddenFiles = TitleToggle(PlasticLocalization.GetString(
  163. PlasticLocalization.Name.PendingChangesShowHiddenFiles), mCanShowHiddenFiles);
  164. using (new EditorGUILayout.HorizontalScope())
  165. {
  166. GUILayout.Space(20);
  167. Paragraph(PlasticLocalization.GetString(
  168. PlasticLocalization.Name.PendingChangesShowHiddenFilesExplanation));
  169. }
  170. GUILayout.Space(5);
  171. mCanShowDeletedFiles = TitleToggle(PlasticLocalization.GetString(
  172. PlasticLocalization.Name.PendingChangesShowDeletedFiles), mCanShowDeletedFiles);
  173. using (new EditorGUILayout.HorizontalScope())
  174. {
  175. GUILayout.Space(20);
  176. Paragraph(PlasticLocalization.GetString(
  177. PlasticLocalization.Name.PendingChangesShowDeletedFilesExplanation));
  178. }
  179. }
  180. void DoMoveDetectionTab()
  181. {
  182. Paragraph(PlasticLocalization.GetString(
  183. PlasticLocalization.Name.PendingChangesMoveDetectionExplanation));
  184. mCanFindMovedFiles = TitleToggle(PlasticLocalization.GetString(
  185. PlasticLocalization.Name.PendingChangesFindMovedFiles), mCanFindMovedFiles);
  186. using (new EditorGUILayout.HorizontalScope())
  187. {
  188. GUILayout.Space(20);
  189. Paragraph(PlasticLocalization.GetString(
  190. PlasticLocalization.Name.PendingChangesFindMovedFilesExplanation));
  191. }
  192. using (new EditorGUILayout.HorizontalScope())
  193. {
  194. GUILayout.Space(20);
  195. Paragraph(PlasticLocalization.GetString(
  196. PlasticLocalization.Name.PendingChangesMoveDetectionFineTune));
  197. }
  198. GUILayout.Space(5);
  199. using (new EditorGUILayout.HorizontalScope())
  200. {
  201. GUILayout.Space(20);
  202. GUI.enabled = mCanFindMovedFiles;
  203. mCanMatchBinarySameExtension = TitleToggle(
  204. PlasticLocalization.GetString(
  205. PlasticLocalization.Name.PendingChangesMatchBinarySameExtension),
  206. mCanMatchBinarySameExtension);
  207. GUI.enabled = true;
  208. }
  209. using (new EditorGUILayout.HorizontalScope())
  210. {
  211. GUILayout.Space(40);
  212. Paragraph(PlasticLocalization.GetString(
  213. PlasticLocalization.Name.PendingChangesMatchBinarySameExtensionExplanation));
  214. }
  215. GUILayout.Space(5);
  216. using (new EditorGUILayout.HorizontalScope())
  217. {
  218. GUILayout.Space(20);
  219. GUI.enabled = mCanFindMovedFiles;
  220. mCanMatchTextSameExtension = TitleToggle(
  221. PlasticLocalization.GetString(
  222. PlasticLocalization.Name.PendingChangesMatchTextSameExtension),
  223. mCanMatchTextSameExtension);
  224. GUI.enabled = true;
  225. }
  226. using (new EditorGUILayout.HorizontalScope())
  227. {
  228. GUILayout.Space(40);
  229. Paragraph(PlasticLocalization.GetString(
  230. PlasticLocalization.Name.PendingChangesMatchTextSameExtensionExplanation));
  231. }
  232. GUILayout.Space(5);
  233. using (new EditorGUILayout.HorizontalScope())
  234. {
  235. GUILayout.Space(20);
  236. GUILayout.Label(PlasticLocalization.GetString(
  237. PlasticLocalization.Name.PendingChangesSimilarityPercentage),
  238. UnityStyles.Dialog.Toggle);
  239. GUILayout.FlexibleSpace();
  240. using (new EditorGUILayout.VerticalScope())
  241. {
  242. GUILayout.Space(8);
  243. mSimilarityPercent = Mathf.RoundToInt(GUILayout.HorizontalSlider(
  244. mSimilarityPercent, 40, 100, GUILayout.Width(300)));
  245. }
  246. GUILayout.Space(2);
  247. using (new EditorGUILayout.VerticalScope())
  248. {
  249. GUILayout.Space(8);
  250. GUILayout.Label(mSimilarityPercent + "%");
  251. }
  252. }
  253. using (new EditorGUILayout.HorizontalScope())
  254. {
  255. GUILayout.Space(40);
  256. Paragraph(PlasticLocalization.GetString(
  257. PlasticLocalization.Name.PendingChangesSimilarityPercentageExplanation));
  258. }
  259. }
  260. void DoFsWatcherMessage(bool isEnabled)
  261. {
  262. GUIContent message = new GUIContent(
  263. isEnabled ?
  264. GetFsWatcherEnabledMessage() :
  265. GetFsWatcherDisabledMessage(),
  266. isEnabled ?
  267. Images.GetInfoIcon() :
  268. Images.GetWarnIcon());
  269. GUILayout.Label(message, UnityStyles.Dialog.Toggle, GUILayout.Height(32));
  270. GUILayout.Space(-10);
  271. string formattedExplanation = isEnabled ?
  272. GetFsWatcherEnabledExplanation() :
  273. GetFsWatcherDisabledExplanation();
  274. string helpLink = GetHelpLink();
  275. TextBlockWithEndLink(
  276. helpLink, formattedExplanation, UnityStyles.Paragraph);
  277. }
  278. void DoButtonsArea()
  279. {
  280. using (new EditorGUILayout.HorizontalScope())
  281. {
  282. GUILayout.FlexibleSpace();
  283. if (Application.platform == RuntimePlatform.WindowsEditor)
  284. {
  285. DoOkButton();
  286. DoCancelButton();
  287. return;
  288. }
  289. DoCancelButton();
  290. DoOkButton();
  291. }
  292. }
  293. void DoOkButton()
  294. {
  295. if (!AcceptButton(PlasticLocalization.GetString(
  296. PlasticLocalization.Name.OkButton)))
  297. return;
  298. OkButtonAction();
  299. }
  300. void DoCancelButton()
  301. {
  302. if (!NormalButton(PlasticLocalization.GetString(
  303. PlasticLocalization.Name.CancelButton)))
  304. return;
  305. CancelButtonAction();
  306. }
  307. bool IsDirty(PendingChangesOptions currentOptions)
  308. {
  309. return !mInitialOptions.AreSameOptions(currentOptions);
  310. }
  311. PendingChangesOptions GetOptions()
  312. {
  313. WorkspaceStatusOptions resultWkStatusOptions =
  314. WorkspaceStatusOptions.None;
  315. if (mCanShowCheckouts)
  316. {
  317. resultWkStatusOptions |= WorkspaceStatusOptions.FindCheckouts;
  318. resultWkStatusOptions |= WorkspaceStatusOptions.FindReplaced;
  319. resultWkStatusOptions |= WorkspaceStatusOptions.FindCopied;
  320. }
  321. if (mCanFindChanged)
  322. resultWkStatusOptions |= WorkspaceStatusOptions.FindChanged;
  323. if (mCanShowPrivateFields)
  324. resultWkStatusOptions |= WorkspaceStatusOptions.FindPrivates;
  325. if (mCanShowDeletedFiles)
  326. resultWkStatusOptions |= WorkspaceStatusOptions.FindLocallyDeleted;
  327. if (mCanShowIgnoredFiles)
  328. resultWkStatusOptions |= WorkspaceStatusOptions.ShowIgnored;
  329. if (mCanShowHiddenFiles)
  330. resultWkStatusOptions |= WorkspaceStatusOptions.ShowHiddenChanges;
  331. if (mCanFindMovedFiles)
  332. resultWkStatusOptions |= WorkspaceStatusOptions.CalculateLocalMoves;
  333. MovedMatchingOptions matchingOptions = new MovedMatchingOptions();
  334. matchingOptions.AllowedChangesPerUnit =
  335. (100 - mSimilarityPercent) / 100f;
  336. matchingOptions.bBinMatchingOnlySameExtension =
  337. mCanMatchBinarySameExtension;
  338. matchingOptions.bTxtMatchingOnlySameExtension =
  339. mCanMatchTextSameExtension;
  340. return new PendingChangesOptions(
  341. resultWkStatusOptions, matchingOptions,
  342. mCanAutoRefresh, false,
  343. mCanCheckFileContent, false);
  344. }
  345. void SetOptions(PendingChangesOptions options)
  346. {
  347. mCanShowCheckouts = IsEnabled(
  348. WorkspaceStatusOptions.FindCheckouts, options.WorkspaceStatusOptions);
  349. mCanFindChanged = IsEnabled(
  350. WorkspaceStatusOptions.FindChanged, options.WorkspaceStatusOptions);
  351. mCanCheckFileContent = options.CheckFileContentForChanged;
  352. mCanAutoRefresh = options.AutoRefresh;
  353. mCanShowPrivateFields = IsEnabled(
  354. WorkspaceStatusOptions.FindPrivates, options.WorkspaceStatusOptions);
  355. mCanShowIgnoredFiles = IsEnabled(
  356. WorkspaceStatusOptions.ShowIgnored, options.WorkspaceStatusOptions);
  357. mCanShowHiddenFiles = IsEnabled(
  358. WorkspaceStatusOptions.ShowHiddenChanges, options.WorkspaceStatusOptions);
  359. mCanShowDeletedFiles = IsEnabled(
  360. WorkspaceStatusOptions.FindLocallyDeleted, options.WorkspaceStatusOptions);
  361. mCanFindMovedFiles = IsEnabled(
  362. WorkspaceStatusOptions.CalculateLocalMoves, options.WorkspaceStatusOptions);
  363. mCanMatchBinarySameExtension =
  364. options.MovedMatchingOptions.bBinMatchingOnlySameExtension;
  365. mCanMatchTextSameExtension =
  366. options.MovedMatchingOptions.bTxtMatchingOnlySameExtension;
  367. mSimilarityPercent = (int)((1 - options.MovedMatchingOptions.AllowedChangesPerUnit) * 100f);
  368. }
  369. void CheckFsWatcher(WorkspaceInfo wkInfo)
  370. {
  371. bool isFileSystemWatcherEnabled = false;
  372. IThreadWaiter waiter = ThreadWaiter.GetWaiter(10);
  373. waiter.Execute(
  374. /*threadOperationDelegate*/ delegate
  375. {
  376. isFileSystemWatcherEnabled =
  377. IsFileSystemWatcherEnabled(wkInfo);
  378. },
  379. /*afterOperationDelegate*/ delegate
  380. {
  381. if (waiter.Exception != null)
  382. return;
  383. mIsFileSystemWatcherEnabled = isFileSystemWatcherEnabled;
  384. });
  385. }
  386. static bool IsEnabled(WorkspaceStatusOptions option, WorkspaceStatusOptions options)
  387. {
  388. return (options & option) == option;
  389. }
  390. static bool IsFileSystemWatcherEnabled(WorkspaceInfo wkInfo)
  391. {
  392. return WorkspaceWatcherFsNodeReadersCache.Get().
  393. IsWatcherEnabled(wkInfo);
  394. }
  395. static string GetFsWatcherEnabledMessage()
  396. {
  397. if (PlatformIdentifier.IsWindows() || PlatformIdentifier.IsMac())
  398. return PlasticLocalization.GetString(
  399. PlasticLocalization.Name.PendingChangesFilesystemWatcherEnabled);
  400. return PlasticLocalization.GetString(
  401. PlasticLocalization.Name.PendingChangesINotifyEnabled);
  402. }
  403. static string GetFsWatcherDisabledMessage()
  404. {
  405. if (PlatformIdentifier.IsWindows() || PlatformIdentifier.IsMac())
  406. return PlasticLocalization.GetString(
  407. PlasticLocalization.Name.PendingChangesFilesystemWatcherDisabled);
  408. return PlasticLocalization.GetString(
  409. PlasticLocalization.Name.PendingChangesINotifyDisabled);
  410. }
  411. static string GetFsWatcherEnabledExplanation()
  412. {
  413. if (PlatformIdentifier.IsWindows() || PlatformIdentifier.IsMac())
  414. return PlasticLocalization.GetString(
  415. PlasticLocalization.Name.PendingChangesFilesystemWatcherEnabledExplanation);
  416. return PlasticLocalization.GetString(
  417. PlasticLocalization.Name.PendingChangesINotifyEnabledExplanation);
  418. }
  419. static string GetFsWatcherDisabledExplanation()
  420. {
  421. if (PlatformIdentifier.IsWindows() || PlatformIdentifier.IsMac())
  422. {
  423. return PlasticLocalization.GetString(
  424. PlasticLocalization.Name.PendingChangesFilesystemWatcherDisabledExplanation)
  425. .Replace("[[HELP_URL|{0}]]", "{0}");
  426. }
  427. return PlasticLocalization.GetString(
  428. PlasticLocalization.Name.PendingChangesINotifyDisabledExplanation);
  429. }
  430. static string GetHelpLink()
  431. {
  432. if (PlatformIdentifier.IsWindows() || PlatformIdentifier.IsMac())
  433. return FS_WATCHER_HELP_URL;
  434. return INOTIFY_HELP_URL;
  435. }
  436. static PendingChangesOptionsDialog Build(WorkspaceInfo wkInfo)
  437. {
  438. PendingChangesOptionsDialog result = Create();
  439. result.CheckFsWatcher(wkInfo);
  440. result.mInitialOptions = new PendingChangesOptions();
  441. result.mInitialOptions.LoadPendingChangesOptions();
  442. result.SetOptions(result.mInitialOptions);
  443. return result;
  444. }
  445. static PendingChangesOptionsDialog Create()
  446. {
  447. var instance = CreateInstance<PendingChangesOptionsDialog>();
  448. instance.mEnterKeyAction = instance.OkButtonAction;
  449. instance.mEscapeKeyAction = instance.CancelButtonAction;
  450. return instance;
  451. }
  452. enum Tab
  453. {
  454. WhatToFind,
  455. WhatToShow,
  456. MoveDetection
  457. }
  458. Tab mSelectedTab = Tab.WhatToFind;
  459. bool mCanShowCheckouts;
  460. bool mCanAutoRefresh;
  461. bool mCanFindChanged;
  462. bool mCanCheckFileContent;
  463. bool mCanShowPrivateFields;
  464. bool mIsFileSystemWatcherEnabled;
  465. bool mCanShowIgnoredFiles;
  466. bool mCanShowHiddenFiles;
  467. bool mCanShowDeletedFiles;
  468. bool mCanFindMovedFiles;
  469. bool mCanMatchBinarySameExtension;
  470. bool mCanMatchTextSameExtension;
  471. int mSimilarityPercent;
  472. PendingChangesOptions mInitialOptions;
  473. const float BOX_PADDING = 22f;
  474. const float BOX_TOOLBAR_HEIGHT = 20f;
  475. const float BOX_HEIGHT = 560f;
  476. const string FS_WATCHER_HELP_URL = "https://plasticscm.com/download/help/support";
  477. const string INOTIFY_HELP_URL = "https://plasticscm.com/download/help/inotify";
  478. }
  479. }