The mpc Reference Manual

Table of Contents

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

The mpc Reference Manual

This is the mpc Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:20:35 2018 GMT+0.


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

1 Introduction

mpc

Deprecated!

MPC is deprecated in favor of MaxPC. See: Max’s Parser Combinators: Why? How?

Description:

A friendly fork of Drew Crampsie's Smug.

mpc is a monadic parser combinators library. It provides a toolbox of predefined parsers, facilities for error handling and parses arrays, streams and lists.

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 mpc

Author

Max Rottenkolber <max@mr.gy>

License

GNU Affero General Public License

Description

Monadic Parser Combinators for Common Lisp. MPC tries to be simple and practical while being powerful, well documented and fairly performant. A friendly fork of Drew Crampsies _Smug_ library.

Source

mpc.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 mpc.asd

Location

mpc.asd

Systems

mpc (system)


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

3.1.2 mpc/packages.lisp

Parent

mpc (system)

Location

packages.lisp

Packages

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

3.1.3 mpc/input.lisp

Dependency

packages.lisp (file)

Parent

mpc (system)

Location

input.lisp

Internal Definitions

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

3.1.4 mpc/mpc.lisp

Dependencies
Parent

mpc (system)

Location

mpc.lisp

Exported Definitions
Internal Definitions

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

3.1.5 mpc/characters.lisp

Dependencies
Parent

mpc (system)

Location

characters.lisp

Exported Definitions

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

3.1.6 mpc/numerals.lisp

Dependencies
Parent

mpc (system)

Location

numerals.lisp

Exported Definitions

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

3.1.7 mpc/error.lisp

Dependencies
Parent

mpc (system)

Location

error.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 mpc.numerals

This package includes parsers for string numerals.
Covered are single digits, natural numbers and signed integers with arbitrary radixes.

Source

packages.lisp (file)

Use List
Exported Definitions

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

4.2 mpc.characters

This package includes parsers specialised for character input. Covered are case sensitivity, strings, whitespace and lines.

Source

packages.lisp (file)

Use List
Used By List

mpc.numerals

Exported Definitions

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

4.3 mpc

Monadic parser combinators. This package contains general purpose parser combinators of varying sophistication. It also contains the {run} entry function and a handful of macros that integrate parser combinators into the Common Lisp condition system. Functions starting with the {=}-prefix construct _parsers_. Their documentation is written from the perspective of the resulting parser. Refer to the [MPC Manual](manual.html) for a general introduction.

Source

packages.lisp (file)

Use List

common-lisp

Used By 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: *whitespace*

*Value Type:*

a _list_ of _characters_.

*Description:*

The _value_ of {*whitespace*} is a _list_ of _characters_ considered to be _whitespace characters_.

Package

mpc.characters

Source

characters.lisp (file)


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

5.1.2 Macros

Macro: =fail &body HANDLING

*Arguments and Values:*

_handling_—_forms_ to run when the parser is invoked.

*Description:*

{=fail} always fails. If supplied, the _handling forms_ will be run when {=fail} is applied. The _handling forms_ may call {get-input-position}.

Package

mpc

Source

mpc.lisp (file)

Macro: =handler-case PARSER &rest HANDLERS

*Arguments and Values:*

_parser_—a _parser_.

_handlers_—handler clauses for {handler-case}.

*Description:*

{=handler-case} establishes _handlers_ as if by {handler-case} before applying _parser_ to the input. _Handlers_ must return _parsers_. If _parser_ signals an _error_ matched by a _handler_, the _parser_ returned by the _handler_ will be applied to the input.

Package

mpc

Source

error.lisp (file)

Macro: =let* BINDINGS &body FORMS

_bindings_::= {(}{{}{(}_symbol_ _parser_{)}{\}}\*{)}

*Arguments and Values:*

_forms_—_forms_ of which the last _form_ must return a _parser_.

_symbol_—a _symbol_.

_parser_—a _form_ whose result is a _parser_.

*Description:*

{=let*} applies the _parsers_ in _bindings_ as if by {=and} and evaluates _forms_ in an implicit {let} environment where the results are bound to the _symbols_ in _bindings_. Finally, {=let*} applies the parser returned by the last _form_.

