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