The ceramic Reference Manual

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

The ceramic Reference Manual

This is the ceramic Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 04:25:52 2022 GMT+0.

Table of Contents


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.


2 Systems

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


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

2.1 ceramic

Common Lisp web apps on the desktop

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

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
  • trivial-download (system).
  • trivial-extract (system).
  • trivial-exe (system).
  • trivial-build (system).
  • trivial-compress (system).
  • electron-tools (system).
  • uiop (system).
  • cl-json (system).
  • external-program (system).
  • uuid (system).
  • copy-directory (system).
  • clack-handler-hunchentoot (system).
  • remote-js (system).
Source

ceramic.asd.

Child Component

src (module).


3 Modules

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


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

3.1 ceramic/src

Source

ceramic.asd.

Parent Component

ceramic (system).

Child Components

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

4.1.1 ceramic/ceramic.asd

Source

ceramic.asd.

Parent Component

ceramic (system).

ASDF Systems

ceramic.


4.1.2 ceramic/src/error.lisp

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.error.

Public Interface
Internals

4.1.3 ceramic/src/os.lisp

Dependency

error.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.os.

Public Interface
Internals

4.1.4 ceramic/src/file.lisp

Dependency

os.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.file.

Public Interface

4.1.5 ceramic/src/logging.lisp

Dependency

file.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.log.

Public Interface

4.1.6 ceramic/src/runtime.lisp

Dependency

logging.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.runtime.

Public Interface

4.1.7 ceramic/src/resource.lisp

Dependency

runtime.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.resource.

Public Interface
Internals

4.1.8 ceramic/src/setup.lisp

Dependency

resource.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.setup.

Public Interface

setup (function).

Internals

4.1.9 ceramic/src/driver.lisp

Dependency

main.js (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.driver.

Public Interface
Internals

4.1.10 ceramic/src/window.lisp

Dependency

driver.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.window.

Public Interface
Internals

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


4.1.12 ceramic/src/dialog.lisp

Dependency

crashreporter.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.dialog.

Public Interface
Internals

4.1.13 ceramic/src/bundler.lisp

Dependency

dialog.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages

ceramic.bundler.

Public Interface

bundle (function).

Internals

4.1.14 ceramic/src/ceramic.lisp

Dependency

bundler.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Packages
Public Interface

4.1.15 ceramic/src/quit.lisp

Dependency

ceramic.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).

Public Interface

quit (function).


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

4.2 Static


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

4.2.1 ceramic/src/main.js

Dependency

setup.lisp (file).

Source

ceramic.asd.

Parent Component

src (module).


5 Packages

Packages are listed by definition order.


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

5.1 ceramic.error

Error conditions.

Source

error.lisp.

Use List

common-lisp.

Public Interface
Internals

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

5.2 ceramic.dialog

Source

dialog.lisp.

Use List

common-lisp.

Public Interface
Internals

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

5.3 ceramic.runtime

Tools for execution during release.

Source

runtime.lisp.

Use List

common-lisp.

Public Interface

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

5.4 ceramic.bundler

Release applications.

Source

bundler.lisp.

Use List

common-lisp.

Public Interface

bundle (function).

Internals

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

5.5 ceramic.file

Ceramic’s files and directory utilities.

Source

file.lisp.

Use List

common-lisp.

Public Interface

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

5.6 ceramic-entry

Source

ceramic.lisp.

Use List

common-lisp.


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

5.7 ceramic.log

Logging.

Source

logging.lisp.

Use List

common-lisp.

Public Interface

5.8 ceramic.window

The window class and its implementation.

Source

window.lisp.

Use List

common-lisp.

Public Interface
Internals

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

5.9 ceramic.crashreporter

Start Electron’s Crash Reporter.

Source

crashreporter.lisp.

Use List

common-lisp.

Public Interface

start-crash-reporter (function).


5.10 ceramic

The main interface.

Source

ceramic.lisp.

Use List

common-lisp.

Public Interface

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

5.11 ceramic.setup

Set up everything needed to develop with Ceramic.

Source

setup.lisp.

Use List

common-lisp.

Public Interface

setup (function).

Internals

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

5.12 ceramic.os

Operating system-related stuff.

Source

os.lisp.

Use List

common-lisp.

Public Interface
Internals

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

5.13 ceramic.resource

Ceramic’s resource-management utilities.

Source

resource.lisp.

Use List

common-lisp.

Public Interface
Internals

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

5.14 ceramic.driver

The Ceramic driver interface.

Source

driver.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


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

6.1 Public Interface


Next: , Previous: , 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.


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.


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.


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.

Generic Function: center (window)
Package

ceramic.window.

Methods
Method: center ((window window))

Move the window to the center of the screen.

Source

window.lisp.

Generic Function: close (window)
Package

