Safe Haskell	Safe-Inferred
Language	Haskell2010

PyF.Formatters

Contents

Generic formatting function
Formatter details
Internal usage only

Description

Formatters for integral / fractional and strings.

The following is supported:

For all types:

Grouping of the integral part (i.e. adding a custom char to separate groups of digits)
Padding (left, right, around, and between the sign and the number)
Sign handling (i.e. display the positive sign or not)

For floating:

Precision
Fixed Exponential Generic formatting

For integrals:

Binary Hexadecimal Octal / Character representation

Synopsis

formatString :: forall paddingWidth precision. (Integral paddingWidth, Integral precision) => Maybe (paddingWidth, AlignMode 'AlignAll, Char) -> Maybe precision -> String -> String
formatIntegral :: Integral paddingWidth => Integral i => Format t t' 'Integral -> SignMode -> Maybe (paddingWidth, AlignMode k, Char) -> Maybe (Int, Char) -> i -> String
formatFractional :: (RealFloat f, Integral paddingWidth, Integral precision) => Format t t' 'Fractional -> SignMode -> Maybe (paddingWidth, AlignMode k, Char) -> Maybe (Int, Char) -> Maybe precision -> f -> String
data AltStatus
- = CanAlt
- | NoAlt
data UpperStatus
- = CanUpper
- | NoUpper
data FormatType
- = Fractional
- | Integral
data Format (k :: AltStatus) (k' :: UpperStatus) (k'' :: FormatType) where
- Decimal :: Format 'NoAlt 'NoUpper 'Integral
- Character :: Format 'NoAlt 'NoUpper 'Integral
- Binary :: Format 'CanAlt 'NoUpper 'Integral
- Hexa :: Format 'CanAlt 'CanUpper 'Integral
- Octal :: Format 'CanAlt 'NoUpper 'Integral
- Fixed :: Format 'CanAlt 'CanUpper 'Fractional
- Exponent :: Format 'CanAlt 'CanUpper 'Fractional
- Generic :: Format 'CanAlt 'CanUpper 'Fractional
- Percent :: Format 'CanAlt 'NoUpper 'Fractional
- Alternate :: Format 'CanAlt u f -> Format 'NoAlt u f
- Upper :: Format alt 'CanUpper f -> Format 'NoAlt 'NoUpper f
data SignMode
- = Plus
- | Minus
- | Space
data AnyAlign where
- AnyAlign :: AlignMode (k :: AlignForString) -> AnyAlign
data AlignMode (k :: AlignForString) where
- AlignLeft :: AlignMode 'AlignAll
- AlignRight :: AlignMode 'AlignAll
- AlignInside :: AlignMode 'AlignNumber
- AlignCenter :: AlignMode 'AlignAll
getAlignForString :: AlignMode k -> Maybe (AlignMode 'AlignAll)
data AlignForString
- = AlignAll
- | AlignNumber

Generic formatting function

formatString Source #

Arguments

:: forall paddingWidth precision. (Integral paddingWidth, Integral precision)
=> Maybe (paddingWidth, AlignMode 'AlignAll, Char)	Padding
-> Maybe precision	Precision (will truncate before padding)
-> String
-> String

Format a string.

formatIntegral Source #

Arguments

:: Integral paddingWidth
=> Integral i
=> Format t t' 'Integral
-> SignMode
-> Maybe (paddingWidth, AlignMode k, Char)	Padding
-> Maybe (Int, Char)	Grouping
-> i
-> String

Format an integral number.

formatFractional Source #

Arguments

:: (RealFloat f, Integral paddingWidth, Integral precision)
=> Format t t' 'Fractional
-> SignMode
-> Maybe (paddingWidth, AlignMode k, Char)	Padding
-> Maybe (Int, Char)	Grouping
-> Maybe precision	Precision
-> f
-> String

Format a fractional number.

Formatter details

data AltStatus Source #

This formatter supports an alternate version.

Constructors

CanAlt
NoAlt

data UpperStatus Source #

This formatter support an uppercase version.

Constructors

CanUpper
NoUpper

data FormatType Source #

This formatter formats an integral or a fractional.

Constructors

Fractional
Integral

data Format (k :: AltStatus) (k' :: UpperStatus) (k'' :: FormatType) where Source #

All the Formatters.

Constructors

Decimal :: Format 'NoAlt 'NoUpper 'Integral
Character :: Format 'NoAlt 'NoUpper 'Integral
Binary :: Format 'CanAlt 'NoUpper 'Integral
Hexa :: Format 'CanAlt 'CanUpper 'Integral
Octal :: Format 'CanAlt 'NoUpper 'Integral
Fixed :: Format 'CanAlt 'CanUpper 'Fractional
Exponent :: Format 'CanAlt 'CanUpper 'Fractional
Generic :: Format 'CanAlt 'CanUpper 'Fractional
Percent :: Format 'CanAlt 'NoUpper 'Fractional
Alternate :: Format 'CanAlt u f -> Format 'NoAlt u f
Upper :: Format alt 'CanUpper f -> Format 'NoAlt 'NoUpper f

Instances

Instances details

Lift (Format k k' k'' :: Type) Source #
Instance details Defined in PyF.Formatters Methods lift :: Quote m => Format k k' k'' -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Format k k' k'' -> Code m (Format k k' k'') #

data SignMode Source #

Sign handling

Constructors

Plus	Display `-` sign and `+` sign
Minus	Only display `-` sign
Space	Display `-` sign and a space for positive numbers

Instances

Instances details

Data SignMode Source #
Instance details Defined in PyF.Formatters Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SignMode -> c SignMode # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SignMode # toConstr :: SignMode -> Constr # dataTypeOf :: SignMode -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SignMode) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SignMode) # gmapT :: (forall b. Data b => b -> b) -> SignMode -> SignMode # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SignMode -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SignMode -> r # gmapQ :: (forall d. Data d => d -> u) -> SignMode -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SignMode -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SignMode -> m SignMode # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SignMode -> m SignMode # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SignMode -> m SignMode #
Show SignMode Source #
Instance details Defined in PyF.Formatters Methods showsPrec :: Int -> SignMode -> ShowS # show :: SignMode -> String # showList :: [SignMode] -> ShowS #
Lift SignMode Source #
Instance details Defined in PyF.Formatters Methods lift :: Quote m => SignMode -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => SignMode -> Code m SignMode #

data AnyAlign where Source #

Existential version of AlignMode

Constructors

AnyAlign :: AlignMode (k :: AlignForString) -> AnyAlign

Instances

Instances details

Show AnyAlign Source #
Instance details Defined in PyF.Formatters Methods showsPrec :: Int -> AnyAlign -> ShowS # show :: AnyAlign -> String # showList :: [AnyAlign] -> ShowS #
Lift AnyAlign Source #
Instance details Defined in PyF.Formatters Methods lift :: Quote m => AnyAlign -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => AnyAlign -> Code m AnyAlign #

Internal usage only

data AlignMode (k :: AlignForString) where Source #

Alignement

Constructors

AlignLeft :: AlignMode 'AlignAll	Left padding
AlignRight :: AlignMode 'AlignAll	Right padding
AlignInside :: AlignMode 'AlignNumber	Padding will be added between the sign and the number
AlignCenter :: AlignMode 'AlignAll	Padding will be added around the value

Instances

Instances details

Lift (AlignMode k :: Type) Source #
Instance details Defined in PyF.Formatters Methods lift :: Quote m => AlignMode k -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => AlignMode k -> Code m (AlignMode k) #
Show (AlignMode k) Source #
Instance details Defined in PyF.Formatters Methods showsPrec :: Int -> AlignMode k -> ShowS # show :: AlignMode k -> String # showList :: [AlignMode k] -> ShowS #

getAlignForString :: AlignMode k -> Maybe (AlignMode 'AlignAll) Source #

data AlignForString Source #

Constructors

AlignAll
AlignNumber

Instances

Instances details

Show AlignForString Source #
Instance details Defined in PyF.Formatters Methods showsPrec :: Int -> AlignForString -> ShowS # show :: AlignForString -> String # showList :: [AlignForString] -> ShowS #