Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

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 Sun Dec 15 05:44:27 2024 GMT+0.

Next: Systems, Previous: The cmake-parser Reference Manual, Up: The cmake-parser Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cmake-parser Reference Manual [Contents][Index]

2 Systems

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

cmake-parser

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

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

package.lisp (file).
cmake-parser.lisp (file).
example.lisp (file).

Next: Packages, Previous: Systems, Up: The cmake-parser Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cmake-parser/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cmake-parser/cmake-parser.asd`

Source: cmake-parser.asd.
Parent Component: cmake-parser (system).
ASDF Systems: cmake-parser.

Next: cmake-parser/cmake-parser.lisp, Previous: cmake-parser/cmake-parser.asd, Up: Lisp [Contents][Index]

3.1.2 `cmake-parser/package.lisp`

Source: cmake-parser.asd.
Parent Component: cmake-parser (system).
Packages: cmake-parser.

Next: cmake-parser/example.lisp, Previous: cmake-parser/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cmake-parser/cmake-parser.lisp`

Dependency

package.lisp (file).

Source

cmake-parser.asd.

Parent Component

cmake-parser (system).

Public Interface

expand-argument (function).
grammar (function).
parse-file (function).
parse-string (function).

Internals

*bracket-argument-parsing* (special variable).
*bracket-close-=-len* (special variable).
*bracket-close-]-got* (special variable).
*bracket-open-=-len* (special variable).
bracket-argument-char? (function).
bracket-close-found? (function).
convert-newline (function).
escape-identity-char? (function).
identifier-first-char? (function).
identifier-rest-char? (function).
parsing-bracket-argument (function).
slurp (function).

Previous: cmake-parser/cmake-parser.lisp, Up: Lisp [Contents][Index]

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

test-arg-combination (function).
test-arg-combination2 (function).
test-bracket-arg (function).
test-cmd-invocation (function).
test-common-usage (function).
test-crlf (function).
test-expand-arg (function).
test-quote-continuation (function).
test-quoted-arg (function).
test-quoted-encoded (function).
test-unquoted-encoded (function).

Next: Definitions, Previous: Files, Up: The cmake-parser Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cmake-parser

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

4.1 `cmake-parser`

Source

package.lisp.

Use List

common-lisp.

Public Interface

expand-argument (function).
grammar (function).
parse-file (function).
parse-string (function).
test-all (function).

Internals

*bracket-argument-parsing* (special variable).
*bracket-close-=-len* (special variable).
*bracket-close-]-got* (special variable).
*bracket-open-=-len* (special variable).
bracket-argument-char? (function).
bracket-close-found? (function).
convert-newline (function).
escape-identity-char? (function).
identifier-first-char? (function).
identifier-rest-char? (function).
parsing-bracket-argument (function).
slurp (function).
test-arg-combination (function).
test-arg-combination2 (function).
test-bracket-arg (function).
test-cmd-invocation (function).
test-common-usage (function).
test-crlf (function).
test-expand-arg (function).
test-quote-continuation (function).
test-quoted-arg (function).
test-quoted-encoded (function).
test-unquoted-encoded (function).

Next: Indexes, Previous: Packages, Up: The cmake-parser Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

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.

Previous: Special variables, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The cmake-parser Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`bracket-argument-parsing`:	Private special variables
	`bracket-close-=-len`:	Private special variables
	`bracket-close-]-got`:	Private special variables
	`bracket-open-=-len`:	Private special variables

S
	`Special Variable, bracket-argument-parsing`:	Private special variables
	`Special Variable, bracket-close-=-len`:	Private special variables
	`Special Variable, bracket-close-]-got`:	Private special variables
	`Special Variable, bracket-open-=-len`:	Private special variables

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

A.4 Data types

Jump to:	C E F P S

	Index Entry	Section

C
	`cmake-parser`:	The cmake-parser system
	`cmake-parser`:	The cmake-parser package
	`cmake-parser.asd`:	The cmake-parser/cmake-parser․asd file
	`cmake-parser.lisp`:	The cmake-parser/cmake-parser․lisp file

E
	`example.lisp`:	The cmake-parser/example․lisp file

F
	`File, cmake-parser.asd`:	The cmake-parser/cmake-parser․asd file
	`File, cmake-parser.lisp`:	The cmake-parser/cmake-parser․lisp file
	`File, example.lisp`:	The cmake-parser/example․lisp file
	`File, package.lisp`:	The cmake-parser/package․lisp file

P
	`Package, cmake-parser`:	The cmake-parser package
	`package.lisp`:	The cmake-parser/package․lisp file

S
	`System, cmake-parser`:	The cmake-parser system

The cmake-parser Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cmake-parser

3 Files

3.1 Lisp

3.1.1 cmake-parser/cmake-parser.asd

3.1.2 cmake-parser/package.lisp

3.1.3 cmake-parser/cmake-parser.lisp

3.1.4 cmake-parser/example.lisp

4 Packages

4.1 cmake-parser

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cmake-parser`

3.1.1 `cmake-parser/cmake-parser.asd`

3.1.2 `cmake-parser/package.lisp`

3.1.3 `cmake-parser/cmake-parser.lisp`

3.1.4 `cmake-parser/example.lisp`

4.1 `cmake-parser`