Safe Haskell	Safe-Inferred
Language	Haskell2010

HIndent.Pretty.Types

Description

Types to pretty-print certain parts of Haskell codes.

We define new types to pretty-print AST nodes rather than define functions to print comments easily using the Pretty implementation of GenLocated.

Synopsis

newtype InfixExpr = InfixExpr (LHsExpr GhcPs)
newtype InfixOp = InfixOp RdrName
newtype PrefixOp = PrefixOp RdrName
data InfixApp = InfixApp {
- lhs :: LHsExpr GhcPs
- op :: LHsExpr GhcPs
- rhs :: LHsExpr GhcPs
- immediatelyAfterDo :: Bool
}
data GRHSsExpr = GRHSsExpr {
- grhssExprType :: GRHSExprType
- grhssExpr :: GRHSs GhcPs (LHsExpr GhcPs)
}
data GRHSExpr = GRHSExpr {
- grhsExprType :: GRHSExprType
- grhsExpr :: GRHS GhcPs (LHsExpr GhcPs)
}
newtype GRHSProc = GRHSProc (GRHS GhcPs (LHsCmd GhcPs))
newtype RecConPat = RecConPat (HsRecFields GhcPs (LPat GhcPs))
newtype RecConField = RecConField (HsFieldBind (LFieldOcc GhcPs) (LPat GhcPs))
data HsSigType' = HsSigType' {
- hsSigTypeFor :: HsTypeFor
- hsSigTypeDir :: HsTypeDir
- hsSigType :: HsSigType GhcPs
}
pattern HsSigTypeInsideInstDecl :: HsSigType GhcPs -> HsSigType'
pattern HsSigTypeInsideVerticalFuncSig :: HsSigType GhcPs -> HsSigType'
pattern HsSigTypeInsideDeclSig :: HsSigType GhcPs -> HsSigType'
data HsType' = HsType' {
- hsTypeFor :: HsTypeFor
- hsTypeDir :: HsTypeDir
- hsType :: HsType GhcPs
}
pattern HsTypeInsideVerticalFuncSig :: HsType GhcPs -> HsType'
pattern HsTypeInsideDeclSig :: HsType GhcPs -> HsType'
pattern HsTypeInsideInstDecl :: HsType GhcPs -> HsType'
pattern HsTypeWithVerticalAppTy :: HsType GhcPs -> HsType'
data DataFamInstDecl' = DataFamInstDecl' {
- dataFamInstDeclFor :: DataFamInstDeclFor
- dataFamInstDecl :: DataFamInstDecl GhcPs
}
pattern DataFamInstDeclTopLevel :: DataFamInstDecl GhcPs -> DataFamInstDecl'
pattern DataFamInstDeclInsideClassInst :: DataFamInstDecl GhcPs -> DataFamInstDecl'
data FamEqn' = FamEqn' {
- famEqnFor :: DataFamInstDeclFor
- famEqn :: FamEqn GhcPs (HsDataDefn GhcPs)
}
pattern FamEqnTopLevel :: FamEqn GhcPs (HsDataDefn GhcPs) -> FamEqn'
pattern FamEqnInsideClassInst :: FamEqn GhcPs (HsDataDefn GhcPs) -> FamEqn'
newtype StmtLRInsideVerticalList = StmtLRInsideVerticalList (StmtLR GhcPs GhcPs (LHsExpr GhcPs))
newtype ParStmtBlockInsideVerticalList = ParStmtBlockInsideVerticalList (ParStmtBlock GhcPs GhcPs)
newtype DeclSig = DeclSig (Sig GhcPs)
newtype TopLevelTyFamInstDecl = TopLevelTyFamInstDecl (TyFamInstDecl GhcPs)
newtype Context = Context (LHsContext GhcPs)
newtype HorizontalContext = HorizontalContext (LHsContext GhcPs)
newtype VerticalContext = VerticalContext (LHsContext GhcPs)
newtype ModuleNameWithPrefix = ModuleNameWithPrefix ModuleName
newtype PatInsidePatDecl = PatInsidePatDecl (Pat GhcPs)
data LambdaCase = LambdaCase {
- lamCaseGroup :: MatchGroup GhcPs (LHsExpr GhcPs)
- caseOrCases :: CaseOrCases
}
newtype ModuleDeprecatedPragma = ModuleDeprecatedPragma (WarningTxt GhcPs)
data ListComprehension = ListComprehension {
- listCompLhs :: ExprLStmt GhcPs
- listCompRhs :: [ExprLStmt GhcPs]
}
data DoExpression = DoExpression {
- doStmts :: [ExprLStmt GhcPs]
- doOrMdo :: DoOrMdo
}
data DoOrMdo
- = Do
- | Mdo
data LetIn = LetIn {
- letBinds :: HsLocalBinds GhcPs
- inExpr :: LHsExpr GhcPs
}
data NodeComments = NodeComments {
- commentsBefore :: [LEpaComment]
- commentsOnSameLine :: [LEpaComment]
- commentsAfter :: [LEpaComment]
}
data GRHSExprType
- = GRHSExprNormal
- | GRHSExprCase
- | GRHSExprMultiWayIf
- | GRHSExprLambda
data GRHSProcType
- = GRHSProcCase
- | GRHSProcLambda
data HsTypeFor
- = HsTypeForNormalDecl
- | HsTypeForInstDecl
- | HsTypeForFuncSig
- | HsTypeForDeclSig
- | HsTypeForVerticalAppTy
data HsTypeDir
- = HsTypeNoDir
- | HsTypeVertical
data CaseOrCases
- = Case
- | Cases
data DataFamInstDeclFor
- = DataFamInstDeclForTopLevel
- | DataFamInstDeclForInsideClassInst

