Sat Apr 3 21:12:53 CEST 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>

* KDE is split up in kde.ui and kde.core.

+ <note>

+ <para>

+ There are also the following repositories: qt.svg qt.dbus kde.core kde.ui kde.tests kde.examples

+ </para>

+ </note>

-<caution>

- The KDE bindings are not yet split up in <package>kde.core</package>

- etc. and thus are currently not functional.

+To use the KDE libraries use the <package>:cl-smoke.kde.ui</package>

+(Depends on <package>:cl-smoke.kde.core</package>).

-</caution>

-Besides the <package>:kde</package> package there

+Besides these packages there

-(mb:load <package>:kde.examples</package>)

+(asdf:oos 'asdf:load-op <package>:cl-smoke.kde.examples</package>)

+<para>

+Custom <methodname>cxx:paint-event</methodname> methods can use <macro>qt:with-painter</macro>

+to ensure that the <classname>qt:painter</classname> is deactivated at the end of the method.

+</para>

+

Sat Apr 3 21:12:32 CEST 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>

* C++ member variable access

+<section id="members"><title>Member variables</title>

+<para>

+C++ member variables of an instance can be accessed by using <code>slot-value</code>; e.g.:

+<informalexample>

+<programlisting language="lisp">(slot-value (make-instance 'qt:object) :static-meta-object)</programlisting>

+</informalexample>

+or

+<informalexample>

+<programlisting language="lisp">(slot-value (find-class 'qt:object) :static-meta-object)</programlisting>

+</informalexample>

+Usually they can also be accessed using methods from the <package>:cxx</package> package.

+</para>

+</section>

+

Sun Jan 10 09:57:54 CET 2010 Tobias Rautenkranz <tobias@rautenkranz.ch>

* modular smoke.

- <listitem><para>10 seconds startup time<footnote>

+ <listitem><para>6 seconds startup time<footnote>

- Pentium M 1.7GHz. (Compilation ~20 seconds)</para></listitem>

+ Pentium M 1.7GHz. </para></listitem>

- bindings from svn; r1061660 or later

+ bindings from svn.

- <listitem><para>a make program (preferably Gnu Make)</para></listitem>

-for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit qt.phonon; do

+for r in smoke qt.core qt.gui qt.network qt.test qt.tests qt.examples qt.uitools qt.webkit qt.phonon; do

- Build and install the <package>:smoke</package> and <package>:qt</package> C wrapper libraries with:

+ Build and install the <package>:smoke</package> and <package>:qt.core</package> C wrapper libraries with:

- should be able to load the systems.

+ should be able to load the systems. The system name has a

+ <code>:cl-smoke.</code> prefix. e.g.:

+ <informalexample>

+ <programlisting language="lisp">(asdf:oos 'asdf:load-op :cl-smoke.qt.examples) </programlisting>

+ </informalexample>

+<caution>

+<para>

+ The KDE bindings are not yet split up in <package>kde.core</package>

+ etc. and thus are currently not functional.

+</para>

+</caution>

-Besides the <package>:qt</package> there are these modules: with

+Besides the <package>:cl-smoke.qt.gui</package> there are these modules:

- <package>:qt.uitools</package>

+ <package>:cl-smoke.qt.uitools</package>

- <listitem><para><package>:qt.test</package>

+ <listitem><para><package>:cl-smoke.qt.test</package>

- <listitem><para><package>:qt.webkit</package>

+ <listitem><para><package>:cl-smoke.qt.webkit</package>

- <listitem><para><package>:qt.phonon</package>

+ <listitem><para><package>:cl-smoke.qt.phonon</package>

+ <listitem><para><package>:cl-smoke.qt.network</package>

+ The network classes of Qt.

+ </para></listitem>

+ <listitem><para><package>:cl-smoke.qt.core</package>

+ the nogui Qt core.

+ </para></listitem>

-Additionally there is the <package>:qt.tests</package> system, containing

-the unit tests and <package>:qt.examples</package> for various examples.

+Additionally there is the <package>:cl-smoke.qt.tests</package> system, containing

+the unit tests and <package>:cl-smoke.qt.examples</package> for various examples.

-in the <filename class="directory">src/</filename> directory of <package>:qt.examples</package> on how to do this.

+in the <filename class="directory">src/</filename> directory of <package>:cl-smoke.qt.examples</package> on how to do this.

-(mb:load <package>:qt.examples</package>)

+(asdf:oos 'asdf:load-op <package>:cl-smoke.qt.examples</package>)

-<para>Qt Classes browser using <package>:qt.webkit</package> to display the

+<para>Qt Classes browser using <package>:cl-smoke.qt.webkit</package> to display the

Sun Dec 13 14:22:09 CET 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* remove mudballs

-<xsl:import href="link-apidoc.xsl" />

+<xsl:import href="nonlink-apidoc.xsl" />

- bindings from svn; r1015073 or later

+ bindings from svn; r1061660 or later

-On the Lisp side you need <ulink url="http://mudballs.com">Mudballs</ulink>

-and <ulink url="http://tobias.rautenkranz.ch/lisp/sysdef.cmake">sysdef.cmake</ulink>.

-</para>

-<para>

-If you prefer to use <ulink url="http://common-lisp.net/project/asdf/">ASDF</ulink> instead of Mudballs, you need these systems:

- For loading the systems you can use Mudballs or ASDF. But first get the sources:

-</para>

-<para>

-for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit qt.phonon kde kde.tests kde.examples repl; do

+for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit qt.phonon; do

- <section><title>Mudballs</title>

- Then add the directory <userinput>SOME_DIR</userinput> to the mudballs search paths by adding

- <programlisting>

-(push (wildcard-searcher "<userinput>SOME_DIR</userinput>/*/*.mbd")

- *custom-search-modules*)

- </programlisting>

- to <filename>~/.mudballs</filename>.

-</para>

-<note>

-<para>

- Loading the packages with <code>mb:load</code> compiles the C wrapper libraries as needed.

-</para>

-</note>

- </section>

-

- <section><title>ASDF</title>

- <para>

- The <code>.asd</code> files are

- <ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=mudballs-to-asdf;a=summary">generated</ulink>

- from the mudballs files. [_$_]

- <ulink url="http://tobias.rautenkranz.ch/lisp/cl-smoke/cl-smoke-asd.tar.bz2">Get the <code>.asd</code> files</ulink> and

- place them in the corresponding source directories. Then symlink the <code>.asd</code> files in a ASDF search path.

- You can for example run: <code>ln -s <userinput>SOME_DIR/*/*.asd</userinput> <userinput>ASDF_PATH</userinput></code>

- </para>

- <para>

- Now build and install the <package>:smoke</package> and <package>:qt</package> C wrapper libraries with:

+ Build and install the <package>:smoke</package> and <package>:qt</package> C wrapper libraries with:

- <note><para>

- Some examples get the paths for the files to load from their Mudballs system (ui and i18n) and thus will not work.

- </para></note>

- </section>

+ <para>

+ When you have symlinked the <filename>.asd</filename> system files, you

+ should be able to load the systems.

+ </para>

-<xsl:import href="link-apidoc.xsl"/>

+<xsl:import href="nonlink-apidoc.xsl"/>

+<?xml version='1.0'?> [_$_]

+<!--

+Copyright 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

+

+Permission is hereby granted, free of charge, to any person

+obtaining a copy of this software and associated documentation

+files (the "Software"), to deal in the Software without

+restriction, including without limitation the rights to use,

+copy, modify, merge, publish, distribute, sublicense, and/or sell

+copies of the Software, and to permit persons to whom the

+Software is furnished to do so, subject to the following

+conditions:

+

+The above copyright notice and this permission notice shall be

+included in all copies or substantial portions of the Software.

+

+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

+OTHER DEALINGS IN THE SOFTWARE. [_$_]

+!-->

+

+<xsl:stylesheet version="1.0"

+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> [_$_]

+

+

+<xsl:template match="macro">

+ <xsl:call-template name="ulink">

+ </xsl:call-template>

+</xsl:template>

+

+<xsl:template match="genericfunction">

+ <xsl:call-template name="ulink">

+ </xsl:call-template>

+</xsl:template>

+

+</xsl:stylesheet>

-For OpenGL an binding is needed (e.g.: [_$_]

+For OpenGL a binding is needed (e.g.: [_$_]

-Because <ulink url="http://common-lisp.net/project/cl-opengl/">cl-opengl</ulink> is need to

-run the example, but is not in mudballs; the origami example is not included in the mudballs system.

-<ulink url="http://axiom-wiki.newsynthesis.org/FrontPage">Axiom</ulink> is needed for building.

+<ulink url="http://axiom-wiki.newsynthesis.org/FrontPage">Axiom</ulink> is needed to generate the lisp source to that

+calculates the vertices.

-<section id="commonqt"><title>CommonQt</title>

-<para><ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/commonqt">:cl-smoke.commonqt</ulink>

-is an experimental compatibility layer to run Lisp code using the

-<ulink url="http://common-lisp.net/project/commonqt/">CommonQt</ulink> API with cl-smoke.

-It is incomplete, but implementing the missing pieces should be straight forward.

-</para>

-<screenshot>

-<mediaobject>

-<imageobject>

- <imagedata fileref="commonqt-t14.png" format="PNG"/>

-</imageobject>

-<caption>

-<para>CommonQt tutorial 14

-<filename><ulink url="http://repo.or.cz/w/commonqt.git?a=blob;f=tutorial/t14.lisp;hb=HEAD">t14.lisp</ulink></filename>

-running with <code>:cl-smoke.commonqt</code>.

-</para>

-</caption>

-</mediaobject>

-</screenshot>

-</section>

-

Wed Sep 2 14:08:06 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* cl-smoke now supports user conversions for return values.

-<para>

-User defined conversions for return values are currently not supported (in <code>defmethods</code>).

-</para>

Sun Aug 30 16:26:13 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Multiple inheritance doc & expand tabs in programmlisting.

- <listitem><para>

- <package>:qt.uitools</package>

- <ulink url="http://doc.trolltech.com/4.5/qtuitools.html">

- QtUiTools</ulink></para></listitem>

- <listitem><para><package>:qt.test</package>

- <ulink url="http://doc.trolltech.com/4.5/qttest.html">

- QtTest</ulink></para></listitem>

- <listitem><para><package>:qt.webkit</package>

- <ulink url="http://doc.trolltech.com/4.5/qtwebkit.html">

- QtWebKit</ulink>

- </para></listitem>

- <listitem><para><package>:qt.phonon</package>

- <ulink url="http://doc.trolltech.com/4.5/phonon.html">

- Phonon</ulink>

- </para></listitem>

+ <listitem><para>

+ <package>:qt.uitools</package>

+ <ulink url="http://doc.trolltech.com/4.5/qtuitools.html">

+ QtUiTools</ulink></para></listitem>

+ <listitem><para><package>:qt.test</package>

+ <ulink url="http://doc.trolltech.com/4.5/qttest.html">

+ QtTest</ulink></para></listitem>

+ <listitem><para><package>:qt.webkit</package>

+ <ulink url="http://doc.trolltech.com/4.5/qtwebkit.html">

+ QtWebKit</ulink>

+ </para></listitem>

+ <listitem><para><package>:qt.phonon</package>

+ <ulink url="http://doc.trolltech.com/4.5/phonon.html">

+ Phonon</ulink>

+ </para></listitem>

- <imagedata fileref="hello-world.png" format="PNG"/>

+ <imagedata fileref="hello-world.png" format="PNG"/>

-</programlisting>[_^I_][_$_]

+</programlisting> [_$_]

- (setf (<methodname>qt:property</methodname> object :object-name) "Foo")

- (assert (string= "Foo" (<methodname>qt:property</methodname> object "objectName"))))

+ (setf (<methodname>qt:property</methodname> object :object-name) "Foo")

+ (assert (string= "Foo" (<methodname>qt:property</methodname> object "objectName"))))

- <imagedata fileref="i18n-hello-world.png" format="PNG"/>

+ <imagedata fileref="i18n-hello-world.png" format="PNG"/>

-</programlisting>[_^I_][_$_]

+</programlisting> [_$_]

-</programlisting>[_^I_][_$_]

+</programlisting> [_$_]

- <imagedata fileref="repl.png" format="PNG"/>

+ <imagedata fileref="repl.png" format="PNG"/>

-</programlisting>[_^I_][_$_]

+</programlisting> [_$_]

- <imagedata fileref="class-browser.png" format="PNG"/>

+ <imagedata fileref="class-browser.png" format="PNG"/>

-</programlisting>[_^I_][_$_]

+</programlisting> [_$_]

- <imagedata fileref="commonqt-t14.png" format="PNG"/>

+ <imagedata fileref="commonqt-t14.png" format="PNG"/>

- (make-instance '<classname>qt:object</classname> :args (list parent)))

+ (make-instance '<classname>qt:object</classname> :args (list parent)))

- (make-instance '<classname>qt:object</classname> :arg0 parent))

+ (make-instance '<classname>qt:object</classname> :arg0 parent))

- ()

- (:metaclass <classname>cxx:class</classname>))

+ ()

+ (:metaclass <classname>cxx:class</classname>))

+

+(make-instance 'my-object)

+</programlisting>

+</informalexample>

+The first superclass must be a Smoke class. When you define a class that has several Smoke superclasses,

+they will be constructed with their default constructor. For the first Smoke superclass you can supply arguments

+with the <code>:args</code> and <code>:arg0</code> etc. keywords.

+<informalexample>

+<programlisting language="lisp">

+(defclass my-graphics-object (<classname>qt:object</classname> <classname>qt:graphics-item</classname>)

+ ()

+ (:metaclass <classname>cxx:class</classname>))

- ()

- (:metaclass <classname>cxx:class</classname>))

+ ()

+ (:metaclass <classname>cxx:class</classname>))

- (declare (ignore object event))

- (call-next-method))

+ (declare (ignore object event))

+ (call-next-method))

- C++ Class enums available as constants. E.g.:

- <code>QColor::Rgb</code> is <constant>qt:color.+rgb+</constant>.

- See <package>:cxx-support</package>.

+ C++ Class enums available as constants. E.g.:

+ <code>QColor::Rgb</code> is <constant>qt:color.+rgb+</constant>.

+ See <package>:cxx-support</package>.

- Ownership transfer for non QObject instances is mostly unimplemented.

+ Ownership transfer for non QObject instances is mostly unimplemented.

Thu Aug 27 13:47:08 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Update for the new smokegenerator

- <listitem><para>No const-correctness</para></listitem>

- bindings 4.2 or later</para></listitem>

+ bindings from svn; r1015073 or later

+ <footnote><para>

+ The new smokegenerator is needed (developed by Arno Rehn for the GSOC 09).

+ </para></footnote>

+ </para></listitem>

-

Sun Aug 2 13:24:57 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Remove wrong note about cxx:meta-object

-An instance may depend on an other one.

-It is a bad idea to do something like this:

-<programlisting language="lisp">

-(defvar *meta* (<genericfunction>cxx:meta-object</genericfunction> (make-instance 'qt:object)))

-</programlisting>

-<code>*meta*</code> references a <classname>qt:meta-class</classname>

-that can become invalid at any time, since the <classname>qt:object</classname> instance can

-be garbage collected, and then the <code>QMetaObject</code> instance is deleted along

-with the <code>QObject</code>.

-</para>

-</caution>

-<caution>

-<para>

Thu Jul 23 00:59:59 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* add phonon repository

-for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit kde kde.tests kde.examples repl; do

+for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit qt.phonon kde kde.tests kde.examples repl; do

Thu Jul 23 00:53:41 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* phonon & :arg0

- Using an image it is around 1 second.

+ Using a core image it is around 1 second.

-Besides the <package>:qt</package> there are these packages: with

+Besides the <package>:qt</package> there are these modules: with

+ <listitem><para><package>:qt.phonon</package>

+ <ulink url="http://doc.trolltech.com/4.5/phonon.html">

+ Phonon</ulink>

+ </para></listitem>

-which provide bindings for their Qt module.

+which provide bindings for their Qt module. The class names of this modules are in

+the <package>:qt</package> package. (E.g. Phonon::VideoPlayer is <code>'qt:phonon.video-player</code>

+and QTest is <code>'qt:test</code>)

+</para>

+<para>

+The predefined Qt properties can be accessed with symbols in the keyword package.

- (setf (<methodname>qt:property</methodname> object 'object-name) "Foo")

+ (setf (<methodname>qt:property</methodname> object :object-name) "Foo")

+or use <code>:arg0</code>, <code>:arg1</code> and <code>:arg2</code>.

+<informalexample>

+<programlisting language="lisp">

+(let ((parent (make-instance '<classname>qt:object</classname>)))

+ (make-instance '<classname>qt:object</classname> :arg0 parent))

+</programlisting>

+</informalexample>

Mon Jul 6 23:51:20 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* OpenGL: origami

-<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/chunk.xsl"/>

-<xsl:import href="link-apidoc.xsl"/>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/chunk.xsl" />

+<xsl:import href="link-apidoc.xsl" />

-<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/highlight.xsl"/>

-<xsl:param name="highlight.source" select="1"/>

+<xsl:import href="video.xsl" />

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/highlight.xsl" />

+

+<xsl:param name="highlight.source" select="1" />

-<xsl:param name="use.id.as.filename" select="1"/>

+<xsl:param name="use.id.as.filename" select="1" />

-<section><title>Limitations</title>

+<section id="limitations"><title>Limitations</title>

-<section><title>Installation</title>

+<section id="installation"><title>Installation</title>

-<section><title>Examples</title>

+<section id="kde_examples"><title>Examples</title>

-<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl"/>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/docbook.xsl"/>

-<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/highlight.xsl"/>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/html/highlight.xsl"/>

+

+<xsl:import href="video.xsl" />

+

+

-<section><title>qt:application</title>

+<section id="qapplication"><title>qt:application</title>

-<section><title>Signal-Slot</title>

+<section id="signal_slot"><title>Signal-Slot</title>

-<section><title>Properties</title>

+<section id="properties"><title>Properties</title>

-<section><title>Variant</title>

+<section id="variant"><title>Variant</title>

-<section><title>i18n</title>

+<section id="i18n"><title>i18n</title>

-<section><title>Examples</title>

+<section id="qt_examples"><title>Examples</title>

-<section><title>CommonQt</title>

+<section id="opengl"><title>OpenGL</title>

+<para>

+For OpenGL an binding is needed (e.g.: [_$_]

+<ulink url="http://common-lisp.net/project/cl-opengl/">cl-opengl</ulink>).

+</para>

+<example><title>Origami</title>

+<para>

+<ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/qt.examples;a=tree;f=/src/origami">Origami</ulink>

+draws a pleated hyperbolic paraboloid using the method described in

+<ulink url="http://arxiv.org/abs/0906.4747">(Non)existence of Pleated Folds: How Paper Folds Between Creases</ulink>

+</para>

+<mediaobject>

+<videoobject>

+<videodata fileref='origami.ogg'/>

+</videoobject>

+</mediaobject>

+<para>

+<note>

+<para>

+Because <ulink url="http://common-lisp.net/project/cl-opengl/">cl-opengl</ulink> is need to

+run the example, but is not in mudballs; the origami example is not included in the mudballs system.

+<ulink url="http://axiom-wiki.newsynthesis.org/FrontPage">Axiom</ulink> is needed for building.

+</para>

+</note>

+</para>

+</example>

+</section>

+

+<section id="commonqt"><title>CommonQt</title>

-<chapter id="smoke"> [_$_]

+<chapter id="usage"> [_$_]

-<section><title>Class</title>

+<section id="classes"><title>Class</title>

-<section><title>Methods</title>

+<section id="methods"><title>Methods</title>

-<section><title>Static Methods</title>

+<section id="static_methods"><title>Static Methods</title>

-<section><title>Constants</title>

+<section id="constants"><title>Constants</title>

-<section><title>Garbage Collection</title>

+<section id="gc"><title>Garbage Collection</title>

+<?xml version='1.0'?> [_$_]

+<xsl:stylesheet version="1.0"

+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> [_$_]

+

+<!-- this barely works -->

+<xsl:template match="videodata">

+ <video controls="true">

+ <xsl:attribute name="src">

+ <xsl:value-of select="@fileref" />

+ </xsl:attribute>

+ <img>

+ <xsl:attribute name="src">

+ <xsl:value-of select="concat(substring-before(@fileref, 'ogg'),'png')" />

+ </xsl:attribute>

+ </img>

+ <p>

+ <a>

+ <xsl:attribute name="href">

+ <xsl:value-of select="@fileref" />

+ </xsl:attribute>

+ <xsl:text>Download Video</xsl:text>

+ </a>

+ </p>

+ </video>

+</xsl:template>

+

+</xsl:stylesheet>

Fri Jul 3 00:28:43 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* cl-smoke.commonqt & Clozure CL support

- </itemizedlist>

-</section>

-<section><title>Partial</title>

- <itemizedlist>

- <ulink url="http://trac.clozure.com/openmcl">Clozure CL</ulink> support is currently broken.

+ <ulink url="http://trac.clozure.com/openmcl">Clozure CL</ulink> on Linux x86.

- You can for examples run: <code>ln -s <userinput>SOME_DIR/*/*.asd</userinput> <userinput>ASDF_PATH</userinput></code>

+ You can for example run: <code>ln -s <userinput>SOME_DIR/*/*.asd</userinput> <userinput>ASDF_PATH</userinput></code>

- <programlisting>

- cmake ./ &amp;&amp; make &amp;&amp; sudo make install

- </programlisting>

+ <programlisting>cmake ./ &amp;&amp; make &amp;&amp; sudo make install</programlisting>

+<section><title>CommonQt</title>

+<para><ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/commonqt">:cl-smoke.commonqt</ulink>

+is an experimental compatibility layer to run Lisp code using the

+<ulink url="http://common-lisp.net/project/commonqt/">CommonQt</ulink> API with cl-smoke.

+It is incomplete, but implementing the missing pieces should be straight forward.

+</para>

+<screenshot>

+<mediaobject>

+<imageobject>

+ <imagedata fileref="commonqt-t14.png" format="PNG"/>

+</imageobject>

+<caption>

+<para>CommonQt tutorial 14

+<filename><ulink url="http://repo.or.cz/w/commonqt.git?a=blob;f=tutorial/t14.lisp;hb=HEAD">t14.lisp</ulink></filename>

+running with <code>:cl-smoke.commonqt</code>.

+</para>

+</caption>

+</mediaobject>

+</screenshot>

+</section>

+

Sun Jun 21 11:29:52 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Link Benchmark

+<section><title>Performance</title>

+<para>

+Method calling is near 3000 times slower than native C++. The overhead is mainly in the overload

+resolution and to/from foreign object translation. Some measurements by

+<code><ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=cl-smoke/benchmark;a=summary">:cl-smoke.benchmark</ulink></code>

+are in

+<filename><ulink url="../benchmark.pdf">benchmark.pdf</ulink></filename>.

+</para>

+</section>

- <ulink url="http://trac.clozure.com/openmcl">Clozure CL</ulink>

- <footnote><para>There are some test suite failures and [_$_]

- it is to slow to be usable.</para></footnote>on Linux x86.

+ <ulink url="http://trac.clozure.com/openmcl">Clozure CL</ulink> support is currently broken.

Wed Jun 10 14:17:14 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* better Lisp source highlighting

+ <highlighter type="word">

+ <word>call-next-method</word>

+ <word>do-external-symbols</word>

+ <word>do</word>

+ <word>do*</word>

+ <word>eval-when</word>

+ <word>handler-bind</word>

+ <word>handler-case</word>

+ <word>in-package</word>

+ <word>let*</word>

+ <word>multiple-value-bind</word>

+ <word>restart-bind</word>

+ <word>restart-case</word>

+ <word>return-from</word>

+ <word>signal</word>

+ <word>unwind-protect</word>

+

+ <style>keyword</style>

+ <ignoreCase />

+ </highlighter>

- <keyword>defun</keyword>

+ <keyword>assert</keyword>

+ <keyword>block</keyword>

+ <keyword>case</keyword>

+ <keyword>catch</keyword>

+ <keyword>ccase</keyword>

+ <keyword>cerror</keyword>

+ <keyword>check-type</keyword>

+ <keyword>declaim</keyword>

+ <keyword>declare</keyword>

+ <keyword>defclass</keyword>

+ <keyword>defconstant</keyword>

+ <keyword>define-condition</keyword>

+ <keyword>defmacro</keyword>

- <keyword>lambda</keyword>

-

- <keyword>if</keyword>

- <keyword>when</keyword>

- <keyword>unless</keyword>

-

- <keyword>let</keyword>

- <keyword>let*</keyword>

-

- <keyword>defvar</keyword>

- <keyword>defparameter</keyword>

-

- <keyword>defclass</keyword>

+ <keyword>defparameter</keyword>

-

- <keyword>declare</keyword>

- <keyword>declaim</keyword>

+ <keyword>deftype</keyword>

+ <keyword>defun</keyword>

+ <keyword>defvar</keyword>

+ <keyword>dolist</keyword>

+ <keyword>dotimes</keyword>

+ <keyword>ecase</keyword>

+ <keyword>error</keyword>

+ <keyword>flet</keyword>

+ <keyword>go</keyword>

+ <keyword>if</keyword>

+ <keyword>labels</keyword>

+ <keyword>lambda</keyword>

+ <keyword>let</keyword>

+ <keyword>loop</keyword>

+ <keyword>prog1</keyword>

+ <keyword>prog2</keyword>

+ <keyword>progn</keyword>

+ <keyword>progv</keyword>

+ <keyword>return</keyword>

+ <keyword>tagbody</keyword>

+ <keyword>throw</keyword>

+ <keyword>typecase</keyword>

+ <keyword>unless</keyword>

+ <keyword>warn</keyword>

+ <keyword>when</keyword>

+

- <highlighter type="word">

- <word>in-package</word>

+ <!-- with- -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=\()(\S+[:])?(with-\S+)</pattern>

- <!-- defined symbols -->

+ <!-- lambda list keywords -->

+ <highlighter type="word">

+ <word>&amp;allow-other-keys</word>

+ <word>&amp;aux</word>

+ <word>&amp;body</word>

+ <word>&amp;environment</word>

+ <word>&amp;key</word>

+ <word>&amp;optional</word>

+ <word>&amp;rest</word>

+ <word>&amp;whole</word>

+

+ <style>attribute</style>

+ <ignoreCase />

+ </highlighter>

+

+ <!-- emacs style highlighted names -->

+ <flags>CASE_INSENSITIVE</flags>

+ <!-- defmacro -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defmacro\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defparameter -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defconstant\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

-

- <!-- numbers [_$_]

- TODO does not work? -->

- <highlighter type="number">

- <point>.</point>

- <exponent>d</exponent> <!-- double-float -->

- <exponent>e</exponent> <!-- float -->

- <exponent>f</exponent> <!-- single-float -->

- <exponent>l</exponent> <!-- long-float -->

- <exponent>s</exponent> <!-- short-float -->

- <ignoreCase />

- </highlighter>

- <!-- numbers -->

- <highlighter type="hexnumber">

- <prefix>#x</prefix>

- <ignoreCase />

+ <!-- define-condition -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=define-condition\s)(\S+)</pattern>

+ <style>directive</style>

Fri Jun 5 16:17:33 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* Lisp syntax highlighting

-# xmllint xsltproc docbook

+# - xmllint

+# - saxon

+# - docbook

+# - xslthl

+# Debian: download the xslthl jar into the doc/ directory; install the remaining dependancies with apt.

+#

+

+SAXON_JAR := /usr/share/java/saxon.jar

+XSLTHL_JAR := $(firstword $(wildcard xslthl*.jar))

+CLASSPATH := "$(SAXON_JAR):$(XSLTHL_JAR)"

+SAXON := java -classpath $(CLASSPATH) \

+ -Dxslthl.config="file://$(realpath xslthl-config.xml)" \

+ com.icl.saxon.StyleSheet

-manual.html: $(DEPENDANCIES)

- xmllint --xinclude --postvalid manual.xml > /dev/null

- xsltproc --xinclude -o $@ manual.xsl manual.xml

+# validate & process xincludes

+manual.tmp: $(DEPENDANCIES)

+ xmllint --xinclude --postvalid manual.xml > manual.tmp

+

+

+manual.html: manual.tmp

+ $(SAXON) -o manual.html manual.tmp manual.xsl

-index.html: $(DEPENDANCIES)

-# xsltproc --xinclude --stringparam base.dir "manual/" chunk.xsl manual.xml

- xsltproc --xinclude chunk.xsl manual.xml

-[_^I_][_$_]

+index.html: manual.tmp

+ $(SAXON) manual.tmp chunk.xsl

- rm -f -- *.html

+ rm -f -- *.html *.tmp

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/highlight.xsl"/>

+<xsl:param name="highlight.source" select="1"/>

+

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

+<?xml version="1.0" encoding="UTF-8"?>

+<!-- Common Lisp highlighter for xslthl -->

+<highlighters>

+ <highlighter type="keywords">

+ <keyword>defun</keyword>

+ <keyword>defgeneric</keyword>

+ <keyword>defmethod</keyword>

+ <keyword>lambda</keyword>

+

+ <keyword>if</keyword>

+ <keyword>when</keyword>

+ <keyword>unless</keyword>

+

+ <keyword>let</keyword>

+ <keyword>let*</keyword>

+

+ <keyword>defvar</keyword>

+ <keyword>defparameter</keyword>

+ <keyword>defpackage</keyword>

+

+ <keyword>defclass</keyword>

+ <keyword>defstruct</keyword>

+

+ <keyword>declare</keyword>

+ <keyword>declaim</keyword>

+ <keyword>proclaim</keyword>

+ <ignoreCase />

+ </highlighter>

+ <highlighter type="word">

+ <word>in-package</word>

+ <style>keyword</style>

+ </highlighter>

+

+ <!-- comments -->

+ <highlighter type="multiline-comment">

+ <start>#|</start>

+ <end>|#</end>

+ <style>comment</style>

+ </highlighter>

+ <highlighter type="oneline-comment">

+ ;

+ </highlighter>

+

+ <!-- string -->

+ <highlighter type="string">

+ <string>"</string>

+ <spanNewLines/>

+ </highlighter>

+

+ <!-- keyword package -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=[ \(])(:[^\s\)]+)</pattern>

+ <style>attribute</style>

+ </highlighter>

+

+ <!-- defined symbols -->

+ <!-- defclass -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defclass\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defun -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defun\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defgeneric -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defgeneric\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defmethod -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defmethod\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defvar -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defvar\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defparameter -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defparameter\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+ <!-- defstruct -->

+ <highlighter type="regex">

+ <pattern>(?&lt;=defstruct\s)(\S+)</pattern>

+ <style>directive</style>

+ </highlighter>

+

+ <!-- numbers [_$_]

+ TODO does not work? -->

+ <highlighter type="number">

+ <point>.</point>

+ <exponent>d</exponent> <!-- double-float -->

+ <exponent>e</exponent> <!-- float -->

+ <exponent>f</exponent> <!-- single-float -->

+ <exponent>l</exponent> <!-- long-float -->

+ <exponent>s</exponent> <!-- short-float -->

+ <ignoreCase />

+ </highlighter>

+ <!-- numbers -->

+ <highlighter type="hexnumber">

+ <prefix>#x</prefix>

+ <ignoreCase />

+ </highlighter>

+</highlighters>

+<xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/highlight.xsl"/>

+<xsl:param name="highlight.source" select="1"/>

+

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting language="po">

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>(frob my-instance 1)</programlisting>

+<programlisting language="lisp">(frob my-instance 1)</programlisting>

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>

+<programlisting language="lisp">

-<programlisting>(defclass the-object-does-nothing (<classname>qt:object</classname>)

+<programlisting language="lisp">(defclass the-object-does-nothing (<classname>qt:object</classname>)

-<programlisting>(<methodname>qt:byte-array.number</methodname> 37)</programlisting>

+<programlisting language="lisp">(<methodname>qt:byte-array.number</methodname> 37)</programlisting>

-<programlisting>(<genericfunction>cxx:number</genericfunction> (find-class '<classname>qt:byte-array</classname>) 37)</programlisting>

+<programlisting language="lisp">(<genericfunction>cxx:number</genericfunction> (find-class '<classname>qt:byte-array</classname>) 37)</programlisting>

-<programlisting>(<genericfunction>cxx:number</genericfunction> (make-instance '<classname>qt:byte-array</classname>) 37)</programlisting>

+<programlisting language="lisp">(<genericfunction>cxx:number</genericfunction> (make-instance '<classname>qt:byte-array</classname>) 37)</programlisting>

-<programlisting>

+<programlisting language="lisp">

+<?xml version="1.0" encoding="UTF-8"?>

+<xslthl-config>

+ <highlighter id="lisp" file="lisp-hl.xml" />

+ <namespace prefix="xslthl" uri="http://xslthl.sf.net" />

+</xslthl-config>

Thu Jun 4 23:20:49 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* interactive development

-<section><title>Status</title>

-<para>

-GUI creation should work and API will probably remain compatible.

-The next goal is to reorganize the argument conversion / overload resolution and to

-integrate more conversions between Lisp and C++ (<code>QList</code> etc.).

-</para>

-

- <listitem><para>Limited conversions. E.g. <code>QList&lt;T&gt;</code> is missing.

- </para></listitem>

+ <listitem><para>Ownership transfer to / from C++ of non QObject objects is seldom known to cl-smoke.

+ E.g.: cl-smoke might delete an instance even though it is still needed by C++.

+ (One that is known is <ulink url="http://doc.qtsoftware.com/4.5-snapshot/qundostack.html#push">QUndoStack::push()</ulink>.)

+ </para></listitem>

+ <listitem><para>Limited conversions to and from C++. You will get an NO-APPLICABLE-CXX-METHOD error

+ when a Lisp to C++ conversion is missing and a pointer will be returned when there is no C++ to Lisp

+ conversion.

+ </para></listitem>

- <listitem><para>Does not recover well from errors

- <footnote><para>Thus you often need to restart the Lisp process

- during interactive development.</para></footnote>.</para></listitem>

+ <listitem><para>Could be faster</para></listitem>

-</section>

-for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit kde kde.tests kde.examples; do

+for r in smoke qt qt.test qt.tests qt.examples qt.uitools qt.webkit kde kde.tests kde.examples repl; do

- Some examples get the paths for files to load from their Mudballs system (ui and i18n) and thus will not work.

+ Some examples get the paths for the files to load from their Mudballs system (ui and i18n) and thus will not work.

-An the running the function of the example; e.g.:

+And then running the function of the example; e.g.:

+<section><title>Interactive Development</title>

+<para>

+The <package>:cl-smoke.repl</package> allows you to start a <classname>qt:application</classname> event loop in the background for

+interactive development in SLIME.

+To start the event loop use <methodname>cl-smoke.repl:start-event-loop-in-background</methodname> (or [_$_]

+<methodname>cl-smoke.repl:start-event-loop-in-repl</methodname>).

+<footnote>

+<para>

+Currently <code>START-EVENT-LOOP-IN-BACKGROUND</code> is recommended.

+</para>

+</footnote>

+As long as you do not kill the thread or unwind over a foreign function, you should be fine.

+</para>

+</section>

-to a <classname>qt:qslot</classname> at least one must have its arguments types specified.

+to a <classname>qt:qslot</classname> at least one must have its arguments types specified. Type specifier <code>T</code>

+allows to pass a Lisp object as is from a Lisp signal to a Lisp slot.

-in the <filename class="directory">src</filename> directory of <package>:qt.examples</package> how to do this.

+in the <filename class="directory">src/</filename> directory of <package>:qt.examples</package> on how to do this.

+<informalexample>

+</informalexample>

-C++ methods are generic functions in the <code>:cxx</code> package.

+C++ methods are generic functions in the <package>:cxx</package> package.

+<caution><para>

+The arguments of the method might have dynamic extend; i.e.: they are only valid in the body of the method.

+</para></caution>

-You will most likely encounter this problem when an error is signaled in a virtual method you have overwritten

+You will most likely encounter this problem when an error is signaled in a virtual method you have overwritten.

-C++ classes are automatically deleted when their lisp object gets garbage collected;

+C++ classes are automatically deleted when their Lisp object gets garbage collected;

-reference is kept to prevent its garbage collection until the parent is deleted.

+reference is kept to prevent the garbage collection removing it until the parent is deleted.

+<caution>

+<para>

+ Ownership transfer for non QObject instances is mostly unimplemented.

+</para>

+</caution>

Thu Jun 4 00:31:34 CEST 2009 Tobias Rautenkranz <tobias@rautenkranz.ch>

* ASDF & dispatch callback restarts

-On the Lisp side you need <ulink url="http://mudballs.com">mudballs</ulink>

+On the Lisp side you need <ulink url="http://mudballs.com">Mudballs</ulink>

+<para>

+If you prefer to use <ulink url="http://common-lisp.net/project/asdf/">ASDF</ulink> instead of Mudballs, you need these systems:

+<itemizedlist>

+<listitem><para><ulink url="http://common-lisp.net/project/alexandria/">alexandria</ulink></para></listitem>

+<listitem><para><ulink url="http://common-lisp.net/project/bordeaux-threads/">bordeaux-threads</ulink></para></listitem>

+<listitem><para><ulink url="http://common-lisp.net/project/cffi/">cffi</ulink></para></listitem>

+<listitem><para><ulink url="http://common-lisp.net/project/closer/closer-mop.html">closer-mop</ulink></para></listitem>

+<listitem><para><ulink url="http://www.cliki.net/trivial-garbage">trivial-garbage</ulink></para></listitem>

+</itemizedlist>

+</para>

+ For loading the systems you can use Mudballs or ASDF. But first get the sources:

+</para>

+<para>

+ </para>

+ <section><title>Mudballs</title>

+ <para>

+ </section>

+

+ <section><title>ASDF</title>

+ <para>

+ The <code>.asd</code> files are

+ <ulink url="http://tobias.rautenkranz.ch/darcsweb/darcsweb.cgi?r=mudballs-to-asdf;a=summary">generated</ulink>

+ from the mudballs files. [_$_]

+ <ulink url="http://tobias.rautenkranz.ch/lisp/cl-smoke/cl-smoke-asd.tar.bz2">Get the <code>.asd</code> files</ulink> and

+ place them in the corresponding source directories. Then symlink the <code>.asd</code> files in a ASDF search path.

+ You can for examples run: <code>ln -s <userinput>SOME_DIR/*/*.asd</userinput> <userinput>ASDF_PATH</userinput></code>

+ </para>

+ <para>

+ Now build and install the <package>:smoke</package> and <package>:qt</package> C wrapper libraries with:

+ <informalexample>

+ <programlisting>

+ cmake ./ &amp;&amp; make &amp;&amp; sudo make install

+ </programlisting>

+ </informalexample>

+ in the <filename>smoke/</filename> and <filename>qt/</filename> directories.

+ </para>

+ <note><para>

+ Some examples get the paths for files to load from their Mudballs system (ui and i18n) and thus will not work.

+ </para></note>

+ </section>

+<para>

+Subclasses of <classname>qt:paint-device</classname> (e.g. <classname>qt:widget</classname>) can only be used when

+a <classname>qt:application</classname> instance exists. When there are, for example, <classname>qt:widget</classname> instances

+at the end of <macro>qt:with-app</macro>, they are deleted by the <classname>qt:application</classname> destructor.

+</para>

+<section><title>Condition</title>

+<para>

+Unwinding of the C++ stack is not supported. This means that you must not invoke a restart that skips any foreign function.

+You will most likely encounter this problem when an error is signaled in a virtual method you have overwritten

+<footnote>

+<para>

+For example an event handler that is called from the C++ library.

+</para>

+</footnote>. For this case restarts are provide that allow to return a value for the failed method,

+call the default C++ implementation instead (something like <code>#'call-next-method</code>) or retry.

+</para>

+</section>