Changeset 3904 for src/Pugs/Monads.hs

Timestamp:

05/26/05 11:56:40 (4 years ago)

Author:

scook0

svk:copy_cache_prev:

5482

Message:

* Haddocks for Internals.hs
* Renamed 'enterLoop' to 'enterWhile'

Files:

• src/Pugs/Monads.hs (modified) (2 diffs)

src/Pugs/Monads.hs

@@ -92 +92 @@
         }
 
-enterLoop :: Eval Val -> Eval Val
-enterLoop action = genSymCC "&last" $ \symLast -> do
+{-|
+Bind @&last@ and @&next@ to subs that respectively break-out-of and repeat the 
+@while@\/@until@, then perform the given evaluation in the new lexical scope.
+
+Note that this function is /not/ responsible for performing the actual
+@while@\/@until@ test; it is the responsibility of the caller to add such a
+test to the top of the body evaluation.
+-}
+enterWhile :: Eval Val -- ^ Evaluation representing loop test & body
+           -> Eval Val
+enterWhile action = genSymCC "&last" $ \symLast -> do
     genSymPrim "&next" (const action) $ \symNext -> do
         enterLex [symLast, symNext] action
@@ -231 +240 @@
         } ]
 
+-- | (This doesn't seem to be used at the moment...)
 caller :: Int -> Eval Env
 caller n = do