diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/hls-haddock-comments-plugin.cabal b/hls-haddock-comments-plugin.cabal new file mode 100644 --- /dev/null +++ b/hls-haddock-comments-plugin.cabal @@ -0,0 +1,30 @@ +cabal-version: 2.2 +name: hls-haddock-comments-plugin +version: 0.1.0.0 +synopsis: Haddock comments plugin for Haskell Language Server +description: + Please see Haskell Language Server Readme (https://github.com/haskell/haskell-language-server#readme) + +license: Apache-2.0 +license-file: LICENSE +author: Potato Hatsue +maintainer: berberman@yandex.com +category: Development +build-type: Simple + +library + exposed-modules: Ide.Plugin.HaddockComments + hs-source-dirs: src + ghc-options: -Wall -Wno-name-shadowing -Wredundant-constraints + build-depends: + , base >=4.12 && <5 + , containers + , ghc + , ghc-exactprint + , ghcide + , haskell-lsp-types + , hls-plugin-api + , text + , unordered-containers + + default-language: Haskell2010 diff --git a/src/Ide/Plugin/HaddockComments.hs b/src/Ide/Plugin/HaddockComments.hs new file mode 100644 --- /dev/null +++ b/src/Ide/Plugin/HaddockComments.hs @@ -0,0 +1,147 @@ +{-# LANGUAGE ExistentialQuantification #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ViewPatterns #-} + +module Ide.Plugin.HaddockComments where + +import Control.Monad (join) +import qualified Data.HashMap.Strict as HashMap +import qualified Data.Map as Map +import qualified Data.Text as T +import Development.IDE +import Development.IDE.GHC.Compat +import Ide.Types +import Language.Haskell.GHC.ExactPrint +import Language.Haskell.GHC.ExactPrint.Types hiding (GhcPs) +import Language.Haskell.GHC.ExactPrint.Utils +import Language.Haskell.LSP.Types + +----------------------------------------------------------------------------- +descriptor :: PluginId -> PluginDescriptor IdeState +descriptor plId = + (defaultPluginDescriptor plId) + { pluginCodeActionProvider = Just codeActionProvider + } + +haddockCommentsId :: CommandId +haddockCommentsId = "HaddockCommentsCommand" + +codeActionProvider :: CodeActionProvider IdeState +codeActionProvider _lspFuncs ideState _pId (TextDocumentIdentifier uri) range CodeActionContext {_diagnostics = List diags} = + do + let noErr = and $ (/= Just DsError) . _severity <$> diags + nfp = uriToNormalizedFilePath $ toNormalizedUri uri + (join -> pm) <- runAction "HaddockComments.GetParsedModule" ideState $ use GetParsedModule `traverse` nfp + let locDecls = hsmodDecls . unLoc . pm_parsed_source <$> pm + anns = relativiseApiAnns <$> (pm_parsed_source <$> pm) <*> (pm_annotations <$> pm) + edits = [runGenComments gen locDecls anns range | noErr, gen <- genList] + return $ Right $ List [CACodeAction $ toAction title uri edit | (Just (title, edit)) <- edits] + +genList :: [GenComments] +genList = + [ genForSig, + genForRecord + ] + +----------------------------------------------------------------------------- +data GenComments = forall a. + GenComments + { title :: T.Text, + fromDecl :: HsDecl GhcPs -> Maybe a, + collectKeys :: a -> [AnnKey], + isFresh :: Annotation -> Bool, + updateAnn :: Annotation -> Annotation + } + +runGenComments :: GenComments -> Maybe [LHsDecl GhcPs] -> Maybe Anns -> Range -> Maybe (T.Text, TextEdit) +runGenComments GenComments {..} mLocDecls mAnns range + | Just locDecls <- mLocDecls, + Just anns <- mAnns, + [(locDecl, src, x)] <- [(locDecl, l, x) | locDecl@(L l (fromDecl -> Just x)) <- locDecls, range `isIntersectWith` l], + annKeys <- collectKeys x, + not $ null annKeys, + and $ maybe False isFresh . flip Map.lookup anns <$> annKeys, + anns' <- foldr (Map.adjust updateAnn) anns annKeys, + Just range' <- toRange src, + result <- T.strip . T.pack $ exactPrint locDecl anns' = + Just (title, TextEdit range' result) + | otherwise = Nothing + +----------------------------------------------------------------------------- + +genForSig :: GenComments +genForSig = GenComments {..} + where + title = "Generate signature comments" + + fromDecl (SigD _ (TypeSig _ _ (HsWC _ (HsIB _ x)))) = Just x + fromDecl _ = Nothing + + updateAnn x = x {annEntryDelta = DP (0, 1), annsDP = dp} + + isFresh Ann {annsDP} = null [() | (AnnComment _, _) <- annsDP] + + collectKeys = keyFromTyVar 0 + + comment = mkComment "-- ^ " noSrcSpan + dp = [(AnnComment comment, DP (0, 1)), (G AnnRarrow, DP (1, 2))] + +genForRecord :: GenComments +genForRecord = GenComments {..} + where + title = "Generate fields comments" + + fromDecl (TyClD _ DataDecl {tcdDataDefn = HsDataDefn {dd_cons = cons}}) = + Just [x | (L _ ConDeclH98 {con_args = x}) <- cons] + fromDecl _ = Nothing + + updateAnn x = x {annEntryDelta = DP (1, 2), annPriorComments = [(comment, DP (1, 2))]} + + isFresh Ann {annPriorComments} = null annPriorComments + + collectKeys = keyFromCon + + comment = mkComment "-- | " noSrcSpan + +----------------------------------------------------------------------------- + +toAction :: T.Text -> Uri -> TextEdit -> CodeAction +toAction title uri edit = CodeAction {..} + where + _title = title + _kind = Just CodeActionQuickFix + _diagnostics = Nothing + _command = Nothing + _changes = Just $ HashMap.singleton uri $ List [edit] + _documentChanges = Nothing + _edit = Just WorkspaceEdit {..} + +toRange :: SrcSpan -> Maybe Range +toRange src + | (RealSrcSpan span) <- src, + range' <- realSrcSpanToRange span = + Just range' + | otherwise = Nothing + +isIntersectWith :: Range -> SrcSpan -> Bool +isIntersectWith Range {_start, _end} x = isInsideSrcSpan _start x || isInsideSrcSpan _end x + +----------------------------------------------------------------------------- + +keyFromTyVar :: Int -> LHsType GhcPs -> [AnnKey] +keyFromTyVar dep c@(L _ (HsFunTy _ x y)) + | dep < 1 = mkAnnKey c : keyFromTyVar dep x ++ keyFromTyVar dep y + | otherwise = [] +keyFromTyVar dep (L _ t@HsForAllTy {}) = keyFromTyVar dep (hst_body t) +keyFromTyVar dep (L _ t@HsQualTy {}) = keyFromTyVar dep (hst_body t) +keyFromTyVar dep (L _ (HsKindSig _ x _)) = keyFromTyVar dep x +keyFromTyVar dep (L _ (HsParTy _ x)) = keyFromTyVar (succ dep) x +keyFromTyVar dep (L _ (HsBangTy _ _ x)) = keyFromTyVar dep x +keyFromTyVar _ _ = [] + +keyFromCon :: [HsConDeclDetails GhcPs] -> [AnnKey] +keyFromCon cons = mconcat [mkAnnKey <$> xs | (RecCon (L _ xs)) <- cons] + +-----------------------------------------------------------------------------