Package

mpc

Source

mpc.lisp (file)

Macro: =restart-case PARSER &rest RESTARTS

*Arguments and Values:*

_parser_—a _parser_.

_restarts_—restart clauses for {restart-case}.

*Description:*

{=restart-case} establishes _restarts_ as if by {restart-case} before applying _parser_ to the input. _Restarts_ must return _parsers_. If _parser_ signals an _error_ matched by a _restart_, the _parser_ returned by the _restart_ will be applied to the input.

Package

mpc

Source

error.lisp (file)


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

5.1.3 Functions

Function: =and &rest PARSERS

*Arguments and Values:*

_parsers_—_parsers_.

*Description:*

{=and} applies _parsers_ sequentially. If all _parsers_ succeed, {=and} succeeds with the last _parser_’s result. Otherwise {=and} fails.

Package

mpc

Source

mpc.lisp (file)

Function: =at-least N PARSER &key LIMIT

*Arguments and Values:*

_n_, _limit_—_bounding index designators_. The default for _limit_ is {nil}.

_parser_—a _parser_.

*Description:*

{=at-least} applies _parser_ repeatedly until it fails and succeeds with a list of the results unless _parser_ succeeded less than _n_ times or, if _limit_ is not {nil}, more than _limit_ times.

Package

mpc

Source

mpc.lisp (file)

Function: =bind PARSER MAKE-PARSER

*Arguments and Values:*

_parser_—a _parser_.

_make-parser_—a _function designator_ for a one-argument _function_ which returns a _parser_.

*Description:*

{=bind} applies _parser_ to the input. For each resulting {(value . input)} pair {=bind} calls _make-parser_ with each _value_ and applies the resulting parser to each _input_. {=bind} succeeds with the concatenated results or fails if _parser_ fails.

Package

mpc

Source

mpc.lisp (file)

Function: =character CHARACTER &optional CASE-SENSITIVE-P

*Arguments and Values:*

_character_—a _character_.

_case-sensitive-p_—a _generalized boolean_. The default is _true_.

*Description:*

{=character} consumes the next item and succeeds with that item as its result if the item is equal to _character_. {=character} is case sensitive unless _case-sensitive-p_ is _false_.

Package

mpc.characters

Source

characters.lisp (file)

Function: =digit &optional RADIX

*Arguments and Values:*

_radix_—a _number_ of _type_ {(integer 2 36)}. The default is {10}.

*Description:*

{=digit} consumes the next item and succeeds with that item as its result if the next item is a digit _character_ in the specified _radix_.

Package

mpc.numerals

Source

numerals.lisp (file)

Function: =end-of-input ()

*Description:*

{=end-of-input} succeeds only if the input is empty.

Package

mpc

Source

mpc.lisp (file)

Function: =eql X

*Arguments and Values:*

_x_—an _object_.

*Description:*

{=eql} consumes the next item and succeeds with that item as its result if the item is {eql} to _object_.

Package

mpc

Source

mpc.lisp (file)

Function: =exactly N PARSER

*Arguments and Values:*

_n_—an non-negative _integer_.

_parser_—a _parser_.

*Description:*

{=exactly} applies _parser_ repeatedly until it fails and succeeds with a list of the results unless _parser_ succeeded not exactly _n_ times.

Package

mpc

Source

mpc.lisp (file)

Function: =funcall PARSER FUNCTION

*Arguments and Values:*

_parser_—a _parser_.

_function_—a _function designator_.

*Description:*

{=funcall} applies _parser_. If successful, {=funcall} applies _function_ on its result and succeeds with the return value.

Package

mpc

Source

mpc.lisp (file)

Function: =if TEST-PARSER THEN-PARSER &optional ELSE-PARSER

*Arguments and Values:*

_test-parser_—a _parser_.

_then-parser_—a _parser_.

_else-parser_—a _parser_. The default is {(=fail)}.

*Description:*

{=if} applies _then-parser_ if _test-parser_ would succeed and _else-parser_ otherwise. Note that _test-parser_ is not actually applied to the input.

Package

mpc

