Merge pull request #489 from joyfulmantis/watchkind-helpers

Add WatchKind helpers and fix a bug with createDoc

Author: joyfulmantis

lsp-test/src/Language/LSP/Test.hs

@@ -418,7 +418,7 @@ createDoc file languageId contents = do
       watchHits :: FileSystemWatcher -> Bool
       watchHits (FileSystemWatcher (GlobPattern (InL (Pattern pattern))) kind) =
         -- If WatchKind is excluded, defaults to all true as per spec
-        fileMatches (T.unpack pattern) && createHits (fromMaybe WatchKind_Create kind)
+        fileMatches (T.unpack pattern) && containsCreate (fromMaybe WatchKind_Create kind)
       -- TODO: Relative patterns
       watchHits _ = False
 
@@ -428,9 +428,6 @@ createDoc file languageId contents = do
                 | isAbsolute pattern = absFile
                 | otherwise = file
 
-      createHits WatchKind_Create = True
-      createHits _ = False
-
       regHits :: TRegistration Method_WorkspaceDidChangeWatchedFiles -> Bool
       regHits reg = foldl' (\acc w -> acc || watchHits w) False (reg ^. L.registerOptions . _Just . L.watchers)
 

lsp-types/lsp-types.cabal

@@ -127,6 +127,7 @@ library
     Language.LSP.Protocol.Types.Singletons
     Language.LSP.Protocol.Types.Uri
     Language.LSP.Protocol.Types.Uri.OsPath
+    Language.LSP.Protocol.Types.WatchKinds
 
   -- The generated modules
   -- In principle these could be in a separate component,

lsp-types/src/Language/LSP/Protocol/Types.hs

@@ -20,6 +20,8 @@ module Language.LSP.Protocol.Types (
   , module Progress
   -- ** Semantic tokens
   , module SemanticTokens
+  -- ** WatchKinds
+  , module WatchKinds
   -- * Main LSP types and functions
   , module Generated
   ) where
@@ -35,3 +37,4 @@ import Language.LSP.Protocol.Types.Singletons as Singletons
 import Language.LSP.Protocol.Types.Uri as Uri
 import Language.LSP.Protocol.Types.Uri.OsPath as Uri
 import Language.LSP.Protocol.Types.Edit as Edits
+import Language.LSP.Protocol.Types.WatchKinds as WatchKinds

lsp-types/src/Language/LSP/Protocol/Types/WatchKinds.hs

@@ -0,0 +1,37 @@
+module Language.LSP.Protocol.Types.WatchKinds where
+
+import           Language.LSP.Protocol.Internal.Types (WatchKind(..))
+import           Language.LSP.Protocol.Types.LspEnum (toEnumBaseType, fromOpenEnumBaseType)
+import           Data.Set (toList, Set)
+
+-- WatchKind is better represented as a Set than as enum. As the lsp spec
+-- defines them as an enum, these helper functions help bridge the difference.
+
+-- |Tests whether `WatchKind_Create` is contained in the provided WatchKind enum
+containsCreate :: WatchKind -> Bool
+containsCreate WatchKind_Create = True
+containsCreate (WatchKind_Custom 3) = True
+containsCreate (WatchKind_Custom 5) = True
+containsCreate (WatchKind_Custom 7) = True
+containsCreate _ = False
+
+-- |Tests whether `WatchKind_Change` is contained in the provided WatchKind enum
+containsChange :: WatchKind -> Bool
+containsChange WatchKind_Change = True
+containsChange (WatchKind_Custom 3) = True
+containsChange (WatchKind_Custom 6) = True
+containsChange (WatchKind_Custom 7) = True
+containsChange _ = False
+
+-- |Tests whether `WatchKind_Delete` is contained in the provided WatchKind enum
+containsDelete :: WatchKind -> Bool
+containsDelete WatchKind_Delete = True
+containsDelete (WatchKind_Custom 5) = True
+containsDelete (WatchKind_Custom 6) = True
+containsDelete (WatchKind_Custom 7) = True
+containsDelete _ = False
+
+-- |Combine a set of WatchKind types into a new WatchKind type that accurately
+-- represents the set
+combineWatchKinds :: Set WatchKind -> WatchKind
+combineWatchKinds s = fromOpenEnumBaseType $ sum $ toEnumBaseType <$> toList s