The cl-m4 Reference Manual

4.1.1 cl-m4/cl-m4.asd

Source

cl-m4.asd.

Parent Component

cl-m4 (system).

ASDF Systems

cl-m4.

Packages

cl-m4-system.

---

4.1.2 cl-m4/src/package.lisp

Source

cl-m4.asd.

Parent Component

src (module).

Packages

• cffi-regex.
• cl-m4.

---

4.1.3 cl-m4/src/cffi-regex/cffi-regex-grovel.lisp

Source

cl-m4.asd.

Parent Component

cffi-regex (module).

---

4.1.4 cl-m4/src/cffi-regex/cffi-regex.lisp

Dependency

cffi-regex-grovel.lisp (file).

Source

cl-m4.asd.

Parent Component

cffi-regex (module).

Internals

• %regex-match (function).
• %regex-match-2 (function).
• %regex-search (function).
• %regex-search-2 (function).
• %regex-set-registers (function).
• compile-fastmap (function).
• compile-pattern (function).
• registers-tclass (class).
• set-syntax (function).

---

4.1.5 cl-m4/src/cffi-regex/regex.lisp

Dependency

cffi-regex.lisp (file).

Source

cl-m4.asd.

Parent Component

cffi-regex (module).

Public Interface

• print-object (method).
• regex-compilation-failure (condition).
• regex-internal-error (condition).
• regex-match (function).
• regex-search (function).
• regex-search-all (function).

Internals

• get-register (function).
• regex-compilation-failure-message (reader method).
• with-pattern-buffer (macro).

---

4.1.6 cl-m4/src/m4-util.lisp

Dependency

package.lisp (file).

Source

cl-m4.asd.

Parent Component

src (module).

Internals

• *m4-comment-end* (special variable).
• *m4-comment-start* (special variable).
• *m4-diversion* (special variable).
• *m4-diversion-table* (special variable).
• *m4-include-path* (special variable).
• *m4-lib* (special variable).
• *m4-macro-hooks* (special variable).
• *m4-macro-name* (special variable).
• *m4-nesting-level* (special variable).
• *m4-nesting-limit* (special variable).
• *m4-parse-column* (special variable).
• *m4-parse-row* (special variable).
• *m4-quote-end* (special variable).
• *m4-quote-start* (special variable).
• *m4-runtime-lib* (special variable).
• *m4-traced-macros* (special variable).
• *m4-wrap-stack* (special variable).
• copy-macro-token (function).
• expand-ascii-ranges (function).
• expand-macro-token (function).
• flush-m4-diversions (function).
• m4-diversion (function).
• m4-macro (function).
• m4-quote-string (function).
• m4-regex-replace (function).
• m4-regex-replace-all (function).
• m4-trace-out (function).
• m4-warn (function).
• macro-condition (condition).
• macro-defn-invocation-condition (condition).
• macro-defn-invocation-result (reader method).
• macro-dnl-invocation-condition (condition).
• macro-invocation-condition (condition).
• macro-invocation-result (reader method).
• macro-nesting-level-excession-condition (condition).
• macro-return (function).
• macro-token (structure).
• macro-token-m4macro (reader).
• (setf macro-token-m4macro) (writer).
• macro-token-name (reader).
• (setf macro-token-name) (writer).
• macro-token-p (function).
• make-m4-diversion-table (function).
• make-macro-token (function).
• nesting-level-limit (reader method).
• quote-regexp (function).
• replace-with-region (function).
• sanitize-m4-regex-replacement (function).
• set-m4-diversion (function).
• translate (function).
• unquote-regexp (function).
• with-m4-diversion-stream (macro).
• with-m4-lib (macro).
• with-regex-search-handler (macro).

---

4.1.7 cl-m4/src/m4-lexer.lisp

Dependency

package.lisp (file).

Source

cl-m4.asd.

Parent Component

src (module).

Public Interface

stream-read-token (method).

Internals

• m4-input-stream (class).
• m4-macro-stack (reader method).
• (setf m4-macro-stack) (writer method).
• m4-pop-macro (generic function).
• m4-push-macro (generic function).

---

4.1.8 cl-m4/src/m4-builtin.lisp

Dependencies

• package.lisp (file).
• m4-util.lisp (file).

Source

cl-m4.asd.

Parent Component

src (module).

Internals

• defm4macro (macro).
• defm4runtimemacro (function).
• popm4macro (function).
• pushm4macro (function).

---