Source

mpc.lisp (file)

Function: =integer-number &optional RADIX

*Arguments and Values:*

_radix_—a _number_ of _type_ {(integer 2 36)}. The default is {10}.

*Description:*

{=integer-number} consumes a signed non-empty sequence of digit _characters_ in the specified _radix_ and succeeds with the _integer_ represented by that sequence. The leading sign is optional and can be {#\\+} and {#\\-} for positive and negative values
respectively. The default is a positive value.

Package

mpc.numerals

Source

numerals.lisp (file)

Function: =item ()

*Description:*

{=item} consumes the next item and succeeds with that item as its result unless the input is empty.

Package

mpc

Source

mpc.lisp (file)

Function: =line &optional KEEP-NEWLINE-P

*Arguments and Values:*

_keep-newline-p_—a _generalized boolean_. The default is _false_.

*Description:*

{=line} consumes a sequence of zero or more _characters_ terminated by a {#\\Newline} _character_ and succeeds with the _characters_ coerced to a _string_. The terminating {#\\Newline} _character_ is not included in the result unless _keep-newline-p_ is _true_.

Package

mpc.characters

Source

characters.lisp (file)

Function: =list &rest PARSERS

*Arguments and Values:*

_parsers_—_parsers_.

*Description:*

{=list} applies _parsers_ sequentially. If all _parsers_ succeed, {=list} succeeds with a list of their results. Otherwise {=list} fails.

Package

mpc

Source

mpc.lisp (file)

Function: =maybe PARSER

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=maybe} applies _parser_. If _parser_ succeeds {=maybe} will succeed with its result, otherwise it will succeed with {nil}.

Package

mpc

Source

mpc.lisp (file)

Function: =natural-number &optional RADIX

*Arguments and Values:*

_radix_—a _number_ of _type_ {(integer 2 36)}. The default is {10}.

*Description:*

{=natural-number} consumes a non-empty sequence of digit _characters_ in the specified _radix_ and succeeds with the natural _number_ represented by that sequence.

Package

mpc.numerals

Source

numerals.lisp (file)

Function: =newline ()

*Description:*

{=newline} consumes the next item and succeeds with that item as its result if the item is the {#\\Newline} _character_.

Package

mpc.characters

Source

characters.lisp (file)

Function: =none-of LIST

*Arguments and Values:*

_list_—a _list_ of _objects_.

*Description:*

{=none-of} consumes the next item and succeeds with that item as its result unless the item is {eql} to one of the _objects_ in _list_.

Package

mpc

Source

mpc.lisp (file)

Function: =not PARSER

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=not} consumes the next item and succeeds with that item as its result if _parser_ would fail. E.g. it negates _parser_. Note that _parser_ is not actually applied to the input.

Package

mpc

Source

mpc.lisp (file)

Function: =one-of LIST

*Arguments and Values:*

_list_—a _list_ of _objects_.

*Description:*

{=one-of} consumes the next item and succeeds with that item as its result if the item is {eql} to any _object_ in _list_.

Package

mpc

Source

mpc.lisp (file)

Function: =one-or-more PARSER

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=one-or-more} applies _parser_ repeatedly until it fails and succeeds with a list of the results if _parser_ succeeded at least one time.

Package

mpc

Source

mpc.lisp (file)

Function: =one-to N PARSER

*Arguments and Values:*

_n_—a positive _integer_.

_parser_—a _parser_.

*Description:*

{=one-to} applies _parser_ repeatedly until it fails and succeeds with a list of the results unless _parser_ succeeded less than once or more than _n_ times.

Package

mpc

Source

mpc.lisp (file)

Function: =or &rest PARSERS

*Arguments and Values:*

_parsers_—_parsers_.

*Description:*

{=or} applies _parsers_ until one _parser_ succeeds, in which case it succeeds with the result of that _parser_. If no _parser_ succeeds {=or} fails.

Package

mpc

Source

mpc.lisp (file)

Function: =plus &rest PARSERS

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=plus} is the non-deterministic choice combinator. It applies _parsers_ to input and succeeds with the result of every successful _parser_. {=plus} fails if every _parser_ fails.

