The ceramic Reference Manual

Child Component

src (module).

Next: Files, Previous: Systems, Up: The ceramic Reference Manual [Contents][Index]

3 Modules

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

ceramic/src

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

3.1 `ceramic/src`

Source

Parent Component

ceramic (system).

Child Components

error.lisp (file).
os.lisp (file).
file.lisp (file).
logging.lisp (file).
runtime.lisp (file).
resource.lisp (file).
setup.lisp (file).
main.js (file).
driver.lisp (file).
window.lisp (file).
crashreporter.lisp (file).
dialog.lisp (file).
bundler.lisp (file).
ceramic.lisp (file).
quit.lisp (file).

Next: Packages, Previous: Modules, Up: The ceramic Reference Manual [Contents][Index]

4 Files

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

Lisp
Static

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

Next: ceramic/src/error.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `ceramic/ceramic.asd`

Source: ceramic.asd.
Parent Component: ceramic (system).
ASDF Systems: ceramic.

Next: ceramic/src/os.lisp, Previous: ceramic/ceramic.asd, Up: Lisp [Contents][Index]

4.1.2 `ceramic/src/error.lisp`

Source

Parent Component

src (module).

Packages

Public Interface

ceramic-error (condition).
no-such-tag (condition).
not-in-release (condition).
unsupported-operating-system (condition).

Internals

error-tag (reader method).
os-name (reader method).

Next: ceramic/src/file.lisp, Previous: ceramic/src/error.lisp, Up: Lisp [Contents][Index]

4.1.3 `ceramic/src/os.lisp`

Dependency

error.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.os.

Public Interface

*architecture* (special variable).
*operating-system* (special variable).

Internals

detect-architecture (function).
detect-operating-system (function).

Next: ceramic/src/logging.lisp, Previous: ceramic/src/os.lisp, Up: Lisp [Contents][Index]

4.1.4 `ceramic/src/file.lisp`

Dependency

os.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.file.

Public Interface

*ceramic-directory* (special variable).
release-directory (function).
wipe-data (function).

Next: ceramic/src/runtime.lisp, Previous: ceramic/src/file.lisp, Up: Lisp [Contents][Index]

4.1.5 `ceramic/src/logging.lisp`

Dependency

file.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.log.

Public Interface

*logging* (special variable).
*logging-stream* (special variable).
log-message (function).

Next: ceramic/src/resource.lisp, Previous: ceramic/src/logging.lisp, Up: Lisp [Contents][Index]

4.1.6 `ceramic/src/runtime.lisp`

Dependency

logging.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.runtime.

Public Interface

*releasep* (special variable).
executable-pathname (function).
executable-relative-pathname (function).

Next: ceramic/src/setup.lisp, Previous: ceramic/src/runtime.lisp, Up: Lisp [Contents][Index]

4.1.7 `ceramic/src/resource.lisp`

Dependency

runtime.lisp (file).

Source

Parent Component

src (module).

Packages

Public Interface

copy-resources (function).
define-resources (macro).
resource (function).
resource (class).
resource-directory (function).

Internals

*resources* (special variable).
call-define-resources (function).
get-resource (function).
release-resources-directory (function).
resource-pathname (reader method).
resource-system (reader method).
resource-tag (reader method).

Next: ceramic/src/driver.lisp, Previous: ceramic/src/resource.lisp, Up: Lisp [Contents][Index]

4.1.8 `ceramic/src/setup.lisp`

Dependency

resource.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.setup.

Public Interface

setup (function).

Internals

*electron-version* (special variable).
+main-javascript+ (special variable).
+ws-module+ (special variable).
clean-release (function).
copy-ws-module (function).
insert-javascript (function).
insert-package-definition (function).
prepare-release (function).

Next: ceramic/src/window.lisp, Previous: ceramic/src/setup.lisp, Up: Lisp [Contents][Index]

4.1.9 `ceramic/src/driver.lisp`

Dependency

main.js (file).

Source

Parent Component

src (module).

Packages

Public Interface

*driver* (special variable).
driver (class).
js (generic function).
start (generic function).
stop (generic function).
sync-js (generic function).

