What4.ProgramLoc

This module primarily defines the Position datatype for handling program location data. A program location may refer either to a source file location (file name, line and column number), a binary file location (file name and byte offset) or be a dummy "internal" location assigned to generated program fragments.

Documentation

data Position

Constructors

SourcePos !Text !Int !Int

A source position containing filename, line, and column.

BinaryPos !Text !Word64

A binary position containing a filename and address in memory.

OtherPos !Text

Some unstructured position information that doesn't fit into the other categories.

InternalPos

Generated internally by the simulator, or otherwise unknown.

Instances

Eq Position

Defined in What4.ProgramLoc

Methods

(==) :: Position -> Position -> Bool

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

Ord Position

Defined in What4.ProgramLoc

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Show Position

Defined in What4.ProgramLoc

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Pretty Position

Defined in What4.ProgramLoc

Methods

pretty :: Position -> Doc

prettyList :: [Position] -> Doc

NFData Position

Defined in What4.ProgramLoc

Methods

rnf :: Position -> ()

sourcePos :: FilePath -> Int -> Int -> Position

startOfFile :: FilePath -> Position

ppNoFileName :: Position -> Doc

data Posd v

A value with a source position associated.

Constructors

Posd

Fields

• pos :: !Position
• pos_val :: !v

Instances

Functor Posd

Defined in What4.ProgramLoc

Methods

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

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

Foldable Posd

Defined in What4.ProgramLoc

Methods

fold :: Monoid m => Posd m -> m

foldMap :: Monoid m => (a -> m) -> Posd a -> m

foldr :: (a -> b -> b) -> b -> Posd a -> b

foldr' :: (a -> b -> b) -> b -> Posd a -> b

foldl :: (b -> a -> b) -> b -> Posd a -> b

foldl' :: (b -> a -> b) -> b -> Posd a -> b

foldr1 :: (a -> a -> a) -> Posd a -> a

foldl1 :: (a -> a -> a) -> Posd a -> a

toList :: Posd a -> [a]

null :: Posd a -> Bool

length :: Posd a -> Int

elem :: Eq a => a -> Posd a -> Bool

maximum :: Ord a => Posd a -> a

minimum :: Ord a => Posd a -> a

sum :: Num a => Posd a -> a

product :: Num a => Posd a -> a

Traversable Posd

Defined in What4.ProgramLoc

Methods

traverse :: Applicative f => (a -> f b) -> Posd a -> f (Posd b)

sequenceA :: Applicative f => Posd (f a) -> f (Posd a)

mapM :: Monad m => (a -> m b) -> Posd a -> m (Posd b)

sequence :: Monad m => Posd (m a) -> m (Posd a)

Eq v => Eq (Posd v)

Defined in What4.ProgramLoc

Methods

(==) :: Posd v -> Posd v -> Bool

(/=) :: Posd v -> Posd v -> Bool

Show v => Show (Posd v)

Defined in What4.ProgramLoc

Methods

showsPrec :: Int -> Posd v -> ShowS

show :: Posd v -> String

showList :: [Posd v] -> ShowS

NFData v => NFData (Posd v)

Defined in What4.ProgramLoc

Methods

rnf :: Posd v -> ()

data ProgramLoc

A very small type that contains a function and PC identifier.

Instances

Eq ProgramLoc

Defined in What4.ProgramLoc

Methods

(==) :: ProgramLoc -> ProgramLoc -> Bool

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

Ord ProgramLoc

Defined in What4.ProgramLoc

Methods

compare :: ProgramLoc -> ProgramLoc -> Ordering

(<) :: ProgramLoc -> ProgramLoc -> Bool

(<=) :: ProgramLoc -> ProgramLoc -> Bool

(>) :: ProgramLoc -> ProgramLoc -> Bool

(>=) :: ProgramLoc -> ProgramLoc -> Bool

max :: ProgramLoc -> ProgramLoc -> ProgramLoc

min :: ProgramLoc -> ProgramLoc -> ProgramLoc

Show ProgramLoc

Defined in What4.ProgramLoc

Methods

showsPrec :: Int -> ProgramLoc -> ShowS

show :: ProgramLoc -> String

showList :: [ProgramLoc] -> ShowS

mkProgramLoc :: FunctionName -> Position -> ProgramLoc

Make a program loc

initializationLoc :: ProgramLoc

Location for initialization code

plFunction :: ProgramLoc -> FunctionName

plSourceLoc :: ProgramLoc -> Position

Objects with a program location associated.

class HasProgramLoc v where

Methods

programLoc :: Lens' v ProgramLoc