support selection range lsp feature

.github/workflows/hackage.yml

@@ -32,7 +32,7 @@ jobs:
                   "hls-refine-imports-plugin", "hls-retrie-plugin",
                   "hls-splice-plugin", "hls-tactics-plugin",
                   "hls-call-hierarchy-plugin", "hls-alternate-number-format-plugin",
-                  "hls-qualify-imported-names-plugin",
+                  "hls-qualify-imported-names-plugin", "hls-selection-range-plugin",
                   "haskell-language-server"]
         ghc: [ "9.0.2"
              , "8.10.7"

.github/workflows/test.yml

@@ -234,6 +234,10 @@ jobs:
         name: Test hls-qualify-imported-names-plugin test suite
         run: cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-qualify-imported-names-plugin --test-options="$TEST_OPTS"
 
+      - if: matrix.test
+        name: Test hls-selection-range-plugin test suite
+        run: cabal test hls-selection-range-plugin --test-options="$TEST_OPTS" || cabal test hls-selection-range-plugin --test-options="$TEST_OPTS" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-selection-range-plugin --test-options="$TEST_OPTS"
+
   test_post_job:
     if: always()
     runs-on: ubuntu-latest

cabal-ghc90.project

@@ -26,6 +26,7 @@ packages:
          ./plugins/hls-ormolu-plugin
          ./plugins/hls-call-hierarchy-plugin
          ./plugins/hls-alternate-number-format-plugin
+         ./plugins/hls-selection-range-plugin
 
 tests: true
 
@@ -35,7 +36,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2022-01-11T22:05:45Z
+index-state: 2022-01-21T11:23:29Z
 
 constraints:
   -- These plugins don't work on GHC9 yet

cabal-ghc921.project

@@ -26,6 +26,7 @@ packages:
          ./plugins/hls-ormolu-plugin
          ./plugins/hls-call-hierarchy-plugin
          ./plugins/hls-alternate-number-format-plugin
+         ./plugins/hls-selection-range-plugin
 
 with-compiler: ghc-9.2.1
 
@@ -37,7 +38,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2022-01-11T22:05:45Z
+index-state: 2022-01-21T11:23:29Z
 
 constraints:
   -- These plugins don't build/work on GHC92 yet

cabal.project

@@ -26,6 +26,7 @@ packages:
          ./plugins/hls-call-hierarchy-plugin
          ./plugins/hls-alternate-number-format-plugin
          ./plugins/hls-qualify-imported-names-plugin
+         ./plugins/hls-selection-range-plugin
 
 -- Standard location for temporary packages needed for particular environments
 -- For example it is used in the project gitlab mirror to help in the MAcOS M1 build script
@@ -40,7 +41,7 @@ package *
 
 write-ghc-environment-files: never
 
-index-state: 2022-01-11T22:05:45Z
+index-state: 2022-01-21T11:23:29Z
 
 constraints:
     hyphenation +embed

docs/features.md

@@ -18,6 +18,7 @@ Many of these are standard LSP features, but a lot of special features are provi
 | [Highlight references](#highlight-references)       | `textDocument/documentHighlight`                                                                  |
 | [Code actions](#code-actions)                       | `textDocument/codeAction`                                                                         |
 | [Code lenses](#code-lenses)                         | `textDocument/codeLens`                                                                           |
+| [Selection range](#selection-range)                 | `textDocument/selectionRange` |
 
 The individual sections below also identify which [HLS plugin](./what-is-hls.md#hls-plugins) is responsible for providing the given functionality, which is useful if you want to raise an issue report or contribute!
 Additionally, not all plugins are supported on all versions of GHC, see the [GHC version support page](supported-versions.md) for details.
@@ -141,7 +142,7 @@ Code action kind: `quickfix`
 Rewrites imported names to be qualified.
 
 ![Qualify Imported Names Demo](../plugins/hls-qualify-imported-names-plugin/qualify-imported-names-demo.gif)
- 
+
 For usage see the ![readme](../plugins/hls-qualify-imported-names-plugin/README.md).
 
 ### Refine import
@@ -239,6 +240,13 @@ Shows module name matching file path, and applies it with a click.
 
 ![Module Name Demo](https://user-images.githubusercontent.com/54035/110860755-78ad8680-82bd-11eb-9845-9ea4b1cc1f76.gif)
 
+## Selection range
+Provided by: `hls-selection-range-plugin`
+
+Provides haskell specific
+[shrink/expand selection](https://code.visualstudio.com/docs/editor/codebasics#shrinkexpand-selection)
+support.
+
 ## Missing features
 
 The following features are supported by the LSP specification but not implemented in HLS.
@@ -251,7 +259,6 @@ Contributions welcome!
 | Jump to implementation | Unclear if useful                                                                        | `textDocument/implementation`                       |
 | Renaming               | [Parital implementation](https://github.com/haskell/haskell-language-server/issues/2193) | `textDocument/rename`, `textDocument/prepareRename` |
 | Folding                | Unimplemented                                                                            | `textDocument/foldingRange`                         |
-| Selection range        | Unimplemented                                                                            | `textDocument/selectionRange`                       |
 | Semantic tokens        | Unimplemented                                                                            | `textDocument/semanticTokens`                       |
 | Linked editing         | Unimplemented                                                                            | `textDocument/linkedEditingRange`                   |
 | Document links         | Unimplemented                                                                            | `textDocument/documentLink`                         |

docs/supported-versions.md

@@ -50,6 +50,7 @@ As such, the functionality provided by those plugins is not available in HLS whe
 | `hls-splice-plugin`                 | 9.2                      |
 | `hls-stylish-haskell-plugin`        | 9.0, 9.2                 |
 | `hls-tactics-plugin`                | 9.2                      |
+| `hls-selection-range-plugin`        |                          |
 
 ### Using deprecated GHC versions
 

exe/Plugins.hs

@@ -72,6 +72,10 @@ import           Ide.Plugin.Splice                 as Splice
 import           Ide.Plugin.AlternateNumberFormat  as AlternateNumberFormat
 #endif
 
+#if selectionRange
+import           Ide.Plugin.SelectionRange         as SelectionRange
+#endif
+
 -- formatters
 
 #if floskell
@@ -167,6 +171,9 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
 #endif
 #if alternateNumberFormat
       AlternateNumberFormat.descriptor "alternateNumberFormat" :
+#endif
+#if selectionRange
+      SelectionRange.descriptor "selectionRange" :
 #endif
     -- The ghcide descriptors should come last so that the notification handlers
     -- (which restart the Shake build) run after everything else

flake_hackage/flake.nix

@@ -7,7 +7,7 @@
       flake = false;
     };
     lsp-types = {
-      url = "https://hackage.haskell.org/package/lsp-types-1.4.0.0/lsp-types-1.4.0.0.tar.gz";
+      url = "https://hackage.haskell.org/package/lsp-types-1.4.0.1/lsp-types-1.4.0.1.tar.gz";
       flake = false;
     };
     lsp-test = {

ghcide/ghcide.cabal

@@ -64,7 +64,7 @@ library
         lens,
         list-t,
         hiedb == 0.4.1.*,
-        lsp-types ^>= 1.4.0.0,
+        lsp-types ^>= 1.4.0.1,
         lsp ^>= 1.4.0.0 ,
         monoid-subclasses,
         mtl,

ghcide/src/Development/IDE/GHC/Compat.hs

@@ -32,6 +32,10 @@ module Development.IDE.GHC.Compat(
 
     nodeInfo',
     getNodeIds,
+    nodeInfoFromSource,
+    isAnnotationInNodeInfo,
+    mkAstNode,
+    combineRealSrcSpans,
 
     isQualifiedImport,
     GhcVersion(..),
@@ -67,71 +71,75 @@ module Development.IDE.GHC.Compat(
     runPp,
     ) where
 
-import           GHC                    hiding (HasSrcSpan, ModLocation, getLoc,
-                                         lookupName, RealSrcSpan)
-import Development.IDE.GHC.Compat.Core
-import Development.IDE.GHC.Compat.Env
-import Development.IDE.GHC.Compat.ExactPrint
-import Development.IDE.GHC.Compat.Iface
-import Development.IDE.GHC.Compat.Logger
-import Development.IDE.GHC.Compat.Outputable
-import Development.IDE.GHC.Compat.Parser
-import Development.IDE.GHC.Compat.Plugins
-import Development.IDE.GHC.Compat.Units
-import Development.IDE.GHC.Compat.Util
+import           Development.IDE.GHC.Compat.Core
+import           Development.IDE.GHC.Compat.Env
+import           Development.IDE.GHC.Compat.ExactPrint
+import           Development.IDE.GHC.Compat.Iface
+import           Development.IDE.GHC.Compat.Logger
+import           Development.IDE.GHC.Compat.Outputable
+import           Development.IDE.GHC.Compat.Parser
+import           Development.IDE.GHC.Compat.Plugins
+import           Development.IDE.GHC.Compat.Units
+import           Development.IDE.GHC.Compat.Util
+import           GHC                                   hiding (HasSrcSpan,
+                                                        ModLocation,
+                                                        RealSrcSpan, getLoc,
+                                                        lookupName)
 
 #if MIN_VERSION_ghc(9,0,0)
 import           GHC.Data.StringBuffer
-import           GHC.Driver.Session    hiding (ExposePackage)
+import           GHC.Driver.Session                    hiding (ExposePackage)
+import qualified GHC.Types.SrcLoc                      as SrcLoc
 import           GHC.Utils.Error
 #if MIN_VERSION_ghc(9,2,0)
 import           Data.Bifunctor
-import           GHC.Unit.Module.ModSummary
-import           GHC.Driver.Env as Env
+import           GHC.Driver.Env                        as Env
 import           GHC.Unit.Module.ModIface
+import           GHC.Unit.Module.ModSummary
 #else
 import           GHC.Driver.Types
 #endif
 import           GHC.Iface.Env
-import           GHC.Iface.Make           (mkIfaceExports)
-import qualified GHC.SysTools.Tasks       as SysTools
-import qualified GHC.Types.Avail          as Avail
+import           GHC.Iface.Make                        (mkIfaceExports)
+import qualified GHC.SysTools.Tasks                    as SysTools
+import qualified GHC.Types.Avail                       as Avail
 #else
-import           DynFlags               hiding (ExposePackage)
-import           HscTypes
-import           MkIface hiding (writeIfaceFile)
 import qualified Avail
+import           DynFlags                              hiding (ExposePackage)
+import           HscTypes
+import           MkIface                               hiding (writeIfaceFile)
 
 #if MIN_VERSION_ghc(8,8,0)
-import           StringBuffer           (hPutStringBuffer)
+import           StringBuffer                          (hPutStringBuffer)
 #endif
 import qualified SysTools
 
 #if !MIN_VERSION_ghc(8,8,0)
-import           SrcLoc                 (RealLocated)
 import qualified EnumSet
+import           SrcLoc                                (RealLocated)
 
 import           Foreign.ForeignPtr
 import           System.IO
 #endif
 #endif
 
-import           Compat.HieAst          (enrichHie)
+import           Compat.HieAst                         (enrichHie)
 import           Compat.HieBin
 import           Compat.HieTypes
 import           Compat.HieUtils
-import qualified Data.ByteString        as BS
+import qualified Data.ByteString                       as BS
 import           Data.IORef
 
-import qualified Data.Map               as Map
-import           Data.List              (foldl')
+import           Data.List                             (foldl')
+import qualified Data.Map                              as Map
+import qualified Data.Set                              as Set
 
 #if MIN_VERSION_ghc(9,0,0)
-import qualified Data.Set               as S
+import qualified Data.Set                              as S
 #endif
 
 #if !MIN_VERSION_ghc(8,10,0)
-import Bag (unitBag)
+import           Bag                                   (unitBag)
 #endif
 
 #if !MIN_VERSION_ghc(9,2,0)
@@ -334,6 +342,13 @@ nodeInfo' = nodeInfo
 -- unhelpfulSpanFS = id
 #endif
 
+nodeInfoFromSource :: HieAST a -> Maybe (NodeInfo a)
+#if MIN_VERSION_ghc(9,0,0)
+nodeInfoFromSource = Map.lookup SourceInfo . getSourcedNodeInfo . sourcedNodeInfo
+#else
+nodeInfoFromSource = Just . nodeInfo
+#endif
+
 data GhcVersion
   = GHC86
   | GHC88
@@ -373,3 +388,31 @@ runPp =
 #else
     const SysTools.runPp
 #endif
+
+isAnnotationInNodeInfo :: (FastString, FastString) -> NodeInfo a -> Bool
+#if MIN_VERSION_ghc(9,2,0)
+isAnnotationInNodeInfo (ctor, typ) = Set.member (NodeAnnotation ctor typ) . nodeAnnotations
+#else
+isAnnotationInNodeInfo p = Set.member p . nodeAnnotations
+#endif
+
+mkAstNode :: NodeInfo a -> Span -> [HieAST a] -> HieAST a
+#if MIN_VERSION_ghc(9,0,0)
+mkAstNode n = Node (SourcedNodeInfo $ Map.singleton GeneratedInfo n)
+#else
+mkAstNode = Node
+#endif
+
+combineRealSrcSpans :: RealSrcSpan -> RealSrcSpan -> RealSrcSpan
+#if MIN_VERSION_ghc(9,2,0)
+combineRealSrcSpans = SrcLoc.combineRealSrcSpans
+#else
+combineRealSrcSpans span1 span2
+  = mkRealSrcSpan (mkRealSrcLoc file line_start col_start) (mkRealSrcLoc file line_end col_end)
+  where
+    (line_start, col_start) = min (srcSpanStartLine span1, srcSpanStartCol span1)
+                                  (srcSpanStartLine span2, srcSpanStartCol span2)
+    (line_end, col_end)     = max (srcSpanEndLine span1, srcSpanEndCol span1)
+                                  (srcSpanEndLine span2, srcSpanEndCol span2)
+    file = srcSpanFile span1
+#endif

haskell-language-server.cabal

@@ -176,6 +176,11 @@ flag qualifyImportedNames
   default:     True
   manual:      True
 
+flag selectionRange
+  description: Enable selectionRange plugin
+  default:     True
+  manual:      True
+
 -- formatters
 
 flag floskell
@@ -283,6 +288,11 @@ common qualifyImportedNames
     build-depends: hls-qualify-imported-names-plugin ^>=1.0.0.0
     cpp-options: -DqualifyImportedNames
 
+common selectionRange
+  if flag(selectionRange)
+    build-depends: hls-selection-range-plugin ^>=1.0.0.0
+    cpp-options: -DselectionRange
+
 -- formatters
 
 common floskell
@@ -332,6 +342,7 @@ executable haskell-language-server
                     , splice
                     , alternateNumberFormat
                     , qualifyImportedNames
+                    , selectionRange
                     , floskell
                     , fourmolu
                     , ormolu