The climc Reference Manual

4.1.1 climc/climc.asd

Source

climc.asd.

Parent Component

climc (system).

ASDF Systems

climc.

---

4.1.2 climc/src/package.lisp

Source

climc.asd.

Parent Component

src (module).

Packages

climc.

---

4.1.3 climc/src/specials.lisp

Dependency

package.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Public Interface

*debug* (special variable).

Internals

• *climc-account* (special variable).
• *climc-account-emails* (special variable).
• *im-client* (special variable).
• *im-client-process* (special variable).
• *xmpp-app* (special variable).
• *xmpp-presences* (special variable).

---

4.1.4 climc/src/tools.lisp

Dependency

package.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Public Interface

redisplay-frame-pane (method).

Internals

• close-box-callback (function).
• get-climc-directory (function).
• iso-time (function).
• make-button (function).
• redisplay-callback (function).
• redisplay-frame-mixin (class).

---

4.1.5 climc/src/im.lisp

Dependency

specials.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Internals

• connection-of (reader method).
• (setf connection-of) (writer method).
• im (class).
• make-im (function).
• password-of (reader method).
• (setf password-of) (writer method).
• send-message (generic function).
• send-presence-request (generic function).
• start-im (generic function).
• stop-im (generic function).
• username-of (reader method).
• (setf username-of) (writer method).

---

4.1.6 climc/src/dao.lisp

Dependency

package.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Internals

• contact (class).
• email-of (reader method).
• (setf email-of) (writer method).
• status-of (reader method).
• (setf status-of) (writer method).

---

4.1.7 climc/src/chat.lisp

Dependency

specials.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Public Interface

update-instance-for-redefined-class (method).

Internals

• chat (class).
• close-chat-callback (function).
• contact-of (reader method).
• (setf contact-of) (writer method).
• define-chat-command (macro).
• display-chat (method).
• display-message (method).
• input-message-callback (function).
• reinitialize-panes-and-layouts (method).

---

4.1.8 climc/src/xmpp.lisp

Dependency

specials.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Public Interface

update-instance-for-redefined-class (method).

Internals

• define-xmpp-app-command (macro).
• display-xmpp-message (function).
• reinitialize-panes-and-layouts (method).
• xmpp-app (class).

---

4.1.9 climc/src/climc.lisp

Dependencies

• xmpp.lisp (file).
• tools.lisp (file).
• dao.lisp (file).
• chat.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Public Interface

• frame-exit (method).
• start-climc (function).
• stop-climc (function).
• update-instance-for-redefined-class (method).

Internals

• %present (method).
• calls-of (reader method).
• (setf calls-of) (writer method).
• chat-of (reader method).
• (setf chat-of) (writer method).
• contacts-of (reader method).
• (setf contacts-of) (writer method).
• define-im-client-command (macro).
• display-contacts (generic function).
• get-email-message (function).
• im-client (class).
• im-of (reader method).
• (setf im-of) (writer method).
• launch-climc (function).
• presence-of (reader method).
• (setf presence-of) (writer method).
• reinitialize-panes-and-layouts (method).
• start-climc-app (function).
• update-xmpp-presence (generic function).
• xmpp-receive-message (generic function).
• xmpp-receive-presence (generic function).

---

4.1.10 climc/src/commands.lisp

Dependency

climc.lisp (file).

Source

climc.asd.

Parent Component

src (module).

Internals

• com-add-contact (function).
• com-add-contact%parser (function).
• com-quit (function).
• com-quit%parser (function).
• com-select-contact (function).
• com-select-contact%parser (function).
• com-xmpp-debug (function).
• com-xmpp-debug%parser (function).

---

6.1.1 Special variables

Special Variable: *debug* ¶

If T, active some logs.

Package

climc.

Source

specials.lisp.

---

6.1.2 Ordinary functions

Function: start-climc (&optional new-process-p) ¶

Package

climc.

Source

climc.lisp.