ceramic.window.

Methods
Method: close ((window window))

Close the window.

Source

window.lisp.

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

ceramic.window.

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

Close the developer tools.

Source

window.lisp.

Generic Function: copy (window)
Package

ceramic.window.

Methods
Method: copy ((window window))

Copy selected text.

Source

window.lisp.

Generic Function: crashedp (window)
Package

ceramic.window.

Methods
Method: crashedp ((window window))

Return whether the window has crashed.

Source

window.lisp.

Generic Function: cut (window)
Package

ceramic.window.

Methods
Method: cut ((window window))

Cut selected text.

Source

window.lisp.

Generic Function: forward (window)
Package

ceramic.window.

Methods
Method: forward ((window window))

Go forward in the page history.

Source

window.lisp.

Generic Function: hide (window)
Package

ceramic.window.

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

ceramic.driver.

Source

driver.lisp.

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.

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

ceramic.window.

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

Open the developer tools.

Source

window.lisp.

Generic Function: paste (window)
Package

ceramic.window.

Methods
Method: paste ((window window))

Paste text.

Source

window.lisp.

Generic Function: redo (window)
Package

ceramic.window.

Methods
Method: redo ((window window))

Redo changes.

Source

window.lisp.

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.

Generic Function: select-all (window)
Package

ceramic.window.

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

Select all text.

Source

window.lisp.

Generic Function: show (window)
Package

ceramic.window.

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

ceramic.driver.

Source

driver.lisp.

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

Stop the Electron process and the remote-js server.

Package

ceramic.driver.

Source

driver.lisp.

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.

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.

Methods
Method: sync-js ((driver driver) js)
Generic Function: title (window)
Package

ceramic.window.

Methods
Method: title ((window window))

Return the window’s title.

Source

window.lisp.

Generic Function: (setf title) (window)
Package

ceramic.window.

Methods
Method: (setf title) ((window window))

Set the window’s title.

Source

window.lisp.

Generic Function: undo (window)
Package

ceramic.window.

Methods
Method: undo ((window window))

Undo changes.

Source

window.lisp.

Generic Function: unselect (window)
Package

ceramic.window.

Methods
Method: unselect ((window window))

Cancel the selection.

Source

window.lisp.

Generic Function: url (window)
Package

ceramic.window.

Methods
Method: url ((window window))

Return the window’s current URL.

Source

window.lisp.

Generic Function: (setf url) (window)
Package

ceramic.window.

Methods
Method: (setf url) ((window window))

Change the window’s URL.

Source

window.lisp.

Generic Reader: window-id (object)
Package

ceramic.window.

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

A unique string ID for the window.

Source

window.lisp.

Target Slot

%id.


6.1.5 Conditions

Condition: ceramic-error

The base class of Ceramic-related conditions.

Package

ceramic.error.

Source

error.lisp.

Direct superclasses

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.

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

ceramic.error.

Source

error.lisp.

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: , Up: Public Interface   [Contents][Index]

6.1.6 Classes

Class: driver

The Ceramic driver.

Package

ceramic.driver.

Source

driver.lisp.

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

ceramic.resource.

Source

resource.lisp.

Direct methods
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

ceramic.window.

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.


6.2 Internals


Next: , Previous: , 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.


6.2.2 Macros

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

ceramic.window.

Source

window.lisp.


Next: , Previous: , 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.


6.2.4 Generic functions

Generic Function: %reload (window)
Package

ceramic.window.

Methods
Method: %reload ((window window))
Source

window.lisp.

Generic Function: %reload-force (window)
Package

ceramic.window.

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

window.lisp.

Generic Function: address (driver)

Return the address the WebSockets server is running on.

Package

ceramic.driver.

Source

driver.lisp.

Methods
Method: address ((driver driver))
Generic Reader: driver-context (object)
Generic Writer: (setf driver-context) (object)
Package

ceramic.driver.

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

ceramic.driver.

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

ceramic.driver.

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

ceramic.driver.

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

ceramic.driver.

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

ceramic.error.

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

ceramic.driver.

Source

driver.lisp.

Methods
Method: on-message ((driver driver) message)
Generic Reader: os-name (condition)
Package

ceramic.error.

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

ceramic.driver.

Source

driver.lisp.

Methods
Method: port ((driver driver))
Generic Reader: resource-pathname (object)
Package

ceramic.resource.

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

ceramic.resource.

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

ceramic.resource.

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

The resource tag.

Source

resource.lisp.

Target Slot

tag.

Generic Function: start-electron (driver)
Package

ceramic.driver.

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

Start the Electron process.

Source

driver.lisp.

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

ceramic.driver.

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

Start the remote-js server.

Source

driver.lisp.

Generic Function: stop-electron (driver)
Package

ceramic.driver.

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

Stop the Electron process.

