The cl-emacs-if Reference Manual

Table of Contents

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 2.4 "Will Decker" on Wed Jun 20 11:04:16 2018 GMT+0.


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

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)))

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

2 Systems

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


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

2.1 cl-emacs-if

Description

Provides Emacs-like IF and WHILE operators

Version

1.0

Source

cl-emacs-if.asd (file)

Component

emacs-if.lisp (file)


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

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 files   [Contents][Index]

3.1.1 cl-emacs-if.asd

Location

cl-emacs-if.asd

Systems

cl-emacs-if (system)


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

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

Parent

cl-emacs-if (system)

Location

emacs-if.lisp

Packages

emacs-if

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 emacs-if

Source

emacs-if.lisp (file)

Use List

common-lisp

Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

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 (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-emacs-if.asd: The cl-emacs-if<dot>asd file
cl-emacs-if/emacs-if.lisp: The cl-emacs-if/emacs-if<dot>lisp file

F
File, Lisp, cl-emacs-if.asd: The cl-emacs-if<dot>asd file
File, Lisp, cl-emacs-if/emacs-if.lisp: The cl-emacs-if/emacs-if<dot>lisp file

L
Lisp File, cl-emacs-if.asd: The cl-emacs-if<dot>asd file
Lisp File, cl-emacs-if/emacs-if.lisp: The cl-emacs-if/emacs-if<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   I   M   W  
Index Entry  Section

I
if: Exported macros

M
Macro, if: Exported macros
Macro, while: Exported macros

W
while: Exported macros

Jump to:   I   M   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   E   P   S  
Index Entry  Section

C
cl-emacs-if: The cl-emacs-if system

E
emacs-if: The emacs-if package

P
Package, emacs-if: The emacs-if package

S
System, cl-emacs-if: The cl-emacs-if system

Jump to:   C   E   P   S