From: simonpj@microsoft.com <unknown>
Date: Thu, 11 Jan 2007 09:10:03 +0000 (+0000)
Subject: Add comments about invariants
X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=899fd7fb59cedf25b3939f951016f0c8b5d1541a

Add comments about invariants
---

diff --git a/compiler/types/InstEnv.lhs b/compiler/types/InstEnv.lhs
index b8e10d5..7d131d4 100644
--- a/compiler/types/InstEnv.lhs
+++ b/compiler/types/InstEnv.lhs
@@ -54,11 +54,14 @@ data Instance
   = Instance { is_cls  :: Name		-- Class name
 	
 		-- Used for "rough matching"; see note below
+		-- INVARIANT: is_tcs = roughMatchTcs is_tys
 	     , is_tcs  :: [Maybe Name]	-- Top of type args
 
 		-- Used for "proper matching"; see note
 	     , is_tvs  :: TyVarSet	-- Template tyvars for full match
 	     , is_tys  :: [Type]	-- Full arg types
+		-- INVARIANT: is_dfun Id has type 
+		--	forall is_tvs. (...) => is_cls is_tys
 
 	     , is_dfun :: DFunId
 	     , is_flag :: OverlapFlag	-- See detailed comments with
@@ -88,7 +91,7 @@ In is_tcs,
 
 The "proper-match" fields
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-The is_tvs, is_tys fields are simply cahced values, pulled
+The is_tvs, is_tys fields are simply cached values, pulled
 out (lazily) from the dfun id. They are cached here simply so 
 that we don't need to decompose the DFunId each time we want 
 to match it.  The hope is that the fast-match fields mean