Package

mpc

Source

mpc.lisp (file)

Function: =prog1 PARSER &rest PARSERS

*Arguments and Values:*

_parser_—a _parser_.

_parsers_—_parsers_.

*Description:*

{=prog1} applies _parser_ and _parsers_ sequentially. If they all succeed, {=prog1} succeeds with _parser_’s result. Otherwise {=prog1} fails.

Package

mpc

Source

mpc.lisp (file)

Function: =prog2 PARSER1 PARSER2 &rest PARSERS

*Arguments and Values:*

_parser1_—a _parser_.

_parser2_—a _parser_.

_parsers_—_parsers_.

*Description:*

{=prog2} applies _parser1_, _parser2_ and _parsers_ sequentially. If they all succeed, {=prog2} succeeds with _parser2_’s result. Otherwise {=prog2} fails.

Package

mpc

Source

mpc.lisp (file)

Function: =range FROM TO &key PARSER PREDICATE

*Arguments and Values:*

_from_—an _object_.

_to_—an _object_.

_parser_—a _parser_. The default is {(=item)}.

_predicate_—a _function designator_ for a three-argument predicate _function_. The default is {char<=}.

*Description:*

{=range} applies _parser_ and, if it succeeds, applies _predicate_ to _from_, its results and _to_. {=range} succeeds with the result of _parser_ if _predicate_ is _true_ and fails otherwise.

Package

mpc

Source

mpc.lisp (file)

Function: =result VALUE

*Arguments and Values:*

_value_—an _object_.

*Description:*

{=result} always succeeds with _value_ as its result.

Package

mpc

Source

mpc.lisp (file)

Function: =satisfies PREDICATE

*Arguments and Values:*

_predicate_—a _function designator_ for a one-argument predicate _function_.

*Description:*

{=satisfies} consumes the next item and succeeds with that item as its result if the result satisfies _predicate_.

Package

mpc

Source

mpc.lisp (file)

Function: =skip-whitespace PARSER

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=skip-whitespace} consumes a sequence of zero or more items which are members of {*whitespace*} and then applies _parser_ and, if successful, succeeds with its result.

Package

mpc.characters

Source

characters.lisp (file)

Function: =string STRING &optional CASE-SENSITIVE-P

*Arguments and Values:*

_string_—a _string_.

_case-sensitive-p_—a _generalized boolean_. The default is _true_.

*Description:*

{=string} consumes a non-empty sequence of _characters_ and succeeds with the _character sequence_ coerced to a _string_ if the result is equal to _sting_. {=string} is case sensitive unless _case-sensitive-p_ is _false_.

Package

mpc.characters

Source

characters.lisp (file)

Function: =string-of PARSER

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=string-of} repeatedly applies _parser_ to the input and succeeds with the resulting _character sequence_ coerced to a _string_. {=string-of} fails unless _parser_ succeeds at least once.

Package

mpc.characters

Source

characters.lisp (file)

Function: =unless TEST-PARSER &rest PARSERS

*Arguments and Values:*

_test-parser_—a _parser_.

_parsers_—_parsers_.

*Description:*

{=unless} applies _parsers_ as if by {=and} if _test-parser_ would fail. Note that _test-parser_ is not actually applied to the input.

Package

mpc

Source

mpc.lisp (file)

Function: =when TEST-PARSER &rest PARSERS

*Arguments and Values:*

_test-parser_—a _parser_.

_parsers_—_parsers_.

*Description:*

{=when} applies _parsers_ as if by {=and} if _test-parser_ would succeed. Note that _test-parser_ is not actually applied to the input.

Package

mpc

Source

mpc.lisp (file)

Function: =whitespace ()

*Description:*

{=whitespace} consumes the next item and succeeds with that item as its result if the item is a member of {*whitespace*}.

Package

mpc.characters

Source

characters.lisp (file)

Function: =zero-or-more PARSER

*Arguments and Values:*

_parser_—a _parser_.

*Description:*

{=zero-or-more} applies _parser_ repeatedly until it fails and succeeds with a list of the results.

Package

mpc

Source

mpc.lisp (file)

Function: =zero-to N PARSER

*Arguments and Values:*

_n_—an non-negative _integer_.

_parser_—a _parser_.

*Description:*

{=zero-to} applies _parser_ repeatedly until it fails and succeeds with a list of the results unless _parser_ succeeded more than _n_ times.

Package

mpc

Source

mpc.lisp (file)

Function: get-input-position ()

→ _position_

→ _position_, _line_, _column_

*Arguments and Values:*

_position_, _column_—non-negative _integers_.

_line_—a positive _integer_.

*Description:*

{get-input-position} returns the number of items read from the input. Additionally, _line_ and _column_ positions are returned if the input’s _element type_ is {character}. Lines are counted starting at 1 while columns are counted starting from 0.

{get-input-position} may only be called from within the body of {=fail}, the handlers of {=handler-case} or the restarts of {=restart-case}.

*Exceptional Situations:*

{get-input-position} signals an _error_ of _type_ {simple-error} unless called within {=fail}, {=handler-case} or {=restart-case}.

Package

mpc

Source

error.lisp (file)

Function: run PARSER INPUT-SOURCE &key RESULT

*Arguments and Values:*

_parser_—a _parser_.

_input-source_—an _array_, an _input stream_ or a _list_.

_result_—a _function designator_ to a one-argument _function_. The default is {caar}.

*Description:*

{run} applies _parser_ to _input-source_ and returns the result of calling the _result_ function on the resulting list of
{(value . input)} pairs.

Package

mpc

Source

mpc.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *input-at-run*

Bound to initial input during RUN.

Package

mpc

Source

mpc.lisp (file)

Special Variable: *input-during-fail*

Bound to input during =FAIL.

Package

mpc

Source

mpc.lisp (file)


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

5.2.2 Functions

Function: =binary-and PARSER-A PARSER-B

=BIND PARSER-A and PARSER-B and fail if any of those fails. Otherwise return the result of PARSER-B.

Package

mpc

Source

mpc.lisp (file)

Function: cases-to-parser-cases CASES INPUT

Utility macro function for =HANDLER-CASE and =RESTART-CASE.

Package

mpc

Source

error.lisp (file)

Function: copy-index INSTANCE
Package

mpc

Source

input.lisp (file)

Function: copy-index-array INSTANCE
Package

mpc

Source

input.lisp (file)

Function: copy-index-list INSTANCE
Package

mpc

Source

input.lisp (file)

Function: copy-index-simple-array INSTANCE
Package

mpc

Source

input.lisp (file)

Function: copy-index-simple-string INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-array-array INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-array-p OBJECT
Package

mpc

Source

input.lisp (file)

Function: index-array-position INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-list-list INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-list-p OBJECT
Package

mpc

Source

input.lisp (file)

Function: index-list-position INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-p OBJECT
Package

mpc

Source

input.lisp (file)

Function: index-position INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-simple-array-array INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-simple-array-p OBJECT
Package

mpc

Source

input.lisp (file)

Function: index-simple-array-position INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-simple-string-array INSTANCE
Package

mpc

Source

input.lisp (file)

Function: index-simple-string-p OBJECT
Package

mpc

Source

input.lisp (file)

Function: index-simple-string-position INSTANCE
Package

mpc

Source

input.lisp (file)

Function: make-index &key (POSITION POSITION)
Package

mpc

Source

input.lisp (file)

Function: make-index-array &key (POSITION POSITION) (ARRAY ARRAY)
Package

mpc

Source

input.lisp (file)

Function: make-index-list &key (POSITION POSITION) (LIST LIST)
Package

mpc

Source

input.lisp (file)

Function: make-index-simple-array &key (POSITION POSITION) (ARRAY ARRAY)
Package

mpc

Source

input.lisp (file)

Function: make-index-simple-string &key (POSITION POSITION) (ARRAY ARRAY)
Package

mpc

Source

input.lisp (file)

Function: parse-line-position INPUT POSITION

Parses line position of POSITION in INPUT.

Package

mpc

Source

error.lisp (file)


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

5.2.3 Generic functions

Generic Function: input-element-type INPUT

Returns element type of {INPUT}.

Package

mpc

Source

input.lisp (file)

Methods
Method: input-element-type (INPUT index-array)
Method: input-element-type INPUT
Generic Function: input-empty-p INPUT

Predicate to test if {INPUT} is empty.

Package

mpc

Source

input.lisp (file)

Methods
Method: input-empty-p (INPUT index-array)
Method: input-empty-p (INPUT index-list)
Generic Function: input-first INPUT

Returns first element of {INPUT}.

Package

mpc

Source

input.lisp (file)

Methods
Method: input-first (INPUT index-simple-string)
Method: input-first (INPUT index-simple-array)
Method: input-first (INPUT index-array)
Method: input-first (INPUT index-list)
Generic Function: input-position INPUT

Returns index position of {INPUT}.

Package

mpc

Source

input.lisp (file)

Methods
Method: input-position (INPUT index)
Generic Function: input-rest INPUT

Returns {INPUT} with its first element stripped.

Package

mpc

Source

input.lisp (file)

Methods
Method: input-rest (INPUT index-simple-string)
Method: input-rest (INPUT index-simple-array)
Method: input-rest (INPUT index-array)
Method: input-rest (INPUT index-list)
Generic Function: make-input SOURCE

Returns input object for {SOURCE}.

Package

mpc

Source

input.lisp (file)

Methods
Method: make-input (INPUT file-stream)
Method: make-input (INPUT string)
Method: make-input (INPUT array)
Method: make-input (INPUT list)

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

5.2.4 Structures

Structure: index ()

Generic index.

Package

mpc

Source

input.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses
Direct methods

input-position (method)

Direct slots
Slot: position
Type

mpc::array-index

Initform

0

Readers

index-position (function)

Writers

(setf index-position) (function)

Structure: index-array ()

Index array.

Package

mpc

Source

input.lisp (file)

Direct superclasses

index (structure)

Direct subclasses
Direct methods
Direct slots
Slot: array
Type

array

Initform

(error "must supply array.")

Readers

index-array-array (function)

Writers

(setf index-array-array) (function)

Structure: index-list ()

Index list.

Package

mpc

Source

input.lisp (file)

Direct superclasses

index (structure)

Direct methods
Direct slots
Slot: list
Type

list

Initform

(error "must supply list.")

Readers

index-list-list (function)

Writers

(setf index-list-list) (function)

Structure: index-simple-array ()

Index simple array.

Package

mpc

Source

input.lisp (file)

Direct superclasses

index-array (structure)

Direct methods
Structure: index-simple-string ()

Index simple string.

Package

mpc

Source

input.lisp (file)

Direct superclasses

index-array (structure)

Direct methods

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

5.2.5 Types

Type: array-index ()

Array index type used in index structure.

Package

mpc

Source

input.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, mpc.asd: The mpc<dot>asd file
File, Lisp, mpc/characters.lisp: The mpc/characters<dot>lisp file
File, Lisp, mpc/error.lisp: The mpc/error<dot>lisp file
File, Lisp, mpc/input.lisp: The mpc/input<dot>lisp file
File, Lisp, mpc/mpc.lisp: The mpc/mpc<dot>lisp file
File, Lisp, mpc/numerals.lisp: The mpc/numerals<dot>lisp file
File, Lisp, mpc/packages.lisp: The mpc/packages<dot>lisp file

L
Lisp File, mpc.asd: The mpc<dot>asd file
Lisp File, mpc/characters.lisp: The mpc/characters<dot>lisp file
Lisp File, mpc/error.lisp: The mpc/error<dot>lisp file
Lisp File, mpc/input.lisp: The mpc/input<dot>lisp file
Lisp File, mpc/mpc.lisp: The mpc/mpc<dot>lisp file
Lisp File, mpc/numerals.lisp: The mpc/numerals<dot>lisp file
Lisp File, mpc/packages.lisp: The mpc/packages<dot>lisp file

