The cl-dsl Reference Manual

Table of Contents

The cl-dsl Reference Manual

This is the cl-dsl Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:43:39 2021 GMT+0.

1 Introduction

cl-dsl

Easily define domain specific languages.

    ;; define auxillary macros and functions
    MY-PACKAGE> (defmacro foo () ...)
    MY-PACKAGE> (defun bar () ...)
    ;; define a master-macro of your DSL
    MY-PACKAGE> (defmacro dsl (with-macrolets (foo) (with-flets (bar) ....)))
    ;; now it can be used like this, no need to explicitly import FOO
    CL-USER>    (my-package:dsl (foo 1 2 3))
    ;; Outside MY-PACKAGE:DSL FOO may well mean something else.
    CL-USER>    (foo "blah blah blah")

Domain specific language usually consists of a set of certain macros and functions. Usually almost all of these macros and functions make sense only when used inside a "master-macro" form (Characteristic example of this is ITERATE - domain specific language for iteration).

If one wants to deploy his newly written DSL as a package, one faces a problem: how to make all these symbols accessible in other packages.

There are several obvious choices:

• put all relevant symbols into :EXPORT array of DEFPACKAGE, and clobber the namespace of target package. Also, using your DSL will require :USE-ing your package.
• implement all the relevant macros and functions as MACROLETs and FLETs in the master macro. There is still some trouble with import of symbols in this approach, which can be cured by using MACROLET!'s and FLET!s from DEFMACRO-ENHANCE package. However, macros implemented as macrolets are much more harder to debug, since MACROEXPAND-1 does not work on them

This package provides third, I believe, smarter, choice. It exports two utility functions - WITH-MACROLETS and WITH-FLETS. Then you define your DSL as follows:

• implement all your auxillary macros and functions with DEFMACROs and DEFUNs in your package
• export only symbol for your main macro from your package
• in main macro use WITH-MACROLETS and WITH-FLETS to define macrolets and flets in the macro user's package which will expand into macros and functions in your package

2 Systems

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

2.1 cl-dsl

Author

Alexander Popolitov <popolit@gmail.com>

License

GPL

Description

Easily define domain specific languages

Version

0.1

Source

cl-dsl.asd (file)

Components

• package.lisp (file)
• cl-dsl.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-dsl.asd

Location

cl-dsl.asd

Systems

cl-dsl (system)

3.1.2 cl-dsl/package.lisp

Parent

cl-dsl (system)

Location

package.lisp

Packages

cl-dsl

3.1.3 cl-dsl/cl-dsl.lisp

Dependency

package.lisp (file)

Parent

cl-dsl (system)

Location

cl-dsl.lisp

Exported Definitions

• with-flets (function)
• with-macrolets (function)

4 Packages

Packages are listed by definition order.

4.1 cl-dsl

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• with-flets (function)
• with-macrolets (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: with-flets WOULD-BE-FLETS BODY

Package

cl-dsl

Source

cl-dsl.lisp (file)

Function: with-macrolets WOULD-BE-MACROLETS BODY

Package

cl-dsl

Source

cl-dsl.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types