ghc/compiler/basicTypes/VarSet.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section{@VarSet@: Variable sets}
   5
   6 \begin{code}
   7 module VarSet (
   8         VarSet, IdSet, TyVarSet,
   9         emptyVarSet, unitVarSet, mkVarSet,
  10         extendVarSet, extendVarSetList, extendVarSet_C,
  11         elemVarSet, varSetElems, subVarSet,
  12         unionVarSet, unionVarSets,
  13         intersectVarSet, intersectsVarSet,
  14         isEmptyVarSet, delVarSet, delVarSetList, delVarSetByKey,
  15         minusVarSet, foldVarSet, filterVarSet,
  16         lookupVarSet, mapVarSet, sizeVarSet, seqVarSet
  17     ) where
  18
  19 #include "HsVersions.h"
  20
  21 import Var              ( Var, Id, TyVar )
  22 import Unique           ( Unique )
  23 import UniqSet
  24 import UniqFM           ( delFromUFM_Directly, addToUFM_C )
  25 \end{code}
  26
  27 %************************************************************************
  28 %*                                                                      *
  29 \subsection{@VarSet@s}
  30 %*                                                                      *
  31 %************************************************************************
  32
  33 \begin{code}
  34 type VarSet       = UniqSet Var
  35 type IdSet        = UniqSet Id
  36 type TyVarSet     = UniqSet TyVar
  37
  38 emptyVarSet     :: VarSet
  39 intersectVarSet :: VarSet -> VarSet -> VarSet
  40 unionVarSet     :: VarSet -> VarSet -> VarSet
  41 unionVarSets    :: [VarSet] -> VarSet
  42 varSetElems     :: VarSet -> [Var]
  43 unitVarSet      :: Var -> VarSet
  44 extendVarSet    :: VarSet -> Var -> VarSet
  45 extendVarSetList:: VarSet -> [Var] -> VarSet
  46 elemVarSet      :: Var -> VarSet -> Bool
  47 delVarSet       :: VarSet -> Var -> VarSet
  48 delVarSetList   :: VarSet -> [Var] -> VarSet
  49 minusVarSet     :: VarSet -> VarSet -> VarSet
  50 isEmptyVarSet   :: VarSet -> Bool
  51 mkVarSet        :: [Var] -> VarSet
  52 foldVarSet      :: (Var -> a -> a) -> a -> VarSet -> a
  53 lookupVarSet    :: VarSet -> Var -> Maybe Var
  54                         -- Returns the set element, which may be
  55                         -- (==) to the argument, but not the same as
  56 mapVarSet       :: (Var -> Var) -> VarSet -> VarSet
  57 sizeVarSet      :: VarSet -> Int
  58 filterVarSet    :: (Var -> Bool) -> VarSet -> VarSet
  59 extendVarSet_C  :: (Var->Var->Var) -> VarSet -> Var -> VarSet
  60
  61 delVarSetByKey  :: VarSet -> Unique -> VarSet
  62
  63 emptyVarSet     = emptyUniqSet
  64 unitVarSet      = unitUniqSet
  65 extendVarSet    = addOneToUniqSet
  66 extendVarSetList= addListToUniqSet
  67 intersectVarSet = intersectUniqSets
  68
  69 intersectsVarSet:: VarSet -> VarSet -> Bool     -- True if non-empty intersection
  70         -- (s1 `intersectsVarSet` s2) doesn't compute s2 if s1 is empty
  71 subVarSet       :: VarSet -> VarSet -> Bool     -- True if first arg is subset of second
  72         -- (s1 `subVarSet` s2) doesn't compute s2 if s1 is empty
  73
  74 unionVarSet     = unionUniqSets
  75 unionVarSets    = unionManyUniqSets
  76 varSetElems     = uniqSetToList
  77 elemVarSet      = elementOfUniqSet
  78 minusVarSet     = minusUniqSet
  79 delVarSet       = delOneFromUniqSet
  80 delVarSetList   = delListFromUniqSet
  81 isEmptyVarSet   = isEmptyUniqSet
  82 mkVarSet        = mkUniqSet
  83 foldVarSet      = foldUniqSet
  84 lookupVarSet    = lookupUniqSet
  85 mapVarSet       = mapUniqSet
  86 sizeVarSet      = sizeUniqSet
  87 filterVarSet    = filterUniqSet
  88 extendVarSet_C combine s x = addToUFM_C combine s x x
  89 delVarSetByKey  = delFromUFM_Directly   -- Can't be bothered to add this to UniqSet
  90 \end{code}
  91
  92 \begin{code}
  93 -- See comments with type signatures
  94 intersectsVarSet s1 s2 = not (isEmptyVarSet (s1 `intersectVarSet` s2))
  95 a `subVarSet` b = isEmptyVarSet (a `minusVarSet` b)
  96 \end{code}
  97
  98 \begin{code}
  99 seqVarSet :: VarSet -> ()
 100 seqVarSet s = sizeVarSet s `seq` ()
 101 \end{code}
 102