The omg Reference Manual

Table of Contents

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

The omg Reference Manual

This is the omg Reference Manual, version 0.1.8, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 12:00:19 2021 GMT+0.


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

1 Introduction

OMGlib

A Common Lisp library to build fully dynamic web interfaces

The main idea of this library is to vanish a border between frontend and backend as much as possible. You can develop a CL application using REPL and SLIME on a backend, but some of you functions and macros can be declared as browser-side (b-s) with defun-f and defmacro-f respectively:

(require :omg)
(defpackage mytest (:use cl omg))
(in-package :mytest)
(defun-f js-add (x y)
  (+ x y)) ;; this code will be executed in a browser

The (start-server) function starts clack web server on default port 7500 (can be changed by setting omg::*port* variable). Now, in the html-code you can inject the following line:

<script src='http://localhost:7500/j' type='text/javascript'></script>

or just open a page http://localhost:7500/ (a blank page with js-injection code).

Now you call a browser-side function, just executing it in REPL, for example:

MYTEST> (js-add 1 2)
;; (3)

The function call will be converted to javascript with JSCL and sent to the browser via websocket, where the code will be executed and result will be returned to the backend. The result in this example will be returned as a list, because we are not specified a session (see below) and the code will be executed in all connected browsers, and the list of result values will be returned.

The more complicated example you can find in in example.lisp file, where omgui package is used to manipulate DOM objects.

OMGUI package

OMG package is all-sufficient and can be used as is to control a frontend. You can execute any JS code on the browser-side using JSCL FFI:

(defun-f jslog (&rest args) ;; call console.log(...args)
  "Log function for js"
  (apply (jscl::oget (jscl::%js-vref "console") "log") args)
  nil)

But many of useful JS and DOM-manipulating functions are provided by omgui package, where you can find the following functions:

Creating SVG elements

You can create SVG elements with make-svg function. The function accepts parameter pairs like :|attributename| value for attributes and (tag-name ...attributes and subtags) for inner elements. For exanple, the following code will return SVG-object with circle:

(make-svg :|viewBox| "0 0 100 100"
          '(circle :|cx| 50 :|cy| 50 :|r| 50 :|fill| "red"))

The following function returns animated spinner:

(defun-f make-spinner ()
  (let* ((width 20)
         (ncirc 10)
         (r (/ width 2))
         (rc (/ width 6)))
    (apply #'make-svg
           `(:|viewBox| ,(format nil "0 0 ~A ~A" width width)
             ,@(loop for i below ncirc
                     for ang = (* i (/ (* 2 pi) ncirc))
                     collect
                 `(circle :|cx| ,(+ r (* (- r rc) (jscos ang)))
                          :|cy| ,(+ r (* -1 (- r rc) (jssin ang)))
                          :|r| 0
                          :|fill| "#505050"
                          (animate :|attributeName| "r"
                                   :|from| ,rc
                                   :|to| ,(* rc (/ 3 (+ ncirc 2)))
                                   :|begin| ,(format nil "~As" (/ (- ncirc i 1) ncirc))
                                   :|dur| "1s"
                                   :|repeatCount| "indefinite")
                          (animate :|attributeName| "fill-opacity"
                                   :|from| 1
                                   :|to| 0
                                   :|begin| ,(format nil "~As" (/ (- ncirc i 1) ncirc))
                                   :|dur| "1s"
                                   :|repeatCount| "indefinite")))))))

Modal dialogs

You can display modal dialog in the browser using the modal-dialog macro:

