hls-cabal-project-plugin: Add completions suggestions for cabal.project files.

Author: rm41339

haskell-language-server.cabal

@@ -345,6 +345,8 @@ library hls-cabal-project-plugin
     Ide.Plugin.CabalProject.Parse
     Ide.Plugin.CabalProject.Diagnostics
     Ide.Plugin.CabalProject.Types
+    Ide.Plugin.CabalProject.Completion.Completions
+    Ide.Plugin.CabalProject.Completion.Data
 
   build-depends:
     , bytestring
@@ -387,6 +389,7 @@ test-suite hls-cabal-project-plugin-tests
   hs-source-dirs:   plugins/hls-cabal-project-plugin/test
   main-is:          Main.hs
   other-modules:
+    Completer
     Utils
   build-depends:
     , bytestring
@@ -401,77 +404,7 @@ test-suite hls-cabal-project-plugin-tests
     , text
     , hls-plugin-api
     , cabal-install
-
------------------------------
--- cabal project plugin
------------------------------
-
-flag cabalProject
-  description: Enable cabalProject plugin
-  default:     True
-  manual:      True
-
-common cabalProject
-  if flag(cabalProject)
-    build-depends: haskell-language-server:hls-cabal-project-plugin
-    cpp-options: -Dhls_cabal_project
-
-library hls-cabal-project-plugin
-  import:           defaults, pedantic, warnings
-  if !flag(cabal)
-    buildable: False
-  exposed-modules:
-    Ide.Plugin.CabalProject
-
-
-  build-depends:
-    , bytestring
-    , Cabal-syntax          >= 3.7
-    , containers
-    , deepseq
-    , directory
-    , filepath
-    , extra                 >=1.7.4
-    , ghcide                == 2.9.0.1
-    , hashable
-    , hls-plugin-api        == 2.9.0.1
-    , hls-graph             == 2.9.0.1
-    , lens
-    , lsp                   ^>=2.7
-    , lsp-types             ^>=2.3
-    , regex-tdfa            ^>=1.3.1
-    , text
-    , text-rope
-    , transformers
-    , unordered-containers  >=0.2.10.0
-    , containers
-    , process
-    , aeson
-    , Cabal
-    , pretty
-
-  hs-source-dirs:   plugins/hls-cabal-project-plugin/src
-
-test-suite hls-cabal-project-plugin-tests
-  import:           defaults, pedantic, test-defaults, warnings
-  if !flag(cabalProject)
-    buildable: False
-  type:             exitcode-stdio-1.0
-  hs-source-dirs:   plugins/hls-cabal-project-plugin/test
-  main-is:          Main.hs
-  other-modules:
-  build-depends:
-    , bytestring
-    , Cabal-syntax          >= 3.7
-    , extra
-    , filepath
-    , ghcide
-    , haskell-language-server:hls-cabal-project-plugin
-    , hls-test-utils    == 2.9.0.1
-    , lens
-    , lsp-types
-    , text
-    , hls-plugin-api
+    , haskell-language-server:hls-cabal-plugin
 
 -----------------------------
 -- class plugin

plugins/hls-cabal-plugin/test/testdata/completer.cabal

@@ -11,4 +11,4 @@ be
 library
     lib
 
-co
+co

plugins/hls-cabal-project-plugin/src/Ide/Plugin/CabalProject.hs

@@ -9,31 +9,45 @@ module Ide.Plugin.CabalProject where
 
 import           Control.Concurrent.Strict
 import           Control.DeepSeq
+import           Control.Lens                                   ((^.))
 import           Control.Monad.Extra
 import           Control.Monad.IO.Class
-import qualified Data.ByteString                     as BS
+import           Control.Monad.Trans.Maybe                      (runMaybeT)
+import qualified Data.ByteString                                as BS
 import           Data.Hashable
-import           Data.HashMap.Strict                 (HashMap)
-import qualified Data.HashMap.Strict                 as HashMap
-import qualified Data.List.NonEmpty                  as NE
+import           Data.HashMap.Strict                            (HashMap)
+                                                                --  toList)
+import qualified Data.HashMap.Strict                            as HashMap
+import qualified Data.List.NonEmpty                             as NE
 import           Data.Proxy
-import qualified Data.Text                           ()
-import qualified Data.Text.Encoding                  as Encoding
-import           Data.Text.Utf16.Rope.Mixed          as Rope
-import           Development.IDE                     as D
-import           Development.IDE.Core.Shake          (restartShakeSession)
-import qualified Development.IDE.Core.Shake          as Shake
-import           Development.IDE.Graph               (Key, alwaysRerun)
-import           Development.IDE.Types.Shake         (toKey)
+import qualified Data.Text                                      ()
+import qualified Data.Text.Encoding                             as Encoding
+import           Data.Text.Utf16.Rope.Mixed                     as Rope
+import           Development.IDE                                as D
+import           Development.IDE.Core.Shake                     (restartShakeSession)
+import qualified Development.IDE.Core.Shake                     as Shake
+import           Development.IDE.Graph                          (Key,
+                                                                 alwaysRerun)
+import qualified Development.IDE.Plugin.Completions.Logic       as Ghcide
+import           Development.IDE.Types.Shake                    (toKey)
+import qualified Distribution.Fields                            as Syntax
+-- import           Distribution.PackageDescription                (allBuildDepends,
+--                                                                  depPkgName,
+--                                                                  unPackageName)
+import qualified Distribution.Parsec.Position                   as Syntax
 import           GHC.Generics
