The ceramic Reference Manual

Table of Contents

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

The ceramic Reference Manual

This is the ceramic Reference Manual, version 0.2, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 07:49:43 2018 GMT+0.


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

1 Introduction

Ceramic

Build Status Coverage Status Quicklisp

Common Lisp web apps on the desktop.

Overview

Ceramic takes an ordinary Common Lisp web app, and bundles it into an executable you can distribute, so your users can install it and run the app and server in a dedicated desktop window like any other app.

See the documentation.

License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.


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 ceramic

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

http://ceramic.github.io/

Source Control

(:git "git@github.com:ceramic/ceramic.git")

Bug Tracker

https://github.com/ceramic/ceramic/issues

License

MIT

Description

Common Lisp web apps on the desktop

Long Description

# [Ceramic](http://ceramic.github.io/)

[![Build Status](https://travis-ci.org/ceramic/ceramic.svg?branch=master)](https://travis-ci.org/ceramic/ceramic)
[![Coverage Status](https://coveralls.io/repos/ceramic/ceramic/badge.svg?branch=master&service=github)](https://coveralls.io/github/ceramic/ceramic?branch=master) [![Quicklisp](http://quickdocs.org/badge/ceramic.svg)](http://quickdocs.org/ceramic/)

Common Lisp web apps on the desktop.

## Overview

Ceramic takes an ordinary Common Lisp web app, and bundles it into an executable
you can distribute, so your users can install it and run the app and server in a
dedicated desktop window like any other app.

See the [documentation](http://ceramic.github.io/docs/introduction.html).

## License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

Version

0.2

Dependencies
Source

ceramic.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 ceramic/src

Parent

ceramic (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 ceramic.asd

Location

ceramic.asd

Systems

ceramic (system)


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

4.1.2 ceramic/src/error.lisp

Parent

src (module)

Location

src/error.lisp

Packages

ceramic.error

Exported Definitions
Internal Definitions

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

4.1.3 ceramic/src/os.lisp

Dependency

error.lisp (file)

Parent

src (module)

Location

src/os.lisp

Packages

ceramic.os

Exported Definitions
Internal Definitions

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

4.1.4 ceramic/src/file.lisp

Dependency

os.lisp (file)

Parent

src (module)

Location

src/file.lisp

Packages

ceramic.file

Exported Definitions

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

4.1.5 ceramic/src/logging.lisp

Dependency

file.lisp (file)

Parent

src (module)

Location

src/logging.lisp

Packages

ceramic.log

Exported Definitions

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

4.1.6 ceramic/src/runtime.lisp

Dependency

logging.lisp (file)

Parent

src (module)

Location

src/runtime.lisp

Packages

ceramic.runtime

Exported Definitions

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

4.1.7 ceramic/src/resource.lisp

Dependency

runtime.lisp (file)

Parent

src (module)

Location

src/resource.lisp

Packages

ceramic.resource

Exported Definitions
Internal Definitions

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

4.1.8 ceramic/src/setup.lisp

Dependency

resource.lisp (file)

Parent

src (module)

Location

src/setup.lisp

Packages

ceramic.setup

Exported Definitions

setup (function)

Internal Definitions

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

4.1.9 ceramic/src/driver.lisp

Dependency

main.js (file)

Parent

src (module)

Location

src/driver.lisp

Packages

ceramic.driver

Exported Definitions
Internal Definitions

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

4.1.10 ceramic/src/window.lisp

Dependency

driver.lisp (file)

Parent

src (module)

Location

src/window.lisp

Packages

ceramic.window

Exported Definitions
Internal Definitions

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

4.1.11 ceramic/src/crashreporter.lisp

Dependency

window.lisp (file)

Parent

src (module)

Location

src/crashreporter.lisp

Packages

ceramic.crashreporter

Exported Definitions

start-crash-reporter (function)


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

4.1.12 ceramic/src/dialog.lisp

Dependency

crashreporter.lisp (file)

Parent

src (module)

Location

src/dialog.lisp

Packages

ceramic.dialog

Exported Definitions
Internal Definitions

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

4.1.13 ceramic/src/bundler.lisp

Dependency

dialog.lisp (file)

Parent

src (module)

Location

src/bundler.lisp

Packages

ceramic.bundler

Exported Definitions

bundle (function)

Internal Definitions

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

4.1.14 ceramic/src/ceramic.lisp

Dependency

bundler.lisp (file)

Parent

src (module)

Location

src/ceramic.lisp

Packages
Exported Definitions

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

4.1.15 ceramic/src/quit.lisp

Dependency

ceramic.lisp (file)

Parent

src (module)

Location

src/quit.lisp

Exported Definitions

quit (function)


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

4.2 Other


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

4.2.1 ceramic/src/main.js

Dependency

setup.lisp (file)

Parent

src (module)

Location

src/main.js


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

5 Packages

Packages are listed by definition order.


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

5.1 ceramic.error

Error conditions.

Source

error.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.2 ceramic.os

Operating system-related stuff.

Source

os.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.3 ceramic.file

Ceramic’s files and directory utilities.

Source

file.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.4 ceramic.log

Logging.

Source

logging.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.5 ceramic.runtime

Tools for execution during release.

Source

runtime.lisp (file)

Use List

common-lisp

Exported Definitions

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

5.6 ceramic.resource

Ceramic’s resource-management utilities.

Source

resource.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.7 ceramic.setup

Set up everything needed to develop with Ceramic.

Source

setup.lisp (file)

Use List

common-lisp

Exported Definitions

setup (function)

Internal Definitions

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

5.8 ceramic.driver

The Ceramic driver interface.

Source

driver.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.9 ceramic.window

The window class and its implementation.

Source

window.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.10 ceramic.crashreporter

Start Electron’s Crash Reporter.

Source

crashreporter.lisp (file)

Use List

common-lisp

Exported Definitions

start-crash-reporter (function)


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

5.11 ceramic.dialog

Source

dialog.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5.12 ceramic.bundler

Release applications.

Source

bundler.lisp (file)

Use List

common-lisp

Exported Definitions

bundle (function)

Internal Definitions

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

5.13 ceramic-entry

Source

ceramic.lisp (file)

Use List

common-lisp


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

5.14 ceramic

The main interface.

Source

ceramic.lisp (file)

Use List

common-lisp

Exported Definitions

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [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 (file)

Special Variable: *ceramic-directory*

The directory where Ceramic stores its files.

Package

ceramic.file

Source

file.lisp (file)

Special Variable: *driver*

The global driver object.

Package

ceramic.driver

Source

driver.lisp (file)

Special Variable: *logging*

Whether or not to log info.

Package

ceramic.log

Source

logging.lisp (file)

Special Variable: *logging-stream*

The logging stream.

Package

ceramic.log

Source

logging.lisp (file)

Special Variable: *operating-system*

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

Package

ceramic.os

Source

os.lisp (file)

Special Variable: *releasep*

Dynamically bound to t when in release mode.

Package

ceramic.runtime

Source

runtime.lisp (file)


Next: , Previous: , Up: Exported definitions   [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 (file)

Macro: define-resources SYSTEM-NAME () &rest PAIRS

Define resource tags for a system.

Package

ceramic.resource

Source

resource.lisp (file)


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

6.1.3 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 (file)

Function: copy-resources DIRECTORY

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

Package

ceramic.resource

Source

resource.lisp (file)

Function: executable-pathname ()

Return the executable’s pathname.

Package

ceramic.runtime

Source

runtime.lisp (file)

Function: executable-relative-pathname PATHNAME

Return an absolute pathname relative to the executable pathname.

Package

ceramic.runtime

Source

runtime.lisp (file)

Function: log-message MESSAGE &rest ARGS
Package

ceramic.log

Source

logging.lisp (file)

Function: make-window &key TITLE URL WIDTH HEIGHT CLASS

Create a window.

Package

ceramic.window

Source

window.lisp (file)

Function: quit &optional EXIT-STATUS

Kill the Electron process and the Lisp process.

Package

ceramic

Source

quit.lisp (file)

Function: release-directory ()

Pathname to the local copy of the Electron release.

Package

ceramic.file

Source

file.lisp (file)

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 (file)

Function: resource-directory RESOURCE-TAG

Return the directory associated to a resource tag.

Package

ceramic.resource

Source

resource.lisp (file)

Function: setup &key FORCE

Set up everything needed to start developing.

Package

ceramic.setup

Source

setup.lisp (file)

Function: show-error-box TITLE CONTENT

Display a dialog that shows an error message.

Package

ceramic.dialog

Source

dialog.lisp (file)

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 (file)

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 (file)

Function: show-save-dialog &key WINDOW TITLE DEFAULT-PATH BUTTON-LABEL FILTERS

Show a Save dialog.

Package

ceramic.dialog

Source

dialog.lisp (file)

Function: start ()

Start the Electron process.

Package

ceramic

Source

ceramic.lisp (file)

Function: start-crash-reporter COMPANY-NAME SUBMIT-URL &key OPTIONS
Package

ceramic.crashreporter

Source

crashreporter.lisp (file)

Function: stop ()

Stop the Electron process.

Package

ceramic

Source

ceramic.lisp (file)

Function: wipe-data ()

Wipe all Ceramic related data.

Package

ceramic.file

Source

file.lisp (file)


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

6.1.4 Generic functions

Generic Function: back WINDOW
Package

ceramic.window

Methods
Method: back (WINDOW window)

Go back in the page history.

Source

window.lisp (file)

Generic Function: center WINDOW
Package

ceramic.window

Methods
Method: center (WINDOW window)

Move the window to the center of the screen.

Source

window.lisp (file)

Generic Function: close WINDOW
Package

ceramic.window

Methods
Method: close (WINDOW window)

Close the window.

Source

window.lisp (file)

Generic Function: close-dev-tools WINDOW
Package

ceramic.window

Methods
Method: close-dev-tools (WINDOW window)

Close the developer tools.

Source

window.lisp (file)

Generic Function: copy WINDOW
Package

ceramic.window

Methods
Method: copy (WINDOW window)

Copy selected text.

Source

window.lisp (file)

Generic Function: crashedp WINDOW
Package

ceramic.window

Methods
Method: crashedp (WINDOW window)

Return whether the window has crashed.

Source

window.lisp (file)

Generic Function: cut WINDOW
Package

ceramic.window

Methods
Method: cut (WINDOW window)

Cut selected text.

Source

window.lisp (file)

Generic Function: forward WINDOW
Package

ceramic.window

Methods
Method: forward (WINDOW window)

Go forward in the page history.

Source

window.lisp (file)

Generic Function: hide WINDOW
Package

ceramic.window

Methods
Method: hide (WINDOW window)

Hide the window from the user.

Source

window.lisp (file)

Generic Function: js DRIVER JS

Evaluate a string of JavaScript in the Electron process.

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: js (DRIVER driver) JS
Generic Function: loadingp WINDOW
Package

ceramic.window

Methods
Method: loadingp (WINDOW window)

Return whether the window is loading a new page.

Source

window.lisp (file)

Generic Function: open-dev-tools WINDOW
Package

ceramic.window

Methods
Method: open-dev-tools (WINDOW window)

Open the developer tools.

Source

window.lisp (file)

Generic Function: paste WINDOW
Package

ceramic.window

Methods
Method: paste (WINDOW window)

Paste text.

Source

window.lisp (file)

Generic Function: redo WINDOW
Package

ceramic.window

Methods
Method: redo (WINDOW window)

Redo changes.

Source

window.lisp (file)

Generic Function: reload WINDOW &key IGNORE-CACHE
Package

ceramic.window

Methods
Method: reload (WINDOW window) &key IGNORE-CACHE

Reload the window. Optionally ignore the cache.

Source

window.lisp (file)

Generic Function: select-all WINDOW
Package

ceramic.window

Methods
Method: select-all (WINDOW window)

Select all text.

Source

window.lisp (file)

Generic Function: show WINDOW
Package

ceramic.window

Methods
Method: show (WINDOW window)

Show the window to the user.

Source

window.lisp (file)

Generic Function: start DRIVER

Start the Electron process and the remote-js server.

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: start (DRIVER driver)
Generic Function: stop DRIVER

Stop the Electron process and the remote-js server.

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: stop (DRIVER driver)
Generic Function: stop-loading WINDOW
Package

ceramic.window

Methods
Method: stop-loading (WINDOW window)

Stop any navigation.

Source

window.lisp (file)

Generic Function: sync-js DRIVER JS

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

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: sync-js (DRIVER driver) JS
Generic Function: title WINDOW
Generic Function: (setf title) NEW-VALUE WINDOW
Package

ceramic.window

Methods
Method: title (WINDOW window)

Return the window’s title.

Source

window.lisp (file)

Method: (setf title) NEW-VALUE (WINDOW window)

Set the window’s title.

Source

window.lisp (file)

Generic Function: undo WINDOW
Package

ceramic.window

Methods
Method: undo (WINDOW window)

Undo changes.

Source

window.lisp (file)

Generic Function: unselect WINDOW
Package

ceramic.window

Methods
Method: unselect (WINDOW window)

Cancel the selection.

Source

window.lisp (file)

Generic Function: url WINDOW
Generic Function: (setf url) NEW-VALUE WINDOW
Package

ceramic.window

Methods
Method: url (WINDOW window)

Return the window’s current URL.

Source

window.lisp (file)

Method: (setf url) NEW-VALUE (WINDOW window)

Change the window’s URL.

Source

window.lisp (file)

Generic Function: window-id OBJECT
Package

ceramic.window

Methods
Method: window-id (WINDOW window)

A unique string ID for the window.

Source

window.lisp (file)


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

6.1.5 Conditions

Condition: ceramic-error ()

The base class of Ceramic-related conditions.

Package

ceramic.error

Source

error.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Condition: no-such-tag ()

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

Package

ceramic.error

Source

error.lisp (file)

Direct superclasses

ceramic-error (condition)

Direct methods

error-tag (method)

Direct slots
Slot: tag

The resource tag.

Initargs

:tag

Readers

error-tag (generic function)

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 (file)

Direct superclasses

ceramic-error (condition)

Condition: unsupported-operating-system ()
Package

ceramic.error

Source

error.lisp (file)

Direct superclasses

ceramic-error (condition)

Direct methods

os-name (method)

Direct slots
Slot: os-name

The name of the operating system.

Initargs

:os-name

Readers

os-name (generic function)


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

6.1.6 Classes

Class: driver ()

The Ceramic driver.

Package

ceramic.driver

Source

driver.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: process

The Electron process.

Readers

driver-process (generic function)

Writers

(setf driver-process) (generic function)

Slot: context

The remote-js object.

Type

remote-js:buffered-context

Readers

driver-context (generic function)

Writers

(setf driver-context) (generic function)

Slot: js-lock

A lock object for js sync

Initform

(bordeaux-threads:make-lock "ceramic-js-sync")

Readers

driver-js-lock (generic function)

Writers

(setf driver-js-lock) (generic function)

Slot: js-cond

A condition variable for js sync

Initform

(bordeaux-threads:make-condition-variable)

Readers

driver-js-cond (generic function)

Writers

(setf driver-js-cond) (generic function)

Slot: responses

A hash table of message IDs to evaluation results.

Type

hash-table

Initform

(make-hash-table :test (function equal))

Readers

driver-responses (generic function)

Writers

(setf driver-responses) (generic function)

Class: resource ()

A resource.

Package

ceramic.resource

Source

resource.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: tag

The resource tag.

Type

symbol

Initargs

:tag

Readers

resource-tag (generic function)

Slot: pathname

The directory, relative to the system directory.

Type

pathname

Initargs

:pathname

Readers

resource-pathname (generic function)

Slot: system

The name of the system this resource is relative to.

Type

keyword

Initargs

:system

Readers

resource-system (generic function)

Class: window ()

A browser window.

Package

ceramic.window

Source

window.lisp (file)

Direct superclasses

standard-object (class)

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 (generic function)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *electron-version*

The version of Electron to use.

Package

ceramic.setup

Source

setup.lisp (file)

Special Variable: *resources*

The list of resources.

Package

ceramic.resource

Source

resource.lisp (file)

Special Variable: +main-javascript+

Pathname to the JavaScript file for the main process.

Package

ceramic.setup

Source

setup.lisp (file)

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

ceramic.dialog

Source

dialog.lisp (file)

Special Variable: +message-box-types+
Package

ceramic.dialog

Source

dialog.lisp (file)

Special Variable: +ws-module+
Package

ceramic.setup

Source

setup.lisp (file)


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

6.2.2 Macros

Macro: define-trivial-operation NAME JS &key DOCSTRING SYNC
Package

ceramic.window

Source

window.lisp (file)


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

6.2.3 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 (file)

Function: call-define-resources SYSTEM-NAME PAIRS
Package

ceramic.resource

Source

resource.lisp (file)

Function: clean-release DIRECTORY &key OPERATING-SYSTEM

Clean up default files from an Electron release.

Package

ceramic.setup

Source

setup.lisp (file)

Function: copy-ws-module DIRECTORY &key OPERATING-SYSTEM

Copy the WebSockets module.

Package

ceramic.setup

Source

setup.lisp (file)

Function: create-archive DIRECTORY OUTPUT
Package

ceramic.bundler

Source

bundler.lisp (file)

Function: detect-architecture ()
Package

ceramic.os

Source

os.lisp (file)

Function: detect-operating-system ()
Package

ceramic.os

Source

os.lisp (file)

Function: file-filters SPEC
Package

ceramic.dialog

Source

dialog.lisp (file)

Function: get-resource RESOURCE-TAG

Return the resource associated to a resource tag.

Package

ceramic.resource

Source

resource.lisp (file)

Function: insert-javascript DIRECTORY &key OPERATING-SYSTEM

Insert the main process JavaScript into an Electron release.

Package

ceramic.setup

Source

setup.lisp (file)

Function: insert-package-definition DIRECTORY &key OPERATING-SYSTEM

Insert the package.json into an Electron release.

Package

ceramic.setup

Source

setup.lisp (file)

Function: js FORMAT-CONTROL &rest ARGS
Package

ceramic.window

Source

window.lisp (file)

Function: prepare-release DIRECTORY &key OPERATING-SYSTEM

Prepare an Electron release.

Package

ceramic.setup

Source

setup.lisp (file)

Function: release-resources-directory ()

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

Package

ceramic.resource

Source

resource.lisp (file)

Function: show-standard-dialog ACTION WINDOW OPTIONS
Package

ceramic.dialog

Source

dialog.lisp (file)

Function: sync-js FORMAT-CONTROL &rest ARGS
Package

ceramic.window

Source

window.lisp (file)


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

6.2.4 Generic functions

Generic Function: %reload WINDOW
Package

ceramic.window

Methods
Method: %reload (WINDOW window)
Source

window.lisp (file)

Generic Function: %reload-force WINDOW
Package

ceramic.window

Methods
Method: %reload-force (WINDOW window)
Source

window.lisp (file)

Generic Function: address DRIVER

Return the address the WebSockets server is running on.

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: address (DRIVER driver)
Generic Function: driver-context OBJECT
Generic Function: (setf driver-context) NEW-VALUE OBJECT
Package

ceramic.driver

Methods
Method: driver-context (DRIVER driver)
Method: (setf driver-context) NEW-VALUE (DRIVER driver)

The remote-js object.

Source

driver.lisp (file)

Generic Function: driver-js-cond OBJECT
Generic Function: (setf driver-js-cond) NEW-VALUE OBJECT
Package

ceramic.driver

Methods
Method: driver-js-cond (DRIVER driver)
Method: (setf driver-js-cond) NEW-VALUE (DRIVER driver)

A condition variable for js sync

Source

driver.lisp (file)

Generic Function: driver-js-lock OBJECT
Generic Function: (setf driver-js-lock) NEW-VALUE OBJECT
Package

ceramic.driver

Methods
Method: driver-js-lock (DRIVER driver)
Method: (setf driver-js-lock) NEW-VALUE (DRIVER driver)

A lock object for js sync

Source

driver.lisp (file)

Generic Function: driver-process OBJECT
Generic Function: (setf driver-process) NEW-VALUE OBJECT
Package

ceramic.driver

Methods
Method: driver-process (DRIVER driver)
Method: (setf driver-process) NEW-VALUE (DRIVER driver)

The Electron process.

Source

driver.lisp (file)

Generic Function: driver-responses OBJECT
Generic Function: (setf driver-responses) NEW-VALUE OBJECT
Package

ceramic.driver

Methods
Method: driver-responses (DRIVER driver)
Method: (setf driver-responses) NEW-VALUE (DRIVER driver)

A hash table of message IDs to evaluation results.

Source

driver.lisp (file)

Generic Function: error-tag CONDITION
Package

ceramic.error

Methods
Method: error-tag (CONDITION no-such-tag)
Source

error.lisp (file)

Generic Function: on-message DRIVER MESSAGE

Receive a message from a WebSockets client.

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: on-message (DRIVER driver) MESSAGE
Generic Function: os-name CONDITION
Package

ceramic.error

Methods
Method: os-name (CONDITION unsupported-operating-system)
Source

error.lisp (file)

Generic Function: port DRIVER

Return the port the WebSockets server is running on.

Package

ceramic.driver

Source

driver.lisp (file)

Methods
Method: port (DRIVER driver)
Generic Function: resource-pathname OBJECT
Package

ceramic.resource

Methods
Method: resource-pathname (RESOURCE resource)

The directory, relative to the system directory.

Source

resource.lisp (file)

Generic Function: resource-system OBJECT
Package

ceramic.resource

Methods
Method: resource-system (RESOURCE resource)

The name of the system this resource is relative to.

Source

resource.lisp (file)

Generic Function: resource-tag OBJECT
Package

ceramic.resource

Methods
Method: resource-tag (RESOURCE resource)

The resource tag.

Source

resource.lisp (file)

Generic Function: start-electron DRIVER
Package

ceramic.driver

Methods
Method: start-electron (DRIVER driver)

Start the Electron process.

Source

driver.lisp (file)

Generic Function: start-remote-js DRIVER
Package

ceramic.driver

Methods
Method: start-remote-js (DRIVER driver)

Start the remote-js server.

Source

driver.lisp (file)

Generic Function: stop-electron DRIVER
Package

ceramic.driver

Methods
Method: stop-electron (DRIVER driver)

Stop the Electron process.

Source

driver.lisp (file)

Generic Function: stop-remote-js DRIVER
Package

ceramic.driver

Methods
Method: stop-remote-js (DRIVER driver)

Stop the remote-js server.

Source

driver.lisp (file)

Generic Function: wait-for-client DRIVER
Package

ceramic.driver

Methods
Method: wait-for-client (DRIVER driver)

Wait for the client to connect to the WebSockets server.

Source

driver.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M   O  
Index Entry  Section

C
ceramic.asd: The ceramic<dot>asd file
ceramic/src: The ceramic/src module
ceramic/src/bundler.lisp: The ceramic/src/bundler<dot>lisp file
ceramic/src/ceramic.lisp: The ceramic/src/ceramic<dot>lisp file
ceramic/src/crashreporter.lisp: The ceramic/src/crashreporter<dot>lisp file
ceramic/src/dialog.lisp: The ceramic/src/dialog<dot>lisp file
ceramic/src/driver.lisp: The ceramic/src/driver<dot>lisp file
ceramic/src/error.lisp: The ceramic/src/error<dot>lisp file
ceramic/src/file.lisp: The ceramic/src/file<dot>lisp file
ceramic/src/logging.lisp: The ceramic/src/logging<dot>lisp file
ceramic/src/main.js: The ceramic/src/main<dot>js file
ceramic/src/os.lisp: The ceramic/src/os<dot>lisp file
ceramic/src/quit.lisp: The ceramic/src/quit<dot>lisp file
ceramic/src/resource.lisp: The ceramic/src/resource<dot>lisp file
ceramic/src/runtime.lisp: The ceramic/src/runtime<dot>lisp file
ceramic/src/setup.lisp: The ceramic/src/setup<dot>lisp file
ceramic/src/window.lisp: The ceramic/src/window<dot>lisp file

F
File, Lisp, ceramic.asd: The ceramic<dot>asd file
File, Lisp, ceramic/src/bundler.lisp: The ceramic/src/bundler<dot>lisp file
File, Lisp, ceramic/src/ceramic.lisp: The ceramic/src/ceramic<dot>lisp file
File, Lisp, ceramic/src/crashreporter.lisp: The ceramic/src/crashreporter<dot>lisp file
File, Lisp, ceramic/src/dialog.lisp: The ceramic/src/dialog<dot>lisp file
File, Lisp, ceramic/src/driver.lisp: The ceramic/src/driver<dot>lisp file
File, Lisp, ceramic/src/error.lisp: The ceramic/src/error<dot>lisp file
File, Lisp, ceramic/src/file.lisp: The ceramic/src/file<dot>lisp file
File, Lisp, ceramic/src/logging.lisp: The ceramic/src/logging<dot>lisp file
File, Lisp, ceramic/src/os.lisp: The ceramic/src/os<dot>lisp file
File, Lisp, ceramic/src/quit.lisp: The ceramic/src/quit<dot>lisp file
File, Lisp, ceramic/src/resource.lisp: The ceramic/src/resource<dot>lisp file
File, Lisp, ceramic/src/runtime.lisp: The ceramic/src/runtime<dot>lisp file
File, Lisp, ceramic/src/setup.lisp: The ceramic/src/setup<dot>lisp file
File, Lisp, ceramic/src/window.lisp: The ceramic/src/window<dot>lisp file
File, other, ceramic/src/main.js: The ceramic/src/main<dot>js file

L
Lisp File, ceramic.asd: The ceramic<dot>asd file
Lisp File, ceramic/src/bundler.lisp: The ceramic/src/bundler<dot>lisp file
Lisp File, ceramic/src/ceramic.lisp: The ceramic/src/ceramic<dot>lisp file
Lisp File, ceramic/src/crashreporter.lisp: The ceramic/src/crashreporter<dot>lisp file
Lisp File, ceramic/src/dialog.lisp: The ceramic/src/dialog<dot>lisp file
Lisp File, ceramic/src/driver.lisp: The ceramic/src/driver<dot>lisp file
Lisp File, ceramic/src/error.lisp: The ceramic/src/error<dot>lisp file
Lisp File, ceramic/src/file.lisp: The ceramic/src/file<dot>lisp file
Lisp File, ceramic/src/logging.lisp: The ceramic/src/logging<dot>lisp file
Lisp File, ceramic/src/os.lisp: The ceramic/src/os<dot>lisp file
Lisp File, ceramic/src/quit.lisp: The ceramic/src/quit<dot>lisp file
Lisp File, ceramic/src/resource.lisp: The ceramic/src/resource<dot>lisp file
Lisp File, ceramic/src/runtime.lisp: The ceramic/src/runtime<dot>lisp file
Lisp File, ceramic/src/setup.lisp: The ceramic/src/setup<dot>lisp file
Lisp File, ceramic/src/window.lisp: The ceramic/src/window<dot>lisp file

M
Module, ceramic/src: The ceramic/src module

O
Other File, ceramic/src/main.js: The ceramic/src/main<dot>js file

Jump to:   C   F   L   M   O  

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

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   L   M   O   P   Q   R   S   T   U   W  
Index Entry  Section

%
%reload: Internal generic functions
%reload: Internal generic functions
%reload-force: Internal generic functions
%reload-force: Internal generic functions

(
(setf driver-context): Internal generic functions
(setf driver-context): Internal generic functions
(setf driver-js-cond): Internal generic functions
(setf driver-js-cond): Internal generic functions
(setf driver-js-lock): Internal generic functions
(setf driver-js-lock): Internal generic functions
(setf driver-process): Internal generic functions
(setf driver-process): Internal generic functions
(setf driver-responses): Internal generic functions
(setf driver-responses): Internal generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf url): Exported generic functions
(setf url): Exported generic functions

A
address: Internal generic functions
address: Internal generic functions
archive-extension: Internal functions

B
back: Exported generic functions
back: Exported generic functions
bundle: Exported functions

C
call-define-resources: Internal functions
center: Exported generic functions
center: Exported generic functions
clean-release: Internal functions
close: Exported generic functions
close: Exported generic functions
close-dev-tools: Exported generic functions
close-dev-tools: Exported generic functions
copy: Exported generic functions
copy: Exported generic functions
copy-resources: Exported functions
copy-ws-module: Internal functions
crashedp: Exported generic functions
crashedp: Exported generic functions
create-archive: Internal functions
cut: Exported generic functions
cut: Exported generic functions

D
define-entry-point: Exported macros
define-resources: Exported macros
define-trivial-operation: Internal macros
detect-architecture: Internal functions
detect-operating-system: Internal functions
driver-context: Internal generic functions
driver-context: Internal generic functions
driver-js-cond: Internal generic functions
driver-js-cond: Internal generic functions
driver-js-lock: Internal generic functions
driver-js-lock: Internal generic functions
driver-process: Internal generic functions
driver-process: Internal generic functions
driver-responses: Internal generic functions
driver-responses: Internal generic functions

E
error-tag: Internal generic functions
error-tag: Internal generic functions
executable-pathname: Exported functions
executable-relative-pathname: Exported functions

F
file-filters: Internal functions
forward: Exported generic functions
forward: Exported generic functions
Function, archive-extension: Internal functions
Function, bundle: Exported functions
Function, call-define-resources: Internal functions
Function, clean-release: Internal functions
Function, copy-resources: Exported functions
Function, copy-ws-module: Internal functions
Function, create-archive: Internal functions
Function, detect-architecture: Internal functions
Function, detect-operating-system: Internal functions
Function, executable-pathname: Exported functions
Function, executable-relative-pathname: Exported functions
Function, file-filters: Internal functions
Function, get-resource: Internal functions
Function, insert-javascript: Internal functions
Function, insert-package-definition: Internal functions
Function, js: Internal functions
Function, log-message: Exported functions
Function, make-window: Exported functions
Function, prepare-release: Internal functions
Function, quit: Exported functions
Function, release-directory: Exported functions
Function, release-resources-directory: Internal functions
Function, resource: Exported functions
Function, resource-directory: Exported functions
Function, setup: Exported functions
Function, show-error-box: Exported functions
Function, show-message-box: Exported functions
Function, show-open-dialog: Exported functions
Function, show-save-dialog: Exported functions
Function, show-standard-dialog: Internal functions
Function, start: Exported functions
Function, start-crash-reporter: Exported functions
Function, stop: Exported functions
Function, sync-js: Internal functions
Function, wipe-data: Exported functions

G
Generic Function, %reload: Internal generic functions
Generic Function, %reload-force: Internal generic functions
Generic Function, (setf driver-context): Internal generic functions
Generic Function, (setf driver-js-cond): Internal generic functions
Generic Function, (setf driver-js-lock): Internal generic functions
Generic Function, (setf driver-process): Internal generic functions
Generic Function, (setf driver-responses): Internal generic functions
Generic Function, (setf title): Exported generic functions
Generic Function, (setf url): Exported generic functions
Generic Function, address: Internal generic functions
Generic Function, back: Exported generic functions
Generic Function, center: Exported generic functions
Generic Function, close: Exported generic functions
Generic Function, close-dev-tools: Exported generic functions
Generic Function, copy: Exported generic functions
Generic Function, crashedp: Exported generic functions
Generic Function, cut: Exported generic functions
Generic Function, driver-context: Internal generic functions
Generic Function, driver-js-cond: Internal generic functions
Generic Function, driver-js-lock: Internal generic functions
Generic Function, driver-process: Internal generic functions
Generic Function, driver-responses: Internal generic functions
Generic Function, error-tag: Internal generic functions
Generic Function, forward: Exported generic functions
Generic Function, hide: Exported generic functions
Generic Function, js: Exported generic functions
Generic Function, loadingp: Exported generic functions
Generic Function, on-message: Internal generic functions
Generic Function, open-dev-tools: Exported generic functions
Generic Function, os-name: Internal generic functions
Generic Function, paste: Exported generic functions
Generic Function, port: Internal generic functions
Generic Function, redo: Exported generic functions
Generic Function, reload: Exported generic functions
Generic Function, resource-pathname: Internal generic functions
Generic Function, resource-system: Internal generic functions
Generic Function, resource-tag: Internal generic functions
Generic Function, select-all: Exported generic functions
Generic Function, show: Exported generic functions
Generic Function, start: Exported generic functions
Generic Function, start-electron: Internal generic functions
Generic Function, start-remote-js: Internal generic functions
Generic Function, stop: Exported generic functions
Generic Function, stop-electron: Internal generic functions
Generic Function, stop-loading: Exported generic functions
Generic Function, stop-remote-js: Internal generic functions
Generic Function, sync-js: Exported generic functions
Generic Function, title: Exported generic functions
Generic Function, undo: Exported generic functions
Generic Function, unselect: Exported generic functions
Generic Function, url: Exported generic functions
Generic Function, wait-for-client: Internal generic functions
Generic Function, window-id: Exported generic functions
get-resource: Internal functions

H
hide: Exported generic functions
hide: Exported generic functions

I
insert-javascript: Internal functions
insert-package-definition: Internal functions

J
js: Exported generic functions
js: Exported generic functions
js: Internal functions

L
loadingp: Exported generic functions
loadingp: Exported generic functions
log-message: Exported functions

M
Macro, define-entry-point: Exported macros
Macro, define-resources: Exported macros
Macro, define-trivial-operation: Internal macros
make-window: Exported functions
Method, %reload: Internal generic functions
Method, %reload-force: Internal generic functions
Method, (setf driver-context): Internal generic functions
Method, (setf driver-js-cond): Internal generic functions
Method, (setf driver-js-lock): Internal generic functions
Method, (setf driver-process): Internal generic functions
Method, (setf driver-responses): Internal generic functions
Method, (setf title): Exported generic functions
Method, (setf url): Exported generic functions
Method, address: Internal generic functions
Method, back: Exported generic functions
Method, center: Exported generic functions
Method, close: Exported generic functions
Method, close-dev-tools: Exported generic functions
Method, copy: Exported generic functions
Method, crashedp: Exported generic functions
Method, cut: Exported generic functions
Method, driver-context: Internal generic functions
Method, driver-js-cond: Internal generic functions
Method, driver-js-lock: Internal generic functions
Method, driver-process: Internal generic functions
Method, driver-responses: Internal generic functions
Method, error-tag: Internal generic functions
Method, forward: Exported generic functions
Method, hide: Exported generic functions
Method, js: Exported generic functions
Method, loadingp: Exported generic functions
Method, on-message: Internal generic functions
Method, open-dev-tools: Exported generic functions
Method, os-name: Internal generic functions
Method, paste: Exported generic functions
Method, port: Internal generic functions
Method, redo: Exported generic functions
Method, reload: Exported generic functions
Method, resource-pathname: Internal generic functions
Method, resource-system: Internal generic functions
Method, resource-tag: Internal generic functions
Method, select-all: Exported generic functions
Method, show: Exported generic functions
Method, start: Exported generic functions
Method, start-electron: Internal generic functions
Method, start-remote-js: Internal generic functions
Method, stop: Exported generic functions
Method, stop-electron: Internal generic functions
Method, stop-loading: Exported generic functions
Method, stop-remote-js: Internal generic functions
Method, sync-js: Exported generic functions
Method, title: Exported generic functions
Method, undo: Exported generic functions
Method, unselect: Exported generic functions
Method, url: Exported generic functions
Method, wait-for-client: Internal generic functions
Method, window-id: Exported generic functions

O
on-message: Internal generic functions
on-message: Internal generic functions
open-dev-tools: Exported generic functions
open-dev-tools: Exported generic functions
os-name: Internal generic functions
os-name: Internal generic functions

P
paste: Exported generic functions
paste: Exported generic functions
port: Internal generic functions
port: Internal generic functions
prepare-release: Internal functions

Q
quit: Exported functions

R
redo: Exported generic functions
redo: Exported generic functions
release-directory: Exported functions
release-resources-directory: Internal functions
reload: Exported generic functions
reload: Exported generic functions
resource: Exported functions
resource-directory: Exported functions
resource-pathname: Internal generic functions
resource-pathname: Internal generic functions
resource-system: Internal generic functions
resource-system: Internal generic functions
resource-tag: Internal generic functions
resource-tag: Internal generic functions

S
select-all: Exported generic functions
select-all: Exported generic functions
setup: Exported functions
show: Exported generic functions
show: Exported generic functions
show-error-box: Exported functions
show-message-box: Exported functions
show-open-dialog: Exported functions
show-save-dialog: Exported functions
show-standard-dialog: Internal functions
start: Exported functions
start: Exported generic functions
start: Exported generic functions
start-crash-reporter: Exported functions
start-electron: Internal generic functions
start-electron: Internal generic functions
start-remote-js: Internal generic functions
start-remote-js: Internal generic functions
stop: Exported functions
stop: Exported generic functions
stop: Exported generic functions
stop-electron: Internal generic functions
stop-electron: Internal generic functions
stop-loading: Exported generic functions
stop-loading: Exported generic functions
stop-remote-js: Internal generic functions
stop-remote-js: Internal generic functions
sync-js: Exported generic functions
sync-js: Exported generic functions
sync-js: Internal functions

T
title: Exported generic functions
title: Exported generic functions

U
undo: Exported generic functions
undo: Exported generic functions
unselect: Exported generic functions
unselect: Exported generic functions
url: Exported generic functions
url: Exported generic functions

W
wait-for-client: Internal generic functions
wait-for-client: Internal generic functions
window-id: Exported generic functions
window-id: Exported generic functions
wipe-data: Exported functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   J   L   M   O   P   Q   R   S   T   U   W  

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

A.3 Variables

Jump to:   %   *   +  
C   J   O   P   R   S   T  
Index Entry  Section

%
%id: Exported classes

*
*architecture*: Exported special variables
*ceramic-directory*: Exported special variables
*driver*: Exported special variables
*electron-version*: Internal special variables
*logging*: Exported special variables
*logging-stream*: Exported special variables
*operating-system*: Exported special variables
*releasep*: Exported special variables
*resources*: Internal special variables

+
+main-javascript+: Internal special variables
+message-box-default-buttons+: Internal special variables
+message-box-types+: Internal special variables
+ws-module+: Internal special variables

C
context: Exported classes

J
js-cond: Exported classes
js-lock: Exported classes

O
os-name: Exported conditions

P
pathname: Exported classes
process: Exported classes

R
responses: Exported classes

S
Slot, %id: Exported classes
Slot, context: Exported classes
Slot, js-cond: Exported classes
Slot, js-lock: Exported classes
Slot, os-name: Exported conditions
Slot, pathname: Exported classes
Slot, process: Exported classes
Slot, responses: Exported classes
Slot, system: Exported classes
Slot, tag: Exported conditions
Slot, tag: Exported classes
Special Variable, *architecture*: Exported special variables
Special Variable, *ceramic-directory*: Exported special variables
Special Variable, *driver*: Exported special variables
Special Variable, *electron-version*: Internal special variables
Special Variable, *logging*: Exported special variables
Special Variable, *logging-stream*: Exported special variables
Special Variable, *operating-system*: Exported special variables
Special Variable, *releasep*: Exported special variables
Special Variable, *resources*: Internal special variables
Special Variable, +main-javascript+: Internal special variables
Special Variable, +message-box-default-buttons+: Internal special variables
Special Variable, +message-box-types+: Internal special variables
Special Variable, +ws-module+: Internal special variables
system: Exported classes

T
tag: Exported conditions
tag: Exported classes

Jump to:   %   *   +  
C   J   O   P   R   S   T  

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

A.4 Data types

Jump to:   C   D   N   P   R   S   U   W  
Index Entry  Section

C
ceramic: The ceramic system
ceramic: The ceramic package
ceramic-entry: The ceramic-entry package
ceramic-error: Exported conditions
ceramic.bundler: The ceramic<dot>bundler package
ceramic.crashreporter: The ceramic<dot>crashreporter package
ceramic.dialog: The ceramic<dot>dialog package
ceramic.driver: The ceramic<dot>driver package
ceramic.error: The ceramic<dot>error package
ceramic.file: The ceramic<dot>file package
ceramic.log: The ceramic<dot>log package
ceramic.os: The ceramic<dot>os package
ceramic.resource: The ceramic<dot>resource package
ceramic.runtime: The ceramic<dot>runtime package
ceramic.setup: The ceramic<dot>setup package
ceramic.window: The ceramic<dot>window package
Class, driver: Exported classes
Class, resource: Exported classes
Class, window: Exported classes
Condition, ceramic-error: Exported conditions
Condition, no-such-tag: Exported conditions
Condition, not-in-release: Exported conditions
Condition, unsupported-operating-system: Exported conditions

D
driver: Exported classes

N
no-such-tag: Exported conditions
not-in-release: Exported conditions

P
Package, ceramic: The ceramic package
Package, ceramic-entry: The ceramic-entry package
Package, ceramic.bundler: The ceramic<dot>bundler package
Package, ceramic.crashreporter: The ceramic<dot>crashreporter package
Package, ceramic.dialog: The ceramic<dot>dialog package
Package, ceramic.driver: The ceramic<dot>driver package
Package, ceramic.error: The ceramic<dot>error package
Package, ceramic.file: The ceramic<dot>file package
Package, ceramic.log: The ceramic<dot>log package
Package, ceramic.os: The ceramic<dot>os package
Package, ceramic.resource: The ceramic<dot>resource package
Package, ceramic.runtime: The ceramic<dot>runtime package
Package, ceramic.setup: The ceramic<dot>setup package
Package, ceramic.window: The ceramic<dot>window package

R
resource: Exported classes

S
System, ceramic: The ceramic system

U
unsupported-operating-system: Exported conditions

W
window: Exported classes

Jump to:   C   D   N   P   R   S   U   W