(in-debug-session
  (print (modal-dialog "Dialog header"
                       "Dialog text"))
                       :lines (list :line1 "field 1"
                                    :line2 "field 2"
                                    :buttons (list (list "OK" #'dialog-ok)
                                                   (list "Cancel" #'close-current-dialog))))
;; ((:line1 "Text in the line 1"))
    (:line2 "Text in the line 2")

This code will display a modal dialog in debug session and print the result, returned as a plist or nil if the Cancel button was pressed.

You can provide validation functions for input lines in the form ... :line1 (list "field1" #'func), where #'func can be a browser-side or RPC function. Also you can provide (lambda (s) ...) as a validator function, and even a #'any-backend-function but you will get a security warning in last case. The function must accept a string as an argument and return an (optionally) modified string which will replace the string in the input field. See the example.lisp.

You callbacks can use the following supplementary functions:

Yotube player

Restrictions

How it works

There are the following macros to define browser-side functions, macros and variables:

Also you can define RPC-functions, with

Browser-side functions

defun-r has similar syntax as a defun, but defines macro with the same name, instead of function. The macro has to check its arguments and evaluate only some of them on backend, passing the rest to the browser-side as is. For example:

(some-bs-function "value1" ;; will be passed as is
                  (some-backend-function) ;; will be evaluated on backend and the result will be passed as a parameter
                  (another-bs-function) ;; will be passed as is and evaluated on browser-side
                  #'another-bs-function ;; will be passed as is
                  (lambda (x) (+ x 1)) ;; will be passed as is and evaluated on browser-side
                  #'another-backend-function) ;; will be automatically converted to RPC-call, security warning will be printed

Just after websocket connection, the browser-side has no declared symbols and functions. When you trying to execute (some-bs-function) the symbol some-bs-function will be undeclared (in browser) and the library will ask backend for the symbol via synchronous XHR query and will get it as an already compiled to JS code. You can change this behavior by setting the omg::*local-compile* variable to nil, after that the CL code will be sent as is and compiled in browser before execution. This can provide a bit more compatibility, but code compilation will be much slower. The omg::*local-compile* may be changed on-the-fly without browser page reloading.

The library determines which symbols must be fetched from backend just by their packages: if the package still not exists, it will be created on-the-fly with defpackage, cl and jscl packages will be used. All created packages will be marked as remote and the library will try to fetch unknown symbols from that packages from the backend. This is the reason, why you cannot define browser-side functions just in CL-USER.

The CLOS is not implemented in browser-side. It is implemented in JSCL, but I see no way to catch access to undefined methods if several methods are defined with same names. If you are know how to implement this - tell me :)

Browser-side macros

Browser-side macros are called while code is compiled to JS and must be evaluated on the browser side. So, if you are use such macros while the omg::*local-compile* is set to T (by default), JSCL will parse the code and execute code of each macro in the browser, get the results and finish the compilation using them. This means that while local compilation is enabled, macro expansion will be rather expensive, especially, if you are using recursive macros.

Browser-side variables and parameters

You can declare browser-side variables and parameters with defvar-f and defparameter-f. They a similar to standard defvar and defparameter, but the symbols will be available to browser-side functions. This is one-way availability: if the variable will be changed on browser-side, backend will see no update, also, the data will not be updated on other connected browsers. If you are changing such variable or parameter on the backend, the changes will be seen only for newly connected browsers or by browser, which are not fetched they yet.

RPC functions

Due to security reasons, you can call only some specially marked functions of backend from browser side. You can declare them with defun-r macro, which acts as standard defun, but places the function name in the list of allowed RPC functions. The RPC function can be simply called on browser-side as any other function.

Also, you can asynchronously call any RPC function using async-bind macro:

(async-bind (res (some-rpc-function arg1 arg2))
  (jslog res) ;; The code will be executed asynchronously after RPC call completion

Sessions

Each connected browser starts a new session which is determined by unique random symbol - session ID. When RPC-function is called from browser-side, it will be executed in the session context, so, it will execute all bs-functions in the specific browser. You can implicitly set the current session by executing a code inside with-session macro:

(with-session (find-session 'ASDXCASA) ;; find a session object by ID
  (some-bs-function)) ;; will be called in session 'ASDXCASA

If you are executing bs-function without session, it will be executed in ALL connected browsers and a list of results will be returned.

The library provides some other utility functions to work with sessions:

Boot functions

Just after connection, the some boot code will be executed in browser. You can control this using the following functions:

REMOTE-EXEC function

You can use (remote-exec cmd [nowait]) function to execute any CL code cmd in the browser. This function has optional argument nowait - set it to T if you are not needed to return value(s) and the function will return nil immediately.


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 omg

Author

Pavel Kaygorodov <hemml@me.com>

Home Page

https://github.com/hemml/OMGlib

Source Control

https://github.com/hemml/OMGlib.git

License

GPLv3

Description

A Common Lisp library to build fully dynamic web interfaces

Version

0.1.8

Dependencies
Source

omg.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 omg.asd

Location

omg.asd

Systems

omg (system)


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

3.1.2 omg/omg.lisp

Parent

omg (system)

Location

omg.lisp

Packages

omg

Exported Definitions
Internal Definitions

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

3.1.3 omg/omgui.lisp

Dependency

omg.lisp (file)

Parent

omg (system)

Location

omgui.lisp

Packages

omgui

Exported Definitions
Internal Definitions

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

3.2 Static


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

3.2.1 omg/README.md

Parent

omg (system)

Location

README.md


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

3.2.2 omg/LICENSE

Parent

omg (system)

Location

LICENSE


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

4 Packages

Packages are listed by definition order.


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

4.1 omg

Source

omg.lisp (file)

Use List
Used By List

omgui

Exported Definitions
Internal Definitions

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

4.2 omgui

Source

omgui.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Macros

Macro: add-youtube-player &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: allow-page-close &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: append-element &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: async-bind &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: check-element &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: close-current-dialog &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: create-element &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: defmacro-f NAME ARGS &rest BODY
Package

omg

Source

omg.lisp (file)

Macro: defparameter-f NAME VAL
Package

omg

Source

omg.lisp (file)

Macro: defun-f NAME ARGS &rest BODY
Package

omg

Source

omg.lisp (file)

Macro: defun-r NAME ARGS &rest BODY

Define a server-side function and allow to call it from browser side

Package

omg

Source

omg.lisp (file)

Macro: defvar-f NAME VAL
Package

omg

Source

omg.lisp (file)

Macro: disable-back-button &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: disable-scroll &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: element-height &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: element-width &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: enable-back-button &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: enable-scroll &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: execute-after &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: get-dialog-data &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: get-element-id &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: in-debug-session &rest BODY
Package

omg

Source

omg.lisp (file)

Macro: js-get-element-by-id &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jscos &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jsfloor &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jslog &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jsmax &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jsmin &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jsrandom &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: jssin &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: load-js-script &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: make-dialog &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: make-js-function &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: make-js-object &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: make-svg &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: modal-dialog &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: page-height &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: page-width &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: parent-element &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: prevent-page-close &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: register-hash-cb &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: remove-element &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: visible-height &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: visible-left &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: visible-top &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: visible-width &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: with-session SESS &rest BODY

Execute commands inside session sess

Package

omg

Source

omg.lisp (file)


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

5.1.2 Functions

Function: add-to-boot F
Package

omg

Source

omg.lisp (file)

Function: current-session-id ()
Package

omg

Source

omg.lisp (file)

Function: dialog-ok ()
Package

omgui

Source

omgui.lisp (file)

Function: find-session SID

Return session object with specific ID

Package

omg

Source

omg.lisp (file)

Function: kill-server ()
Package

omg

Source

omg.lisp (file)

Function: remote-exec CMD &optional NOWAIT

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.

Package

omg

Source

omg.lisp (file)

Function: restart-server &rest ARGS
Package

omg

Source

omg.lisp (file)

Function: rm-from-boot F
Package

omg

Source

omg.lisp (file)

Function: set-debug-session SID
Package

omg

Source

omg.lisp (file)

Function: start-server &rest ARGS
Package

omg

Source

omg.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: sid-length
Package

omg

Source

omg.lisp (file)


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

5.2.2 Special variables

Special Variable: *backcnt*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *beforeunload-installed*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *boot-functions*
Package

omg

Source

omg.lisp (file)

Special Variable: *current-dialog*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *current-res*
Package

omg

Source

omg.lisp (file)

Special Variable: *current-session*
Package

omg

Source

omg.lisp (file)

Special Variable: *debug-session-id*
Package

omg

Source

omg.lisp (file)

Special Variable: *dialog-stack*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *dialog-wait-list*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *disable-back*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *disable-page-unload*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *exportable-expressions*
Package

omg

Source

omg.lisp (file)

Special Variable: *exported-function-names*
Package

omg

Source

omg.lisp (file)

Special Variable: *fback*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *giant-hash-lock*
Package

omg

Source

omg.lisp (file)

Special Variable: *gimme-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *gimme-wait-list*
Package

omg

Source

omg.lisp (file)

Special Variable: *hash-change-cbs*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *html-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *in-f-macro*
Package

omg

Source

omg.lisp (file)

Special Variable: *in-rpc*
Package

omg

Source

omg.lisp (file)

Special Variable: *js-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *last-args*
Package

omg

Source

omg.lisp (file)

Special Variable: *local-compile*
Package

omg

Source

omg.lisp (file)

Special Variable: *local-lambdas*
Package

omg

Source

omg.lisp (file)

Special Variable: *onpopstate-installed*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *port*
Package

omg

Source

omg.lisp (file)

Special Variable: *root-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *rpc-functions*
Package

omg

Source

omg.lisp (file)

Special Variable: *rpc-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *scroll-disabled*
Package

omgui

Source

omgui.lisp (file)

Special Variable: *serv*
Package

omg

Source

omg.lisp (file)

Special Variable: *session-list*
Package

omg

Source

omg.lisp (file)

Special Variable: *ssl-cert*
Package

omg

Source

omg.lisp (file)

Special Variable: *ssl-key*
Package

omg

Source

omg.lisp (file)

Special Variable: *takit-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *takit-wait-list*
Package

omg

Source

omg.lisp (file)

Special Variable: *use-wss*
Package

omg

Source

omg.lisp (file)

Special Variable: *ws-path*
Package

omg

Source

omg.lisp (file)

Special Variable: *youtube-js-loaded*
Package

omgui

Source

omgui.lisp (file)


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

5.2.3 Macros

Macro: curtain &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: deep-oget-1 &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: defconstant-f NAME VAL
Package

omg

Source

omg.lisp (file)

Macro: dialog-frame &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: dialog-header &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: dialog-table &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: form-button-row &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: form-line &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: js-string-split &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: make-def-macro-f OP

Just a macro to generate macros for f-functions and f-macros definintions (defun-f, defmacro-f, etc...)

Package

omg

Source

omg.lisp (file)

Macro: make-var-macro-f OP

A macro for variables-parameters-constants definitions

Package

omg

Source

omg.lisp (file)

Macro: random-id &rest ARGS
Package

omgui

Source

omgui.lisp (file)

Macro: system-font &rest ARGS
Package

omgui

Source

omgui.lisp (file)


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

5.2.4 Functions

Function: boot-f ()

The boot code, will be executed on the browser-side just after the socket is connected.

Package

omg

Source

omg.lisp (file)

Function: compile-to-js CODE PKG &optional RESKEY

Return JS for the code, pkg is current package for compilation context.
The reskey is the *gimme-wait-list* key, the place to store compilation result.

Package

omg

Source

omg.lisp (file)

Function: dialog-wl-send ID DAT
Package

omgui

Source

omgui.lisp (file)

Function: exec-local-lambda IDARGS
Package

omg

Source

omg.lisp (file)

Function: exec-remote-macro NAME ARGS

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.

Package

omg

Source

omg.lisp (file)

Function: f-eval ARG

Smart-eval – evaluate everything, but expotrable expressions, lambdas and function names

Package

omg

Source

omg.lisp (file)

Function: get-main-js ()

Return the JS code, including JSCL and OMG parts glued.

Package

omg

Source

omg.lisp (file)

Function: get-root-html ()

Return a somple HTML with JS injected.

Package

omg

Source

omg.lisp (file)

Function: get-str-from S LEN
Package

omg

Source

omg.lisp (file)

Function: gethash-lock &rest ARGS
Function: (setf gethash-lock) VAL &rest ARGS
Package

omg

Source

omg.lisp (file)

Function: gimme SYM

The handler for gimme-requests, which are used to request unknown symbols from the server-side.

Package

omg

Source

omg.lisp (file)

Function: has-ssl-p ()
Package

omg

Source

omg.lisp (file)

Function: make-ws ENV

Return the websocket for the new session. Also, creates the session object.

Package

omg

Source

omg.lisp (file)

Function: random-key H &optional LEN

Make a random hash-table key

Package

omg

Source

omg.lisp (file)

Function: random-string LEN

Generate a random stgring of length len

Package

omg

Source

omg.lisp (file)

Function: random-symbol LEN

Make a random symbol

Package

omg

Source

omg.lisp (file)

Function: register-rpc NAME
Package

omg

Source

omg.lisp (file)

Function: remote-unintern SYM

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.

Package

omg

Source

omg.lisp (file)

Function: replace-all STRING PART REPLACEMENT &key TEST

Returns a new string in which all the occurences of the part is replaced with replacement.

Package

omg

Source

omg.lisp (file)

Function: rpc-wrapper OP ARGS PKG

The wrapper for RPC requests, used to allow call browser-side functions from RPC funcs.

Package

omg

Source

omg.lisp (file)

Function: serv ENV
Package

omg

Source

omg.lisp (file)

Function: takit KEY RES

The handler for takit-requests. This requests are used to return macro expansion results from browser-side

Package

omg

Source

omg.lisp (file)

Function: use-wss-p ()
Package

omg

Source

omg.lisp (file)


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

5.2.5 Generic functions

Generic Function: get-id OBJECT
Package

omg

Methods
Method: get-id (OMG-SESSION omg-session)

automatically generated reader method

Source

omg.lisp (file)

Generic Function: wait-list OBJECT
Package

omg

Methods
Method: wait-list (OMG-SESSION omg-session)

automatically generated reader method

Source

omg.lisp (file)


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

5.2.6 Classes

Class: omg-session ()

The session object, holding the session socket, the wait-list holding semaphores and storing result data from remote-exec calls

Package

omg

Source

omg.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: socket
Initargs

:socket

Initform

(error "socket required")

Readers

socket (generic function)

Slot: ses-id
Initform

(omg::random-symbol omg::|sid-length|)

Readers

get-id (generic function)

Slot: wait-list
Initform

(make-hash-table)

Readers

wait-list (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   O   S  
Index Entry  Section

F
File, Lisp, omg.asd: The omg․asd file
File, Lisp, omg/omg.lisp: The omg/omg․lisp file
File, Lisp, omg/omgui.lisp: The omg/omgui․lisp file
File, static, omg/LICENSE: The omg/license file
File, static, omg/README.md: The omg/readme․md file

L
Lisp File, omg.asd: The omg․asd file
Lisp File, omg/omg.lisp: The omg/omg․lisp file
Lisp File, omg/omgui.lisp: The omg/omgui․lisp file

O
omg.asd: The omg․asd file
omg/LICENSE: The omg/license file
omg/omg.lisp: The omg/omg․lisp file
omg/omgui.lisp: The omg/omgui․lisp file
omg/README.md: The omg/readme․md file

S
Static File, omg/LICENSE: The omg/license file
Static File, omg/README.md: The omg/readme․md file

Jump to:   F   L   O   S  

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

A.2 Functions

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

(
(setf gethash-lock): Internal functions

A
add-to-boot: Exported functions
add-youtube-player: Exported macros
allow-page-close: Exported macros
append-element: Exported macros
async-bind: Exported macros

B
boot-f: Internal functions

C
check-element: Exported macros
close-current-dialog: Exported macros
compile-to-js: Internal functions
create-element: Exported macros
current-session-id: Exported functions
curtain: Internal macros

D
deep-oget-1: Internal macros
defconstant-f: Internal macros
defmacro-f: Exported macros
defparameter-f: Exported macros
defun-f: Exported macros
defun-r: Exported macros
defvar-f: Exported macros
dialog-frame: Internal macros
dialog-header: Internal macros
dialog-ok: Exported functions
dialog-table: Internal macros
dialog-wl-send: Internal functions
disable-back-button: Exported macros
disable-scroll: Exported macros

E
element-height: Exported macros
element-width: Exported macros
enable-back-button: Exported macros
enable-scroll: Exported macros
exec-local-lambda: Internal functions
exec-remote-macro: Internal functions
execute-after: Exported macros

F
f-eval: Internal functions
find-session: Exported functions
form-button-row: Internal macros
form-line: Internal macros
Function, (setf gethash-lock): Internal functions
Function, add-to-boot: Exported functions
Function, boot-f: Internal functions
Function, compile-to-js: Internal functions
Function, current-session-id: Exported functions
Function, dialog-ok: Exported functions
Function, dialog-wl-send: Internal functions
Function, exec-local-lambda: Internal functions
Function, exec-remote-macro: Internal functions
Function, f-eval: Internal functions
Function, find-session: Exported functions
Function, get-main-js: Internal functions
Function, get-root-html: Internal functions
Function, get-str-from: Internal functions
Function, gethash-lock: Internal functions
Function, gimme: Internal functions
Function, has-ssl-p: Internal functions
Function, kill-server: Exported functions
Function, make-ws: Internal functions
Function, random-key: Internal functions
Function, random-string: Internal functions
Function, random-symbol: Internal functions
Function, register-rpc: Internal functions
Function, remote-exec: Exported functions
Function, remote-unintern: Internal functions
Function, replace-all: Internal functions
Function, restart-server: Exported functions
Function, rm-from-boot: Exported functions
Function, rpc-wrapper: Internal functions
Function, serv: Internal functions
Function, set-debug-session: Exported functions
Function, start-server: Exported functions
Function, takit: Internal functions
Function, use-wss-p: Internal functions

G
Generic Function, get-id: Internal generic functions
Generic Function, wait-list: Internal generic functions
get-dialog-data: Exported macros
get-element-id: Exported macros
get-id: Internal generic functions
get-id: Internal generic functions
get-main-js: Internal functions
get-root-html: Internal functions
get-str-from: Internal functions
gethash-lock: Internal functions
gimme: Internal functions

H
has-ssl-p: Internal functions

I
in-debug-session: Exported macros

J
js-get-element-by-id: Exported macros
js-string-split: Internal macros
jscos: Exported macros
jsfloor: Exported macros
jslog: Exported macros
jsmax: Exported macros
jsmin: Exported macros
jsrandom: Exported macros
jssin: Exported macros

K
kill-server: Exported functions

L
load-js-script: Exported macros

M
Macro, add-youtube-player: Exported macros
Macro, allow-page-close: Exported macros
Macro, append-element: Exported macros
Macro, async-bind: Exported macros
Macro, check-element: Exported macros
Macro, close-current-dialog: Exported macros
Macro, create-element: Exported macros
Macro, curtain: Internal macros
Macro, deep-oget-1: Internal macros
Macro, defconstant-f: Internal macros
Macro, defmacro-f: Exported macros
Macro, defparameter-f: Exported macros
Macro, defun-f: Exported macros
Macro, defun-r: Exported macros
Macro, defvar-f: Exported macros
Macro, dialog-frame: Internal macros
Macro, dialog-header: Internal macros
Macro, dialog-table: Internal macros
Macro, disable-back-button: Exported macros
Macro, disable-scroll: Exported macros
Macro, element-height: Exported macros
Macro, element-width: Exported macros
Macro, enable-back-button: Exported macros
Macro, enable-scroll: Exported macros
Macro, execute-after: Exported macros
Macro, form-button-row: Internal macros
Macro, form-line: Internal macros
Macro, get-dialog-data: Exported macros
Macro, get-element-id: Exported macros
Macro, in-debug-session: Exported macros
Macro, js-get-element-by-id: Exported macros
Macro, js-string-split: Internal macros
Macro, jscos: Exported macros
Macro, jsfloor: Exported macros
Macro, jslog: Exported macros
Macro, jsmax: Exported macros
Macro, jsmin: Exported macros
Macro, jsrandom: Exported macros
Macro, jssin: Exported macros
Macro, load-js-script: Exported macros
Macro, make-def-macro-f: Internal macros
Macro, make-dialog: Exported macros
Macro, make-js-function: Exported macros
Macro, make-js-object: Exported macros
Macro, make-svg: Exported macros
Macro, make-var-macro-f: Internal macros
Macro, modal-dialog: Exported macros
Macro, page-height: Exported macros
Macro, page-width: Exported macros
Macro, parent-element: Exported macros
Macro, prevent-page-close: Exported macros
Macro, random-id: Internal macros
Macro, register-hash-cb: Exported macros
Macro, remove-element: Exported macros
Macro, system-font: Internal macros
Macro, visible-height: Exported macros
Macro, visible-left: Exported macros
Macro, visible-top: Exported macros
Macro, visible-width: Exported macros
Macro, with-session: Exported macros
make-def-macro-f: Internal macros
make-dialog: Exported macros
make-js-function: Exported macros
make-js-object: Exported macros
make-svg: Exported macros
make-var-macro-f: Internal macros
make-ws: Internal functions
Method, get-id: Internal generic functions
Method, wait-list: Internal generic functions
modal-dialog: Exported macros

P
page-height: Exported macros
page-width: Exported macros
parent-element: Exported macros
prevent-page-close: Exported macros

R
random-id: Internal macros
random-key: Internal functions
random-string: Internal functions
random-symbol: Internal functions
register-hash-cb: Exported macros
register-rpc: Internal functions
remote-exec: Exported functions
remote-unintern: Internal functions
remove-element: Exported macros
replace-all: Internal functions
restart-server: Exported functions
rm-from-boot: Exported functions
rpc-wrapper: Internal functions

S
serv: Internal functions
set-debug-session: Exported functions
start-server: Exported functions
system-font: Internal macros

T
takit: Internal functions

U
use-wss-p: Internal functions

V
visible-height: Exported macros
visible-left: Exported macros
visible-top: Exported macros
visible-width: Exported macros

W
wait-list: Internal generic functions
wait-list: Internal generic functions
with-session: Exported macros

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

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

A.3 Variables

Jump to:   *  
C   S   W  
Index Entry  Section

*
*backcnt*: Internal special variables
*beforeunload-installed*: Internal special variables
*boot-functions*: Internal special variables
*current-dialog*: Internal special variables
*current-res*: Internal special variables
*current-session*: Internal special variables
*debug-session-id*: Internal special variables
*dialog-stack*: Internal special variables
*dialog-wait-list*: Internal special variables
*disable-back*: Internal special variables
*disable-page-unload*: Internal special variables
*exportable-expressions*: Internal special variables
*exported-function-names*: Internal special variables
*fback*: Internal special variables
*giant-hash-lock*: Internal special variables
*gimme-path*: Internal special variables
*gimme-wait-list*: Internal special variables
*hash-change-cbs*: Internal special variables
*html-path*: Internal special variables
*in-f-macro*: Internal special variables
*in-rpc*: Internal special variables
*js-path*: Internal special variables
*last-args*: Internal special variables
*local-compile*: Internal special variables
*local-lambdas*: Internal special variables
*onpopstate-installed*: Internal special variables
*port*: Internal special variables
*root-path*: Internal special variables
*rpc-functions*: Internal special variables
*rpc-path*: Internal special variables
*scroll-disabled*: Internal special variables
*serv*: Internal special variables
*session-list*: Internal special variables
*ssl-cert*: Internal special variables
*ssl-key*: Internal special variables
*takit-path*: Internal special variables
*takit-wait-list*: Internal special variables
*use-wss*: Internal special variables
*ws-path*: Internal special variables
*youtube-js-loaded*: Internal special variables

C
Constant, sid-length: Internal constants

S
ses-id: Internal classes
sid-length: Internal constants
Slot, ses-id: Internal classes
Slot, socket: Internal classes
Slot, wait-list: Internal classes
socket: Internal classes
Special Variable, *backcnt*: Internal special variables
Special Variable, *beforeunload-installed*: Internal special variables
Special Variable, *boot-functions*: Internal special variables
Special Variable, *current-dialog*: Internal special variables
Special Variable, *current-res*: Internal special variables
Special Variable, *current-session*: Internal special variables
Special Variable, *debug-session-id*: Internal special variables
Special Variable, *dialog-stack*: Internal special variables
Special Variable, *dialog-wait-list*: Internal special variables
Special Variable, *disable-back*: Internal special variables
Special Variable, *disable-page-unload*: Internal special variables
Special Variable, *exportable-expressions*: Internal special variables
Special Variable, *exported-function-names*: Internal special variables
Special Variable, *fback*: Internal special variables
Special Variable, *giant-hash-lock*: Internal special variables
Special Variable, *gimme-path*: Internal special variables
Special Variable, *gimme-wait-list*: Internal special variables
Special Variable, *hash-change-cbs*: Internal special variables
Special Variable, *html-path*: Internal special variables
Special Variable, *in-f-macro*: Internal special variables
Special Variable, *in-rpc*: Internal special variables
Special Variable, *js-path*: Internal special variables
Special Variable, *last-args*: Internal special variables
Special Variable, *local-compile*: Internal special variables
Special Variable, *local-lambdas*: Internal special variables
Special Variable, *onpopstate-installed*: Internal special variables
Special Variable, *port*: Internal special variables
Special Variable, *root-path*: Internal special variables
Special Variable, *rpc-functions*: Internal special variables
Special Variable, *rpc-path*: Internal special variables
Special Variable, *scroll-disabled*: Internal special variables
Special Variable, *serv*: Internal special variables
Special Variable, *session-list*: Internal special variables
Special Variable, *ssl-cert*: Internal special variables
Special Variable, *ssl-key*: Internal special variables
Special Variable, *takit-path*: Internal special variables
Special Variable, *takit-wait-list*: Internal special variables
Special Variable, *use-wss*: Internal special variables
Special Variable, *ws-path*: Internal special variables
Special Variable, *youtube-js-loaded*: Internal special variables

W
wait-list: Internal classes

Jump to:   *  
C   S   W  

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

A.4 Data types

Jump to:   C   O   P   S  
Index Entry  Section

C
Class, omg-session: Internal classes

O
omg: The omg system
omg: The omg package
omg-session: Internal classes
omgui: The omgui package

P
Package, omg: The omg package
Package, omgui: The omgui package

S
System, omg: The omg system

Jump to:   C   O   P   S