4.1.9 cl-m4/src/m4-parser.lisp

Dependencies

• package.lisp (file).
• m4-util.lisp (file).
• m4-lexer.lisp (file).

Source

cl-m4.asd.

Parent Component

src (module).

Public Interface

process-m4 (function).

Internals

• call-m4-macro (function).
• m4-out (function).
• m4-parse-error (condition).
• m4-parse-error-column (reader method).
• m4-parse-error-message (reader method).
• m4-parse-error-row (reader method).
• parse-m4 (function).
• parse-m4-comment (function).
• parse-m4-dnl (function).
• parse-m4-macro (function).
• parse-m4-macro-arguments (function).
• parse-m4-munch-whitespace (function).
• parse-m4-quote (function).
• split-merge (function).
• with-tokens-active (macro).

---

6.1.1 Ordinary functions

Function: process-m4 (input-stream output-stream &key include-path prepend-include-path trace-functions nesting-limit) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: regex-match (regex target-string &optional start) ¶

regex-match regex target-string &optional (start 0) => incomplete

Package

cffi-regex.

Source

regex.lisp.

Function: regex-search (regex target-string &key start end) ¶

regex-search regex target-string &key (start 0) (end (length target-string)) => (startpos registers)

High-level interface to libc regex re_search. Match REGEX against region between
START and END of TARGET-STRING returning STARTPOS of the first match and
SIMPLE-VECTOR REGISTERS containing LISTs of register group STARTs and ENDs. The
first register always contains the match of the whole REGEX.
If no part of TARGET-STRING matches, nil is return.
In case of a libc internal error signal a REGEX-INTERNAL-ERROR condition.

Package

cffi-regex.

Source

regex.lisp.

Function: regex-search-all (regex target-string &key start end) ¶

regex-search-all regex target-string &key (start 0) (end (length target-string)) => list

Multi-version of REGEX-SEARCH that evaluates to a list of all (STARTPOS
REGISTERS) matches of REGEX in TARGET-STRING.

Package

cffi-regex.

Source

regex.lisp.

---

6.1.2 Standalone methods

Method: print-object ((condition regex-compilation-failure) stream) ¶

Source

regex.lisp.

Method: stream-read-token :around ((stream m4-input-stream) &optional peek) ¶

Package

graylex.

Source

m4-lexer.lisp.

---

6.1.3 Conditions

Condition: regex-compilation-failure ¶

Package

cffi-regex.

Source

regex.lisp.

Direct superclasses

error.

Direct methods

• print-object.
• regex-compilation-failure-message.

Direct slots

Slot: message ¶

Initargs

:message

Readers

regex-compilation-failure-message.

Writers

This slot is read-only.

Condition: regex-internal-error ¶

Package

cffi-regex.

Source

regex.lisp.

Direct superclasses

error.

---

6.2.1 Special variables

Special Variable: *m4-comment-end* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-comment-start* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-diversion* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-diversion-table* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-include-path* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-lib* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-macro-hooks* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-macro-name* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-nesting-level* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-nesting-limit* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-parse-column* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-parse-row* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-quote-end* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-quote-start* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-runtime-lib* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-traced-macros* ¶

Package

cl-m4.

Source

m4-util.lisp.

Special Variable: *m4-wrap-stack* ¶

Package

cl-m4.

Source

m4-util.lisp.

---

6.2.2 Macros

Macro: defm4macro (name args (&key arguments-only minimum-arguments accept-macro-tokens) &body body) ¶

Package

cl-m4.

Source

m4-builtin.lisp.

Macro: with-m4-diversion-stream ((var &optional number) &body body) ¶

Package

cl-m4.

Source

m4-util.lisp.

Macro: with-m4-lib (&body body) ¶

Package

cl-m4.

Source

m4-util.lisp.

Macro: with-pattern-buffer ((var pattern &optional syntax) &body body) ¶

with-pattern-buffer var pattern &optional (syntax (list +syntax-emacs+))) &body body => context

Create lexical context binding VAR to a compiled libc regex PATTERN-BUFFER (re_pattern_buffer) with dynamic allocation and SYNTAX.
In case of REGEX compilation failure a REGEX-COMPILATION-FAILURE condition
containing the original error message is signaled.

Package

cffi-regex.

Source

regex.lisp.

Macro: with-regex-search-handler (regexp &body body) ¶

Package

cl-m4.

Source

m4-util.lisp.

Macro: with-tokens-active ((&rest tokens) &body body) ¶

Package

