Comments only
[ghc.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 {-# OPTIONS -fno-warn-tabs #-}
9 -- The above warning supression flag is a temporary kludge.
10 -- While working on this module you are encouraged to remove it and
11 -- detab the module (please do the detabbing in a separate patch). See
12 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#TabsvsSpaces
13 -- for details
14
15 module NameEnv (
16         -- * Var, Id and TyVar environments (maps) 
17         NameEnv, 
18         
19         -- ** Manipulating these environments
20         mkNameEnv,
21         emptyNameEnv, unitNameEnv, nameEnvElts, nameEnvUniqueElts,
22         extendNameEnv_C, extendNameEnv_Acc, extendNameEnv,
23         extendNameEnvList, extendNameEnvList_C,
24         foldNameEnv, filterNameEnv,
25         plusNameEnv, plusNameEnv_C, alterNameEnv,
26         lookupNameEnv, lookupNameEnv_NF, delFromNameEnv, delListFromNameEnv,
27         elemNameEnv, mapNameEnv,
28
29         -- ** Dependency analysis
30         depAnal
31     ) where
32
33 #include "HsVersions.h"
34
35 import Digraph
36 import Name
37 import Unique
38 import UniqFM
39 import Maybes
40 \end{code}
41
42 %************************************************************************
43 %*                                                                      *
44 \subsection{Name environment}
45 %*                                                                      *
46 %************************************************************************
47
48 \begin{code}
49 depAnal :: (node -> [Name])      -- Defs 
50         -> (node -> [Name])      -- Uses
51         -> [node]
52         -> [SCC node]
53 -- Peform dependency analysis on a group of definitions,
54 -- where each definition may define more than one Name
55 --
56 -- The get_defs and get_uses functions are called only once per node
57 depAnal get_defs get_uses nodes
58   = stronglyConnCompFromEdgedVertices (map mk_node keyed_nodes)
59   where
60     keyed_nodes = nodes `zip` [(1::Int)..]
61     mk_node (node, key) = (node, key, mapCatMaybes (lookupNameEnv key_map) (get_uses node))
62
63     key_map :: NameEnv Int   -- Maps a Name to the key of the decl that defines it
64     key_map = mkNameEnv [(name,key) | (node, key) <- keyed_nodes, name <- get_defs node]                        
65 \end{code}
66
67
68 %************************************************************************
69 %*                                                                      *
70 \subsection{Name environment}
71 %*                                                                      *
72 %************************************************************************
73
74 \begin{code}
75 type NameEnv a = UniqFM a       -- Domain is Name
76
77 emptyNameEnv       :: NameEnv a
78 mkNameEnv          :: [(Name,a)] -> NameEnv a
79 nameEnvElts        :: NameEnv a -> [a]
80 nameEnvUniqueElts  :: NameEnv a -> [(Unique, a)]
81 alterNameEnv       :: (Maybe a-> Maybe a) -> NameEnv a -> Name -> NameEnv a
82 extendNameEnv_C    :: (a->a->a) -> NameEnv a -> Name -> a -> NameEnv a
83 extendNameEnv_Acc  :: (a->b->b) -> (a->b) -> NameEnv b -> Name -> a -> NameEnv b
84 extendNameEnv      :: NameEnv a -> Name -> a -> NameEnv a
85 plusNameEnv        :: NameEnv a -> NameEnv a -> NameEnv a
86 plusNameEnv_C      :: (a->a->a) -> NameEnv a -> NameEnv a -> NameEnv a
87 extendNameEnvList  :: NameEnv a -> [(Name,a)] -> NameEnv a
88 extendNameEnvList_C :: (a->a->a) -> NameEnv a -> [(Name,a)] -> NameEnv a
89 delFromNameEnv     :: NameEnv a -> Name -> NameEnv a
90 delListFromNameEnv :: NameEnv a -> [Name] -> NameEnv a
91 elemNameEnv        :: Name -> NameEnv a -> Bool
92 unitNameEnv        :: Name -> a -> NameEnv a
93 lookupNameEnv      :: NameEnv a -> Name -> Maybe a
94 lookupNameEnv_NF   :: NameEnv a -> Name -> a
95 foldNameEnv        :: (a -> b -> b) -> b -> NameEnv a -> b
96 filterNameEnv      :: (elt -> Bool) -> NameEnv elt -> NameEnv elt
97 mapNameEnv         :: (elt1 -> elt2) -> NameEnv elt1 -> NameEnv elt2
98
99 nameEnvElts x         = eltsUFM x
100 emptyNameEnv          = emptyUFM
101 unitNameEnv x y       = unitUFM x y 
102 extendNameEnv x y z   = addToUFM x y z
103 extendNameEnvList x l = addListToUFM x l
104 lookupNameEnv x y     = lookupUFM x y
105 alterNameEnv          = alterUFM
106 mkNameEnv     l       = listToUFM l
107 elemNameEnv x y          = elemUFM x y
108 foldNameEnv a b c        = foldUFM a b c 
109 plusNameEnv x y          = plusUFM x y 
110 plusNameEnv_C f x y      = plusUFM_C f x y 
111 extendNameEnv_C f x y z  = addToUFM_C f x y z
112 mapNameEnv f x           = mapUFM f x
113 nameEnvUniqueElts x      = ufmToList x
114 extendNameEnv_Acc x y z a b  = addToUFM_Acc x y z a b
115 extendNameEnvList_C x y z = addListToUFM_C x y z
116 delFromNameEnv x y      = delFromUFM x y
117 delListFromNameEnv x y  = delListFromUFM x y
118 filterNameEnv x y       = filterUFM x y
119
120 lookupNameEnv_NF env n = expectJust "lookupNameEnv_NF" (lookupNameEnv env n)
121 \end{code}
122