Source

driver.lisp.

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

ceramic.driver.

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

Stop the remote-js server.

Source

driver.lisp.

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.


Appendix A Indexes


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

A.1 Concepts


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: Private generic functions
%reload: Private generic functions
%reload-force: Private generic functions
%reload-force: Private generic functions

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

A
address: Private generic functions
address: Private generic functions
archive-extension: Private ordinary functions

B
back: Public generic functions
back: Public generic functions
bundle: Public ordinary functions

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

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

E
error-tag: Private generic functions
error-tag: Private generic functions
executable-pathname: Public ordinary functions
executable-relative-pathname: Public ordinary functions

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

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

H
hide: Public generic functions
hide: Public generic functions

I
insert-javascript: Private ordinary functions
insert-package-definition: Private ordinary functions

J
js: Public generic functions
js: Public generic functions
js: Private ordinary functions

L
loadingp: Public generic functions
loadingp: Public generic functions
log-message: Public ordinary functions

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

O
on-message: Private generic functions
on-message: Private generic functions
open-dev-tools: Public generic functions
open-dev-tools: Public generic functions
os-name: Private generic functions
os-name: Private generic functions

P
paste: Public generic functions
paste: Public generic functions
port: Private generic functions
port: Private generic functions
prepare-release: Private ordinary functions

Q
quit: Public ordinary functions

R
redo: Public generic functions
redo: Public generic functions
release-directory: Public ordinary functions
release-resources-directory: Private ordinary functions
reload: Public generic functions
reload: Public generic functions
resource: Public ordinary functions
resource-directory: Public ordinary functions
resource-pathname: Private generic functions
resource-pathname: Private generic functions
resource-system: Private generic functions
resource-system: Private generic functions
resource-tag: Private generic functions
resource-tag: Private generic functions

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

T
title: Public generic functions
title: Public generic functions

U
undo: Public generic functions
undo: Public generic functions
unselect: Public generic functions
unselect: Public generic functions
url: Public generic functions
url: Public generic functions

W
wait-for-client: Private generic functions
wait-for-client: Private generic functions
window-id: Public generic functions
window-id: Public generic functions
wipe-data: Public ordinary 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: Public classes

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

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

C
context: Public classes

J
js-cond: Public classes
js-lock: Public classes

O
os-name: Public conditions

P
pathname: Public classes
process: Public classes

R
responses: Public classes

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

T
tag: Public conditions
tag: Public classes

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

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

A.4 Data types

Jump to:   B   C   D   E   F   L   M   N   O   P   Q   R   S   U   W  
Index Entry  Section

B
bundler.lisp: The ceramic/src/bundler․lisp file

C
ceramic: The ceramic system
ceramic: The ceramic package
ceramic-entry: The ceramic-entry package
ceramic-error: Public conditions
ceramic.asd: The ceramic/ceramic․asd file
ceramic.bundler: The ceramic․bundler package
ceramic.crashreporter: The ceramic․crashreporter package
ceramic.dialog: The ceramic․dialog package
ceramic.driver: The ceramic․driver package
ceramic.error: The ceramic․error package
ceramic.file: The ceramic․file package
ceramic.lisp: The ceramic/src/ceramic․lisp file
ceramic.log: The ceramic․log package
ceramic.os: The ceramic․os package
ceramic.resource: The ceramic․resource package
ceramic.runtime: The ceramic․runtime package
ceramic.setup: The ceramic․setup package
ceramic.window: The ceramic․window package
Class, driver: Public classes
Class, resource: Public classes
Class, window: Public classes
Condition, ceramic-error: Public conditions
Condition, no-such-tag: Public conditions
Condition, not-in-release: Public conditions
Condition, unsupported-operating-system: Public conditions
crashreporter.lisp: The ceramic/src/crashreporter․lisp file

D
dialog.lisp: The ceramic/src/dialog․lisp file
driver: Public classes
driver.lisp: The ceramic/src/driver․lisp file

E
error.lisp: The ceramic/src/error․lisp file

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

L
logging.lisp: The ceramic/src/logging․lisp file

M
main.js: The ceramic/src/main․js file
Module, src: The ceramic/src module

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

O
os.lisp: The ceramic/src/os․lisp file

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

Q
quit.lisp: The ceramic/src/quit․lisp file

R
resource: Public classes
resource.lisp: The ceramic/src/resource․lisp file
runtime.lisp: The ceramic/src/runtime․lisp file

S
setup.lisp: The ceramic/src/setup․lisp file
src: The ceramic/src module
System, ceramic: The ceramic system

U
unsupported-operating-system: Public conditions

W
window: Public classes
window.lisp: The ceramic/src/window․lisp file

Jump to:   B   C   D   E   F   L   M   N   O   P   Q   R   S   U   W