Safe Haskell	None
Language	Haskell98

Floskell.Types

Description

All types.

Synopsis

data OutputRestriction
- = Anything
- | NoOverflow
- | NoOverflowOrLinebreak
data TypeLayout
- = TypeFree
- | TypeFlex
- | TypeVertical
newtype Penalty = Penalty Int
newtype TabStop = TabStop String
newtype Printer a = Printer {
- unPrinter :: StateT PrintState (Search Penalty) a
}
execPrinter :: Printer a -> PrintState -> Maybe (Penalty, PrintState)
runPrinter :: Printer a -> PrintState -> Maybe (Penalty, (a, PrintState))
data PrintState = PrintState {
- psBuffer :: !Buffer
- psIndentLevel :: !Int
- psOnside :: !Int
- psTabStops :: !(Map TabStop Int)
- psConfig :: !Config
- psEolComment :: !Bool
- psOutputRestriction :: !OutputRestriction
- psTypeLayout :: !TypeLayout
}
psLine :: PrintState -> Int
psColumn :: PrintState -> Int
psNewline :: PrintState -> Bool
initialPrintState :: Config -> PrintState
data Config = Config {
- cfgPenalty :: !PenaltyConfig
- cfgAlign :: !AlignConfig
- cfgIndent :: !IndentConfig
- cfgLayout :: !LayoutConfig
- cfgOp :: !OpConfig
- cfgGroup :: !GroupConfig
- cfgOptions :: !OptionConfig
}
data SrcSpan = SrcSpan {
- srcSpanFilename :: String
- srcSpanStartLine :: Int
- srcSpanStartColumn :: Int
- srcSpanEndLine :: Int
- srcSpanEndColumn :: Int
}
data CommentType
- = InlineComment
- | LineComment
- | PreprocessorDirective
data Comment = Comment {
- commentType :: !CommentType
- commentSpan :: !SrcSpan
- commentText :: !String
}
data NodeInfo = NodeInfo {
- nodeInfoSpan :: !SrcSpan
- nodeInfoLeadingComments :: ![Comment]
- nodeInfoTrailingComments :: ![Comment]
}
noNodeInfo :: NodeInfo
nodeSpan :: Annotated ast => ast NodeInfo -> SrcSpan
data Location
- = Before
- | After

Documentation

data OutputRestriction Source #

Constructors

Anything
NoOverflow
NoOverflowOrLinebreak

Instances

Eq OutputRestriction Source #
Instance details Defined in Floskell.Types Methods (==) :: OutputRestriction -> OutputRestriction -> Bool # (/=) :: OutputRestriction -> OutputRestriction -> Bool #
Ord OutputRestriction Source #
Instance details Defined in Floskell.Types Methods compare :: OutputRestriction -> OutputRestriction -> Ordering # (<) :: OutputRestriction -> OutputRestriction -> Bool # (<=) :: OutputRestriction -> OutputRestriction -> Bool # (>) :: OutputRestriction -> OutputRestriction -> Bool # (>=) :: OutputRestriction -> OutputRestriction -> Bool # max :: OutputRestriction -> OutputRestriction -> OutputRestriction # min :: OutputRestriction -> OutputRestriction -> OutputRestriction #
Show OutputRestriction Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> OutputRestriction -> ShowS # show :: OutputRestriction -> String # showList :: [OutputRestriction] -> ShowS #

data TypeLayout Source #

Constructors

TypeFree
TypeFlex
TypeVertical

Instances

Eq TypeLayout Source #
Instance details Defined in Floskell.Types Methods (==) :: TypeLayout -> TypeLayout -> Bool # (/=) :: TypeLayout -> TypeLayout -> Bool #
Ord TypeLayout Source #
Instance details Defined in Floskell.Types Methods compare :: TypeLayout -> TypeLayout -> Ordering # (<) :: TypeLayout -> TypeLayout -> Bool # (<=) :: TypeLayout -> TypeLayout -> Bool # (>) :: TypeLayout -> TypeLayout -> Bool # (>=) :: TypeLayout -> TypeLayout -> Bool # max :: TypeLayout -> TypeLayout -> TypeLayout # min :: TypeLayout -> TypeLayout -> TypeLayout #
Show TypeLayout Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> TypeLayout -> ShowS # show :: TypeLayout -> String # showList :: [TypeLayout] -> ShowS #

newtype Penalty Source #

Constructors

Penalty Int

Instances

