Floskell.Types

All types.

Documentation

data OutputRestriction

Constructors

Anything

NoOverflow

NoOverflowOrLinebreak

Instances

Eq OutputRestriction

Defined in Floskell.Types

Methods

(==) :: OutputRestriction -> OutputRestriction -> Bool

(/=) :: OutputRestriction -> OutputRestriction -> Bool

Ord OutputRestriction

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

Defined in Floskell.Types

Methods

showsPrec :: Int -> OutputRestriction -> ShowS

show :: OutputRestriction -> String

showList :: [OutputRestriction] -> ShowS

data TypeLayout

Constructors

TypeFree

TypeFlex

TypeVertical

Instances

Eq TypeLayout

Defined in Floskell.Types

Methods

(==) :: TypeLayout -> TypeLayout -> Bool

(/=) :: TypeLayout -> TypeLayout -> Bool

Ord TypeLayout

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

Defined in Floskell.Types

Methods

showsPrec :: Int -> TypeLayout -> ShowS

show :: TypeLayout -> String

showList :: [TypeLayout] -> ShowS

newtype Penalty

Constructors

Penalty Int

Instances

Eq Penalty

Defined in Floskell.Types

Methods

(==) :: Penalty -> Penalty -> Bool

(/=) :: Penalty -> Penalty -> Bool

Num Penalty

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

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

Defined in Floskell.Types

Methods

showsPrec :: Int -> Penalty -> ShowS

show :: Penalty -> String

showList :: [Penalty] -> ShowS

Semigroup Penalty

Defined in Floskell.Types

Methods

(<>) :: Penalty -> Penalty -> Penalty

sconcat :: NonEmpty Penalty -> Penalty

stimes :: Integral b => b -> Penalty -> Penalty

Monoid Penalty

Defined in Floskell.Types

Methods

mempty :: Penalty

mappend :: Penalty -> Penalty -> Penalty

mconcat :: [Penalty] -> Penalty

MonadSearch Penalty Printer

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

Constructors

TabStop String

Instances

Eq TabStop

Defined in Floskell.Types

Methods

(==) :: TabStop -> TabStop -> Bool

(/=) :: TabStop -> TabStop -> Bool

Ord TabStop

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

Defined in Floskell.Types

Methods

showsPrec :: Int -> TabStop -> ShowS

show :: TabStop -> String

showList :: [TabStop] -> ShowS

newtype Printer a

A pretty printing monad.

Constructors

Printer

Fields

• unPrinter :: StateT PrintState (Search Penalty) a

Instances

Monad Printer

Defined in Floskell.Types

Methods

(>>=) :: Printer a -> (a -> Printer b) -> Printer b

(>>) :: Printer a -> Printer b -> Printer b

return :: a -> Printer a

Functor Printer

Defined in Floskell.Types

Methods

fmap :: (a -> b) -> Printer a -> Printer b

(<$) :: a -> Printer b -> Printer a

Applicative Printer

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

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

Defined in Floskell.Types

Methods

mzero :: Printer a

mplus :: Printer a -> Printer a -> Printer a

MonadSearch Penalty Printer

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

Defined in Floskell.Types

Methods

get :: Printer PrintState

put :: PrintState -> Printer ()

state :: (PrintState -> (a, PrintState)) -> Printer a

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

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

data PrintState

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

Defined in Floskell.Types

Methods

get :: Printer PrintState

put :: PrintState -> Printer ()

state :: (PrintState -> (a, PrintState)) -> Printer a

psLine :: PrintState -> Int

psColumn :: PrintState -> Int

psNewline :: PrintState -> Bool

initialPrintState :: Config -> PrintState

data Config

Constructors

Config

Fields

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

Instances

Generic Config

Defined in Floskell.Config

Associated Types

type Rep Config :: Type -> Type

Methods

from :: Config -> Rep Config x

to :: Rep Config x -> Config

ToJSON Config

Defined in Floskell.Config

Methods

toJSON :: Config -> Value

toEncoding :: Config -> Encoding

toJSONList :: [Config] -> Value

toEncodingList :: [Config] -> Encoding

FromJSON Config

Defined in Floskell.Config

Methods

parseJSON :: Value -> Parser Config

parseJSONList :: Value -> Parser [Config]

Default Config

Defined in Floskell.Config

Methods

def :: Config

type Rep Config

Defined in Floskell.Config

type Rep Config = D1 ('MetaData "Config" "Floskell.Config" "floskell-0.10.6-82g7u7k8RyIBgbNp7FyVnZ" '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

Defined in Language.Haskell.Exts.SrcLoc

Methods

(==) :: SrcSpan -> SrcSpan -> Bool

(/=) :: SrcSpan -> SrcSpan -> Bool

Data SrcSpan

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 :: forall r r'. (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

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

Defined in Language.Haskell.Exts.SrcLoc

Methods

showsPrec :: Int -> SrcSpan -> ShowS

show :: SrcSpan -> String

showList :: [SrcSpan] -> ShowS

Generic SrcSpan

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

Defined in Language.Haskell.Exts.Pretty

Methods

pretty :: SrcSpan -> Doc

prettyPrec :: Int -> SrcSpan -> Doc

SrcInfo SrcSpan

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

Defined in Language.Haskell.Exts.SrcLoc

type Rep SrcSpan = D1 ('MetaData "SrcSpan" "Language.Haskell.Exts.SrcLoc" "haskell-src-exts-1.23.1-GVIftkv0WzlF1sdfsy5X6R" '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

Constructors

InlineComment

LineComment

PreprocessorDirective

Instances

Show CommentType

Defined in Floskell.Types

Methods

showsPrec :: Int -> CommentType -> ShowS

show :: CommentType -> String

showList :: [CommentType] -> ShowS

data Comment

Constructors

Comment

Fields

• commentType :: !CommentType
• commentSpan :: !SrcSpan
• commentText :: !String

Instances

Show Comment

Defined in Floskell.Types

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

data NodeInfo

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

Defined in Floskell.Types

Methods

showsPrec :: Int -> NodeInfo -> ShowS

show :: NodeInfo -> String

showList :: [NodeInfo] -> ShowS

noNodeInfo :: NodeInfo

Empty NodeInfo

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

data Location

Constructors

Before

After

Instances

Bounded Location

Defined in Floskell.Config

Methods

minBound :: Location

maxBound :: Location

Enum Location

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

Defined in Floskell.Config

Methods

(==) :: Location -> Location -> Bool

(/=) :: Location -> Location -> Bool

Ord Location

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

Defined in Floskell.Config

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Generic Location

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

Defined in Floskell.Config

type Rep Location = D1 ('MetaData "Location" "Floskell.Config" "floskell-0.10.6-82g7u7k8RyIBgbNp7FyVnZ" 'False) (C1 ('MetaCons "Before" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "After" 'PrefixI 'False) (U1 :: Type -> Type))