The paren-files Reference Manual

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 4.0 beta 2 "William Riker" on Mon Aug 15 05:32:28 2022 GMT+0.

Table of Contents


1 Systems

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


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

1.1 paren-files

Parenscript library for compiling files and ASDF systems.

Author

Red Daly <reddaly@gmail.com.>

License

MIT

Version

0.0.1

Dependency

parenscript (system).

Source

paren-files.asd.

Child Component

src (module).


2 Modules

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


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

2.1 paren-files/src

Source

paren-files.asd.

Parent Component

paren-files (system).

Child Components

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   [Contents][Index]

3.1.1 paren-files/paren-files.asd

Source

paren-files.asd.

Parent Component

paren-files (system).

ASDF Systems

paren-files.

Packages

paren-files-system.


3.1.2 paren-files/src/package.lisp

Source

paren-files.asd.

Parent Component

src (module).

Packages

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

Dependency

package.lisp (file).

Source

paren-files.asd.

Parent Component

src (module).

Public Interface
Internals

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

Dependency

compile-file.lisp (file).

Source

paren-files.asd.

Parent Component

src (module).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 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.

Nickname

parenscript-reader

Use List
  • common-lisp.
  • parenscript.

4.2 parenscript.asdf

ASDF extensions that help compile and use Parenscript systems.

Source

package.lisp.

Use List
  • asdf/interface.
  • common-lisp.
  • parenscript.
Used By List

parenscript.files.

Public Interface

compile-script-system (function).

Internals

4.3 parenscript.files

Library that compiles Parenscript files and systems.

Source

package.lisp.

Nickname

paren-files

Use List
Public Interface
Internals

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

4.4 paren-files-system

Source

paren-files.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary 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.

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.

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.

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.

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.


5.1.2 Standalone methods

Method: component-depends-on ((op parenscript-compile-op) (system system))

Returns the list of operations the system depends on to ps-compile. We requrie that the lisp system be loaded first.

Package

asdf/action.

Source

paren-asdf.lisp.

Method: component-depends-on ((op parenscript-compile-op) (c component))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: operation-done-p ((op parenscript-compile-op) (file javascript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: operation-done-p ((op parenscript-compile-op) (file parenscript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: operation-done-p ((op parenscript-compile-op) (module module))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: operation-done-p ((op parenscript-compile-op) general-component)
Package

asdf/action.

Source

paren-asdf.lisp.

Method: output-files ((op parenscript-compile-op) general-component)

Parenscript compilation does not, in general, produce output files.

Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op parenscript-compile-op) (file parenscript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op parenscript-compile-op) (file javascript-file))

Include the javascript in the output stream.

Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op parenscript-compile-op) (file source-file))

Do nothing on a source (non-compound) component.

Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op parenscript-compile-op) general-component)

Do the usual on some non-specific component.

Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op load-op) (file javascript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op compile-op) (file javascript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op load-op) (paren-file parenscript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: perform ((op compile-op) (paren-file parenscript-file))
Package

asdf/action.

Source

paren-asdf.lisp.

Method: source-file-type ((c javascript-file) (s module))
Package

asdf/component.

Source

paren-asdf.lisp.

Method: source-file-type ((c parenscript-file) (s module))
Package

asdf/component.

Source

paren-asdf.lisp.


5.2 Internals


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

5.2.1 Special variables

Special Variable: *javascript-file-extension*
Package

parenscript.asdf.

Source

paren-asdf.lisp.

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

parenscript.asdf.

Source

paren-asdf.lisp.

Special Variable: *parenscript-file-extension*
Package

parenscript.asdf.

Source

paren-asdf.lisp.

Special Variable: *ps-compile-noops*
Package

parenscript.asdf.

Source

paren-asdf.lisp.

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

parenscript.asdf.

Source

paren-asdf.lisp.


5.2.2 Macros

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

parenscript.files.

Source

compile-file.lisp.

Macro: with-toplevel-compilation ((env) &body body)
Package

parenscript.files.

Source

compile-file.lisp.


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

5.2.3 Ordinary functions

Function: slurp-file-3000 (pathname)

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

Package

parenscript.asdf.

Source

paren-asdf.lisp.


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

5.2.4 Generic functions

Generic Reader: comp-env (object)
Generic Writer: (setf comp-env) (object)
Package

parenscript.asdf.

Methods
Reader Method: comp-env ((parenscript-compile-op parenscript-compile-op))
Writer Method: (setf comp-env) ((parenscript-compile-op parenscript-compile-op))

Compilaiton environment to use to compile.

Source

paren-asdf.lisp.

Target Slot

comp-env.

Generic Reader: force-p (object)
Generic Writer: (setf force-p) (object)
Package

parenscript.asdf.

Methods
Reader Method: force-p ((parenscript-compile-op parenscript-compile-op))
Writer Method: (setf force-p) ((parenscript-compile-op parenscript-compile-op))

T to force compilation.

Source

paren-asdf.lisp.

Target Slot

force-p.

Generic Reader: output-spec (object)
Package

parenscript.asdf.

Methods
Reader Method: output-spec ((parenscript-compile-op parenscript-compile-op))

automatically generated reader method

Source

paren-asdf.lisp.

Target Slot

output-spec.

Generic Writer: (setf output-spec) (object)
Package

parenscript.asdf.

Methods
Writer Method: (setf output-spec) ((parenscript-compile-op parenscript-compile-op))

automatically generated writer method

Source

paren-asdf.lisp.

Target Slot

output-spec.

Generic Reader: output-stream (object)
Generic Writer: (setf output-stream) (object)
Package

parenscript.asdf.

Methods
Reader Method: output-stream ((parenscript-compile-op parenscript-compile-op))
Writer Method: (setf output-stream) ((parenscript-compile-op parenscript-compile-op))

The output stream in which to print the Javascript output.

Source

paren-asdf.lisp.

Target Slot

output-stream.

Generic Reader: pretty-print-p (object)
Generic Writer: (setf pretty-print-p) (object)
Package

parenscript.asdf.

Methods
Reader Method: pretty-print-p ((parenscript-compile-op parenscript-compile-op))
Writer Method: (setf pretty-print-p) ((parenscript-compile-op parenscript-compile-op))

T if Javascript should be printed readably.

Source

paren-asdf.lisp.

Target Slot

pretty-print-p.


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

5.2.5 Classes

Class: javascript-file
Package

asdf/interface.

Source

paren-asdf.lisp.

Direct superclasses

source-file.

Direct methods
Class: parenscript-compile-op

The operation used in conjunction with parenscript:compile-script-system.

Package

asdf/interface.

Source

paren-asdf.lisp.

Direct superclasses

operation.

Direct methods
Direct slots
Slot: output-spec
Package

parenscript.asdf.

Initform

:javascript

Initargs

:output-spec

Readers

output-spec.

Writers

(setf output-spec).

Slot: comp-env

Compilaiton environment to use to compile.

Package

parenscript.asdf.

Initargs

:comp-env

Readers

comp-env.

Writers

(setf comp-env).

Slot: pretty-print-p

T if Javascript should be printed readably.

Package

parenscript.asdf.

Initargs

:pretty-print

Readers

pretty-print-p.

Writers

(setf pretty-print-p).

Slot: output-stream

The output stream in which to print the Javascript output.

Package

parenscript.asdf.

Initform

*standard-output*

Initargs

:output-stream

Readers

output-stream.

Writers

(setf output-stream).

Slot: force-p

T to force compilation.

Package

parenscript.asdf.

Initargs

:force-p

Readers

force-p.

Writers

(setf force-p).

Class: parenscript-file
Package

asdf/interface.

Source

paren-asdf.lisp.

Direct superclasses

source-file.

Direct methods

Appendix A Indexes


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

A.1 Concepts


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): Private generic functions
(setf comp-env): Private generic functions
(setf force-p): Private generic functions
(setf force-p): Private generic functions
(setf output-spec): Private generic functions
(setf output-spec): Private generic functions
(setf output-stream): Private generic functions
(setf output-stream): Private generic functions
(setf pretty-print-p): Private generic functions
(setf pretty-print-p): Private generic functions

