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

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

fail :: String -> 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 :: !Int64

  Current indentation level.

• psOnside :: !Int64

  Extra indentation is necessary with next line break.

• psTabStops :: !(Map TabStop Int64)

  Tab stops for alignment.

• psUserState :: !FlexConfig

  User state.

• psEolComment :: !Bool

  An end of line comment has just been outputted.

• psOutputRestriction :: OutputRestriction

Instances

MonadState PrintState Printer

Defined in Floskell.Types

Methods

get :: Printer PrintState

put :: PrintState -> Printer ()

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

psLine :: PrintState -> Int64

psColumn :: PrintState -> Int64

psNewline :: PrintState -> Bool

data Style

A printer style.

Constructors

Style

Fields

• styleName :: !Text

  Name of the style, used in the commandline interface.

• styleAuthor :: !Text

  Author of the printer (as opposed to the author of the style).

• styleDescription :: !Text

  Description of the style.

• styleInitialState :: !FlexConfig

  User state, if needed.

data FlexConfig

Constructors

FlexConfig

Fields

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

Instances

Generic FlexConfig

Defined in Floskell.Config

Associated Types

type Rep FlexConfig :: Type -> Type

Methods

from :: FlexConfig -> Rep FlexConfig x

to :: Rep FlexConfig x -> FlexConfig

ToJSON FlexConfig

Defined in Floskell.Config

Methods

toJSON :: FlexConfig -> Value

toEncoding :: FlexConfig -> Encoding

toJSONList :: [FlexConfig] -> Value

toEncodingList :: [FlexConfig] -> Encoding

FromJSON FlexConfig

Defined in Floskell.Config

Methods

parseJSON :: Value -> Parser FlexConfig

parseJSONList :: Value -> Parser [FlexConfig]

Default FlexConfig

Defined in Floskell.Config

Methods

def :: FlexConfig

type Rep FlexConfig

Defined in Floskell.Config

type Rep FlexConfig = D1 (MetaData "FlexConfig" "Floskell.Config" "floskell-0.9.0-inplace" False) (C1 (MetaCons "FlexConfig" 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 NodeInfo

Information for each node in the AST.

Constructors

NodeInfo

Fields

• nodeInfoSpan :: !SrcSpanInfo

  Location info from the parser.

• nodeInfoComments :: ![ComInfo]

  Comments which are attached to this node.

Instances

Show NodeInfo

Defined in Floskell.Types

Methods

showsPrec :: Int -> NodeInfo -> ShowS

show :: NodeInfo -> String

showList :: [NodeInfo] -> ShowS

data ComInfo

Comment with some more info.

Constructors

ComInfo

Fields

• comInfoComment :: !Comment

  The normal comment type.

• comInfoLocation :: !(Maybe Location)

  Where the comment lies relative to the node.

Instances

Show ComInfo

Defined in Floskell.Types

Methods

showsPrec :: Int -> ComInfo -> ShowS

show :: ComInfo -> String

showList :: [ComInfo] -> ShowS

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.9.0-inplace" False) (C1 (MetaCons "Before" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "After" PrefixI False) (U1 :: Type -> Type))