Language.Haskell.Tools.AST.Helpers

Helper functions for using the AST.

Documentation

importIsExact :: Ann UImportDecl dom stage -> Bool

Does the import declaration import only the explicitly listed elements?

bindingName :: SemanticInfo dom UQualifiedName ~ ni => Simple Traversal (Ann UValueBind dom stage) (Ann UQualifiedName dom stage)

Accesses the name of a function or value binding

declHeadNames :: Simple Traversal (Ann UDeclHead dom stage) (Ann UQualifiedName dom stage)

Accesses that name of a declaration through the declaration head.

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

A reference to access type arguments to a type constructor call that may be universally qualified or parenthesized.

valBindPats :: Simple Traversal (Ann UValueBind dom stage) (Ann UPattern dom stage)

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

Access the semantic information of an AST node.

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

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 source spans based on their lengths. Can only used for NESTED spans.

class NamedElement elem where

A class to access the names of named elements. Have to locate where does the AST element store its name. The returned name will be the one that was marked isDefining.

Minimal complete definition

elementName

Methods

elementName :: Simple Traversal (Ann elem dom st) (Ann UQualifiedName dom st)

Instances

NamedElement ULocalBind

Methods

elementName :: (RefMonads w r, MonadPlus r, Morph Maybe r, Morph [] r) => Reference w r (MU *) (MU *) (Ann ULocalBind dom st) (Ann ULocalBind dom st) (Ann UQualifiedName dom st) (Ann UQualifiedName dom st)

NamedElement UDecl

Methods

elementName :: (RefMonads w r, MonadPlus r, Morph Maybe r, Morph [] r) => Reference w r (MU *) (MU *) (Ann UDecl dom st) (Ann UDecl dom st) (Ann UQualifiedName dom st) (Ann UQualifiedName dom st)

inScope :: Name -> Scope -> Bool

Pattern synonyms for annotated lists and maybes

pattern AnnList :: forall elem dom stage. [Ann elem dom stage] -> AnnListG elem dom stage

pattern AnnNothing :: forall elem dom stage. AnnMaybeG elem dom stage

pattern AnnJust :: forall elem dom stage. Ann elem dom stage -> AnnMaybeG elem dom stage