Function: stop-climc () ¶

Package

climc.

Source

climc.lisp.

---

6.1.3 Standalone methods

Method: frame-exit :before ((im-client im-client)) ¶

Package

clim.

Source

climc.lisp.

Method: redisplay-frame-pane :after ((frame redisplay-frame-mixin) (pane application-pane) &key force-p) ¶

Package

clim.

Source

tools.lisp.

Method: update-instance-for-redefined-class :after ((instance im-client) as ds pl &rest initargs) ¶

Source

climc.lisp.

Method: update-instance-for-redefined-class :after ((instance chat) as ds pl &rest initargs) ¶

Source

chat.lisp.

Method: update-instance-for-redefined-class :after ((instance xmpp-app) as ds pl &rest initargs) ¶

Source

xmpp.lisp.

---

6.2.1 Special variables

Special Variable: *climc-account* ¶

Package

climc.

Source

specials.lisp.

Special Variable: *climc-account-emails* ¶

Package

climc.

Source

specials.lisp.

Special Variable: *im-client* ¶

Package

climc.

Source

specials.lisp.

Special Variable: *im-client-process* ¶

Package

climc.

Source

specials.lisp.

Special Variable: *xmpp-app* ¶

Package

climc.

Source

specials.lisp.

Special Variable: *xmpp-presences* ¶

Package

climc.

Source

specials.lisp.

---

6.2.2 Macros

Macro: define-chat-command (name-and-options arguments &rest body) ¶

Package

climc.

Source

chat.lisp.

Macro: define-im-client-command (name-and-options arguments &rest body) ¶

Package

climc.

Source

climc.lisp.

Macro: define-xmpp-app-command (name-and-options arguments &rest body) ¶

Package

climc.

Source

xmpp.lisp.

---

6.2.3 Ordinary functions

Function: close-box-callback (button) ¶

Callback to close dialog box.

Package

climc.

Source

tools.lisp.

Function: close-chat-callback (button) ¶

Callback to close the chat box.

Package

climc.

Source

chat.lisp.

Function: com-add-contact () ¶

Package

climc.

Source

commands.lisp.

Function: com-add-contact%parser (arg del str) ¶

Package

climc.

Source

commands.lisp.

Function: com-quit () ¶

Package

climc.

Source

commands.lisp.

Function: com-quit%parser (arg del str) ¶

Package

climc.

Source

commands.lisp.

Function: com-select-contact (contact) ¶

Package

climc.

Source

commands.lisp.

Function: com-select-contact%parser (argument-parser0 delimiter-parser1 stream2) ¶

Package

climc.

Source

commands.lisp.

Function: com-xmpp-debug () ¶

Package

climc.

Source

commands.lisp.

Function: com-xmpp-debug%parser (arg del str) ¶

Package

climc.

Source

commands.lisp.

Function: display-xmpp-message (text) ¶

Package

climc.

Source

xmpp.lisp.

Function: get-climc-directory () ¶

Get the home directory of Climc.

Package

climc.

Source

tools.lisp.

Function: get-email-message (message) ¶

Package

climc.

Source

climc.lisp.

Function: input-message-callback (gadget) ¶

Callback invoked by the text input gadget when the user hits enter

Package

climc.

Source

chat.lisp.

Function: iso-time (&optional time) ¶

Returns the universal time TIME as a string in full ISO format.

Package

climc.

Source

tools.lisp.

Function: launch-climc (account &optional emails) ¶

Start the IM client.
‘ACCOUNT’ is a cons which contains username and password. ‘CONTACTS’ is a list of emails.

Package

climc.

Source

climc.lisp.

Function: make-button (label callback &key width height max-width min-width max-height min-height) ¶

Creates a new button.

Package

climc.

Source

tools.lisp.

Function: make-im (username password) ¶

Package

climc.

Source

im.lisp.

Function: redisplay-callback (app pane) ¶

Force ‘APP’ to redisplay the specified ‘PANE’.