Internals

address (generic function).
driver-context (reader method).
(setf driver-context) (writer method).
driver-js-cond (reader method).
(setf driver-js-cond) (writer method).
driver-js-lock (reader method).
(setf driver-js-lock) (writer method).
driver-process (reader method).
(setf driver-process) (writer method).
driver-responses (reader method).
(setf driver-responses) (writer method).
on-message (generic function).
port (generic function).
start-electron (method).
start-remote-js (method).
stop-electron (method).
stop-remote-js (method).
wait-for-client (method).

Next: ceramic/src/crashreporter.lisp, Previous: ceramic/src/driver.lisp, Up: Lisp [Contents][Index]

4.1.10 `ceramic/src/window.lisp`

Dependency

driver.lisp (file).

Source

Parent Component

src (module).

Packages

Public Interface

back (method).
center (method).
close (method).
close-dev-tools (method).
copy (method).
crashedp (method).
cut (method).
forward (method).
hide (method).
loadingp (method).
make-window (function).
open-dev-tools (method).
paste (method).
redo (method).
reload (method).
select-all (method).
show (method).
stop-loading (method).
title (method).
(setf title) (method).
undo (method).
unselect (method).
url (method).
(setf url) (method).
window (class).
window-id (reader method).

Internals

%reload (method).
%reload-force (method).
define-trivial-operation (macro).
js (function).
sync-js (function).

Next: ceramic/src/dialog.lisp, Previous: ceramic/src/window.lisp, Up: Lisp [Contents][Index]

4.1.11 `ceramic/src/crashreporter.lisp`

Dependency: window.lisp (file).
Source: ceramic.asd.
Parent Component: src (module).
Packages: ceramic.crashreporter.
Public Interface: start-crash-reporter (function).

Next: ceramic/src/bundler.lisp, Previous: ceramic/src/crashreporter.lisp, Up: Lisp [Contents][Index]

4.1.12 `ceramic/src/dialog.lisp`

Dependency

crashreporter.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.dialog.

Public Interface

show-error-box (function).
show-message-box (function).
show-open-dialog (function).
show-save-dialog (function).

Internals

+message-box-default-buttons+ (special variable).
+message-box-types+ (special variable).
file-filters (function).
show-standard-dialog (function).

Next: ceramic/src/ceramic.lisp, Previous: ceramic/src/dialog.lisp, Up: Lisp [Contents][Index]

4.1.13 `ceramic/src/bundler.lisp`

Dependency

dialog.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic.bundler.

Public Interface

bundle (function).

Internals

archive-extension (function).
create-archive (function).

Next: ceramic/src/quit.lisp, Previous: ceramic/src/bundler.lisp, Up: Lisp [Contents][Index]

4.1.14 `ceramic/src/ceramic.lisp`

Dependency

bundler.lisp (file).

Source

Parent Component

src (module).

Packages

ceramic-entry.
ceramic.

Public Interface

define-entry-point (macro).
start (function).
stop (function).

Previous: ceramic/src/ceramic.lisp, Up: Lisp [Contents][Index]

4.1.15 `ceramic/src/quit.lisp`

Dependency: ceramic.lisp (file).
Source: ceramic.asd.
Parent Component: src (module).
Public Interface: quit (function).

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

4.2 Static

ceramic/src/main.js

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

4.2.1 `ceramic/src/main.js`

Dependency: setup.lisp (file).
Source: ceramic.asd.
Parent Component: src (module).

Next: Definitions, Previous: Files, Up: The ceramic Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

ceramic.error
ceramic.resource
ceramic-entry
ceramic.os
ceramic.crashreporter
ceramic.bundler
ceramic
ceramic.log
ceramic.setup
ceramic.window
ceramic.file
ceramic.driver
ceramic.dialog
ceramic.runtime

Next: ceramic.resource, Previous: Packages, Up: Packages [Contents][Index]

5.1 `ceramic.error`

Error conditions.

Source

Use List

common-lisp.

Public Interface

ceramic-error (condition).
no-such-tag (condition).
not-in-release (condition).
unsupported-operating-system (condition).

