Safe Haskell	None
Language	Haskell98

ShellCheck.CFGAnalysis

Documentation

analyzeControlFlow :: CFGParameters -> Token -> CFGAnalysis Source #

data CFGParameters Source #

Constructors

CFGParameters
Fields cfLastpipe :: Bool cfPipefail :: Bool

data CFGAnalysis Source #

Constructors

CFGAnalysis
Fields graph :: CFGraph tokenToRange :: Map Id (Node, Node) tokenToNodes :: Map Id (Set Node) postDominators :: Array Node [Node] nodeToData :: Map Node (ProgramState, ProgramState)

Instances

Instances details

Show CFGAnalysis Source #
Instance details Defined in ShellCheck.CFGAnalysis Methods showsPrec :: Int -> CFGAnalysis -> ShowS # show :: CFGAnalysis -> String # showList :: [CFGAnalysis] -> ShowS #

data ProgramState Source #

Constructors

ProgramState
Fields variablesInScope :: Map String VariableState exitCodes :: Set Id stateIsReachable :: Bool

Instances

Instances details

Generic ProgramState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Associated Types

type Rep ProgramState

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep ProgramState = D1 ('MetaData "ProgramState" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "ProgramState" 'PrefixI 'True) (S1 ('MetaSel ('Just "variablesInScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map String VariableState)) :*: (S1 ('MetaSel ('Just "exitCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Id)) :*: S1 ('MetaSel ('Just "stateIsReachable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

Methods

from :: ProgramState -> Rep ProgramState x #

to :: Rep ProgramState x -> ProgramState #

Show ProgramState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

showsPrec :: Int -> ProgramState -> ShowS #

show :: ProgramState -> String #

showList :: [ProgramState] -> ShowS #

NFData ProgramState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

rnf :: ProgramState -> () #

Eq ProgramState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

(==) :: ProgramState -> ProgramState -> Bool #

(/=) :: ProgramState -> ProgramState -> Bool #

type Rep ProgramState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep ProgramState = D1 ('MetaData "ProgramState" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "ProgramState" 'PrefixI 'True) (S1 ('MetaSel ('Just "variablesInScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map String VariableState)) :*: (S1 ('MetaSel ('Just "exitCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Set Id)) :*: S1 ('MetaSel ('Just "stateIsReachable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data VariableState Source #

Constructors

VariableState
Fields variableValue :: VariableValue variableProperties :: VariableProperties

Instances

Instances details

Generic VariableState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Associated Types

type Rep VariableState

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep VariableState = D1 ('MetaData "VariableState" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "VariableState" 'PrefixI 'True) (S1 ('MetaSel ('Just "variableValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VariableValue) :*: S1 ('MetaSel ('Just "variableProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VariableProperties)))

Methods

from :: VariableState -> Rep VariableState x #

to :: Rep VariableState x -> VariableState #

Show VariableState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

showsPrec :: Int -> VariableState -> ShowS #

show :: VariableState -> String #

showList :: [VariableState] -> ShowS #

NFData VariableState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

rnf :: VariableState -> () #

Eq VariableState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

(==) :: VariableState -> VariableState -> Bool #

(/=) :: VariableState -> VariableState -> Bool #

Ord VariableState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

compare :: VariableState -> VariableState -> Ordering #

(<) :: VariableState -> VariableState -> Bool #

(<=) :: VariableState -> VariableState -> Bool #

(>) :: VariableState -> VariableState -> Bool #

(>=) :: VariableState -> VariableState -> Bool #

max :: VariableState -> VariableState -> VariableState #

min :: VariableState -> VariableState -> VariableState #

type Rep VariableState Source #

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep VariableState = D1 ('MetaData "VariableState" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "VariableState" 'PrefixI 'True) (S1 ('MetaSel ('Just "variableValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VariableValue) :*: S1 ('MetaSel ('Just "variableProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VariableProperties)))

data VariableValue Source #

Constructors

VariableValue
Fields literalValue :: Maybe String spaceStatus :: SpaceStatus numericalStatus :: NumericalStatus

Instances

Instances details

Generic VariableValue Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Associated Types

type Rep VariableValue

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep VariableValue = D1 ('MetaData "VariableValue" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "VariableValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "literalValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: (S1 ('MetaSel ('Just "spaceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpaceStatus) :*: S1 ('MetaSel ('Just "numericalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NumericalStatus))))

Methods

from :: VariableValue -> Rep VariableValue x #

to :: Rep VariableValue x -> VariableValue #

Show VariableValue Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

showsPrec :: Int -> VariableValue -> ShowS #

show :: VariableValue -> String #

showList :: [VariableValue] -> ShowS #

NFData VariableValue Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

rnf :: VariableValue -> () #

Eq VariableValue Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

(==) :: VariableValue -> VariableValue -> Bool #

(/=) :: VariableValue -> VariableValue -> Bool #

Ord VariableValue Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

compare :: VariableValue -> VariableValue -> Ordering #

(<) :: VariableValue -> VariableValue -> Bool #

(<=) :: VariableValue -> VariableValue -> Bool #

(>) :: VariableValue -> VariableValue -> Bool #

(>=) :: VariableValue -> VariableValue -> Bool #

max :: VariableValue -> VariableValue -> VariableValue #

min :: VariableValue -> VariableValue -> VariableValue #

type Rep VariableValue Source #

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep VariableValue = D1 ('MetaData "VariableValue" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "VariableValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "literalValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :*: (S1 ('MetaSel ('Just "spaceStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpaceStatus) :*: S1 ('MetaSel ('Just "numericalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NumericalStatus))))

type VariableProperties = Set (Set CFVariableProp) Source #

data SpaceStatus Source #

Constructors

SpaceStatusEmpty
SpaceStatusClean
SpaceStatusDirty

Instances

Instances details

Generic SpaceStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Associated Types

type Rep SpaceStatus

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep SpaceStatus = D1 ('MetaData "SpaceStatus" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "SpaceStatusEmpty" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SpaceStatusClean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpaceStatusDirty" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: SpaceStatus -> Rep SpaceStatus x #

to :: Rep SpaceStatus x -> SpaceStatus #

Show SpaceStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

showsPrec :: Int -> SpaceStatus -> ShowS #

show :: SpaceStatus -> String #

showList :: [SpaceStatus] -> ShowS #

NFData SpaceStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

rnf :: SpaceStatus -> () #

Eq SpaceStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

(==) :: SpaceStatus -> SpaceStatus -> Bool #

(/=) :: SpaceStatus -> SpaceStatus -> Bool #

Ord SpaceStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

compare :: SpaceStatus -> SpaceStatus -> Ordering #

(<) :: SpaceStatus -> SpaceStatus -> Bool #

(<=) :: SpaceStatus -> SpaceStatus -> Bool #

(>) :: SpaceStatus -> SpaceStatus -> Bool #

(>=) :: SpaceStatus -> SpaceStatus -> Bool #

max :: SpaceStatus -> SpaceStatus -> SpaceStatus #

min :: SpaceStatus -> SpaceStatus -> SpaceStatus #

type Rep SpaceStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep SpaceStatus = D1 ('MetaData "SpaceStatus" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) (C1 ('MetaCons "SpaceStatusEmpty" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "SpaceStatusClean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpaceStatusDirty" 'PrefixI 'False) (U1 :: Type -> Type)))

data NumericalStatus Source #

Constructors

NumericalStatusUnknown
NumericalStatusEmpty
NumericalStatusMaybe
NumericalStatusDefinitely

Instances

Instances details

Generic NumericalStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Associated Types

type Rep NumericalStatus

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep NumericalStatus = D1 ('MetaData "NumericalStatus" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) ((C1 ('MetaCons "NumericalStatusUnknown" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NumericalStatusEmpty" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NumericalStatusMaybe" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NumericalStatusDefinitely" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: NumericalStatus -> Rep NumericalStatus x #

to :: Rep NumericalStatus x -> NumericalStatus #

Show NumericalStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

showsPrec :: Int -> NumericalStatus -> ShowS #

show :: NumericalStatus -> String #

showList :: [NumericalStatus] -> ShowS #

NFData NumericalStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

rnf :: NumericalStatus -> () #

Eq NumericalStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

(==) :: NumericalStatus -> NumericalStatus -> Bool #

(/=) :: NumericalStatus -> NumericalStatus -> Bool #

Ord NumericalStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

Methods

compare :: NumericalStatus -> NumericalStatus -> Ordering #

(<) :: NumericalStatus -> NumericalStatus -> Bool #

(<=) :: NumericalStatus -> NumericalStatus -> Bool #

(>) :: NumericalStatus -> NumericalStatus -> Bool #

(>=) :: NumericalStatus -> NumericalStatus -> Bool #

max :: NumericalStatus -> NumericalStatus -> NumericalStatus #

min :: NumericalStatus -> NumericalStatus -> NumericalStatus #

type Rep NumericalStatus Source #

Instance details

Defined in ShellCheck.CFGAnalysis

type Rep NumericalStatus = D1 ('MetaData "NumericalStatus" "ShellCheck.CFGAnalysis" "ShellCheck-0.10.0-CNPzbMsdekxa9OZIJ81ii" 'False) ((C1 ('MetaCons "NumericalStatusUnknown" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NumericalStatusEmpty" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NumericalStatusMaybe" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NumericalStatusDefinitely" 'PrefixI 'False) (U1 :: Type -> Type)))

getIncomingState :: CFGAnalysis -> Id -> Maybe ProgramState Source #

getOutgoingState :: CFGAnalysis -> Id -> Maybe ProgramState Source #

doesPostDominate :: CFGAnalysis -> Id -> Id -> Bool Source #

variableMayBeDeclaredInteger :: ProgramState -> String -> Maybe Bool Source #

variableMayBeAssignedInteger :: ProgramState -> String -> Maybe Bool Source #

runTests :: IO Bool Source #