Package

climc.

Source

tools.lisp.

Function: start-climc-app () ¶

Lunch the IM client.

Package

climc.

Source

climc.lisp.

---

6.2.4 Generic functions

Generic Reader: calls-of (object) ¶

Package

climc.

Methods

Reader Method: calls-of ((im-client im-client)) ¶

automatically generated reader method

Source

climc.lisp.

Target Slot

calls.

Generic Writer: (setf calls-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf calls-of) ((im-client im-client)) ¶

automatically generated writer method

Source

climc.lisp.

Target Slot

calls.

Generic Reader: chat-of (object) ¶

Package

climc.

Methods

Reader Method: chat-of ((im-client im-client)) ¶

automatically generated reader method

Source

climc.lisp.

Target Slot

chat.

Generic Writer: (setf chat-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf chat-of) ((im-client im-client)) ¶

automatically generated writer method

Source

climc.lisp.

Target Slot

chat.

Generic Reader: connection-of (object) ¶

Package

climc.

Methods

Reader Method: connection-of ((im im)) ¶

automatically generated reader method

Source

im.lisp.

Target Slot

connection.

Generic Writer: (setf connection-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf connection-of) ((im im)) ¶

automatically generated writer method

Source

im.lisp.

Target Slot

connection.

Generic Reader: contact-of (object) ¶

Package

climc.

Methods

Reader Method: contact-of ((chat chat)) ¶

automatically generated reader method

Source

chat.lisp.

Target Slot

contact.

Generic Writer: (setf contact-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf contact-of) ((chat chat)) ¶

automatically generated writer method

Source

chat.lisp.

Target Slot

contact.

Generic Reader: contacts-of (object) ¶

Generic Writer: (setf contacts-of) (object) ¶

Package

climc.

Methods

Reader Method: contacts-of ((im-client im-client)) ¶

Writer Method: (setf contacts-of) ((im-client im-client)) ¶

The available contacts.

Source

climc.lisp.

Target Slot

contacts.

Generic Function: display-chat (frame stream) ¶

Package

climc.

Methods

Method: display-chat ((frame chat) stream) ¶

Source

chat.lisp.

Generic Function: display-contacts (frame stream) ¶

Display account contacts.

Package

climc.

Source

climc.lisp.

Methods

Method: display-contacts ((frame im-client) stream) ¶

Generic Function: display-message (frame stream) ¶

Package

climc.

Methods

Method: display-message ((frame chat) stream) ¶

Source

chat.lisp.

Generic Reader: email-of (object) ¶

Package

climc.

Methods

Reader Method: email-of ((contact contact)) ¶

automatically generated reader method

Source

dao.lisp.

Target Slot

email.

Generic Writer: (setf email-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf email-of) ((contact contact)) ¶

automatically generated writer method

Source

dao.lisp.

Target Slot

email.

Generic Reader: im-of (object) ¶

Package

climc.

Methods

Reader Method: im-of ((im-client im-client)) ¶

automatically generated reader method

Source

climc.lisp.

Target Slot

im.

Generic Writer: (setf im-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf im-of) ((im-client im-client)) ¶

automatically generated writer method

Source

climc.lisp.

Target Slot

im.

Generic Reader: password-of (object) ¶

Package

climc.

Methods

Reader Method: password-of ((im im)) ¶

automatically generated reader method

Source

im.lisp.

Target Slot

password.

Generic Writer: (setf password-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf password-of) ((im im)) ¶

automatically generated writer method

Source

im.lisp.

Target Slot

password.

Generic Reader: presence-of (object) ¶

Package

climc.

Methods

Reader Method: presence-of ((im-client im-client)) ¶

automatically generated reader method

Source

climc.lisp.

Target Slot

presence.

Generic Writer: (setf presence-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf presence-of) ((im-client im-client)) ¶

automatically generated writer method

Source

climc.lisp.

Target Slot

presence.

Generic Function: send-message (im to text) ¶

