44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE TypeFamilies #-}
66
7- module Ide.Plugin.Cabal (descriptor , Log (.. )) where
7+ module Ide.Plugin.Cabal (descriptor , haskellInteractionDescriptor , Log (.. )) where
88
99import Control.Concurrent.Strict
1010import Control.DeepSeq
@@ -54,6 +54,35 @@ import Ide.Plugin.Cabal.Orphans ()
5454import Ide.Plugin.Cabal.Outline
5555import qualified Ide.Plugin.Cabal.Parse as Parse
5656import Ide.Plugin.Error
57+ import Data.HashMap.Strict (HashMap )
58+ import qualified Data.HashMap.Strict as HashMap
59+ import qualified Data.List.NonEmpty as NE
60+ import qualified Data.Maybe as Maybe
61+ import qualified Data.Text as T
62+ import qualified Data.Text.Encoding as Encoding
63+ import Data.Typeable
64+ import Development.IDE as D
65+ import Development.IDE.Core.Shake (restartShakeSession )
66+ import qualified Development.IDE.Core.Shake as Shake
67+ import Development.IDE.Graph (Key , alwaysRerun )
68+ import qualified Development.IDE.Plugin.Completions.Logic as Ghcide
69+ import Development.IDE.Types.Shake (toKey )
70+ import qualified Distribution.Fields as Syntax
71+ import qualified Distribution.Parsec.Position as Syntax
72+ import GHC.Generics
73+ import qualified Ide.Plugin.Cabal.Completion.Completer.Types as CompleterTypes
74+ import qualified Ide.Plugin.Cabal.Completion.Completions as Completions
75+ import Ide.Plugin.Cabal.Completion.Types (ParseCabalCommonSections (ParseCabalCommonSections ),
76+ ParseCabalFields (.. ),
77+ ParseCabalFile (.. ))
78+ import qualified Ide.Plugin.Cabal.Completion.Types as Types
79+ import Ide.Plugin.Cabal.Definition (gotoDefinition )
80+ import qualified Ide.Plugin.Cabal.Diagnostics as Diagnostics
81+ import qualified Ide.Plugin.Cabal.FieldSuggest as FieldSuggest
82+ import qualified Ide.Plugin.Cabal.LicenseSuggest as LicenseSuggest
83+ import Ide.Plugin.Cabal.Orphans ()
84+ import Ide.Plugin.Cabal.Outline
85+ import qualified Ide.Plugin.Cabal.Parse as Parse
5786import Ide.Types
5887import qualified Language.LSP.Protocol.Lens as JL
5988import qualified Language.LSP.Protocol.Message as LSP
@@ -62,6 +91,9 @@ import qualified Language.LSP.VFS as VFS
6291import Text.Regex.TDFA
6392
6493
94+ import qualified Data.Text ()
95+ import qualified Ide.Plugin.Cabal.CabalAdd as CabalAdd
96+
6597data Log
6698 = LogModificationTime NormalizedFilePath FileVersion
6799 | LogShake Shake. Log
@@ -72,6 +104,7 @@ data Log
72104 | LogFOI (HashMap NormalizedFilePath FileOfInterestStatus )
73105 | LogCompletionContext Types. ContextPosition
74106 | LogCompletions Types. Log
107+ | LogCabalAdd CabalAdd. Log
75108 deriving (Show )
76109
77110instance Pretty Log where
@@ -95,6 +128,25 @@ instance Pretty Log where
95128 <+> " for cursor position:"
96129 <+> pretty position
97130 LogCompletions logs -> pretty logs
131+ LogCabalAdd logs -> pretty logs
132+
133+ -- | Some actions with cabal files originate from haskell files.
134+ -- This descriptor allows to hook into the diagnostics of haskell source files, and
135+ -- allows us to provide code actions and commands that interact with `.cabal` files.
136+ haskellInteractionDescriptor :: Recorder (WithPriority Log ) -> PluginId -> PluginDescriptor IdeState
137+ haskellInteractionDescriptor recorder plId =
138+ (defaultPluginDescriptor plId " Provides the cabal-add code action in haskell files"
139+ { pluginHandlers =
140+ mconcat
141+ [ mkPluginHandler LSP. SMethod_TextDocumentCodeAction
142+ ]
143+ , pluginCommands = [PluginCommand CabalAdd. cabalAddCommand " add a dependency to a cabal file" CabalAdd. command cabalAddRecorder)]
144+ , pluginRules = pure ()
145+ , pluginNotificationHandlers = mempty
146+ }
147+ where
148+ cabalAddRecorder = cmapWithPrio LogCabalAdd recorder
149+
98150
99151descriptor :: Recorder (WithPriority Log ) -> PluginId -> PluginDescriptor IdeState
100152descriptor recorder plId =
@@ -319,6 +371,32 @@ gotoDefinition ideState _ msgParam = do
319371 isSectionArgName name (Syntax. Section= name == CabalFields. onelineSectionArgs sectionArgName
320372 isSectionArgName _ _ = False
321373
374+
375+ cabalAddCodeAction :: PluginMethodHandler IdeState 'LSP.Method_TextDocumentCodeAction
376+ cabalAddCodeAction state plId (CodeActionParams _ _ (TextDocumentIdentifier uri) _ CodeActionContext {_diagnostics= diags}) = do
377+ maxCompls <- fmap maxCompletions . liftIO $ runAction " cabal.cabal-add"
378+ let suggestions = take maxCompls $ concatMap CabalAdd. hiddenPackageSuggestion diags
379+ case suggestions of
380+ [] -> pure $ InL []
381+ _ ->
382+ case uriToFilePath uri of
383+ Nothing -> pure $ InL []
384+ Just haskellFilePath -> do
385+ mbCabalFile <- liftIO $ CabalAdd. findResponsibleCabalFile haskellFilePath
386+ case mbCabalFile of
387+ Nothing -> pure $ InL []
388+ Just cabalFilePath -> do
389+ verTxtDocId <- lift $ pluginGetVersionedTextDoc $ TextDocumentIdentifier (filePathToUri cabalFilePath)
390+ mbGPD <- liftIO $ runAction " cabal.cabal-add" $ useWithStale ParseCabalFile $ toNormalizedFilePath cabalFilePath
391+ case mbGPD of
392+ Nothing -> pure $ InL []
393+ Just (gpd, _) -> do
394+ actions <- liftIO $ CabalAdd. addDependencySuggestCodeAction plId verTxtDocId
395+ suggestions
396+ haskellFilePath cabalFilePath
397+ gpd
398+ pure $ InL $ fmap InR actions
399+
322400-- | Handler for hover messages.
323401--
324402-- Provides a Handler for displaying message on hover.
@@ -361,6 +439,7 @@ hover ide _ msgParam = do
361439 documentationText :: T. Text-> T. Text
362440 documentationText package = " [Documentation](https://hackage.haskell.org/package/" <> package <> " )"
363441
442+
364443-- ----------------------------------------------------------------
365444-- Cabal file of Interest rules and global variable
366445-- ----------------------------------------------------------------
0 commit comments