Language.Haskell.Tools.AST.Helpers

Helper functions for using the AST.

Documentation

ordByOccurrence :: QualifiedName dom stage -> QualifiedName dom stage -> Ordering

nameString :: QualifiedName dom stage -> String

The occurrence of the name.

nameElements :: QualifiedName dom stage -> [String]

The qualifiers and the unqualified name

nameQualifier :: QualifiedName dom stage -> [String]

The qualifier of the name

importIsExact :: ImportDecl dom stage -> Bool

Does the import declaration import only the explicitly listed elements?

importIsHiding :: ImportDecl dom stage -> Bool

Does the import declaration has a hiding clause?

importExacts :: Simple Traversal (ImportDecl dom stage) (IESpec dom stage)

All elements that are explicitly listed to be imported in the import declaration

importHidings :: Simple Traversal (ImportDecl dom stage) (IESpec dom stage)

All elements that are hidden in an import

importQualifiers :: ImportDecl dom stage -> [[String]]

Possible qualifiers to use imported definitions

bindingName :: SemanticInfo dom QualifiedName ~ ni => Simple Traversal (Ann ValueBind dom stage) ni

declHeadNames :: Simple Traversal (Ann DeclHead dom stage) (Ann QualifiedName dom stage)

typeParams :: Simple Traversal (Ann Type dom stage) (Ann Type dom stage)

semantics :: Simple Lens (Ann elem dom stage) (SemanticInfo dom elem)

Access the semantic information of an AST node.

dhNames :: SemanticInfo dom QualifiedName ~ k => Simple Traversal (Ann DeclHead dom stage) k

class BindingElem d where

A type class for transformations that work on both top-level and local definitions

Minimal complete definition

sigBind, valBind, createTypeSig, createBinding, isTypeSig, isBinding

Methods

sigBind :: Simple Partial (d dom stage) (Ann TypeSignature dom stage)

valBind :: Simple Partial (d dom stage) (Ann ValueBind dom stage)

createTypeSig :: Ann TypeSignature dom stage -> d dom stage

createBinding :: Ann ValueBind dom stage -> d dom stage

isTypeSig :: d dom stage -> Bool

isBinding :: d dom stage -> Bool

Instances

BindingElem LocalBind

Methods

sigBind :: (Functor w, Applicative w, Monad w, Functor r, Applicative r, MonadPlus r, Morph Maybe r) => Reference w r (MU *) (MU *) (LocalBind dom stage) (LocalBind dom stage) (Ann TypeSignature dom stage) (Ann TypeSignature dom stage)

valBind :: (Functor w, Applicative w, Monad w, Functor r, Applicative r, MonadPlus r, Morph Maybe r) => Reference w r (MU *) (MU *) (LocalBind dom stage) (LocalBind dom stage) (Ann ValueBind dom stage) (Ann ValueBind dom stage)

createTypeSig :: Ann TypeSignature dom stage -> LocalBind dom stage

createBinding :: Ann ValueBind dom stage -> LocalBind dom stage

isTypeSig :: LocalBind dom stage -> Bool

isBinding :: LocalBind dom stage -> Bool

BindingElem Decl

Methods

sigBind :: (Functor w, Applicative w, Monad w, Functor r, Applicative r, MonadPlus r, Morph Maybe r) => Reference w r (MU *) (MU *) (Decl dom stage) (Decl dom stage) (Ann TypeSignature dom stage) (Ann TypeSignature dom stage)

valBind :: (Functor w, Applicative w, Monad w, Functor r, Applicative r, MonadPlus r, Morph Maybe r) => Reference w r (MU *) (MU *) (Decl dom stage) (Decl dom stage) (Ann ValueBind dom stage) (Ann ValueBind dom stage)

createTypeSig :: Ann TypeSignature dom stage -> Decl dom stage

createBinding :: Ann ValueBind dom stage -> Decl dom stage

isTypeSig :: Decl dom stage -> Bool

isBinding :: Decl dom stage -> Bool

bindName :: (BindingElem d, SemanticInfo dom QualifiedName ~ k) => Simple Traversal (d dom stage) k

valBindsInList :: BindingElem d => Simple Traversal (AnnList d dom stage) (Ann ValueBind dom stage)

getValBindInList :: (BindingElem d, SourceInfo stage) => RealSrcSpan -> AnnList d dom stage -> Maybe (Ann ValueBind dom stage)

nodesContaining :: (HasRange (inner dom stage), Biplate (node dom stage) (inner dom stage), SourceInfo stage) => RealSrcSpan -> Simple Traversal (node dom stage) (inner dom stage)

Get all nodes that contain a given source range

isInside :: HasRange (inner dom stage) => RealSrcSpan -> inner dom stage -> Bool

Return true if the node contains a given range

nodesContained :: (HasRange (inner dom stage), Biplate (node dom stage) (inner dom stage), SourceInfo stage) => RealSrcSpan -> Simple Traversal (node dom stage) (inner dom stage)

Get all nodes that are contained in a given source range

isContained :: HasRange (inner dom stage) => RealSrcSpan -> inner dom stage -> Bool

Return true if the node contains a given range

nodesWithRange :: (Biplate (Ann node dom stage) (Ann inner dom stage), SourceInfo stage) => RealSrcSpan -> Simple Traversal (Ann node dom stage) (Ann inner dom stage)

Get the nodes that have exactly the given range

hasRange :: SourceInfo stage => RealSrcSpan -> Ann inner dom stage -> Bool

True, if the node has the given range

getNodeContaining :: (Biplate (Ann node dom stage) (Ann inner dom stage), SourceInfo stage, HasRange (Ann inner dom stage)) => RealSrcSpan -> Ann node dom stage -> Maybe (Ann inner dom stage)

Get the shortest source range that contains the given

compareRangeLength :: SrcSpan -> SrcSpan -> Ordering

Compares two NESTED source spans based on their lengths

getNode :: (Biplate (Ann node dom stage) (Ann inner dom stage), SourceInfo stage) => RealSrcSpan -> Ann node dom stage -> Ann inner dom stage