ghc-tags-plugin (empty) → 0.1.0.0
raw patch · 7 files changed
+1012/−0 lines, 7 filesdep +attoparsecdep +basedep +bytestringsetup-changed
Dependencies added: attoparsec, base, bytestring, containers, directory, ghc
Files
- CHANGELOG.md +5/−0
- LICENSE +373/−0
- Setup.hs +2/−0
- ghc-tags-plugin.cabal +34/−0
- lib/Plugin/GhcTags.hs +192/−0
- lib/Plugin/GhcTags/Generate.hs +303/−0
- lib/Plugin/GhcTags/Parser.hs +103/−0
+ CHANGELOG.md view
@@ -0,0 +1,5 @@+# Revision history for ghctags++## 0.1.0.0 -- YYYY-mm-dd++* First version. Released on an unsuspecting world.
+ LICENSE view
@@ -0,0 +1,373 @@+Mozilla Public License Version 2.0+==================================++1. Definitions+--------------++1.1. "Contributor"+ means each individual or legal entity that creates, contributes to+ the creation of, or owns Covered Software.++1.2. "Contributor Version"+ means the combination of the Contributions of others (if any) used+ by a Contributor and that particular Contributor's Contribution.++1.3. "Contribution"+ means Covered Software of a particular Contributor.++1.4. "Covered Software"+ means Source Code Form to which the initial Contributor has attached+ the notice in Exhibit A, the Executable Form of such Source Code+ Form, and Modifications of such Source Code Form, in each case+ including portions thereof.++1.5. "Incompatible With Secondary Licenses"+ means++ (a) that the initial Contributor has attached the notice described+ in Exhibit B to the Covered Software; or++ (b) that the Covered Software was made available under the terms of+ version 1.1 or earlier of the License, but not also under the+ terms of a Secondary License.++1.6. "Executable Form"+ means any form of the work other than Source Code Form.++1.7. "Larger Work"+ means a work that combines Covered Software with other material, in+ a separate file or files, that is not Covered Software.++1.8. "License"+ means this document.++1.9. "Licensable"+ means having the right to grant, to the maximum extent possible,+ whether at the time of the initial grant or subsequently, any and+ all of the rights conveyed by this License.++1.10. "Modifications"+ means any of the following:++ (a) any file in Source Code Form that results from an addition to,+ deletion from, or modification of the contents of Covered+ Software; or++ (b) any new file in Source Code Form that contains any Covered+ Software.++1.11. "Patent Claims" of a Contributor+ means any patent claim(s), including without limitation, method,+ process, and apparatus claims, in any patent Licensable by such+ Contributor that would be infringed, but for the grant of the+ License, by the making, using, selling, offering for sale, having+ made, import, or transfer of either its Contributions or its+ Contributor Version.++1.12. "Secondary License"+ means either the GNU General Public License, Version 2.0, the GNU+ Lesser General Public License, Version 2.1, the GNU Affero General+ Public License, Version 3.0, or any later versions of those+ licenses.++1.13. "Source Code Form"+ means the form of the work preferred for making modifications.++1.14. "You" (or "Your")+ means an individual or a legal entity exercising rights under this+ License. For legal entities, "You" includes any entity that+ controls, is controlled by, or is under common control with You. For+ purposes of this definition, "control" means (a) the power, direct+ or indirect, to cause the direction or management of such entity,+ whether by contract or otherwise, or (b) ownership of more than+ fifty percent (50%) of the outstanding shares or beneficial+ ownership of such entity.++2. License Grants and Conditions+--------------------------------++2.1. Grants++Each Contributor hereby grants You a world-wide, royalty-free,+non-exclusive license:++(a) under intellectual property rights (other than patent or trademark)+ Licensable by such Contributor to use, reproduce, make available,+ modify, display, perform, distribute, and otherwise exploit its+ Contributions, either on an unmodified basis, with Modifications, or+ as part of a Larger Work; and++(b) under Patent Claims of such Contributor to make, use, sell, offer+ for sale, have made, import, and otherwise transfer either its+ Contributions or its Contributor Version.++2.2. Effective Date++The licenses granted in Section 2.1 with respect to any Contribution+become effective for each Contribution on the date the Contributor first+distributes such Contribution.++2.3. Limitations on Grant Scope++The licenses granted in this Section 2 are the only rights granted under+this License. No additional rights or licenses will be implied from the+distribution or licensing of Covered Software under this License.+Notwithstanding Section 2.1(b) above, no patent license is granted by a+Contributor:++(a) for any code that a Contributor has removed from Covered Software;+ or++(b) for infringements caused by: (i) Your and any other third party's+ modifications of Covered Software, or (ii) the combination of its+ Contributions with other software (except as part of its Contributor+ Version); or++(c) under Patent Claims infringed by Covered Software in the absence of+ its Contributions.++This License does not grant any rights in the trademarks, service marks,+or logos of any Contributor (except as may be necessary to comply with+the notice requirements in Section 3.4).++2.4. Subsequent Licenses++No Contributor makes additional grants as a result of Your choice to+distribute the Covered Software under a subsequent version of this+License (see Section 10.2) or under the terms of a Secondary License (if+permitted under the terms of Section 3.3).++2.5. Representation++Each Contributor represents that the Contributor believes its+Contributions are its original creation(s) or it has sufficient rights+to grant the rights to its Contributions conveyed by this License.++2.6. Fair Use++This License is not intended to limit any rights You have under+applicable copyright doctrines of fair use, fair dealing, or other+equivalents.++2.7. Conditions++Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted+in Section 2.1.++3. Responsibilities+-------------------++3.1. Distribution of Source Form++All distribution of Covered Software in Source Code Form, including any+Modifications that You create or to which You contribute, must be under+the terms of this License. You must inform recipients that the Source+Code Form of the Covered Software is governed by the terms of this+License, and how they can obtain a copy of this License. You may not+attempt to alter or restrict the recipients' rights in the Source Code+Form.++3.2. Distribution of Executable Form++If You distribute Covered Software in Executable Form then:++(a) such Covered Software must also be made available in Source Code+ Form, as described in Section 3.1, and You must inform recipients of+ the Executable Form how they can obtain a copy of such Source Code+ Form by reasonable means in a timely manner, at a charge no more+ than the cost of distribution to the recipient; and++(b) You may distribute such Executable Form under the terms of this+ License, or sublicense it under different terms, provided that the+ license for the Executable Form does not attempt to limit or alter+ the recipients' rights in the Source Code Form under this License.++3.3. Distribution of a Larger Work++You may create and distribute a Larger Work under terms of Your choice,+provided that You also comply with the requirements of this License for+the Covered Software. If the Larger Work is a combination of Covered+Software with a work governed by one or more Secondary Licenses, and the+Covered Software is not Incompatible With Secondary Licenses, this+License permits You to additionally distribute such Covered Software+under the terms of such Secondary License(s), so that the recipient of+the Larger Work may, at their option, further distribute the Covered+Software under the terms of either this License or such Secondary+License(s).++3.4. Notices++You may not remove or alter the substance of any license notices+(including copyright notices, patent notices, disclaimers of warranty,+or limitations of liability) contained within the Source Code Form of+the Covered Software, except that You may alter any license notices to+the extent required to remedy known factual inaccuracies.++3.5. Application of Additional Terms++You may choose to offer, and to charge a fee for, warranty, support,+indemnity or liability obligations to one or more recipients of Covered+Software. However, You may do so only on Your own behalf, and not on+behalf of any Contributor. You must make it absolutely clear that any+such warranty, support, indemnity, or liability obligation is offered by+You alone, and You hereby agree to indemnify every Contributor for any+liability incurred by such Contributor as a result of warranty, support,+indemnity or liability terms You offer. You may include additional+disclaimers of warranty and limitations of liability specific to any+jurisdiction.++4. Inability to Comply Due to Statute or Regulation+---------------------------------------------------++If it is impossible for You to comply with any of the terms of this+License with respect to some or all of the Covered Software due to+statute, judicial order, or regulation then You must: (a) comply with+the terms of this License to the maximum extent possible; and (b)+describe the limitations and the code they affect. Such description must+be placed in a text file included with all distributions of the Covered+Software under this License. Except to the extent prohibited by statute+or regulation, such description must be sufficiently detailed for a+recipient of ordinary skill to be able to understand it.++5. Termination+--------------++5.1. The rights granted under this License will terminate automatically+if You fail to comply with any of its terms. However, if You become+compliant, then the rights granted under this License from a particular+Contributor are reinstated (a) provisionally, unless and until such+Contributor explicitly and finally terminates Your grants, and (b) on an+ongoing basis, if such Contributor fails to notify You of the+non-compliance by some reasonable means prior to 60 days after You have+come back into compliance. Moreover, Your grants from a particular+Contributor are reinstated on an ongoing basis if such Contributor+notifies You of the non-compliance by some reasonable means, this is the+first time You have received notice of non-compliance with this License+from such Contributor, and You become compliant prior to 30 days after+Your receipt of the notice.++5.2. If You initiate litigation against any entity by asserting a patent+infringement claim (excluding declaratory judgment actions,+counter-claims, and cross-claims) alleging that a Contributor Version+directly or indirectly infringes any patent, then the rights granted to+You by any and all Contributors for the Covered Software under Section+2.1 of this License shall terminate.++5.3. In the event of termination under Sections 5.1 or 5.2 above, all+end user license agreements (excluding distributors and resellers) which+have been validly granted by You or Your distributors under this License+prior to termination shall survive termination.++************************************************************************+* *+* 6. Disclaimer of Warranty *+* ------------------------- *+* *+* Covered Software is provided under this License on an "as is" *+* basis, without warranty of any kind, either expressed, implied, or *+* statutory, including, without limitation, warranties that the *+* Covered Software is free of defects, merchantable, fit for a *+* particular purpose or non-infringing. The entire risk as to the *+* quality and performance of the Covered Software is with You. *+* Should any Covered Software prove defective in any respect, You *+* (not any Contributor) assume the cost of any necessary servicing, *+* repair, or correction. This disclaimer of warranty constitutes an *+* essential part of this License. No use of any Covered Software is *+* authorized under this License except under this disclaimer. *+* *+************************************************************************++************************************************************************+* *+* 7. Limitation of Liability *+* -------------------------- *+* *+* Under no circumstances and under no legal theory, whether tort *+* (including negligence), contract, or otherwise, shall any *+* Contributor, or anyone who distributes Covered Software as *+* permitted above, be liable to You for any direct, indirect, *+* special, incidental, or consequential damages of any character *+* including, without limitation, damages for lost profits, loss of *+* goodwill, work stoppage, computer failure or malfunction, or any *+* and all other commercial damages or losses, even if such party *+* shall have been informed of the possibility of such damages. This *+* limitation of liability shall not apply to liability for death or *+* personal injury resulting from such party's negligence to the *+* extent applicable law prohibits such limitation. Some *+* jurisdictions do not allow the exclusion or limitation of *+* incidental or consequential damages, so this exclusion and *+* limitation may not apply to You. *+* *+************************************************************************++8. Litigation+-------------++Any litigation relating to this License may be brought only in the+courts of a jurisdiction where the defendant maintains its principal+place of business and such litigation shall be governed by laws of that+jurisdiction, without reference to its conflict-of-law provisions.+Nothing in this Section shall prevent a party's ability to bring+cross-claims or counter-claims.++9. Miscellaneous+----------------++This License represents the complete agreement concerning the subject+matter hereof. If any provision of this License is held to be+unenforceable, such provision shall be reformed only to the extent+necessary to make it enforceable. Any law or regulation which provides+that the language of a contract shall be construed against the drafter+shall not be used to construe this License against a Contributor.++10. Versions of the License+---------------------------++10.1. New Versions++Mozilla Foundation is the license steward. Except as provided in Section+10.3, no one other than the license steward has the right to modify or+publish new versions of this License. Each version will be given a+distinguishing version number.++10.2. Effect of New Versions++You may distribute the Covered Software under the terms of the version+of the License under which You originally received the Covered Software,+or under the terms of any subsequent version published by the license+steward.++10.3. Modified Versions++If you create software not governed by this License, and you want to+create a new license for such software, you may create and use a+modified version of this License if you rename the license and remove+any references to the name of the license steward (except to note that+such modified license differs from this License).++10.4. Distributing Source Code Form that is Incompatible With Secondary+Licenses++If You choose to distribute Source Code Form that is Incompatible With+Secondary Licenses under the terms of this version of the License, the+notice described in Exhibit B of this License must be attached.++Exhibit A - Source Code Form License Notice+-------------------------------------------++ This Source Code Form is subject to the terms of the Mozilla Public+ License, v. 2.0. If a copy of the MPL was not distributed with this+ file, You can obtain one at http://mozilla.org/MPL/2.0/.++If it is not possible or desirable to put the notice in a particular+file, then You may include the notice in a location (such as a LICENSE+file in a relevant directory) where a recipient would be likely to look+for such a notice.++You may add additional accurate notices of copyright ownership.++Exhibit B - "Incompatible With Secondary Licenses" Notice+---------------------------------------------------------++ This Source Code Form is "Incompatible With Secondary Licenses", as+ defined by the Mozilla Public License, v. 2.0.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ ghc-tags-plugin.cabal view
@@ -0,0 +1,34 @@+cabal-version: 2.4+name: ghc-tags-plugin+version: 0.1.0.0+synopsis: A compiler plugin which generates tags file from GHC syntax tree.+description:+ A compiler source plugin which takes parsed Haskell syntax tree and saves+ tags file to disk, leaving the parsed tree untouched.+license: MPL-2.0+license-file: LICENSE+author: Marcin Szamotulski+maintainer: profunctor@pm.me+copyright: 2020, Marcin Szamotulski+category: Development+extra-source-files: CHANGELOG.md+homepage: https://github.com/coot#readme+bug-reports: https://github.com/coot/ghc-tags-plugin/issues++source-repository head+ type: git+ location: https://github.com/coot/ghc-tags-plugin++library+ exposed-modules: Plugin.GhcTags+ other-modules: Plugin.GhcTags.Generate+ Plugin.GhcTags.Parser+ build-depends: base ^>=4.12.0.0,+ attoparsec ^>=0.13.0.0,+ containers ^>=0.6,+ directory ^>=1.3,+ bytestring ^>=0.10,+ ghc >=8.4 && <8.9+ hs-source-dirs: lib+ default-language: Haskell2010+ ghc-options: -Wall
+ lib/Plugin/GhcTags.hs view
@@ -0,0 +1,192 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE ScopedTypeVariables #-}++module Plugin.GhcTags ( plugin ) where++import Control.Concurrent+import Control.Exception+import qualified Data.ByteString as BS+import Data.ByteString.Builder (Builder)+import qualified Data.ByteString.Builder as BS+import Data.Functor ((<$))+import Data.List (sort)+import qualified Data.Map as Map+import Data.Maybe (mapMaybe)+-- import Data.Foldable (traverse_)+import System.IO+import System.IO.Error (tryIOError)+import System.IO.Unsafe (unsafePerformIO)+import System.Directory++import GhcPlugins ( CommandLineOption+ , Hsc+ , HsParsedModule (..)+ , ModSummary+ , Plugin (..)+ , liftIO+ , purePlugin+ )+import GhcPlugins hiding (occName, (<>))+import HsExtension (GhcPs)+import HsSyn (HsModule)++import Plugin.GhcTags.Generate+import Plugin.GhcTags.Parser+++-- | Global shared state which persists across compilation of different+-- modules - a nasty hack which is only used for optimzation.+--+tagsMVar :: MVar (Maybe TagsMap)+tagsMVar = unsafePerformIO $ newMVar Nothing++-- | The GhcTags plugin. It will run for every compiled module and have access+-- to parsed syntax tree. It will inpect it and:+--+-- * update a global mutable state variable, which stores a tag map.+-- It is shared accross modules compiled in the same `ghc` run.+-- * update 'tags' file. +--+-- The global mutable variable save us from parsing the tags file for every+-- compiled module.+--+-- __The syntax tree is left unchanged.__+-- +-- The tags file will contain location information about:+--+-- * top level terms+-- * type classes+-- * type class members+-- * type class instances+-- * type families /(standalone and associated)/+-- * type family instances /(standalone and associated)/+-- * data type families /(standalone and associated)/+-- * data type families instances /(standalone and associated)/+-- * data type family instances constructors /(standalone and associated)/+--+plugin :: Plugin+plugin = GhcPlugins.defaultPlugin {+ parsedResultAction = ghcTagPlugin,+ pluginRecompile = purePlugin+ }+++-- | The plugin does not change the 'HsParedModule', it only runs side effects.+--+ghcTagPlugin :: [CommandLineOption] -> ModSummary -> HsParsedModule -> Hsc HsParsedModule+ghcTagPlugin options _modSummary hsParsedModule@HsParsedModule {hpm_module} =+ hsParsedModule <$ liftIO (updateTags tagsFile hpm_module)+ where+ tagsFile :: FilePath+ tagsFile = case options of+ [] -> "tags"+ a : _ -> a+++-- | Extract tags from a module and update tags file as well as the 'tagsMVar'+-- Using 'tagsMVar' we can save on parsing the tags file: we do it only when+-- the first module is compiled. We need to write the results at every+-- compilation step since we don't know if the currently compiled module is the+-- last one or not.+--+updateTags :: FilePath+ -> Located (HsModule GhcPs)+ -> IO ()+updateTags tagsFile lmodule =+ -- Take exclusive lock. This assures that only one thread will have access to+ -- the tags file. Parsing and the rest of the compilation pipeline can+ -- happen concurrently.+ mvarLock tagsMVar $ \mTagsMap -> do+ (tagsMap :: TagsMap) <-+ case mTagsMap of++ Nothing -> do+ a <- doesFileExist tagsFile+ res <-+ if a+ then do+ mbytes <- tryIOError (BS.readFile tagsFile)+ case mbytes of+ Left err -> do+ putStrLn $ "GhcTags: error reading \"" ++ tagsFile ++ "\": " ++ (show err)+ return $ Right []+ Right bytes ->+ parseVimTagFile bytes+ else return $ Right []+ case res of+ Left err -> do+ putStrLn $ "GhcTags: error reading or parsing \"" ++ tagsFile ++ "\": " ++ err+ return $ Map.empty+ Right tagList -> do+ return $ mkTagsMap tagList++ Just tagsMap -> return tagsMap++ let tagsMap', updatedTagsMap :: TagsMap+ tagsMap' =+ mkTagsMap+ $ mapMaybe ghcTagToTag+ $ generateTagsForModule+ $ lmodule++ updatedTagsMap = tagsMap' `Map.union` tagsMap++ {-+ putStrLn $ "tags found"+ traverse_ print+ $ sortOn tagName+ $ concat+ $ Map.elems tagsMap'+ -}++ -- update 'tagsIORef', make sure that `updateTagsMap` is evaluated.+ -- TODO: this is not attomic, which will break when compiling multiple+ -- modules at the same time. I think we need to use 'MVar' and+ -- 'takeMVar'.++ -- update tags file+ withFile tagsFile WriteMode $ \fhandle ->+ BS.hPutBuilder fhandle+ $ foldMap formatVimTag+ $ sort+ $ concat+ $ Map.elems updatedTagsMap++ return $ updatedTagsMap `seq` Just updatedTagsMap+++-- | The 'MVar' is used as an exlusive lock. Also similar to 'bracket' but+-- updates the 'MVar' with returned value, or put the original value if an+-- exception is thrown by the continuation (or an async exception).+--+mvarLock :: MVar a+ -> (a -> IO a)+ -> IO ()+mvarLock v k = mask $ \unmask -> do+ a <- takeMVar v+ a' <- unmask (k a)+ `onException`+ putMVar v a+ putMVar v $! a'+++ghcTagToTag :: GhcTag -> Maybe Tag+ghcTagToTag GhcTag { tagSrcSpan, tagTag } =+ case tagSrcSpan of+ UnhelpfulSpan {} -> Nothing+ RealSrcSpan realSrcSpan ->+ Just $ Tag { tagName = TagName (fs_bs tagTag)+ , tagFile = TagFile (fs_bs (srcSpanFile realSrcSpan))+ , tagLine = srcSpanStartLine realSrcSpan+ }+++formatVimTag :: Tag -> Builder+formatVimTag Tag { tagName, tagFile, tagLine } =+ BS.byteString (getTagName tagName)+ <> BS.charUtf8 '\t'+ <> BS.byteString (getTagFile tagFile)+ <> BS.charUtf8 '\t'+ <> BS.intDec tagLine+ <> BS.charUtf8 '\n'
+ lib/Plugin/GhcTags/Generate.hs view
@@ -0,0 +1,303 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE NamedFieldPuns #-}+{-# LANGUAGE ScopedTypeVariables #-}++-- | Interface for generatating tags for a parsed module.+--+module Plugin.GhcTags.Generate+ ( GhcTag (..)+ , GhcTags+ , generateTagsForModule+ ) where++import Data.Maybe (mapMaybe)+import Data.Foldable (foldl')++-- Ghc imports+import FastString ( FastString (..)+ )+import HsBinds ( HsBindLR (..)+ , PatSynBind (..)+ , Sig (..)+ )+import HsDecls ( ClsInstDecl (..)+ , ConDecl (..)+ , DataFamInstDecl (..)+ , FamEqn (..)+ , FamilyDecl (..)+ , ForeignDecl (..)+ , LHsDecl+ , HsDecl (..)+ , HsDataDefn (..)+ , InstDecl (..)+ , TyClDecl (..)+ , TyFamInstDecl (..)+ )+import HsSyn ( GhcPs+ , HsModule (..)+ )+import HsTypes ( HsImplicitBndrs (..)+ , HsType (..)+ , LHsType+ )+import SrcLoc ( GenLocated (..)+ , Located+ , SrcSpan (..)+ , unLoc+ )+import RdrName ( RdrName (..)+ )+import Name ( nameOccName+ , occNameFS+ )+++-- | We can read names from using fields of type 'GHC.Hs.Extensions.IdP' (a tpye+-- family) which for @'Parsed@ resolved to 'RdrName'+--+data GhcTag = GhcTag {+ tagSrcSpan :: !SrcSpan+ , tagTag :: !FastString+ }+ deriving Show++type GhcTags = [GhcTag]+++mkGhcTag :: Located RdrName -- Located (IdP GhcPs)+ -> GhcTag+mkGhcTag (L tagSrcSpan rdrName) =+ case rdrName of+ Unqual occName ->+ GhcTag { tagTag = occNameFS occName+ , tagSrcSpan+ }++ Qual _ occName ->+ GhcTag { tagTag = occNameFS occName+ , tagSrcSpan+ }++ -- Orig is the only one we are interested in+ Orig _ occName ->+ GhcTag { tagTag = occNameFS occName+ , tagSrcSpan+ }++ Exact name -> + GhcTag { tagTag = occNameFS $ nameOccName name+ , tagSrcSpan+ }++++-- | Generate tags for a module - simple walk over the syntax tree.+--+-- Supported identifiers:+-- * top level terms+-- * type classes+-- * type class members+-- * type class instances+-- * type families+-- * type family instances+-- * data type families+-- * data type families instances+-- * data type family instances constructors+--+generateTagsForModule :: Located (HsModule GhcPs)+ -> GhcTags+generateTagsForModule (L _ HsModule { hsmodDecls }) = + reverse $ foldl' go [] hsmodDecls+ where+ go :: GhcTags -> LHsDecl GhcPs -> GhcTags+ go tags (L _ hsDecl) = case hsDecl of+ -- type or class declaration+ TyClD _ tyClDecl ->+ case tyClDecl of+ FamDecl { tcdFam } ->+ case mkFamilyDeclTags tcdFam of+ Just tag -> tag : tags+ Nothing -> tags++ SynDecl { tcdLName } ->+ mkGhcTag tcdLName : tags++ DataDecl { tcdLName, tcdDataDefn } -> + case tcdDataDefn of+ HsDataDefn { dd_cons } ->+ mkGhcTag tcdLName : ((mkConsTags . unLoc) `concatMap` dd_cons) ++ tags++ XHsDataDefn {} ->+ tags++ -- TODO: add 'tcdATDefs'+ ClassDecl { tcdLName, tcdSigs, tcdMeths, tcdATs } ->+ -- class name+ mkGhcTag tcdLName+ -- class methods+ : (mkSigTags . unLoc) `concatMap` tcdSigs+ -- default methods+ ++ foldl' (\tags' hsBind -> mkHsBindLRTags (unLoc hsBind) ++ tags')+ tags+ tcdMeths+ -- associated types+ ++ (mkFamilyDeclTags . unLoc) `mapMaybe` tcdATs++ XTyClDecl {} -> tags++ InstD _ instDecl ->+ case instDecl of+ ClsInstD { cid_inst } ->+ case cid_inst of+ XClsInstDecl {} -> tags++ ClsInstDecl { cid_poly_ty, cid_tyfam_insts, cid_datafam_insts } ->+ case cid_poly_ty of+ XHsImplicitBndrs {} ->+ tyFamTags ++ dataFamTags ++ tags++ -- TODO: @hsbib_body :: LHsType GhcPs@+ HsIB { hsib_body } ->+ case mkLHsTypeTag hsib_body of+ Nothing -> tyFamTags ++ dataFamTags ++ tags+ Just tag -> tag : tyFamTags ++ dataFamTags ++ tags+ where+ dataFamTags = (mkDataFamInstDeclTag . unLoc) `concatMap` cid_datafam_insts+ tyFamTags = (mkTyFamInstDeclTag . unLoc) `mapMaybe` cid_tyfam_insts+++ DataFamInstD { dfid_inst } ->+ mkDataFamInstDeclTag dfid_inst ++ tags++ TyFamInstD { tfid_inst } ->+ case mkTyFamInstDeclTag tfid_inst of+ Nothing -> tags+ Just tag -> tag : tags++ XInstDecl {} -> tags++ -- deriveving declaration+ DerivD {} -> tags++ -- value declaration+ ValD _ hsBind -> mkHsBindLRTags hsBind ++ tags++ -- signature declaration+ SigD _ sig -> mkSigTags sig ++ tags++ -- default declaration+ DefD {} -> tags++ -- foreign declaration+ ForD _ foreignDecl ->+ case foreignDecl of+ ForeignImport { fd_name } -> mkGhcTag fd_name : tags++ ForeignExport { fd_name } -> mkGhcTag fd_name : tags++ XForeignDecl {} -> tags++ WarningD {} -> tags+ AnnD {} -> tags++ -- TODO: Rules are named it would be nice to get them too+ RuleD {} -> tags++ -- TODO: splices+ SpliceD {} -> tags++ DocD {} -> tags+ RoleAnnotD {} -> tags+ XHsDecl {} -> tags++ -- tags of all constructors of a type+ mkConsTags :: ConDecl GhcPs -> GhcTags+ mkConsTags ConDeclGADT { con_names } = mkGhcTag `map` con_names+ mkConsTags ConDeclH98 { con_name } = [mkGhcTag con_name]+ mkConsTags XConDecl {} = []++ mkHsBindLRTags :: HsBindLR GhcPs GhcPs -> GhcTags+ mkHsBindLRTags hsBind =+ case hsBind of+ FunBind { fun_id } -> [mkGhcTag fun_id]++ -- TODO+ -- This is useful fo generating tags for+ -- ````+ -- Just x = lhs+ -- ```+ PatBind {} -> []++ VarBind { var_id, var_rhs = L srcSpan _ } -> [mkGhcTag (L srcSpan var_id)]++ -- abstraction binding are only used after translaction+ AbsBinds {} -> []++ PatSynBind _ PSB { psb_id } -> [mkGhcTag psb_id]+ PatSynBind _ XPatSynBind {} -> []++ XHsBindsLR {} -> []++ mkSigTags :: Sig GhcPs -> GhcTags+ mkSigTags (TypeSig _ lhs _) = mkGhcTag `map` lhs+ mkSigTags (PatSynSig _ lhs _) = mkGhcTag `map` lhs+ mkSigTags (ClassOpSig _ _ lhs _) = mkGhcTag `map` lhs+ mkSigTags IdSig {} = []+ -- TODO: generate theses with additional info (fixity)+ mkSigTags FixSig {} = []+ mkSigTags InlineSig {} = []+ -- SPECIALISE pragmas+ mkSigTags SpecSig {} = []+ mkSigTags SpecInstSig {} = []+ -- MINIMAL pragma+ mkSigTags MinimalSig {} = []+ -- SSC pragma+ mkSigTags SCCFunSig {} = []+ -- COMPLETE pragma+ mkSigTags CompleteMatchSig {} = []+ mkSigTags XSig {} = []++ mkFamilyDeclTags :: FamilyDecl GhcPs -> Maybe GhcTag+ mkFamilyDeclTags FamilyDecl { fdLName } = Just $ mkGhcTag fdLName+ mkFamilyDeclTags XFamilyDecl {} = Nothing++ -- used to generate tag of an instance declaration+ mkLHsTypeTag :: LHsType GhcPs -> Maybe GhcTag+ mkLHsTypeTag (L _ hsType) =+ case hsType of+ HsForAllTy {hst_body} -> mkLHsTypeTag hst_body+ + HsQualTy {hst_body} -> mkLHsTypeTag hst_body++ HsTyVar _ _ a -> Just $ mkGhcTag a++ HsAppTy _ a _ -> mkLHsTypeTag a+ HsOpTy _ _ a _ -> Just $ mkGhcTag a+ HsKindSig _ a _ -> mkLHsTypeTag a++ _ -> Nothing++ -- todo: type constructors+ mkDataFamInstDeclTag :: DataFamInstDecl GhcPs -> GhcTags+ mkDataFamInstDeclTag DataFamInstDecl { dfid_eqn } =+ case dfid_eqn of+ XHsImplicitBndrs {} -> []++ HsIB { hsib_body = FamEqn { feqn_tycon, feqn_rhs } } ->+ case feqn_rhs of+ HsDataDefn { dd_cons } ->+ mkGhcTag feqn_tycon : (mkConsTags . unLoc) `concatMap` dd_cons+ XHsDataDefn {} ->+ mkGhcTag feqn_tycon : []++ HsIB { hsib_body = XFamEqn {} } -> []++ mkTyFamInstDeclTag :: TyFamInstDecl GhcPs -> Maybe GhcTag+ mkTyFamInstDeclTag TyFamInstDecl { tfid_eqn } =+ case tfid_eqn of+ XHsImplicitBndrs {} -> Nothing++ -- TODO: should we check @feqn_rhs :: LHsType GhcPs@ as well?+ HsIB { hsib_body = FamEqn { feqn_tycon } } -> Just $ mkGhcTag feqn_tycon++ HsIB { hsib_body = XFamEqn {} } -> Nothing
+ lib/Plugin/GhcTags/Parser.hs view
@@ -0,0 +1,103 @@+{-# LANGUAGE BangPatterns #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-}+{-# LANGUAGE DerivingStrategies #-}++module Plugin.GhcTags.Parser+ ( -- * Tag+ TagName (..)+ , TagFile (..)+ , Tag (..)+ -- * Parsing+ , parseVimTagFile+ -- * TagsMap+ , TagsMap+ , mkTagsMap+ ) where++import Data.ByteString (ByteString)+import Data.ByteString.Internal (c2w)+import Data.Attoparsec.ByteString (Parser)+import qualified Data.Attoparsec.ByteString as Atto+import qualified Data.Attoparsec.ByteString.Char8 as Atto ( decimal+ , endOfLine+ )+import Data.List (sort)+import Data.Map (Map)+import qualified Data.Map as Map+++--+-- Tag+--+++-- | 'ByteString' which encodes a tag name.+--+newtype TagName = TagName { getTagName :: ByteString }+ deriving newtype (Eq, Ord, Show)+++-- | 'ByteString' which encodes a tag file.+--+newtype TagFile = TagFile { getTagFile :: ByteString }+ deriving newtype (Eq, Ord, Show)+++-- | Simple Tag record. For the moment on tag name, tag file and line numbers+-- are supported.+--+-- TODO: expand to support column numbers and extra information.+--+data Tag = Tag+ { tagName :: !TagName+ , tagFile :: !TagFile+ , tagLine :: !Int+ }+ deriving (Ord, Eq, Show)+++--+-- Parsing+--+++-- | Parser for a single line of a vim-style tag file.+--+vimTagLineParser:: Parser Tag+vimTagLineParser =+ Tag <$> (TagName <$> Atto.takeWhile (/= tab) <* Atto.skipWhile (== tab))+ <*> (TagFile <$> Atto.takeWhile (/= tab) <* Atto.skipWhile (== tab))+ <*> Atto.decimal+ where+ tab = c2w '\t'++-- | A vim-style tag file parser.+--+vimTagFileParser :: Parser [Tag]+vimTagFileParser = Atto.sepBy vimTagLineParser Atto.endOfLine+++-- | Parse a vim-style tag file.+--+parseVimTagFile :: ByteString+ -> IO (Either String [Tag])+parseVimTagFile =+ fmap Atto.eitherResult+ . Atto.parseWith (pure mempty) vimTagFileParser+++--+-- TagsMap+--+++type TagsMap = Map TagFile [Tag]++-- | Map from TagName to list of tags. This will be useful when updating tags.+-- We will just need to merge dictionaries.+--+mkTagsMap :: [Tag] -> TagsMap+mkTagsMap =+ fmap sort+ . Map.fromListWith (<>)+ . map (\t -> (tagFile t, [t]))