The cl-emacs-if Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-emacs-if Reference Manual

This is the cl-emacs-if Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:36:54 2022 GMT+0.

Table of Contents


1 Introduction

Description

Emacs-If is a small package that provides Emacs-like IF and WHILE statements for Common Lisp.

Recommended Usage:

(defpackage :my-package
  (:use :cl)
  (:shadowing-import-from :emacs-if :if :while))

(in-package :my-package)

(defun test-1 ()
  (if (oddp (random 100)) (print 'one)
    (print 'two)
    (print 'three))
  (values))
    
(defun test-2 ()
  (let ((n 10))
    (while (plusp n)
      (print (decf n)))
  (values)))

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-emacs-if

Provides Emacs-like IF and WHILE operators

Version

1.0

Source

cl-emacs-if.asd.

Child Component

emacs-if.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 cl-emacs-if/cl-emacs-if.asd

Source

cl-emacs-if.asd.

Parent Component

cl-emacs-if (system).

ASDF Systems

cl-emacs-if.


3.1.2 cl-emacs-if/emacs-if.lisp

Source

cl-emacs-if.asd.

Parent Component

cl-emacs-if (system).

Packages

emacs-if.

Public Interface

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 emacs-if

Source

emacs-if.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Macros

Macro: if (test then &body else)

Emacs like IF statement that allows multiple ELSE clauses

Package

emacs-if.

Source

emacs-if.lisp.

Macro: while (test &body body)

Emacs like WHILE loop statement. Just like other CL loops the body is wrapped into the BLOCK named NIL and a TAGBODY form

Package

emacs-if.

Source

emacs-if.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   I   M   W  
Index Entry  Section

I
if: Public macros

M
Macro, if: Public macros
Macro, while: Public macros

W
while: Public macros

Jump to:   I   M   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables