The paren-files Reference Manual

Table of Contents

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

The paren-files Reference Manual

This is the paren-files Reference Manual, version 0.0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:23:34 2018 GMT+0.


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

1 Systems

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


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

1.1 paren-files

Author

Red Daly <reddaly@gmail.com.>

License

MIT

Description

Parenscript library for compiling files and ASDF systems.

Version

0.0.1

Dependency

parenscript

Source

paren-files.asd (file)

Component

src (module)


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

2 Modules

Modules are listed depth-first from the system components tree.


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

2.1 paren-files/src

Parent

paren-files (system)

Location

src/

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 paren-files.asd

Location

paren-files.asd

Systems

paren-files (system)

Packages

paren-files-system


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

3.1.2 paren-files/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

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

3.1.3 paren-files/src/compile-file.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/compile-file.lisp

Exported Definitions
Internal Definitions

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

3.1.4 paren-files/src/paren-asdf.lisp

Dependency

compile-file.lisp (file)

Parent

src (module)

Location

src/paren-asdf.lisp

Exported Definitions

compile-script-system (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 paren-files-system

Source

paren-files.asd

Use List

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

4.2 parenscript.files

Library that compiles Parenscript files and systems.

Source

package.lisp (file)

Nickname

paren-files

Use List
Exported Definitions
Internal Definitions

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

4.3 parenscript.asdf

ASDF extensions that help compile and use Parenscript systems.

Source

package.lisp (file)

Use List
Used By List

parenscript.files

Exported Definitions

compile-script-system (function)

Internal Definitions

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

4.4 parenscript.reader

The Parenscript reader. Used for reading Parenscript forms.

The only significant difference between this and the standard lisp reader is that package names are script package names rather than Lisp package names.

Source

package.lisp (file)

Nickname

parenscript-reader

Use List

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


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

5.1.1 Functions

Function: compile-script-file SOURCE-FILE &key OUTPUT-SPEC COMP-ENV PRETTY-PRINT OUTPUT-STREAM

Compiles the given Parenscript source file and outputs the results to the given output stream.

Package

parenscript.files

Source

compile-file.lisp (file)

Function: compile-script-file-to-js-file SOURCE-FILE &rest ARGS &key DESTINATION-FILE &allow-other-keys

Compile SOURCE-FILE (a parenscript file) to a javascript file with compile-parenscript-file-to-string. When DESTINATION-FILE is omitted, then it will be named the same as SOURCE-FILE but with js extension.

Package

parenscript.files

Source

compile-file.lisp (file)

Function: compile-script-file-to-string SOURCE-FILE &rest REST

Compile SOURCE-FILE (a parenscript file) to a javascript string. (in-package ...) forms behave as expected and all other forms are evaluated according to the value of EVAL-FORMS-P. If the result of the evaluation is not nil then it’s compiled with js:js* and written to the output.

Package

parenscript.files

Source

compile-file.lisp (file)

Function: compile-script-system SYSTEM &key PRETTY-PRINT OUTPUT-SPEC OUTPUT-TO-STREAM OUTPUT-STREAM OUTPUT-TO-FILES COMP-ENV

Compiles a collection of parenscripts as described by an ASDF system into files or a specified output stream.

Package

parenscript.asdf

Source

paren-asdf.lisp (file)

Function: read-parenscript-form &optional STREAM EOF-ERROR-OP EOF-VALUE RECURSIVEP

Reads a parenscript form from a stream. Use instead of READ so we can replace the reader with a parenscript reader, if necessary.

Package

parenscript.files

Source

compile-file.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: *javascript-file-extension*
Package

parenscript.asdf

Source

paren-asdf.lisp (file)

Special Variable: *omit-implicit-load-op-dependency*
Package

parenscript.asdf

Source

paren-asdf.lisp (file)

Special Variable: *parenscript-file-extension*
Package

parenscript.asdf

Source

paren-asdf.lisp (file)

Special Variable: *ps-compile-noops*
Package

parenscript.asdf

Source

paren-asdf.lisp (file)

Special Variable: *ps-compile-ps-files*
Package

parenscript.asdf

Source

paren-asdf.lisp (file)


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

5.2.2 Macros

Macro: with-ps-compilation-environment (ENV) &body BODY
Package

parenscript.files

Source

compile-file.lisp (file)

Macro: with-toplevel-compilation (ENV) &body BODY
Package

parenscript.files

Source

compile-file.lisp (file)


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

5.2.3 Functions

Function: slurp-file-3000 PATHNAME

A SLURP-FILE function inspired Mr. Insane 3000’s SLURP-STREAM4.

Package

parenscript.asdf

Source

paren-asdf.lisp (file)


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

5.2.4 Generic functions

Generic Function: comp-env OBJECT
Generic Function: (setf comp-env) NEW-VALUE OBJECT
Package

parenscript.asdf

Methods
Method: comp-env (PARENSCRIPT-COMPILE-OP parenscript-compile-op)
Method: (setf comp-env) NEW-VALUE (PARENSCRIPT-COMPILE-OP parenscript-compile-op)

Compilaiton environment to use to compile.

Source

paren-asdf.lisp (file)

Generic Function: force-p OBJECT
Generic Function: (setf force-p) NEW-VALUE OBJECT
Package

parenscript.asdf

Methods
Method: force-p (PARENSCRIPT-COMPILE-OP parenscript-compile-op)
Method: (setf force-p) NEW-VALUE (PARENSCRIPT-COMPILE-OP parenscript-compile-op)

T to force compilation.

Source

paren-asdf.lisp (file)

Generic Function: output-spec OBJECT
Generic Function: (setf output-spec) NEW-VALUE OBJECT
Package

parenscript.asdf

Methods
Method: output-spec (PARENSCRIPT-COMPILE-OP parenscript-compile-op)

automatically generated reader method

Source

paren-asdf.lisp (file)

Method: (setf output-spec) NEW-VALUE (PARENSCRIPT-COMPILE-OP parenscript-compile-op)

automatically generated writer method

Source

paren-asdf.lisp (file)

Generic Function: output-stream OBJECT
Generic Function: (setf output-stream) NEW-VALUE OBJECT
Package

parenscript.asdf

Methods
Method: output-stream (PARENSCRIPT-COMPILE-OP parenscript-compile-op)
Method: (setf output-stream) NEW-VALUE (PARENSCRIPT-COMPILE-OP parenscript-compile-op)

The output stream in which to print the Javascript output.

Source

paren-asdf.lisp (file)

Generic Function: pretty-print-p OBJECT
Generic Function: (setf pretty-print-p) NEW-VALUE OBJECT
Package

parenscript.asdf

Methods
Method: pretty-print-p (PARENSCRIPT-COMPILE-OP parenscript-compile-op)
Method: (setf pretty-print-p) NEW-VALUE (PARENSCRIPT-COMPILE-OP parenscript-compile-op)

T if Javascript should be printed readably.

Source

paren-asdf.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M   P  
Index Entry  Section

F
File, Lisp, paren-files.asd: The paren-files<dot>asd file
File, Lisp, paren-files/src/compile-file.lisp: The paren-files/src/compile-file<dot>lisp file
File, Lisp, paren-files/src/package.lisp: The paren-files/src/package<dot>lisp file
File, Lisp, paren-files/src/paren-asdf.lisp: The paren-files/src/paren-asdf<dot>lisp file

L
Lisp File, paren-files.asd: The paren-files<dot>asd file
Lisp File, paren-files/src/compile-file.lisp: The paren-files/src/compile-file<dot>lisp file
Lisp File, paren-files/src/package.lisp: The paren-files/src/package<dot>lisp file
Lisp File, paren-files/src/paren-asdf.lisp: The paren-files/src/paren-asdf<dot>lisp file

M
Module, paren-files/src: The paren-files/src module

P
paren-files.asd: The paren-files<dot>asd file
paren-files/src: The paren-files/src module
paren-files/src/compile-file.lisp: The paren-files/src/compile-file<dot>lisp file
paren-files/src/package.lisp: The paren-files/src/package<dot>lisp file
paren-files/src/paren-asdf.lisp: The paren-files/src/paren-asdf<dot>lisp file

Jump to:   F   L   M   P  

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

A.2 Functions

Jump to:   (  
C   F   G   M   O   P   R   S   W  
Index Entry  Section

(
(setf comp-env): Internal generic functions
(setf comp-env): Internal generic functions
(setf force-p): Internal generic functions
(setf force-p): Internal generic functions
(setf output-spec): Internal generic functions
(setf output-spec): Internal generic functions
(setf output-stream): Internal generic functions
(setf output-stream): Internal generic functions
(setf pretty-print-p): Internal generic functions
(setf pretty-print-p): Internal generic functions

C
comp-env: Internal generic functions
comp-env: Internal generic functions
compile-script-file: Exported functions
compile-script-file-to-js-file: Exported functions
compile-script-file-to-string: Exported functions
compile-script-system: Exported functions

F
force-p: Internal generic functions
force-p: Internal generic functions
Function, compile-script-file: Exported functions
Function, compile-script-file-to-js-file: Exported functions
Function, compile-script-file-to-string: Exported functions
Function, compile-script-system: Exported functions
Function, read-parenscript-form: Exported functions
Function, slurp-file-3000: Internal functions

G
Generic Function, (setf comp-env): Internal generic functions
Generic Function, (setf force-p): Internal generic functions
Generic Function, (setf output-spec): Internal generic functions
Generic Function, (setf output-stream): Internal generic functions
Generic Function, (setf pretty-print-p): Internal generic functions
Generic Function, comp-env: Internal generic functions
Generic Function, force-p: Internal generic functions
Generic Function, output-spec: Internal generic functions
Generic Function, output-stream: Internal generic functions
Generic Function, pretty-print-p: Internal generic functions

M
Macro, with-ps-compilation-environment: Internal macros
Macro, with-toplevel-compilation: Internal macros
Method, (setf comp-env): Internal generic functions
Method, (setf force-p): Internal generic functions
Method, (setf output-spec): Internal generic functions
Method, (setf output-stream): Internal generic functions
Method, (setf pretty-print-p): Internal generic functions
Method, comp-env: Internal generic functions
Method, force-p: Internal generic functions
Method, output-spec: Internal generic functions
Method, output-stream: Internal generic functions
Method, pretty-print-p: Internal generic functions

O
output-spec: Internal generic functions
output-spec: Internal generic functions
output-stream: Internal generic functions
output-stream: Internal generic functions

P
pretty-print-p: Internal generic functions
pretty-print-p: Internal generic functions

R
read-parenscript-form: Exported functions

S
slurp-file-3000: Internal functions

W
with-ps-compilation-environment: Internal macros
with-toplevel-compilation: Internal macros

Jump to:   (  
C   F   G   M   O   P   R   S   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*javascript-file-extension*: Internal special variables
*omit-implicit-load-op-dependency*: Internal special variables
*parenscript-file-extension*: Internal special variables
*ps-compile-noops*: Internal special variables
*ps-compile-ps-files*: Internal special variables

S
Special Variable, *javascript-file-extension*: Internal special variables
Special Variable, *omit-implicit-load-op-dependency*: Internal special variables
Special Variable, *parenscript-file-extension*: Internal special variables
Special Variable, *ps-compile-noops*: Internal special variables
Special Variable, *ps-compile-ps-files*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, paren-files-system: The paren-files-system package
Package, parenscript.asdf: The parenscript<dot>asdf package
Package, parenscript.files: The parenscript<dot>files package
Package, parenscript.reader: The parenscript<dot>reader package
paren-files: The paren-files system
paren-files-system: The paren-files-system package
parenscript.asdf: The parenscript<dot>asdf package
parenscript.files: The parenscript<dot>files package
parenscript.reader: The parenscript<dot>reader package

S
System, paren-files: The paren-files system

Jump to:   P   S