fix(vim): Add infrastructure for additional mode context (#2362)

Some prep work to address #2357 - this plumbs through some additional context for modes, so that we can display it in the status bar and elsewhere. This updates the `Mode` variant to be able to handle contextual state (and updates all the downstream dependencies). With this change - we'll be able to integrate it with onivim/libvim#218 so we can add some operator pending info for #2357
onivim · Aug 26, 2020 · 354a87e · 354a87e
1 parent d2a5979
commit 354a87e
Show file tree

Hide file tree

Showing 64 changed files with 306 additions and 247 deletions.
diff --git a/integration_test/ClipboardInsertModePasteEmptyTest.re b/integration_test/ClipboardInsertModePasteEmptyTest.re
@@ -10,13 +10,13 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   setClipboard(None);

diff --git a/integration_test/ClipboardInsertModePasteMultiLineTest.re b/integration_test/ClipboardInsertModePasteMultiLineTest.re
@@ -10,13 +10,13 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   setClipboard(Some("def\nghi"));

diff --git a/integration_test/ClipboardInsertModePasteSingleLineTest.re b/integration_test/ClipboardInsertModePasteSingleLineTest.re
@@ -10,13 +10,13 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   setClipboard(Some("def"));

diff --git a/integration_test/ClipboardNormalModePasteTest.re b/integration_test/ClipboardNormalModePasteTest.re
@@ -19,7 +19,7 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // '*' test case

diff --git a/integration_test/ClipboardYankTest.re b/integration_test/ClipboardYankTest.re
@@ -37,15 +37,15 @@ runTest(~name="ClipboardYankTest", (dispatch, wait, runEffects) => {
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   dispatch(KeyboardInput({isText: true, input: "abc"}));
   dispatch(KeyboardInput({isText: false, input: "<esc>"}));
   runEffects();
 
   wait(~name="Mode switches back to normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   setClipboard(None);

diff --git a/integration_test/EchoNotificationTest.re b/integration_test/EchoNotificationTest.re
@@ -3,7 +3,7 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="EchoNotificationTest", (dispatch, wait, _runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(VimExecuteCommand("echo 'hi from test'"));

diff --git a/integration_test/EditorFontFromPathTest.re b/integration_test/EditorFontFromPathTest.re
@@ -16,7 +16,7 @@ runTest(
   ~name="EditorFontFromPath",
   (_, wait, _) => {
     wait(~name="Initial mode is normal", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Normal
+      Feature_Vim.mode(state.vim) == Vim.Mode.Normal
     );
 
     print_endline("Using font: " ++ font);

diff --git a/integration_test/EditorFontValidTest.re b/integration_test/EditorFontValidTest.re
@@ -23,7 +23,7 @@ if (Revery.Environment.os !== Revery.Environment.Linux) {
     ~name="EditorFontValid",
     (_, wait, _) => {
       wait(~name="Initial mode is normal", (state: State.t) =>
-        Feature_Vim.mode(state.vim) == Vim.Types.Normal
+        Feature_Vim.mode(state.vim) == Vim.Mode.Normal
       );
 
       wait(

diff --git a/integration_test/EditorUtf8Test.re b/integration_test/EditorUtf8Test.re
@@ -7,7 +7,7 @@ open Feature_Editor;
 
 runTestWithInput(~name="EditorUtf8Test", (input, dispatch, wait, _) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   let testFile = getAssetPath("utf8.txt");

diff --git a/integration_test/ExtHostBufferOpenTest.re b/integration_test/ExtHostBufferOpenTest.re
@@ -10,7 +10,7 @@ module TS = TextSynchronization;
 runTestWithInput(
   ~name="ExtHostBufferOpen", (_input, dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // Wait until the extension is activated

diff --git a/integration_test/ExtHostBufferUpdatesTest.re b/integration_test/ExtHostBufferUpdatesTest.re
@@ -11,7 +11,7 @@ module TS = TextSynchronization;
 runTestWithInput(
   ~name="ExtHostBufferUpdates", (input, dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // Wait until the extension is activated

diff --git a/integration_test/ExtHostCompletionTest.re b/integration_test/ExtHostCompletionTest.re
@@ -8,7 +8,7 @@ open Oni_IntegrationTestLib;
 runTestWithInput(
   ~name="ExtHostCompletionTest", (input, dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // Wait until the extension is activated

diff --git a/integration_test/ExtHostDefinitionTest.re b/integration_test/ExtHostDefinitionTest.re
@@ -9,7 +9,7 @@ open Feature_Editor;
 runTestWithInput(
   ~name="ExtHostDefinitionTest", (input, dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // Wait until the extension is activated

diff --git a/integration_test/FontSizeChangeTest.re b/integration_test/FontSizeChangeTest.re
@@ -4,7 +4,7 @@ open Oni_IntegrationTestLib;
 // Validate that change the font size via config results in new metrics
 runTest(~name="FontSizeChangeTest", (dispatch, wait, runEffects) => {
   wait(~name="Mode switches back to normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   wait(~name="Set configuration to small font size", (state: State.t) => {

diff --git a/integration_test/InputIgnoreTest.re b/integration_test/InputIgnoreTest.re
@@ -7,13 +7,13 @@ module Log = (val Log.withNamespace("IntegrationTest.inputIgnore"));
 // This test validates that certain keystrokes are ignored by our Vim layer
 runTest(~name="InputIgnore test", (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   dispatch(KeyboardInput({isText: false, input: "<D-A->"}));

diff --git a/integration_test/InsertModeTest.re b/integration_test/InsertModeTest.re
@@ -3,12 +3,12 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="InsertMode test", (dispatch, wait, _) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 });
diff --git a/integration_test/KeySequenceJJTest.re b/integration_test/KeySequenceJJTest.re
@@ -13,7 +13,7 @@ runTest(
   ~name="KeySequenceJJTest",
   (dispatch, wait, _) => {
     wait(~name="Initial mode is normal", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Normal
+      Feature_Vim.mode(state.vim) == Vim.Mode.Normal
     );
 
     let input = key => {
@@ -31,14 +31,14 @@ runTest(
 
     input("i");
     wait(~name="Mode is now insert", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Insert
+      Feature_Vim.mode(state.vim) == Vim.Mode.Insert
     );
 
     input("j");
     input("j");
 
     wait(~name="Mode is back to normal", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Normal
+      Feature_Vim.mode(state.vim) == Vim.Mode.Normal
     );
     // TODO: Figure out why this check is failing...
     wait(~name="Validate buffer is empty", (state: State.t) => {

diff --git a/integration_test/KeybindingsInvalidJsonTest.re b/integration_test/KeybindingsInvalidJsonTest.re
@@ -10,7 +10,7 @@ runTest(
   ~name="KeybindingsInvalidJson",
   (_dispatch, wait, _) => {
     wait(~name="Initial mode is normal", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Normal
+      Feature_Vim.mode(state.vim) == Vim.Mode.Normal
     );
 
     let getErrorNotificationCount = (state: State.t) => {

diff --git a/integration_test/LanguageCssTest.re b/integration_test/LanguageCssTest.re
@@ -9,7 +9,7 @@ open Feature_LanguageSupport;
 runTestWithInput(
   ~name="LanguageCssTest", (input, dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   ExtensionHelpers.waitForExtensionToActivate(

diff --git a/integration_test/LanguageTypeScriptTest.re b/integration_test/LanguageTypeScriptTest.re
@@ -6,7 +6,7 @@ open Feature_LanguageSupport;
 runTestWithInput(
   ~name="LanguageTypeScriptTest", (input, dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   ExtensionHelpers.waitForExtensionToActivate(

diff --git a/integration_test/LineEndingsCRLFTest.re b/integration_test/LineEndingsCRLFTest.re
@@ -5,7 +5,7 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="LineEndingsCRLFTest", (dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   let testFile = getAssetPath("test.crlf");

diff --git a/integration_test/LineEndingsLFTest.re b/integration_test/LineEndingsLFTest.re
@@ -5,7 +5,7 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="LineEndingsLFTest", (dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   let testFile = getAssetPath("test.lf");

diff --git a/integration_test/QuickOpenEventuallyCompletesTest.re b/integration_test/QuickOpenEventuallyCompletesTest.re
@@ -3,7 +3,7 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="QuickOpen eventually completes", (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   /* Switch to root directory */

diff --git a/integration_test/Regression1671Test.re b/integration_test/Regression1671Test.re
@@ -8,7 +8,7 @@ runTestWithInput(
   ~name="Regression1671 - Opening new buffer loses changes in previous buffer",
   (input, _dispatch, wait, _runEffects) => {
     wait(~name="Capture initial state", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Normal
+      Feature_Vim.mode(state.vim) == Vim.Mode.Normal
     );
 
     input(":e a-test-file");

diff --git a/integration_test/Regression2349EnewTest.re b/integration_test/Regression2349EnewTest.re
@@ -3,7 +3,7 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="Regression: Command line no completions", (dispatch, wait, _) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   let initialEditorId = ref(None);

diff --git a/integration_test/RegressionCommandLineNoCompletionTest.re b/integration_test/RegressionCommandLineNoCompletionTest.re
@@ -3,13 +3,13 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="Regression: Command line no completions", (dispatch, wait, _) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: ":"}));
 
   wait(~name="Mode switches to command line", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.CommandLine
+    Feature_Vim.mode(state.vim) == Vim.Mode.CommandLine
   );
 
   dispatch(KeyboardInput({isText: true, input: "e"}));

diff --git a/integration_test/RegressionFileModifiedIndicationTest.re b/integration_test/RegressionFileModifiedIndicationTest.re
@@ -10,7 +10,7 @@ runTestWithInput(
   ~name="RegressionFileModifiedIndication",
   (input, dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   let initialBuffer = Vim.Buffer.getCurrent();

diff --git a/integration_test/SCMGitTest.re b/integration_test/SCMGitTest.re
@@ -3,7 +3,7 @@ open Oni_IntegrationTestLib;
 
 runTest(~name="SCMGitTest", (_dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // For now... just validate that the extension activated

diff --git a/integration_test/SearchShowClearHighlightsTest.re b/integration_test/SearchShowClearHighlightsTest.re
@@ -7,14 +7,14 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   // Edit
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   dispatch(KeyboardInput({isText: true, input: "a"}));

diff --git a/integration_test/SyntaxHighlightTextMateTest.re b/integration_test/SyntaxHighlightTextMateTest.re
@@ -5,7 +5,7 @@ open Oni_IntegrationTestLib;
 // Validate that textmate highlight runs
 runTest(~name="SyntaxHighlightTextMateTest", (dispatch, wait, _runEffects) => {
   wait(~name="Capture initial state", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
   wait(~name="Wait for syntax server", ~timeout=10.0, (state: State.t) => {
     Feature_Syntax.isSyntaxServerRunning(state.syntaxHighlights)

diff --git a/integration_test/SyntaxHighlightTreesitterTest.re b/integration_test/SyntaxHighlightTreesitterTest.re
@@ -12,7 +12,7 @@ runTest(
   ~name="SyntaxHighlightTreesitterTest",
   (dispatch, wait, _runEffects) => {
     wait(~name="Capture initial state", (state: State.t) =>
-      Feature_Vim.mode(state.vim) == Vim.Types.Normal
+      Feature_Vim.mode(state.vim) == Vim.Mode.Normal
     );
 
     wait(~name="Wait for syntax server", ~timeout=10.0, (state: State.t) => {

diff --git a/integration_test/TypingBatchedTest.re b/integration_test/TypingBatchedTest.re
@@ -8,13 +8,13 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   /* Simulate multiple events getting dispatched before running effects */

diff --git a/integration_test/TypingUnbatchedTest.re b/integration_test/TypingUnbatchedTest.re
@@ -8,13 +8,13 @@ runTest(
   ~name="InsertMode test - effects batched to runEffects",
   (dispatch, wait, runEffects) => {
   wait(~name="Initial mode is normal", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Normal
+    Feature_Vim.mode(state.vim) == Vim.Mode.Normal
   );
 
   dispatch(KeyboardInput({isText: true, input: "i"}));
 
   wait(~name="Mode switches to insert", (state: State.t) =>
-    Feature_Vim.mode(state.vim) == Vim.Types.Insert
+    Feature_Vim.mode(state.vim) == Vim.Mode.Insert
   );
 
   /* Simulate multiple events getting dispatched before running effects */