Camfort.Specification.Stencils.Annotation

Defines the StencilAnnotation datatype, which is used for annotating a ProgramFile with stencil information.

Documentation

data StencilAnnotation a

Instances

Linkable SA

Defined in Camfort.Specification.Stencils.Annotation

Methods

link :: SA -> Block SA -> SA

linkPU :: SA -> ProgramUnit SA -> SA

ASTEmbeddable SA Specification

Defined in Camfort.Specification.Stencils.Annotation

Methods

annotateWithAST :: SA -> Specification -> SA

Eq a => Eq (StencilAnnotation a)

Defined in Camfort.Specification.Stencils.Annotation

Methods

(==) :: StencilAnnotation a -> StencilAnnotation a -> Bool

(/=) :: StencilAnnotation a -> StencilAnnotation a -> Bool

Data a => Data (StencilAnnotation a)

Defined in Camfort.Specification.Stencils.Annotation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StencilAnnotation a -> c (StencilAnnotation a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (StencilAnnotation a)

toConstr :: StencilAnnotation a -> Constr

dataTypeOf :: StencilAnnotation a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (StencilAnnotation a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (StencilAnnotation a))

gmapT :: (forall b. Data b => b -> b) -> StencilAnnotation a -> StencilAnnotation a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StencilAnnotation a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StencilAnnotation a -> r

gmapQ :: (forall d. Data d => d -> u) -> StencilAnnotation a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> StencilAnnotation a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> StencilAnnotation a -> m (StencilAnnotation a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StencilAnnotation a -> m (StencilAnnotation a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StencilAnnotation a -> m (StencilAnnotation a)

Show a => Show (StencilAnnotation a)

Defined in Camfort.Specification.Stencils.Annotation

Methods

showsPrec :: Int -> StencilAnnotation a -> ShowS

show :: StencilAnnotation a -> String

showList :: [StencilAnnotation a] -> ShowS

type SA = Analysis (StencilAnnotation A)

Convenience name for common annotation type.

mkStencilAnnotation :: a -> StencilAnnotation a

Create a new stencil annotation.

Specification Annotation Helpers

getAstSpec :: SA -> Maybe SpecDecls

Retrieve a normalized specification from an annotation.

getParseSpec :: SA -> Maybe Specification

Retrieve a parsed specification from an annotation.

getRegionSpec :: SA -> Maybe RegionDecl

Retrieve a region environment from an annotation.

getStencilBlock :: SA -> Maybe (Block SA)

giveAstSpec :: SpecDecls -> SA -> SA

Set the annotation's stencil specification to a normalized specification.

giveParseSpec :: Specification -> SA -> SA

Set the annotation's stencil specification to a parsed specification.

giveRegionSpec :: RegionDecl -> SA -> SA

Set the annotation's stencil specification to a region alias.

Base Annotation

getBaseAnnotation :: SA -> A

Retrieve the underlying (base) annotation from a stencil annotation.

modifyBaseAnnotation :: (A -> A) -> SA -> SA