The xembed Reference Manual

This is the xembed Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:51:44 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 xembed

An implementation of the XEMBED protocol that integrates with CLX.

Author

Alessandro Piras

License

MIT

Version

0.1.0

Dependency

clx (system).

Source

xembed.asd.

Child Components

2 Modules

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


2.1 xembed/utils

Dependency

package.lisp (file).

Source

xembed.asd.

Parent Component

xembed (system).

Child Components

3 Files

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


3.1 Lisp


3.1.1 xembed/xembed.asd

Source

xembed.asd.

Parent Component

xembed (system).

ASDF Systems

xembed.


3.1.2 xembed/package.lisp

Source

xembed.asd.

Parent Component

xembed (system).

Packages

3.1.3 xembed/utils/debug.lisp

Source

xembed.asd.

Parent Component

utils (module).

Public Interface
Internals

3.1.4 xembed/utils/utils.lisp

Dependency

debug.lisp (file).

Source

xembed.asd.

Parent Component

utils (module).

Public Interface
Internals

3.1.5 xembed/utils/xlib-utils.lisp

Dependency

utils.lisp (file).

Source

xembed.asd.

Parent Component

utils (module).

Public Interface
Internals

3.1.6 xembed/xembed-core.lisp

Dependency

utils (module).

Source

xembed.asd.

Parent Component

xembed (system).

Public Interface
Internals

3.1.7 xembed/socket.lisp

Dependency

xembed-core.lisp (file).

Source

xembed.asd.

Parent Component

