Safe Haskell	None
Language	Haskell2010

Tokstyle.Analysis.Scope

Description

This module implements the Scope Binding pass.

This pass traverses the AST and replaces all variable names (Text) with unique identifiers (ScopedId). This eliminates any ambiguity from name shadowing and is a prerequisite for a correct and precise points-to analysis.

Synopsis

data ScopedId = ScopedId {
- sidUniqueId :: Int
- sidName :: Text
- sidScope :: Scope
}
data ScopeState = ScopeState {
- ssTable :: SymbolTable
- ssNextId :: Int
- ssCurrentScope :: Scope
- ssErrors :: [String]
- ssFuncParamIds :: Map Text [ScopedId]
}
runScopePass :: [Node (Lexeme Text)] -> ([Node (Lexeme ScopedId)], ScopeState)
initialScopeState :: ScopeState
dummyScopedId :: Text -> ScopedId

Documentation

data ScopedId Source #

A unique identifier for a variable, including its original name and scope info.

Constructors

ScopedId
Fields sidUniqueId :: Int The globally unique ID. sidName :: Text The original name, for debugging. sidScope :: Scope The scope it was defined in (Global or Static).

Instances

Instances details

Eq ScopedId Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods (==) :: ScopedId -> ScopedId -> Bool # (/=) :: ScopedId -> ScopedId -> Bool #
Ord ScopedId Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods compare :: ScopedId -> ScopedId -> Ordering # (<) :: ScopedId -> ScopedId -> Bool # (<=) :: ScopedId -> ScopedId -> Bool # (>) :: ScopedId -> ScopedId -> Bool # (>=) :: ScopedId -> ScopedId -> Bool # max :: ScopedId -> ScopedId -> ScopedId # min :: ScopedId -> ScopedId -> ScopedId #
Show ScopedId Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods showsPrec :: Int -> ScopedId -> ShowS # show :: ScopedId -> String # showList :: [ScopedId] -> ShowS #
IsString ScopedId Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods fromString :: String -> ScopedId #
Hashable ScopedId Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods hashWithSalt :: Int -> ScopedId -> Int # hash :: ScopedId -> Int #
Pretty ScopedId Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods pretty :: ScopedId -> Doc ann # prettyList :: [ScopedId] -> Doc ann #
DataFlow PointsToAnalysis PointsToContext ScopedId PointsToFact RelevantInputState Source #
Instance details Defined in Tokstyle.Analysis.PointsTo Methods emptyFacts :: PointsToContext ScopedId -> PointsToAnalysis PointsToFact Source # transfer :: PointsToContext ScopedId -> ScopedId -> Int -> PointsToFact -> Node (Lexeme ScopedId) -> PointsToAnalysis (PointsToFact, Set (ScopedId, RelevantInputState)) Source # join :: PointsToContext ScopedId -> PointsToFact -> PointsToFact -> PointsToAnalysis PointsToFact Source #

data ScopeState Source #

The state for the scope analysis traversal.

Constructors

ScopeState
Fields ssTable :: SymbolTable The stack of symbol tables. ssNextId :: Int The next available unique ID. ssCurrentScope :: Scope The scope of the current function. ssErrors :: [String] A list of errors encountered. ssFuncParamIds :: Map Text [ScopedId]

Instances

Instances details

Show ScopeState Source #
Instance details Defined in Tokstyle.Analysis.Scope Methods showsPrec :: Int -> ScopeState -> ShowS # show :: ScopeState -> String # showList :: [ScopeState] -> ShowS #

runScopePass :: [Node (Lexeme Text)] -> ([Node (Lexeme ScopedId)], ScopeState) Source #

Runs the scope binding pass on a list of translation units.

initialScopeState :: ScopeState Source #

The initial state for the scope analysis.

dummyScopedId :: Text -> ScopedId Source #

Creates a dummy ScopedId for non-variable identifiers like struct fields.