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, UVarSet,
   9         emptyVarSet, unitVarSet, mkVarSet,
  10         extendVarSet, extendVarSet_C,
  11         elemVarSet, varSetElems, subVarSet,
  12         unionVarSet, unionVarSets,
  13         intersectVarSet, intersectsVarSet,
  14         isEmptyVarSet, delVarSet, delVarSetByKey,
  15         minusVarSet, foldVarSet, filterVarSet,
  16         lookupVarSet, mapVarSet, sizeVarSet, seqVarSet
  17     ) where
  18
  19 #include "HsVersions.h"
  20
  21 import Var              ( Var, Id, TyVar, UVar )
  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 type UVarSet      = UniqSet UVar
  38
  39 emptyVarSet     :: VarSet
  40 intersectVarSet :: VarSet -> VarSet -> VarSet
  41 intersectsVarSet:: VarSet -> VarSet -> Bool     -- True if non-empty intersection
  42 unionVarSet     :: VarSet -> VarSet -> VarSet
  43 unionVarSets    :: [VarSet] -> VarSet
  44 varSetElems     :: VarSet -> [Var]
  45 unitVarSet      :: Var -> VarSet
  46 extendVarSet    :: VarSet -> Var -> VarSet
  47 elemVarSet      :: Var -> VarSet -> Bool
  48 delVarSet       :: 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 subVarSet       :: VarSet -> VarSet -> Bool
  60 extendVarSet_C  :: (Var->Var->Var) -> VarSet -> Var -> VarSet
  61
  62 delVarSetByKey  :: VarSet -> Unique -> VarSet
  63
  64 emptyVarSet     = emptyUniqSet
  65 unitVarSet      = unitUniqSet
  66 extendVarSet    = addOneToUniqSet
  67 intersectVarSet = intersectUniqSets
  68 intersectsVarSet s1 s2 = not (isEmptyVarSet (s1 `intersectVarSet` s2))
  69 unionVarSet     = unionUniqSets
  70 unionVarSets    = unionManyUniqSets
  71 varSetElems     = uniqSetToList
  72 elemVarSet      = elementOfUniqSet
  73 minusVarSet     = minusUniqSet
  74 delVarSet       = delOneFromUniqSet
  75 isEmptyVarSet   = isEmptyUniqSet
  76 mkVarSet        = mkUniqSet
  77 foldVarSet      = foldUniqSet
  78 lookupVarSet    = lookupUniqSet
  79 mapVarSet       = mapUniqSet
  80 sizeVarSet      = sizeUniqSet
  81 filterVarSet    = filterUniqSet
  82 extendVarSet_C combine s x = addToUFM_C combine s x x
  83 a `subVarSet` b = isEmptyVarSet (a `minusVarSet` b)
  84 delVarSetByKey  = delFromUFM_Directly   -- Can't be bothered to add this to UniqSet
  85 \end{code}
  86
  87 \begin{code}
  88 seqVarSet :: VarSet -> ()
  89 seqVarSet s = sizeVarSet s `seq` ()
  90 \end{code}
  91