xembed (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 xembed

Source

package.lisp.

Use List
  • asdf/interface.
  • common-lisp.
  • xlib.
Used By List

xembed-user.

Public Interface
Internals

4.2 xembed-user

Source

package.lisp.

Use List
  • asdf/interface.
  • common-lisp.
  • xembed.
  • xlib.

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *timestamp*
Package

xembed.

Source

xembed-core.lisp.


5.1.2 Macros

Macro: handler-vector (&rest clauses)
Package

xembed.

Source

xlib-utils.lisp.


5.1.3 Ordinary functions

Function: client (win)
Package

xembed.

Source

socket.lisp.

Function: combine-handlers (h1 h2)
Package

xembed.

Source

xlib-utils.lisp.

Function: create-socket (use-client-geometry &rest key-value-pairs &key &allow-other-keys)
Package

xembed.

Source

socket.lisp.

Function: curry (function &rest args)
Package

xembed.

Source

utils.lisp.

Function: decode-xembed-message-type (type)
Package

xembed.

Source

xembed-core.lisp.

Function: destroy-socket (socketwin &optional reparent-p)
Package

xembed.

Source

socket.lisp.

Function: dformat (level control-string &rest format-arguments)
Package

xembed.

Source

debug.lisp.

Function: embed (socketwin clientwin &optional reparent-p x y reset-geometry-p)
Package

xembed.

Source

socket.lisp.

Function: handler-pos (event-key)
Package

xembed.

Source

xlib-utils.lisp.

Function: move-next-to (el next-to seq &key where test)
Package

xembed.

Source

utils.lisp.

Function: rformat (control-string &rest format-arguments)
Package

xembed.

Source

debug.lisp.

Function: socket-activate (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-list-handler-vector (socketlist-fn)
Package

xembed.

Source

socket.lisp.

Function: socket-resize (socketwin w h)
Package

xembed.

Source

socket.lisp.

Function: update-timestamp (win &optional timestamp)
Package

xembed.

Source

xembed-core.lisp.

Function: window-parent (win)
Package

xembed.

Source

xlib-utils.lisp.

Function: window-resize (window width height)
Package

xembed.

Source

xlib-utils.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *debug-level*
Package

xembed.

Source

debug.lisp.

Special Variable: *debug-stream*
Package

xembed.

Source

debug.lisp.

Special Variable: *progress-stream*
Package

xembed.

Source

debug.lisp.

Special Variable: *result-stream*
Package

xembed.

Source

debug.lisp.

Special Variable: *show-progress*
Package

xembed.

Source

debug.lisp.

Special Variable: +currenttime+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +last-event+
Package

xembed.

Source

xlib-utils.lisp.

Special Variable: +socket-event-mask+
Package

xembed.

Source

socket.lisp.

Special Variable: +xembed-detail-alist+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed-info-flags-alist+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed-message-alist+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed-modifier-alist+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed-socket-info-flags-alist+
Package

xembed.

Source

socket.lisp.

Special Variable: +xembed-version+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_accelerator_overloaded+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_direction_default+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_direction_left_right+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_direction_up_down+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_result_ok+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_result_unsupported+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: +xembed_result_x11error+
Package

xembed.

Source

xembed-core.lisp.

Special Variable: handlers
Package

xembed.

Source

xlib-utils.lisp.


5.2.2 Macros

Macro: send-and-set-flag (socketwin flag-key flag-value &body send-form)
Package

xembed.

Source

socket.lisp.

Macro: send-wrapper (disp (&body send-sequence) &body error-handlers)
Package

xembed.

Source

xembed-core.lisp.

Macro: with-result-stream ((fname &rest key-value-pairs &key &allow-other-keys) &body body)
Package

xembed.

Source

debug.lisp.


5.2.3 Ordinary functions

Function: combine-functions (hf1 hf2)
Package

xembed.

Source

utils.lisp.

Function: compose (fn1 fn2)
Package

xembed.

Source

utils.lisp.

Function: decode-flags (flags flags-alist)
Package

xembed.

Source

xembed-core.lisp.

Function: decode-xembed-detail (detail)
Package

xembed.

Source

xembed-core.lisp.

Function: decode-xembed-info-flags (flags)
Package

xembed.

Source

xembed-core.lisp.

Function: decode-xembed-modifier-flags (flags)
Package

xembed.

Source

xembed-core.lisp.

Function: delete-create-notify-event (win)
Package

xembed.

Source

xembed-core.lisp.

Function: dformat-call (level fn in-or-out &rest arguments)
Package

xembed.

Source

debug.lisp.

Function: drop-configure-notify (socketwin w h)
Package

xembed.

Source

socket.lisp.

Function: encode-flags (flags flags-alist)
Package

xembed.

Source

xembed-core.lisp.

Function: encode-xembed-detail (detail)
Package

xembed.

Source

xembed-core.lisp.

Function: encode-xembed-info-flags (flags)
Package

xembed.

Source

xembed-core.lisp.

Function: encode-xembed-message-type (type)
Package

xembed.

Source

xembed-core.lisp.

Function: encode-xembed-modifier-flags (flags)
Package

xembed.

Source

xembed-core.lisp.

Function: flatten (list)
Package

xembed.

Source

utils.lisp.

Function: format-call (fn in-or-out &rest arguments)
Package

xembed.

Source

debug.lisp.

Function: format-in-or-out (in-or-out)
Package

xembed.

Source

debug.lisp.

Function: forward-xembed-message-up (socketwin timestamp opcode detail data1 data2)
Package

xembed.

Source

socket.lisp.

Function: get-keyword-value (key list)
Package

xembed.

Source

utils.lisp.

Function: get-server-time (win)
Package

xembed.

Source

xembed-core.lisp.

Function: getflag (key flags key-alist)
Package

xembed.

Source

utils.lisp.

Function: group-by-2 (list)
Package

xembed.

Source

utils.lisp.

Function: is-toplevel (win)
Package

xembed.

Source

xlib-utils.lisp.

Function: maybe (pred)
Package

xembed.

Source

utils.lisp.

Function: maybe-start-protocol (socketwin)
Package

xembed.

Source

socket.lisp.

Function: move-next-to-helper (el next-to seq &key where test)
Package

xembed.

Source

utils.lisp.

Function: nullfn (&rest args)
Package

xembed.

Source

utils.lisp.

Function: pformat (control-string &rest format-arguments)
Package

xembed.

Source

debug.lisp.

Function: requested-state (win)
Package

xembed.

Source

socket.lisp.

Function: satisfy-map/unmap-request (socketwin)
Package

xembed.

Source

socket.lisp.

Function: sequencep (object)
Package

xembed.

Source

utils.lisp.

Function: set-property-notify (window)
Package

xembed.

Source

xembed-core.lisp.

Function: setflag (flags key-alist key value)
Package

xembed.

Source

utils.lisp.

Function: setflags (flags key-alist &rest key-value-pairs &key &allow-other-keys)
Package

xembed.

Source

utils.lisp.

Function: socket-clear-focus-request (socketwin &optional value)
Package

xembed.

Source

socket.lisp.

Function: socket-deactivate (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-focus-in (socketwin &optional what)
Package

xembed.

Source

socket.lisp.

Function: socket-focus-out (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-focus-requested-p (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-handler-vector (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-modality-off (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-modality-on (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-reset (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socket-reset-geometry (socketwin)
Package

xembed.

Source

socket.lisp.

Function: socketp (window)
Package

xembed.

Source

socket.lisp.

Function: subst-keyword-value (key value list)
Package

xembed.

Source

utils.lisp.

Function: supported-protocol-version (win)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-focus-in (client-window detail)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info (window)
Package

xembed.

Source

xembed-core.lisp.

Function: (setf xembed-info) (window)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-flags (xembed-info)
Package

xembed.

Source

xembed-core.lisp.

Function: (setf xembed-info-flags) (window)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-flags-raw (xembed-info)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-raw (window)
Package

xembed.

Source

xembed-core.lisp.

Function: (setf xembed-info-raw) (window)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-ready-p (window)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-valid-p (xembed-info)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-version (xembed-info)
Package

xembed.

Source

xembed-core.lisp.

Function: (setf xembed-info-version) (window)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-info-version-raw (xembed-info)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-notify (client-window embedder-window &optional version)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-send (dest-win &key opcode detail data1 data2 timestamp)
Package

xembed.

Source

xembed-core.lisp.

Function: xembed-socket-info (window)
Package

xembed.

Source

socket.lisp.

Function: (setf xembed-socket-info) (window)
Package

xembed.

Source

socket.lisp.

Function: xor (x y)
Package

xembed.

Source

utils.lisp.

Function: xsi-flags (xsi)
Package

xembed.

Source

socket.lisp.

Function: xsi-getflag (xsi key)
Package

xembed.

Source

socket.lisp.

Function: xsi-setflags (xsi &rest keyword-value-pairs &key &allow-other-keys)
Package

xembed.

Source

socket.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   E   F   G   H   I   M   N   P   R   S   U   W   X  
Index Entry  Section

(
(setf xembed-info): Private ordinary functions
(setf xembed-info-flags): Private ordinary functions
(setf xembed-info-raw): Private ordinary functions
(setf xembed-info-version): Private ordinary functions
(setf xembed-socket-info): Private ordinary functions

C
client: Public ordinary functions
combine-functions: Private ordinary functions
combine-handlers: Public ordinary functions
compose: Private ordinary functions
create-socket: Public ordinary functions
curry: Public ordinary functions

D
decode-flags: Private ordinary functions
decode-xembed-detail: Private ordinary functions
decode-xembed-info-flags: Private ordinary functions
decode-xembed-message-type: Public ordinary functions
decode-xembed-modifier-flags: Private ordinary functions
delete-create-notify-event: Private ordinary functions
destroy-socket: Public ordinary functions
dformat: Public ordinary functions
dformat-call: Private ordinary functions
drop-configure-notify: Private ordinary functions

E
embed: Public ordinary functions
encode-flags: Private ordinary functions
encode-xembed-detail: Private ordinary functions
encode-xembed-info-flags: Private ordinary functions
encode-xembed-message-type: Private ordinary functions
encode-xembed-modifier-flags: Private ordinary functions

F
flatten: Private ordinary functions
format-call: Private ordinary functions
format-in-or-out: Private ordinary functions
forward-xembed-message-up: Private ordinary functions
Function, (setf xembed-info): Private ordinary functions
Function, (setf xembed-info-flags): Private ordinary functions
Function, (setf xembed-info-raw): Private ordinary functions
Function, (setf xembed-info-version): Private ordinary functions
Function, (setf xembed-socket-info): Private ordinary functions
Function, client: Public ordinary functions
Function, combine-functions: Private ordinary functions
Function, combine-handlers: Public ordinary functions
Function, compose: Private ordinary functions
Function, create-socket: Public ordinary functions
Function, curry: Public ordinary functions
Function, decode-flags: Private ordinary functions
Function, decode-xembed-detail: Private ordinary functions
Function, decode-xembed-info-flags: Private ordinary functions
Function, decode-xembed-message-type: Public ordinary functions
Function, decode-xembed-modifier-flags: Private ordinary functions
Function, delete-create-notify-event: Private ordinary functions
Function, destroy-socket: Public ordinary functions
Function, dformat: Public ordinary functions
Function, dformat-call: Private ordinary functions
Function, drop-configure-notify: Private ordinary functions
Function, embed: Public ordinary functions
Function, encode-flags: Private ordinary functions
Function, encode-xembed-detail: Private ordinary functions
Function, encode-xembed-info-flags: Private ordinary functions
Function, encode-xembed-message-type: Private ordinary functions
Function, encode-xembed-modifier-flags: Private ordinary functions
Function, flatten: Private ordinary functions
Function, format-call: Private ordinary functions
Function, format-in-or-out: Private ordinary functions
Function, forward-xembed-message-up: Private ordinary functions
Function, get-keyword-value: Private ordinary functions
Function, get-server-time: Private ordinary functions
Function, getflag: Private ordinary functions
Function, group-by-2: Private ordinary functions
Function, handler-pos: Public ordinary functions
Function, is-toplevel: Private ordinary functions
Function, maybe: Private ordinary functions
Function, maybe-start-protocol: Private ordinary functions
Function, move-next-to: Public ordinary functions
Function, move-next-to-helper: Private ordinary functions
Function, nullfn: Private ordinary functions
Function, pformat: Private ordinary functions
Function, requested-state: Private ordinary functions
Function, rformat: Public ordinary functions
Function, satisfy-map/unmap-request: Private ordinary functions
Function, sequencep: Private ordinary functions
Function, set-property-notify: Private ordinary functions
Function, setflag: Private ordinary functions
Function, setflags: Private ordinary functions
Function, socket-activate: Public ordinary functions
Function, socket-clear-focus-request: Private ordinary functions
Function, socket-deactivate: Private ordinary functions
Function, socket-focus-in: Private ordinary functions
Function, socket-focus-out: Private ordinary functions
Function, socket-focus-requested-p: Private ordinary functions
Function, socket-handler-vector: Private ordinary functions
Function, socket-list-handler-vector: Public ordinary functions
Function, socket-modality-off: Private ordinary functions
Function, socket-modality-on: Private ordinary functions
Function, socket-reset: Private ordinary functions
Function, socket-reset-geometry: Private ordinary functions
Function, socket-resize: Public ordinary functions
Function, socketp: Private ordinary functions
Function, subst-keyword-value: Private ordinary functions
Function, supported-protocol-version: Private ordinary functions
Function, update-timestamp: Public ordinary functions
Function, window-parent: Public ordinary functions
Function, window-resize: Public ordinary functions
Function, xembed-focus-in: Private ordinary functions
Function, xembed-info: Private ordinary functions
Function, xembed-info-flags: Private ordinary functions
Function, xembed-info-flags-raw: Private ordinary functions
Function, xembed-info-raw: Private ordinary functions
Function, xembed-info-ready-p: Private ordinary functions
Function, xembed-info-valid-p: Private ordinary functions
Function, xembed-info-version: Private ordinary functions
Function, xembed-info-version-raw: Private ordinary functions
Function, xembed-notify: Private ordinary functions
Function, xembed-send: Private ordinary functions
Function, xembed-socket-info: Private ordinary functions
Function, xor: Private ordinary functions
Function, xsi-flags: Private ordinary functions
Function, xsi-getflag: Private ordinary functions
Function, xsi-setflags: Private ordinary functions

G
get-keyword-value: Private ordinary functions
get-server-time: Private ordinary functions
getflag: Private ordinary functions
group-by-2: Private ordinary functions

H
handler-pos: Public ordinary functions
handler-vector: Public macros

I
is-toplevel: Private ordinary functions

M
Macro, handler-vector: Public macros
Macro, send-and-set-flag: Private macros
Macro, send-wrapper: Private macros
Macro, with-result-stream: Private macros
maybe: Private ordinary functions
maybe-start-protocol: Private ordinary functions
move-next-to: Public ordinary functions
move-next-to-helper: Private ordinary functions

N
nullfn: Private ordinary functions

P
pformat: Private ordinary functions

R
requested-state: Private ordinary functions
rformat: Public ordinary functions

S
satisfy-map/unmap-request: Private ordinary functions
send-and-set-flag: Private macros
send-wrapper: Private macros
sequencep: Private ordinary functions
set-property-notify: Private ordinary functions
setflag: Private ordinary functions
setflags: Private ordinary functions
socket-activate: Public ordinary functions
socket-clear-focus-request: Private ordinary functions
socket-deactivate: Private ordinary functions
socket-focus-in: Private ordinary functions
socket-focus-out: Private ordinary functions
socket-focus-requested-p: Private ordinary functions
socket-handler-vector: Private ordinary functions
socket-list-handler-vector: Public ordinary functions
socket-modality-off: Private ordinary functions
socket-modality-on: Private ordinary functions
socket-reset: Private ordinary functions
socket-reset-geometry: Private ordinary functions
socket-resize: Public ordinary functions
socketp: Private ordinary functions
subst-keyword-value: Private ordinary functions
supported-protocol-version: Private ordinary functions

U
update-timestamp: Public ordinary functions

W
window-parent: Public ordinary functions
window-resize: Public ordinary functions
with-result-stream: Private macros

X
xembed-focus-in: Private ordinary functions
xembed-info: Private ordinary functions
xembed-info-flags: Private ordinary functions
xembed-info-flags-raw: Private ordinary functions
xembed-info-raw: Private ordinary functions
xembed-info-ready-p: Private ordinary functions
xembed-info-valid-p: Private ordinary functions
xembed-info-version: Private ordinary functions
xembed-info-version-raw: Private ordinary functions
xembed-notify: Private ordinary functions
xembed-send: Private ordinary functions
xembed-socket-info: Private ordinary functions
xor: Private ordinary functions
xsi-flags: Private ordinary functions
xsi-getflag: Private ordinary functions
xsi-setflags: Private ordinary functions


A.3 Variables

Jump to:   *   +  
H   S  
Index Entry  Section

*
*debug-level*: Private special variables
*debug-stream*: Private special variables
*progress-stream*: Private special variables
*result-stream*: Private special variables
*show-progress*: Private special variables
*timestamp*: Public special variables

+
+currenttime+: Private special variables
+last-event+: Private special variables
+socket-event-mask+: Private special variables
+xembed-detail-alist+: Private special variables
+xembed-info-flags-alist+: Private special variables
+xembed-message-alist+: Private special variables
+xembed-modifier-alist+: Private special variables
+xembed-socket-info-flags-alist+: Private special variables
+xembed-version+: Private special variables
+xembed_accelerator_overloaded+: Private special variables
+xembed_direction_default+: Private special variables
+xembed_direction_left_right+: Private special variables
+xembed_direction_up_down+: Private special variables
+xembed_result_ok+: Private special variables
+xembed_result_unsupported+: Private special variables
+xembed_result_x11error+: Private special variables

H
handlers: Private special variables

S
Special Variable, *debug-level*: Private special variables
Special Variable, *debug-stream*: Private special variables
Special Variable, *progress-stream*: Private special variables
Special Variable, *result-stream*: Private special variables
Special Variable, *show-progress*: Private special variables
Special Variable, *timestamp*: Public special variables
Special Variable, +currenttime+: Private special variables
Special Variable, +last-event+: Private special variables
Special Variable, +socket-event-mask+: Private special variables
Special Variable, +xembed-detail-alist+: Private special variables
Special Variable, +xembed-info-flags-alist+: Private special variables
Special Variable, +xembed-message-alist+: Private special variables
Special Variable, +xembed-modifier-alist+: Private special variables
Special Variable, +xembed-socket-info-flags-alist+: Private special variables
Special Variable, +xembed-version+: Private special variables
Special Variable, +xembed_accelerator_overloaded+: Private special variables
Special Variable, +xembed_direction_default+: Private special variables
Special Variable, +xembed_direction_left_right+: Private special variables
Special Variable, +xembed_direction_up_down+: Private special variables
Special Variable, +xembed_result_ok+: Private special variables
Special Variable, +xembed_result_unsupported+: Private special variables
Special Variable, +xembed_result_x11error+: Private special variables
Special Variable, handlers: Private special variables