Skip to content

Commit cd761ed

Browse files
AilrunAilrun
committed
Implements basic Class plugin
1 parent b649b15 commit cd761ed

File tree

13 files changed

+398
-16
lines changed

13 files changed

+398
-16
lines changed

‎exe/Main.hs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import Ide.Types (IdePlugins)
1212

1313
-- haskell-language-server plugins
1414

15+
import Ide.Plugin.Class as Class
1516
import Ide.Plugin.Eval as Eval
1617
import Ide.Plugin.Example as Example
1718
import Ide.Plugin.Example2 as Example2
@@ -59,6 +60,7 @@ idePlugins includeExamples = pluginDescToIdePlugins allPlugins
5960
#if AGPL
6061
, Brittany.descriptor "brittany"
6162
#endif
63+
, Class.descriptor "class"
6264
, Eval.descriptor "eval"
6365
, ExplicitImports.descriptor "importLens"
6466
, ModuleName.descriptor "moduleName"

‎haskell-language-server.cabal

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ executable haskell-language-server
118118
, hashable
119119
, haskell-language-server
120120
, haskell-lsp ^>=0.22
121+
, hls-class-plugin
121122
, hls-hlint-plugin
122123
, hls-plugin-api
123124
, hls-tactics-plugin

‎plugins/hls-class-plugin/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎plugins/hls-class-plugin/hls-class-plugin.cabal

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
cabal-version: 2.2
2+
name: hls-class-plugin
3+
version: 0.1.0.0
4+
synopsis: Explicit imports plugin for Haskell Language Server
5+
license: Apache-2.0
6+
license-file: LICENSE
7+
author: Junyoung Clare Jang
8+
maintainer: jjc9310@gmail.com
9+
category: Development
10+
build-type: Simple
11+
12+
library
13+
exposed-modules: Ide.Plugin.Class
14+
hs-source-dirs: src
15+
build-depends: aeson
16+
, base
17+
, containers
18+
, deepseq
19+
, haskell-lsp-types
20+
, hls-plugin-api
21+
, ghc
22+
, ghcide
23+
, lens
24+
, shake
25+
, text
26+
, transformers
27+
, unordered-containers
28+
29+
default-language: Haskell2010

