Skip to content

Move Common Plugin Functions into PluginUtils #2433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 4, 2021
Merged

Move Common Plugin Functions into PluginUtils #2433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a47da19
Centralize common Functions.
drsooch Nov 29, 2021
af2b906
Merge branch 'master' into refactor-plugin-utils
mergify[bot] Dec 3, 2021
a92f8a2
Merge branch 'master' into refactor-plugin-utils
jneira Dec 4, 2021
941ff19
Merge branch 'master' into refactor-plugin-utils
mergify[bot] Dec 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions hls-plugin-api/hls-plugin-api.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ library
, dependent-sum
, Diff ^>=0.4.0
, dlist
, extra
, ghc
, hashable
, hls-graph >=1.4 && < 1.6
Expand All @@ -54,6 +55,7 @@ library
, process
, regex-tdfa >=1.3.1.0
, text
, transformers
, unordered-containers

if os(windows)
Expand Down
20 changes: 20 additions & 0 deletions hls-plugin-api/src/Ide/PluginUtils.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,22 @@ module Ide.PluginUtils
installSigUsr1Handler,
subRange,
usePropertyLsp,
response,
handleMaybe,
handleMaybeM,
)
where


import Control.Monad.Extra (maybeM)
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Except (ExceptT, runExceptT, throwE)
import Data.Algorithm.Diff
import Data.Algorithm.DiffOutput
import Data.Bifunctor (Bifunctor (first))
import Data.Containers.ListUtils (nubOrdOn)
import qualified Data.HashMap.Strict as H
import Data.String (IsString (fromString))
import qualified Data.Text as T
import Ide.Plugin.Config
import Ide.Plugin.Properties
Expand Down Expand Up @@ -236,3 +244,15 @@ allLspCmdIds pid commands = concatMap go commands
where
go (plid, cmds) = map (mkLspCmdId pid plid . commandId) cmds

-- ---------------------------------------------------------------------

handleMaybe :: Monad m => e -> Maybe b -> ExceptT e m b
handleMaybe msg = maybe (throwE msg) return

handleMaybeM :: Monad m => e -> m (Maybe b) -> ExceptT e m b
handleMaybeM msg act = maybeM (throwE msg) return $ lift act

response :: Monad m => ExceptT String m a -> m (Either ResponseError a)
response =
fmap (first (\msg -> ResponseError InternalError (fromString msg) Nothing))
. runExceptT
2 changes: 0 additions & 2 deletions plugins/hls-alternate-number-format-plugin/hls-alternate-number-format-plugin.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ library
, ghc-boot-th
, hls-graph
, hls-plugin-api >=1.1 && < 1.3
, hls-retrie-plugin
, hie-compat
, lens
, lsp
Expand All @@ -41,7 +40,6 @@ library