Documentation

newtype InfixExpr Source #

LHsExpr used as a infix operator

Constructors

InfixExpr (LHsExpr GhcPs)

Instances

Instances details

CommentExtraction InfixExpr Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: InfixExpr -> NodeComments Source #

newtype InfixOp Source #

Constructors

InfixOp RdrName

Instances

Instances details

CommentExtraction InfixOp Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: InfixOp -> NodeComments Source #

newtype PrefixOp Source #

A wrapper type for printing an identifier as a prefix operator.

Printing a PrefixOp value containing a symbol operator wraps it with parentheses.

Constructors

PrefixOp RdrName

Instances

Instances details

CommentExtraction PrefixOp Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: PrefixOp -> NodeComments Source #

data InfixApp Source #

An infix operator application.

immediatelyAfterDo is True if an application is next to a `do` keyword. It needs an extra indent in such cases because

do a
* b

is not a valid Haskell code.

Constructors

InfixApp
Fields lhs :: LHsExpr GhcPs op :: LHsExpr GhcPs rhs :: LHsExpr GhcPs immediatelyAfterDo :: Bool

Instances

Instances details

CommentExtraction InfixApp Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: InfixApp -> NodeComments Source #

data GRHSsExpr Source #

GRHSs with a label indicating in which context the RHS is located in.

Constructors

GRHSsExpr
Fields grhssExprType :: GRHSExprType grhssExpr :: GRHSs GhcPs (LHsExpr GhcPs)

Instances

Instances details

CommentExtraction GRHSsExpr Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: GRHSsExpr -> NodeComments Source #

data GRHSExpr Source #

GRHS for a normal binding.

Constructors

GRHSExpr
Fields grhsExprType :: GRHSExprType grhsExpr :: GRHS GhcPs (LHsExpr GhcPs)

Instances

Instances details

CommentExtraction GRHSExpr Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: GRHSExpr -> NodeComments Source #

newtype GRHSProc Source #

GRHS for a proc binding.

Constructors

GRHSProc (GRHS GhcPs (LHsCmd GhcPs))

Instances

Instances details

CommentExtraction GRHSProc Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: GRHSProc -> NodeComments Source #

newtype RecConPat Source #

A pattern match against a record.

Constructors

RecConPat (HsRecFields GhcPs (LPat GhcPs))

Instances

Instances details

CommentExtraction RecConPat Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: RecConPat -> NodeComments Source #

newtype RecConField Source #

A record field in a pattern match.

Constructors

RecConField (HsFieldBind (LFieldOcc GhcPs) (LPat GhcPs))

Instances

Instances details

CommentExtraction RecConField Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: RecConField -> NodeComments Source #

data HsSigType' Source #

A wrapper for HsSigType.

Constructors

HsSigType'
Fields hsSigTypeFor :: HsTypeFor In which context a `HsSigType` is located in. hsSigTypeDir :: HsTypeDir How a `HsSigType` should be printed; either horizontally or vertically. hsSigType :: HsSigType GhcPs The actual signature.

Instances

Instances details

CommentExtraction HsSigType' Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: HsSigType' -> NodeComments Source #

pattern HsSigTypeInsideInstDecl :: HsSigType GhcPs -> HsSigType' Source #

HsSigType' for instance declarations.

pattern HsSigTypeInsideVerticalFuncSig :: HsSigType GhcPs -> HsSigType' Source #

