Safe Haskell	None
Language	Haskell2010

Tokstyle.Cimple.Analysis.Functions

Description

Function definitions with their success conventions, and helpers for analysing function bodies.

Synopsis

data Function = Function {
- fnFile :: FilePath
- fnName :: Text
- fnParams :: [Text]
- fnShape :: Shape
- fnDefn :: Node (Lexeme Text)
}
data Shape
- = BoolShape
- | ZeroShape
- | IdShape
- | PtrShape
- | NoShape
data Outcome
- = Success
- | Failure
definitions :: [(FilePath, [Node (Lexeme Text)])] -> [Function]
callees :: Function -> [Text]
bottomUp :: Eq k => (Function -> [Text]) -> (s -> Function -> s) -> (s -> Function -> k) -> [Function] -> s -> s
freers :: Map Text Int
allocators :: Map Text Int
bare :: Node (Lexeme Text) -> Node (Lexeme Text)
accessPath :: Node (Lexeme Text) -> Maybe AccessPath
mapRoot :: (String -> String) -> AccessPath -> AccessPath
valuesUsed :: Node (Lexeme Text) -> [Text]
returnOutcomes :: Shape -> Maybe (Node (Lexeme Text)) -> [Outcome]
branchOn :: Map Text Shape -> Node (Lexeme Text) -> Maybe (Lexeme Text, Outcome)
calleeLexeme :: Node (Lexeme Text) -> Lexeme Text
universe :: Node (Lexeme Text) -> [Node (Lexeme Text)]
strip :: Node (Lexeme Text) -> Node (Lexeme Text)
unFix' :: Node (Lexeme Text) -> NodeF (Lexeme Text) (Node (Lexeme Text))
intLit :: Node (Lexeme Text) -> Maybe Integer
constName :: Node (Lexeme Text) -> Maybe Text
isNullLit :: Node (Lexeme Text) -> Bool
nullTest :: (Node (Lexeme Text) -> Maybe a) -> Node (Lexeme Text) -> Maybe (a, EdgeType)
isEnumConst :: Text -> Bool
flagHolds :: Map String Text -> Node (Lexeme Text) -> EdgeType -> Bool
localDecls :: Node (Lexeme Text) -> [(String, Maybe (Node (Lexeme Text)))]
assignments :: Node (Lexeme Text) -> Map String [Node (Lexeme Text)]
nodeExprs :: Node -> [Node (Lexeme Text)]
rootOf :: AccessPath -> Maybe String
throughPointer :: AccessPath -> Bool
render :: AccessPath -> Doc ann

Documentation

data Function Source #

Constructors

Function
Fields fnFile :: FilePath fnName :: Text fnParams :: [Text] fnShape :: Shape fnDefn :: Node (Lexeme Text)

data Shape Source #

The convention a function's return value uses to report success.

Constructors

BoolShape	Returns `true` on success and `false` on failure.
ZeroShape	Returns 0 on success and a negative number on failure.
IdShape	Returns a negative number on failure and anything else on success.
PtrShape	Returns `nullptr` on failure.
NoShape

data Outcome Source #

Constructors

Success
Failure

Instances

Instances details

Bounded Outcome Source #
Instance details Defined in Tokstyle.Cimple.Analysis.Functions Methods minBound :: Outcome # maxBound :: Outcome #
Enum Outcome Source #
Instance details Defined in Tokstyle.Cimple.Analysis.Functions Methods succ :: Outcome -> Outcome # pred :: Outcome -> Outcome # toEnum :: Int -> Outcome # fromEnum :: Outcome -> Int # enumFrom :: Outcome -> [Outcome] # enumFromThen :: Outcome -> Outcome -> [Outcome] # enumFromTo :: Outcome -> Outcome -> [Outcome] # enumFromThenTo :: Outcome -> Outcome -> Outcome -> [Outcome] #
Show Outcome Source #
Instance details Defined in Tokstyle.Cimple.Analysis.Functions Methods showsPrec :: Int -> Outcome -> ShowS # show :: Outcome -> String # showList :: [Outcome] -> ShowS #
Eq Outcome Source #
Instance details Defined in Tokstyle.Cimple.Analysis.Functions Methods (==) :: Outcome -> Outcome -> Bool # (/=) :: Outcome -> Outcome -> Bool #
Ord Outcome Source #
Instance details Defined in Tokstyle.Cimple.Analysis.Functions Methods compare :: Outcome -> Outcome -> Ordering # (<) :: Outcome -> Outcome -> Bool # (<=) :: Outcome -> Outcome -> Bool # (>) :: Outcome -> Outcome -> Bool # (>=) :: Outcome -> Outcome -> Bool # max :: Outcome -> Outcome -> Outcome # min :: Outcome -> Outcome -> Outcome #