C
comp-env: Private generic functions
comp-env: Private generic functions
compile-script-file: Public ordinary functions
compile-script-file-to-js-file: Public ordinary functions
compile-script-file-to-string: Public ordinary functions
compile-script-system: Public ordinary functions
component-depends-on: Public standalone methods
component-depends-on: Public standalone methods

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

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

M
Macro, with-ps-compilation-environment: Private macros
Macro, with-toplevel-compilation: Private macros
Method, (setf comp-env): Private generic functions
Method, (setf force-p): Private generic functions
Method, (setf output-spec): Private generic functions
Method, (setf output-stream): Private generic functions
Method, (setf pretty-print-p): Private generic functions
Method, comp-env: Private generic functions
Method, component-depends-on: Public standalone methods
Method, component-depends-on: Public standalone methods
Method, force-p: Private generic functions
Method, operation-done-p: Public standalone methods
Method, operation-done-p: Public standalone methods
Method, operation-done-p: Public standalone methods
Method, operation-done-p: Public standalone methods
Method, output-files: Public standalone methods
Method, output-spec: Private generic functions
Method, output-stream: Private generic functions
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, pretty-print-p: Private generic functions
Method, source-file-type: Public standalone methods
Method, source-file-type: Public standalone methods

O
operation-done-p: Public standalone methods
operation-done-p: Public standalone methods
operation-done-p: Public standalone methods
operation-done-p: Public standalone methods
output-files: Public standalone methods
output-spec: Private generic functions
output-spec: Private generic functions
output-stream: Private generic functions
output-stream: Private generic functions

P
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
perform: Public standalone methods
pretty-print-p: Private generic functions
pretty-print-p: Private generic functions

R
read-parenscript-form: Public ordinary functions

S
slurp-file-3000: Private ordinary functions
source-file-type: Public standalone methods
source-file-type: Public standalone methods

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

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

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

A.4 Data types

Jump to:   C   F   J   M   P   S  
Index Entry  Section

C
Class, javascript-file: Private classes
Class, parenscript-compile-op: Private classes
Class, parenscript-file: Private classes
compile-file.lisp: The paren-files/src/compile-file․lisp file

F
File, compile-file.lisp: The paren-files/src/compile-file․lisp file
File, package.lisp: The paren-files/src/package․lisp file
File, paren-asdf.lisp: The paren-files/src/paren-asdf․lisp file
File, paren-files.asd: The paren-files/paren-files․asd file

J
javascript-file: Private classes

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

P
Package, paren-files-system: The paren-files-system package
Package, parenscript.asdf: The parenscript․asdf package
Package, parenscript.files: The parenscript․files package
Package, parenscript.reader: The parenscript․reader package
package.lisp: The paren-files/src/package․lisp file
paren-asdf.lisp: The paren-files/src/paren-asdf․lisp file
paren-files: The paren-files system
paren-files-system: The paren-files-system package
paren-files.asd: The paren-files/paren-files․asd file
parenscript-compile-op: Private classes
parenscript-file: Private classes
parenscript.asdf: The parenscript․asdf package
parenscript.files: The parenscript․files package
parenscript.reader: The parenscript․reader package

S
src: The paren-files/src module
System, paren-files: The paren-files system

Jump to:   C   F   J   M   P   S