File Explorer Keyboard Navigation - Part 1 (#1086)

* focus -> active

* add separate focus property to state, remove active from TreeView

* add Utility.ArrayEx.findIndex

* add prev/nextExpandedNode to FsTreeNode

* focus previous and next

* use hash for findByPath

* remove FsTreeNode.id, add equals

* fix warnings

* formatting

* add Utility.Path

* abstract hash function

* FileExplorerStore.nodeOffsetByPath -> FsTreeNode.expandedIndex

* select on enter

src/Core/Utility.re

@@ -259,6 +259,24 @@ module RangeUtil = {
     };
 };
 
+module ArrayEx = {
+  exception Found(int);
+
+  let findIndex = (predicate, array) =>
+    try(
+      {
+        for (i in 0 to Array.length(array) - 1) {
+          if (predicate(array[i])) {
+            raise(Found(i));
+          };
+        };
+        None;
+      }
+    ) {
+    | Found(i) => Some(i)
+    };
+};
+
 // TODO: Remove after 4.08 upgrade
 module List = {
   include List;
@@ -688,3 +706,15 @@ module ChunkyQueue: {
   let toList = ({front, rear, _}) =>
     front @ (Queue.toList(rear) |> List.concat);
 };
+
+module Path = {
+  // Not very robust path-handling utilities.
+  // TODO: Make good
+
+  let toRelative = (~base, path) => {
+    let base = base == "/" ? base : base ++ Filename.dir_sep;
+    Str.replace_first(Str.regexp_string(base), "", path);
+  };
+
+  let explode = String.split_on_char(Filename.dir_sep.[0]);
+};

src/Model/FileExplorer.re

@@ -1,24 +1,24 @@
-open Revery;
 open Oni_Core;
 open Oni_Extensions;
 
 type t = {
   tree: option(FsTreeNode.t),
   isOpen: bool,
   scrollOffset: [ | `Start(float) | `Middle(float)],
-  focus: option(string) // path
+  active: option(string), // path
+  focus: option(string) // node id
 };
 
 [@deriving show({with_path: false})]
 type action =
   | TreeLoaded([@opaque] FsTreeNode.t)
-  | NodeLoaded(int, [@opaque] FsTreeNode.t)
-  | FocusNodeLoaded(int, [@opaque] FsTreeNode.t)
+  | NodeLoaded(string, [@opaque] FsTreeNode.t)
+  | FocusNodeLoaded(string, [@opaque] FsTreeNode.t)
   | NodeClicked([@opaque] FsTreeNode.t)
-  | ScrollOffsetChanged([ | `Start(float) | `Middle(float)]);
-
-module ExplorerId =
-  UniqueId.Make({});
+  | ScrollOffsetChanged([ | `Start(float) | `Middle(float)])
+  | Select
+  | FocusPrev
+  | FocusNext;
 
 let getFileIcon = (languageInfo, iconTheme, filePath) => {
   let fileIcon =
@@ -79,7 +79,6 @@ let getFilesAndFolders = (~ignored, cwd, getIcon) => {
   let rec getDirContent = (~loadChildren=false, cwd) => {
     let toFsTreeNode = file => {
       let path = Filename.concat(cwd, file);
-      let id = ExplorerId.getUniqueId();
 
       if (isDirectory(path)) {
         let%lwt children =
@@ -94,10 +93,11 @@ let getFilesAndFolders = (~ignored, cwd, getIcon) => {
             Lwt.return([]);
           };
 
-        FsTreeNode.directory(path, ~id, ~icon=getIcon(path), ~children)
-        |> Lwt.return;
+        Lwt.return(
+          FsTreeNode.directory(path, ~icon=getIcon(path), ~children),
+        );
       } else {
-        FsTreeNode.file(path, ~id, ~icon=getIcon(path)) |> Lwt.return;
+        FsTreeNode.file(path, ~icon=getIcon(path)) |> Lwt.return;
       };
     };
 
@@ -116,25 +116,19 @@ let getFilesAndFolders = (~ignored, cwd, getIcon) => {
 };
 
 let getDirectoryTree = (cwd, languageInfo, iconTheme, ignored) => {
-  let id = ExplorerId.getUniqueId();
   let getIcon = getFileIcon(languageInfo, iconTheme);
   let children =
     getFilesAndFolders(~ignored, cwd, getIcon)
     |> Lwt_main.run
     |> List.sort(sortByLoweredDisplayName);
 
-  FsTreeNode.directory(
-    cwd,
-    ~id,
-    ~icon=getIcon(cwd),
-    ~children,
-    ~isOpen=true,
-  );
+  FsTreeNode.directory(cwd, ~icon=getIcon(cwd), ~children, ~isOpen=true);
 };
 
 let initial = {
   tree: None,
   isOpen: true,
   scrollOffset: `Start(0.),
+  active: None,
   focus: None,
 };

src/Model/FileExplorer.rei

@@ -4,16 +4,20 @@ type t = {
   tree: option(FsTreeNode.t),
   isOpen: bool,
   scrollOffset: [ | `Start(float) | `Middle(float)],
-  focus: option(string) // path
+  active: option(string), // path
+  focus: option(string) // node id
 };
 
 [@deriving show]
 type action =
   | TreeLoaded([@opaque] FsTreeNode.t)
-  | NodeLoaded(int, [@opaque] FsTreeNode.t)
-  | FocusNodeLoaded(int, [@opaque] FsTreeNode.t)
+  | NodeLoaded(string, [@opaque] FsTreeNode.t)
+  | FocusNodeLoaded(string, [@opaque] FsTreeNode.t)
   | NodeClicked([@opaque] FsTreeNode.t)
-  | ScrollOffsetChanged([ | `Start(float) | `Middle(float)]);
+  | ScrollOffsetChanged([ | `Start(float) | `Middle(float)])
+  | Select
+  | FocusPrev
+  | FocusNext;
 
 let initial: t;