HsSigType' for function declarations; printed horizontally.

pattern HsSigTypeInsideDeclSig :: HsSigType GhcPs -> HsSigType' Source #

HsSigType' for a top-level function signature.

data HsType' Source #

A wrapper for HsType.

Constructors

HsType'
Fields hsTypeFor :: HsTypeFor In which context a `HsType` is located in. hsTypeDir :: HsTypeDir How a function signature is printed; either horizontally or vertically. hsType :: HsType GhcPs The actual type.

Instances

Instances details

CommentExtraction HsType' Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: HsType' -> NodeComments Source #

pattern HsTypeInsideVerticalFuncSig :: HsType GhcPs -> HsType' Source #

HsType' inside a function signature declaration; printed horizontally.

pattern HsTypeInsideDeclSig :: HsType GhcPs -> HsType' Source #

HsType' inside a top-level function signature declaration.

pattern HsTypeInsideInstDecl :: HsType GhcPs -> HsType' Source #

HsType' inside a instance signature declaration.

pattern HsTypeWithVerticalAppTy :: HsType GhcPs -> HsType' Source #

HsType' to pretty-print a HsAppTy vertically.

data DataFamInstDecl' Source #

A wrapper of DataFamInstDecl.

Constructors

DataFamInstDecl'
Fields dataFamInstDeclFor :: DataFamInstDeclFor Where a data family instance is declared. dataFamInstDecl :: DataFamInstDecl GhcPs The actual value.

Instances

Instances details

CommentExtraction DataFamInstDecl' Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: DataFamInstDecl' -> NodeComments Source #

pattern DataFamInstDeclTopLevel :: DataFamInstDecl GhcPs -> DataFamInstDecl' Source #

DataFamInstDecl' wrapping a DataFamInstDecl representing a top-level data family instance.

pattern DataFamInstDeclInsideClassInst :: DataFamInstDecl GhcPs -> DataFamInstDecl' Source #

DataFamInstDecl' wrapping a DataFamInstDecl representing a data family instance inside a class instance.

data FamEqn' Source #

A wrapper for FamEqn.

Constructors

FamEqn'
Fields famEqnFor :: DataFamInstDeclFor Where a data family instance is declared. famEqn :: FamEqn GhcPs (HsDataDefn GhcPs)

Instances

Instances details

CommentExtraction FamEqn' Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: FamEqn' -> NodeComments Source #

pattern FamEqnTopLevel :: FamEqn GhcPs (HsDataDefn GhcPs) -> FamEqn' Source #

FamEqn' wrapping a FamEqn representing a top-level data family instance.

pattern FamEqnInsideClassInst :: FamEqn GhcPs (HsDataDefn GhcPs) -> FamEqn' Source #

FamEqn' wrapping a FamEqn representing a data family instance inside a class instance.

newtype StmtLRInsideVerticalList Source #

StmtLR inside a vertically printed list.

Constructors

StmtLRInsideVerticalList (StmtLR GhcPs GhcPs (LHsExpr GhcPs))

Instances

Instances details

CommentExtraction StmtLRInsideVerticalList Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: StmtLRInsideVerticalList -> NodeComments Source #

newtype ParStmtBlockInsideVerticalList Source #

ParStmtBlock inside a vertically printed list.

Constructors

ParStmtBlockInsideVerticalList (ParStmtBlock GhcPs GhcPs)

Instances

Instances details

CommentExtraction ParStmtBlockInsideVerticalList Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: ParStmtBlockInsideVerticalList -> NodeComments Source #

newtype DeclSig Source #

A top-level function signature.

Constructors

DeclSig (Sig GhcPs)

Instances

Instances details

CommentExtraction DeclSig Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: DeclSig -> NodeComments Source #

newtype TopLevelTyFamInstDecl Source #

A top-level type family instance declaration.

Constructors

TopLevelTyFamInstDecl (TyFamInstDecl GhcPs)

Instances

Instances details

CommentExtraction TopLevelTyFamInstDecl Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: TopLevelTyFamInstDecl -> NodeComments Source #

newtype Context Source #

A wrapper type for type class constraints; e.g., (Eq a, Ord a) of (Eq a, Ord a) => [a] -> [a]. Either HorizontalContext or VerticalContext is used internally.

Constructors

Context (LHsContext GhcPs)

Instances

Instances details

CommentExtraction Context Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: Context -> NodeComments Source #

newtype HorizontalContext Source #

A wrapper type for printing a context horizontally.

Constructors

