haskell-src-exts-simple: A simplified view on the haskell-src-exts AST

[ development, library, mit ] [ Propose Tags ] [ Report a vulnerability ]

This package provides a shim for haskell-src-exts (HSE), exposing the same AST but without annotations, using ghc's pattern synonyms.

See README.md for further information and compatibility considerations.


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 1.18.0.0, 1.18.0.1, 1.18.0.1.1, 1.19.0.0, 1.20.0.0, 1.21.0.0, 1.21.1.0, 1.22.0.0, 1.23.0.0
Change log CHANGELOG.md
Dependencies base (>=4.7 && <5), haskell-src-exts (>=1.18 && <1.20) [details]
License MIT
Copyright 2016, Bertram Felgenhauer
Author Bertram Felgenhauer
Maintainer Bertram Felgenhauer <int-e@gmx.de>
Category Development
Home page https://github.com/int-e/haskell-src-exts-simple
Source repo head: git clone https://github.com/int-e/haskell-src-exts-simple
Uploaded by BertramFelgenhauer at 2016-11-20T12:57:16Z
Distributions Arch:1.23.0.0, Debian:1.23.0.0, LTSHaskell:1.23.0.0, NixOS:1.23.0.0, Stackage:1.23.0.0
Reverse Dependencies 4 direct, 5 indirect [details]
Downloads 7230 total (60 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-11-20 [all 1 reports]

Readme for haskell-src-exts-simple-1.19.0.0

[back to package description]

haskell-src-exts-simple

Synopsis

This package provides a shim for haskell-src-exts, exposing the same AST but without annotations, using ghc's pattern synonyms.

This package is useful for synthesizing and manipulating HSE ASTs that don't carry source location information. It may also aid in porting packages from haskell-src-exts 1.17 to 1.18, but it is not a drop-in replacement for the old annotation-free AST. See the Compatibility section for details.

Versioning

To be able to track the haskell-src-exts version numbers conveniently, the first three components of the version will be treated as the major version, followed by the minor version as usual. This deviates from the PVP.

Compatibility

Comparison to haskell-src-exts 1.17 (as of version 1.18):

haskell-src-exts-simple provides a simplified view of the annotated AST in haskell-src-exts, so there are differences to the unannotated AST provided by earlier versions of haskell-src-exts:

  • some constructors carried SrcLoc information, which is no longer available, notably
    • most constructors of the Decl, ModulePragma, ImportDecl, IPBind, ClassDecl, InstDecl, QualConDecl, GadtDecl datatypes
    • the Lambda, ExpTypeSig and Proc constructors of the Exp type (and a few XML related ones)
    • the Generator constructor of Stmt
    • the Alt constructor of Alt
    • the PatTypeSig constructor of Pat
  • the second, fourth and fifth fields of the Module constructor have been combined into a single field of type ModuleHead

(this list is probably incomplete)

ghc compatibility

  • haskell-src-exts-simple requires ghc-7.8 or later
  • Note that with ghc-7.8, the constructors of the Language.Haskell.Exts.Simple.Syntax.Literal type are only available for pattern matching, because construction relies on explicitly bidirectional pattern synonyms for literals. For ghc-7.8 compatibility, you should use the *L (intL etc.) functions for constructing Literal values.
  • Support for record pattern synonyms was added in ghc-8.0. Therefore, with ghc-7.10 and earlier, the constructor of the Language.Haskell.Exts.Simple.Syntax.ImportDecl type is exported as a plain constructor, and the selectors as functions.