Internals

error-tag (generic reader).
os-name (generic reader).

Next: ceramic-entry, Previous: ceramic.error, Up: Packages [Contents][Index]

5.2 `ceramic.resource`

Ceramic’s resource-management utilities.

Source

resource.lisp.

Use List

common-lisp.

Public Interface

copy-resources (function).
define-resources (macro).
resource (function).
resource (class).
resource-directory (function).

Internals

*resources* (special variable).
call-define-resources (function).
get-resource (function).
release-resources-directory (function).
resource-pathname (generic reader).
resource-system (generic reader).
resource-tag (generic reader).

Next: ceramic.os, Previous: ceramic.resource, Up: Packages [Contents][Index]

5.3 `ceramic-entry`

Source: ceramic.lisp.
Use List: common-lisp.

Next: ceramic.crashreporter, Previous: ceramic-entry, Up: Packages [Contents][Index]

5.4 `ceramic.os`

Operating system-related stuff.

Source

os.lisp.

Use List

common-lisp.

Public Interface

*architecture* (special variable).
*operating-system* (special variable).

Internals

detect-architecture (function).
detect-operating-system (function).

Next: ceramic.bundler, Previous: ceramic.os, Up: Packages [Contents][Index]

5.5 `ceramic.crashreporter`

Start Electron’s Crash Reporter.

Source: crashreporter.lisp.
Use List: common-lisp.
Public Interface: start-crash-reporter (function).

Next: ceramic, Previous: ceramic.crashreporter, Up: Packages [Contents][Index]

5.6 `ceramic.bundler`

Release applications.

Source

bundler.lisp.

Use List

common-lisp.

Public Interface

bundle (function).

Internals

archive-extension (function).
create-archive (function).

Next: ceramic.log, Previous: ceramic.bundler, Up: Packages [Contents][Index]

5.7 `ceramic`

The main interface.

Source

ceramic.lisp.

Use List

common-lisp.

Public Interface

define-entry-point (macro).
quit (function).
start (function).
stop (function).

Next: ceramic.setup, Previous: ceramic, Up: Packages [Contents][Index]

5.8 `ceramic.log`

Logging.

Source

logging.lisp.

Use List

common-lisp.

Public Interface

*logging* (special variable).
*logging-stream* (special variable).
log-message (function).

Next: ceramic.window, Previous: ceramic.log, Up: Packages [Contents][Index]

5.9 `ceramic.setup`

Set up everything needed to develop with Ceramic.

Source

setup.lisp.

Use List

common-lisp.

Public Interface

setup (function).

Internals

*electron-version* (special variable).
+main-javascript+ (special variable).
+ws-module+ (special variable).
clean-release (function).
copy-ws-module (function).
insert-javascript (function).
insert-package-definition (function).
prepare-release (function).

Next: ceramic.file, Previous: ceramic.setup, Up: Packages [Contents][Index]

5.10 `ceramic.window`

The window class and its implementation.

Source

window.lisp.

Use List

common-lisp.

Public Interface

back (generic function).
center (generic function).
close (generic function).
close-dev-tools (generic function).
copy (generic function).
crashedp (generic function).
cut (generic function).
forward (generic function).
hide (generic function).
loadingp (generic function).
make-window (function).
open-dev-tools (generic function).
paste (generic function).
redo (generic function).
reload (generic function).
select-all (generic function).
show (generic function).
stop-loading (generic function).
title (generic function).
(setf title) (generic function).
undo (generic function).
unselect (generic function).
url (generic function).
(setf url) (generic function).
window (class).
window-id (generic reader).

Internals

%reload (generic function).
%reload-force (generic function).
define-trivial-operation (macro).
js (function).
sync-js (function).

Next: ceramic.driver, Previous: ceramic.window, Up: Packages [Contents][Index]

5.11 `ceramic.file`

Ceramic’s files and directory utilities.

Source

file.lisp.

Use List

common-lisp.

Public Interface

*ceramic-directory* (special variable).
release-directory (function).
wipe-data (function).

