[project @ 2004-08-16 09:53:47 by simonpj]
[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, extendNameEnvList_C, extendNameEnv, extendNameEnvList, 
11         foldNameEnv, filterNameEnv,
12         plusNameEnv, plusNameEnv_C, 
13         lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, delListFromNameEnv,
14         elemNameEnv
15     ) where
16
17 #include "HsVersions.h"
18
19 import Name     ( Name )
20 import UniqFM
21 import Maybes   ( expectJust )
22 \end{code}
23
24 %************************************************************************
25 %*                                                                      *
26 \subsection{Name environment}
27 %*                                                                      *
28 %************************************************************************
29
30 \begin{code}
31 type NameEnv a = UniqFM a       -- Domain is Name
32
33 emptyNameEnv       :: NameEnv a
34 mkNameEnv          :: [(Name,a)] -> NameEnv a
35 nameEnvElts        :: NameEnv a -> [a]
36 extendNameEnv_C    :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
37 extendNameEnvList_C:: (a->a->a) -> NameEnv a -> [(Name,a)] -> NameEnv a
38 extendNameEnv      :: NameEnv a -> Name -> a -> NameEnv a
39 plusNameEnv        :: NameEnv a -> NameEnv a -> NameEnv a
40 plusNameEnv_C      :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
41 extendNameEnvList  :: NameEnv a -> [(Name,a)] -> NameEnv a
42 delFromNameEnv     :: NameEnv a -> Name -> NameEnv a
43 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
44 elemNameEnv        :: Name -> NameEnv a -> Bool
45 unitNameEnv        :: Name -> a -> NameEnv a
46 lookupNameEnv      :: NameEnv a -> Name -> Maybe a
47 lookupNameEnv_NF   :: NameEnv a -> Name -> a
48 foldNameEnv        :: (a -> b -> b) -> b -> NameEnv a -> b
49 filterNameEnv      :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
50
51 emptyNameEnv        = emptyUFM
52 foldNameEnv         = foldUFM
53 mkNameEnv           = listToUFM
54 nameEnvElts         = eltsUFM
55 extendNameEnv_C     = addToUFM_C
56 extendNameEnvList_C = addListToUFM_C
57 extendNameEnv       = addToUFM
58 plusNameEnv         = plusUFM
59 plusNameEnv_C       = plusUFM_C
60 extendNameEnvList   = addListToUFM
61 delFromNameEnv      = delFromUFM
62 delListFromNameEnv  = delListFromUFM
63 elemNameEnv         = elemUFM
64 unitNameEnv         = unitUFM
65 filterNameEnv       = filterUFM
66
67 lookupNameEnv          = lookupUFM
68 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupUFM env n)
69 \end{code}
70