-- | Only the 'SymbolTable' definitions.

module Language.Fortran.Vars.Types.SymbolTable where

import Language.Fortran.Vars.Rep ( Type, ExpVal )

import Language.Fortran.AST ( Name )

import Data.Map ( Map )

import GHC.Generics ( Generic )
import Data.Aeson ( FromJSON, ToJSON )
import Data.Data ( Data )

-- | Symbol table containing all non-intrisic symbols declared in a program
type SymbolTable = Map Name SymbolTableEntry

-- | An entry in the 'SymbolTable' for some variable
data SymbolTableEntry
  = SParameter { SymbolTableEntry -> Type
parType :: Type , SymbolTableEntry -> ExpVal
parVal :: ExpVal }
  | SVariable { SymbolTableEntry -> Type
varType :: Type , SymbolTableEntry -> Location
varLoc :: Location }
  | SDummy { SymbolTableEntry -> Type
dumType :: Type }
  | SExternal {SymbolTableEntry -> Type
extType :: Type }
  deriving (SymbolTableEntry -> SymbolTableEntry -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SymbolTableEntry -> SymbolTableEntry -> Bool
$c/= :: SymbolTableEntry -> SymbolTableEntry -> Bool
== :: SymbolTableEntry -> SymbolTableEntry -> Bool
$c== :: SymbolTableEntry -> SymbolTableEntry -> Bool
Eq, Eq SymbolTableEntry
SymbolTableEntry -> SymbolTableEntry -> Bool
SymbolTableEntry -> SymbolTableEntry -> Ordering
SymbolTableEntry -> SymbolTableEntry -> SymbolTableEntry
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: SymbolTableEntry -> SymbolTableEntry -> SymbolTableEntry
$cmin :: SymbolTableEntry -> SymbolTableEntry -> SymbolTableEntry
max :: SymbolTableEntry -> SymbolTableEntry -> SymbolTableEntry
$cmax :: SymbolTableEntry -> SymbolTableEntry -> SymbolTableEntry
>= :: SymbolTableEntry -> SymbolTableEntry -> Bool
$c>= :: SymbolTableEntry -> SymbolTableEntry -> Bool
> :: SymbolTableEntry -> SymbolTableEntry -> Bool
$c> :: SymbolTableEntry -> SymbolTableEntry -> Bool
<= :: SymbolTableEntry -> SymbolTableEntry -> Bool
$c<= :: SymbolTableEntry -> SymbolTableEntry -> Bool
< :: SymbolTableEntry -> SymbolTableEntry -> Bool
$c< :: SymbolTableEntry -> SymbolTableEntry -> Bool
compare :: SymbolTableEntry -> SymbolTableEntry -> Ordering
$ccompare :: SymbolTableEntry -> SymbolTableEntry -> Ordering
Ord, Int -> SymbolTableEntry -> ShowS
[SymbolTableEntry] -> ShowS
SymbolTableEntry -> [Char]
forall a.
(Int -> a -> ShowS) -> (a -> [Char]) -> ([a] -> ShowS) -> Show a
showList :: [SymbolTableEntry] -> ShowS
$cshowList :: [SymbolTableEntry] -> ShowS
show :: SymbolTableEntry -> [Char]
$cshow :: SymbolTableEntry -> [Char]
showsPrec :: Int -> SymbolTableEntry -> ShowS
$cshowsPrec :: Int -> SymbolTableEntry -> ShowS
Show, Typeable SymbolTableEntry
SymbolTableEntry -> DataType
SymbolTableEntry -> Constr
(forall b. Data b => b -> b)
-> SymbolTableEntry -> SymbolTableEntry
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u.
Int -> (forall d. Data d => d -> u) -> SymbolTableEntry -> u
forall u. (forall d. Data d => d -> u) -> SymbolTableEntry -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> SymbolTableEntry -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> SymbolTableEntry -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c SymbolTableEntry
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> SymbolTableEntry -> c SymbolTableEntry
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c SymbolTableEntry)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c SymbolTableEntry)
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> SymbolTableEntry -> m SymbolTableEntry
gmapQi :: forall u.
Int -> (forall d. Data d => d -> u) -> SymbolTableEntry -> u
$cgmapQi :: forall u.
Int -> (forall d. Data d => d -> u) -> SymbolTableEntry -> u
gmapQ :: forall u. (forall d. Data d => d -> u) -> SymbolTableEntry -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> SymbolTableEntry -> [u]
gmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> SymbolTableEntry -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> SymbolTableEntry -> r
gmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> SymbolTableEntry -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> SymbolTableEntry -> r
gmapT :: (forall b. Data b => b -> b)
-> SymbolTableEntry -> SymbolTableEntry
$cgmapT :: (forall b. Data b => b -> b)
-> SymbolTableEntry -> SymbolTableEntry
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c SymbolTableEntry)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c SymbolTableEntry)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c SymbolTableEntry)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c SymbolTableEntry)
dataTypeOf :: SymbolTableEntry -> DataType
$cdataTypeOf :: SymbolTableEntry -> DataType
toConstr :: SymbolTableEntry -> Constr
$ctoConstr :: SymbolTableEntry -> Constr
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c SymbolTableEntry
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c SymbolTableEntry
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> SymbolTableEntry -> c SymbolTableEntry
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> SymbolTableEntry -> c SymbolTableEntry
Data, forall x. Rep SymbolTableEntry x -> SymbolTableEntry
forall x. SymbolTableEntry -> Rep SymbolTableEntry x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SymbolTableEntry x -> SymbolTableEntry
$cfrom :: forall x. SymbolTableEntry -> Rep SymbolTableEntry x
Generic)

instance FromJSON SymbolTableEntry
instance ToJSON SymbolTableEntry

-- | The location of a variable, i.e. the 'MemoryBlockName' that
-- contains it as well as the 'Offset' to its location in memory
type Location = (MemoryBlockName, Offset)

-- | The name of block of memory
type MemoryBlockName = Name

-- | Memory offset given to a variable in memory
type Offset = Int