README.md

   1 <!-- -*- mode: markdown; coding: utf-8; -*- -->
   2
   3 COUNTED-FEATURE-TESTS - Numeric prefix for standard CL #+ and #- reader
   4 macros.
   5
   6 Copyright (C) 2012 Olof-Joachim Frahm
   7
   8 Released as Public Domain.  Uses two definitions from SBCL:
   9
  10     ;;;; This software is part of the SBCL system. See the README file for
  11     ;;;; more information.
  12     ;;;;
  13     ;;;; This software is derived from the CMU CL system, which was
  14     ;;;; written at Carnegie Mellon University and released into the
  15     ;;;; public domain. The software is in the public domain and is
  16     ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
  17     ;;;; files for more information.
  18
  19 Uses fiveam for defining tests.
  20
  21 # USAGE
  22
  23 Uses same semantics as CLSQLs reader macros:  Use
  24 `ENABLE-COUNTED-FEATURE-TESTS-SYNTAX` to enable and `DISABLE-` to
  25 disable the syntax.  `LOCALLY-ENABLE-` / `LOCALLY-DISABLE-` to switch
  26 until `RESTORE-COUNTED-FEATURE-TESTS-SYNTAX` is called.
  27 `FILE-ENABLE-COUNTED-FEATURE-TESTS-SYNTAX` to enable it just for a
  28 single file.
  29
  30 The syntax enables a numeric prefix to the `#+` and `#-` (sharp-sign
  31 plus and minus) reader macros (positive of course), so that those skip
  32 that exact number of next forms.  This helps e.g. during ASDF
  33 definitions, feature-dependent keyword arguments and so on.
  34
  35 # EXAMPLES
  36
  37     ;; (list #2+(or)
  38     ;;       :a-keyword-argument and-its-value
  39     ;;       'other 'stuff)
  40     ;; => (OTHER STUFF)
  41
  42     ;; #0+is 'useless
  43     ;; => USELESS
  44
  45     ;; #+(and) 42
  46     ;; OR #1+(and) 42
  47     ;; => 42