M
mpc.asd: The mpc<dot>asd file
mpc/characters.lisp: The mpc/characters<dot>lisp file
mpc/error.lisp: The mpc/error<dot>lisp file
mpc/input.lisp: The mpc/input<dot>lisp file
mpc/mpc.lisp: The mpc/mpc<dot>lisp file
mpc/numerals.lisp: The mpc/numerals<dot>lisp file
mpc/packages.lisp: The mpc/packages<dot>lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   =  
C   F   G   I   M   P   R  
Index Entry  Section

=
=and: Exported functions
=at-least: Exported functions
=binary-and: Internal functions
=bind: Exported functions
=character: Exported functions
=digit: Exported functions
=end-of-input: Exported functions
=eql: Exported functions
=exactly: Exported functions
=fail: Exported macros
=funcall: Exported functions
=handler-case: Exported macros
=if: Exported functions
=integer-number: Exported functions
=item: Exported functions
=let*: Exported macros
=line: Exported functions
=list: Exported functions
=maybe: Exported functions
=natural-number: Exported functions
=newline: Exported functions
=none-of: Exported functions
=not: Exported functions
=one-of: Exported functions
=one-or-more: Exported functions
=one-to: Exported functions
=or: Exported functions
=plus: Exported functions
=prog1: Exported functions
=prog2: Exported functions
=range: Exported functions
=restart-case: Exported macros
=result: Exported functions
=satisfies: Exported functions
=skip-whitespace: Exported functions
=string: Exported functions
=string-of: Exported functions
=unless: Exported functions
=when: Exported functions
=whitespace: Exported functions
=zero-or-more: Exported functions
=zero-to: Exported functions

C
cases-to-parser-cases: Internal functions
copy-index: Internal functions
copy-index-array: Internal functions
copy-index-list: Internal functions
copy-index-simple-array: Internal functions
copy-index-simple-string: Internal functions

F
Function, =and: Exported functions
Function, =at-least: Exported functions
Function, =binary-and: Internal functions
Function, =bind: Exported functions
Function, =character: Exported functions
Function, =digit: Exported functions
Function, =end-of-input: Exported functions
Function, =eql: Exported functions
Function, =exactly: Exported functions
Function, =funcall: Exported functions
Function, =if: Exported functions
Function, =integer-number: Exported functions
Function, =item: Exported functions
Function, =line: Exported functions
Function, =list: Exported functions
Function, =maybe: Exported functions
Function, =natural-number: Exported functions
Function, =newline: Exported functions
Function, =none-of: Exported functions
Function, =not: Exported functions
Function, =one-of: Exported functions
Function, =one-or-more: Exported functions
Function, =one-to: Exported functions
Function, =or: Exported functions
Function, =plus: Exported functions
Function, =prog1: Exported functions
Function, =prog2: Exported functions
Function, =range: Exported functions
Function, =result: Exported functions
Function, =satisfies: Exported functions
Function, =skip-whitespace: Exported functions
Function, =string: Exported functions
Function, =string-of: Exported functions
Function, =unless: Exported functions
Function, =when: Exported functions
Function, =whitespace: Exported functions
Function, =zero-or-more: Exported functions
Function, =zero-to: Exported functions
Function, cases-to-parser-cases: Internal functions
Function, copy-index: Internal functions
Function, copy-index-array: Internal functions
Function, copy-index-list: Internal functions
Function, copy-index-simple-array: Internal functions
Function, copy-index-simple-string: Internal functions
Function, get-input-position: Exported functions
Function, index-array-array: Internal functions
Function, index-array-p: Internal functions
Function, index-array-position: Internal functions
Function, index-list-list: Internal functions
Function, index-list-p: Internal functions
Function, index-list-position: Internal functions
Function, index-p: Internal functions
Function, index-position: Internal functions
Function, index-simple-array-array: Internal functions
Function, index-simple-array-p: Internal functions
Function, index-simple-array-position: Internal functions
Function, index-simple-string-array: Internal functions
Function, index-simple-string-p: Internal functions
Function, index-simple-string-position: Internal functions
Function, make-index: Internal functions
Function, make-index-array: Internal functions
Function, make-index-list: Internal functions
Function, make-index-simple-array: Internal functions
Function, make-index-simple-string: Internal functions
Function, parse-line-position: Internal functions
Function, run: Exported functions