Next: ceramic.dialog, Previous: ceramic.file, Up: Packages [Contents][Index]

5.12 `ceramic.driver`

The Ceramic driver interface.

Source

Use List

common-lisp.

Public Interface

*driver* (special variable).
driver (class).
js (generic function).
start (generic function).
stop (generic function).
sync-js (generic function).

Internals

address (generic function).
driver-context (generic reader).
(setf driver-context) (generic writer).
driver-js-cond (generic reader).
(setf driver-js-cond) (generic writer).
driver-js-lock (generic reader).
(setf driver-js-lock) (generic writer).
driver-process (generic reader).
(setf driver-process) (generic writer).
driver-responses (generic reader).
(setf driver-responses) (generic writer).
on-message (generic function).
port (generic function).
start-electron (generic function).
start-remote-js (generic function).
stop-electron (generic function).
stop-remote-js (generic function).
wait-for-client (generic function).

Next: ceramic.runtime, Previous: ceramic.driver, Up: Packages [Contents][Index]

5.13 `ceramic.dialog`

Source

dialog.lisp.

Use List

common-lisp.

Public Interface

show-error-box (function).
show-message-box (function).
show-open-dialog (function).
show-save-dialog (function).

Internals

+message-box-default-buttons+ (special variable).
+message-box-types+ (special variable).
file-filters (function).
show-standard-dialog (function).

Previous: ceramic.dialog, Up: Packages [Contents][Index]

5.14 `ceramic.runtime`

Tools for execution during release.

Source

runtime.lisp.

Use List

common-lisp.

Public Interface

*releasep* (special variable).
executable-pathname (function).
executable-relative-pathname (function).

Next: Indexes, Previous: Packages, Up: The ceramic Reference Manual [Contents][Index]

6 Definitions

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

Public Interface
Internals

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

6.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions
Conditions
Classes

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Special variables

Special Variable: *architecture* ¶

The OS architecture. Either @c(:64) or @c(:32).

Package: ceramic.os.
Source: os.lisp.

Special Variable: *ceramic-directory* ¶

The directory where Ceramic stores its files.

Package: ceramic.file.
Source: file.lisp.

Special Variable: *driver* ¶

The global driver object.

Package: ceramic.driver.
Source: driver.lisp.

Special Variable: *logging* ¶

Whether or not to log info.

Package: ceramic.log.
Source: logging.lisp.

Special Variable: *logging-stream* ¶

The logging stream.

Package: ceramic.log.
Source: logging.lisp.

Special Variable: *operating-system* ¶

The operating system. Either @c(:linux), @c(:windows) or @c(:mac).

Package: ceramic.os.
Source: os.lisp.

Special Variable: *releasep* ¶

Dynamically bound to t when in release mode.

Package: ceramic.runtime.
Source: runtime.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Macros

Macro: define-entry-point (system-name () &body body) ¶

Define the application’s entry point.

Package: ceramic.
Source: ceramic.lisp.

Macro: define-resources (system-name () &rest pairs) ¶

Define resource tags for a system.

Package: ceramic.resource.
Source: resource.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.3 Ordinary functions

Function: bundle (system-name &key bundle-pathname system-directory) ¶

Compile the application to an executable, and ship it with its resources.

Package: ceramic.bundler.
Source: bundler.lisp.

Function: copy-resources (directory) ¶

Copy all resource directories to @cl:param(directory).

Package: ceramic.resource.
Source: resource.lisp.

Function: executable-pathname () ¶

Return the executable’s pathname.

Package: ceramic.runtime.
Source: runtime.lisp.

Function: executable-relative-pathname (pathname) ¶

Return an absolute pathname relative to the executable pathname.

Package: ceramic.runtime.
Source: runtime.lisp.

Function: log-message (message &rest args) ¶

Package: ceramic.log.
Source: logging.lisp.

Function: make-window (&key title url width height frame show transparent resizable class) ¶

Create a window.

Package: ceramic.window.
Source: window.lisp.

Function: quit (&optional exit-status) ¶

Kill the Electron process and the Lisp process.

Package: ceramic.
Source: quit.lisp.