Eq Penalty Source #
Instance details Defined in Floskell.Types Methods (==) :: Penalty -> Penalty -> Bool # (/=) :: Penalty -> Penalty -> Bool #
Num Penalty Source #
Instance details Defined in Floskell.Types Methods (+) :: Penalty -> Penalty -> Penalty # (-) :: Penalty -> Penalty -> Penalty # (*) :: Penalty -> Penalty -> Penalty # negate :: Penalty -> Penalty # abs :: Penalty -> Penalty # signum :: Penalty -> Penalty # fromInteger :: Integer -> Penalty #
Ord Penalty Source #
Instance details Defined in Floskell.Types Methods compare :: Penalty -> Penalty -> Ordering # (<) :: Penalty -> Penalty -> Bool # (<=) :: Penalty -> Penalty -> Bool # (>) :: Penalty -> Penalty -> Bool # (>=) :: Penalty -> Penalty -> Bool # max :: Penalty -> Penalty -> Penalty # min :: Penalty -> Penalty -> Penalty #
Show Penalty Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> Penalty -> ShowS # show :: Penalty -> String # showList :: [Penalty] -> ShowS #
Semigroup Penalty Source #
Instance details Defined in Floskell.Types Methods (<>) :: Penalty -> Penalty -> Penalty # sconcat :: NonEmpty Penalty -> Penalty # stimes :: Integral b => b -> Penalty -> Penalty #
Monoid Penalty Source #
Instance details Defined in Floskell.Types Methods mempty :: Penalty # mappend :: Penalty -> Penalty -> Penalty # mconcat :: [Penalty] -> Penalty #
MonadSearch Penalty Printer Source #
Instance details Defined in Floskell.Types Methods cost :: Penalty -> Penalty -> Printer () # junction :: Printer a -> Printer a -> Printer a # abandon :: Printer a # seal :: Printer a -> Printer a # collapse :: Printer () #

newtype TabStop Source #

Constructors

TabStop String

Instances

Eq TabStop Source #
Instance details Defined in Floskell.Types Methods (==) :: TabStop -> TabStop -> Bool # (/=) :: TabStop -> TabStop -> Bool #
Ord TabStop Source #
Instance details Defined in Floskell.Types Methods compare :: TabStop -> TabStop -> Ordering # (<) :: TabStop -> TabStop -> Bool # (<=) :: TabStop -> TabStop -> Bool # (>) :: TabStop -> TabStop -> Bool # (>=) :: TabStop -> TabStop -> Bool # max :: TabStop -> TabStop -> TabStop # min :: TabStop -> TabStop -> TabStop #
Show TabStop Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> TabStop -> ShowS # show :: TabStop -> String # showList :: [TabStop] -> ShowS #

newtype Printer a Source #

A pretty printing monad.

Constructors

Printer
Fields unPrinter :: StateT PrintState (Search Penalty) a

Instances

Monad Printer Source #
Instance details Defined in Floskell.Types Methods (>>=) :: Printer a -> (a -> Printer b) -> Printer b # (>>) :: Printer a -> Printer b -> Printer b # return :: a -> Printer a # fail :: String -> Printer a #
Functor Printer Source #
Instance details Defined in Floskell.Types Methods fmap :: (a -> b) -> Printer a -> Printer b # (<$) :: a -> Printer b -> Printer a #
Applicative Printer Source #
Instance details Defined in Floskell.Types Methods pure :: a -> Printer a # (<>) :: Printer (a -> b) -> Printer a -> Printer b # liftA2 :: (a -> b -> c) -> Printer a -> Printer b -> Printer c # (>) :: Printer a -> Printer b -> Printer b # (<*) :: Printer a -> Printer b -> Printer a #
Alternative Printer Source #
Instance details Defined in Floskell.Types Methods empty :: Printer a # (<\|>) :: Printer a -> Printer a -> Printer a # some :: Printer a -> Printer [a] # many :: Printer a -> Printer [a] #
MonadPlus Printer Source #
Instance details Defined in Floskell.Types Methods mzero :: Printer a # mplus :: Printer a -> Printer a -> Printer a #
MonadSearch Penalty Printer Source #
Instance details Defined in Floskell.Types Methods cost :: Penalty -> Penalty -> Printer () # junction :: Printer a -> Printer a -> Printer a # abandon :: Printer a # seal :: Printer a -> Printer a # collapse :: Printer () #
MonadState PrintState Printer Source #
Instance details Defined in Floskell.Types Methods get :: Printer PrintState # put :: PrintState -> Printer () # state :: (PrintState -> (a, PrintState)) -> Printer a #

