The lisp-preprocessor Reference Manual

Table of Contents

The lisp-preprocessor Reference Manual

This is the lisp-preprocessor Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:54:35 2021 GMT+0.

1 Introduction

Lisp Preprocessor

Common Lisp embedded template engine

Usage

input

#include <stdio.h>

int main(void) {
    #{ :indent
    (loop :for i :from 0 :below 10
          :do (format t "printf(\"Loop: %d\", ~D);~%" i)) #}
    return 0;
}

compile

(lisp-preprocessor:run-template-into-file #p"input" #p"output")

output

#include <stdio.h>

int main(void) {
    printf("Loop: %d", 0);
    printf("Loop: %d", 1);
    printf("Loop: %d", 2);
    printf("Loop: %d", 3);
    printf("Loop: %d", 4);
    printf("Loop: %d", 5);
    printf("Loop: %d", 6);
    printf("Loop: %d", 7);
    printf("Loop: %d", 8);
    printf("Loop: %d", 9);
    return 0;
}

API

(run-template-into-stream compiland stream &rest arguments)

(run-template-into-string compiland &rest arguments)

(run-template-into-file compiland file &rest arguments)

(let ((compiland (compile-template "#{ (princ (string-capitalize $arg)) #}" :arguments '($arg))))
  (run-template-into-string compiland "test"))
; => "Test"

compiland is a string or pathname, or a compiled template function.

(compile-template text &key template-begin template-begin arguments)

* (compile-template "foo #{ (princ \"bar\") #} baz") ; => #<FUNCTION (LAMBDA (#:STREAM)) {...}>
* (run-template-into-stream * *standard-output*)
foo bar baz

* (compile-template "foo {{{ (princ \"bar\" }}} baz" :template-begin "{{{" :template-end "}}}")
* (run-template-into-stream * *standard-output*)
foo bar baz

* (run-template-into-stream (compile-template "#{ (princ (list ? ??)) #}" :arguments '(? ??)) *standard-output* "foo" "bar")
(foo bar)

Syntax

#{ template #}

indent

Keep indentation of start position

#{ :indent [offset]
...
#}

// input
int main(void) {
    #{ :indent
    (loop :for i :from 0 :below 10
          :do (format t "printf(\"Loop: %d\", ~D);~%" i)) #}
    return 0;
}

// output
int main(void) {
    printf("Loop: %d", 0);
    printf("Loop: %d", 1);
    printf("Loop: %d", 2);
    printf("Loop: %d", 3);
    printf("Loop: %d", 4);
    printf("Loop: %d", 5);
    printf("Loop: %d", 6);
    printf("Loop: %d", 7);
    printf("Loop: %d", 8);
    printf("Loop: %d", 9);
    return 0;
}

chop

Chop whitespace before and after the template

#{ :chop #}

;;; input
(defun foo (#{ (format t "~{~(~A~)~^ ~}" (loop :for symbol :in '(a b c) :collect symbol)) #}
            #{ :chop #}
            #{ (format t " ~{~(~A~)~^ ~}" (loop :for symbol :in '(x y z) :collect symbol)) #})
  (values a b c x y z))

;;; output
(defun foo (a b c x y z)
  (values a b c x y z))

License

MIT

2 Systems

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

2.1 lisp-preprocessor

Author

cxxxr

License

MIT

Description

Common Lisp embedded template engine

Dependencies

• alexandria
• split-sequence
• trivial-gray-streams
• trivia
• cl-ppcre

Source

lisp-preprocessor.asd (file)

Components

• packages.lisp (file)
• stream.lisp (file)
• lisp-preprocessor.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 lisp-preprocessor.asd

Location

lisp-preprocessor.asd

Systems

lisp-preprocessor (system)

3.1.2 lisp-preprocessor/packages.lisp

Parent

lisp-preprocessor (system)

Location

packages.lisp

Packages

• lisp-preprocessor.in-template
• lisp-preprocessor
• lisp-preprocessor.stream

3.1.3 lisp-preprocessor/stream.lisp

Dependency

packages.lisp (file)

Parent

lisp-preprocessor (system)

Location

stream.lisp

Exported Definitions

• emitter (class)
• with-indent (macro)

Internal Definitions

• +tab-width+ (special variable)
• add-character-width (function)
• call-with-indent (function)
• emitter-column (method)
• (setf emitter-column) (method)
• emitter-indent (method)
• (setf emitter-indent) (method)
• emitter-stream (method)

3.1.4 lisp-preprocessor/lisp-preprocessor.lisp

Dependency

stream.lisp (file)

Parent

lisp-preprocessor (system)

Location

lisp-preprocessor.lisp

Exported Definitions

• *in-template-package* (special variable)
• compile-template (function)
• run-template-into-file (function)
• run-template-into-stream (function)
• run-template-into-string (function)
• with-indent (macro)

Internal Definitions

• *template-begin* (special variable)
• *template-end* (special variable)
• +whitespaces+ (special variable)
• begin+ (function)
• blank-line-p (function)
• chop-in-forms (function)
• compute-column (function)
• empty-string-p (function)
• end+ (function)
• end-of-line-p (function)
• ensure-compiled-template (function)
• invoke-with-indent (function)
• load-template (function)
• read-template-form (function)
• reintern-symbol (function)

4 Packages

Packages are listed by definition order.

4.1 lisp-preprocessor.in-template

Source

packages.lisp (file)

Use List

• split-sequence
• alexandria
• common-lisp

Exported Definitions

with-indent (macro)

Internal Definitions

invoke-with-indent (function)

4.2 lisp-preprocessor

Source

packages.lisp (file)

Use List

• split-sequence
• alexandria
• common-lisp

Exported Definitions

• *in-template-package* (special variable)
• compile-template (function)
• run-template-into-file (function)
• run-template-into-stream (function)
• run-template-into-string (function)

Internal Definitions

• *template-begin* (special variable)
• *template-end* (special variable)
• +whitespaces+ (special variable)
• begin+ (function)
• blank-line-p (function)
• chop-in-forms (function)
• compute-column (function)
• empty-string-p (function)
• end+ (function)
• end-of-line-p (function)
• ensure-compiled-template (function)
• load-template (function)
• read-template-form (function)
• reintern-symbol (function)

4.3 lisp-preprocessor.stream

Source

packages.lisp (file)

Use List

• trivial-gray-streams
• common-lisp

Exported Definitions

• emitter (class)
• with-indent (macro)

Internal Definitions

• +tab-width+ (special variable)
• add-character-width (function)
• call-with-indent (function)
• emitter-column (generic function)
• emitter-column (method)
• (setf emitter-column) (method)
• (setf emitter-column) (generic function)
• emitter-indent (generic function)
• emitter-indent (method)
• (setf emitter-indent) (method)
• (setf emitter-indent) (generic function)
• emitter-stream (generic function)
• emitter-stream (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *in-template-package*

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

5.1.2 Macros

Macro: with-indent INDENT &body BODY

Package

lisp-preprocessor.in-template

Source

lisp-preprocessor.lisp (file)

Macro: with-indent EMITTER INDENT &body BODY

Package

lisp-preprocessor.stream

Source

stream.lisp (file)

5.1.3 Functions

Function: compile-template STRING-OR-PATHNAME &key (TEMPLATE-BEGIN *TEMPLATE-BEGIN*) (TEMPLATE-END *TEMPLATE-END*) (IN-TEMPLATE-PACKAGE *IN-TEMPLATE-PACKAGE*) ARGUMENTS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: run-template-into-file COMPILAND FILE &rest ARGUMENTS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: run-template-into-stream COMPILAND STREAM &rest ARGUMENTS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: run-template-into-string COMPILAND &rest ARGUMENTS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

5.1.4 Classes

Class: emitter ()

Package

lisp-preprocessor.stream

Source

stream.lisp (file)

Direct superclasses

fundamental-output-stream (class)

Direct methods

• stream-line-column (method)
• stream-fresh-line (method)
• stream-write-string (method)
• stream-write-char (method)
• stream-element-type (method)
• emitter-stream (method)
• emitter-indent (method)
• emitter-indent (method)
• emitter-column (method)
• emitter-column (method)

Direct slots

Slot: column

Initform

0

Readers

emitter-column (generic function)

Writers

(setf emitter-column) (generic function)

Slot: indent

Initform

0

Readers

emitter-indent (generic function)

Writers

(setf emitter-indent) (generic function)

Slot: stream

Initargs

:stream

Initform

*standard-output*

Readers

emitter-stream (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *template-begin*

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Special Variable: *template-end*

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Special Variable: +tab-width+

Package

lisp-preprocessor.stream

Source

stream.lisp (file)

Special Variable: +whitespaces+

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

5.2.2 Functions

Function: add-character-width CHARACTER COLUMN

Package

lisp-preprocessor.stream

Source

stream.lisp (file)

Function: begin+ POS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: blank-line-p TEXT POS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: call-with-indent EMITTER INDENT FUNCTION

Package

lisp-preprocessor.stream

Source

stream.lisp (file)

Function: chop-in-forms FORMS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: compute-column TEXT POS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: empty-string-p STRING

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: end+ POS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: end-of-line-p TEXT POS

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: ensure-compiled-template COMPILAND

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: invoke-with-indent INDENT FUNCTION

Package

lisp-preprocessor.in-template

Source

lisp-preprocessor.lisp (file)

Function: load-template STRING-OR-PATHNAME

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: read-template-form STREAM TEXT COLUMN

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

Function: reintern-symbol SYMBOL

Package

lisp-preprocessor

Source

lisp-preprocessor.lisp (file)

5.2.3 Generic functions

Generic Function: emitter-column OBJECT

Generic Function: (setf emitter-column) NEW-VALUE OBJECT

Package

lisp-preprocessor.stream

Methods

Method: emitter-column (EMITTER emitter)

automatically generated reader method

Source

stream.lisp (file)

Method: (setf emitter-column) NEW-VALUE (EMITTER emitter)

automatically generated writer method

Source

stream.lisp (file)

Generic Function: emitter-indent OBJECT

Generic Function: (setf emitter-indent) NEW-VALUE OBJECT

Package

lisp-preprocessor.stream

Methods

Method: emitter-indent (EMITTER emitter)

automatically generated reader method

Source

stream.lisp (file)

Method: (setf emitter-indent) NEW-VALUE (EMITTER emitter)

automatically generated writer method

Source

stream.lisp (file)

Generic Function: emitter-stream OBJECT

Package

lisp-preprocessor.stream

Methods

Method: emitter-stream (EMITTER emitter)

automatically generated reader method

Source

stream.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types