[project @ 2001-03-19 16:22:00 by simonmar]
[ghc-hetmet.git] / ghc / compiler / basicTypes / NameEnv.lhs
1 %
2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
3 %
4 \section[NameEnv]{@NameEnv@: name environments}
5
6 \begin{code}
7 module NameEnv (
8         NameEnv, mkNameEnv,
9         emptyNameEnv, unitNameEnv, nameEnvElts, 
10         extendNameEnv_C, extendNameEnv, foldNameEnv, filterNameEnv,
11         plusNameEnv, plusNameEnv_C, extendNameEnv, extendNameEnvList,
12         lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, delListFromNameEnv,
13         elemNameEnv
14     ) where
15
16 #include "HsVersions.h"
17
18 import Name     ( Name )
19 import UniqFM
20 import Maybes   ( expectJust )
21 \end{code}
22
23 %************************************************************************
24 %*                                                                      *
25 \subsection{Name environment}
26 %*                                                                      *
27 %************************************************************************
28
29 \begin{code}
30 type NameEnv a = UniqFM a       -- Domain is Name
31
32 emptyNameEnv     :: NameEnv a
33 mkNameEnv        :: [(Name,a)] -> NameEnv a
34 nameEnvElts      :: NameEnv a -> [a]
35 extendNameEnv_C  :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
36 extendNameEnv    :: NameEnv a -> Name -> a -> NameEnv a
37 plusNameEnv      :: NameEnv a -> NameEnv a -> NameEnv a
38 plusNameEnv_C    :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
39 extendNameEnvList:: NameEnv a -> [(Name,a)] -> NameEnv a
40 delFromNameEnv   :: NameEnv a -> Name -> NameEnv a
41 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
42 elemNameEnv      :: Name -> NameEnv a -> Bool
43 unitNameEnv      :: Name -> a -> NameEnv a
44 lookupNameEnv    :: NameEnv a -> Name -> Maybe a
45 lookupNameEnv_NF :: NameEnv a -> Name -> a
46 mapNameEnv       :: (a->b) -> NameEnv a -> NameEnv b
47 foldNameEnv      :: (a -> b -> b) -> b -> NameEnv a -> b
48 filterNameEnv    :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
49
50 emptyNameEnv     = emptyUFM
51 foldNameEnv      = foldUFM
52 mkNameEnv        = listToUFM
53 nameEnvElts      = eltsUFM
54 extendNameEnv_C  = addToUFM_C
55 extendNameEnv    = addToUFM
56 plusNameEnv      = plusUFM
57 plusNameEnv_C    = plusUFM_C
58 extendNameEnvList= addListToUFM
59 delFromNameEnv   = delFromUFM
60 delListFromNameEnv = delListFromUFM
61 elemNameEnv      = elemUFM
62 mapNameEnv       = mapUFM
63 unitNameEnv      = unitUFM
64 filterNameEnv    = filterUFM
65
66 lookupNameEnv          = lookupUFM
67 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupUFM env n)
68 \end{code}
69