Safe Haskell	Safe-Inferred
Language	Haskell2010

Location

Description

Locations exist for all "code entities"
- variables
- function calls
- function definitions
- while loops
- etc.
Locations are constructed only during parsing
- users should not construct locations
Locations help to present security findings to users
In addition, locations are used as primary keys in the container database
- more precisely, locations are variables in the resulting Prolog program
- each location corresponds to exactly one "code entity"
- this is why users should never construct locations
- it is completely the parser's job !

Synopsis

data Location = Location {
- filename :: FilePath
- lineStart :: Word
- lineEnd :: Word
- colStart :: Word
- colEnd :: Word
}

Documentation

data Location Source #

Lines and columns are 1-based, for compatability with Sarif.

The line number of the first line in a text artifact SHALL be 1.

Constructors

Location
Fields filename :: FilePath lineStart :: Word lineEnd :: Word colStart :: Word colEnd :: Word

Instances

Instances details

FromJSON Location Source #
Instance details Defined in Location Methods parseJSON :: Value -> Parser Location # parseJSONList :: Value -> Parser [Location] # omittedField :: Maybe Location #
ToJSON Location Source #
Instance details Defined in Location Methods toJSON :: Location -> Value # toEncoding :: Location -> Encoding # toJSONList :: [Location] -> Value # toEncodingList :: [Location] -> Encoding # omitField :: Location -> Bool #
Generic Location Source #
Instance details Defined in Location Associated Types type Rep Location :: Type -> Type Methods from :: Location -> Rep Location x to :: Rep Location x -> Location
Read Location Source #
Instance details Defined in Location Methods readsPrec :: Int -> ReadS Location readList :: ReadS [Location] readPrec :: ReadPrec Location readListPrec :: ReadPrec [Location]
Show Location Source #
Instance details Defined in Location Methods showsPrec :: Int -> Location -> ShowS show :: Location -> String showList :: [Location] -> ShowS
Eq Location Source #
Instance details Defined in Location Methods (==) :: Location -> Location -> Bool (/=) :: Location -> Location -> Bool
Ord Location Source #
Instance details Defined in Location Methods compare :: Location -> Location -> Ordering (<) :: Location -> Location -> Bool (<=) :: Location -> Location -> Bool (>) :: Location -> Location -> Bool (>=) :: Location -> Location -> Bool max :: Location -> Location -> Location min :: Location -> Location -> Location
type Rep Location Source #
Instance details Defined in Location type Rep Location = D1 ('MetaData "Location" "Location" "dhscanner-ast-1.1.2-inplace" 'False) (C1 ('MetaCons "Location" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: S1 ('MetaSel ('Just "lineStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)) :: (S1 ('MetaSel ('Just "lineEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :: (S1 ('MetaSel ('Just "colStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word) :: S1 ('MetaSel ('Just "colEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word)))))