The cmake-parser Reference Manual

This is the cmake-parser Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:04:28 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cmake-parser

A cmake script parser.

Author

zbq

License

MIT

Version

0.1.0

Dependencies
  • esrap (system).
  • alexandria (system).
Source

cmake-parser.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cmake-parser/cmake-parser.asd

Source

cmake-parser.asd.

Parent Component

cmake-parser (system).

ASDF Systems

cmake-parser.


3.1.2 cmake-parser/package.lisp

Source

cmake-parser.asd.

Parent Component

cmake-parser (system).

Packages

cmake-parser.


3.1.3 cmake-parser/cmake-parser.lisp

Dependency

package.lisp (file).

Source

cmake-parser.asd.

Parent Component

cmake-parser (system).

Public Interface
Internals

3.1.4 cmake-parser/example.lisp

Dependency

cmake-parser.lisp (file).

Source

cmake-parser.asd.

Parent Component

cmake-parser (system).

Public Interface

test-all (function).

Internals

4 Packages

Packages are listed by definition order.


4.1 cmake-parser

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: expand-argument (arg binding)

Expand argument if it contains variable reference. You should provide a variable binding hash-table. Ex. arg: ’Hello ${someone}’, binding: ’someone’->’Bob’, it will expand to ’Hello Bob’.

Package

cmake-parser.

Source

cmake-parser.lisp.

Function: grammar ()

Return cmake grammar.

Package

cmake-parser.

Source

cmake-parser.lisp.

Function: parse-file (pathname)

Parse cmake script file, return a list of command invocation.

Package

cmake-parser.

Source

cmake-parser.lisp.

Function: parse-string (str)

Parse cmake script string, return a list of command invocation.

Package

cmake-parser.

Source

cmake-parser.lisp.

Function: test-all ()
Package

cmake-parser.

Source

example.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *bracket-argument-parsing*

whether we are parsing bracket argument

Package

cmake-parser.

Source

cmake-parser.lisp.

Special Variable: *bracket-close-=-len*

length of ’=’ in ’]=...]’

Package

cmake-parser.

Source

cmake-parser.lisp.

Special Variable: *bracket-close-]-got*

whether we got first ’]’ of ’]=...]’

Package

cmake-parser.

Source

cmake-parser.lisp.

Special Variable: *bracket-open-=-len*

length of ’=’ in ’[=...[’

Package

cmake-parser.

Source

cmake-parser.lisp.


5.2.2 Ordinary functions

Function: bracket-argument-char? (char)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: bracket-close-found? (str)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: convert-newline (str)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: escape-identity-char? (char)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: identifier-first-char? (char)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: identifier-rest-char? (char)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: parsing-bracket-argument (str)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: slurp (pathname)
Package

cmake-parser.

Source

cmake-parser.lisp.

Function: test-arg-combination ()
Package

cmake-parser.

Source

example.lisp.

Function: test-arg-combination2 ()
Package

cmake-parser.

Source

example.lisp.

Function: test-bracket-arg ()
Package

cmake-parser.

Source

example.lisp.

Function: test-cmd-invocation ()
Package

cmake-parser.

Source

example.lisp.

Function: test-common-usage ()
Package

cmake-parser.

Source

example.lisp.

Function: test-crlf ()
Package

cmake-parser.

Source

example.lisp.

Function: test-expand-arg ()
Package

cmake-parser.

Source

example.lisp.

Function: test-quote-continuation ()
Package

cmake-parser.

Source

example.lisp.

Function: test-quoted-arg ()
Package

cmake-parser.

Source

example.lisp.

Function: test-quoted-encoded ()
Package

cmake-parser.

Source

example.lisp.

Function: test-unquoted-encoded ()
Package

cmake-parser.

Source

example.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   B   C   E   F   G   I   P   S   T  
Index Entry  Section

B
bracket-argument-char?: Private ordinary functions
bracket-close-found?: Private ordinary functions

C
convert-newline: Private ordinary functions

E
escape-identity-char?: Private ordinary functions
expand-argument: Public ordinary functions

F
Function, bracket-argument-char?: Private ordinary functions
Function, bracket-close-found?: Private ordinary functions
Function, convert-newline: Private ordinary functions
Function, escape-identity-char?: Private ordinary functions
Function, expand-argument: Public ordinary functions
Function, grammar: Public ordinary functions
Function, identifier-first-char?: Private ordinary functions
Function, identifier-rest-char?: Private ordinary functions
Function, parse-file: Public ordinary functions
Function, parse-string: Public ordinary functions
Function, parsing-bracket-argument: Private ordinary functions
Function, slurp: Private ordinary functions
Function, test-all: Public ordinary functions
Function, test-arg-combination: Private ordinary functions
Function, test-arg-combination2: Private ordinary functions
Function, test-bracket-arg: Private ordinary functions
Function, test-cmd-invocation: Private ordinary functions
Function, test-common-usage: Private ordinary functions
Function, test-crlf: Private ordinary functions
Function, test-expand-arg: Private ordinary functions
Function, test-quote-continuation: Private ordinary functions
Function, test-quoted-arg: Private ordinary functions
Function, test-quoted-encoded: Private ordinary functions
Function, test-unquoted-encoded: Private ordinary functions

G
grammar: Public ordinary functions

I
identifier-first-char?: Private ordinary functions
identifier-rest-char?: Private ordinary functions

P
parse-file: Public ordinary functions
parse-string: Public ordinary functions
parsing-bracket-argument: Private ordinary functions

S
slurp: Private ordinary functions

T
test-all: Public ordinary functions
test-arg-combination: Private ordinary functions
test-arg-combination2: Private ordinary functions
test-bracket-arg: Private ordinary functions
test-cmd-invocation: Private ordinary functions
test-common-usage: Private ordinary functions
test-crlf: Private ordinary functions
test-expand-arg: Private ordinary functions
test-quote-continuation: Private ordinary functions
test-quoted-arg: Private ordinary functions
test-quoted-encoded: Private ordinary functions
test-unquoted-encoded: Private ordinary functions