-import           Ide.Plugin.Cabal.Orphans            ()
-import           Ide.Plugin.CabalProject.Diagnostics as Diagnostics
-import           Ide.Plugin.CabalProject.Parse       as Parse
-import           Ide.Plugin.CabalProject.Types       as Types
+import qualified Ide.Plugin.Cabal.Completion.Completer.Types    as CompleterTypes
+import qualified Ide.Plugin.Cabal.Completion.Types              as CTypes
+import           Ide.Plugin.Cabal.Orphans                       ()
+import qualified Ide.Plugin.CabalProject.Completion.Completions as Completions
+import           Ide.Plugin.CabalProject.Diagnostics            as Diagnostics
+import           Ide.Plugin.CabalProject.Parse                  as Parse
+import           Ide.Plugin.CabalProject.Types                  as Types
 import           Ide.Types
-import qualified Language.LSP.Protocol.Message       as LSP
+import qualified Language.LSP.Protocol.Lens                     as JL
+import qualified Language.LSP.Protocol.Message                  as LSP
 import           Language.LSP.Protocol.Types
-import qualified Language.LSP.VFS                    as VFS
+import qualified Language.LSP.VFS                               as VFS
 
 data Log
   = LogModificationTime NormalizedFilePath FileVersion
@@ -43,6 +57,8 @@ data Log
   | LogDocSaved Uri
   | LogDocClosed Uri
   | LogFOI (HashMap NormalizedFilePath FileOfInterestStatus)
+  | LogCompletionContext CTypes.Context Position
+  | LogCompletions CTypes.Log
   deriving (Show)
 
 instance Pretty Log where
@@ -60,11 +76,22 @@ instance Pretty Log where
       "Closed text document:" <+> pretty (getUri uri)
     LogFOI files ->
       "Set files of interest to:" <+> viaShow files
+    LogCompletionContext context position ->
+      "Determined completion context:"
+        <+> pretty context
+        <+> "for cursor position:"
+        <+> pretty position
+    LogCompletions logs -> pretty logs
 
 descriptor :: Recorder (WithPriority Log) -> PluginId -> PluginDescriptor IdeState
 descriptor recorder plId =
   (defaultCabalProjectPluginDescriptor plId "Provides a variety of IDE features in cabal.project files")
     { pluginRules = cabalProjectRules recorder plId
+    , pluginHandlers =
+        mconcat
+          [
+          mkPluginHandler LSP.SMethod_TextDocumentCompletion $ completion recorder
+          ]
     , pluginNotificationHandlers =
         mconcat
           [ mkPluginNotificationHandler LSP.SMethod_TextDocumentDidOpen $
@@ -179,8 +206,8 @@ cabalProjectRules recorder plId = do
  where
   log' = logWith recorder
 
-{- | This is the kick function for the cabal.project plugin.
-We run this action, whenever a shake session is run/restarted, which triggers
+{- | This is the kick function for the cabal project plugin.
+We run this action, whenever we shake session us run/restarted, which triggers
 actions to produce diagnostics for cabal.project files.
 
 It is paramount that this kick-function can be run quickly, since it is a blocking
@@ -189,6 +216,7 @@ function invocation.
 kick :: Action ()
 kick = do
   files <- HashMap.keys <$> getCabalProjectFilesOfInterestUntracked
+--   let keys = map Types.ParseCabalProjectFile files
   Shake.runWithSignal (Proxy @"kick/start/cabal-project") (Proxy @"kick/done/cabal-project") files Types.ParseCabalProjectFile
 
 
@@ -266,3 +294,49 @@ deleteFileOfInterest recorder state f = do
   return [toKey IsFileOfInterest f]
  where
   log' = logWith recorder
+
+-- ----------------------------------------------------------------
+-- Completion
+-- ----------------------------------------------------------------
+
+completion :: Recorder (WithPriority Log) -> PluginMethodHandler IdeState 'LSP.Method_TextDocumentCompletion
+completion recorder ide _ complParams = do
+  let TextDocumentIdentifier uri = complParams ^. JL.textDocument
+      position = complParams ^. JL.position
+  mContents <- liftIO $ runAction "cabal-project-plugin.getUriContents" ide $ getUriContents $ toNormalizedUri uri
+  case (,) <$> mContents <*> uriToFilePath' uri of
+    Just (cnts, path) -> do
+      mFields <- liftIO $ runAction "cabal-project-plugin.fields" ide $ useWithStale ParseCabalProjectFields $ toNormalizedFilePath path
+      case mFields of
+        Nothing ->
+          pure . InR $ InR Null
+        Just (fields, _) -> do
+          let lspPrefInfo = Ghcide.getCompletionPrefixFromRope position cnts
+              cabalProjectPrefInfo = Completions.getCabalProjectPrefixInfo path lspPrefInfo
+          let res = computeCompletionsAt recorder ide cabalProjectPrefInfo path fields
+          liftIO $ fmap InL res
+    Nothing -> pure . InR $ InR Null
+
+computeCompletionsAt :: Recorder (WithPriority Log) -> IdeState -> CTypes.CabalPrefixInfo -> FilePath -> [Syntax.Field Syntax.Position] -> IO [CompletionItem]
+computeCompletionsAt recorder _ prefInfo _ fields = do
+  runMaybeT (context fields) >>= \case
+    Nothing -> pure []
+    Just ctx -> do
+      logWith recorder Debug $ LogCompletionContext ctx pos
+      let completer = Completions.contextToCompleter ctx
+      let completerData = CompleterTypes.CompleterData
+            {
+            getLatestGPD = pure Nothing,
+            getCabalCommonSections = pure Nothing,
+            cabalPrefixInfo = prefInfo
+            , stanzaName =
+            case fst ctx of
+                CTypes.Stanza _ name -> name
+                _                    -> Nothing
+            }
+      completions <- completer completerRecorder completerData
+      pure completions
+  where
+    pos = CTypes.completionCursorPosition prefInfo
+    context fields = Completions.getContext completerRecorder prefInfo fields
+    completerRecorder = cmapWithPrio LogCompletions recorder