Copyright	(c) Galois Inc 2014-2020
License	BSD3
Maintainer	Joe Hendrix <jhendrix@galois.com>
Stability	provisional
Safe Haskell	None
Language	Haskell2010

What4.ProgramLoc

Contents

Objects with a program location associated.

Description

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.

Synopsis

data Position
- = SourcePos !Text !Int !Int
- | BinaryPos !Text !Word64
- | OtherPos !Text
- | InternalPos
sourcePos :: FilePath -> Int -> Int -> Position
startOfFile :: FilePath -> Position
ppNoFileName :: Position -> Doc ann
data Posd v = Posd {
- pos :: !Position
- pos_val :: !v
}
data ProgramLoc
mkProgramLoc :: FunctionName -> Position -> ProgramLoc
initializationLoc :: ProgramLoc
plFunction :: ProgramLoc -> FunctionName
plSourceLoc :: ProgramLoc -> Position
class HasProgramLoc v where
- programLoc :: Lens' v ProgramLoc

Documentation

data Position Source #

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

Instances details

Eq Position Source #
Instance details Defined in What4.ProgramLoc Methods (==) :: Position -> Position -> Bool # (/=) :: Position -> Position -> Bool #
Ord Position Source #
Instance details 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 Source #
Instance details Defined in What4.ProgramLoc Methods showsPrec :: Int -> Position -> ShowS # show :: Position -> String # showList :: [Position] -> ShowS #
NFData Position Source #
Instance details Defined in What4.ProgramLoc Methods rnf :: Position -> () #
Pretty Position Source #
Instance details Defined in What4.ProgramLoc Methods pretty :: Position -> Doc ann # prettyList :: [Position] -> Doc ann #

sourcePos :: FilePath -> Int -> Int -> Position Source #

startOfFile :: FilePath -> Position Source #

ppNoFileName :: Position -> Doc ann Source #

data Posd v Source #

A value with a source position associated.

Constructors

Posd
Fields pos :: !Position pos_val :: !v

Instances

Instances details

Functor Posd Source #
Instance details Defined in What4.ProgramLoc Methods fmap :: (a -> b) -> Posd a -> Posd b # (<$) :: a -> Posd b -> Posd a #
Foldable Posd Source #
Instance details Defined in What4.ProgramLoc Methods fold :: Monoid m => Posd m -> m # foldMap :: Monoid m => (a -> m) -> Posd a -> 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 Source #
Instance details 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) Source #
Instance details Defined in What4.ProgramLoc Methods (==) :: Posd v -> Posd v -> Bool # (/=) :: Posd v -> Posd v -> Bool #
Show v => Show (Posd v) Source #
Instance details Defined in What4.ProgramLoc Methods showsPrec :: Int -> Posd v -> ShowS # show :: Posd v -> String # showList :: [Posd v] -> ShowS #
NFData v => NFData (Posd v) Source #
Instance details Defined in What4.ProgramLoc Methods rnf :: Posd v -> () #

data ProgramLoc Source #

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

Instances

Instances details

Eq ProgramLoc Source #
Instance details Defined in What4.ProgramLoc Methods (==) :: ProgramLoc -> ProgramLoc -> Bool # (/=) :: ProgramLoc -> ProgramLoc -> Bool #
Ord ProgramLoc Source #
Instance details 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 Source #
Instance details Defined in What4.ProgramLoc Methods showsPrec :: Int -> ProgramLoc -> ShowS # show :: ProgramLoc -> String # showList :: [ProgramLoc] -> ShowS #

mkProgramLoc :: FunctionName -> Position -> ProgramLoc Source #

Make a program loc

initializationLoc :: ProgramLoc Source #

Location for initialization code

plFunction :: ProgramLoc -> FunctionName Source #

plSourceLoc :: ProgramLoc -> Position Source #

Objects with a program location associated.

class HasProgramLoc v where Source #

Methods

programLoc :: Lens' v ProgramLoc Source #