doplus

2021-10-21

DO+ (doplus) is a high-level, extensible iteration construct for Common Lisp with a reasonably simple implementation, which in particular does not use a code walker.

Upstream URL

github.com/alessiostalla/doplus

Author

Alessio Stalla <alessiostalla@gmail.com>

License

GPLv3
README
Provided Systems

Doplus

doplus (written DO+) is an iteration macro for Common Lisp. I wrote it because:

  • I want to code in Lisp, not in Pascal (LOOP, I'm looking at you!)
  • Code-walkers are overkill, iteration should not require one (iterate, WTF?).

Overview and main features

We can think of doplus as a higher-level DSL over CL:DO [*]. In spirit it's similar to iterate, but having implementation simplicity as a core goal, its syntax is necessarily a bit different to accomodate the lack of a code walker that can freely move pieces of code around. Also, doplus generally requires the user to be a bit more explicit than both LOOP and iterate.

doplus, like iterate, is meant to be extensible by simply writing macros. By contrast, LOOP is not portably extensible, and on those implementations where it is, it's not trivial to extend it. Most macros that extend doplus can be written combining built-in operators and producing code in doplus syntax, just like a user might have written it. This makes many possible doplus extensions very readable.

doplus is fully understood by SLIME, since it uses regular macros and defines dummy top-level macros for its body-local macrolets, to make symbol completion available for them as well.

doplus is, to my knowledge, the only advanced iteration construct in Lisp to support atomic initialization and stepping of iteration variables. Refer to the manual section Initialization and stepping for more information.

[*] doplus used to be actually written on top of cl:do*, but has been rewritten using lower-level constructs to have more control on the various steps of iteration.

Getting Started

You can find doplus on Quicklisp.

The manual is on a separate page.

Licensing

doplus is distributed under the GPLv3 license; if you'd like a different license arrangement, please contact me. I'm very open about providing friendlier licenses to individuals and companies that I trust, but by default I won't allow complete strangers to profit from my code without giving anything back.

Test Suite

To run the test suite, load the system :doplus-tests after loading :doplus itself. To rerun the test suite after :doplus-tests has been loaded, evaluate the form (doplus-tests:run-all-tests).

Further Information

The home of doplus is https://github.com/alessiostalla/doplus. There you can find in-depth documentation, access the code repository and checkout the latest version.

Dependencies (2)

  • fset
  • parse-declarations

Dependents (1)

  • GitHub
  • Quicklisp