definitions :: [(FilePath, [Node (Lexeme Text)])] -> [Function] Source #

callees :: Function -> [Text] Source #

Get the functions a function calls directly by name.

bottomUp :: Eq k => (Function -> [Text]) -> (s -> Function -> s) -> (s -> Function -> k) -> [Function] -> s -> s Source #

Compute function summaries bottom-up over the strongly connected components of the call graph. add adds a function's summary, and each cycle is iterated until look stops changing, at most length + 2 times.

freers :: Map Text Int Source #

Deallocation functions, with the position of the argument they free.

allocators :: Map Text Int Source #

Allocation functions returning fresh memory, with the position of their element count or size argument.

bare :: Node (Lexeme Text) -> Node (Lexeme Text) Source #

accessPath :: Node (Lexeme Text) -> Maybe AccessPath Source #

Get the access path of an expression naming a variable, field, element or pointee.

mapRoot :: (String -> String) -> AccessPath -> AccessPath Source #

valuesUsed :: Node (Lexeme Text) -> [Text] Source #

Get the names used other than as callees, e.g. a function passed or stored as a value.

returnOutcomes :: Shape -> Maybe (Node (Lexeme Text)) -> [Outcome] Source #

branchOn :: Map Text Shape -> Node (Lexeme Text) -> Maybe (Lexeme Text, Outcome) Source #

For a condition on a call's return value, get the call and the outcome it reported on the true branch.

calleeLexeme :: Node (Lexeme Text) -> Lexeme Text Source #

universe :: Node (Lexeme Text) -> [Node (Lexeme Text)] Source #

strip :: Node (Lexeme Text) -> Node (Lexeme Text) Source #

unFix' :: Node (Lexeme Text) -> NodeF (Lexeme Text) (Node (Lexeme Text)) Source #

intLit :: Node (Lexeme Text) -> Maybe Integer Source #

Get the value of an integer literal, including negative ones.

constName :: Node (Lexeme Text) -> Maybe Text Source #

Get the name of a named constant, e.g. true, nullptr or TOX_OK.

isNullLit :: Node (Lexeme Text) -> Bool Source #

nullTest :: (Node (Lexeme Text) -> Maybe a) -> Node (Lexeme Text) -> Maybe (a, EdgeType) Source #

Find the expression a condition tests for null, mapped through view, and the branch on which it is null.

isEnumConst :: Text -> Bool Source #

flagHolds :: Map String Text -> Node (Lexeme Text) -> EdgeType -> Bool Source #

Whether a branch on an error flag can be taken with the enum constants the flags hold.

localDecls :: Node (Lexeme Text) -> [(String, Maybe (Node (Lexeme Text)))] Source #

Get the local variables of a function with their initialisers.

assignments :: Node (Lexeme Text) -> Map String [Node (Lexeme Text)] Source #

Get the values assigned to each local variable after its declaration.

nodeExprs :: Node -> [Node (Lexeme Text)] Source #

rootOf :: AccessPath -> Maybe String Source #

throughPointer :: AccessPath -> Bool Source #

Check if a path goes through a pointer, i.e. names memory that outlives the function.

render :: AccessPath -> Doc ann Source #