Copyright	(c) Galois Inc 2015-2016
License	BSD3
Maintainer	Rob Dockins <rdockins@galois.com>
Stability	provisional
Safe Haskell	Safe-Inferred
Language	Haskell2010

Lang.Crucible.LLVM.Printf

Description

A model of C's printf function. This does not entirely conform to the C standard's specification of printf; see doc/limitations.md for the specifics.

Synopsis

data PrintfFlag
data PrintfLengthModifier
- = Len_Byte
- | Len_Short
- | Len_Long
- | Len_LongLong
- | Len_LongDouble
- | Len_IntMax
- | Len_PtrDiff
- | Len_Sizet
- | Len_NoMod
data Case
- = UpperCase
- | LowerCase
data IntFormat
data FloatFormat
data PrintfConversionType
data PrintfDirective
- = StringDirective ByteString
- | ConversionDirective ConversionDirective
parseDirectives :: [Word8] -> Either String [PrintfDirective]
data ConversionDirective = Conversion {
- printfAccessField :: Maybe Int
- printfFlags :: Set PrintfFlag
- printfMinWidth :: Int
- printfPrecision :: Maybe Int
- printfLengthMod :: PrintfLengthModifier
- printfType :: PrintfConversionType
}
data PrintfOperations m = PrintfOperations {
- printfGetInteger :: Int -> Bool -> PrintfLengthModifier -> m (Maybe Integer)
- printfGetFloat :: Int -> PrintfLengthModifier -> m (Maybe Rational)
- printfGetPointer :: Int -> m String
- printfGetString :: Int -> Maybe Int -> m [Word8]
- printfSetInteger :: Int -> PrintfLengthModifier -> Int -> m ()
- printfUnsupported :: !(forall a. HasCallStack => String -> m a)
}
executeDirectives :: forall m. Monad m => PrintfOperations m -> [PrintfDirective] -> m (ByteString, Int)
formatInteger :: Maybe Integer -> IntFormat -> Int -> Maybe Int -> Set PrintfFlag -> String
formatRational :: Maybe Rational -> FloatFormat -> Int -> Maybe Int -> Set PrintfFlag -> Either String String

Documentation

data PrintfFlag Source #

Constructors

PrintfAlternateForm
PrintfZeroPadding
PrintfNegativeWidth
PrintfPosSpace
PrintfPosPlus
PrintfThousandsSep

Instances

Instances details

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

data PrintfLengthModifier Source #

Constructors

Len_Byte
Len_Short
Len_Long
Len_LongLong
Len_LongDouble
Len_IntMax
Len_PtrDiff
Len_Sizet
Len_NoMod

Instances

Instances details

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

data Case Source #

Constructors

UpperCase
LowerCase

Instances

Instances details

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

data IntFormat Source #

Constructors

IntFormat_SignedDecimal
IntFormat_UnsignedDecimal
IntFormat_Octal
IntFormat_Hex Case

Instances

Instances details

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

data FloatFormat Source #

Constructors

FloatFormat_Scientific Case
FloatFormat_Standard Case
FloatFormat_Auto Case
FloatFormat_Hex Case

Instances

Instances details

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

data PrintfConversionType Source #

Constructors

Conversion_Integer IntFormat
Conversion_Floating FloatFormat
Conversion_Char
Conversion_String
Conversion_Pointer
Conversion_CountChars

Instances

Instances details

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

data PrintfDirective Source #

Constructors

StringDirective ByteString
ConversionDirective ConversionDirective

Instances

Instances details

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

parseDirectives :: [Word8] -> Either String [PrintfDirective] Source #

data ConversionDirective Source #

Constructors

Conversion
Fields printfAccessField :: Maybe Int printfFlags :: Set PrintfFlag printfMinWidth :: Int printfPrecision :: Maybe Int printfLengthMod :: PrintfLengthModifier printfType :: PrintfConversionType

Instances

Instances details

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

data PrintfOperations m Source #

Constructors

PrintfOperations
Fields printfGetInteger :: Int -> Bool -> PrintfLengthModifier -> m (Maybe Integer) printfGetFloat :: Int -> PrintfLengthModifier -> m (Maybe Rational) printfGetPointer :: Int -> m String printfGetString :: Int -> Maybe Int -> m [Word8] printfSetInteger :: Int -> PrintfLengthModifier -> Int -> m () printfUnsupported :: !(forall a. HasCallStack => String -> m a)

executeDirectives :: forall m. Monad m => PrintfOperations m -> [PrintfDirective] -> m (ByteString, Int) Source #

Given a list of PrintfDirectives, compute the resulting ByteString and its length.

We make an effort not to assume a particular text encoding for the ByteString that this returns. Some parts of the implementation do use functionality from Data.ByteString.Char8, which is limited to the subset of Unicode covered by code points 0-255. We believe these uses are justified, however, and we have left comments explaining the reasoning behind each use.

formatInteger :: Maybe Integer -> IntFormat -> Int -> Maybe Int -> Set PrintfFlag -> String Source #

formatRational Source #

Arguments

:: Maybe Rational
-> FloatFormat
-> Int
-> Maybe Int
-> Set PrintfFlag
-> Either String String	Left indicates an error, right is OK