execPrinter :: Printer a -> PrintState -> Maybe (Penalty, PrintState) Source #

runPrinter :: Printer a -> PrintState -> Maybe (Penalty, (a, PrintState)) Source #

data PrintState Source #

The state of the pretty printer.

Constructors

PrintState
Fields psBuffer :: !Buffer Output buffer psIndentLevel :: !Int Current indentation level. psOnside :: !Int Extra indentation is necessary with next line break. psTabStops :: !(Map TabStop Int) Tab stops for alignment. psConfig :: !Config Style definition. psEolComment :: !Bool An end of line comment has just been outputted. psOutputRestriction :: !OutputRestriction psTypeLayout :: !TypeLayout

Instances

MonadState PrintState Printer Source #
Instance details Defined in Floskell.Types Methods get :: Printer PrintState # put :: PrintState -> Printer () # state :: (PrintState -> (a, PrintState)) -> Printer a #

psLine :: PrintState -> Int Source #

psColumn :: PrintState -> Int Source #

psNewline :: PrintState -> Bool Source #

initialPrintState :: Config -> PrintState Source #

data Config Source #

Constructors

Config
Fields cfgPenalty :: !PenaltyConfig cfgAlign :: !AlignConfig cfgIndent :: !IndentConfig cfgLayout :: !LayoutConfig cfgOp :: !OpConfig cfgGroup :: !GroupConfig cfgOptions :: !OptionConfig

Instances

