diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +Parser-helper - Serialize haskell-src-exts to JSON. +========= + +Parser-helper parses a Haskell file with haskell-src-exts and prints a +JSON-serialized parse tree to standard out. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/parser-helper.cabal b/parser-helper.cabal new file mode 100644 --- /dev/null +++ b/parser-helper.cabal @@ -0,0 +1,39 @@ +name: parser-helper + +-- The package version. See the Haskell package versioning policy (PVP) +-- for standards guiding when and how versions should be incremented. +-- http://www.haskell.org/haskellwiki/Package_versioning_policy +-- PVP summary: +-+------- breaking API changes +-- | | +----- non-breaking API additions +-- | | | +--- code changes with no API change +version: 0.1.0.0 +synopsis: Prints Haskell parse trees in JSON. + +-- A longer description of the package. +description: Serialize haskell-src-exts parse trees to JSON. +license: Apache-2.0 +license-file: LICENSE +author: Peter A. Jonsson +maintainer: jonsson.peter.a@gmail.com +-- copyright: +category: Development +build-type: Simple +extra-source-files: README.md +cabal-version: >=1.10 + +source-repository head + type: git + location: https://github.com/pjonsson/parser-helper + +executable parser-helper + main-is: Development/Main.hs + -- other-modules: + other-extensions: TemplateHaskell, + OverloadedStrings + build-depends: base >= 4.6 && <4.7, + aeson > 0.7, + haskell-src-exts > 1.15 && < 1.16, + bytestring > 0.10, + text > 1.0 + hs-source-dirs: src + default-language: Haskell2010 diff --git a/src/Development/Main.hs b/src/Development/Main.hs new file mode 100644 --- /dev/null +++ b/src/Development/Main.hs @@ -0,0 +1,198 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TemplateHaskell #-} +module Main (main) where + +import Data.Aeson +import Data.Aeson.TH +import qualified Data.ByteString.Lazy as B +import Data.Maybe (listToMaybe) +import Data.Text (pack) +import Language.Haskell.Exts.Annotated +import System.Environment +import System.Exit (exitFailure) + +-- | Program version. Important for API changes. +version :: String +version = "0.1.0" + +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''SrcSpanInfo) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''SrcSpan) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Module) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Exp) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Promoted) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ImportDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ImportSpec) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ExportSpec) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''WarningText) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ModulePragma) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Tool) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''CName) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''QName) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''IPName) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Decl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''RPat) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''RPatOp) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Annotation) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''InstHead) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Activation) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''CallConv) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Safety) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Rhs) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Match) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Op) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''InstDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ClassDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''DeclHead) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Assoc) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ConDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''BangType) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''PatField) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''GuardedAlts) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Kind) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Context) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Name) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''SpecialCon) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''XName) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''TyVarBind) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Asst) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Splice) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Bracket) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Literal) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''QOp) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Type) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''QualStmt) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''FieldUpdate) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Stmt) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Pat) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Binds) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Boxed) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''RuleVar) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''DataOrNew) + +-- FIXME: Waiting for https://github.com/bos/aeson/issues/206. +{- +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ModuleHead) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ModuleName) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Comment) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ImportSpecList) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''ExportSpecList) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Deriving) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''IfAlt) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''GuardedAlt) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Alt) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''PXAttr) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''XAttr) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''FunDep) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''GadtDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''FieldDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''QualConDecl) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''IPBind) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''GuardedRhs) +$(deriveToJSON defaultOptions { sumEncoding = ObjectWithSingleField } ''Rule) +-} + + +-- l (ModuleName l) (Maybe (WarningText l)) (Maybe (ExportSpecList l)) +instance ToJSON l => ToJSON (ModuleHead l) where + toJSON (ModuleHead s n wt es) + = object [(pack "ModuleHead") .= [toJSON s, toJSON n, toJSON wt, toJSON es]] + +instance ToJSON l => ToJSON (ModuleName l) where + toJSON (ModuleName s name) + = object [(pack "ModuleName") .= [toJSON s, toJSON name]] + +-- data Comment = Comment Bool SrcSpan String +instance ToJSON Comment where + toJSON (Comment b s c) + = object [(pack "Comment") .= [toJSON b, toJSON s, toJSON c]] + +instance ToJSON l => ToJSON (ImportSpecList l) where + toJSON (ImportSpecList l b ls) + = object [(pack "ImportSpecList") .= [toJSON l, toJSON b, toJSON ls]] + +instance ToJSON l => ToJSON (ExportSpecList l) where + toJSON (ExportSpecList l ls) + = object [(pack "ExportSpecList") .= [toJSON l, toJSON ls]] + +instance ToJSON l => ToJSON (Deriving l) where + toJSON (Deriving l hs) = object [(pack "Deriving") .= [toJSON l, toJSON hs]] + +instance ToJSON l => ToJSON (IfAlt l) where + toJSON (IfAlt l e1 e2) + = object [(pack "IfAlt") .= [toJSON l, toJSON e1, toJSON e2]] + +instance ToJSON l => ToJSON (GuardedAlt l) where + toJSON (GuardedAlt l s1 e2) + = object [(pack "GuardedAlt") .= [toJSON l, toJSON s1, toJSON e2]] + +instance ToJSON l => ToJSON (Alt l) where + toJSON (Alt l p alts bs) + = object [(pack "Alt") .= [toJSON l, toJSON p, toJSON alts, toJSON bs]] + +instance ToJSON l => ToJSON (PXAttr l) where + toJSON (PXAttr l x p) + = object [(pack "PXAttr") .= [toJSON l, toJSON x, toJSON p]] + +instance ToJSON l => ToJSON (XAttr l) where + toJSON (XAttr l x e) + = object [(pack "XAttr") .= [toJSON l, toJSON x, toJSON e]] + +instance ToJSON l => ToJSON (FunDep l) where + toJSON (FunDep l n1 n2) + = object [(pack "FunDep") .= [toJSON l, toJSON n1, toJSON n2]] + +instance ToJSON l => ToJSON (GadtDecl l) where + toJSON (GadtDecl l n1 t2) + = object [(pack "GadtDecl") .= [toJSON l, toJSON n1, toJSON t2]] + +instance ToJSON l => ToJSON (FieldDecl l) where + toJSON (FieldDecl l n1 b2) + = object [(pack "FieldDecl") .= [toJSON l, toJSON n1, toJSON b2]] + +instance ToJSON l => ToJSON (QualConDecl l) where + toJSON (QualConDecl l tys c1 c2) + = object [(pack "QualConDecl") .= [toJSON l, toJSON tys, toJSON c1 + , toJSON c2]] + +instance ToJSON l => ToJSON (IPBind l) where + toJSON (IPBind l ip n) + = object [(pack "IPBind") .= [toJSON l, toJSON ip, toJSON n]] + +instance ToJSON l => ToJSON (GuardedRhs l) where + toJSON (GuardedRhs l s e) + = object [(pack "GuardedRhs") .= [toJSON l, toJSON s, toJSON e]] + +instance ToJSON l => ToJSON (Rule l) where + toJSON (Rule l s a r e1 e2) + = object [(pack "Rule") .= [toJSON l, toJSON s, toJSON a, toJSON r + , toJSON e1, toJSON e2]] + +-- | Parse the first argument and serialize as JSON to stdout. +main :: IO () +main = do + args <- getArgs + case listToMaybe args of + Just arg -> handleArg arg + Nothing -> printUsage >> exitFailure + +-- | Handle possible arguments. +handleArg "--numeric-version" = putStrLn version +handleArg "--version" = putStrLn $ "parser-helper v" ++ version +handleArg "--help" = printUsage +handleArg "-h" = printUsage +handleArg fileName = doWork fileName + +-- | Print usage info. +printUsage :: IO () +printUsage = putStrLn "Usage: parser-helper [ file | --numeric-version | --version ]" + +-- | Parse, serialize and print to stdout. +doWork :: String -> IO () +doWork fileName = do + let parseOpts = defaultParseMode { parseFilename = "A.hs" + , baseLanguage = Haskell2010 + } + p <- parseFileWithComments parseOpts fileName + case p of + ParseOk tree -> B.putStrLn (encode tree) + ParseFailed loc msg -> putStrLn $ "ERROR:" ++ msg