Function: release-directory () ¶

Pathname to the local copy of the Electron release.

Package: ceramic.file.
Source: file.lisp.

Function: resource (resource-tag pathname) ¶

Return the pathname of a resource relative to the directory of a resource tag.

Package: ceramic.resource.
Source: resource.lisp.

Function: resource-directory (resource-tag) ¶

Return the directory associated to a resource tag.

Package: ceramic.resource.
Source: resource.lisp.

Function: setup (&key force) ¶

Set up everything needed to start developing.

Package: ceramic.setup.
Source: setup.lisp.

Function: show-error-box (title content) ¶

Display a dialog that shows an error message.

Package: ceramic.dialog.
Source: dialog.lisp.

Function: show-message-box (message &key window type buttons default-id title detail icon cancel-id no-link) ¶

Show a message box dialog.

Package: ceramic.dialog.
Source: dialog.lisp.

Function: show-open-dialog (&key window title default-path button-label open-file open-directory multi-selections create-directory show-hidden-files filters) ¶

Show an Open dialog.

Package: ceramic.dialog.
Source: dialog.lisp.

Function: show-save-dialog (&key window title default-path button-label filters) ¶

Show a Save dialog.

Package: ceramic.dialog.
Source: dialog.lisp.

Function: start () ¶

Start the Electron process.

Package: ceramic.
Source: ceramic.lisp.

Function: start-crash-reporter (company-name submit-url &key options) ¶

Package: ceramic.crashreporter.
Source: crashreporter.lisp.

Function: stop () ¶

Stop the Electron process.

Package: ceramic.
Source: ceramic.lisp.

Function: wipe-data () ¶

Wipe all Ceramic related data.

Package: ceramic.file.
Source: file.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.4 Generic functions

Generic Function: back (window) ¶

Package

Methods

Method: back ((window window)) ¶

Go back in the page history.

Source: window.lisp.

Generic Function: center (window) ¶

Package

Methods

Method: center ((window window)) ¶

Move the window to the center of the screen.

Source: window.lisp.

Generic Function: close (window) ¶

Package

Methods

Method: close ((window window)) ¶

Close the window.

Source: window.lisp.

Generic Function: close-dev-tools (window) ¶

Package

Methods

Method: close-dev-tools ((window window)) ¶

Close the developer tools.

Source: window.lisp.

Generic Function: copy (window) ¶

Package

Methods

Method: copy ((window window)) ¶

Copy selected text.

Source: window.lisp.

Generic Function: crashedp (window) ¶

Package

Methods

Method: crashedp ((window window)) ¶

Return whether the window has crashed.

Source: window.lisp.

Generic Function: cut (window) ¶

Package

Methods

Method: cut ((window window)) ¶

Cut selected text.

Source: window.lisp.

Generic Function: forward (window) ¶

Package

Methods

Method: forward ((window window)) ¶

Go forward in the page history.

Source: window.lisp.

Generic Function: hide (window) ¶

Package

Methods

Method: hide ((window window)) ¶

Hide the window from the user.

Source: window.lisp.

Generic Function: js (driver js) ¶

Evaluate a string of JavaScript in the Electron process.

Package

Source

Methods

Method: js ((driver driver) js) ¶

Generic Function: loadingp (window) ¶

Package

Methods

Method: loadingp ((window window)) ¶

Return whether the window is loading a new page.

Source: window.lisp.

Generic Function: open-dev-tools (window) ¶

Package

Methods

Method: open-dev-tools ((window window)) ¶

Open the developer tools.

Source: window.lisp.

Generic Function: paste (window) ¶

Package

Methods

Method: paste ((window window)) ¶

Paste text.

Source: window.lisp.

Generic Function: redo (window) ¶

Package

Methods

Method: redo ((window window)) ¶

Redo changes.

Source: window.lisp.

Generic Function: reload (window &key ignore-cache) ¶

Package

Methods

Method: reload ((window window) &key ignore-cache) ¶

Reload the window. Optionally ignore the cache.

Source: window.lisp.

Generic Function: select-all (window) ¶

Package

Methods

