The xembed Reference Manual

Table of Contents

The xembed Reference Manual

This is the xembed Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:41:18 2021 GMT+0.

1 Systems

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

1.1 xembed

Author

Alessandro Piras

License

MIT

Description

An implementation of the XEMBED protocol that integrates with CLX.

Version

0.1.0

Dependency

clx

Source

xembed.asd (file)

Components

• package.lisp (file)
• utils (module)
• xembed-core.lisp (file)
• socket.lisp (file)

2 Modules

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

2.1 xembed/utils

Dependency

package.lisp (file)

Parent

xembed (system)

Location

utils/

Components

• debug.lisp (file)
• utils.lisp (file)
• xlib-utils.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 xembed.asd

Location

xembed.asd

Systems

xembed (system)

3.1.2 xembed/package.lisp

Parent

xembed (system)

Location

package.lisp

Packages

• xembed-user
• xembed

3.1.3 xembed/utils/debug.lisp

Parent

utils (module)

Location

utils/debug.lisp

Exported Definitions

• dformat (function)
• rformat (function)

Internal Definitions

• *debug-level* (special variable)
• *debug-stream* (special variable)
• *progress-stream* (special variable)
• *result-stream* (special variable)
• *show-progress* (special variable)
• dformat-call (function)
• format-call (function)
• format-in-or-out (function)
• pformat (function)
• with-result-stream (macro)

3.1.4 xembed/utils/utils.lisp

Dependency

debug.lisp (file)

Parent

utils (module)

Location

utils/utils.lisp

Exported Definitions

• curry (function)
• move-next-to (function)

Internal Definitions

• combine-functions (function)
• compose (function)
• flatten (function)
• get-keyword-value (function)
• getflag (function)
• group-by-2 (function)
• maybe (function)
• move-next-to-helper (function)
• nullfn (function)
• sequencep (function)
• setflag (function)
• setflags (function)
• subst-keyword-value (function)
• xor (function)

3.1.5 xembed/utils/xlib-utils.lisp

Dependency

utils.lisp (file)

Parent

utils (module)

Location

utils/xlib-utils.lisp

Exported Definitions

• combine-handlers (function)
• handler-pos (function)
• handler-vector (macro)
• window-parent (function)
• window-resize (function)

Internal Definitions

• +last-event+ (special variable)
• handlers (special variable)
• is-toplevel (function)

3.1.6 xembed/xembed-core.lisp

Dependency

utils (module)

Parent

xembed (system)

Location

xembed-core.lisp

Exported Definitions

• *timestamp* (special variable)
• decode-xembed-message-type (function)
• update-timestamp (function)

Internal Definitions

• +currenttime+ (special variable)
• +xembed-detail-alist+ (special variable)
• +xembed-info-flags-alist+ (special variable)
• +xembed-message-alist+ (special variable)
• +xembed-modifier-alist+ (special variable)
• +xembed-version+ (special variable)
• +xembed_accelerator_overloaded+ (special variable)
• +xembed_direction_default+ (special variable)
• +xembed_direction_left_right+ (special variable)
• +xembed_direction_up_down+ (special variable)
• +xembed_result_ok+ (special variable)
• +xembed_result_unsupported+ (special variable)
• +xembed_result_x11error+ (special variable)
• decode-flags (function)
• decode-xembed-detail (function)
• decode-xembed-info-flags (function)
• decode-xembed-modifier-flags (function)
• delete-create-notify-event (function)
• encode-flags (function)
• encode-xembed-detail (function)
• encode-xembed-info-flags (function)
• encode-xembed-message-type (function)
• encode-xembed-modifier-flags (function)
• get-server-time (function)
• send-wrapper (macro)
• set-property-notify (function)
• supported-protocol-version (function)
• xembed-focus-in (function)
• xembed-info (function)
• (setf xembed-info) (function)
• xembed-info-flags (function)
• (setf xembed-info-flags) (function)
• xembed-info-flags-raw (function)
• xembed-info-raw (function)
• (setf xembed-info-raw) (function)
• xembed-info-ready-p (function)
• xembed-info-valid-p (function)
• xembed-info-version (function)
• (setf xembed-info-version) (function)
• xembed-info-version-raw (function)
• xembed-notify (function)
• xembed-send (function)

3.1.7 xembed/socket.lisp

Dependency

xembed-core.lisp (file)

Parent

xembed (system)

Location

socket.lisp

Exported Definitions

• client (function)
• create-socket (function)
• destroy-socket (function)
• embed (function)
• socket-activate (function)
• socket-list-handler-vector (function)
• socket-resize (function)

Internal Definitions

