hls-exactprint-utils (empty) → 0.5.0.1
raw patch · 3 files changed
+585/−0 lines, 3 filesdep +basedep +dlistdep +ghc
Dependencies added: base, dlist, ghc, ghc-exactprint, ghcide, haskell-lsp-types, hls-plugin-api, retrie, syb, text, transformers
Files
- LICENSE +201/−0
- hls-exactprint-utils.cabal +50/−0
- src/Ide/TreeTransform.hs +334/−0
+ LICENSE view
@@ -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.
+ hls-exactprint-utils.cabal view
@@ -0,0 +1,50 @@+cabal-version: 2.2+name: hls-exactprint-utils+version: 0.5.0.1+synopsis: Common utilities to interaction between ghc-exactprint and HLS plugins.+description:+ Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>+homepage: https://github.com/haskell/haskell-language-server/hls-exactprint-utils+bug-reports: https://github.com/haskell/haskell-language-server/issues+license: Apache-2.0+license-file: LICENSE+author: Sandy Maguire, Hiromi ISHII+maintainer: Sandy Maguire <sandy@sandymaguire.me>, HiromiISHII <konn.jinro@gmail.com>+copyright: Sandy Maguire, Hiromi ISHII+category: Web+build-type: Simple++flag pedantic+ description: Enable -Werror+ default: False+ manual: True++source-repository head+ type: git+ location: https://github.com/haskell/haskell-language-server++library+ exposed-modules:+ Ide.TreeTransform++ hs-source-dirs: src+ build-depends:+ base >=4.12 && <5+ , dlist+ , ghc+ , ghc-exactprint+ , ghcide+ , haskell-lsp-types+ , hls-plugin-api+ , retrie+ , syb+ , text+ , transformers+++ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns++ if flag(pedantic)+ ghc-options: -Werror++ default-language: Haskell2010
+ src/Ide/TreeTransform.hs view
@@ -0,0 +1,334 @@+{-# LANGUAGE CPP #-}+{-# LANGUAGE DerivingStrategies #-}+{-# LANGUAGE GADTs #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RankNTypes #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE ScopedTypeVariables #-}++module Ide.TreeTransform+ ( Graft(..),+ graft,+ graftDecls,+ graftDeclsWithM,+ hoistGraft,+ graftWithM,+ graftWithSmallestM,+ transform,+ transformM,+ useAnnotatedSource,+ annotateParsedSource,+ ASTElement (..),+ ExceptStringT (..),+ )+where++import BasicTypes (appPrec)+import Control.Applicative (Alternative)+import Control.Monad+import qualified Control.Monad.Fail as Fail+import Control.Monad.IO.Class (MonadIO)+import Control.Monad.Trans.Class+import Control.Monad.Trans.Except+import Control.Monad.Zip+import qualified Data.DList as DL+import Data.Functor.Classes+import Data.Functor.Contravariant+import qualified Data.Text as T+import Development.IDE.Core.RuleTypes+import Development.IDE.Core.Rules+import Development.IDE.Core.Shake+import Development.IDE.GHC.Compat hiding (parseExpr)+import Development.IDE.Types.Location+import Generics.SYB+import Ide.PluginUtils+import Language.Haskell.GHC.ExactPrint+import Language.Haskell.GHC.ExactPrint.Parsers+import Language.Haskell.LSP.Types+import Language.Haskell.LSP.Types.Capabilities (ClientCapabilities)+import Outputable (Outputable, ppr, showSDoc)+import Retrie.ExactPrint hiding (parseDecl, parseExpr, parsePattern, parseType)+#if __GLASGOW_HASKELL__ == 808+import Control.Arrow+#endif+++------------------------------------------------------------------------------++-- | Get the latest version of the annotated parse source.+useAnnotatedSource ::+ String ->+ IdeState ->+ NormalizedFilePath ->+ IO (Maybe (Annotated ParsedSource))+useAnnotatedSource herald state nfp =+ fmap annotateParsedSource+ <$> runAction herald state (use GetParsedModule nfp)++annotateParsedSource :: ParsedModule -> Annotated ParsedSource+annotateParsedSource = fixAnns++------------------------------------------------------------------------------++{- | A transformation for grafting source trees together. Use the semigroup+ instance to combine 'Graft's, and run them via 'transform'.+-}+newtype Graft m a = Graft+ { runGraft :: DynFlags -> a -> TransformT m a+ }++hoistGraft :: (forall x. m x -> n x) -> Graft m a -> Graft n a+hoistGraft h (Graft f) = Graft (fmap (hoistTransform h) . f)++newtype ExceptStringT m a = ExceptStringT {runExceptString :: ExceptT String m a}+ deriving newtype+ ( MonadTrans+ , Monad+ , Functor+ , Applicative+ , Alternative+ , Foldable+ , Contravariant+ , MonadIO+ , Eq1+ , Ord1+ , Show1+ , Read1+ , MonadZip+ , MonadPlus+ , Eq+ , Ord+ , Show+ , Read+ )++instance Monad m => Fail.MonadFail (ExceptStringT m) where+ fail = ExceptStringT . ExceptT . pure . Left++instance Monad m => Semigroup (Graft m a) where+ Graft a <> Graft b = Graft $ \dflags -> a dflags >=> b dflags++instance Monad m => Monoid (Graft m a) where+ mempty = Graft $ const pure++------------------------------------------------------------------------------++-- | Convert a 'Graft' into a 'WorkspaceEdit'.+transform ::+ DynFlags ->+ ClientCapabilities ->+ Uri ->+ Graft (Either String) ParsedSource ->+ Annotated ParsedSource ->+ Either String WorkspaceEdit+transform dflags ccs uri f a = do+ let src = printA a+ a' <- transformA a $ runGraft f dflags+ let res = printA a'+ pure $ diffText ccs (uri, T.pack src) (T.pack res) IncludeDeletions++------------------------------------------------------------------------------++-- | Convert a 'Graft' into a 'WorkspaceEdit'.+transformM ::+ Monad m =>+ DynFlags ->+ ClientCapabilities ->+ Uri ->+ Graft (ExceptStringT m) ParsedSource ->+ Annotated ParsedSource ->+ m (Either String WorkspaceEdit)+transformM dflags ccs uri f a = runExceptT $+ runExceptString $ do+ let src = printA a+ a' <- transformA a $ runGraft f dflags+ let res = printA a'+ pure $ diffText ccs (uri, T.pack src) (T.pack res) IncludeDeletions++------------------------------------------------------------------------------++{- | Construct a 'Graft', replacing the node at the given 'SrcSpan' with the+ given 'LHSExpr'. The node at that position must already be a 'LHsExpr', or+ this is a no-op.+-}+graft ::+ forall ast a.+ (Data a, ASTElement ast) =>+ SrcSpan ->+ Located ast ->+ Graft (Either String) a+graft dst val = Graft $ \dflags a -> do+ (anns, val') <- annotate dflags $ maybeParensAST val+ modifyAnnsT $ mappend anns+ pure $+ everywhere'+ ( mkT $+ \case+ (L src _ :: Located ast) | src == dst -> val'+ l -> l+ )+ a++------------------------------------------------------------------------------++graftWithM ::+ forall ast m a.+ (Fail.MonadFail m, Data a, ASTElement ast) =>+ SrcSpan ->+ (Located ast -> TransformT m (Maybe (Located ast))) ->+ Graft m a+graftWithM dst trans = Graft $ \dflags a -> do+ everywhereM'+ ( mkM $+ \case+ val@(L src _ :: Located ast)+ | src == dst -> do+ mval <- trans val+ case mval of+ Just val' -> do+ (anns, val'') <-+ hoistTransform (either Fail.fail pure) $+ annotate dflags $ maybeParensAST val'+ modifyAnnsT $ mappend anns+ pure val''+ Nothing -> pure val+ l -> pure l+ )+ a++graftWithSmallestM ::+ forall ast m a.+ (Fail.MonadFail m, Data a, ASTElement ast) =>+ SrcSpan ->+ (Located ast -> TransformT m (Maybe (Located ast))) ->+ Graft m a+graftWithSmallestM dst trans = Graft $ \dflags a -> do+ everywhereM'+ ( mkM $+ \case+ val@(L src _ :: Located ast)+ | dst `isSubspanOf` src -> do+ mval <- trans val+ case mval of+ Just val' -> do+ (anns, val'') <-+ hoistTransform (either Fail.fail pure) $+ annotate dflags $ maybeParensAST val'+ modifyAnnsT $ mappend anns+ pure val''+ Nothing -> pure val+ l -> pure l+ )+ a++graftDecls ::+ forall a.+ (HasDecls a) =>+ SrcSpan ->+ [LHsDecl GhcPs] ->+ Graft (Either String) a+graftDecls dst decs0 = Graft $ \dflags a -> do+ decs <- forM decs0 $ \decl -> do+ (anns, decl') <- annotateDecl dflags decl+ modifyAnnsT $ mappend anns+ pure decl'+ let go [] = DL.empty+ go (L src e : rest)+ | src == dst = DL.fromList decs <> DL.fromList rest+ | otherwise = DL.singleton (L src e) <> go rest+ modifyDeclsT (pure . DL.toList . go) a++graftDeclsWithM ::+ forall a m.+ (HasDecls a, Fail.MonadFail m) =>+ SrcSpan ->+ (LHsDecl GhcPs -> TransformT m (Maybe [LHsDecl GhcPs])) ->+ Graft m a+graftDeclsWithM dst toDecls = Graft $ \dflags a -> do+ let go [] = pure DL.empty+ go (e@(L src _) : rest)+ | src == dst = toDecls e >>= \case+ Just decs0 -> do+ decs <- forM decs0 $ \decl -> do+ (anns, decl') <-+ hoistTransform (either Fail.fail pure) $+ annotateDecl dflags decl+ modifyAnnsT $ mappend anns+ pure decl'+ pure $ DL.fromList decs <> DL.fromList rest+ Nothing -> (DL.singleton e <>) <$> go rest+ | otherwise = (DL.singleton e <>) <$> go rest+ modifyDeclsT (fmap DL.toList . go) a+++everywhereM' :: forall m. Monad m => GenericM m -> GenericM m+everywhereM' f = go+ where+ go :: GenericM m+ go = gmapM go <=< f++class (Data ast, Outputable ast) => ASTElement ast where+ parseAST :: Parser (Located ast)+ maybeParensAST :: Located ast -> Located ast++instance p ~ GhcPs => ASTElement (HsExpr p) where+ parseAST = parseExpr+ maybeParensAST = parenthesize++instance p ~ GhcPs => ASTElement (Pat p) where+#if __GLASGOW_HASKELL__ == 808+ parseAST = fmap (fmap $ right $ second dL) . parsePattern+ maybeParensAST = dL . parenthesizePat appPrec . unLoc+#else+ parseAST = parsePattern+ maybeParensAST = parenthesizePat appPrec+#endif++instance p ~ GhcPs => ASTElement (HsType p) where+ parseAST = parseType+ maybeParensAST = parenthesizeHsType appPrec++instance p ~ GhcPs => ASTElement (HsDecl p) where+ parseAST = parseDecl+ maybeParensAST = id++------------------------------------------------------------------------------++-- | Dark magic I stole from retrie. No idea what it does.+fixAnns :: ParsedModule -> Annotated ParsedSource+fixAnns ParsedModule {..} =+ let ranns = relativiseApiAnns pm_parsed_source pm_annotations+ in unsafeMkA pm_parsed_source ranns 0++------------------------------------------------------------------------------++-- | Given an 'LHSExpr', compute its exactprint annotations.+annotate :: ASTElement ast => DynFlags -> Located ast -> TransformT (Either String) (Anns, Located ast)+annotate dflags ast = do+ uniq <- show <$> uniqueSrcSpanT+ let rendered = render dflags ast+ (anns, expr') <- lift $ either (Left . show) Right $ parseAST dflags uniq rendered+ let anns' = setPrecedingLines expr' 0 1 anns+ pure (anns', expr')++-- | Given an 'LHsDecl', compute its exactprint annotations.+annotateDecl :: DynFlags -> LHsDecl GhcPs -> TransformT (Either String) (Anns, LHsDecl GhcPs)+annotateDecl dflags ast = do+ uniq <- show <$> uniqueSrcSpanT+ let rendered = render dflags ast+ (anns, expr') <- lift $ either (Left . show) Right $ parseDecl dflags uniq rendered+ let anns' = setPrecedingLines expr' 1 0 anns+ pure (anns', expr')+------------------------------------------------------------------------------++-- | Print out something 'Outputable'.+render :: Outputable a => DynFlags -> a -> String+render dflags = showSDoc dflags . ppr++------------------------------------------------------------------------------++-- | Put parentheses around an expression if required.+parenthesize :: LHsExpr GhcPs -> LHsExpr GhcPs+parenthesize = parenthesizeHsExpr appPrec