Method: select-all ((window window)) ¶

Select all text.

Source: window.lisp.

Generic Function: show (window) ¶

Package

Methods

Method: show ((window window)) ¶

Show the window to the user.

Source: window.lisp.

Generic Function: start (driver) ¶

Start the Electron process and the remote-js server.

Package

Source

Methods

Method: start ((driver driver)) ¶

Generic Function: stop (driver) ¶

Stop the Electron process and the remote-js server.

Package

Source

Methods

Method: stop ((driver driver)) ¶

Generic Function: stop-loading (window) ¶

Package

Methods

Method: stop-loading ((window window)) ¶

Stop any navigation.

Source: window.lisp.

Generic Function: sync-js (driver js) ¶

Synchronously evaluate JavaScript in the Electron process, returning a string containing the result of the evaluation.

Package

Source

Methods

Method: sync-js ((driver driver) js) ¶

Generic Function: title (window) ¶

Package

Methods

Method: title ((window window)) ¶

Return the window’s title.

Source: window.lisp.

Generic Function: (setf title) (window) ¶

Package

Methods

Method: (setf title) ((window window)) ¶

Set the window’s title.

Source: window.lisp.

Generic Function: undo (window) ¶

Package

Methods

Method: undo ((window window)) ¶

Undo changes.

Source: window.lisp.

Generic Function: unselect (window) ¶

Package

Methods

Method: unselect ((window window)) ¶

Cancel the selection.

Source: window.lisp.

Generic Function: url (window) ¶

Package

Methods

Method: url ((window window)) ¶

Return the window’s current URL.

Source: window.lisp.

Generic Function: (setf url) (window) ¶

Package

Methods

Method: (setf url) ((window window)) ¶

Change the window’s URL.

Source: window.lisp.

Generic Reader: window-id (object) ¶

Package

Methods

Reader Method: window-id ((window window)) ¶

A unique string ID for the window.

Source: window.lisp.
Target Slot: %id.

Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]

6.1.5 Conditions

Condition: ceramic-error ¶

The base class of Ceramic-related conditions.

Package

Source

Direct superclasses

condition.

Direct subclasses

no-such-tag.
not-in-release.
unsupported-operating-system.

Condition: no-such-tag ¶

Signalled when the program references a resource tag that doesn’t exist.

Package

Source

Direct superclasses

ceramic-error.

Direct methods

error-tag.

Direct slots

Slot: tag ¶

The resource tag.

Initargs: :tag
Readers: error-tag.
Writers: This slot is read-only.

Condition: not-in-release ¶

Signalled when an operation that requires Ceramic to run in release mode is called in interactive mode.

Package: ceramic.error.
Source: error.lisp.
Direct superclasses: ceramic-error.

Condition: unsupported-operating-system ¶

Package

Source

Direct superclasses

ceramic-error.

Direct methods

os-name.

Direct slots

Slot: os-name ¶

The name of the operating system.

Initargs: :os-name
Readers: os-name.
Writers: This slot is read-only.

Previous: Conditions, Up: Public Interface [Contents][Index]

6.1.6 Classes

Class: driver ¶

The Ceramic driver.

Package

Source

Direct methods

Direct slots

Slot: process ¶

The Electron process.

Readers: driver-process.
Writers: (setf driver-process).

Slot: context ¶

The remote-js object.

Type: remote-js:buffered-context
Readers: driver-context.
Writers: (setf driver-context).

Slot: js-lock ¶

A lock object for js sync

Initform: (bordeaux-threads:make-lock "ceramic-js-sync")
Readers: driver-js-lock.
Writers: (setf driver-js-lock).

Slot: js-cond ¶

A condition variable for js sync

Initform: (bordeaux-threads:make-condition-variable)
Readers: driver-js-cond.
Writers: (setf driver-js-cond).

Slot: responses ¶

A hash table of message IDs to evaluation results.

Type: hash-table
Initform: (make-hash-table :test (function equal))
Readers: driver-responses.
Writers: (setf driver-responses).

Class: resource ¶

A resource.

Package

Source

resource.lisp.