HorizontalContext (LHsContext GhcPs)

Instances

Instances details

CommentExtraction HorizontalContext Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: HorizontalContext -> NodeComments Source #

newtype VerticalContext Source #

A wrapper type for printing a context vertically.

Constructors

VerticalContext (LHsContext GhcPs)

Instances

Instances details

CommentExtraction VerticalContext Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: VerticalContext -> NodeComments Source #

newtype ModuleNameWithPrefix Source #

A wrapper type for pretty-printing a value of ModuleName with the module prefix.

Pretty-printing it via (string "module " >> pretty (name :: ModuleName)) locates comments before name in the same line as module and the name will be in the next line. This type is to avoid the problem.

Constructors

ModuleNameWithPrefix ModuleName

Instances

Instances details

CommentExtraction ModuleNameWithPrefix Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: ModuleNameWithPrefix -> NodeComments Source #

newtype PatInsidePatDecl Source #

A wrapper for LPat inside a pattern declaration. Here, all infix patterns have extra spaces around the operators, like x : xs.

Constructors

PatInsidePatDecl (Pat GhcPs)

Instances

Instances details

CommentExtraction PatInsidePatDecl Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: PatInsidePatDecl -> NodeComments Source #

data LambdaCase Source #

Lambda case.

Constructors

LambdaCase
Fields lamCaseGroup :: MatchGroup GhcPs (LHsExpr GhcPs) caseOrCases :: CaseOrCases

Instances

Instances details

CommentExtraction LambdaCase Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: LambdaCase -> NodeComments Source #

newtype ModuleDeprecatedPragma Source #

A deprecation pragma for a module.

Constructors

ModuleDeprecatedPragma (WarningTxt GhcPs)

Instances

Instances details

CommentExtraction ModuleDeprecatedPragma Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: ModuleDeprecatedPragma -> NodeComments Source #

data ListComprehension Source #

Use this type to pretty-print a list comprehension.

Constructors

ListComprehension
Fields listCompLhs :: ExprLStmt GhcPs `f x` of `[f x\| x <- xs]`. listCompRhs :: [ExprLStmt GhcPs] `x <- xs` of `[f x\| x <- xs]`.

Instances

Instances details

CommentExtraction ListComprehension Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: ListComprehension -> NodeComments Source #

data DoExpression Source #

Use this type to pretty-print a do expression.

Constructors

DoExpression
Fields doStmts :: [ExprLStmt GhcPs] doOrMdo :: DoOrMdo

Instances

Instances details

CommentExtraction DoExpression Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: DoExpression -> NodeComments Source #

data DoOrMdo Source #

Values indicating whether `do` or mdo is used.

Constructors

Do
Mdo

data LetIn Source #

Use this type to pretty-print a let ... in ... expression.

Constructors

LetIn
Fields letBinds :: HsLocalBinds GhcPs inExpr :: LHsExpr GhcPs

Instances

Instances details

CommentExtraction LetIn Source #
Instance details Defined in HIndent.Pretty.NodeComments Methods nodeComments :: LetIn -> NodeComments Source #

data NodeComments Source #

Comments belonging to an AST node.

Constructors

NodeComments
Fields commentsBefore :: [LEpaComment] commentsOnSameLine :: [LEpaComment] commentsAfter :: [LEpaComment]

data GRHSExprType Source #

Values indicating in which context a RHS is located.

Constructors

GRHSExprNormal
GRHSExprCase
GRHSExprMultiWayIf
GRHSExprLambda

Instances

Instances details

Eq GRHSExprType Source #
Instance details Defined in HIndent.Pretty.Types Methods (==) :: GRHSExprType -> GRHSExprType -> Bool # (/=) :: GRHSExprType -> GRHSExprType -> Bool #

data GRHSProcType Source #

Values indicating in which context a RHS in a proc expression is located.

Constructors

GRHSProcCase
GRHSProcLambda

data HsTypeFor Source #

Values indicating in which context a HsType is located.

Constructors

HsTypeForNormalDecl
HsTypeForInstDecl
HsTypeForFuncSig
HsTypeForDeclSig
HsTypeForVerticalAppTy

data HsTypeDir Source #

Values indicating how a node should be printed; either horizontally or vertically.

Constructors

HsTypeNoDir
HsTypeVertical

data CaseOrCases Source #

Values indicating whether `case` or cases is used.

Constructors

Case
Cases

data DataFamInstDeclFor Source #

Values indicating where a data family instance is declared.

Constructors

DataFamInstDeclForTopLevel
DataFamInstDeclForInsideClassInst