This is the omg Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:08:44 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
omgA Common Lisp library to build fully dynamic web interfaces
Pavel Kaygorodov <hemml@me.com>
GPLv3
0.2.0
clack (system).
websocket-driver-server (system).
bordeaux-threads (system).
trivial-utf-8 (system).
media-types (system).
hunchentoot (system).
pngload (system).
skippy (system).
cl-jpeg (system).
cl-base64 (system).
quri (system).
readme.md (file).
license (file).
omg.lisp (file).
omgui.lisp (file).
omgutil.lisp (file).
omgwidgets.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
omg/omg.lispomg (system).
omg.
add-serve-path (function).
add-to-boot (function).
add-to-root-html (function).
add-to-root-html-head (function).
current-session-id (function).
def-local-macro-f (macro).
def-session-var (macro).
defclass-f (macro).
defconstant-f (macro).
defgeneric-f (macro).
defmacro-f (macro).
defmethod-f (macro).
defmethod-r (macro).
defparameter-f (macro).
defun-f (macro).
defun-r (macro).
defvar-f (macro).
find-session (function).
in-debug-session (macro).
initialize-instance (method).
kill-server (function).
print-object (method).
remote-exec (function).
remote-exec-timeout (condition).
restart-server (function).
rm-from-boot (function).
set-boot (function).
set-debug-session (function).
set-root-head (function).
set-root-html (function).
socket (reader method).
start-server (function).
thread-in-session (macro).
with-session (macro).
*accessor-classes* (special variable).
*boot-done* (special variable).
*boot-functions* (special variable).
*classes-f-slots* (special variable).
*classes-f-superclasses* (special variable).
*cross-origin* (special variable).
*current-res* (special variable).
*current-session* (special variable).
*debug-session-id* (special variable).
*disable-remote-macro* (special variable).
*exportable-expressions* (special variable).
*exported-classes-methods* (special variable).
*exported-function-names* (special variable).
*extra-head* (special variable).
*extra-html* (special variable).
*giant-hash-lock* (special variable).
*gimme-path* (special variable).
*gimme-wait-list* (special variable).
*html-path* (special variable).
*in-f-macro* (special variable).
*in-omg-writer* (special variable).
*in-rpc* (special variable).
*js-path* (special variable).
*last-args* (special variable).
*local-compile* (special variable).
*local-lambdas* (special variable).
*m-classess* (special variable).
*m-initialized* (special variable).
*m-scope-funcs* (special variable).
*m-scopes* (special variable).
*omg-thread-list* (special variable).
*port* (special variable).
*pre-boot-functions* (special variable).
*remote-exec-timeout* (special variable).
*remote-objects* (special variable).
*root-path* (special variable).
*rpc-functions* (special variable).
*rpc-path* (special variable).
*rpc-path-m* (special variable).
*serv* (special variable).
*serve-paths* (special variable).
*service-worker-path* (special variable).
*session-list* (special variable).
*session-timeout* (special variable).
*ssl-cert* (special variable).
*ssl-key* (special variable).
*takit-path* (special variable).
*takit-wait-list* (special variable).
*thread-to-kill* (special variable).
*use-wss* (special variable).
*user-uri-handler* (special variable).
*web-worker-path* (special variable).
*wl-timeout* (special variable).
*ws-path* (special variable).
boot-f (function).
compile-to-js (function).
defclass-m (macro).
disconnected-at (reader method).
(setf disconnected-at) (writer method).
exec-local-lambda (function).
exec-remote-macro (function).
f-eval (function).
from-base64 (function).
get-all-sup (function).
get-id (reader method).
get-main-js (function).
get-root-html (function).
get-service-worker-js (function).
get-str-from (function).
get-worker-js (function).
gethash-lock (function).
(setf gethash-lock) (function).
gimme (function).
has-ssl-p (function).
id (reader method).
(setf id) (writer method).
is-system-pkg (function).
last-active (reader method).
make-def-macro-f (macro).
make-var-macro-f (macro).
make-ws (function).
omg-data-to-compile-form (function).
omg-read (function).
omg-read-from-string (function).
omg-session (class).
omg-write-to-string (function).
par-map (function).
print-m-slots-init (method).
put-wl-result (function).
random-key (function).
random-string (function).
random-symbol (function).
register-rpc (function).
remote-object (class).
remote-rdefclass (function).
remote-unintern (function).
remote-update-methods (function).
replace-all (function).
rpc-wrapper (function).
scope-session (function).
serv (function).
session (reader method).
session (reader method).
(setf session) (writer method).
session-ws (reader method).
(setf session-ws) (writer method).
sid-length (constant).
takit (function).
to-base64 (function).
use-wss-p (function).
wait-list (reader method).
omg/omgui.lispomg.lisp (file).
omg (system).
add-event-handler (macro).
add-event-listener (macro).
add-style (macro).
add-youtube-player (macro).
allow-page-close (macro).
append-element (macro).
async-bind (macro).
bind-exit-values-for (macro).
browser-case (macro).
check-element (macro).
close-current-dialog (macro).
create-element (macro).
dialog-ok (macro).
disable-back-button (macro).
disable-scroll (macro).
dragabble-list-elements (macro).
dragabble-list-insert (macro).
dragabble-list-insert-position (macro).
element-height (macro).
element-width (macro).
enable-back-button (macro).
enable-scroll (macro).
ensure-element (macro).
execute-after (macro).
find-widget (macro).
gensym2 (macro).
get-dialog-data (macro).
get-element-id (macro).
if-idb-key (macro).
in-service-worker (macro).
indexed-db-add (macro).
indexed-db-delete (macro).
indexed-db-get (macro).
indexed-db-get-all-keys (macro).
indexed-db-put (macro).
is-nan (macro).
js-get-element-by-id (macro).
js-parse-float (macro).
jsacos (macro).
jsasin (macro).
jsatan (macro).
jsatan2 (macro).
jsceil (macro).
jscos (macro).
jsfloor (macro).
jsln (macro).
jslog (macro).
jsmax (macro).
jsmin (macro).
jsrandom (macro).
jssin (macro).
jssort (macro).
jstan (macro).
jstrunc (macro).
load-from-buffer (macro).
load-js-script (macro).
local-storage (macro).
make-dialog (macro).
make-dragabble-list (macro).
make-js-function (macro).
make-js-object (macro).
make-pwa (function).
make-svg (macro).
make-tab-form (macro).
modal-dialog (macro).
now (macro).
oget-bind (macro).
on-element-remove (macro).
page-height (macro).
page-width (macro).
parent-element (macro).
prevent-page-close (macro).
register-hash-cb (macro).
register-main-lambda (macro).
remove-element (macro).
rm-event-handler (macro).
run-in-web-worker (macro).
session-storage (macro).
set-service-worker-uri-handler (macro).
setup-indexed-db (macro).
show-notification (macro).
store-to-buffer (macro).
visible-height (macro).
visible-left (macro).
visible-top (macro).
visible-width (macro).
when-worker-free (macro).
when-worker-ready (macro).
winref (macro).
with-promise (macro).
with-self (macro).
*backcnt* (special variable).
*beforeunload-installed* (special variable).
*current-service-worker* (special variable).
*default-icon* (special variable).
*dialog-stack* (special variable).
*dialog-wait-list* (special variable).
*disable-back* (special variable).
*disable-page-unload* (special variable).
*fback* (special variable).
*global-event-handlers* (special variable).
*global-observer-handlers* (special variable).
*hash-change-cbs* (special variable).
*linefeed* (special variable).
*main-lambdas* (special variable).
*main-thread-result-cache* (special variable).
*notification-container* (special variable).
*onpopstate-installed* (special variable).
*pwa-mode* (special variable).
*scroll-disabled* (special variable).
*style-cache* (special variable).
*web-workers-pool* (special variable).
*worker-cache* (special variable).
*youtube-js-loaded* (special variable).
compile-js (macro).
curtain (macro).
deep-oget-1 (macro).
dialog-frame (macro).
dialog-header (macro).
dialog-table (macro).
dialog-wl-send (function).
element-on-page-p (macro).
form-button-row (macro).
form-line (macro).
get-free-worker (macro).
get-js-path (function).
get-root-path (function).
get-sw-path (function).
get-ww-path (function).
js-string-split (macro).
random-id (macro).
system-font (macro).
with-indexed-db (macro).
omg/omgutil.lispomg.lisp (file).
omg (system).
data-sync (class).
get-timeouts (function).
initialize-instance (method).
print-object (method).
reset-timeouts (function).
sync-data (method).
*data-sync-objects* (special variable).
data-epoch (reader method).
(setf data-epoch) (writer method).
print-m-slots-init (method).
sync-all-data (macro).
sync-slot (method).
sync-slot-r (method).
omg/omgwidgets.lispomg.lisp (file).
omgui.lisp (file).
omg (system).
current-position (reader method).
(setf current-position) (writer method).
elements (reader method).
(setf elements) (writer method).
initialize-instance (method).
list-view (class).
make-curve (generic function).
print-object (method).
root (reader method).
(setf root) (writer method).
xmax (generic function).
xmin (generic function).
ymax (generic function).
ymin (generic function).
elements-length (method).
get-element (method).
get-elements (method).
guess-delta (macro).
print-m-slots-init (method).
sync-slot (method).
sync-slot-r (method).
Packages are listed by definition order.
omguibordeaux-threads.
common-lisp.
jscl.
omg.
add-event-handler (macro).
add-event-listener (macro).
add-style (macro).
add-youtube-player (macro).
allow-page-close (macro).
append-element (macro).
async-bind (macro).
bind-exit-values-for (macro).
browser-case (macro).
check-element (macro).
close-current-dialog (macro).
create-element (macro).
dialog-ok (macro).
disable-back-button (macro).
disable-scroll (macro).
dragabble-list-elements (macro).
dragabble-list-insert (macro).
dragabble-list-insert-position (macro).
element-height (macro).
element-width (macro).
enable-back-button (macro).
enable-scroll (macro).
ensure-element (macro).
execute-after (macro).
find-widget (macro).
gensym2 (macro).
get-dialog-data (macro).
get-element-id (macro).
if-idb-key (macro).
in-service-worker (macro).
indexed-db-add (macro).
indexed-db-delete (macro).
indexed-db-get (macro).
indexed-db-get-all-keys (macro).
indexed-db-put (macro).
is-nan (macro).
js-get-element-by-id (macro).
js-parse-float (macro).
jsacos (macro).
jsasin (macro).
jsatan (macro).
jsatan2 (macro).
jsceil (macro).
jscos (macro).
jsfloor (macro).
jsln (macro).
jslog (macro).
jsmax (macro).
jsmin (macro).
jsrandom (macro).
jssin (macro).
jssort (macro).
jstan (macro).
jstrunc (macro).
load-from-buffer (macro).
load-js-script (macro).
local-storage (macro).
make-dialog (macro).
make-dragabble-list (macro).
make-js-function (macro).
make-js-object (macro).
make-pwa (function).
make-svg (macro).
make-tab-form (macro).
modal-dialog (macro).
now (macro).
oget-bind (macro).
on-element-remove (macro).
page-height (macro).
page-width (macro).
parent-element (macro).
prevent-page-close (macro).
register-hash-cb (macro).
register-main-lambda (macro).
remove-element (macro).
rm-event-handler (macro).
run-in-web-worker (macro).
session-storage (macro).
set-service-worker-uri-handler (macro).
setup-indexed-db (macro).
show-notification (macro).
store-to-buffer (macro).
visible-height (macro).
visible-left (macro).
visible-top (macro).
visible-width (macro).
when-worker-free (macro).
when-worker-ready (macro).
winref (macro).
with-promise (macro).
with-self (macro).
*backcnt* (special variable).
*beforeunload-installed* (special variable).
*current-service-worker* (special variable).
*default-icon* (special variable).
*dialog-stack* (special variable).
*dialog-wait-list* (special variable).
*disable-back* (special variable).
*disable-page-unload* (special variable).
*fback* (special variable).
*global-event-handlers* (special variable).
*global-observer-handlers* (special variable).
*hash-change-cbs* (special variable).
*linefeed* (special variable).
*main-lambdas* (special variable).
*main-thread-result-cache* (special variable).
*notification-container* (special variable).
*onpopstate-installed* (special variable).
*pwa-mode* (special variable).
*scroll-disabled* (special variable).
*style-cache* (special variable).
*web-workers-pool* (special variable).
*worker-cache* (special variable).
*youtube-js-loaded* (special variable).
compile-js (macro).
curtain (macro).
deep-oget-1 (macro).
dialog-frame (macro).
dialog-header (macro).
dialog-table (macro).
dialog-wl-send (function).
element-on-page-p (macro).
form-button-row (macro).
form-line (macro).
get-free-worker (macro).
get-js-path (function).
get-root-path (function).
get-sw-path (function).
get-ww-path (function).
js-string-split (macro).
random-id (macro).
system-font (macro).
with-indexed-db (macro).
omgwidgetscurrent-position (generic reader).
(setf current-position) (generic writer).
elements (generic reader).
(setf elements) (generic writer).
list-view (class).
make-curve (generic function).
root (generic reader).
(setf root) (generic writer).
xmax (generic function).
xmin (generic function).
ymax (generic function).
ymin (generic function).
elements-length (generic function).
get-element (generic function).
get-elements (generic function).
guess-delta (macro).
omgbordeaux-threads.
clack.
common-lisp.
trivial-utf-8.
websocket-driver.
add-serve-path (function).
add-to-boot (function).
add-to-root-html (function).
add-to-root-html-head (function).
current-session-id (function).
def-local-macro-f (macro).
def-session-var (macro).
defclass-f (macro).
defconstant-f (macro).
defgeneric-f (macro).
defmacro-f (macro).
defmethod-f (macro).
defmethod-r (macro).
defparameter-f (macro).
defun-f (macro).
defun-r (macro).
defvar-f (macro).
find-session (function).
in-debug-session (macro).
kill-server (function).
remote-exec (function).
remote-exec-timeout (condition).
restart-server (function).
rm-from-boot (function).
set-boot (function).
set-debug-session (function).
set-root-head (function).
set-root-html (function).
start-server (function).
thread-in-session (macro).
with-session (macro).
*accessor-classes* (special variable).
*boot-done* (special variable).
*boot-functions* (special variable).
*classes-f-slots* (special variable).
*classes-f-superclasses* (special variable).
*cross-origin* (special variable).
*current-res* (special variable).
*current-session* (special variable).
*debug-session-id* (special variable).
*disable-remote-macro* (special variable).
*exportable-expressions* (special variable).
*exported-classes-methods* (special variable).
*exported-function-names* (special variable).
*extra-head* (special variable).
*extra-html* (special variable).
*giant-hash-lock* (special variable).
*gimme-path* (special variable).
*gimme-wait-list* (special variable).
*html-path* (special variable).
*in-f-macro* (special variable).
*in-omg-writer* (special variable).
*in-rpc* (special variable).
*js-path* (special variable).
*last-args* (special variable).
*local-compile* (special variable).
*local-lambdas* (special variable).
*m-classess* (special variable).
*m-initialized* (special variable).
*m-scope-funcs* (special variable).
*m-scopes* (special variable).
*omg-thread-list* (special variable).
*port* (special variable).
*pre-boot-functions* (special variable).
*remote-exec-timeout* (special variable).
*remote-objects* (special variable).
*root-path* (special variable).
*rpc-functions* (special variable).
*rpc-path* (special variable).
*rpc-path-m* (special variable).
*serv* (special variable).
*serve-paths* (special variable).
*service-worker-path* (special variable).
*session-list* (special variable).
*session-timeout* (special variable).
*ssl-cert* (special variable).
*ssl-key* (special variable).
*takit-path* (special variable).
*takit-wait-list* (special variable).
*thread-to-kill* (special variable).
*use-wss* (special variable).
*user-uri-handler* (special variable).
*web-worker-path* (special variable).
*wl-timeout* (special variable).
*ws-path* (special variable).
boot-f (function).
compile-to-js (function).
defclass-m (macro).
disconnected-at (generic reader).
(setf disconnected-at) (generic writer).
exec-local-lambda (function).
exec-remote-macro (function).
f-eval (function).
f-init (slot).
f-init (slot).
from-base64 (function).
get-all-sup (function).
get-id (generic reader).
get-main-js (function).
get-root-html (function).
get-service-worker-js (function).
get-str-from (function).
get-worker-js (function).
gethash-lock (function).
(setf gethash-lock) (function).
gimme (function).
has-ssl-p (function).
id (generic reader).
(setf id) (generic writer).
is-system-pkg (function).
last-active (generic reader).
make-def-macro-f (macro).
make-var-macro-f (macro).
make-ws (function).
omg-data-to-compile-form (function).
omg-id (slot).
omg-id (slot).
omg-read (function).
omg-read-from-string (function).
omg-session (class).
omg-write-to-string (function).
par-map (function).
print-m-slots-init (generic function).
put-wl-result (function).
random-key (function).
random-string (function).
random-symbol (function).
register-rpc (function).
remote-object (class).
remote-rdefclass (function).
remote-unintern (function).
remote-update-methods (function).
replace-all (function).
rpc-wrapper (function).
scope (slot).
scope (slot).
scope-session (function).
serv (function).
session (generic reader).
(setf session) (generic writer).
session-ws (generic reader).
(setf session-ws) (generic writer).
sid-length (constant).
sync-all-data (macro).
sync-slot (generic function).
sync-slot-r (generic function).
takit (function).
to-base64 (function).
use-wss-p (function).
wait-list (generic reader).
omgutilcommon-lisp.
omg.
data-sync (class).
get-timeouts (function).
reset-timeouts (function).
sync-data (generic function).
*data-sync-objects* (special variable).
data-epoch (generic reader).
(setf data-epoch) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a server-side function and allow to call it from browser side
Execute commands inside session sess
Execute the code on the browser-side. If the *current-session* set, the code will be executed
within the specific session, otherwise, the code will be executed in all sessions and all the return
values are returned as a list. If the nowait is T, the function will retrurn NIL immediately, without waiting
result from the remote side.
remote-object) &key &allow-other-keys) ¶remote-object) s) ¶omg-session)) ¶automatically generated reader method
omg.
error.
0
Just a macro to generate macros for f-functions and f-macros definintions (defun-f, defmacro-f, etc...)
A macro for variables-parameters-constants definitions
The boot code, will be executed on the browser-side just after the page is loaded and socket connected.
Return JS for the code, pkg is current package for compilation context.
Execute in a browser a code of the macro with the specific name and argments.
Called by JSCL compiler while compling lisp code to JS. We have to execute macros on the
browser-side, because all side-effects, produced by macros, must have a place in the browser.
Smart-eval – evaluate everything, but expotrable expressions, lambdas and function names
Return the JS code, including JSCL and OMG parts glued.
The handler for gimme-requests, which are used to request unknown symbols from the server-side.
Return the websocket for the new session. Also, creates the session object.
Generate a random stgring of length len
Unintern the symbol within all active sessions, mandatory to reflect symbol redefinition. The next try to intern the symbol in browser-side will cause new symbol fetch.
Returns a new string in which all the occurences of the part is replaced with replacement.
The wrapper for RPC requests, used to allow call browser-side functions from RPC funcs.
The handler for takit-requests. This requests are used to return macro expansion results from browser-side
omg.
omg-session)) ¶automatically generated reader method
omg.
omg-session)) ¶automatically generated writer method
omg.
omg-session)) ¶automatically generated reader method
omg.
remote-object)) ¶automatically generated reader method
omg.
remote-object)) ¶automatically generated writer method
omg.
omg-session)) ¶automatically generated reader method
omg.
remote-exec-timeout)) ¶remote-object)) ¶automatically generated reader method
omg.
remote-object)) ¶automatically generated writer method
omg.
omg-session)) ¶automatically generated reader method
omg.
omg-session)) ¶automatically generated writer method
omg.
omg-session)) ¶automatically generated reader method
The session object, holding the session socket, the wait-list holding semaphores and storing result data from remote-exec calls
omg.
websocket-driver.ws.base.
(error "socket required")
:socket
This slot is read-only.
(omg::random-symbol omg::|sid-length|)
This slot is read-only.
0
(get-universal-time)
This slot is read-only.
(error "session ws required")
:ws
| Jump to: | (
A B C D E F G H I J K L M N O P R S T U V W X Y |
|---|
| Jump to: | (
A B C D E F G H I J K L M N O P R S T U V W X Y |
|---|
| Jump to: | *
C D E F I L O R S T W |
|---|
| Jump to: | *
C D E F I L O R S T W |
|---|
| Jump to: | C D F L O P R S |
|---|
| Jump to: | C D F L O P R S |
|---|