Safe Haskell	None
Language	Haskell2010

Language.Haskell.GHC.ExactPrint.Annotate

Description

annotate is a function which given a GHC AST fragment, constructs a syntax tree which indicates which annotations belong to each specific part of the fragment.

Delta and Print provide two interpreters for this structure. You should probably use those unless you know what you're doing!

The functor AnnotationF has a number of constructors which correspond to different sitations which annotations can arise. It is hoped that in future versions of GHC these can be simplified by making suitable modifications to the AST.

Synopsis

Documentation

annotate :: Annotate ast => Located ast -> Annotated () #

Construct a syntax tree which represent which KeywordIds must appear where.

data AnnotationF next where #

MarkPrim: The main constructor. Marks that a specific AnnKeywordId could appear with an optional String which is used when printing.
MarkPPOptional: Used to flag elements, such as optional braces, that are not used in the pretty printer. This functions identically to MarkPrim for the other interpreters.
MarkEOF: Special constructor which marks the end of file marker.
MarkExternal: TODO
MarkOutside: A AnnKeywordId which is precisely located but not inside the current context. This is usually used to reassociated located RdrName which are more naturally associated with their parent than in their own annotation.
MarkInside: The dual of MarkOutside. If we wish to mark a non-separating comma or semi-colon then we must use this constructor.
MarkMany: Some syntax elements allow an arbritary number of puncuation marks without reflection in the AST. This construction greedily takes all of the specified AnnKeywordId.
MarkOffsetPrim: Some syntax elements have repeated AnnKeywordId which are seperated by different AnnKeywordId. Thus using MarkMany is unsuitable and instead we provide an index to specify which specific instance to choose each time.
WithAST: TODO
CountAnns: Sometimes the AST does not reflect the concrete source code and the only way to tell what the concrete source was is to count a certain kind of AnnKeywordId.
WithSortKey: There are many places where the syntactic ordering of elements is thrown away by the AST. This constructor captures the original ordering and reflects any changes in ordered as specified by the annSortKey field in Annotation.
SetLayoutFlag: It is important to know precisely where layout rules apply. This constructor wraps a computation to indicate that LayoutRules apply to the corresponding construct.
StoreOriginalSrcSpan: TODO
GetSrcSpanFromKw: TODO
StoreString: TODO
AnnotationsToComments: Used when the AST is sufficiently vague that there is no other option but to convert a fragment of source code into a comment. This means it is impossible to edit such a fragment but means that processing files with such fragments is still possible.

Constructors

MarkPrim :: AnnKeywordId -> Maybe String -> next -> AnnotationF next
MarkPPOptional :: AnnKeywordId -> Maybe String -> next -> AnnotationF next
MarkEOF :: next -> AnnotationF next
MarkExternal :: SrcSpan -> AnnKeywordId -> String -> next -> AnnotationF next
MarkOutside :: AnnKeywordId -> KeywordId -> next -> AnnotationF next
MarkInside :: AnnKeywordId -> next -> AnnotationF next
MarkMany :: AnnKeywordId -> next -> AnnotationF next
MarkManyOptional :: AnnKeywordId -> next -> AnnotationF next
MarkOffsetPrim :: AnnKeywordId -> Int -> Maybe String -> next -> AnnotationF next
MarkOffsetPrimOptional :: AnnKeywordId -> Int -> Maybe String -> next -> AnnotationF next
WithAST :: Data a => Located a -> Annotated b -> next -> AnnotationF next
CountAnns :: AnnKeywordId -> (Int -> next) -> AnnotationF next
WithSortKey :: [(SrcSpan, Annotated ())] -> next -> AnnotationF next
SetLayoutFlag :: Rigidity -> Annotated () -> next -> AnnotationF next
MarkAnnBeforeAnn :: AnnKeywordId -> AnnKeywordId -> next -> AnnotationF next
StoreOriginalSrcSpan :: SrcSpan -> AnnKey -> (AnnKey -> next) -> AnnotationF next
GetSrcSpanForKw :: SrcSpan -> AnnKeywordId -> (SrcSpan -> next) -> AnnotationF next
AnnotationsToComments :: [AnnKeywordId] -> next -> AnnotationF next
SetContextLevel :: Set AstContext -> Int -> Annotated () -> next -> AnnotationF next
UnsetContext :: AstContext -> Annotated () -> next -> AnnotationF next
IfInContext :: Set AstContext -> Annotated () -> Annotated () -> next -> AnnotationF next
WithSortKeyContexts :: ListContexts -> [(SrcSpan, Annotated ())] -> next -> AnnotationF next
TellContext :: Set AstContext -> next -> AnnotationF next

Instances

Functor AnnotationF #
Methods fmap :: (a -> b) -> AnnotationF a -> AnnotationF b # (<$) :: a -> AnnotationF b -> AnnotationF a #

type Annotated = FreeT AnnotationF Identity #

