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