cl-m4.

Source

m4-parser.lisp.

---

6.2.3 Ordinary functions

Function: %regex-match (buffer string length start registers) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: %regex-match-2 (buffer string1 length1 string2 length2 start range registers stop) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: %regex-search (buffer string length start range registers) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: %regex-search-2 (buffer string1 length1 string2 length2 start range registers stop) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: %regex-set-registers (buffer registers num-regs starts ends) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: call-m4-macro (macro macro-name args lexer) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: compile-fastmap (buffer) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: compile-pattern (pattern length buffer) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: copy-macro-token (instance) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: defm4runtimemacro (name expansion &optional replace) ¶

Package

cl-m4.

Source

m4-builtin.lisp.

Function: expand-ascii-ranges (string) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: expand-macro-token (token) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: flush-m4-diversions (&rest diversions) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: get-register (registers index) ¶

get-register registers index => (start end)

Return START and END of register match # INDEX in libc regex REGISTERS (re_registers).

Package

cffi-regex.

Source

regex.lisp.

Function: m4-diversion (&optional number) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: m4-macro (macro &optional builtin) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: m4-out (word) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: m4-quote-string (string) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: m4-regex-replace (template string registers) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: m4-regex-replace-all (template string register-list) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: m4-trace-out (macro args result) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: m4-warn (datum) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: macro-return (result) ¶

Package

cl-m4.

Source

m4-util.lisp.

Reader: macro-token-m4macro (instance) ¶

Writer: (setf macro-token-m4macro) (instance) ¶

Package

cl-m4.

Source

m4-util.lisp.

Target Slot

m4macro.

Reader: macro-token-name (instance) ¶

Writer: (setf macro-token-name) (instance) ¶

Package

cl-m4.

Source

m4-util.lisp.

Target Slot

name.

Function: macro-token-p (object) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: make-m4-diversion-table (stream) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: make-macro-token (m4macro name) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: parse-m4 (lexer) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: parse-m4-comment (lexer image) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: parse-m4-dnl (lexer) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: parse-m4-macro (lexer macro-name) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: parse-m4-macro-arguments (lexer) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: parse-m4-munch-whitespace (lexer) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: parse-m4-quote (lexer) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: popm4macro (name) ¶

Package

cl-m4.

Source

m4-builtin.lisp.

Function: pushm4macro (name fun &optional replace) ¶

Package

cl-m4.

Source

m4-builtin.lisp.

Function: quote-regexp (string) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: replace-with-region (replacefn &rest args) ¶

replace-with-region replacefn &rest args => closure

Create closure that is suitable for use with CL-PPCRE replacement forms. Created closure invokes REPLACEFN against the matched subsequence in the string to be searched additionally passing ARGS.

Package

cl-m4.

Source

m4-util.lisp.

Function: sanitize-m4-regex-replacement (replacement) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: set-m4-diversion (number) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: set-syntax (syntax) ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Function: split-merge (string-list split-token) ¶

Package

cl-m4.

Source

m4-parser.lisp.

Function: translate (string charbag &optional replacebag) ¶

Package

cl-m4.

Source

m4-util.lisp.

Function: unquote-regexp (string) ¶

Package

cl-m4.

Source

m4-util.lisp.

---

6.2.4 Generic functions

Generic Reader: m4-macro-stack (object) ¶

Package

cl-m4.

Methods

Reader Method: m4-macro-stack ((m4-input-stream m4-input-stream)) ¶

automatically generated reader method

Source

m4-lexer.lisp.

Target Slot

macro-stack.

Generic Writer: (setf m4-macro-stack) (object) ¶

Package

cl-m4.

Methods

Writer Method: (setf m4-macro-stack) ((m4-input-stream m4-input-stream)) ¶

automatically generated writer method

Source

m4-lexer.lisp.

Target Slot

macro-stack.

Generic Reader: m4-parse-error-column (condition) ¶

Package

cl-m4.

Methods

Reader Method: m4-parse-error-column ((condition m4-parse-error)) ¶

Source

m4-parser.lisp.

Target Slot

column.

Generic Reader: m4-parse-error-message (condition) ¶

Package

cl-m4.

Methods

Reader Method: m4-parse-error-message ((condition m4-parse-error)) ¶

Source

m4-parser.lisp.

Target Slot

message.

Generic Reader: m4-parse-error-row (condition) ¶

Package

cl-m4.

Methods

Reader Method: m4-parse-error-row ((condition m4-parse-error)) ¶