• +socket-event-mask+ (special variable)
• +xembed-socket-info-flags-alist+ (special variable)
• drop-configure-notify (function)
• forward-xembed-message-up (function)
• maybe-start-protocol (function)
• requested-state (function)
• satisfy-map/unmap-request (function)
• send-and-set-flag (macro)
• socket-clear-focus-request (function)
• socket-deactivate (function)
• socket-focus-in (function)
• socket-focus-out (function)
• socket-focus-requested-p (function)
• socket-handler-vector (function)
• socket-modality-off (function)
• socket-modality-on (function)
• socket-reset (function)
• socket-reset-geometry (function)
• socketp (function)
• xembed-socket-info (function)
• (setf xembed-socket-info) (function)
• xsi-flags (function)
• xsi-getflag (function)
• xsi-setflags (function)

4 Packages

Packages are listed by definition order.

4.1 xembed-user

Source

package.lisp (file)

Use List

• xembed
• xlib
• asdf/interface
• common-lisp

4.2 xembed

Source

package.lisp (file)

Use List

• xlib
• asdf/interface
• common-lisp

Used By List

xembed-user

Exported Definitions

• *timestamp* (special variable)
• client (function)
• combine-handlers (function)
• create-socket (function)
• curry (function)
• decode-xembed-message-type (function)
• destroy-socket (function)
• dformat (function)
• embed (function)
• handler-pos (function)
• handler-vector (macro)
• move-next-to (function)
• rformat (function)
• socket-activate (function)
• socket-list-handler-vector (function)
• socket-resize (function)
• update-timestamp (function)
• window-parent (function)
• window-resize (function)

Internal Definitions

