From: Olof-Joachim Frahm <olof@macrolet.net>
Date: Mon, 22 Dec 2014 13:26:39 +0000 (+0000)
Subject: Explain `CALL-PREVIOUS` and `*PREVIOUS*`.
X-Git-Tag: 1.0.1~4
X-Git-Url: http://repo.macrolet.net/gitweb/?p=cl-mock.git;a=commitdiff_plain;h=ea8abfa292363629e99e052cf21a0bfcd64d6ea1

Explain `CALL-PREVIOUS` and `*PREVIOUS*`.
---

diff --git a/README.md b/README.md
index 72316e8..718ee99 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,9 @@ dynamic function rebinding):
 
     > (declaim (notinline foo bar))
     > (defun foo () 'foo)
-    > (defun bar () 'bar)
+    > (defun bar (&rest args)
+    >   (declare (ignore args))
+    >   'bar)
     > (with-mocks ()
     >   (answer (foo 1) 42)
     >   (answer foo 23)
@@ -78,6 +80,21 @@ function call will fail and that error is propagated upwards.
 the list, which (as of now) isn't available via `ANSWER` (and should be
 treated as subject to change anyway).
 
+Should you wish to run the previously defined function, use the function
+`CALL-PREVIOUS`.  If no arguments are passed it will use the current
+arguments from `*ARGUMENTS*`, if any.  Otherwise it will be called with
+the passed arguments instead.  For cases where explicitely calling it
+with no arguments is necessary, using `(funcall *previous*)` is still
+possible as well.
+
+    > (with-mocks ()
+    >   (answer foo `(was originally ,(funcall *previous*)))
+    >   (answer bar `(was originally ,(call-previous)))
+    >   (values
+    >    (foo "hello")
+    >    (bar "hello")))
+    > => (WAS ORIGINALLY FOO) (WAS ORIGINALLY BAR)
+
 The function `INVOCATIONS` may be used to retrieve all recorded
 invocations of mocks (so far); the optional argument can be used to
 filter for a particular name:
diff --git a/src/package.lisp b/src/package.lisp
index e2725b3..8c92929 100644
--- a/src/package.lisp
+++ b/src/package.lisp
@@ -15,6 +15,8 @@
    #:dflet
 
    ;; mocking of regular functions
+   #:*previous*
+   #:*arguments*
    #:call-previous
    #:register-mock
    #:invocations