Direct methods

resource-pathname.
resource-system.
resource-tag.

Direct slots

Slot: tag ¶

The resource tag.

Type: symbol
Initargs: :tag
Readers: resource-tag.
Writers: This slot is read-only.

Slot: pathname ¶

The directory, relative to the system directory.

Package: common-lisp.
Type: pathname
Initargs: :pathname
Readers: resource-pathname.
Writers: This slot is read-only.

Slot: system ¶

The name of the system this resource is relative to.

Type: keyword
Initargs: :system
Readers: resource-system.
Writers: This slot is read-only.

Class: window ¶

A browser window.

Package

Source

window.lisp.

Direct methods

Direct slots

Slot: %id ¶

A unique string ID for the window.

Type: string
Initform: (uuid:format-as-urn nil (uuid:make-v4-uuid))
Readers: window-id.
Writers: This slot is read-only.

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

6.2 Internals

Special variables
Macros
Ordinary functions
Generic functions

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

6.2.1 Special variables

Special Variable: *electron-version* ¶

The version of Electron to use.

Package: ceramic.setup.
Source: setup.lisp.

Special Variable: *resources* ¶

The list of resources.

Package: ceramic.resource.
Source: resource.lisp.

Special Variable: +main-javascript+ ¶

Pathname to the JavaScript file for the main process.

Package: ceramic.setup.
Source: setup.lisp.

Special Variable: +message-box-default-buttons+ ¶

Package: ceramic.dialog.
Source: dialog.lisp.

Special Variable: +message-box-types+ ¶

Package: ceramic.dialog.
Source: dialog.lisp.

Special Variable: +ws-module+ ¶

Package: ceramic.setup.
Source: setup.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

6.2.2 Macros

Macro: define-trivial-operation (name js &key docstring sync) ¶

Package: ceramic.window.
Source: window.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

6.2.3 Ordinary functions

Function: archive-extension () ¶

Use zip files on Windows and tar archives on Unix. This is necessary because tar archives preserve permissions (important for executing!), but Windows doesn’t care about that, and Windows doesn’t natively know about tar files (But most people can unzip).

Package: ceramic.bundler.
Source: bundler.lisp.

Function: call-define-resources (system-name pairs) ¶

Package: ceramic.resource.
Source: resource.lisp.

Function: clean-release (directory &key operating-system) ¶

Clean up default files from an Electron release.

Package: ceramic.setup.
Source: setup.lisp.

Function: copy-ws-module (directory &key operating-system) ¶

Copy the WebSockets module.

Package: ceramic.setup.
Source: setup.lisp.

Function: create-archive (directory output) ¶

Package: ceramic.bundler.
Source: bundler.lisp.

Function: detect-architecture () ¶

Package: ceramic.os.
Source: os.lisp.

Function: detect-operating-system () ¶

Package: ceramic.os.
Source: os.lisp.

Function: file-filters (spec) ¶

Package: ceramic.dialog.
Source: dialog.lisp.

Function: get-resource (resource-tag) ¶

Return the resource associated to a resource tag.

Package: ceramic.resource.
Source: resource.lisp.

Function: insert-javascript (directory &key operating-system) ¶

Insert the main process JavaScript into an Electron release.

Package: ceramic.setup.
Source: setup.lisp.

Function: insert-package-definition (directory &key operating-system) ¶

Insert the package.json into an Electron release.

Package: ceramic.setup.
Source: setup.lisp.

Function: js (format-control &rest args) ¶

Package: ceramic.window.
Source: window.lisp.

Function: prepare-release (directory &key operating-system) ¶

Prepare an Electron release.

Package: ceramic.setup.
Source: setup.lisp.

Function: release-resources-directory () ¶

The directory where resource directories are stored, relative to the executable pathname.

Package: ceramic.resource.
Source: resource.lisp.

Function: show-standard-dialog (action window options) ¶

Package: ceramic.dialog.
Source: dialog.lisp.

Function: sync-js (format-control &rest args) ¶

Package: ceramic.window.
Source: window.lisp.

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

6.2.4 Generic functions