Generic Config Source #
Instance details Defined in Floskell.Config Associated Types type Rep Config :: Type -> Type # Methods from :: Config -> Rep Config x # to :: Rep Config x -> Config #
ToJSON Config Source #
Instance details Defined in Floskell.Config Methods toJSON :: Config -> Value # toEncoding :: Config -> Encoding # toJSONList :: [Config] -> Value # toEncodingList :: [Config] -> Encoding #
FromJSON Config Source #
Instance details Defined in Floskell.Config Methods parseJSON :: Value -> Parser Config # parseJSONList :: Value -> Parser [Config] #
Default Config Source #
Instance details Defined in Floskell.Config Methods def :: Config #
type Rep Config Source #
Instance details Defined in Floskell.Config type Rep Config = D1 (MetaData "Config" "Floskell.Config" "floskell-0.10.2-1uzebgOQCtQ7azD3koQ0G1" False) (C1 (MetaCons "Config" PrefixI True) ((S1 (MetaSel (Just "cfgPenalty") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PenaltyConfig) :: (S1 (MetaSel (Just "cfgAlign") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AlignConfig) :: S1 (MetaSel (Just "cfgIndent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 IndentConfig))) :: ((S1 (MetaSel (Just "cfgLayout") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LayoutConfig) :: S1 (MetaSel (Just "cfgOp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OpConfig)) :: (S1 (MetaSel (Just "cfgGroup") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GroupConfig) :: S1 (MetaSel (Just "cfgOptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 OptionConfig)))))

data SrcSpan #

A portion of the source, spanning one or more lines and zero or more columns.

Constructors

SrcSpan
Fields srcSpanFilename :: String srcSpanStartLine :: Int srcSpanStartColumn :: Int srcSpanEndLine :: Int srcSpanEndColumn :: Int

Instances

Eq SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc Methods (==) :: SrcSpan -> SrcSpan -> Bool # (/=) :: SrcSpan -> SrcSpan -> Bool #
Data SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SrcSpan -> c SrcSpan # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SrcSpan # toConstr :: SrcSpan -> Constr # dataTypeOf :: SrcSpan -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SrcSpan) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SrcSpan) # gmapT :: (forall b. Data b => b -> b) -> SrcSpan -> SrcSpan # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SrcSpan -> r # gmapQ :: (forall d. Data d => d -> u) -> SrcSpan -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SrcSpan -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SrcSpan -> m SrcSpan #
Ord SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc Methods compare :: SrcSpan -> SrcSpan -> Ordering # (<) :: SrcSpan -> SrcSpan -> Bool # (<=) :: SrcSpan -> SrcSpan -> Bool # (>) :: SrcSpan -> SrcSpan -> Bool # (>=) :: SrcSpan -> SrcSpan -> Bool # max :: SrcSpan -> SrcSpan -> SrcSpan # min :: SrcSpan -> SrcSpan -> SrcSpan #
Show SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc Methods showsPrec :: Int -> SrcSpan -> ShowS # show :: SrcSpan -> String # showList :: [SrcSpan] -> ShowS #
Generic SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc Associated Types type Rep SrcSpan :: Type -> Type # Methods from :: SrcSpan -> Rep SrcSpan x # to :: Rep SrcSpan x -> SrcSpan #
Pretty SrcSpan
Instance details Defined in Language.Haskell.Exts.Pretty Methods pretty :: SrcSpan -> Doc prettyPrec :: Int -> SrcSpan -> Doc
SrcInfo SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc Methods toSrcInfo :: SrcLoc -> [SrcSpan] -> SrcLoc -> SrcSpan # fromSrcInfo :: SrcSpanInfo -> SrcSpan # getPointLoc :: SrcSpan -> SrcLoc # fileName :: SrcSpan -> String # startLine :: SrcSpan -> Int # startColumn :: SrcSpan -> Int #
type Rep SrcSpan
Instance details Defined in Language.Haskell.Exts.SrcLoc type Rep SrcSpan = D1 (MetaData "SrcSpan" "Language.Haskell.Exts.SrcLoc" "haskell-src-exts-1.22.0-5tSwDhjCyZb5AQf9d2FsEo" False) (C1 (MetaCons "SrcSpan" PrefixI True) ((S1 (MetaSel (Just "srcSpanFilename") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: S1 (MetaSel (Just "srcSpanStartLine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :: (S1 (MetaSel (Just "srcSpanStartColumn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: (S1 (MetaSel (Just "srcSpanEndLine") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "srcSpanEndColumn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))))

data CommentType Source #

Constructors

InlineComment
LineComment
PreprocessorDirective

Instances

Show CommentType Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> CommentType -> ShowS # show :: CommentType -> String # showList :: [CommentType] -> ShowS #

data Comment Source #

Constructors

Comment
Fields commentType :: !CommentType commentSpan :: !SrcSpan commentText :: !String

Instances

Show Comment Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> Comment -> ShowS # show :: Comment -> String # showList :: [Comment] -> ShowS #

data NodeInfo Source #

Information for each node in the AST.

Constructors

NodeInfo
Fields nodeInfoSpan :: !SrcSpan Location info from the parser. nodeInfoLeadingComments :: ![Comment] Leading comments attached to this node. nodeInfoTrailingComments :: ![Comment] Trailing comments attached to this node.

Instances

Show NodeInfo Source #
Instance details Defined in Floskell.Types Methods showsPrec :: Int -> NodeInfo -> ShowS # show :: NodeInfo -> String # showList :: [NodeInfo] -> ShowS #

noNodeInfo :: NodeInfo Source #

Empty NodeInfo

nodeSpan :: Annotated ast => ast NodeInfo -> SrcSpan Source #

data Location Source #

Constructors

Before
After

Instances

Bounded Location Source #
Instance details Defined in Floskell.Config Methods minBound :: Location # maxBound :: Location #
Enum Location Source #
Instance details Defined in Floskell.Config Methods succ :: Location -> Location # pred :: Location -> Location # toEnum :: Int -> Location # fromEnum :: Location -> Int # enumFrom :: Location -> [Location] # enumFromThen :: Location -> Location -> [Location] # enumFromTo :: Location -> Location -> [Location] # enumFromThenTo :: Location -> Location -> Location -> [Location] #
Eq Location Source #
Instance details Defined in Floskell.Config Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Ord Location Source #
Instance details Defined in Floskell.Config Methods compare :: Location -> Location -> Ordering # (<) :: Location -> Location -> Bool # (<=) :: Location -> Location -> Bool # (>) :: Location -> Location -> Bool # (>=) :: Location -> Location -> Bool # max :: Location -> Location -> Location # min :: Location -> Location -> Location #
Show Location Source #
Instance details Defined in Floskell.Config Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #
Generic Location Source #
Instance details Defined in Floskell.Config Associated Types type Rep Location :: Type -> Type # Methods from :: Location -> Rep Location x # to :: Rep Location x -> Location #
type Rep Location Source #
Instance details Defined in Floskell.Config type Rep Location = D1 (MetaData "Location" "Floskell.Config" "floskell-0.10.2-1uzebgOQCtQ7azD3koQ0G1" False) (C1 (MetaCons "Before" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "After" PrefixI False) (U1 :: Type -> Type))