class Data ast => Annotate ast where #

Minimal complete definition

markAST

Methods

markAST :: SrcSpan -> ast -> Annotated () #

Instances

Annotate DocDecl #
Methods markAST :: SrcSpan -> DocDecl -> Annotated () #
Annotate HsIPName #
Methods markAST :: SrcSpan -> HsIPName -> Annotated () #
Annotate HsLit #
Methods markAST :: SrcSpan -> HsLit -> Annotated () #
Annotate RdrName #
Methods markAST :: SrcSpan -> RdrName -> Annotated () #
Annotate Safety #
Methods markAST :: SrcSpan -> Safety -> Annotated () #
Annotate CExportSpec #
Methods markAST :: SrcSpan -> CExportSpec -> Annotated () #
Annotate CCallConv #
Methods markAST :: SrcSpan -> CCallConv -> Annotated () #
Annotate CType #
Methods markAST :: SrcSpan -> CType -> Annotated () #
Annotate StringLiteral #
Methods markAST :: SrcSpan -> StringLiteral -> Annotated () #
Annotate WarningTxt #
Methods markAST :: SrcSpan -> WarningTxt -> Annotated () #
Annotate OverlapMode #
Methods markAST :: SrcSpan -> OverlapMode -> Annotated () #
Annotate HsDocString #
Methods markAST :: SrcSpan -> HsDocString -> Annotated () #
Annotate FastString #
Methods markAST :: SrcSpan -> FastString -> Annotated () #
Annotate Name #
Methods markAST :: SrcSpan -> Name -> Annotated () #
Annotate ModuleName #
Methods markAST :: SrcSpan -> ModuleName -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate [ExprLStmt name] #	Used for declarations that need to be aligned together, e.g. in a do or let .. in statement/expr
Methods markAST :: SrcSpan -> [ExprLStmt name] -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate [LHsType name] #
Methods markAST :: SrcSpan -> [LHsType name] -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate [LHsSigType name] #
Methods markAST :: SrcSpan -> [LHsSigType name] -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate [LConDeclField name] #
Methods markAST :: SrcSpan -> [LConDeclField name] -> Annotated () #
(DataId name, HasOccName name, Annotate name) => Annotate [LIE name] #
Methods markAST :: SrcSpan -> [LIE name] -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name, Annotate body) => Annotate [Located (Match name (Located body))] #
Methods markAST :: SrcSpan -> [Located (Match name (Located body))] -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate [Located (StmtLR name name (LHsCmd name))] #
Methods markAST :: SrcSpan -> [Located (StmtLR name name (LHsCmd name))] -> Annotated () #
Annotate (Maybe Role) #
Methods markAST :: SrcSpan -> Maybe Role -> Annotated () #
Annotate (HsModule RdrName) #
Methods markAST :: SrcSpan -> HsModule RdrName -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsTupArg name) #
Methods markAST :: SrcSpan -> HsTupArg name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsCmdTop name) #
Methods markAST :: SrcSpan -> HsCmdTop name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsRecUpdField name) #
Methods markAST :: SrcSpan -> HsRecUpdField name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsDecl name) #
Methods markAST :: SrcSpan -> HsDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (SpliceDecl name) #
Methods markAST :: SrcSpan -> SpliceDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (TyClDecl name) #
Methods markAST :: SrcSpan -> TyClDecl name -> Annotated () #
(DataId name, Annotate name, OutputableBndr name, HasOccName name) => Annotate (FamilyResultSig name) #
Methods markAST :: SrcSpan -> FamilyResultSig name -> Annotated () #
(DataId name, Annotate name, OutputableBndr name, HasOccName name) => Annotate (FamilyDecl name) #
Methods markAST :: SrcSpan -> FamilyDecl name -> Annotated () #
(DataId name, Annotate name) => Annotate (InjectivityAnn name) #
Methods markAST :: SrcSpan -> InjectivityAnn name -> Annotated () #
(DataId name, Annotate name, OutputableBndr name, HasOccName name) => Annotate (ConDecl name) #
Methods markAST :: SrcSpan -> ConDecl name -> Annotated () #
(DataId name, Annotate name, OutputableBndr name, HasOccName name) => Annotate (TyFamInstEqn name) #
Methods markAST :: SrcSpan -> TyFamInstEqn name -> Annotated () #
(DataId name, Annotate name, OutputableBndr name, HasOccName name) => Annotate (TyFamDefltEqn name) #
Methods markAST :: SrcSpan -> TyFamDefltEqn name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (TyFamInstDecl name) #
Methods markAST :: SrcSpan -> TyFamInstDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (DataFamInstDecl name) #
Methods markAST :: SrcSpan -> DataFamInstDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (ClsInstDecl name) #
Methods markAST :: SrcSpan -> ClsInstDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (InstDecl name) #
Methods markAST :: SrcSpan -> InstDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (DerivDecl name) #
Methods markAST :: SrcSpan -> DerivDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (DefaultDecl name) #
Methods markAST :: SrcSpan -> DefaultDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (ForeignDecl name) #
Methods markAST :: SrcSpan -> ForeignDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (RuleDecls name) #
Methods markAST :: SrcSpan -> RuleDecls name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (RuleDecl name) #
Methods markAST :: SrcSpan -> RuleDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (RuleBndr name) #
Methods markAST :: SrcSpan -> RuleBndr name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (VectDecl name) #
Methods markAST :: SrcSpan -> VectDecl name -> Annotated () #
Annotate name => Annotate (WarnDecls name) #
Methods markAST :: SrcSpan -> WarnDecls name -> Annotated () #
Annotate name => Annotate (WarnDecl name) #
Methods markAST :: SrcSpan -> WarnDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (AnnDecl name) #
Methods markAST :: SrcSpan -> AnnDecl name -> Annotated () #
Annotate name => Annotate (RoleAnnotDecl name) #
Methods markAST :: SrcSpan -> RoleAnnotDecl name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsLocalBinds name) #
Methods markAST :: SrcSpan -> HsLocalBinds name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsBind name) #
Methods markAST :: SrcSpan -> HsBind name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (IPBind name) #
Methods markAST :: SrcSpan -> IPBind name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (Sig name) #
Methods markAST :: SrcSpan -> Sig name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsTyVarBndr name) #
Methods markAST :: SrcSpan -> HsTyVarBndr name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsType name) #
Methods markAST :: SrcSpan -> HsType name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsAppType name) #
Methods markAST :: SrcSpan -> HsAppType name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (ConDeclField name) #
Methods markAST :: SrcSpan -> ConDeclField name -> Annotated () #
DataId name => Annotate (FieldOcc name) #
Methods markAST :: SrcSpan -> FieldOcc name -> Annotated () #
DataId name => Annotate (AmbiguousFieldOcc name) #
Methods markAST :: SrcSpan -> AmbiguousFieldOcc name -> Annotated () #
DataId name => Annotate (HsOverLit name) #
Methods markAST :: SrcSpan -> HsOverLit name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsExpr name) #
Methods markAST :: SrcSpan -> HsExpr name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsCmd name) #
Methods markAST :: SrcSpan -> HsCmd name -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (HsSplice name) #
Methods markAST :: SrcSpan -> HsSplice name -> Annotated () #
(DataId name, Annotate name, OutputableBndr name, HasOccName name) => Annotate (Pat name) #
Methods markAST :: SrcSpan -> Pat name -> Annotated () #
(DataId name, Annotate name) => Annotate (FunDep (Located name)) #
Methods markAST :: SrcSpan -> FunDep (Located name) -> Annotated () #
(DataId name, HasOccName name, Annotate name) => Annotate (ImportDecl name) #
Methods markAST :: SrcSpan -> ImportDecl name -> Annotated () #
(DataId name, HasOccName name, Annotate name) => Annotate (IE name) #
Methods markAST :: SrcSpan -> IE name -> Annotated () #
Annotate name => Annotate (BooleanFormula (Located name)) #
Methods markAST :: SrcSpan -> BooleanFormula (Located name) -> Annotated () #
Annotate (SourceText, FastString) #
Methods markAST :: SrcSpan -> (SourceText, FastString) -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name, Annotate body) => Annotate (Match name (Located body)) #
Methods markAST :: SrcSpan -> Match name (Located body) -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name, Annotate body) => Annotate (GRHS name (Located body)) #
Methods markAST :: SrcSpan -> GRHS name (Located body) -> Annotated () #
(DataId name, OutputableBndr name, Annotate name, HasOccName name, Annotate body) => Annotate (Stmt name (Located body)) #
Methods markAST :: SrcSpan -> Stmt name (Located body) -> Annotated () #
(DataId name, OutputableBndr name, HasOccName name, Annotate name) => Annotate (ParStmtBlock name name) #
Methods markAST :: SrcSpan -> ParStmtBlock name name -> Annotated () #
(Annotate name, DataId name, OutputableBndr name, HasOccName name) => Annotate (HsRecField name (LHsExpr name)) #
Methods markAST :: SrcSpan -> HsRecField name (LHsExpr name) -> Annotated () #
(Annotate name, DataId name, OutputableBndr name, HasOccName name) => Annotate (HsRecField name (LPat name)) #
Methods markAST :: SrcSpan -> HsRecField name (LPat name) -> Annotated () #
(DataId name, Annotate arg) => Annotate (HsImplicitBndrs name (Located arg)) #
Methods markAST :: SrcSpan -> HsImplicitBndrs name (Located arg) -> Annotated () #

withSortKeyContextsHelper :: Monad m => (Annotated () -> m ()) -> ListContexts -> [(SrcSpan, Annotated ())] -> m () #