Source

m4-parser.lisp.

Target Slot

row.

Generic Function: m4-pop-macro (m4-input-stream) ¶

Package

cl-m4.

Source

m4-lexer.lisp.

Methods

Method: m4-pop-macro ((stream m4-input-stream)) ¶

Generic Function: m4-push-macro (m4-input-stream macro) ¶

Package

cl-m4.

Source

m4-lexer.lisp.

Methods

Method: m4-push-macro ((stream m4-input-stream) macro) ¶

Generic Reader: macro-defn-invocation-result (condition) ¶

Package

cl-m4.

Methods

Reader Method: macro-defn-invocation-result ((condition macro-defn-invocation-condition)) ¶

Source

m4-util.lisp.

Target Slot

macro.

Generic Reader: macro-invocation-result (condition) ¶

Package

cl-m4.

Methods

Reader Method: macro-invocation-result ((condition macro-invocation-condition)) ¶

Source

m4-util.lisp.

Target Slot

result.

Generic Reader: nesting-level-limit (condition) ¶

Package

cl-m4.

Methods

Reader Method: nesting-level-limit ((condition macro-nesting-level-excession-condition)) ¶

Source

m4-util.lisp.

Target Slot

limit.

Generic Reader: regex-compilation-failure-message (condition) ¶

Package

cffi-regex.

Methods

Reader Method: regex-compilation-failure-message ((condition regex-compilation-failure)) ¶

Source

regex.lisp.

Target Slot

message.

---

6.2.5 Conditions

Condition: m4-parse-error ¶

Package

cl-m4.

Source

m4-parser.lisp.

Direct superclasses

error.

Direct methods

• m4-parse-error-column.
• m4-parse-error-message.
• m4-parse-error-row.

Direct slots

Slot: message ¶

Initargs

:message

Readers

m4-parse-error-message.

Writers

This slot is read-only.

Slot: row ¶

Initargs

:row

Readers

m4-parse-error-row.

Writers

This slot is read-only.

Slot: column ¶

Initargs

:column

Readers

m4-parse-error-column.

Writers

This slot is read-only.

Condition: macro-condition ¶

Package

cl-m4.

Source

m4-util.lisp.

Direct superclasses

error.

Direct subclasses

• macro-defn-invocation-condition.
• macro-dnl-invocation-condition.
• macro-invocation-condition.
• macro-nesting-level-excession-condition.

Condition: macro-defn-invocation-condition ¶

Package

cl-m4.

Source

m4-util.lisp.

Direct superclasses

macro-condition.

Direct methods

macro-defn-invocation-result.

Direct slots

Slot: macro ¶

Initargs

:macro

Readers

macro-defn-invocation-result.

Writers

This slot is read-only.

Condition: macro-dnl-invocation-condition ¶

Package

cl-m4.

Source

m4-util.lisp.

Direct superclasses

macro-condition.

Condition: macro-invocation-condition ¶

Package

cl-m4.

Source

m4-util.lisp.

Direct superclasses

macro-condition.

Direct methods

macro-invocation-result.

Direct slots

Slot: result ¶

Initargs

:result

Readers

macro-invocation-result.

Writers

This slot is read-only.

Condition: macro-nesting-level-excession-condition ¶

Package

cl-m4.

Source

m4-util.lisp.

Direct superclasses

macro-condition.

Direct methods

nesting-level-limit.

Direct slots

Slot: limit ¶

Initargs

:limit

Readers

nesting-level-limit.

Writers

This slot is read-only.

---

6.2.6 Structures

Structure: macro-token ¶

Package

cl-m4.

Source

m4-util.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: m4macro ¶

Readers

macro-token-m4macro.

Writers

(setf macro-token-m4macro).

Slot: name ¶

Readers

macro-token-name.

Writers

(setf macro-token-name).

---

6.2.7 Classes

Class: m4-input-stream ¶

Package

cl-m4.

Source

m4-lexer.lisp.

Direct superclasses

lexer-input-stream.

Direct methods

• (setf m4-macro-stack).
• m4-macro-stack.
• m4-pop-macro.
• m4-push-macro.
• stream-read-token.

Direct slots

Slot: macro-stack ¶

Readers

m4-macro-stack.

Writers

(setf m4-macro-stack).

Class: registers-tclass ¶

Package

cffi-regex.

Source

cffi-regex.lisp.

Direct superclasses

• foreign-struct-type.
• translatable-foreign-type.

---