default-language: Haskell2010
default-extensions:
CPP
LambdaCase
NamedFieldPuns
OverloadedStrings
Expand Down
2 changes: 1 addition & 1 deletion plugins/hls-alternate-number-format-plugin/src/Ide/Plugin/AlternateNumberFormat.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import Ide.Plugin.Conversion (FormatType, alternateFormat,
toFormatTypes)
import Ide.Plugin.Literals (Literal (..), collectLiterals,
getSrcSpan, getSrcText)
import Ide.Plugin.Retrie (handleMaybe, handleMaybeM,
import Ide.PluginUtils (handleMaybe, handleMaybeM,
response)
import Ide.Types
import Language.LSP.Types
Expand Down
8 changes: 4 additions & 4 deletions plugins/hls-eval-plugin/src/Ide/Plugin/Eval/CodeLens.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,10 @@ import Ide.Plugin.Eval.Parse.Comments (commentsToSections)
import Ide.Plugin.Eval.Parse.Option (parseSetFlags)
import Ide.Plugin.Eval.Rules (queueForEvaluation)
import Ide.Plugin.Eval.Types
import Ide.Plugin.Eval.Util (asS, gStrictTry, handleMaybe,
handleMaybeM, isLiterate,
logWith, response, response',
timed)
import Ide.Plugin.Eval.Util (asS, gStrictTry, isLiterate,
logWith, response', timed)
import Ide.PluginUtils (handleMaybe, handleMaybeM,
response)
import Ide.Types
import Language.LSP.Server
import Language.LSP.Types hiding
Expand Down
20 changes: 1 addition & 19 deletions plugins/hls-eval-plugin/src/Ide/Plugin/Eval/Util.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,15 @@ module Ide.Plugin.Eval.Util (
asS,
timed,
isLiterate,
handleMaybe,
handleMaybeM,
response,
response',
gStrictTry,
logWith,
) where

import Control.Exception (SomeException, evaluate)
import Control.Monad.Extra (maybeM)
import Control.Monad.IO.Class (MonadIO (liftIO))
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Except (ExceptT (..), runExceptT,
throwE)
import Control.Monad.Trans.Except (ExceptT (..), runExceptT)
import Data.Aeson (Value (Null))
import Data.Bifunctor (first)
import Data.String (IsString (fromString))
import qualified Data.Text as T
import Development.IDE (IdeState, Priority (..),
Expand Down Expand Up @@ -71,17 +64,6 @@ logLevel = Debug -- Info
isLiterate :: FilePath -> Bool
isLiterate x = takeExtension x `elem` [".lhs", ".lhs-boot"]

handleMaybe :: Monad m => e -> Maybe b -> ExceptT e m b
handleMaybe msg = maybe (throwE msg) return

handleMaybeM :: Monad m => e -> m (Maybe b) -> ExceptT e m b
handleMaybeM msg act = maybeM (throwE msg) return $ lift act

response :: Functor f => ExceptT String f c -> f (Either ResponseError c)
response =
fmap (first (\msg -> ResponseError InternalError (fromString msg) Nothing))
. runExceptT

response' :: ExceptT String (LspM c) WorkspaceEdit -> LspM c (Either ResponseError Value)
response' act = do
res <- runExceptT act
Expand Down
1 change: 0 additions & 1 deletion plugins/hls-rename-plugin/hls-rename-plugin.cabal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ library
, ghcide >=1.4 && <1.6
, hiedb
, hls-plugin-api ^>=1.2
, hls-retrie-plugin >=1.0.1.1
, lsp
, lsp-types
, syb
Expand Down
1 change: 0 additions & 1 deletion plugins/hls-rename-plugin/src/Ide/Plugin/Rename.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import Name
#endif
import HieDb.Query
import Ide.Plugin.Config
import Ide.Plugin.Retrie hiding (descriptor)
import Ide.PluginUtils
import Ide.Types
import Language.Haskell.GHC.ExactPrint
Expand Down
21 changes: 3 additions & 18 deletions plugins/hls-retrie-plugin/src/Ide/Plugin/Retrie.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,17 @@

{-# OPTIONS -Wno-orphans #-}

module Ide.Plugin.Retrie (descriptor, response, handleMaybe, handleMaybeM) where
module Ide.Plugin.Retrie (descriptor) where

import Control.Concurrent.Extra (readVar)
import Control.Exception.Safe (Exception (..),
SomeException, catch,
throwIO, try)
import Control.Monad (forM, unless)
import Control.Monad.Extra (maybeM)
import Control.Monad.IO.Class (MonadIO (liftIO))
import Control.Monad.Trans.Class (MonadTrans (lift))
import Control.Monad.Trans.Except (ExceptT (..), runExceptT,
throwE)
import Control.Monad.Trans.Except (ExceptT (ExceptT),
runExceptT)
import Control.Monad.Trans.Maybe
import Data.Aeson (FromJSON (..),
ToJSON (..),
Expand Down Expand Up @@ -499,20 +498,6 @@ _useRuleStale label state rule f =
-- | Chosen approach for calling ghcide Shake rules
useRule label = _useRuleStale ("Retrie." <> label)

-------------------------------------------------------------------------------
-- Error handling combinators

handleMaybe :: Monad m => e -> Maybe b -> ExceptT e m b
handleMaybe msg = maybe (throwE msg) return

handleMaybeM :: Monad m => e -> m (Maybe b) -> ExceptT e m b
handleMaybeM msg act = maybeM (throwE msg) return $ lift act

response :: Monad m => ExceptT String m a -> m (Either ResponseError a)
response =
fmap (first (\msg -> ResponseError InternalError (fromString msg) Nothing))
. runExceptT

-------------------------------------------------------------------------------
-- Serialization wrappers and instances

Expand Down