The romreader Reference Manual

3.1.1 romreader/romreader.asd

Source

romreader.asd.

Parent Component

romreader (system).

ASDF Systems

romreader.

3.1.2 romreader/package.lisp

Source

romreader.asd.

Parent Component

romreader (system).

Packages

romreader.

3.1.3 romreader/conditions.lisp

Dependency

package.lisp (file).

Source

romreader.asd.

Parent Component

romreader (system).

Public Interface

• malformed-header (condition).
• romreader-error (condition).

Internals

• filename (reader method).
• message (reader method).
• unknown-format (condition).

3.1.4 romreader/romreader.lisp

Dependency

conditions.lisp (file).

Source

romreader.asd.

Parent Component

romreader (system).

Public Interface

• *valid-formats* (special variable).
• defreader (macro).
• load-rom (function).
• rom (class).
• rom-binary (generic reader).
• rom-chr (generic reader).
• (setf rom-chr) (writer method).
• rom-format (generic reader).
• rom-metadata (generic reader).
• rom-prg (generic reader).
• (setf rom-prg) (writer method).

Internals

• ksymb (function).
• mkstr (function).
• parse-rom (generic function).

3.1.5 romreader/nes.lisp

Dependency

romreader.lisp (file).

Source

romreader.asd.

Parent Component

romreader (system).

Packages

romreader-nes.

Public Interface

initialize-instance (method).

Internals

• *mapper-table* (special variable).
• nes (class).
• parse-header (function).
• parse-rom (method).

5.1.1 Special variables

Special Variable: *valid-formats* ¶

A list of ROM formats with implemented readers. Do not manually modify this.

Package

romreader.

Source

romreader.lisp.

5.1.2 Macros

Macro: defreader (format &body body) ¶

Define a reader for FORMAT. FORMAT should be a pathname-type
(i.e. file extension). FORMAT will be added to *valid-formats* if needed. BODY executes inside a WITH-OPEN-FILE binding ’in’ to a binary-stream of the ROM. The BODY should return a list like so: (rom-metadata rom-binary).

Package

romreader.

Source

romreader.lisp.

5.1.3 Ordinary functions

Function: load-rom (path) ¶

Check to see if PATH exists and is a supported ROM format. If so, call the appropriate reader and return a ROM instance, otherwise error.

Package

romreader.

Source

romreader.lisp.

5.1.4 Generic functions

Generic Reader: rom-binary (rom) ¶

Return a bytevector of the ROM data.

Package

romreader.

Source

romreader.lisp.

Methods

Reader Method: rom-binary ((rom rom)) ¶

automatically generated reader method

Target Slot

binary.

Generic Reader: rom-chr (rom) ¶

Return the character/sprite data from the ROM.

Package

romreader.

Source

romreader.lisp.

Methods

Reader Method: rom-chr ((rom rom)) ¶

automatically generated reader method

Target Slot

chr.

Generic Writer: (setf rom-chr) (object) ¶

Package

romreader.

Methods

Writer Method: (setf rom-chr) ((rom rom)) ¶

automatically generated writer method

Source

romreader.lisp.

Target Slot

chr.

Generic Reader: rom-format (rom) ¶

Return the file extension of the ROM as a symbol.

Package

romreader.

Source

romreader.lisp.

Methods

Reader Method: rom-format ((rom rom)) ¶

automatically generated reader method

Target Slot

format.

Generic Reader: rom-metadata (rom) ¶

Return a plist of the ROM metadata.

Package

romreader.

Source

romreader.lisp.

Methods

Reader Method: rom-metadata ((rom rom)) ¶

automatically generated reader method

Target Slot

metadata.

Generic Reader: rom-prg (rom) ¶

Return the program data from the ROM.

Package

romreader.

Source

romreader.lisp.

Methods

Reader Method: rom-prg ((rom rom)) ¶

automatically generated reader method

Target Slot

prg.

Generic Writer: (setf rom-prg) (object) ¶

Package

romreader.

Methods

Writer Method: (setf rom-prg) ((rom rom)) ¶

automatically generated writer method

Source

romreader.lisp.

Target Slot

prg.

5.1.5 Standalone methods

Method: initialize-instance :after ((rom nes) &key) ¶

Source

nes.lisp.

5.1.6 Conditions

Condition: malformed-header ¶

Signalled when a corrupted or invalid header is encountered.

Package

romreader.

Source

conditions.lisp.

Direct superclasses

romreader-error.

Direct methods

message.

Direct slots

Slot: message ¶

Initargs

:message

Readers

message.

Writers

This slot is read-only.

Condition: romreader-error ¶

The base condition for all errors in ROMREADER.

Package

romreader.

Source

conditions.lisp.

Direct superclasses

error.

Direct subclasses

• malformed-header.
• unknown-format.

5.1.7 Classes

Class: rom ¶

Package

romreader.

Source

romreader.lisp.

Direct subclasses

nes.

Direct methods

• rom-binary.
• (setf rom-chr).
• rom-chr.
• rom-format.
• rom-metadata.
• (setf rom-prg).
• rom-prg.

Direct slots

Slot: metadata ¶

Initargs

:metadata

Readers

rom-metadata.

Writers

This slot is read-only.

Slot: binary ¶

Initargs

:binary

Readers

rom-binary.

Writers

This slot is read-only.

Slot: format ¶

Package

common-lisp.

Initargs

:format

Readers

rom-format.

Writers

This slot is read-only.

Slot: prg ¶

Initargs

:prg

Readers

rom-prg.

Writers

(setf rom-prg).

Slot: chr ¶

Initargs

:prg

Readers

rom-chr.

Writers

(setf rom-chr).

5.2.1 Special variables

Special Variable: *mapper-table* ¶

A list of known NES Memory Mappers of the form (Number . Name).

Package

romreader-nes.

Source

nes.lisp.

5.2.2 Ordinary functions

Function: ksymb (&rest args) ¶

Package

romreader.

Source

romreader.lisp.

Function: mkstr (&rest args) ¶

Package

romreader.

Source

romreader.lisp.

Function: parse-header (byte-vector) ¶

Package

romreader-nes.

Source

nes.lisp.

5.2.3 Generic functions

Generic Reader: filename (condition) ¶

Package

romreader.

Methods

Reader Method: filename ((condition unknown-format)) ¶

Source

conditions.lisp.

Target Slot

filename.

Generic Reader: message (condition) ¶

Package

romreader.

Methods

Reader Method: message ((condition malformed-header)) ¶

Source

conditions.lisp.

Target Slot

message.

Generic Function: parse-rom (format pathname) ¶

Parse the file located at PATHNAME as a ROM of the given
FORMAT. FORMAT should be a symbol denoting a file extension. Returns a ROM instance.

Package

romreader.

Source

romreader.lisp.

Methods

Method: parse-rom ((rom (eql :nes)) pathname) ¶

Source

nes.lisp.

5.2.4 Conditions

Condition: unknown-format ¶

Signalled when an appropriate parser method could not be found for the extension of the given ROM pathname.

Package

romreader.

Source

conditions.lisp.

Direct superclasses

romreader-error.

Direct methods

filename.

Direct slots

Slot: filename ¶

Initargs

:filename

Readers

filename.

Writers

This slot is read-only.

5.2.5 Classes

Class: nes ¶

Package

romreader-nes.

Source

nes.lisp.

Direct superclasses

rom.

Direct methods

initialize-instance.