Send a message ‘TEXT’ to a contact ‘TO’.

Package

climc.

Source

im.lisp.

Methods

Method: send-message ((im im) to text) ¶

Generic Function: send-presence-request (im presence) ¶

Send a XMPP request with ‘PRESENCE’ information.

Package

climc.

Source

im.lisp.

Methods

Method: send-presence-request ((im im) presence) ¶

Generic Function: start-im (im) ¶

Start the ‘IM’ client.

Package

climc.

Source

im.lisp.

Methods

Method: start-im ((im im)) ¶

Generic Reader: status-of (object) ¶

Package

climc.

Methods

Reader Method: status-of ((contact contact)) ¶

automatically generated reader method

Source

dao.lisp.

Target Slot

status.

Generic Writer: (setf status-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf status-of) ((contact contact)) ¶

automatically generated writer method

Source

dao.lisp.

Target Slot

status.

Generic Function: stop-im (im) ¶

Stop the ‘IM’.

Package

climc.

Source

im.lisp.

Methods

Method: stop-im ((im im)) ¶

Generic Function: update-xmpp-presence (im-client updated-presence) ¶

Send a XMPP request to update presence.

Package

climc.

Source

climc.lisp.

Methods

Method: update-xmpp-presence ((im-client im-client) updated-presence) ¶

Generic Reader: username-of (object) ¶

Package

climc.

Methods

Reader Method: username-of ((im im)) ¶

automatically generated reader method

Source

im.lisp.

Target Slot

username.

Generic Writer: (setf username-of) (object) ¶

Package

climc.

Methods

Writer Method: (setf username-of) ((im im)) ¶

automatically generated writer method

Source

im.lisp.

Target Slot

username.

Generic Function: xmpp-receive-message (client message) ¶

Handler for reception of a XMPP message.

Package

climc.

Source

climc.lisp.

Methods

Method: xmpp-receive-message ((im-client im-client) message) ¶

Generic Function: xmpp-receive-presence (im-client presence) ¶

Handler when the IM client receive a XMPP presence request.

Package

climc.

Source

climc.lisp.

Methods

Method: xmpp-receive-presence ((im-client im-client) presence) ¶

---

6.2.5 Standalone methods

Method: %present ((type-key contact) contact type stream view &key args) ¶

Package

clim-internals.

Source

climc.lisp.

Method: reinitialize-panes-and-layouts ((frame im-client)) ¶

Package

clim-internals.

Source

climc.lisp.

Method: reinitialize-panes-and-layouts ((frame chat)) ¶

Package

clim-internals.

Source

chat.lisp.

Method: reinitialize-panes-and-layouts ((frame xmpp-app)) ¶

Package

clim-internals.

Source

xmpp.lisp.

---

6.2.6 Classes

Class: chat ¶

Package

climc.

Source

chat.lisp.

Direct superclasses

• redisplay-frame-mixin.
• standard-application-frame.

Direct methods

• (setf contact-of).
• contact-of.
• display-chat.
• display-message.
• reinitialize-panes-and-layouts.
• update-instance-for-redefined-class.

Direct Default Initargs

