Formatting.

[cl-mock.git] / README.md

diff --git a/README.md b/README.md
index 2a0e10b..ad9bcb6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,4 +18,55 @@ Some parts may be used independently of the testing facilities,
 e.g. dynamic `FLET` and method bindings with `PROGM` may be of general
 interest.
 
+
+# GENERIC FUNCTIONS
+
+Since behaviour isn't bound to classes, but to generic functions,
+creating new classes on the fly isn't particularly interesting.
+
+We provide the form `PROGM` to bind a number of methods during the
+execution of its contained body:
+
+    > (progm
+    >     '((baz NIL (list)))
+    >     '((lambda (list) list))
+    >   ...)
+
+For example:
+
+    > (defclass foo () ())
+    > (defgeneric baz (foo)
+        (:method ((foo foo))
+          42))
+    > (progm '((baz NIL (list)))
+             '((lambda (list) list))
+        (values (baz (make-instance 'foo)) (baz '(1 2 3))))
+    > => 42
+    > => (1 2 3)
+
+
+# UTILITIES
+
+`DFLET` dynamically rebinds functions similar to `FLET`:
+
+    > (defun foo () 42)
+    > (defun bar () (foo))
+    > (bar)
+    > => 42
+    > (dflet ((foo () 23))
+    >   (bar))
+    > => 23
+    > (OR) => 42, if FOO was inlined
+
+The caveat is that this might not work on certain optimization settings,
+including inlining.
+
+The underlying function `PROGF` may be used as well similarly to standard
+`PROG`:
+
+    > (progf '(foo) (list (lambda () 23))
+    >   (bar))
+    > => 23
+    > (OR) => 42, if FOO was inlined
+
 [1]: http://common-lisp.net/project/closer/closer-mop.html