The cue-parser Reference Manual

This is the cue-parser Reference Manual, version 0.5, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:58:29 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cue-parser

A library for parsing audio CUE files

Author

Vasily Postnicov <>

License

2-clause BSD

Version

0.5

Dependencies
  • esrap (system).
  • flexi-streams (system).
Source

cue-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 cue-parser/cue-parser.asd

Source

cue-parser.asd.

Parent Component

cue-parser (system).

ASDF Systems

cue-parser.


3.1.2 cue-parser/package.lisp

Source

cue-parser.asd.

Parent Component

cue-parser (system).

Packages

cue-parser.


3.1.3 cue-parser/parser.lisp

Dependency

package.lisp (file).

Source

cue-parser.asd.

Parent Component

cue-parser (system).

Public Interface
Internals

3.1.4 cue-parser/helper-functions.lisp

Dependency

package.lisp (file).

Source

cue-parser.asd.

Parent Component

cue-parser (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 cue-parser

Source

package.lisp.

Nickname

cue

Use List
  • common-lisp.
  • esrap.
  • flexi-streams.
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 Special variables

Special Variable: *cue-external-format*

Default external format for CUE sheet files

Package

cue-parser.

Source

parser.lisp.


5.1.2 Ordinary functions

Function: find-track (tree test)

Returns the first track in parsed CUE sheet @cl:param(tree) which satisfies the test. Test function receives a track as its only argument.

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-command-arg (tree command)

Get an argument of the command from CUE sheet block
@cl:param(tree). @cl:param(tree) can be the toplevel block or a track block.

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-command-named-arg (tree command arg-name)

Get a named argument of the command from CUE sheet block
@cl:param(tree). @cl:param(tree) can be the toplevel block or a track block.

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-file-name (tree track)

Returns a file name where the track @cl:param(track) can be found

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-toplevel (tree)

Get the toplevel block from parsed CUE sheet. Just wrapper around @c(first).

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-track-by-idx (tree idx)

Return a track from parsed CUE sheet @cl:param(tree) by its index @cl:param(idx).

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-track-index-sec (track &optional index)

Get an index in seconds for a @cl:param(track). @cl:param(index) can be either @c(:PREGAP), @c(:START) or a number.

Package

cue-parser.

Source

helper-functions.lisp.

Function: get-tracks (tree)

Get tracks from parsed CUE sheet. Just wrapper around @c(second).

Package

cue-parser.

Source

helper-functions.lisp.

Function: parse-cue (stream)

Parse CUE sheet from the @cl:param(stream). Stream must be opened as a character stream. User must detect and set external format by himself

Package

cue-parser.

Source

parser.lisp.

Function: parse-cue-file (name &optional external-format)

Parses CUE sheet from file with the name
@cl:param(name). @cl:param(external-format) is used for reading from file.

Package

cue-parser.

Source

parser.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: not-an-but-allowed (c)
Package

cue-parser.

Source

parser.lisp.

Function: number-parser (list)
Package

cue-parser.

Source

parser.lisp.

Function: repeat-n-times (form n)
Package

cue-parser.

Source

parser.lisp.

Function: string-to-keyword (list)
Package

cue-parser.

Source

parser.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*cue-external-format*: Public special variables

S
Special Variable, *cue-external-format*: Public special variables