Initarg	Value
:name	(quote chat)
:pretty-name	chat
:command-table	(find-command-table (quote chat))
:disabled-commands	(quote nil)
:menu-bar	(quote t)
:pointer-documentation	(quote nil)
:current-layout	(quote default)
:layouts	(quote ((default (vertically nil chat-pane (labelling (label message) message-text-field) ok-bt))))
:resize-frame	(quote nil)
:top-level-lambda	(lambda (frame-arg0) (default-frame-top-level frame-arg0))
:panes-constructor	(lambda (fm frame) (or (frame-panes-for-layout frame) (setf (frame-panes-for-layout frame) (with-look-and-feel-realization (fm frame) (list (cons (quote chat-pane) (make-clim-application-pane name (quote chat-pane) min-width 500 min-height 200 incremental-redisplay t display-function (function display-chat))) (cons (quote message-text-field) (make-pane (quote text-field) name (quote message-text-field) value min-width 500 activate-callback (quote input-message-callback))) (cons (quote ok-bt) (coerce-pane-name (make-button quit (quote close-chat-callback)) (quote ok-bt))))))))
:layout-constructor	(lambda (fm frame) (disown-frame-panes fm frame) (let ((named-panes (frame-panes-for-layout frame))) (declare (ignorable named-panes)) (let ((chat-pane (assoc-value named-panes (quote chat-pane) test (function eq))) (message-text-field (assoc-value named-panes (quote message-text-field) test (function eq))) (ok-bt (assoc-value named-panes (quote ok-bt) test (function eq)))) (declare (ignorable chat-pane message-text-field ok-bt)) (setf (frame-panes frame) (ecase (frame-current-layout frame) (default (vertically nil chat-pane (labelling (label message) message-text-field) ok-bt)))))) (adopt-frame-panes fm frame (frame-current-layout frame)) (update-frame-pane-lists frame))

Direct slots

Slot: contact ¶

Initargs

:contact

Readers

contact-of.

Writers

(setf contact-of).

Class: contact ¶

An IM contact.

Package

climc.

Source

dao.lisp.

Direct methods

• %present.
• (setf email-of).
• email-of.
• (setf status-of).
• status-of.

Direct slots

Slot: email ¶

Initargs

:email

Readers

email-of.

Writers

(setf email-of).

Slot: status ¶

Initform

""

Initargs

:status

Readers

status-of.

Writers

(setf status-of).

Class: im ¶

Package

climc.

Source

im.lisp.

Direct methods

• (setf connection-of).
• connection-of.
• (setf password-of).
• password-of.
• send-message.
• send-presence-request.
• start-im.
• stop-im.
• (setf username-of).
• username-of.

Direct slots

Slot: connection ¶

Initargs

:connection

Readers

connection-of.

Writers

(setf connection-of).

Slot: username ¶

Initargs

:username

Readers

username-of.

Writers

(setf username-of).

Slot: password ¶

Initargs

:password

Readers

password-of.

Writers

(setf password-of).

Class: im-client ¶

Package

climc.

Source

climc.lisp.

Direct superclasses

• redisplay-frame-mixin.
• standard-application-frame.

Direct methods

• (setf calls-of).
• calls-of.
• (setf chat-of).
• chat-of.
• (setf contacts-of).
• contacts-of.
• display-contacts.
• frame-exit.
• (setf im-of).
• im-of.
• (setf presence-of).
• presence-of.
• reinitialize-panes-and-layouts.
• update-instance-for-redefined-class.
• update-xmpp-presence.
• xmpp-receive-message.
• xmpp-receive-presence.

Direct Default Initargs

Initarg	Value
:name	(quote im-client)
:pretty-name	im-client
:command-table	(find-command-table (quote im-client))
:disabled-commands	(quote nil)
:menu-bar	(quote ((climc menu main-menu)))
:pointer-documentation	(quote nil)
:current-layout	(quote default)
:layouts	(quote ((default (vertically (equalize-width t equalize-height nil height 200 width 100) contacts-pane presence-pane))))
:resize-frame	(quote nil)
:top-level-lambda	(lambda (frame-arg0) (default-frame-top-level frame-arg0))
:panes-constructor	(lambda (fm frame) (or (frame-panes-for-layout frame) (setf (frame-panes-for-layout frame) (with-look-and-feel-realization (fm frame) (list (cons (quote contacts-pane) (make-clim-application-pane name (quote contacts-pane) min-width 100 max-width 250 min-height 100 max-height 400 incremental-redisplay t display-function (function display-contacts))) (cons (quote presence-pane) (coerce-pane-name (make-pane (quote option-pane) width 70 min-width 70 min-height 100 max-height 100 items *xmpp-presences* value (first *xmpp-presences*) value-changed-callback (lambda (gadget value) (update-xmpp-presence *im-client* value))) (quote presence-pane))) (cons (quote xmpp-pane) (make-clim-application-pane name (quote xmpp-pane) min-width 100 max-width 250 min-height 100 max-height 400 incremental-redisplay t)))))))
:layout-constructor	(lambda (fm frame) (disown-frame-panes fm frame) (let ((named-panes (frame-panes-for-layout frame))) (declare (ignorable named-panes)) (let ((contacts-pane (assoc-value named-panes (quote contacts-pane) test (function eq))) (presence-pane (assoc-value named-panes (quote presence-pane) test (function eq))) (xmpp-pane (assoc-value named-panes (quote xmpp-pane) test (function eq)))) (declare (ignorable contacts-pane presence-pane xmpp-pane)) (setf (frame-panes frame) (ecase (frame-current-layout frame) (default (vertically (equalize-width t equalize-height nil height 200 width 100) contacts-pane presence-pane)))))) (adopt-frame-panes fm frame (frame-current-layout frame)) (update-frame-pane-lists frame))

