The cue-parser Reference Manual

Table of Contents

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

The cue-parser Reference Manual

This is the cue-parser Reference Manual, version 0.5, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:32:14 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

This simple library can help you to parse cue sheet files in simple s-expr tree 
and  get metadata (i.e. performer, title of audio work, indices and so on) from
it.

See http://shamazmazum.github.io/cue-parser/ for documentation


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 cue-parser

Author

Vasily Postnicov <shamaz.mazum@gmail.com>

License

2-clause BSD

Description

A library for parsing audio CUE files

Version

0.5

Dependencies
Source

cue-parser.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cue-parser.asd

Location

cue-parser.asd

Systems

cue-parser (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cue-parser/package.lisp

Parent

cue-parser (system)

Location

package.lisp

Packages

cue-parser


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cue-parser/parser.lisp

Dependency

package.lisp (file)

Parent

cue-parser (system)

Location

parser.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cue-parser/helper-functions.lisp

Dependency

package.lisp (file)

Parent

cue-parser (system)

Location

helper-functions.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 cue-parser

Source

package.lisp (file)

Nickname

cue

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *cue-external-format*

Default external format for CUE sheet files

Package

cue-parser

Source

parser.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 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 (file)

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 (file)

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 (file)

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 (file)

Function: get-toplevel TREE

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

Package

cue-parser

Source

helper-functions.lisp (file)

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 (file)

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 (file)

Function: get-tracks TREE

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

Package

cue-parser

Source

helper-functions.lisp (file)

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 (file)

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 (file)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: not-an-but-allowed C
Package

cue-parser

Source

parser.lisp (file)

Function: number-parser LIST
Package

cue-parser

Source

parser.lisp (file)

Function: repeat-n-times FORM N
Package

cue-parser

Source

parser.lisp (file)

Function: string-to-keyword LIST
Package

cue-parser

Source

parser.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cue-parser.asd: The cue-parser<dot>asd file
cue-parser/helper-functions.lisp: The cue-parser/helper-functions<dot>lisp file
cue-parser/package.lisp: The cue-parser/package<dot>lisp file
cue-parser/parser.lisp: The cue-parser/parser<dot>lisp file

F
File, Lisp, cue-parser.asd: The cue-parser<dot>asd file
File, Lisp, cue-parser/helper-functions.lisp: The cue-parser/helper-functions<dot>lisp file
File, Lisp, cue-parser/package.lisp: The cue-parser/package<dot>lisp file
File, Lisp, cue-parser/parser.lisp: The cue-parser/parser<dot>lisp file

L
Lisp File, cue-parser.asd: The cue-parser<dot>asd file
Lisp File, cue-parser/helper-functions.lisp: The cue-parser/helper-functions<dot>lisp file
Lisp File, cue-parser/package.lisp: The cue-parser/package<dot>lisp file
Lisp File, cue-parser/parser.lisp: The cue-parser/parser<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   F   G   N   P   R   S  
Index Entry  Section

F
find-track: Exported functions
Function, find-track: Exported functions
Function, get-command-arg: Exported functions
Function, get-command-named-arg: Exported functions
Function, get-file-name: Exported functions
Function, get-toplevel: Exported functions
Function, get-track-by-idx: Exported functions
Function, get-track-index-sec: Exported functions
Function, get-tracks: Exported functions
Function, not-an-but-allowed: Internal functions
Function, number-parser: Internal functions
Function, parse-cue: Exported functions
Function, parse-cue-file: Exported functions
Function, repeat-n-times: Internal functions
Function, string-to-keyword: Internal functions

G
get-command-arg: Exported functions
get-command-named-arg: Exported functions
get-file-name: Exported functions
get-toplevel: Exported functions
get-track-by-idx: Exported functions
get-track-index-sec: Exported functions
get-tracks: Exported functions

N
not-an-but-allowed: Internal functions
number-parser: Internal functions

P
parse-cue: Exported functions
parse-cue-file: Exported functions

R
repeat-n-times: Internal functions

S
string-to-keyword: Internal functions

Jump to:   F   G   N   P   R   S  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

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

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

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cue-parser: The cue-parser system
cue-parser: The cue-parser package

P
Package, cue-parser: The cue-parser package

S
System, cue-parser: The cue-parser system

Jump to:   C   P   S