X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=compiler%2FbasicTypes%2FBasicTypes.lhs;h=8fcf5ca77725bb6f72154964c62eb8be229e6d4d;hb=6084fb5517da34f65034370a3695e2af3b85ce2b;hp=f782da3e96751b808114c1fe28b9421a31070e66;hpb=cae75f82226638691cfa1e85fc168f4b65ddce4d;p=ghc-hetmet.git

diff --git a/compiler/basicTypes/BasicTypes.lhs b/compiler/basicTypes/BasicTypes.lhs
index f782da3..8fcf5ca 100644
--- a/compiler/basicTypes/BasicTypes.lhs
+++ b/compiler/basicTypes/BasicTypes.lhs
@@ -30,6 +30,8 @@ module BasicTypes(
 
 	RecFlag(..), isRec, isNonRec, boolToRecFlag,
 
+	RuleName,
+
 	TopLevelFlag(..), isTopLevel, isNotTopLevel,
 
 	OverlapFlag(..), 
@@ -129,6 +131,15 @@ instance Outputable name => Outputable (IPName name) where
     ppr (IPName n) = char '?' <> ppr n -- Ordinary implicit parameters
 \end{code}
 
+%************************************************************************
+%*									*
+		Rules
+%*									*
+%************************************************************************
+
+\begin{code}
+type RuleName = FastString
+\end{code}
 
 %************************************************************************
 %*									*
@@ -372,17 +383,20 @@ the base of the module hierarchy.  So it seemed simpler to put the
 defn of OccInfo here, safely at the bottom
 
 \begin{code}
+-- | Identifier occurrence information
 data OccInfo 
-  = NoOccInfo		-- Many occurrences, or unknown
+  = NoOccInfo		-- ^ There are many occurrences, or unknown occurences
 
-  | IAmDead		-- Marks unused variables.  Sometimes useful for
+  | IAmDead		-- ^ Marks unused variables.  Sometimes useful for
 			-- lambda and case-bound variables.
 
-  | OneOcc		-- Occurs exactly once, not inside a rule
+  | OneOcc
 	!InsideLam
  	!OneBranch
-	!InterestingCxt
+	!InterestingCxt -- ^ Occurs exactly once, not inside a rule
 
+  -- | This identifier breaks a loop of mutually recursive functions. The field
+  -- marks whether it is only a loop breaker due to a reference in a rule
   | IAmALoopBreaker	-- Note [LoopBreaker OccInfo]
 	!RulesOnly	-- True <=> This is a weak or rules-only loop breaker
 			--  	    See OccurAnal Note [Weak loop breakers]