Direct slots

Slot: im ¶

Initargs

:im

Readers

im-of.

Writers

(setf im-of).

Slot: presence ¶

Initform

(first climc::*xmpp-presences*)

Initargs

:presence

Readers

presence-of.

Writers

(setf presence-of).

Slot: chat ¶

Initargs

:chat

Readers

chat-of.

Writers

(setf chat-of).

Slot: contacts ¶

The available contacts.

Initform

(quote nil)

Initargs

:contacts

Readers

contacts-of.

Writers

(setf contacts-of).

Slot: calls ¶

Initargs

:calls

Readers

calls-of.

Writers

(setf calls-of).

Class: redisplay-frame-mixin ¶

Package

climc.

Source

tools.lisp.

Direct subclasses

• chat.
• im-client.
• xmpp-app.

Direct methods

redisplay-frame-pane.

Class: xmpp-app ¶

Package

climc.

Source

xmpp.lisp.

Direct superclasses

• redisplay-frame-mixin.
• standard-application-frame.

Direct methods

• reinitialize-panes-and-layouts.
• update-instance-for-redefined-class.

Direct Default Initargs

Initarg	Value
:name	(quote xmpp-app)
:pretty-name	xmpp-app
:command-table	(find-command-table (quote xmpp-app))
:disabled-commands	(quote nil)
:menu-bar	(quote t)
:pointer-documentation	(quote nil)
:current-layout	(quote default)
:layouts	(quote ((default (vertically (equalize-width nil equalize-height nil width 500 height 200) xmpp-pane ok-bt))))
:resize-frame	(quote nil)
:top-level-lambda	(lambda (frame-arg0) (default-frame-top-level frame-arg0))
:panes-constructor	(lambda (fm frame) (or (frame-panes-for-layout frame) (setf (frame-panes-for-layout frame) (with-look-and-feel-realization (fm frame) (list (cons (quote xmpp-pane) (make-clim-application-pane name (quote xmpp-pane) min-width 500 min-height 200 incremental-redisplay t)) (cons (quote ok-bt) (coerce-pane-name (make-button ok (quote close-box-callback)) (quote ok-bt))))))))
:layout-constructor	(lambda (fm frame) (disown-frame-panes fm frame) (let ((named-panes (frame-panes-for-layout frame))) (declare (ignorable named-panes)) (let ((xmpp-pane (assoc-value named-panes (quote xmpp-pane) test (function eq))) (ok-bt (assoc-value named-panes (quote ok-bt) test (function eq)))) (declare (ignorable xmpp-pane ok-bt)) (setf (frame-panes frame) (ecase (frame-current-layout frame) (default (vertically (equalize-width nil equalize-height nil width 500 height 200) xmpp-pane ok-bt)))))) (adopt-frame-panes fm frame (frame-current-layout frame)) (update-frame-pane-lists frame))

---