G
Generic Function, input-element-type: Internal generic functions
Generic Function, input-empty-p: Internal generic functions
Generic Function, input-first: Internal generic functions
Generic Function, input-position: Internal generic functions
Generic Function, input-rest: Internal generic functions
Generic Function, make-input: Internal generic functions
get-input-position: Exported functions

I
index-array-array: Internal functions
index-array-p: Internal functions
index-array-position: Internal functions
index-list-list: Internal functions
index-list-p: Internal functions
index-list-position: Internal functions
index-p: Internal functions
index-position: Internal functions
index-simple-array-array: Internal functions
index-simple-array-p: Internal functions
index-simple-array-position: Internal functions
index-simple-string-array: Internal functions
index-simple-string-p: Internal functions
index-simple-string-position: Internal functions
input-element-type: Internal generic functions
input-element-type: Internal generic functions
input-element-type: Internal generic functions
input-empty-p: Internal generic functions
input-empty-p: Internal generic functions
input-empty-p: Internal generic functions
input-first: Internal generic functions
input-first: Internal generic functions
input-first: Internal generic functions
input-first: Internal generic functions
input-first: Internal generic functions
input-position: Internal generic functions
input-position: Internal generic functions
input-rest: Internal generic functions
input-rest: Internal generic functions
input-rest: Internal generic functions
input-rest: Internal generic functions
input-rest: Internal generic functions

M
Macro, =fail: Exported macros
Macro, =handler-case: Exported macros
Macro, =let*: Exported macros
Macro, =restart-case: Exported macros
make-index: Internal functions
make-index-array: Internal functions
make-index-list: Internal functions
make-index-simple-array: Internal functions
make-index-simple-string: Internal functions
make-input: Internal generic functions
make-input: Internal generic functions
make-input: Internal generic functions
make-input: Internal generic functions
make-input: Internal generic functions
Method, input-element-type: Internal generic functions
Method, input-element-type: Internal generic functions
Method, input-empty-p: Internal generic functions
Method, input-empty-p: Internal generic functions
Method, input-first: Internal generic functions
Method, input-first: Internal generic functions
Method, input-first: Internal generic functions
Method, input-first: Internal generic functions
Method, input-position: Internal generic functions
Method, input-rest: Internal generic functions
Method, input-rest: Internal generic functions
Method, input-rest: Internal generic functions
Method, input-rest: Internal generic functions
Method, make-input: Internal generic functions
Method, make-input: Internal generic functions
Method, make-input: Internal generic functions
Method, make-input: Internal generic functions

P
parse-line-position: Internal functions

R
run: Exported functions

Jump to:   =  
C   F   G   I   M   P   R  

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

A.3 Variables

Jump to:   *  
A   L   P   S  
Index Entry  Section

*
*input-at-run*: Internal special variables
*input-during-fail*: Internal special variables
*whitespace*: Exported special variables

A
array: Internal structures

L
list: Internal structures

P
position: Internal structures

S
Slot, array: Internal structures
Slot, list: Internal structures
Slot, position: Internal structures
Special Variable, *input-at-run*: Internal special variables
Special Variable, *input-during-fail*: Internal special variables
Special Variable, *whitespace*: Exported special variables

Jump to:   *  
A   L   P   S  

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

A.4 Data types

Jump to:   A   I   M   P   S   T  
Index Entry  Section

A
array-index: Internal types

I
index: Internal structures
index-array: Internal structures
index-list: Internal structures
index-simple-array: Internal structures
index-simple-string: Internal structures

M
mpc: The mpc system
mpc: The mpc package
mpc.characters: The mpc<dot>characters package
mpc.numerals: The mpc<dot>numerals package

P
Package, mpc: The mpc package
Package, mpc.characters: The mpc<dot>characters package
Package, mpc.numerals: The mpc<dot>numerals package

S
Structure, index: Internal structures
Structure, index-array: Internal structures
Structure, index-list: Internal structures
Structure, index-simple-array: Internal structures
Structure, index-simple-string: Internal structures
System, mpc: The mpc system

T
Type, array-index: Internal types

Jump to:   A   I   M   P   S   T