• *debug-level* (special variable)
• *debug-stream* (special variable)
• *progress-stream* (special variable)
• *result-stream* (special variable)
• *show-progress* (special variable)
• +currenttime+ (special variable)
• +last-event+ (special variable)
• +socket-event-mask+ (special variable)
• +xembed-detail-alist+ (special variable)
• +xembed-info-flags-alist+ (special variable)
• +xembed-message-alist+ (special variable)
• +xembed-modifier-alist+ (special variable)
• +xembed-socket-info-flags-alist+ (special variable)
• +xembed-version+ (special variable)
• +xembed_accelerator_overloaded+ (special variable)
• +xembed_direction_default+ (special variable)
• +xembed_direction_left_right+ (special variable)
• +xembed_direction_up_down+ (special variable)
• +xembed_result_ok+ (special variable)
• +xembed_result_unsupported+ (special variable)
• +xembed_result_x11error+ (special variable)
• combine-functions (function)
• compose (function)
• decode-flags (function)
• decode-xembed-detail (function)
• decode-xembed-info-flags (function)
• decode-xembed-modifier-flags (function)
• delete-create-notify-event (function)
• dformat-call (function)
• drop-configure-notify (function)
• encode-flags (function)
• encode-xembed-detail (function)
• encode-xembed-info-flags (function)
• encode-xembed-message-type (function)
• encode-xembed-modifier-flags (function)
• flatten (function)
• format-call (function)
• format-in-or-out (function)
• forward-xembed-message-up (function)
• get-keyword-value (function)
• get-server-time (function)
• getflag (function)
• group-by-2 (function)
• handlers (special variable)
• is-toplevel (function)
• maybe (function)
• maybe-start-protocol (function)
• move-next-to-helper (function)
• nullfn (function)
• pformat (function)
• requested-state (function)
• satisfy-map/unmap-request (function)
• send-and-set-flag (macro)
• send-wrapper (macro)
• sequencep (function)
• set-property-notify (function)
• setflag (function)
• setflags (function)
• socket-clear-focus-request (function)
• socket-deactivate (function)
• socket-focus-in (function)
• socket-focus-out (function)
• socket-focus-requested-p (function)
• socket-handler-vector (function)
• socket-modality-off (function)
• socket-modality-on (function)
• socket-reset (function)
• socket-reset-geometry (function)
• socketp (function)
• subst-keyword-value (function)
• supported-protocol-version (function)
• with-result-stream (macro)
• xembed-focus-in (function)
• xembed-info (function)
• (setf xembed-info) (function)
• xembed-info-flags (function)
• (setf xembed-info-flags) (function)
• xembed-info-flags-raw (function)
• xembed-info-raw (function)
• (setf xembed-info-raw) (function)
• xembed-info-ready-p (function)
• xembed-info-valid-p (function)
• xembed-info-version (function)
• (setf xembed-info-version) (function)
• xembed-info-version-raw (function)
• xembed-notify (function)
• xembed-send (function)
• xembed-socket-info (function)
• (setf xembed-socket-info) (function)
• xor (function)
• xsi-flags (function)
• xsi-getflag (function)
• xsi-setflags (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *timestamp*

Package

xembed

Source

xembed-core.lisp (file)

5.1.2 Macros

Macro: handler-vector &rest CLAUSES

Package

xembed

Source

xlib-utils.lisp (file)

5.1.3 Functions

Function: client WIN

Package

xembed

Source

socket.lisp (file)

Function: combine-handlers H1 H2

Package

xembed

Source

xlib-utils.lisp (file)

Function: create-socket USE-CLIENT-GEOMETRY &rest KEY-VALUE-PAIRS &key &allow-other-keys

Package

xembed

Source

socket.lisp (file)

Function: curry FUNCTION &rest ARGS

Package

xembed

Source

utils.lisp (file)

Function: decode-xembed-message-type TYPE

Package

xembed

Source

xembed-core.lisp (file)

Function: destroy-socket SOCKETWIN &optional REPARENT-P

Package

xembed

Source

socket.lisp (file)

Function: dformat LEVEL CONTROL-STRING &rest FORMAT-ARGUMENTS

Package

xembed

Source

debug.lisp (file)

Function: embed SOCKETWIN CLIENTWIN &optional REPARENT-P X Y RESET-GEOMETRY-P

Package

xembed

Source

socket.lisp (file)

Function: handler-pos EVENT-KEY

Package

xembed

Source

xlib-utils.lisp (file)

Function: move-next-to EL NEXT-TO SEQ &key WHERE TEST

Package

xembed

Source

utils.lisp (file)

Function: rformat CONTROL-STRING &rest FORMAT-ARGUMENTS

Package

xembed

Source

debug.lisp (file)

Function: socket-activate SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-list-handler-vector SOCKETLIST-FN

Package

xembed

Source

socket.lisp (file)

Function: socket-resize SOCKETWIN W H

Package

xembed

Source

socket.lisp (file)

Function: update-timestamp WIN &optional TIMESTAMP

Package

xembed

Source

xembed-core.lisp (file)

Function: window-parent WIN

Package

xembed

Source

xlib-utils.lisp (file)

Function: window-resize WINDOW WIDTH HEIGHT

Package

xembed

Source

xlib-utils.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *debug-level*

Package

xembed

Source

debug.lisp (file)

Special Variable: *debug-stream*

Package

xembed

Source

debug.lisp (file)

Special Variable: *progress-stream*

Package

xembed

Source

debug.lisp (file)

Special Variable: *result-stream*

Package

xembed

Source

debug.lisp (file)

Special Variable: *show-progress*

Package

xembed

Source

debug.lisp (file)

Special Variable: +currenttime+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +last-event+

Package

xembed

Source

xlib-utils.lisp (file)

Special Variable: +socket-event-mask+

Package

xembed

Source

socket.lisp (file)

Special Variable: +xembed-detail-alist+

Package

xembed

Source

xembed-core.lisp (file)

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

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed-message-alist+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed-modifier-alist+

Package

xembed

Source

xembed-core.lisp (file)

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

Package

xembed

Source

socket.lisp (file)

Special Variable: +xembed-version+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_accelerator_overloaded+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_direction_default+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_direction_left_right+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_direction_up_down+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_result_ok+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_result_unsupported+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: +xembed_result_x11error+

Package

xembed

Source

xembed-core.lisp (file)

Special Variable: handlers

Package

xembed

Source

xlib-utils.lisp (file)

5.2.2 Macros

Macro: send-and-set-flag SOCKETWIN FLAG-KEY FLAG-VALUE &body SEND-FORM

Package

xembed

Source

socket.lisp (file)

Macro: send-wrapper DISP (&body SEND-SEQUENCE) &body ERROR-HANDLERS

Package

xembed

Source

xembed-core.lisp (file)

Macro: with-result-stream (FNAME &rest KEY-VALUE-PAIRS &key &allow-other-keys) &body BODY

Package

xembed

Source

debug.lisp (file)

5.2.3 Functions

Function: combine-functions HF1 HF2

Package

xembed

Source

utils.lisp (file)

Function: compose FN1 FN2

Package

xembed

Source

utils.lisp (file)

Function: decode-flags FLAGS FLAGS-ALIST

Package

xembed

Source

xembed-core.lisp (file)

Function: decode-xembed-detail DETAIL

Package

xembed

Source

xembed-core.lisp (file)

Function: decode-xembed-info-flags FLAGS

Package

xembed

Source

xembed-core.lisp (file)

Function: decode-xembed-modifier-flags FLAGS

Package

xembed

Source

xembed-core.lisp (file)

Function: delete-create-notify-event WIN

Package

xembed

Source

xembed-core.lisp (file)

Function: dformat-call LEVEL FN IN-OR-OUT &rest ARGUMENTS

Package

xembed

Source

debug.lisp (file)

Function: drop-configure-notify SOCKETWIN W H

Package

xembed

Source

socket.lisp (file)

Function: encode-flags FLAGS FLAGS-ALIST

Package

xembed

Source

xembed-core.lisp (file)

Function: encode-xembed-detail DETAIL

Package

xembed

Source

xembed-core.lisp (file)

Function: encode-xembed-info-flags FLAGS

Package

xembed

Source

xembed-core.lisp (file)

Function: encode-xembed-message-type TYPE

Package

xembed

Source

xembed-core.lisp (file)

Function: encode-xembed-modifier-flags FLAGS

Package

xembed

Source

xembed-core.lisp (file)

Function: flatten LIST

Package

xembed

Source

utils.lisp (file)

Function: format-call FN IN-OR-OUT &rest ARGUMENTS

Package

xembed

Source

debug.lisp (file)

Function: format-in-or-out IN-OR-OUT

Package

xembed

Source

debug.lisp (file)

Function: forward-xembed-message-up SOCKETWIN TIMESTAMP OPCODE DETAIL DATA1 DATA2

Package

xembed

Source

socket.lisp (file)

Function: get-keyword-value KEY LIST

Package

xembed

Source

utils.lisp (file)

Function: get-server-time WIN

Package

xembed

Source

xembed-core.lisp (file)

Function: getflag KEY FLAGS KEY-ALIST

Package

xembed

Source

utils.lisp (file)

Function: group-by-2 LIST

Package

xembed

Source

utils.lisp (file)

Function: is-toplevel WIN

Package

xembed

Source

xlib-utils.lisp (file)

Function: maybe PRED

Package

xembed

Source

utils.lisp (file)

Function: maybe-start-protocol SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: move-next-to-helper EL NEXT-TO SEQ &key WHERE TEST

Package

xembed

Source

utils.lisp (file)

Function: nullfn &rest ARGS

Package

xembed

Source

utils.lisp (file)

Function: pformat CONTROL-STRING &rest FORMAT-ARGUMENTS

Package

xembed

Source

debug.lisp (file)

Function: requested-state WIN

Package

xembed

Source

socket.lisp (file)

Function: satisfy-map/unmap-request SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: sequencep OBJECT

Package

xembed

Source

utils.lisp (file)

Function: set-property-notify WINDOW

Package

xembed

Source

xembed-core.lisp (file)

Function: setflag FLAGS KEY-ALIST KEY VALUE

Package

xembed

Source

utils.lisp (file)

Function: setflags FLAGS KEY-ALIST &rest KEY-VALUE-PAIRS &key &allow-other-keys

Package

xembed

Source

utils.lisp (file)

Function: socket-clear-focus-request SOCKETWIN &optional VALUE

Package

xembed

Source

socket.lisp (file)

Function: socket-deactivate SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-focus-in SOCKETWIN &optional WHAT

Package

xembed

Source

socket.lisp (file)

Function: socket-focus-out SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-focus-requested-p SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-handler-vector SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-modality-off SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-modality-on SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-reset SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socket-reset-geometry SOCKETWIN

Package

xembed

Source

socket.lisp (file)

Function: socketp WINDOW

Package

xembed

Source

socket.lisp (file)

Function: subst-keyword-value KEY VALUE LIST

Package

xembed

Source

utils.lisp (file)

Function: supported-protocol-version WIN

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-focus-in CLIENT-WINDOW DETAIL

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info WINDOW

Function: (setf xembed-info) NEW-VAL WINDOW

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-flags XEMBED-INFO

Function: (setf xembed-info-flags) NEW-VAL WINDOW

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-flags-raw XEMBED-INFO

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-raw WINDOW

Function: (setf xembed-info-raw) NEW-VAL WINDOW

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-ready-p WINDOW

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-valid-p XEMBED-INFO

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-version XEMBED-INFO

Function: (setf xembed-info-version) NEW-VAL WINDOW

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-info-version-raw XEMBED-INFO

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-notify CLIENT-WINDOW EMBEDDER-WINDOW &optional VERSION

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-send DEST-WIN &key OPCODE DETAIL DATA1 DATA2 TIMESTAMP

Package

xembed

Source

xembed-core.lisp (file)

Function: xembed-socket-info WINDOW

Function: (setf xembed-socket-info) VALUE WINDOW

Package

xembed

Source

socket.lisp (file)

Function: xor X Y

Package

xembed

Source

utils.lisp (file)

Function: xsi-flags XSI

Package

xembed

Source

socket.lisp (file)

Function: xsi-getflag XSI KEY

Package

xembed

Source

socket.lisp (file)

Function: xsi-setflags XSI &rest KEYWORD-VALUE-PAIRS &key &allow-other-keys

Package

xembed

Source

socket.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types