Generic Function: %reload (window) ¶

Package

Methods

Method: %reload ((window window)) ¶

Source: window.lisp.

Generic Function: %reload-force (window) ¶

Package

Methods

Method: %reload-force ((window window)) ¶

Source: window.lisp.

Generic Function: address (driver) ¶

Return the address the WebSockets server is running on.

Package

Source

Methods

Method: address ((driver driver)) ¶

Generic Reader: driver-context (object) ¶

Generic Writer: (setf driver-context) (object) ¶

Package

Methods

Reader Method: driver-context ((driver driver)) ¶

Writer Method: (setf driver-context) ((driver driver)) ¶

The remote-js object.

Source: driver.lisp.
Target Slot: context.

Generic Reader: driver-js-cond (object) ¶

Generic Writer: (setf driver-js-cond) (object) ¶

Package

Methods

Reader Method: driver-js-cond ((driver driver)) ¶

Writer Method: (setf driver-js-cond) ((driver driver)) ¶

A condition variable for js sync

Source: driver.lisp.
Target Slot: js-cond.

Generic Reader: driver-js-lock (object) ¶

Generic Writer: (setf driver-js-lock) (object) ¶

Package

Methods

Reader Method: driver-js-lock ((driver driver)) ¶

Writer Method: (setf driver-js-lock) ((driver driver)) ¶

A lock object for js sync

Source: driver.lisp.
Target Slot: js-lock.

Generic Reader: driver-process (object) ¶

Generic Writer: (setf driver-process) (object) ¶

Package

Methods

Reader Method: driver-process ((driver driver)) ¶

Writer Method: (setf driver-process) ((driver driver)) ¶

The Electron process.

Source: driver.lisp.
Target Slot: process.

Generic Reader: driver-responses (object) ¶

Generic Writer: (setf driver-responses) (object) ¶

Package

Methods

Reader Method: driver-responses ((driver driver)) ¶

Writer Method: (setf driver-responses) ((driver driver)) ¶

A hash table of message IDs to evaluation results.

Source: driver.lisp.
Target Slot: responses.

Generic Reader: error-tag (condition) ¶

Package

Methods

Reader Method: error-tag ((condition no-such-tag)) ¶

Source: error.lisp.
Target Slot: tag.

Generic Function: on-message (driver message) ¶

Receive a message from a WebSockets client.

Package

Source

Methods

Method: on-message ((driver driver) message) ¶

Generic Reader: os-name (condition) ¶

Package

Methods

Reader Method: os-name ((condition unsupported-operating-system)) ¶

Source: error.lisp.
Target Slot: os-name.

Generic Function: port (driver) ¶

Return the port the WebSockets server is running on.

Package

Source

Methods

Method: port ((driver driver)) ¶

Generic Reader: resource-pathname (object) ¶

Package

Methods

Reader Method: resource-pathname ((resource resource)) ¶

The directory, relative to the system directory.

Source: resource.lisp.
Target Slot: pathname.

Generic Reader: resource-system (object) ¶

Package

Methods

Reader Method: resource-system ((resource resource)) ¶

The name of the system this resource is relative to.

Source: resource.lisp.
Target Slot: system.

Generic Reader: resource-tag (object) ¶

Package

Methods

Reader Method: resource-tag ((resource resource)) ¶

The resource tag.

Source: resource.lisp.
Target Slot: tag.

Generic Function: start-electron (driver) ¶

Package

Methods

Method: start-electron ((driver driver)) ¶

Start the Electron process.

Source: driver.lisp.

Generic Function: start-remote-js (driver) ¶

Package

Methods

Method: start-remote-js ((driver driver)) ¶

Start the remote-js server.

Source: driver.lisp.

Generic Function: stop-electron (driver) ¶

Package

Methods

Method: stop-electron ((driver driver)) ¶

Stop the Electron process.

Source: driver.lisp.

Generic Function: stop-remote-js (driver) ¶

Package

Methods

Method: stop-remote-js ((driver driver)) ¶

Stop the remote-js server.

Source: driver.lisp.

Generic Function: wait-for-client (driver) ¶

Package