‎plugins/hls-class-plugin/src/Ide/Plugin/Class.hs

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
{-# LANGUAGE DeriveAnyClass #-}
2+
{-# LANGUAGE DeriveGeneric #-}
3+
{-# LANGUAGE OverloadedStrings #-}
4+
{-# LANGUAGE RecordWildCards #-}
5+
{-# LANGUAGE TypeFamilies #-}
6+
{-# LANGUAGE ViewPatterns #-}
7+
module Ide.Plugin.Class
8+
( descriptor
9+
) where
10+
11+
import BooleanFormula
12+
import Class
13+
import ConLike
14+
import Control.Applicative
15+
import Control.Lens hiding (List)
16+
import Control.Monad
17+
import Data.Aeson
18+
import Data.Char
19+
import Data.List
20+
import qualified Data.Map.Strict as Map
21+
import Data.Maybe
22+
import qualified Data.Text as T
23+
import Development.IDE
24+
import Development.IDE.GHC.Compat
25+
import Development.IDE.Spans.AtPoint
26+
import qualified GHC.Generics as Generics
27+
import GhcPlugins hiding (Var, (<>))
28+
import Ide.Plugin
29+
import Ide.Types
30+
import Language.Haskell.LSP.Types
31+
import qualified Language.Haskell.LSP.Types.Lens as J
32+
import TcEnv
33+
import TcRnMonad
34+
import qualified Data.HashMap.Strict as H
35+
36+
descriptor :: PluginId -> PluginDescriptor
37+
descriptor plId = (defaultPluginDescriptor plId)
38+
{ pluginCommands = commands
39+
, pluginCodeActionProvider = Just codeAction
40+
}
41+
42+
commands :: [PluginCommand]
43+
commands = [ PluginCommand "addMethodPlaceholders" "add placeholders for minimal methods" addMethodPlaceholders
44+
]
45+
46+
-- | Parameter for the addMethods PluginCommand.
47+
data AddMethodsParams = AddMethodsParams
48+
{ uri :: Uri
49+
, range :: Range
50+
, methodGroup :: List T.Text
51+
}
52+
deriving (Show, Eq, Generics.Generic, ToJSON, FromJSON)
53+
54+
addMethodPlaceholders :: CommandFunction AddMethodsParams
55+
addMethodPlaceholders _ _ AddMethodsParams{..} = pure (Right Null, Just (WorkspaceApplyEdit, ApplyWorkspaceEditParams workspaceEdit))
56+
where
57+
workspaceEdit
58+
= WorkspaceEdit
59+
(Just (H.singleton uri textEdits))
60+
Nothing
61+
62+
textEdits
63+
= List
64+
[ TextEdit (Range pos pos) $ "\n" <> methodText
65+
]
66+
67+
methodText
68+
= mconcat
69+
. intersperse "\n"
70+
. fmap (\n -> T.replicate indentSize " " <> toMethodName n <> " = _")
71+
. unList
72+
$ methodGroup
73+
74+
toMethodName n
75+
| Just (h, _) <- T.uncons n
76+
, not (isAlpha h)
77+
= "(" <> n <> ")"
78+
| otherwise
79+
= n
80+
81+
pos = range ^. J.end
82+
indentSize = range ^. J.start . J.character + 2
83+
84+
-- | This implementation is extremely ad-hoc in a sense that
85+
-- 1. sensitive to the format of diagnostic messages from GHC
86+
-- 2. pattern matches are not exhaustive
87+
codeAction :: CodeActionProvider
88+
codeAction _ state plId docId _ ctx = do
89+
let Just docPath = docId ^. J.uri & uriToFilePath <&> toNormalizedFilePath
90+
Just (hieAst -> hf, _) <- runAction "classplugin" state $ useWithStale GetHieAst docPath
91+
Just (tmrTypechecked -> thisMod, _) <- runAction "classplugin" state $ useWithStale TypeCheck docPath
92+
actions <- join <$> mapM (mkActions docPath hf thisMod) methodDiags
93+
pure . Right . List $ actions
94+
where
95+
ghcDiags = filter (\d -> d ^. J.source == Just "typecheck") . unList $ ctx ^. J.diagnostics
96+
methodDiags = filter (\d -> isClassMethodWarning (d ^. J.message)) ghcDiags
97+
98+
ghostSpan = realSrcLocSpan $ mkRealSrcLoc (fsLit "<haskell-language-sever>") 1 1
99+
100+
mkAction range methodGroup
101+
= codeAction <$> mkLspCommand plId "addMethodPlaceholders" title (Just cmdParams)
102+
where
103+
title = "Add placeholders for "
104+
<> mconcat (intersperse ", " (fmap (\m -> "‘" <> m <> "’") methodGroup))
105+
cmdParams = [toJSON (AddMethodsParams (docId ^. J.uri) range (List methodGroup))]
106+
107+
codeAction cmd
108+
= CACodeAction
109+
$ CodeAction title (Just CodeActionQuickFix) (Just (List [])) Nothing (Just cmd)
110+
111+
mkActions docPath hf thisMod d = do
112+
Just (hscEnv -> hscenv, _) <- runAction "classplugin" state $ useWithStale GhcSessionDeps docPath
113+
(_, Just cls) <- initTcWithGbl hscenv thisMod ghostSpan $ do
114+
tcthing <- tcLookup name
115+
case tcthing of
116+
AGlobal (AConLike (RealDataCon con))
117+
| Just cls <- tyConClass_maybe (dataConOrigTyCon con) -> pure cls
118+
_ -> panic "Ide.Plugin.Class.mkActions"
119+
let minDef = classMinimalDef cls
120+
traverse (mkAction range) (minDefToMethodGroups minDef)
121+
where
122+
[([[Right name]], range)] =
123+
pointCommand hf (d ^. J.range . J.start & J.character -~ 1)
124+
$ \n ->
125+
( Map.keys . Map.filter (isNothing . identType) . nodeIdentifiers . nodeInfo <$> nodeChildren n
126+
, realSrcSpanToRange (nodeSpan n)
127+
)
128+
129+
unList :: List a -> [a]
130+
unList (List xs) = xs
131+
132+
isClassMethodWarning :: T.Text -> Bool
133+
isClassMethodWarning = T.isPrefixOf "• No explicit implementation for"
134+
135+
minDefToMethodGroups :: BooleanFormula Name -> [[T.Text]]
136+
minDefToMethodGroups = go
137+
where
138+
go (Var mn) = [[T.pack (occNameString (occName mn))]]
139+
go (Or ms) = concatMap (go . unLoc) ms
140+
go (And ms) = foldr (liftA2 (<>)) [[]] (fmap (go . unLoc) ms)
141+
go (Parens m) = go (unLoc m)

0 commit comments

Comments
 (0)