Function: do*

do* is a for cl-do*, defined in cl-macs.el.gz.

This macro is obsolete since 27.1; use cl-do* instead.

Signature

(do* ((VAR INIT [STEP])...) (END-TEST [RESULT...]) BODY...)

Documentation

Bind variables and run BODY forms until END-TEST returns non-nil.

First, each VAR is bound to the associated INIT value as if by a let* form. Then, in each iteration of the loop, the END-TEST is evaluated; if true, the loop is finished. Otherwise, the BODY forms are evaluated, then each VAR is set to the associated STEP expression (as if by a setq form) and the next iteration begins.

Once the END-TEST becomes true, the RESULT forms are evaluated (with the VARs still bound to their values) to produce the result returned by cl-do*.

Note that the entire loop is enclosed in an implicit nil block, so that you can use cl-return to exit at any time.

Also note that END-TEST is checked before evaluating BODY. If END-TEST is initially non-nil, cl-do* will exit without running BODY.

This is to cl-do what let* is to let. For more details, see cl-do* description in Info node (cl) Iteration.

Aliases

do* (obsolete since 27.1)