dhscanner-ast-1.1.0: src/Token.hs

-- |
--
-- * For the most part, tokens are constructed during parsing
--
--     * exception example: an instrumented call to __nondet__, which involves creating a 'VarName'
--
-- * Each token kind ( 'VarName', 'ParamName' etc. ) corresponds to its own Haskell type
--
--     * this means that ( for example ) 'VarName' and 'ParamName' are /not/ interchangeable
--
-- * Sometimes, a /unified view/ is needed for named tokens
--
--     * for instance, inside the symbol table
--     * in these cases, use the included 'Named' portion of the type
--     * getter functions below help to easily extract it
--     * the abstract syntax tree does /not/ contain "naked" 'Named' tokens
--

{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DeriveAnyClass #-}
{-# LANGUAGE OverloadedStrings #-}

module Token

where

-- project imports
import Location

-- general imports
import Data.Aeson
import GHC.Generics

-- |
--
-- * Raw data that is wrapped and included by the different tokens
--
-- * Aimed to facilitate a unified view of named tokens
--
-- * Is /not/ a part of the abstract syntax tree
--
data Named
   = Named
   {
       content :: String,
       location :: Location
   }
   deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
   
data VarName   = VarName   Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
data FuncName  = FuncName  Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
data ParamName = ParamName Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
data FieldName = FieldName Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
data ClassName = ClassName Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
data SuperName = SuperName Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )
data MemberName = MemberName Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord, ToJSONKey, FromJSONKey )
data MethodName = MethodName Named deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord, ToJSONKey, FromJSONKey )

-- getters signatures (to quiet ghc -Wall)
getVarNameToken   :: VarName   -> Named
getFuncNameToken  :: FuncName  -> Named
getParamNameToken :: ParamName -> Named
getFieldNameToken :: FieldName -> Named
getClassNameToken :: ClassName -> Named
getSuperNameToken :: SuperName -> Named
getMemberNameToken :: MemberName -> Named
getMethodNameToken :: MethodName -> Named

-- getters
getVarNameToken   (VarName   v) = v
getFuncNameToken  (FuncName  f) = f
getParamNameToken (ParamName p) = p
getFieldNameToken (FieldName f) = f
getClassNameToken (ClassName c) = c
getSuperNameToken (SuperName s) = s
getMemberNameToken (MemberName m) = m
getMethodNameToken (MethodName m) = m

-- locations signatures
getVarNameLocation :: VarName -> Location
getFuncNameLocation :: FuncName -> Location
getClassNameLocation :: ClassName -> Location
getParamNameLocation :: ParamName -> Location
getFieldNameLocation :: FieldName -> Location
getMethodNameLocation :: MethodName -> Location

-- locations signatures
getVarNameLocation = location . getVarNameToken
getFuncNameLocation = location . getFuncNameToken
getClassNameLocation = location . getClassNameToken
getParamNameLocation = location . getParamNameToken
getFieldNameLocation = location . getFieldNameToken
getMethodNameLocation = location . getMethodNameToken

data ConstBool
   = ConstBool
   {
       constBoolValue :: Bool,
       constBoolLocation :: Location
   }
   deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )

data ConstInt
   = ConstInt
   {
       constIntValue :: Int,
       constIntLocation :: Location
   }
   deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )

data ConstStr
   = ConstStr
   {
       constStrValue :: String,
       constStrLocation :: Location
   }
   deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )

data ConstNull
   = ConstNull
   {
       constNullLocation :: Location
   }
   deriving ( Show, Eq, Generic, ToJSON, FromJSON, Ord )