From a538bc01a157d622ca2915400c9abd99998743f1 Mon Sep 17 00:00:00 2001 From: "Peter S. Housel" Date: Thu, 18 Jul 2024 21:42:55 -0700 Subject: [PATCH] SNAPSNAP: documentation: New API document for environment-protocols --- .../environment/environment-protocols.rst | 6204 +++++++++++++++++ .../source/hacker-guide/environment/index.rst | 10 + documentation/source/hacker-guide/index.rst | 1 + 3 files changed, 6215 insertions(+) create mode 100644 documentation/source/hacker-guide/environment/environment-protocols.rst create mode 100644 documentation/source/hacker-guide/environment/index.rst diff --git a/documentation/source/hacker-guide/environment/environment-protocols.rst b/documentation/source/hacker-guide/environment/environment-protocols.rst new file mode 100644 index 000000000..fbeb90174 --- /dev/null +++ b/documentation/source/hacker-guide/environment/environment-protocols.rst @@ -0,0 +1,6204 @@ +********************************* +The ENVIRONMENT-PROTOCOLS library +********************************* + +.. current-library:: environment-protocols + + +The ENVIRONMENT-PROTOCOLS module +******************************** + +.. current-module:: environment-protocols + +Server Objects +============== + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required object: An instance of :class:``. + :keyword required project: An instance of :class:``. + +.. generic-function:: condition-project + + :signature: condition-project (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: condition-object + + :signature: condition-object (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: record-client-query + :open: + + :signature: record-client-query (server client object type) => () + + :parameter server: An instance of :class:``. + :parameter client: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter type: An instance of :const:``. + +.. method:: record-client-query + :specializer: , , , + +.. method:: record-client-query + :specializer: , , , + +.. method:: record-client-query + :specializer: , , , + +.. generic-function:: server-project + :open: + + :signature: server-project (server) => (project) + + :parameter server: An instance of :class:``. + :value project: An instance of :class:``. + +.. method:: server-project + :specializer: + +.. method:: server-project + :specializer: + +.. method:: server-project + :specializer: + +Identifiers +=========== + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required library: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required module: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required generic-function: An instance of :class:``. + :keyword required specializers: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required filename: An instance of :class:``. + :keyword required line-number: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required library: An instance of :class:``. + +.. generic-function:: id-filename + + :signature: id-filename (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: id-generic-function + + :signature: id-generic-function (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: id-library + + :signature: id-library (object) => (id) + + :parameter object: An instance of :class:``. + :value id: An instance of :class:``. + +.. method:: id-library + :specializer: + +.. method:: id-library + :specializer: + +.. generic-function:: id-line-number + + :signature: id-line-number (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: id-module + + :signature: id-module (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: id-name + + :signature: id-name (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: id-specializers + + :signature: id-specializers (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +Environment Objects +=================== + +.. class:: + :open: + :abstract: + :primary: + + :superclasses: :class:`` + + :keyword library: An instance of :drm:``. + :keyword name: An instance of :class:``, or ``#f``. + +.. class:: + :open: + :abstract: + :primary: + + :superclasses: :class:`` + + :keyword required id: An instance of :class:``, or ``#f``. + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required library: An instance of :class:``. + +.. generic-function:: note-object-properties-changed + :open: + + :signature: note-object-properties-changed (client object type) => () + + :parameter client: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter type: An instance of :const:``. + +.. method:: note-object-properties-changed + :specializer: , , + +.. generic-function:: environment-object-id + :open: + + :signature: environment-object-id (server object) => (id) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value id: An instance of :class:``, or ``#f``. + +.. method:: environment-object-id + :specializer: , + +.. method:: environment-object-id + :specializer: , + +.. generic-function:: environment-object-exists? + :open: + + :signature: environment-object-exists? (server object) => (exists?) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value exists?: An instance of :class:``. + +.. method:: environment-object-exists? + :specializer: , + +.. method:: environment-object-exists? + :specializer: , + +.. method:: environment-object-exists? + :specializer: , + +.. method:: environment-object-exists? + :specializer: , + +.. generic-function:: environment-object-primitive-name + :open: + + :signature: environment-object-primitive-name (server object) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: environment-object-primitive-name + :specializer: , + +.. method:: environment-object-primitive-name + :specializer: , + +.. method:: environment-object-primitive-name + :specializer: , + +.. method:: environment-object-primitive-name + :specializer: , + +.. generic-function:: get-environment-object-primitive-name + :open: + + :signature: get-environment-object-primitive-name (server object) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: get-environment-object-primitive-name + :specializer: , + +.. method:: get-environment-object-primitive-name + :specializer: , + +.. method:: get-environment-object-primitive-name + :specializer: , + +.. method:: get-environment-object-primitive-name + :specializer: , + +.. method:: get-environment-object-primitive-name + :specializer: , + +.. method:: get-environment-object-primitive-name + :specializer: , + +.. generic-function:: environment-object-basic-name + :open: + + :signature: environment-object-basic-name (server object #key #all-keys) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. method:: environment-object-basic-name + :specializer: , + +.. generic-function:: environment-object-display-name + :open: + + :signature: environment-object-display-name (server object namespace #key #all-keys) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter namespace: An instance of :class:``, or ``#f``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: environment-object-display-name + :specializer: , , false-or() + +.. generic-function:: environment-object-unique-name + :open: + + :signature: environment-object-unique-name (server object namespace #key #all-keys) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter namespace: An instance of :class:``, or ``#f``. + :value name: An instance of :class:``. + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. method:: environment-object-unique-name + :specializer: , , false-or() + +.. generic-function:: environment-object-type + :open: + + :signature: environment-object-type (server object) => (type) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value type: An instance of :class:``, or ``#f``. + +.. method:: environment-object-type + :specializer: , + +.. method:: environment-object-type + :specializer: , + +.. method:: environment-object-type + :specializer: , + +.. method:: environment-object-type + :specializer: , + +.. generic-function:: environment-object-type-name + :open: + + :signature: environment-object-type-name (object) => (type-name) + + :parameter object: An instance of :class:``. + :value type-name: An instance of :class:``. + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. method:: environment-object-type-name + :specializer: + +.. generic-function:: environment-object-source + :open: + + :signature: environment-object-source (server object) => (source) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value source: An instance of :class:``, or ``#f``. + +.. method:: environment-object-source + :specializer: , + +.. method:: environment-object-source + :specializer: , + +.. method:: environment-object-source + :specializer: , + +.. generic-function:: environment-object-source-location + :open: + + :signature: environment-object-source-location (server object) => (location) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value location: An instance of :class:``, or ``#f``. + +.. method:: environment-object-source-location + :specializer: , + +.. method:: environment-object-source-location + :specializer: , + +.. method:: environment-object-source-location + :specializer: , + +.. method:: environment-object-source-location + :specializer: , + +.. method:: environment-object-source-location + :specializer: , + +.. generic-function:: environment-object-home-server? + + :signature: environment-object-home-server? (project object) => (home?) + + :parameter project: An instance of :class:``. + :parameter object: An instance of :class:``. + :value home?: An instance of :class:``. + +.. method:: environment-object-home-server? + :specializer: , + +.. method:: environment-object-home-server? + :specializer: , + +.. method:: environment-object-home-server? + :specializer: , + +.. method:: environment-object-home-server? + :specializer: , + +.. method:: environment-object-home-server? + :specializer: , + +.. generic-function:: environment-object-home-name + :open: + + :signature: environment-object-home-name (server object) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: environment-object-home-name + :specializer: , + +.. method:: environment-object-home-name + :specializer: , + +.. method:: environment-object-home-name + :specializer: , + +.. method:: environment-object-home-name + :specializer: , + +.. generic-function:: environment-object-name + :open: + + :signature: environment-object-name (server object namespace) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter namespace: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: environment-object-name + :specializer: , , + +.. method:: environment-object-name + :specializer: , , + +.. method:: environment-object-name + :specializer: , , + +.. method:: environment-object-name + :specializer: , , + +.. generic-function:: environment-object-library + :open: + + :signature: environment-object-library (server object) => (library) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value library: An instance of :class:``, or ``#f``. + +.. method:: environment-object-library + :specializer: , + +.. method:: environment-object-library + :specializer: , + +.. method:: environment-object-library + :specializer: , + +.. method:: environment-object-library + :specializer: , + +.. method:: environment-object-library + :specializer: , + +.. generic-function:: find-environment-object + :open: + + :signature: find-environment-object (server name #key #all-keys) => (object) + + :parameter server: An instance of :class:``. + :parameter name: An instance of ``type-union(, )``. + :value object: An instance of :class:``, or ``#f``. + +.. method:: find-environment-object + :specializer: , + +.. method:: find-environment-object + :specializer: , + +.. method:: find-environment-object + :specializer: , + +.. method:: find-environment-object + :specializer: , + +.. method:: find-environment-object + :specializer: , + +.. generic-function:: make-environment-object + + :signature: make-environment-object (class #key project library id application-object-proxy compiler-object-proxy) => (object) + + :parameter class: An instance of ``subclass()``. + :parameter #key project: An instance of :class:``. + :parameter #key library: An instance of :class:``, or ``#f``. + :parameter #key id: An instance of :class:``, or ``#f``. + :parameter #key application-object-proxy: An instance of :class:``. + :parameter #key compiler-object-proxy: An instance of :class:``. + :value object: An instance of :class:``. + +.. method:: make-environment-object + :specializer: subclass() + +.. method:: make-environment-object + :specializer: subclass() + +.. method:: make-environment-object + :specializer: subclass() + +.. generic-function:: parse-environment-object-name + + :signature: parse-environment-object-name (name #key module library #all-keys) => (id) + + :parameter name: An instance of :class:``. + :parameter #key module: An instance of :class:``, or ``#f``. + :parameter #key library: An instance of :class:``, or ``#f``. + :value id: An instance of :class:``, or ``#f``. + +.. generic-function:: parse-module-name + + :signature: parse-module-name (name #key library) => (id) + + :parameter name: An instance of :class:``. + :parameter #key library: An instance of :class:``, or ``#f``. + :value id: An instance of :class:``, or ``#f``. + +.. generic-function:: print-environment-object + :open: + + :signature: print-environment-object (stream server object #key #all-keys) => () + + :parameter stream: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + +.. method:: print-environment-object + :specializer: , , + +.. generic-function:: print-environment-object-to-string + + :signature: print-environment-object-to-string (server object #rest args #key namespace #all-keys) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #rest args: An instance of :class:``. + :parameter #key namespace: An instance of :class:``. + :value name: An instance of :class:``. + +.. generic-function:: print-environment-object-name + :open: + + :signature: print-environment-object-name (stream server object #key #all-keys) => () + + :parameter stream: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. method:: print-environment-object-name + :specializer: , , + +.. generic-function:: print-environment-object-name-to-string + + :signature: print-environment-object-name-to-string (server object #rest args #key namespace #all-keys) => (name) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #rest args: An instance of :class:``. + :parameter #key namespace: An instance of :class:``. + :value name: An instance of :class:``. + +.. generic-function:: source-location-environment-object + :open: + + :signature: source-location-environment-object (server location) => (object) + + :parameter server: An instance of :class:``. + :parameter location: An instance of :class:``. + :value object: An instance of :class:``, or ``#f``. + +.. method:: source-location-environment-object + :specializer: , + +.. method:: source-location-environment-object + :specializer: , + +Environment Options +=================== + +.. class:: + + :superclasses: :class:`` + +Compiler Objects +================ + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword required compiler-object-proxy: An instance of :class:``. + +.. generic-function:: compiler-object-proxy + + :signature: compiler-object-proxy (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: invalidate-compiler-proxy + :open: + + :signature: invalidate-compiler-proxy (server object) => () + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + +.. method:: invalidate-compiler-proxy + :specializer: , + +Application Objects +=================== + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword application-object-proxy: An instance of :class:``. + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. generic-function:: application-object-class + :open: + + :signature: application-object-class (server object) => (class) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value class: An instance of :class:``, or ``#f``. + +.. method:: application-object-class + :specializer: , + +.. method:: application-object-class + :specializer: , + +.. generic-function:: application-object-proxy + + :signature: application-object-proxy (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-object-proxy-setter + + :signature: application-object-proxy-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-object-address + :open: + + :signature: application-object-address (server object) => (address) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value address: An instance of :class:``, or ``#f``. + +.. method:: application-object-address + :specializer: , + +.. generic-function:: invalidate-application-proxy + :open: + + :signature: invalidate-application-proxy (server object) => () + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + +.. method:: invalidate-application-proxy + :specializer: , + +Unbound Objects +=============== + +.. class:: + + :superclasses: :class:`` + + +.. constant:: $unbound-object + +Address Objects +=============== + +.. constant:: + +.. constant:: + +.. constant:: + +.. class:: + + :superclasses: :class:`` + + +.. constant:: $invalid-address-object + +.. generic-function:: address-application-object + :open: + + :signature: address-application-object (server addr) => (obj) + + :parameter server: An instance of :class:``. + :parameter addr: An instance of :class:``. + :value obj: An instance of :class:``. + +.. method:: address-application-object + :specializer: , + +.. generic-function:: address-to-string + :open: + + :signature: address-to-string (server address #key format) => (s) + + :parameter server: An instance of :class:``. + :parameter address: An instance of :class:``. + :parameter #key format: An instance of :const:``. + :value s: An instance of :class:``. + +.. method:: address-to-string + :specializer: , + +.. generic-function:: string-to-address + :open: + + :signature: string-to-address (server str #key format) => (addr) + + :parameter server: An instance of :class:``. + :parameter str: An instance of :class:``. + :parameter #key format: An instance of :const:``. + :value addr: An instance of :class:``. + +.. method:: string-to-address + :specializer: , + +.. generic-function:: indirect-address + :open: + + :signature: indirect-address (server addr) => (i-addr) + + :parameter server: An instance of :class:``. + :parameter addr: An instance of :class:``. + :value i-addr: An instance of :class:``. + +.. method:: indirect-address + :specializer: , + +.. generic-function:: indexed-address + :open: + + :signature: indexed-address (server addr i #key size) => (i-addr) + + :parameter server: An instance of :class:``. + :parameter addr: An instance of :class:``. + :parameter i: An instance of :class:``. + :parameter #key size: An instance of :const:``. + :value i-addr: An instance of :class:``. + +.. method:: indexed-address + :specializer: , , + +.. generic-function:: address-read-memory-contents + :open: + + :signature: address-read-memory-contents (server addr #key size format from-index to-index) => (printable-strings nxt) + + :parameter server: An instance of :class:``. + :parameter addr: An instance of :class:``. + :parameter #key size: An instance of :const:``. + :parameter #key format: An instance of :const:``. + :parameter #key from-index: An instance of :class:``. + :parameter #key to-index: An instance of :class:``. + :value printable-strings: An instance of :class:``. + :value nxt: An instance of :class:``. + +.. method:: address-read-memory-contents + :specializer: , + +.. generic-function:: address-read-application-object + :open: + + :signature: address-read-application-object (server addr) => (obj) + + :parameter server: An instance of :class:``. + :parameter addr: An instance of :class:``. + :value obj: An instance of :class:``, or ``#f``. + +.. method:: address-read-application-object + :specializer: , + +Register Objects +================ + +.. constant:: + +.. class:: + + :superclasses: :class:`` + + +.. function:: application-registers + + :signature: application-registers (server #key category) => (classes) + + :parameter server: An instance of :class:``. + :parameter #key category: An instance of :class:``. + :value classes: An instance of :class:``. + +.. generic-function:: do-application-registers + :open: + + :signature: do-application-registers (f server #key category) => () + + :parameter f: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter #key category: An instance of :class:``. + +.. method:: do-application-registers + :specializer: , + +.. generic-function:: register-contents + :open: + + :signature: register-contents (server reg thread #key stack-frame-context) => (obj) + + :parameter server: An instance of :class:``. + :parameter reg: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key stack-frame-context: An instance of :class:``. + :value obj: An instance of :class:``, or ``#f``. + +.. method:: register-contents + :specializer: , , + +.. generic-function:: register-contents-address + :open: + + :signature: register-contents-address (server reg thread #key stack-frame-context) => (obj) + + :parameter server: An instance of :class:``. + :parameter reg: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key stack-frame-context: An instance of :class:``. + :value obj: An instance of :class:``, or ``#f``. + +.. method:: register-contents-address + :specializer: , , + +.. generic-function:: lookup-register-by-name + :open: + + :signature: lookup-register-by-name (server name) => (reg) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value reg: An instance of :class:``, or ``#f``. + +.. method:: lookup-register-by-name + :specializer: , + +Component Objects +================= + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: component-image-filename + :open: + + :signature: component-image-filename (server component) => (file) + + :parameter server: An instance of :class:``. + :parameter component: An instance of :class:``. + :value file: An instance of :class:``, or ``#f``. + +.. method:: component-image-filename + :specializer: , + +.. generic-function:: component-version + :open: + + :signature: component-version (server component) => (major-version-index minor-version-index) + + :parameter server: An instance of :class:``. + :parameter component: An instance of :class:``. + :value major-version-index: An instance of :class:``. + :value minor-version-index: An instance of :class:``. + +.. method:: component-version + :specializer: , + +.. function:: component-version-string + + :signature: component-version-string (server component) => (version-string) + + :parameter server: An instance of :class:``. + :parameter component: An instance of :class:``. + :value version-string: An instance of :class:``. + +.. function:: application-components + + :signature: application-components (server) => (components) + + :parameter server: An instance of :class:``. + :value components: An instance of :class:``. + +.. generic-function:: do-application-components + :open: + + :signature: do-application-components (f server) => () + + :parameter f: An instance of :class:``. + :parameter server: An instance of :class:``. + +.. method:: do-application-components + :specializer: , + +Application and Compiler Objects +================================ + +.. class:: + :open: + :abstract: + + :superclasses: :class:``, :class:`` + +Composite Objects +================= + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. generic-function:: composite-object-size + :open: + + :signature: composite-object-size (server object #key inherited?) => (size) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key inherited?: An instance of :class:``. + :value size: An instance of :class:``, or ``#f``. + +.. method:: composite-object-size + :specializer: , + +.. generic-function:: composite-object-contents + :open: + + :signature: composite-object-contents (server object #key inherited?) => (names values) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key inherited?: An instance of :class:``. + :value names: An instance of :class:``. + :value values: An instance of :class:``. + +.. method:: composite-object-contents + :specializer: , + +User Objects +============ + +.. class:: + + :superclasses: :class:``, :class:`` + + +.. generic-function:: user-object-slot-value + :open: + + :signature: user-object-slot-value (server obj slot #key repeated-element) => (value) + + :parameter server: An instance of :class:``. + :parameter obj: An instance of :class:``. + :parameter slot: An instance of ``type-union(, )``. + :parameter #key repeated-element: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. method:: user-object-slot-value + :specializer: , , + +.. method:: user-object-slot-value + :specializer: , , + +.. generic-function:: user-object-slot-values + :open: + + :signature: user-object-slot-values (server object) => (functions values) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value functions: An instance of :class:``. + :value values: An instance of :class:``. + +.. method:: user-object-slot-values + :specializer: , + +User Class Info +=============== + +.. class:: + + :superclasses: :class:`` + + :keyword required class: An instance of :class:``. + :keyword required id: An instance of :class:``. + +.. generic-function:: user-class-info-class + + :signature: user-class-info-class (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: user-class-info-id + + :signature: user-class-info-id (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. function:: user-object-class-mappings + + :signature: user-object-class-mappings () => (mappings) + + :value mappings: An instance of :class:``. + +Internal Objects +================ + +.. class:: + + :superclasses: :class:`` + +Foreign Objects +=============== + +.. class:: + + :superclasses: :class:`` + +Dylan Objects +============= + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + +.. class:: + :open: + :abstract: + + :superclasses: :class:``, :class:`` + + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + +.. class:: + :open: + :abstract: + + :superclasses: :class:``, :class:`` + + +.. constant:: $dylan-library-id + +.. constant:: $dylan-module-id + +.. constant:: $dylan-extensions-module-id + +.. constant:: $dispatch-engine-module-id + +.. constant:: $-id + +.. constant:: $-id + +.. constant:: $-id + +.. constant:: $-id + +Dylan Expression Objects +======================== + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + +.. class:: + :open: + + :superclasses: :class:`` + + +.. class:: + :open: + + :superclasses: :class:`` + +Dylan Application Objects +========================= + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: number-object-to-string + :open: + + :signature: number-object-to-string (server number #key prefix? format) => (string) + + :parameter server: An instance of :class:``. + :parameter number: An instance of :class:``. + :parameter #key prefix?: An instance of :class:``. + :parameter #key format: An instance of :class:``, or ``#f``. + :value string: An instance of :class:``, or ``#f``. + +.. method:: number-object-to-string + :specializer: , + +Boolean Objects +=============== + +.. class:: + + :superclasses: :class:`` + + :keyword required true?: An instance of :class:``. + +.. generic-function:: boolean-object-true? + + :signature: boolean-object-true? (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. constant:: $true-object + +.. constant:: $false-object + +Collection Objects +================== + +.. class:: + + :superclasses: :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: collection-size + :open: + + :signature: collection-size (server collection) => (size) + + :parameter server: An instance of :class:``. + :parameter collection: An instance of :class:``. + :value size: An instance of :class:``, or ``#f``. + +.. method:: collection-size + :specializer: , + +.. generic-function:: collection-keys + :open: + + :signature: collection-keys (server collection #key range) => (keys) + + :parameter server: An instance of :class:``. + :parameter collection: An instance of :class:``. + :parameter #key range: An instance of :class:``. + :value keys: An instance of :class:``, or ``#f``. + +.. method:: collection-keys + :specializer: , + +.. generic-function:: collection-elements + :open: + + :signature: collection-elements (server collection #key range) => (elements) + + :parameter server: An instance of :class:``. + :parameter collection: An instance of :class:``. + :parameter #key range: An instance of :class:``. + :value elements: An instance of :class:``, or ``#f``. + +.. method:: collection-elements + :specializer: , + +.. generic-function:: do-collection-keys + :open: + + :signature: do-collection-keys (function server collection) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter collection: An instance of :class:``. + +.. method:: do-collection-keys + :specializer: , , + +.. generic-function:: do-collection-elements + :open: + + :signature: do-collection-elements (function server collection) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter collection: An instance of :class:``. + +.. method:: do-collection-elements + :specializer: , , + +.. generic-function:: range-start + :open: + + :signature: range-start (server range) => (_start) + + :parameter server: An instance of :class:``. + :parameter range: An instance of :class:``. + :value _start: An instance of :class:``, or ``#f``. + +.. method:: range-start + :specializer: , + +.. generic-function:: range-end + :open: + + :signature: range-end (server range) => (_end) + + :parameter server: An instance of :class:``. + :parameter range: An instance of :class:``. + :value _end: An instance of :class:``, or ``#f``. + +.. method:: range-end + :specializer: , + +.. generic-function:: range-by + :open: + + :signature: range-by (server range) => (by) + + :parameter server: An instance of :class:``. + :parameter range: An instance of :class:``. + :value by: An instance of :class:``, or ``#f``. + +.. method:: range-by + :specializer: , + +.. generic-function:: pair-head + :open: + + :signature: pair-head (server pair) => (head) + + :parameter server: An instance of :class:``. + :parameter pair: An instance of :class:``. + :value head: An instance of :class:``, or ``#f``. + +.. method:: pair-head + :specializer: , + +.. generic-function:: pair-tail + :open: + + :signature: pair-tail (server pair) => (head) + + :parameter server: An instance of :class:``. + :parameter pair: An instance of :class:``. + :value head: An instance of :class:``, or ``#f``. + +.. method:: pair-tail + :specializer: , + +Source Forms +============ + +.. class:: + :open: + :abstract: + + :superclasses: :class:``, :class:``, :class:`` + + +.. generic-function:: do-used-definitions + :open: + + :signature: do-used-definitions (function server object #key modules libraries client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key modules: An instance of :class:``. + :parameter #key libraries: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-used-definitions + :specializer: , , + +.. generic-function:: do-client-source-forms + :open: + + :signature: do-client-source-forms (function server object #key modules libraries client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key modules: An instance of :class:``. + :parameter #key libraries: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-client-source-forms + :specializer: , , + +.. generic-function:: source-form-has-clients? + :open: + + :signature: source-form-has-clients? (server object #key modules libraries client) => (has-clients?) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key modules: An instance of :class:``. + :parameter #key libraries: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value has-clients?: An instance of :class:``. + +.. method:: source-form-has-clients? + :specializer: , + +.. generic-function:: source-form-uses-definitions? + :open: + + :signature: source-form-uses-definitions? (server object #key modules libraries client) => (uses-definitions?) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key modules: An instance of :class:``. + :parameter #key libraries: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value uses-definitions?: An instance of :class:``. + +.. method:: source-form-uses-definitions? + :specializer: , + +.. function:: source-form-used-definitions + + :signature: source-form-used-definitions (server source-form #key libraries modules client) => (used-definitions) + + :parameter server: An instance of :class:``. + :parameter source-form: An instance of :class:``. + :parameter #key libraries: An instance of :class:``. + :parameter #key modules: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value used-definitions: An instance of :class:``. + +.. function:: source-form-clients + + :signature: source-form-clients (server source-form #key libraries modules client) => (clients) + + :parameter server: An instance of :class:``. + :parameter source-form: An instance of :class:``. + :parameter #key libraries: An instance of :class:``. + :parameter #key modules: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value clients: An instance of :class:``. + +Macro Calls +=========== + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. generic-function:: do-macro-call-source-forms + :open: + + :signature: do-macro-call-source-forms (function server object) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + +.. method:: do-macro-call-source-forms + :specializer: , , + +.. function:: macro-call-source-forms + + :signature: macro-call-source-forms (server source-form) => (source-forms) + + :parameter server: An instance of :class:``. + :parameter source-form: An instance of :class:``. + :value source-forms: An instance of :class:``. + +Non-definition Source Forms +=========================== + +.. class:: + + :superclasses: :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +Definition Objects +================== + +.. class:: + :open: + :abstract: + + :superclasses: :class:``, :class:``, :class:`` + + +.. generic-function:: definition-modifiers + :open: + + :signature: definition-modifiers (server object) => (modifiers) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value modifiers: An instance of :class:``. + +.. method:: definition-modifiers + :specializer: , + +.. generic-function:: definition-interactive-locations + :open: + + :signature: definition-interactive-locations (server object) => (locations) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value locations: An instance of :class:``. + +.. method:: definition-interactive-locations + :specializer: , + +.. generic-function:: definition-known-locations + :open: + + :signature: definition-known-locations (server object) => (locations) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value locations: An instance of :class:``. + +.. method:: definition-known-locations + :specializer: , + +.. function:: find-named-definition + + :signature: find-named-definition (project module name #key imported?) => (definition) + + :parameter project: An instance of :class:``. + :parameter module: An instance of :class:``. + :parameter name: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :value definition: An instance of :class:``, or ``#f``. + +Breakpoints +=========== + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword enabled?: An instance of :class:``. + :keyword library: An instance of :class:``, or ``#f``. + :keyword message?: An instance of :class:``, or ``#f``. + :keyword object: An instance of :class:``. + :keyword profile?: An instance of :class:``. + :keyword required project: An instance of :class:``. + :keyword stop?: An instance of :class:``. + :keyword test: An instance of :class:``. + :keyword transient?: An instance of :class:``. + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword directions: An instance of :class:``. + :keyword entry-function?: An instance of :class:``. + :keyword entry-point?: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. constant:: + +.. constant:: + +.. constant:: $default-breakpoint-stop? + +.. constant:: $default-breakpoint-message? + +.. constant:: $default-breakpoint-transient? + +.. constant:: $default-breakpoint-enabled? + +.. constant:: $default-breakpoint-profile? + +.. constant:: $default-breakpoint-test + +.. constant:: $default-breakpoint-entry-function? + +.. constant:: $default-breakpoint-directions + +.. generic-function:: destroy-breakpoint + :open: + + :signature: destroy-breakpoint (breakpoint) => () + + :parameter breakpoint: An instance of :class:``. + +.. method:: destroy-breakpoint + :specializer: + +.. method:: destroy-breakpoint + :specializer: + +.. method:: destroy-breakpoint + :specializer: + +.. method:: destroy-breakpoint + :specializer: + +.. method:: destroy-breakpoint + :specializer: + +.. generic-function:: initialize-breakpoint + :open: + + :signature: initialize-breakpoint (breakpoint #key #all-keys) => () + + :parameter breakpoint: An instance of :class:``. + +.. method:: initialize-breakpoint + :specializer: + +.. method:: initialize-breakpoint + :specializer: + +.. method:: initialize-breakpoint + :specializer: + +.. method:: initialize-breakpoint + :specializer: + +.. generic-function:: reinitialize-breakpoint + :open: + + :signature: reinitialize-breakpoint (breakpoint #rest args #key #all-keys) => () + + :parameter breakpoint: An instance of :class:``. + :parameter #rest args: An instance of :class:``. + +.. method:: reinitialize-breakpoint + :specializer: + +.. method:: reinitialize-breakpoint + :specializer: + +.. method:: reinitialize-breakpoint + :specializer: + +.. generic-function:: do-generic-breakpoint-methods + :open: + + :signature: do-generic-breakpoint-methods (operation breakpoint) => () + + :parameter operation: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + +.. method:: do-generic-breakpoint-methods + :specializer: , + +.. generic-function:: current-stop-breakpoints + :open: + + :signature: current-stop-breakpoints (server thread) => (breakpoints) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value breakpoints: An instance of :class:``. + +.. method:: current-stop-breakpoints + :specializer: , + +.. generic-function:: find-breakpoint + :open: + + :signature: find-breakpoint (class #rest args #key #all-keys) => (breakpoint) + + :parameter class: An instance of ``subclass()``. + :parameter #rest args: An instance of :class:``. + :value breakpoint: An instance of :class:``, or ``#f``. + +.. method:: find-breakpoint + :specializer: singleton() + +.. method:: find-breakpoint + :specializer: subclass() + +.. method:: find-breakpoint + :specializer: subclass() + +.. generic-function:: project-breakpoints + :open: + + :signature: project-breakpoints (project) => (breakpoints) + + :parameter project: An instance of :class:``. + :value breakpoints: An instance of :class:``. + +.. method:: project-breakpoints + :specializer: + +.. generic-function:: source-location-breakpoints + :open: + + :signature: source-location-breakpoints (project) => (breakpoints) + + :parameter project: An instance of :class:``. + :value breakpoints: An instance of :class:``. + +.. method:: source-location-breakpoints + :specializer: + +.. generic-function:: environment-object-breakpoints + :open: + + :signature: environment-object-breakpoints (project) => (breakpoints) + + :parameter project: An instance of :class:``. + :value breakpoints: An instance of :class:``. + +.. method:: environment-object-breakpoints + :specializer: + +.. generic-function:: breakpoint-object + :open: + + :signature: breakpoint-object (breakpoint) => (object) + + :parameter breakpoint: An instance of :class:``. + :value object: An instance of :class:``. + +.. method:: breakpoint-object + :specializer: + +.. generic-function:: breakpoint-object-setter + :open: + + :signature: breakpoint-object-setter (object breakpoint) => (object) + + :parameter object: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value object: An instance of :class:``. + +.. method:: breakpoint-object-setter + :specializer: , + +.. generic-function:: breakpoint-project + :open: + + :signature: breakpoint-project (breakpoint) => (project) + + :parameter breakpoint: An instance of :class:``. + :value project: An instance of :class:``. + +.. method:: breakpoint-project + :specializer: + +.. generic-function:: breakpoint-stop? + :open: + + :signature: breakpoint-stop? (breakpoint) => (stop?) + + :parameter breakpoint: An instance of :class:``. + :value stop?: An instance of :class:``. + +.. method:: breakpoint-stop? + :specializer: + +.. generic-function:: breakpoint-stop?-setter + :open: + + :signature: breakpoint-stop?-setter (stop? breakpoint) => (stop?) + + :parameter stop?: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value stop?: An instance of :class:``. + +.. method:: breakpoint-stop?-setter + :specializer: , + +.. method:: breakpoint-stop?-setter + :specializer: , + +.. generic-function:: breakpoint-message? + :open: + + :signature: breakpoint-message? (breakpoint) => (message?) + + :parameter breakpoint: An instance of :class:``. + :value message?: An instance of :class:``, or ``#f``. + +.. method:: breakpoint-message? + :specializer: + +.. generic-function:: breakpoint-message?-setter + :open: + + :signature: breakpoint-message?-setter (message? breakpoint) => (message?) + + :parameter message?: An instance of :class:``, or ``#f``. + :parameter breakpoint: An instance of :class:``. + :value message?: An instance of :class:``, or ``#f``. + +.. method:: breakpoint-message?-setter + :specializer: false-or(), + +.. method:: breakpoint-message?-setter + :specializer: false-or(), + +.. generic-function:: breakpoint-transient? + :open: + + :signature: breakpoint-transient? (breakpoint) => (transient?) + + :parameter breakpoint: An instance of :class:``. + :value transient?: An instance of :class:``. + +.. method:: breakpoint-transient? + :specializer: + +.. generic-function:: breakpoint-transient?-setter + :open: + + :signature: breakpoint-transient?-setter (transient? breakpoint) => (transient?) + + :parameter transient?: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value transient?: An instance of :class:``. + +.. method:: breakpoint-transient?-setter + :specializer: , + +.. method:: breakpoint-transient?-setter + :specializer: , + +.. generic-function:: breakpoint-enabled? + :open: + + :signature: breakpoint-enabled? (breakpoint) => (enabled?) + + :parameter breakpoint: An instance of :class:``. + :value enabled?: An instance of :class:``. + +.. method:: breakpoint-enabled? + :specializer: + +.. generic-function:: breakpoint-enabled?-setter + :open: + + :signature: breakpoint-enabled?-setter (enabled? breakpoint) => (enabled?) + + :parameter enabled?: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value enabled?: An instance of :class:``. + +.. method:: breakpoint-enabled?-setter + :specializer: , + +.. method:: breakpoint-enabled?-setter + :specializer: , + +.. generic-function:: breakpoint-profile? + :open: + + :signature: breakpoint-profile? (breakpoint) => (profile?) + + :parameter breakpoint: An instance of :class:``. + :value profile?: An instance of :class:``. + +.. method:: breakpoint-profile? + :specializer: + +.. generic-function:: breakpoint-profile?-setter + :open: + + :signature: breakpoint-profile?-setter (profile? breakpoint) => (profile?) + + :parameter profile?: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value profile?: An instance of :class:``. + +.. method:: breakpoint-profile?-setter + :specializer: , + +.. method:: breakpoint-profile?-setter + :specializer: , + +.. generic-function:: breakpoint-test + :open: + + :signature: breakpoint-test (breakpoint) => (test) + + :parameter breakpoint: An instance of :class:``. + :value test: An instance of :class:``. + +.. method:: breakpoint-test + :specializer: + +.. generic-function:: breakpoint-test-setter + :open: + + :signature: breakpoint-test-setter (test breakpoint) => (test) + + :parameter test: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value test: An instance of :class:``. + +.. method:: breakpoint-test-setter + :specializer: , + +.. method:: breakpoint-test-setter + :specializer: , + +.. generic-function:: breakpoint-entry-function? + :open: + + :signature: breakpoint-entry-function? (breakpoint) => (entry-function?) + + :parameter breakpoint: An instance of :class:``. + :value entry-function?: An instance of :class:``. + +.. method:: breakpoint-entry-function? + :specializer: + +.. generic-function:: breakpoint-entry-function?-setter + :open: + + :signature: breakpoint-entry-function?-setter (entry-function? breakpoint) => (entry-function?) + + :parameter entry-function?: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value entry-function?: An instance of :class:``. + +.. method:: breakpoint-entry-function?-setter + :specializer: , + +.. method:: breakpoint-entry-function?-setter + :specializer: , + +.. generic-function:: breakpoint-entry-point? + + :signature: breakpoint-entry-point? (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: breakpoint-entry-point?-setter + :open: + + :signature: breakpoint-entry-point?-setter (entry-point? breakpoint) => (entry-point?) + + :parameter entry-point?: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value entry-point?: An instance of :class:``. + +.. method:: breakpoint-entry-point?-setter + :specializer: , + +.. method:: breakpoint-entry-point?-setter + :specializer: , + +.. generic-function:: breakpoint-directions + :open: + + :signature: breakpoint-directions (breakpoint) => (directions) + + :parameter breakpoint: An instance of :class:``. + :value directions: An instance of :class:``. + +.. method:: breakpoint-directions + :specializer: + +.. generic-function:: breakpoint-directions-setter + :open: + + :signature: breakpoint-directions-setter (directions breakpoint) => (directions) + + :parameter directions: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :value directions: An instance of :class:``. + +.. method:: breakpoint-directions-setter + :specializer: , + +.. method:: breakpoint-directions-setter + :specializer: , + +.. generic-function:: note-breakpoint-state-changed + :open: + + :signature: note-breakpoint-state-changed (breakpoint state) => () + + :parameter breakpoint: An instance of :class:``. + :parameter state: An instance of :const:``. + +.. method:: note-breakpoint-state-changed + :specializer: , + +.. generic-function:: server-note-breakpoint-state-changed + :open: + + :signature: server-note-breakpoint-state-changed (server breakpoint state #key use-project-proxy) => () + + :parameter server: An instance of :class:``. + :parameter breakpoint: An instance of :class:``. + :parameter state: An instance of :const:``. + :parameter #key use-project-proxy: An instance of :class:``. + +.. method:: server-note-breakpoint-state-changed + :specializer: , , + +.. macro:: with-compressed-breakpoint-state-changes + +.. function:: do-with-compressed-breakpoint-state-changes + + :signature: do-with-compressed-breakpoint-state-changes (continuation) => () + + :parameter continuation: An instance of :class:``. + +.. generic-function:: note-breakpoint-state-changes-failed + :open: + + :signature: note-breakpoint-state-changes-failed (server breakpoints state) => () + + :parameter server: An instance of :class:``. + :parameter breakpoints: An instance of :class:``. + :parameter state: An instance of :const:``. + +.. method:: note-breakpoint-state-changes-failed + :specializer: , , + +.. function:: trace-function + + :signature: trace-function (project function) => (breakpoint) + + :parameter project: An instance of :class:``. + :parameter function: An instance of :class:``. + :value breakpoint: An instance of :class:``. + +Threads Objects +=============== + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: thread-stack-trace + :open: + + :signature: thread-stack-trace (server thread) => (top-frame) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value top-frame: An instance of :class:``. + +.. method:: thread-stack-trace + :specializer: , + +.. generic-function:: thread-complete-stack-trace + :open: + + :signature: thread-complete-stack-trace (server thread) => (all-frames) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value all-frames: An instance of :class:``. + +.. method:: thread-complete-stack-trace + :specializer: , + +.. generic-function:: thread-index + :open: + + :signature: thread-index (server thread) => (index) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value index: An instance of :class:``. + +.. method:: thread-index + :specializer: , + +.. generic-function:: thread-state + :open: + + :signature: thread-state (server thread) => (state) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value state: An instance of :class:``. + +.. method:: thread-state + :specializer: , + +.. generic-function:: thread-runtime-state + + :signature: thread-runtime-state (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: thread-runtime-state-setter + + :signature: thread-runtime-state-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: thread-suspended? + + :signature: thread-suspended? (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: thread-suspended?-setter + + :signature: thread-suspended?-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: create-application-thread + :open: + + :signature: create-application-thread (server title) => (thread) + + :parameter server: An instance of :class:``. + :parameter title: An instance of :class:``. + :value thread: An instance of :class:``. + +.. method:: create-application-thread + :specializer: , + +.. generic-function:: suspend-application-thread + :open: + + :signature: suspend-application-thread (server thread) => () + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + +.. method:: suspend-application-thread + :specializer: , + +.. generic-function:: resume-application-thread + :open: + + :signature: resume-application-thread (server thread) => () + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + +.. method:: resume-application-thread + :specializer: , + +.. generic-function:: thread-current-interactor-level + :open: + + :signature: thread-current-interactor-level (server thread) => (level) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value level: An instance of :class:``. + +.. method:: thread-current-interactor-level + :specializer: , + +.. generic-function:: add-application-object-to-thread-history + :open: + + :signature: add-application-object-to-thread-history (server thread application-object) => (varname) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter application-object: An instance of :class:``. + :value varname: An instance of :class:``, or ``#f``. + +.. method:: add-application-object-to-thread-history + :specializer: , , + +.. generic-function:: application-default-interactor-thread + :open: + + :signature: application-default-interactor-thread (server) => (thread) + + :parameter server: An instance of :class:``. + :value thread: An instance of :class:``, or ``#f``. + +.. method:: application-default-interactor-thread + :specializer: + +Restarts +======== + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: application-thread-restarts + :open: + + :signature: application-thread-restarts (server thread) => (sequence-of-restart-objects) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value sequence-of-restart-objects: An instance of :class:``. + +.. method:: application-thread-restarts + :specializer: , + +.. generic-function:: application-restart-message + :open: + + :signature: application-restart-message (server rst) => (printable-string) + + :parameter server: An instance of :class:``. + :parameter rst: An instance of :class:``. + :value printable-string: An instance of :class:``. + +.. method:: application-restart-message + :specializer: , + +.. generic-function:: application-restart-abort? + :open: + + :signature: application-restart-abort? (server rst) => (is-abort?) + + :parameter server: An instance of :class:``. + :parameter rst: An instance of :class:``. + :value is-abort?: An instance of :class:``. + +.. method:: application-restart-abort? + :specializer: , + +.. generic-function:: invoke-application-restart + :open: + + :signature: invoke-application-restart (server thread rst) => () + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter rst: An instance of :class:``. + +.. method:: invoke-application-restart + :specializer: , , + +Machines +======== + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required network-address: An instance of :class:``, or ``#f``. + +.. function:: machine-network-address + + :signature: machine-network-address (m) => (a) + + :parameter m: An instance of :class:``. + :value a: An instance of :class:``. + +.. generic-function:: machine-hostname + :open: + + :signature: machine-hostname (m) => (h) + + :parameter m: An instance of :class:``. + :value h: An instance of :class:``. + +.. method:: machine-hostname + :specializer: + +.. function:: environment-host-machine + + :signature: environment-host-machine () => (m) + + :value m: An instance of :class:``. + +.. function:: do-machine-connections + + :signature: do-machine-connections (itr #key include-local?) => (#rest results) + + :parameter itr: An instance of :class:``. + :parameter #key include-local?: An instance of :class:``. + :value #rest results: An instance of :class:``. + +.. generic-function:: close-connection-to-machine + :open: + + :signature: close-connection-to-machine (m) => () + + :parameter m: An instance of :class:``. + +.. method:: close-connection-to-machine + :specializer: + +.. generic-function:: machine-connection-open? + :open: + + :signature: machine-connection-open? (m) => (well?) + + :parameter m: An instance of :class:``. + :value well?: An instance of :class:``. + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required failed-connection: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required network-address: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required password: An instance of :class:``. + +.. generic-function:: failed-connection + + :signature: failed-connection (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: failed-network-address + + :signature: failed-network-address (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: failed-password + + :signature: failed-password (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + +Processes +========= + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required process-debuggable?: An instance of :class:``. + :keyword required process-executable-file: An instance of :class:``. + :keyword required process-host-machine: An instance of :class:``. + :keyword required process-id: An instance of :class:``. + +.. generic-function:: process-host-machine + + :signature: process-host-machine (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: process-executable-file + + :signature: process-executable-file (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: process-id + + :signature: process-id (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. function:: lookup-process-by-id + + :signature: lookup-process-by-id (id #key machine) => (proc) + + :parameter id: An instance of :class:``. + :parameter #key machine: An instance of :class:``. + :value proc: An instance of :class:``, or ``#f``. + +.. generic-function:: process-debuggable? + + :signature: process-debuggable? (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. function:: do-active-processes + + :signature: do-active-processes (f #key machine) => () + + :parameter f: An instance of :class:``. + :parameter #key machine: An instance of :class:``. + +.. generic-function:: do-processes-on-machine + :open: + + :signature: do-processes-on-machine (m function) => () + + :parameter m: An instance of :class:``. + :parameter function: An instance of :class:``. + +.. method:: do-processes-on-machine + :specializer: , + +Applications +============ + +.. class:: + :open: + :abstract: + :primary: + + :superclasses: :class:``, :class:`` + + :keyword arguments: An instance of :class:``. + :keyword required client: An instance of :class:``. + :keyword required filename: An instance of :class:``. + :keyword required machine: An instance of :class:``. + :keyword required project: An instance of :class:``. + +.. constant:: + +.. constant:: + +.. macro:: with-application-transaction + +.. generic-function:: perform-application-transaction + :open: + + :signature: perform-application-transaction (server function) => (#rest values) + + :parameter server: An instance of :class:``. + :parameter function: An instance of :class:``. + :value #rest values: An instance of :class:``. + +.. method:: perform-application-transaction + :specializer: , + +.. generic-function:: application-startup-option + :open: + + :signature: application-startup-option (server) => (opt) + + :parameter server: An instance of :class:``. + :value opt: An instance of :const:``. + +.. method:: application-startup-option + :specializer: + +.. generic-function:: application-client + + :signature: application-client (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-machine + :open: + + :signature: application-machine (server) => (machine) + + :parameter server: An instance of :class:``. + :value machine: An instance of :class:``, or ``#f``. + +.. method:: application-machine + :specializer: + +.. generic-function:: application-filename + + :signature: application-filename (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-arguments + + :signature: application-arguments (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-temporary-stop? + + :signature: application-temporary-stop? (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-temporary-stop?-setter + + :signature: application-temporary-stop?-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-state + + :signature: application-state (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :const:``. + +.. generic-function:: application-state-setter + + :signature: application-state-setter (state application) => (state) + + :parameter state: An instance of :const:``. + :parameter application: An instance of :class:``. + :value state: An instance of :const:``. + +.. generic-function:: application-threads + :open: + + :signature: application-threads (application #key client) => (threads) + + :parameter application: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value threads: An instance of :class:``. + +.. generic-function:: application-running? + :open: + + :signature: application-running? (application) => (running?) + + :parameter application: An instance of :class:``. + :value running?: An instance of :class:``. + +.. method:: application-running? + :specializer: + +.. generic-function:: application-stopped? + :open: + + :signature: application-stopped? (application) => (stopped?) + + :parameter application: An instance of :class:``. + :value stopped?: An instance of :class:``. + +.. method:: application-stopped? + :specializer: + +.. generic-function:: application-closed? + :open: + + :signature: application-closed? (application) => (closed?) + + :parameter application: An instance of :class:``. + :value closed?: An instance of :class:``. + +.. method:: application-closed? + :specializer: + +.. function:: application-tethered? + + :signature: application-tethered? (server) => (tethered?) + + :parameter server: An instance of :class:``. + :value tethered?: An instance of :class:``. + +.. generic-function:: application-pause-before-termination? + :open: + + :signature: application-pause-before-termination? (server) => (well?) + + :parameter server: An instance of :class:``. + :value well?: An instance of :class:``. + +.. method:: application-pause-before-termination? + :specializer: + +.. generic-function:: application-just-hit-breakpoint? + :open: + + :signature: application-just-hit-breakpoint? (server thread) => (hit?) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value hit?: An instance of :class:``. + +.. method:: application-just-hit-breakpoint? + :specializer: , + +.. generic-function:: application-just-hit-dylan-error? + :open: + + :signature: application-just-hit-dylan-error? (server thread) => (hit?) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value hit?: An instance of :class:``. + +.. method:: application-just-hit-dylan-error? + :specializer: , + +.. generic-function:: application-just-hit-error? + :open: + + :signature: application-just-hit-error? (server thread) => (hit?) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value hit?: An instance of :class:``. + +.. method:: application-just-hit-error? + :specializer: , + +.. generic-function:: application-just-interacted? + :open: + + :signature: application-just-interacted? (server thread) => (interacted?) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value interacted?: An instance of :class:``. + +.. method:: application-just-interacted? + :specializer: , + +.. generic-function:: application-just-stepped? + :open: + + :signature: application-just-stepped? (server thread) => (stepped?) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value stepped?: An instance of :class:``. + +.. method:: application-just-stepped? + :specializer: , + +.. generic-function:: application-stop-reason-message + :open: + + :signature: application-stop-reason-message (application) => (message) + + :parameter application: An instance of :class:``. + :value message: An instance of :class:``, or ``#f``. + +.. generic-function:: close-application + :open: + + :signature: close-application (server #key wait-for-termination?) => () + + :parameter server: An instance of :class:``. + :parameter #key wait-for-termination?: An instance of :class:``. + +.. method:: close-application + :specializer: + +.. generic-function:: continue-application + :open: + + :signature: continue-application (server #key thread) => () + + :parameter server: An instance of :class:``. + :parameter #key thread: An instance of :class:``. + +.. method:: continue-application + :specializer: + +.. function:: ensure-application-proxy + + :signature: ensure-application-proxy (application object) => (proxy) + + :parameter application: An instance of :class:``. + :parameter object: An instance of :class:``. + :value proxy: An instance of :class:``. + +.. generic-function:: find-application-proxy + :open: + + :signature: find-application-proxy (application id) => (application-proxy) + + :parameter application: An instance of :class:``. + :parameter id: An instance of :class:``. + :value application-proxy: An instance of :class:``. + +.. method:: find-application-proxy + :specializer: , + +.. generic-function:: application-proxy-id + :open: + + :signature: application-proxy-id (application proxy) => (id) + + :parameter application: An instance of :class:``. + :parameter proxy: An instance of :class:``. + :value id: An instance of :class:``, or ``#f``. + +.. generic-function:: run-application + :open: + + :signature: run-application (server #key startup-option client filename arguments pause-before-termination? library-search-paths working-directory machine) => (application) + + :parameter server: An instance of :class:``. + :parameter #key startup-option: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key filename: An instance of :class:``. + :parameter #key arguments: An instance of :class:``. + :parameter #key pause-before-termination?: An instance of :class:``. + :parameter #key library-search-paths: An instance of :class:``. + :parameter #key working-directory: An instance of :class:``. + :parameter #key machine: An instance of :class:``. + :value application: An instance of :class:``. + +.. method:: run-application + :specializer: + +.. generic-function:: initialize-application-client + :open: + + :signature: initialize-application-client (client application) => () + + :parameter client: An instance of :class:``. + :parameter application: An instance of :class:``. + +.. method:: initialize-application-client + :specializer: , + +.. generic-function:: attach-live-application + :open: + + :signature: attach-live-application (server process #key client system-data) => (app) + + :parameter server: An instance of :class:``. + :parameter process: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key system-data: An instance of :class:``. + :value app: An instance of :class:``. + +.. method:: attach-live-application + :specializer: , + +.. generic-function:: note-run-application-failed + :open: + + :signature: note-run-application-failed (application) => () + + :parameter application: An instance of :class:``. + +.. method:: note-run-application-failed + :specializer: + +.. generic-function:: stop-application + :open: + + :signature: stop-application (server #key client-data) => () + + :parameter server: An instance of :class:``. + :parameter #key client-data: An instance of :class:``. + +.. method:: stop-application + :specializer: + +.. generic-function:: make-project-application + :open: + + :signature: make-project-application (project #key #all-keys) => (application) + + :parameter project: An instance of :class:``. + :value application: An instance of :class:``. + +.. generic-function:: step-application-into + :open: + + :signature: step-application-into (server thread) => () + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + +.. method:: step-application-into + :specializer: , + +.. generic-function:: step-application-over + :open: + + :signature: step-application-over (server thread #key stack-frame) => () + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key stack-frame: An instance of :class:``. + +.. method:: step-application-over + :specializer: , + +.. generic-function:: step-application-out + :open: + + :signature: step-application-out (server thread #key stack-frame) => () + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key stack-frame: An instance of :class:``. + +.. method:: step-application-out + :specializer: , + +.. generic-function:: update-application + :open: + + :signature: update-application (server #key progress-callback) => () + + :parameter server: An instance of :class:``. + :parameter #key progress-callback: An instance of :class:``. + +.. method:: update-application + :specializer: + +.. generic-function:: note-application-initialized + :open: + + :signature: note-application-initialized (project) => () + + :parameter project: An instance of :class:``. + +.. method:: note-application-initialized + :specializer: + +Compiler Databases +================== + +.. class:: + :open: + :abstract: + :primary: + + :superclasses: :class:``, :class:`` + + :keyword required project: An instance of :class:``. + +.. function:: ensure-database-proxy + + :signature: ensure-database-proxy (database object) => (proxy) + + :parameter database: An instance of :class:``. + :parameter object: An instance of :class:``. + :value proxy: An instance of :class:``. + +.. generic-function:: find-compiler-database-proxy + :open: + + :signature: find-compiler-database-proxy (database id #key imported?) => (compiler-proxy) + + :parameter database: An instance of :class:``. + :parameter id: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :value compiler-proxy: An instance of :class:``. + +.. method:: find-compiler-database-proxy + :specializer: , + +.. generic-function:: compiler-database-proxy-id + :open: + + :signature: compiler-database-proxy-id (database proxy) => (id) + + :parameter database: An instance of :class:``. + :parameter proxy: An instance of :class:``. + :value id: An instance of :class:``, or ``#f``. + +.. function:: invalidate-compiler-database + + :signature: invalidate-compiler-database (database) => () + + :parameter database: An instance of :class:``. + +Project Objects +=============== + +.. class:: + :open: + :abstract: + :primary: + + :superclasses: :class:``, :class:`` + + :keyword application: An instance of :class:``, or ``#f``. + :keyword compiler-database: An instance of :class:``, or ``#f``. + :keyword proxy: An instance of :class:``. + :keyword server-path: An instance of :const:``. + +.. constant:: + +.. constant:: + +.. constant:: + +.. function:: active-project + + :signature: active-project () => (project) + + :value project: An instance of :class:``, or ``#f``. + +.. function:: active-project-setter + + :signature: active-project-setter (project) => (project) + + :parameter project: An instance of :class:``, or ``#f``. + :value project: An instance of :class:``, or ``#f``. + +.. function:: project-name + + :signature: project-name (project) => (name) + + :parameter project: An instance of :class:``. + :value name: An instance of :class:``. + +.. generic-function:: project-properties + + :signature: project-properties (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: project-properties-setter + + :signature: project-properties-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: project-proxy + :open: + + :signature: project-proxy (project) => (proxy) + + :parameter project: An instance of :class:``. + :value proxy: An instance of :class:``. + +.. method:: project-proxy + :specializer: + +.. generic-function:: project-proxy-setter + + :signature: project-proxy-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: project-application + :open: + + :signature: project-application (project) => (application) + + :parameter project: An instance of :class:``. + :value application: An instance of :class:``, or ``#f``. + +.. method:: project-application + :specializer: + +.. generic-function:: project-application-setter + + :signature: project-application-setter (value object) => (value) + + :parameter value: An instance of :class:``, or ``#f``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: project-compiler-database + :open: + + :signature: project-compiler-database (project) => (compiler-database) + + :parameter project: An instance of :class:``. + :value compiler-database: An instance of :class:``, or ``#f``. + +.. method:: project-compiler-database + :specializer: + +.. generic-function:: project-compiler-database-setter + + :signature: project-compiler-database-setter (value object) => (value) + + :parameter value: An instance of :class:``, or ``#f``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: project-database-changed? + :open: + + :signature: project-database-changed? (project) => (yes?) + + :parameter project: An instance of :class:``. + :value yes?: An instance of :class:``. + +.. generic-function:: project-sources-changed? + :open: + + :signature: project-sources-changed? (project) => (yes?) + + :parameter project: An instance of :class:``. + :value yes?: An instance of :class:``. + +.. generic-function:: project-opened-by-user? + :open: + + :signature: project-opened-by-user? (project) => (by-user?) + + :parameter project: An instance of :class:``. + :value by-user?: An instance of :class:``. + +.. generic-function:: project-opened-by-user?-setter + :open: + + :signature: project-opened-by-user?-setter (by-user? project) => (by-user?) + + :parameter by-user?: An instance of :class:``. + :parameter project: An instance of :class:``. + :value by-user?: An instance of :class:``. + +.. function:: project-used-libraries + + :signature: project-used-libraries (server project) => (libraries) + + :parameter server: An instance of :class:``. + :parameter project: An instance of :class:``. + :value libraries: An instance of :class:``. + +.. function:: project-used-projects + + :signature: project-used-projects (project #key indirect? read-only?) => (projects) + + :parameter project: An instance of :class:``. + :parameter #key indirect?: An instance of :class:``. + :parameter #key read-only?: An instance of :class:``. + :value projects: An instance of :class:``. + +.. generic-function:: do-project-used-libraries + :open: + + :signature: do-project-used-libraries (function server project) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter project: An instance of :class:``. + +.. method:: do-project-used-libraries + :specializer: , , + +.. generic-function:: do-project-file-libraries + :open: + + :signature: do-project-file-libraries (function server file) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter file: An instance of :class:``. + +.. method:: do-project-file-libraries + :specializer: , , + +.. generic-function:: do-used-projects + :open: + + :signature: do-used-projects (function project #key indirect? read-only?) => () + + :parameter function: An instance of :class:``. + :parameter project: An instance of :class:``. + :parameter #key indirect?: An instance of :class:``. + :parameter #key read-only?: An instance of :class:``. + +.. generic-function:: edit-source-location + :open: + + :signature: edit-source-location (server source-location) => () + + :parameter server: An instance of :class:``. + :parameter source-location: An instance of :class:``. + +.. generic-function:: edit-source-record + :open: + + :signature: edit-source-record (server source-record #key start-line start-column end-line end-column) => () + + :parameter server: An instance of :class:``. + :parameter source-record: An instance of :class:``. + :parameter #key start-line: An instance of :class:``. + :parameter #key start-column: An instance of :class:``. + :parameter #key end-line: An instance of :class:``. + :parameter #key end-column: An instance of :class:``. + +.. generic-function:: edit-definition + :open: + + :signature: edit-definition (server object) => (found-definition?) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value found-definition?: An instance of :class:``. + +.. generic-function:: open-project + :open: + + :signature: open-project (locator) => (project) + + :parameter locator: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. method:: open-project + :specializer: + +.. generic-function:: find-project + :open: + + :signature: find-project (name) => (project) + + :parameter name: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. generic-function:: create-new-user-project + :open: + + :signature: create-new-user-project (name location) => (project) + + :parameter name: An instance of :class:``. + :parameter location: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. generic-function:: open-project-from-file + :open: + + :signature: open-project-from-file (locator) => (project) + + :parameter locator: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. generic-function:: create-exe-project-from-file + :open: + + :signature: create-exe-project-from-file (locator) => (project) + + :parameter locator: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. generic-function:: import-project-from-file + :open: + + :signature: import-project-from-file (locator #key filename) => (project) + + :parameter locator: An instance of :class:``. + :parameter #key filename: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. generic-function:: close-project + :open: + + :signature: close-project (project) => () + + :parameter project: An instance of :class:``. + +.. generic-function:: project-add-source-record + :open: + + :signature: project-add-source-record (project record) => () + + :parameter project: An instance of :class:``. + :parameter record: An instance of :class:``. + +.. generic-function:: project-remove-source-record + :open: + + :signature: project-remove-source-record (project record) => () + + :parameter project: An instance of :class:``. + :parameter record: An instance of :class:``. + +.. generic-function:: project-reorder-source-records + :open: + + :signature: project-reorder-source-records (project compare-function) => () + + :parameter project: An instance of :class:``. + :parameter compare-function: An instance of :class:``. + +.. generic-function:: save-project + :open: + + :signature: save-project (project #key save-database? filename) => () + + :parameter project: An instance of :class:``. + :parameter #key save-database?: An instance of :class:``. + :parameter #key filename: An instance of :class:``, or ``#f``. + +.. generic-function:: save-project-database + :open: + + :signature: save-project-database (project) => () + + :parameter project: An instance of :class:``. + +.. generic-function:: open-projects + :open: + + :signature: open-projects () => (projects) + + :value projects: An instance of :class:``. + +.. function:: current-project + + :signature: current-project () => (project) + + :value project: An instance of :class:``, or ``#f``. + +.. function:: current-project-setter + + :signature: current-project-setter (project) => (project) + + :parameter project: An instance of :class:``, or ``#f``. + :value project: An instance of :class:``, or ``#f``. + +.. generic-function:: project-library + :open: + + :signature: project-library (server) => (library) + + :parameter server: An instance of :class:``. + :value library: An instance of :class:``, or ``#f``. + +.. method:: project-library + :specializer: + +.. generic-function:: project-start-function-name + :open: + + :signature: project-start-function-name (project) => (name) + + :parameter project: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. generic-function:: project-start-function-name-setter + :open: + + :signature: project-start-function-name-setter (name project) => (name) + + :parameter name: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. function:: project-start-function + + :signature: project-start-function (project) => (function) + + :parameter project: An instance of :class:``. + :value function: An instance of :class:``, or ``#f``. + +.. generic-function:: project-read-only? + :open: + + :signature: project-read-only? (project) => (read-only?) + + :parameter project: An instance of :class:``. + :value read-only?: An instance of :class:``. + +.. generic-function:: project-can-be-built? + :open: + + :signature: project-can-be-built? (project) => (can-be-built?) + + :parameter project: An instance of :class:``. + :value can-be-built?: An instance of :class:``. + +.. generic-function:: project-can-be-debugged? + :open: + + :signature: project-can-be-debugged? (project) => (can-be-debugged?) + + :parameter project: An instance of :class:``. + :value can-be-debugged?: An instance of :class:``. + +.. generic-function:: project-compiled? + :open: + + :signature: project-compiled? (project) => (compiled?) + + :parameter project: An instance of :class:``. + :value compiled?: An instance of :class:``. + +.. generic-function:: project-sources + :open: + + :signature: project-sources (project) => (sources) + + :parameter project: An instance of :class:``. + :value sources: An instance of :class:``. + +.. generic-function:: project-canonical-sources + :open: + + :signature: project-canonical-sources (project) => (sources) + + :parameter project: An instance of :class:``. + :value sources: An instance of :class:``. + +.. generic-function:: project-canonical-source-record + + :signature: project-canonical-source-record (project record) => (canonical-record) + + :parameter project: An instance of :class:``. + :parameter record: An instance of :class:``. + :value canonical-record: An instance of :class:``, or ``#f``. + +.. generic-function:: project-canonical-filename + + :signature: project-canonical-filename (project file) => (canonical-filename) + + :parameter project: An instance of :class:``. + :parameter file: An instance of :class:``. + :value canonical-filename: An instance of :class:``, or ``#f``. + +.. generic-function:: project-other-sources + :open: + + :signature: project-other-sources (project) => (sources) + + :parameter project: An instance of :class:``. + :value sources: An instance of :class:``. + +.. generic-function:: project-directory + :open: + + :signature: project-directory (project) => (directory) + + :parameter project: An instance of :class:``. + :value directory: An instance of :class:``. + +.. generic-function:: project-filename + :open: + + :signature: project-filename (project) => (filename) + + :parameter project: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +.. generic-function:: project-build-filename + :open: + + :signature: project-build-filename (project) => (filename) + + :parameter project: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +.. generic-function:: project-build-filename-setter + :open: + + :signature: project-build-filename-setter (filename project) => (filename) + + :parameter filename: An instance of :class:``. + :parameter project: An instance of :class:``. + :value filename: An instance of :class:``. + +.. function:: project-full-build-filename + + :signature: project-full-build-filename (project) => (pathname) + + :parameter project: An instance of :class:``. + :value pathname: An instance of :class:``. + +.. generic-function:: project-debug-filename + :open: + + :signature: project-debug-filename (project) => (filename) + + :parameter project: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +.. generic-function:: project-debug-filename-setter + :open: + + :signature: project-debug-filename-setter (filename project) => (filename) + + :parameter filename: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +.. generic-function:: project-debug-arguments + :open: + + :signature: project-debug-arguments (project) => (arguments) + + :parameter project: An instance of :class:``. + :value arguments: An instance of :class:``. + +.. generic-function:: project-debug-arguments-setter + :open: + + :signature: project-debug-arguments-setter (arguments project) => (arguments) + + :parameter arguments: An instance of :class:``. + :parameter project: An instance of :class:``. + :value arguments: An instance of :class:``. + +.. generic-function:: project-debug-machine-address + :open: + + :signature: project-debug-machine-address (project) => (name) + + :parameter project: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. generic-function:: project-debug-machine-address-setter + :open: + + :signature: project-debug-machine-address-setter (name project) => (name) + + :parameter name: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. generic-function:: project-debug-machine + :open: + + :signature: project-debug-machine (project) => (machine) + + :parameter project: An instance of :class:``. + :value machine: An instance of :class:``, or ``#f``. + +.. method:: project-debug-machine + :specializer: + +.. generic-function:: project-debug-machine-setter + :open: + + :signature: project-debug-machine-setter (machine project) => (machine) + + :parameter machine: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value machine: An instance of :class:``, or ``#f``. + +.. method:: project-debug-machine-setter + :specializer: false-or(), + +.. generic-function:: project-debug-directory + :open: + + :signature: project-debug-directory (project) => (directory) + + :parameter project: An instance of :class:``. + :value directory: An instance of :class:``, or ``#f``. + +.. generic-function:: project-debug-directory-setter + :open: + + :signature: project-debug-directory-setter (directory project) => (directory) + + :parameter directory: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value directory: An instance of :class:``, or ``#f``. + +.. generic-function:: project-build-directory + :open: + + :signature: project-build-directory (project) => (directory) + + :parameter project: An instance of :class:``. + :value directory: An instance of :class:``, or ``#f``. + +.. generic-function:: project-bin-directory + :open: + + :signature: project-bin-directory (project) => (directory) + + :parameter project: An instance of :class:``. + :value directory: An instance of :class:``. + +.. generic-function:: project-release-directory + :open: + + :signature: project-release-directory (project) => (directory) + + :parameter project: An instance of :class:``. + :value directory: An instance of :class:``. + +.. generic-function:: project-server-path + + :signature: project-server-path (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :const:``. + +.. generic-function:: project-compilation-mode + :open: + + :signature: project-compilation-mode (project) => (mode) + + :parameter project: An instance of :class:``. + :value mode: An instance of :const:``. + +.. generic-function:: project-compilation-mode-setter + :open: + + :signature: project-compilation-mode-setter (mode project) => (mode) + + :parameter mode: An instance of :const:``. + :parameter project: An instance of :class:``. + :value mode: An instance of :const:``. + +.. generic-function:: project-compiler-back-end + :open: + + :signature: project-compiler-back-end (project) => (back-end) + + :parameter project: An instance of :class:``. + :value back-end: An instance of :class:``. + +.. generic-function:: project-compiler-back-end-setter + :open: + + :signature: project-compiler-back-end-setter (back-end project) => (back-end) + + :parameter back-end: An instance of :class:``. + :parameter project: An instance of :class:``. + :value back-end: An instance of :class:``. + +.. generic-function:: project-executable-name + :open: + + :signature: project-executable-name (project) => (executable-name) + + :parameter project: An instance of :class:``. + :value executable-name: An instance of :class:``. + +.. generic-function:: project-executable-name-setter + :open: + + :signature: project-executable-name-setter (executable-name project) => (executable-name) + + :parameter executable-name: An instance of :class:``. + :parameter project: An instance of :class:``. + :value executable-name: An instance of :class:``. + +.. generic-function:: project-target-type + :open: + + :signature: project-target-type (project) => (target-type) + + :parameter project: An instance of :class:``. + :value target-type: An instance of :const:``. + +.. generic-function:: project-target-type-setter + :open: + + :signature: project-target-type-setter (target-type project) => (target-type) + + :parameter target-type: An instance of :const:``. + :parameter project: An instance of :class:``. + :value target-type: An instance of :const:``. + +.. generic-function:: project-interface-type + :open: + + :signature: project-interface-type (project) => (interface-type) + + :parameter project: An instance of :class:``. + :value interface-type: An instance of :const:``. + +.. generic-function:: project-interface-type-setter + :open: + + :signature: project-interface-type-setter (interface-type project) => (interface-type) + + :parameter interface-type: An instance of :const:``. + :parameter project: An instance of :class:``. + :value interface-type: An instance of :const:``. + +.. generic-function:: project-base-address + :open: + + :signature: project-base-address (project) => (address) + + :parameter project: An instance of :class:``. + :value address: An instance of :class:``, or ``#f``. + +.. generic-function:: project-base-address-setter + :open: + + :signature: project-base-address-setter (address project) => (address) + + :parameter address: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value address: An instance of :class:``, or ``#f``. + +.. generic-function:: project-major-version + :open: + + :signature: project-major-version (project) => (version) + + :parameter project: An instance of :class:``. + :value version: An instance of :class:``. + +.. generic-function:: project-major-version-setter + :open: + + :signature: project-major-version-setter (version project) => (version) + + :parameter version: An instance of :class:``. + :parameter project: An instance of :class:``. + :value version: An instance of :class:``. + +.. generic-function:: project-minor-version + :open: + + :signature: project-minor-version (project) => (version) + + :parameter project: An instance of :class:``. + :value version: An instance of :class:``. + +.. generic-function:: project-minor-version-setter + :open: + + :signature: project-minor-version-setter (version project) => (version) + + :parameter version: An instance of :class:``. + :parameter project: An instance of :class:``. + :value version: An instance of :class:``. + +.. generic-function:: find-project-source-record + :open: + + :signature: find-project-source-record (project filename) => (record) + + :parameter project: An instance of :class:``. + :parameter filename: An instance of :class:``. + :value record: An instance of :class:``, or ``#f``. + +.. method:: find-project-source-record + :specializer: , + +.. generic-function:: find-source-record-library + :open: + + :signature: find-source-record-library (project record) => (library) + + :parameter project: An instance of :class:``. + :parameter record: An instance of :class:``. + :value library: An instance of :class:``, or ``#f``. + +.. generic-function:: session-property + :open: + + :signature: session-property (key) => (value) + + :parameter key: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: session-property-setter + :open: + + :signature: session-property-setter (value key) => (value) + + :parameter value: An instance of :class:``. + :parameter key: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: source-record-top-level-forms + :open: + + :signature: source-record-top-level-forms (server sr #key project) => (source-forms) + + :parameter server: An instance of :class:``. + :parameter sr: An instance of :class:``. + :parameter #key project: An instance of :class:``. + :value source-forms: An instance of :class:``. + +.. method:: source-record-top-level-forms + :specializer: , + +.. generic-function:: source-record-projects + :open: + + :signature: source-record-projects (source-record) => (projects) + + :parameter source-record: An instance of :class:``. + :value projects: An instance of :class:``. + +.. method:: source-record-projects + :specializer: + +.. method:: source-record-projects + :specializer: + +.. generic-function:: source-record-colorization-info + :open: + + :signature: source-record-colorization-info (project source-record) => (info) + + :parameter project: An instance of :class:``. + :parameter source-record: An instance of :class:``. + :value info: An instance of :class:``. + +.. generic-function:: open-project-compiler-database + :open: + + :signature: open-project-compiler-database (project #key warning-callback error-handler) => (database) + + :parameter project: An instance of :class:``. + :parameter #key warning-callback: An instance of :class:``. + :parameter #key error-handler: An instance of :class:``. + :value database: An instance of :class:``, or ``#f``. + +.. generic-function:: parse-project-source + :open: + + :signature: parse-project-source (project #key warning-callback progress-callback error-handler process-subprojects?) => (well?) + + :parameter project: An instance of :class:``. + :parameter #key warning-callback: An instance of :class:``. + :parameter #key progress-callback: An instance of :class:``. + :parameter #key error-handler: An instance of :class:``. + :parameter #key process-subprojects?: An instance of :class:``. + :value well?: An instance of :class:``. + +.. generic-function:: build-project + :open: + + :signature: build-project (project #key clean? link? release? output warning-callback progress-callback error-handler save-databases? process-subprojects? messages) => (built?) + + :parameter project: An instance of :class:``. + :parameter #key clean?: An instance of :class:``. + :parameter #key link?: An instance of :class:``. + :parameter #key release?: An instance of :class:``. + :parameter #key output: An instance of :class:``. + :parameter #key warning-callback: An instance of :class:``. + :parameter #key progress-callback: An instance of :class:``. + :parameter #key error-handler: An instance of :class:``. + :parameter #key save-databases?: An instance of :class:``. + :parameter #key process-subprojects?: An instance of :class:``. + :parameter #key messages: An instance of :class:``. + :value built?: An instance of :class:``. + +.. generic-function:: clean-project + :open: + + :signature: clean-project (project #key error-handler process-subprojects?) => () + + :parameter project: An instance of :class:``. + :parameter #key error-handler: An instance of :class:``. + :parameter #key process-subprojects?: An instance of :class:``. + +.. generic-function:: link-project + :open: + + :signature: link-project (project #key progress-callback error-handler process-subprojects? build-script target force? unify? release? messages) => () + + :parameter project: An instance of :class:``. + :parameter #key progress-callback: An instance of :class:``. + :parameter #key error-handler: An instance of :class:``. + :parameter #key process-subprojects?: An instance of :class:``. + :parameter #key build-script: An instance of :class:``. + :parameter #key target: An instance of :class:``. + :parameter #key force?: An instance of :class:``. + :parameter #key unify?: An instance of :class:``. + :parameter #key release?: An instance of :class:``. + :parameter #key messages: An instance of :class:``. + +.. generic-function:: note-user-project-opened + + :signature: note-user-project-opened (project-object) => () + + :parameter project-object: An instance of :class:``. + +Playground +========== + +.. function:: find-playground-project + + :signature: find-playground-project () => (project) + + :value project: An instance of :class:``, or ``#f``. + +.. function:: playground-project-name + + :signature: playground-project-name () => (name) + + :value name: An instance of :class:``. + +.. function:: playground-project? + + :signature: playground-project? (project #key just-name?) => (playground?) + + :parameter project: An instance of :class:``. + :parameter #key just-name?: An instance of :class:``. + :value playground?: An instance of :class:``. + +.. function:: playground-application-filename + + :signature: playground-application-filename (project) => (filename) + + :parameter project: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +File Extensions +=============== + +.. function:: environment-locator-type + + :signature: environment-locator-type (locator) => (type) + + :parameter locator: An instance of :class:``. + :value type: An instance of :class:``, or ``#f``. + +.. generic-function:: executable-file-extension + :open: + + :signature: executable-file-extension () => (extension) + + :value extension: An instance of :class:``. + +.. generic-function:: project-file-extension + :open: + + :signature: project-file-extension () => (extension) + + :value extension: An instance of :class:``. + +.. generic-function:: lid-file-extension + :open: + + :signature: lid-file-extension () => (extension) + + :value extension: An instance of :class:``. + +.. generic-function:: dylan-file-extension + :open: + + :signature: dylan-file-extension () => (extension) + + :value extension: An instance of :class:``. + +Interactive Evaluation +====================== + +.. generic-function:: project-execute-code + :open: + + :signature: project-execute-code (server code thread #key module runtime-context stack-frame) => (execution-id deferred-execution?) + + :parameter server: An instance of :class:``. + :parameter code: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key module: An instance of :class:``. + :parameter #key runtime-context: An instance of :class:``. + :parameter #key stack-frame: An instance of :class:``. + :value execution-id: An instance of :const:``. + :value deferred-execution?: An instance of :class:``. + +.. method:: project-execute-code + :specializer: , , + +.. generic-function:: project-macroexpand-code + :open: + + :signature: project-macroexpand-code (server module code #key expansion-stream) => () + + :parameter server: An instance of :class:``. + :parameter module: An instance of :class:``. + :parameter code: An instance of :class:``. + :parameter #key expansion-stream: An instance of :class:``. + +.. method:: project-macroexpand-code + :specializer: , , + +.. generic-function:: project-valid-code? + :open: + + :signature: project-valid-code? (server code thread #key module runtime-context stack-frame) => (valid? warnings) + + :parameter server: An instance of :class:``. + :parameter code: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key module: An instance of :class:``. + :parameter #key runtime-context: An instance of :class:``. + :parameter #key stack-frame: An instance of :class:``. + :value valid?: An instance of :class:``. + :value warnings: An instance of :class:``. + +.. method:: project-valid-code? + :specializer: , , + +.. generic-function:: project-runtime-context + :open: + + :signature: project-runtime-context (server thread #key stack-frame) => (runtime-context) + + :parameter server: An instance of :class:``. + :parameter thread: An instance of :class:``. + :parameter #key stack-frame: An instance of :class:``. + :value runtime-context: An instance of :class:``. + +.. method:: project-runtime-context + :specializer: , + +.. generic-function:: record-return-values + :open: + + :signature: record-return-values (project execution-id values) => () + + :parameter project: An instance of :class:``. + :parameter execution-id: An instance of :const:``. + :parameter values: An instance of :class:``. + +.. generic-function:: application-state-at-code-entry + :open: + + :signature: application-state-at-code-entry (id) => (state) + + :parameter id: An instance of :class:``. + :value state: An instance of :const:``. + +.. constant:: + +.. class:: + + :superclasses: :class:`` + + :keyword required id: An instance of :const:``. + :keyword required thread: An instance of :class:``. + +.. generic-function:: execution-info-id + + :signature: execution-info-id (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :const:``. + +.. generic-function:: execution-info-thread + + :signature: execution-info-thread (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: project-execution-info + :open: + + :signature: project-execution-info (project id) => (info) + + :parameter project: An instance of :class:``. + :parameter id: An instance of :const:``. + :value info: An instance of :class:``, or ``#f``. + +.. generic-function:: project-remove-execution-info + :open: + + :signature: project-remove-execution-info (project info) => () + + :parameter project: An instance of :class:``. + :parameter info: An instance of :class:``. + +.. generic-function:: project-bind-variable + :open: + + :signature: project-bind-variable (server variable-name object #key module) => (success?) + + :parameter server: An instance of :class:``. + :parameter variable-name: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key module: An instance of :class:``. + :value success?: An instance of :class:``. + +.. generic-function:: fetch-interactor-return-values + :open: + + :signature: fetch-interactor-return-values (server execution-id) => (environment-objects) + + :parameter server: An instance of :class:``. + :parameter execution-id: An instance of :const:``. + :value environment-objects: An instance of :class:``. + +.. method:: fetch-interactor-return-values + :specializer: , + +.. generic-function:: dispose-interactor-return-values + :open: + + :signature: dispose-interactor-return-values (server execution-id) => () + + :parameter server: An instance of :class:``. + :parameter execution-id: An instance of :const:``. + +.. method:: dispose-interactor-return-values + :specializer: , + +.. generic-function:: transaction-id-source-record + :open: + + :signature: transaction-id-source-record (server id) => (source-record) + + :parameter server: An instance of :class:``. + :parameter id: An instance of :const:``. + :value source-record: An instance of :class:``, or ``#f``. + +.. method:: transaction-id-source-record + :specializer: , + +Name Objects +============ + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: name-value + :open: + + :signature: name-value (server name) => (value) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. method:: name-value + :specializer: , + +.. generic-function:: name-type + :open: + + :signature: name-type (server name) => (type) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value type: An instance of :class:``. + +.. method:: name-type + :specializer: , + +.. generic-function:: name-imported? + :open: + + :signature: name-imported? (server name) => (imported?) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value imported?: An instance of :class:``. + +.. method:: name-imported? + :specializer: , + +.. generic-function:: name-exported? + :open: + + :signature: name-exported? (server name) => (exported?) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value exported?: An instance of :class:``. + +.. method:: name-exported? + :specializer: , + +Namespace Objects +================= + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: find-name + :open: + + :signature: find-name (server name namespace #key imported?) => (name) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :parameter namespace: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :value name: An instance of :class:``, or ``#f``. + +.. method:: find-name + :specializer: , , + +.. method:: find-name + :specializer: , , + +.. generic-function:: name-namespace + :open: + + :signature: name-namespace (server name) => (namespace) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value namespace: An instance of :class:``. + +.. method:: name-namespace + :specializer: , + +.. function:: namespace-names + + :signature: namespace-names (server namespace #key client imported?) => (names) + + :parameter server: An instance of :class:``. + :parameter namespace: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :value names: An instance of :class:``. + +.. generic-function:: do-namespace-names + :open: + + :signature: do-namespace-names (function server namespace #key imported? client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter namespace: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-namespace-names + :specializer: , , + +Library Objects +=============== + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: find-library + :open: + + :signature: find-library (server name) => (library) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :value library: An instance of :class:``, or ``#f``. + +.. method:: find-library + :specializer: , + +.. method:: find-library + :specializer: , + +.. function:: library-modules + + :signature: library-modules (server library #key client imported?) => (modules) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :value modules: An instance of :class:``. + +.. function:: library-default-module + + :signature: library-default-module (server library) => (module) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value module: An instance of :class:``, or ``#f``. + +.. generic-function:: library-project + :open: + + :signature: library-project (server library) => (project) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value project: An instance of :class:``, or ``#f``. + +.. method:: library-project + :specializer: , + +.. generic-function:: library-project-filename + :open: + + :signature: library-project-filename (server library) => (filename) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +.. method:: library-project-filename + :specializer: , + +.. generic-function:: library-filename + :open: + + :signature: library-filename (server library) => (filename) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value filename: An instance of :class:``, or ``#f``. + +.. method:: library-filename + :specializer: , + +.. generic-function:: library-interactive? + :open: + + :signature: library-interactive? (server library) => (interactive?) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value interactive?: An instance of :class:``. + +.. method:: library-interactive? + :specializer: , + +.. generic-function:: library-read-only? + :open: + + :signature: library-read-only? (server library) => (read-only?) + + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value read-only?: An instance of :class:``. + +.. method:: library-read-only? + :specializer: , + +.. generic-function:: library-read-only?-setter + :open: + + :signature: library-read-only?-setter (read-only? server library) => (read-only?) + + :parameter read-only?: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :value read-only?: An instance of :class:``. + +.. method:: library-read-only?-setter + :specializer: , , + +.. function:: do-library-modules + + :signature: do-library-modules (function server library #key client imported?) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter library: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + +Module Objects +============== + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: file-module + :open: + + :signature: file-module (project filename) => (module library) + + :parameter project: An instance of :class:``, or ``#f``. + :parameter filename: An instance of ``type-union(, )``. + :value module: An instance of :class:``, or ``#f``. + :value library: An instance of :class:``, or ``#f``. + +.. method:: file-module + :specializer: false-or(), type-union(, ) + +.. generic-function:: find-module + :open: + + :signature: find-module (server name #key library imported? all-libraries?) => (module) + + :parameter server: An instance of :class:``. + :parameter name: An instance of :class:``. + :parameter #key library: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :parameter #key all-libraries?: An instance of :class:``. + :value module: An instance of :class:``, or ``#f``. + +.. method:: find-module + :specializer: , + +.. method:: find-module + :specializer: , + +.. generic-function:: module-project-proxy + :open: + + :signature: module-project-proxy (server module) => (proxy) + + :parameter server: An instance of :class:``. + :parameter module: An instance of :class:``. + :value proxy: An instance of :class:``. + +.. method:: module-project-proxy + :specializer: , + +.. generic-function:: do-module-definitions + :open: + + :signature: do-module-definitions (function server module #key imported? client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter module: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-module-definitions + :specializer: , , + +.. function:: module-definitions + + :signature: module-definitions (server module #key client imported?) => (names) + + :parameter server: An instance of :class:``. + :parameter module: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key imported?: An instance of :class:``. + :value names: An instance of :class:``. + +Macros +====== + +.. class:: + + :superclasses: :class:`` + +Variable Objects +================ + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + :abstract: + + :superclasses: :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: variable-type + :open: + + :signature: variable-type (server variable) => (type) + + :parameter server: An instance of :class:``. + :parameter variable: An instance of :class:``. + :value type: An instance of :class:``, or ``#f``. + +.. method:: variable-type + :specializer: , + +.. generic-function:: variable-value + :open: + + :signature: variable-value (server variable #key thread) => (value) + + :parameter server: An instance of :class:``. + :parameter variable: An instance of :class:``. + :parameter #key thread: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. method:: variable-value + :specializer: , + +Constant Objects +================ + +.. class:: + + :superclasses: :class:``, :class:`` + +Functions +========= + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:``, :class:`` + + +.. class:: + + :superclasses: :class:``, :class:``, :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required name: An instance of :class:``. + :keyword required type: An instance of :class:``. + +.. constant:: + +.. class:: + + :superclasses: :class:`` + + :keyword required default-value: An instance of :class:``. + :keyword keyword: An instance of :class:``, or ``#f``. + +.. constant:: + +.. generic-function:: function-parameters + :open: + + :signature: function-parameters (server function) => (required rest keys all-keys? next values rest-value) + + :parameter server: An instance of :class:``. + :parameter function: An instance of :class:``. + :value required: An instance of :const:``. + :value rest: An instance of :class:``, or ``#f``. + :value keys: An instance of :const:``. + :value all-keys?: An instance of :class:``. + :value next: An instance of :class:``, or ``#f``. + :value values: An instance of :const:``. + :value rest-value: An instance of :class:``, or ``#f``. + +.. method:: function-parameters + :specializer: , + +.. generic-function:: do-generic-function-methods + :open: + + :signature: do-generic-function-methods (function server generic-function #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter generic-function: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-generic-function-methods + :specializer: , , + +.. function:: generic-function-object-methods + + :signature: generic-function-object-methods (server function) => (methods) + + :parameter server: An instance of :class:``. + :parameter function: An instance of :class:``. + :value methods: An instance of :class:``. + +.. generic-function:: method-generic-function + :open: + + :signature: method-generic-function (server object) => (function) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value function: An instance of :class:``, or ``#f``. + +.. method:: method-generic-function + :specializer: , + +.. generic-function:: method-specializers + :open: + + :signature: method-specializers (server object) => (specializers) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value specializers: An instance of :class:``. + +.. method:: method-specializers + :specializer: , + +.. generic-function:: parameter-name + + :signature: parameter-name (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: parameter-type + + :signature: parameter-type (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: parameter-keyword + + :signature: parameter-keyword (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: parameter-default-value + + :signature: parameter-default-value (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +Domains +======= + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: domain-specializers + :open: + + :signature: domain-specializers (server object) => (specializers) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value specializers: An instance of :class:``. + +.. method:: domain-specializers + :specializer: , + +Type Objects +============ + +.. class:: + + :superclasses: :class:``, :class:``, :class:`` + +Singleton Objects +================= + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: singleton-value + :open: + + :signature: singleton-value (server object) => (value) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. method:: singleton-value + :specializer: , + +Classes +======= + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: do-direct-subclasses + :open: + + :signature: do-direct-subclasses (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-direct-subclasses + :specializer: , , + +.. generic-function:: do-direct-superclasses + :open: + + :signature: do-direct-superclasses (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-direct-superclasses + :specializer: , , + +.. generic-function:: do-direct-methods + :open: + + :signature: do-direct-methods (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-direct-methods + :specializer: , , + +.. generic-function:: do-direct-slots + :open: + + :signature: do-direct-slots (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-direct-slots + :specializer: , , + +.. generic-function:: do-all-methods + :open: + + :signature: do-all-methods (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-all-methods + :specializer: , , + +.. generic-function:: do-all-superclasses + :open: + + :signature: do-all-superclasses (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-all-superclasses + :specializer: , , + +.. generic-function:: do-all-slots + :open: + + :signature: do-all-slots (function server class #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-all-slots + :specializer: , , + +.. generic-function:: do-init-keywords + :open: + + :signature: do-init-keywords (function server class #key client inherited?) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :parameter #key inherited?: An instance of :class:``. + +.. method:: do-init-keywords + :specializer: , , + +.. function:: class-direct-subclasses + + :signature: class-direct-subclasses (server class) => (classes) + + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :value classes: An instance of :class:``. + +.. function:: class-direct-superclasses + + :signature: class-direct-superclasses (server class) => (classes) + + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :value classes: An instance of :class:``. + +.. function:: class-direct-methods + + :signature: class-direct-methods (server class) => (methods) + + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :value methods: An instance of :class:``. + +.. function:: class-direct-slots + + :signature: class-direct-slots (server class) => (slots) + + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :value slots: An instance of :class:``. + +.. function:: class-slots + + :signature: class-slots (server class) => (slots) + + :parameter server: An instance of :class:``. + :parameter class: An instance of :class:``. + :value slots: An instance of :class:``. + +Slots +===== + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: slot-class + :open: + + :signature: slot-class (server slot) => (class) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value class: An instance of :class:``. + +.. method:: slot-class + :specializer: , + +.. generic-function:: slot-getter + :open: + + :signature: slot-getter (server slot) => (getter) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value getter: An instance of :class:``, or ``#f``. + +.. method:: slot-getter + :specializer: , + +.. generic-function:: slot-setter + :open: + + :signature: slot-setter (server slot) => (setter) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value setter: An instance of :class:``, or ``#f``. + +.. method:: slot-setter + :specializer: , + +.. generic-function:: slot-type + :open: + + :signature: slot-type (server slot) => (type) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value type: An instance of :class:``. + +.. method:: slot-type + :specializer: , + +.. generic-function:: slot-init-kind + :open: + + :signature: slot-init-kind (server slot) => (kind) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value kind: An instance of :class:``, or ``#f``. + +.. method:: slot-init-kind + :specializer: , + +.. generic-function:: slot-init-keyword + :open: + + :signature: slot-init-keyword (server slot) => (keyword required?) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value keyword: An instance of :class:``, or ``#f``. + :value required?: An instance of :class:``. + +.. method:: slot-init-keyword + :specializer: , + +.. generic-function:: slot-allocation + :open: + + :signature: slot-allocation (server slot) => (keywords) + + :parameter server: An instance of :class:``. + :parameter slot: An instance of :class:``. + :value keywords: An instance of :class:``. + +.. method:: slot-allocation + :specializer: , + +Local Variable Objects +====================== + +.. class:: + + :superclasses: :class:`` + +Stack Frame Objects +=================== + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: stack-frame-function + :open: + + :signature: stack-frame-function (server stack-frame) => (function) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value function: An instance of :class:``, or ``#f``. + +.. method:: stack-frame-function + :specializer: , + +.. generic-function:: stack-frame-environment-object + :open: + + :signature: stack-frame-environment-object (server stack-frame) => (object) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value object: An instance of :class:``, or ``#f``. + +.. method:: stack-frame-environment-object + :specializer: , + +.. generic-function:: stack-frame-source-location + :open: + + :signature: stack-frame-source-location (server stack-frame) => (location exact? dylan?) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value location: An instance of :class:``, or ``#f``. + :value exact?: An instance of :class:``. + :value dylan?: An instance of :class:``. + +.. method:: stack-frame-source-location + :specializer: , + +.. generic-function:: stack-frame-thread + :open: + + :signature: stack-frame-thread (server stack-frame) => (thread) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value thread: An instance of :class:``. + +.. method:: stack-frame-thread + :specializer: , + +.. generic-function:: stack-frame-type + :open: + + :signature: stack-frame-type (server stack-frame) => (type) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value type: An instance of :class:``. + +.. method:: stack-frame-type + :specializer: , + +.. generic-function:: stack-frame-next-frame + :open: + + :signature: stack-frame-next-frame (server stack-frame) => (next-one) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value next-one: An instance of :class:``, or ``#f``. + +.. method:: stack-frame-next-frame + :specializer: , + +.. generic-function:: stack-frame-previous-frame + :open: + + :signature: stack-frame-previous-frame (server stack-frame) => (previous-one) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value previous-one: An instance of :class:``, or ``#f``. + +.. method:: stack-frame-previous-frame + :specializer: , + +.. generic-function:: stack-frame-local-variables + :open: + + :signature: stack-frame-local-variables (server stack-frame) => (locals) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value locals: An instance of :class:``. + +.. method:: stack-frame-local-variables + :specializer: , + +.. generic-function:: stack-frame-local-variable-count + :open: + + :signature: stack-frame-local-variable-count (server stack-frame) => (locals-count) + + :parameter server: An instance of :class:``. + :parameter stack-frame: An instance of :class:``. + :value locals-count: An instance of :class:``. + +.. method:: stack-frame-local-variable-count + :specializer: , + +Compiler Warnings +================= + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required proxy: An instance of :class:``. + +.. class:: + + :superclasses: :class:``, :class:``, :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: compiler-warning-short-message + :open: + + :signature: compiler-warning-short-message (server warning) => (message) + + :parameter server: An instance of :class:``. + :parameter warning: An instance of :class:``. + :value message: An instance of :class:``. + +.. method:: compiler-warning-short-message + :specializer: , + +.. generic-function:: compiler-warning-full-message + :open: + + :signature: compiler-warning-full-message (server warning) => (message) + + :parameter server: An instance of :class:``. + :parameter warning: An instance of :class:``. + :value message: An instance of :class:``. + +.. method:: compiler-warning-full-message + :specializer: , + +.. generic-function:: environment-object-proxy + + :signature: environment-object-proxy (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: warning-owner + :open: + + :signature: warning-owner (server warning) => (owner) + + :parameter server: An instance of :class:``. + :parameter warning: An instance of :class:``. + :value owner: An instance of :class:``, or ``#f``. + +.. method:: warning-owner + :specializer: , + +.. generic-function:: do-compiler-warnings + :open: + + :signature: do-compiler-warnings (function server object #key client) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key client: An instance of :class:``. + +.. method:: do-compiler-warnings + :specializer: , , + +.. method:: do-compiler-warnings + :specializer: , , + +.. function:: project-warnings + + :signature: project-warnings (project #key client) => (warnings) + + :parameter project: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value warnings: An instance of :class:``. + +.. function:: source-form-compiler-warnings + + :signature: source-form-compiler-warnings (server object #key client) => (warnings) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key client: An instance of :class:``. + :value warnings: An instance of :class:``. + +Condition Objects +================= + +.. class:: + + :superclasses: :class:`` + +DUIM Objects +============ + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: duim-object-composite? + :open: + + :signature: duim-object-composite? (server duim-object) => (composite?) + + :parameter server: An instance of :class:``. + :parameter duim-object: An instance of :class:``. + :value composite?: An instance of :class:``. + +.. method:: duim-object-composite? + :specializer: , + +.. method:: duim-object-composite? + :specializer: , + +.. generic-function:: do-duim-object-children + :open: + + :signature: do-duim-object-children (function server duim-object) => () + + :parameter function: An instance of :class:``. + :parameter server: An instance of :class:``. + :parameter duim-object: An instance of :class:``. + +.. method:: do-duim-object-children + :specializer: , , + +.. method:: do-duim-object-children + :specializer: , , + +.. method:: do-duim-object-children + :specializer: , , + +.. method:: do-duim-object-children + :specializer: , , + +.. method:: do-duim-object-children + :specializer: , , + +.. function:: duim-object-children + + :signature: duim-object-children (server object) => (children) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :value children: An instance of :class:``. + +Profiling +========= + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: profiling-enabled? + + :signature: profiling-enabled? (server) => (enabled?) + + :parameter server: An instance of :class:``. + :value enabled?: An instance of :class:``. + +.. generic-function:: project-default-profile-options + + :signature: project-default-profile-options (project) => (options) + + :parameter project: An instance of :class:``. + :value options: An instance of :class:``, or ``#f``. + +.. generic-function:: project-default-profile-options-setter + + :signature: project-default-profile-options-setter (options project) => (options) + + :parameter options: An instance of :class:``, or ``#f``. + :parameter project: An instance of :class:``. + :value options: An instance of :class:``, or ``#f``. + +.. generic-function:: project-last-profile + + :signature: project-last-profile (project) => (profile) + + :parameter project: An instance of :class:``. + :value profile: An instance of :class:``, or ``#f``. + +.. generic-function:: profile-snapshot-available-values + :open: + + :signature: profile-snapshot-available-values (server) => (values) + + :parameter server: An instance of :class:``. + :value values: An instance of :class:``. + +.. method:: profile-snapshot-available-values + :specializer: + +.. generic-function:: start-profiling-application + :open: + + :signature: start-profiling-application (server #key options) => () + + :parameter server: An instance of :class:``. + :parameter #key options: An instance of :class:``, or ``#f``. + +.. method:: start-profiling-application + :specializer: + +.. function:: ensure-profiling-started + + :signature: ensure-profiling-started (application) => () + + :parameter application: An instance of :class:``. + +.. generic-function:: stop-profiling-application + :open: + + :signature: stop-profiling-application (server) => (profile) + + :parameter server: An instance of :class:``. + :value profile: An instance of :class:``, or ``#f``. + +.. method:: stop-profiling-application + :specializer: + +.. generic-function:: clear-profiling-results + + :signature: clear-profiling-results (server) => () + + :parameter server: An instance of :class:``. + +.. generic-function:: process-profiling-results + :open: + + :signature: process-profiling-results (application) => (profile) + + :parameter application: An instance of :class:``. + :value profile: An instance of :class:``, or ``#f``. + +Profiling Options +================= + +.. class:: + + :superclasses: :class:`` + + :keyword required sampling-options: An instance of :class:``. + :keyword required snapshot-options: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword rate: An instance of :class:``, or ``#f``. + :keyword required style: An instance of :const:``. + +.. constant:: + +.. class:: + + :superclasses: :class:`` + + :keyword stack-depth: An instance of :class:``, or ``#f``. + :keyword required values: An instance of :class:``. + +.. generic-function:: profile-sampling-options + + :signature: profile-sampling-options (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: profile-sampling-style + + :signature: profile-sampling-style (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :const:``. + +.. generic-function:: profile-sampling-rate + + :signature: profile-sampling-rate (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: profile-snapshot-options + + :signature: profile-snapshot-options (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: profile-snapshot-values + + :signature: profile-snapshot-values (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: profile-snapshot-stack-depth + + :signature: profile-snapshot-stack-depth (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +Profile Results +=============== + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required options: An instance of :class:``. + +.. generic-function:: application-profile-options + :open: + + :signature: application-profile-options (profile) => (options) + + :parameter profile: An instance of :class:``. + :value options: An instance of :class:``. + +.. method:: application-profile-options + :specializer: + +.. generic-function:: application-profile-snapshots + + :signature: application-profile-snapshots (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. function:: do-application-profile-snapshots + + :signature: do-application-profile-snapshots (function profile) => () + + :parameter function: An instance of :class:``. + :parameter profile: An instance of :class:``. + +.. generic-function:: application-profile-threads + + :signature: application-profile-threads (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. function:: do-application-profile-threads + + :signature: do-application-profile-threads (function profile) => () + + :parameter function: An instance of :class:``. + :parameter profile: An instance of :class:``. + +.. function:: application-total-snapshots + + :signature: application-total-snapshots (profile) => (total) + + :parameter profile: An instance of :class:``. + :value total: An instance of :class:``. + +.. generic-function:: application-total-wall-time + + :signature: application-total-wall-time (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-total-wall-time-setter + + :signature: application-total-wall-time-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-total-page-faults + + :signature: application-total-page-faults (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: application-total-page-faults-setter + + :signature: application-total-page-faults-setter (value object) => (value) + + :parameter value: An instance of :class:``. + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required page-faults: An instance of :class:``, or ``#f``. + :keyword required thread-snapshots: An instance of :class:``. + :keyword required wall-time: An instance of :class:``, or ``#f``. + +.. generic-function:: application-snapshot-wall-time + + :signature: application-snapshot-wall-time (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: application-snapshot-page-faults + + :signature: application-snapshot-page-faults (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. function:: application-snapshot-thread-snapshot + + :signature: application-snapshot-thread-snapshot (snapshot thread) => (thread-snapshot) + + :parameter snapshot: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value thread-snapshot: An instance of :class:``, or ``#f``. + +.. generic-function:: application-snapshot-thread-snapshots + + :signature: application-snapshot-thread-snapshots (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. function:: do-application-snapshot-thread-snapshots + + :signature: do-application-snapshot-thread-snapshots (function snapshot) => () + + :parameter function: An instance of :class:``. + :parameter snapshot: An instance of :class:``. + +.. function:: thread-profile-snapshots + + :signature: thread-profile-snapshots (application profile thread) => (threads) + + :parameter application: An instance of :class:``. + :parameter profile: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value threads: An instance of :class:``. + +.. function:: do-thread-profile-snapshots + + :signature: do-thread-profile-snapshots (function application profile thread) => (threads) + + :parameter function: An instance of :class:``. + :parameter application: An instance of :class:``. + :parameter profile: An instance of :class:``. + :parameter thread: An instance of :class:``. + :value threads: An instance of :class:``. + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required allocated-class: An instance of :class:``, or ``#f``. + :keyword required allocation: An instance of :class:``, or ``#f``. + :keyword required cpu-time: An instance of :class:``, or ``#f``. + :keyword required thread: An instance of :class:``. + +.. generic-function:: thread-snapshot-thread + + :signature: thread-snapshot-thread (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: thread-snapshot-cpu-time + + :signature: thread-snapshot-cpu-time (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: thread-snapshot-allocated-class + + :signature: thread-snapshot-allocated-class (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: thread-snapshot-allocation + + :signature: thread-snapshot-allocation (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: thread-snapshot-stack-size + :open: + + :signature: thread-snapshot-stack-size (application snapshot) => (size) + + :parameter application: An instance of :class:``. + :parameter snapshot: An instance of :class:``. + :value size: An instance of :class:``. + +.. function:: thread-snapshot-frame-snapshots + + :signature: thread-snapshot-frame-snapshots (application snapshot) => (snapshots) + + :parameter application: An instance of :class:``. + :parameter snapshot: An instance of :class:``. + :value snapshots: An instance of :class:``. + +.. generic-function:: process-thread-snapshot-frame-snapshots + :open: + + :signature: process-thread-snapshot-frame-snapshots (application snapshot) => (frame-snapshots) + + :parameter application: An instance of :class:``. + :parameter snapshot: An instance of :class:``. + :value frame-snapshots: An instance of :class:``. + +.. function:: thread-snapshot-functions + + :signature: thread-snapshot-functions (application snapshot) => (functions) + + :parameter application: An instance of :class:``. + :parameter snapshot: An instance of :class:``. + :value functions: An instance of :class:``. + +.. function:: do-thread-snapshot-functions + + :signature: do-thread-snapshot-functions (function application snapshot) => () + + :parameter function: An instance of :class:``. + :parameter application: An instance of :class:``. + :parameter snapshot: An instance of :class:``. + +.. class:: + :open: + :abstract: + + :superclasses: :class:`` + + :keyword required function: An instance of :class:``, or ``#f``. + :keyword required source-location: An instance of :class:``, or ``#f``. + +.. generic-function:: frame-snapshot-function + + :signature: frame-snapshot-function (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +.. generic-function:: frame-snapshot-source-location + + :signature: frame-snapshot-source-location (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``, or ``#f``. + +Channels +======== + +.. constant:: $project-channel + + Some channel stuff for communicating project messages to interested + parties. + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword required project: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. generic-function:: message-project + + :signature: message-project (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword required state: An instance of :const:``. + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required breakpoint: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required breakpoints: An instance of :class:``. + +.. generic-function:: message-breakpoint-state + + :signature: message-breakpoint-state (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :const:``. + +.. generic-function:: message-breakpoint + + :signature: message-breakpoint (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: message-breakpoints + + :signature: message-breakpoints (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + :keyword required enabled?: An instance of :class:``. + +.. generic-function:: message-enabled? + + :signature: message-enabled? (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +Application Messages +==================== + +.. class:: + :abstract: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + + :superclasses: :class:`` + + +.. class:: + :abstract: + + :superclasses: :class:`` + + :keyword required thread: An instance of :class:``. + +.. class:: + + :superclasses: :class:`` + + :keyword required transaction-id: An instance of :class:``. + :keyword required warnings: An instance of :class:``. + +.. generic-function:: message-thread + + :signature: message-thread (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: message-transaction-id + + :signature: message-transaction-id (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +.. generic-function:: message-warnings + + :signature: message-warnings (object) => (value) + + :parameter object: An instance of :class:``. + :value value: An instance of :class:``. + +Printing Utilities +================== + +.. generic-function:: print-source-location + + :signature: print-source-location (stream location #key line-number) => () + + :parameter stream: An instance of :class:``. + :parameter location: An instance of :class:``. + :parameter #key line-number: An instance of :class:``, or ``#f``. + +.. function:: application-state-label + + :signature: application-state-label (project) => (label) + + :parameter project: An instance of :class:``. + :value label: An instance of :class:``. + +.. function:: thread-state-label + + :signature: thread-state-label (project state) => (label) + + :parameter project: An instance of :class:``. + :parameter state: An instance of :class:``. + :value label: An instance of :class:``. + +.. generic-function:: environment-object-contents + + :signature: environment-object-contents (project object) => (contents) + + :parameter project: An instance of :class:``. + :parameter object: An instance of :class:``. + :value contents: An instance of :class:``. + +.. generic-function:: environment-object-description + + :signature: environment-object-description (project object module) => (description) + + :parameter project: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter module: An instance of :class:``. + :value description: An instance of :class:``. + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. method:: environment-object-description + :specializer: , , + +.. function:: print-function-parameters + + :signature: print-function-parameters (server function-object namespace) => (name) + + :parameter server: An instance of :class:``. + :parameter function-object: An instance of :class:``. + :parameter namespace: An instance of :class:``, or ``#f``. + :value name: An instance of :class:``. + +.. function:: print-function-values + + :signature: print-function-values (server function-object namespace) => (name) + + :parameter server: An instance of :class:``. + :parameter function-object: An instance of :class:``. + :parameter namespace: An instance of :class:``, or ``#f``. + :value name: An instance of :class:``. + +.. generic-function:: print-environment-object-location + :open: + + :signature: print-environment-object-location (server object #key absolute-path?) => (location) + + :parameter server: An instance of :class:``. + :parameter object: An instance of :class:``. + :parameter #key absolute-path?: An instance of :class:``. + :value location: An instance of :class:``. + +.. method:: print-environment-object-location + :specializer: , + +.. method:: print-environment-object-location + :specializer: , + +.. constant:: $n/a + +.. constant:: $type-n/a + +.. constant:: $no-information-available + +.. constant:: $unknown-name + +.. constant:: $unknown + +.. constant:: $project-not-built + +.. constant:: $interactive-definition + +.. constant:: $not-available + +.. constant:: $not-applicable diff --git a/documentation/source/hacker-guide/environment/index.rst b/documentation/source/hacker-guide/environment/index.rst new file mode 100644 index 000000000..0a7985734 --- /dev/null +++ b/documentation/source/hacker-guide/environment/index.rst @@ -0,0 +1,10 @@ +*********** +Environment +*********** + +Contents: + +.. toctree:: + :maxdepth: 2 + + environment-protocols diff --git a/documentation/source/hacker-guide/index.rst b/documentation/source/hacker-guide/index.rst index 21b21afc8..e6061b434 100644 --- a/documentation/source/hacker-guide/index.rst +++ b/documentation/source/hacker-guide/index.rst @@ -102,6 +102,7 @@ Hackers. compiler/index runtime/index runtime-manager/index + environment/index duim/index topics/index glossary