Apache OpenOffice Wiki - User contributions [en]

Buildbot

2009-08-07T15:57:01Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-ldap --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --enable-werror --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td>Smoketest currently broken</td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-9.04-i386 Ubuntu-9.04-i386]
</td>
<td>--with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla --with-system-python</td>
<td>Built-in Python is incompatible with newer gcc, so we have to build with system python</td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-08-07T11:55:57Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --enable-werror --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td>Smoketest currently broken</td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-9.04-i386 Ubuntu-9.04-i386]
</td>
<td>--with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla --with-system-python</td>
<td>Built-in Python is incompatible with newer gcc, so we have to build with system python</td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-04-09T13:07:22Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td>Smoketest currently broken</td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-9.04-i386 Ubuntu-9.04-i386]
</td>
<td>--with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla --with-system-python</td>
<td>Built-in Python is incompatible with newer gcc, so we have to build with system python</td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-04-09T08:19:14Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td>Smoketest currently broken</td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-9.04-i386 Ubuntu-9.04-i386]
</td>
<td>--with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-04-09T08:18:49Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td>Smoketest currently broken</td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

OpenSolaris Build Instructions

2009-03-24T09:28:47Z

Cli:

The page should be filled with useful information about how to build a recent version of OOo on the OpenSolaris platform. Some mailing list postings showed that this may not be an easy task.

This description refers to an OpenSolaris 2008.11 (svn_100). Please note that you need at least 1.5 GB virtual memory to succesfully build OOo on OpenSolaris. It is highly recommended to set TMP to a directory on a real disk (per default /tmp which resides in memory).

== Prerequisites ==

If you have a freshly installed OpenSolaris you may need the following packages to build OpenOffice.org.
A package can be installed with:

pfexec pkg install <packagename>

* SUNWxorg-headers
* IPSgawk (from blastwave.org)
* IPSpkgconfig (from blastwave.org)
* SUNWant (currently OOo configure is not able to detect the system ANT properly, you have to manually install ANT and use --with-ant-home)
* SUNWbison
* SUNWcurl (if you build with --with-system-curl)
* SUNWflexlex
* SUNWgcc (if you build with gcc, not with Sun Studio. Note: this gcc package is linked against Sun ld and currently won't work for OOo)
* SUNWgmake (although not required to build OOo, it is necessary to compile the OOo dmake...)
* SUNWgnu-gperf
* IPSlibicu (if you are building with --with-system-icu)
* SUNWsvn (if you like to checkout sources via Subversion)

You will need the Archive::Zip.pm Perl module which does not ship with OpenSolaris per default. You can manually install it (and its prerequisites) using CPAN with invoking the following commands:
# export PATH=/usr/bin:/opt/SunStudioExpress/bin:$PATH
Note that the command above makes sure that Perl does not use GNU make, which can cause trouble at this point. Later you will need GNU make to build OOo.
# /usr/perl5/bin/perl -MCPAN -e 'shell'
cpan> install Archive::Zip
cpan> exit

You will need a Sun Studio 11 (version 12 currently not supported).

As on all other platforms you need the unowinreg.dll from http://tools.openoffice.org/unowinreg_prebuild/680/ .

== Environment variables ==

CC=/opt/SunStudioExpress/bin/cc
CXX=/opt/SunStudioExpress/bin/CC
PKG_CONFIG=/opt/csw/bin/pkg-config
PKG_CONFIG_PATH=/usr/lib/pkgconfig
GNUMAKE=/usr/bin/gmake

Comment : if $GNUMAKE undefined, make is used instead, and causes breakage in moz e.g.

== Special switches ==

As it requires more work you may want to disable specific features on OpenSolaris. The following configure switches make life easier:

./configure --disable-cups --disable-mozilla --disable-Xaw --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/gnu/bin/cp --disable-gtk --with-system-curl --with-jdk-home=/usr/jdk/instances/jdk1.6.0 --with-use-shell=bash

Please note that some of these switches may disable common features of OOo, but currently there is no practical way to enable them (if you know one, please edit this document).

==<font color=red>''' Experimental''' </font>==

There is a work in progress, to make seamonkey1.1.13 (or superior) buildable on OpenSolaris (2008-11). See {{CWS|moz2seamonkey01 |DEV300}} cws

'''Current status is, only moz does build''' (the OOo build is broken on OpenSolaris) but The zipped archive build is ok, and just some little changes remain to be done (code factorization, be sure the right options are used and so on)

More info on http://eric.bachard.free.fr/mac/moz/OpenSolaris/ , where you'll find :

* [http://eric.bachard.free.fr/mac/moz/OpenSolaris/config.parms config.parms] (please prefer download and build the moz from moz2seamonkey cws)
* the zipped archives for OpenSolaris (32 bits for now) :
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iinc.zip the include archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Ilib.zip the lib archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iruntime.zip the runtime archive]

== Known issues ==

If you meet unresolved dependencies in libjawt.so, [http://defect.opensolaris.org/bz/show_bug.cgi?id=4394 this issue] might be interesting for you.

If the build of module automation failes because libXm.so cannot be found, try to link /var/lib/libXmu.so => /var/lib/Xm.so.

There are of course bugs that prevent OOo from building, see [http://www.openoffice.org/servlets/Search?resultsPerPage=40&scope=domain&artifact=issuezilla+ALL&Button=Search&query=opensolaris Issuetracker].

If configure cannot find the ant-libs, download ANT manually and provide configure the ant home dir with --with-ant-home=<myanthome> .

[[Category:Development]]
[[Category:Build_System]]
[[Category: Distribution-Specific Build Instructions]]

Buildbot

2009-03-23T11:13:43Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td>Smoketest currently broken</td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

OpenSolaris Build Instructions

2009-03-20T16:44:19Z

Cli: /* Prerequisites */

The page should be filled with useful information about how to build a recent version of OOo on the OpenSolaris platform. Some mailing list postings showed that this may not be an easy task.

This description refers to an OpenSolaris 2008.11 (svn_100). Please note that you need at least 1.5 GB virtual memory to succesfully build OOo on OpenSolaris.

== Prerequisites ==

If you have a freshly installed OpenSolaris you may need the following packages to build OpenOffice.org.
A package can be installed with:

pfexec pkg install <packagename>

* SUNWxorg-headers
* IPSgawk (from blastwave.org)
* IPSpkgconfig (from blastwave.org)
* SUNWant (currently OOo configure is not able to detect the system ANT properly, you have to manually install ANT and use --with-ant-home)
* SUNWbison
* SUNWcurl (if you build with --with-system-curl)
* SUNWflexlex
* SUNWgcc (if you build with gcc, not with Sun Studio. Note: this gcc package is linked against Sun ld and currently won't work for OOo)
* SUNWgmake (although not required to build OOo, it is necessary to compile the OOo dmake...)
* SUNWgnu-gperf
* IPSlibicu (if you are building with --with-system-icu)
* SUNWsvn (if you like to checkout sources via Subversion)

You will need the Archive::Zip.pm Perl module which does not ship with OpenSolaris per default. You can manually install it (and its prerequisites) using CPAN with invoking the following commands:
# export PATH=/usr/bin:/opt/SunStudioExpress/bin:$PATH
Note that the command above makes sure that Perl does not use GNU make, which can cause trouble at this point. Later you will need GNU make to build OOo.
# /usr/perl5/bin/perl -MCPAN -e 'shell'
cpan> install Archive::Zip
cpan> exit

You will need a Sun Studio 11 (version 12 currently not supported).

As on all other platforms you need the unowinreg.dll from http://tools.openoffice.org/unowinreg_prebuild/680/ .

== Environment variables ==

CC=/opt/SunStudioExpress/bin/cc
CXX=/opt/SunStudioExpress/bin/CC
PKG_CONFIG=/opt/csw/bin/pkg-config
PKG_CONFIG_PATH=/usr/lib/pkgconfig
GNUMAKE=/usr/bin/gmake

Comment : if $GNUMAKE undefined, make is used instead, and causes breakage in moz e.g.

== Special switches ==

As it requires more work you may want to disable specific features on OpenSolaris. The following configure switches make life easier:

./configure --disable-cups --disable-mozilla --disable-Xaw --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/gnu/bin/cp --disable-gtk --with-system-curl --with-jdk-home=/usr/jdk/instances/jdk1.6.0 --with-use-shell=bash

Please note that some of these switches may disable common features of OOo, but currently there is no practical way to enable them (if you know one, please edit this document).

==<font color=red>''' Experimental''' </font>==

There is a work in progress, to make seamonkey1.1.13 (or superior) buildable on OpenSolaris (2008-11). See {{CWS|moz2seamonkey01 |DEV300}} cws

'''Current status is, only moz does build''' (the OOo build is broken on OpenSolaris) but The zipped archive build is ok, and just some little changes remain to be done (code factorization, be sure the right options are used and so on)

More info on http://eric.bachard.free.fr/mac/moz/OpenSolaris/ , where you'll find :

* [http://eric.bachard.free.fr/mac/moz/OpenSolaris/config.parms config.parms] (please prefer download and build the moz from moz2seamonkey cws)
* the zipped archives for OpenSolaris (32 bits for now) :
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iinc.zip the include archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Ilib.zip the lib archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iruntime.zip the runtime archive]

== Known issues ==

If you meet unresolved dependencies in libjawt.so, [http://defect.opensolaris.org/bz/show_bug.cgi?id=4394 this issue] might be interesting for you.

If the build of module automation failes because libXm.so cannot be found, try to link /var/lib/libXmu.so => /var/lib/Xm.so.

There are of course bugs that prevent OOo from building, see [http://www.openoffice.org/servlets/Search?resultsPerPage=40&scope=domain&artifact=issuezilla+ALL&Button=Search&query=opensolaris Issuetracker].

If configure cannot find the ant-libs, download ANT manually and provide configure the ant home dir with --with-ant-home=<myanthome> .

[[Category:Development]]
[[Category:Build_System]]
[[Category: Distribution-Specific Build Instructions]]

OpenSolaris Build Instructions

2009-03-20T15:28:49Z

Cli:

The page should be filled with useful information about how to build a recent version of OOo on the OpenSolaris platform. Some mailing list postings showed that this may not be an easy task.

This description refers to an OpenSolaris 2008.11 (svn_100). Please note that you need at least 1.5 GB virtual memory to succesfully build OOo on OpenSolaris.

== Prerequisites ==

If you have a freshly installed OpenSolaris you may need the following packages to build OpenOffice.org.
A package can be installed with:

pfexec pkg install <packagename>

* SUNWxorg-headers
* IPSgawk (from blastwave.org)
* IPSpkgconfig (from blastwave.org)
* SUNWant (currently OOo configure is not able to detect the system ANT properly, you have to manually install ANT and use --with-ant-home)
* SUNWbison
* SUNWcurl (if you build with --with-system-curl)
* SUNWflexlex
* SUNWgcc (if you build with gcc, not with Sun Studio. Note: this gcc package is linked against Sun ld and currently won't work for OOo)
* SUNWgmake (although not required to build OOo, it is necessary to compile the OOo dmake...)
* SUNWgnu-gperf
* SUNWicu (if you build with --with-system-icu, currently not working)
* SUNWicud (if you build with --with-system-icu, currently not working)
* SUNWsvn (if you like to checkout sources via Subversion)

You will need the Archive::Zip.pm Perl module which does not ship with OpenSolaris per default. You can manually install it (and its prerequisites) using CPAN with invoking the following commands:
# export PATH=/usr/bin:/opt/SunStudioExpress/bin:$PATH
Note that the command above makes sure that Perl does not use GNU make, which can cause trouble at this point. Later you will need GNU make to build OOo.
# /usr/perl5/bin/perl -MCPAN -e 'shell'
cpan> install Archive::Zip
cpan> exit

You will need a Sun Studio 11 (version 12 currently not supported).

As on all other platforms you need the unowinreg.dll from http://tools.openoffice.org/unowinreg_prebuild/680/ .

== Environment variables ==

CC=/opt/SunStudioExpress/bin/cc
CXX=/opt/SunStudioExpress/bin/CC
PKG_CONFIG=/opt/csw/bin/pkg-config
PKG_CONFIG_PATH=/usr/lib/pkgconfig
GNUMAKE=/usr/bin/gmake

Comment : if $GNUMAKE undefined, make is used instead, and causes breakage in moz e.g.

== Special switches ==

As it requires more work you may want to disable specific features on OpenSolaris. The following configure switches make life easier:

./configure --disable-cups --disable-mozilla --disable-Xaw --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/gnu/bin/cp --disable-gtk --with-system-curl --with-jdk-home=/usr/jdk/instances/jdk1.6.0 --with-use-shell=bash

Please note that some of these switches may disable common features of OOo, but currently there is no practical way to enable them (if you know one, please edit this document).

==<font color=red>''' Experimental''' </font>==

There is a work in progress, to make seamonkey1.1.13 (or superior) buildable on OpenSolaris (2008-11). See {{CWS|moz2seamonkey01 |DEV300}} cws

'''Current status is, only moz does build''' (the OOo build is broken on OpenSolaris) but The zipped archive build is ok, and just some little changes remain to be done (code factorization, be sure the right options are used and so on)

More info on http://eric.bachard.free.fr/mac/moz/OpenSolaris/ , where you'll find :

* [http://eric.bachard.free.fr/mac/moz/OpenSolaris/config.parms config.parms] (please prefer download and build the moz from moz2seamonkey cws)
* the zipped archives for OpenSolaris (32 bits for now) :
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iinc.zip the include archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Ilib.zip the lib archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iruntime.zip the runtime archive]

== Known issues ==

If you meet unresolved dependencies in libjawt.so, [http://defect.opensolaris.org/bz/show_bug.cgi?id=4394 this issue] might be interesting for you.

If the build of module automation failes because libXm.so cannot be found, try to link /var/lib/libXmu.so => /var/lib/Xm.so.

There are of course bugs that prevent OOo from building, see [http://www.openoffice.org/servlets/Search?resultsPerPage=40&scope=domain&artifact=issuezilla+ALL&Button=Search&query=opensolaris Issuetracker].

If configure cannot find the ant-libs, download ANT manually and provide configure the ant home dir with --with-ant-home=<myanthome> .

[[Category:Development]]
[[Category:Build_System]]
[[Category: Distribution-Specific Build Instructions]]

OpenSolaris Build Instructions

2009-03-20T15:28:30Z

Cli: /* Special switches */

The page should be filled with useful information about how to build a recent version of OOo on the OpenSolaris platform. Some mailing list postings showed that this may not be an easy task.

This description refers to an OpenSolaris 2008.11 (svn_100). Please note that you need at least 1.5 GB virtual memory to succesfully build OOo on OpenSolaris.

<font color="red">svn_101a contains a new Sun Studio Compiler that is currently incompatible with OOo stlport, use Compiler STLport instead!</font>

== Prerequisites ==

If you have a freshly installed OpenSolaris you may need the following packages to build OpenOffice.org.
A package can be installed with:

pfexec pkg install <packagename>

* SUNWxorg-headers
* IPSgawk (from blastwave.org)
* IPSpkgconfig (from blastwave.org)
* SUNWant (currently OOo configure is not able to detect the system ANT properly, you have to manually install ANT and use --with-ant-home)
* SUNWbison
* SUNWcurl (if you build with --with-system-curl)
* SUNWflexlex
* SUNWgcc (if you build with gcc, not with Sun Studio. Note: this gcc package is linked against Sun ld and currently won't work for OOo)
* SUNWgmake (although not required to build OOo, it is necessary to compile the OOo dmake...)
* SUNWgnu-gperf
* SUNWicu (if you build with --with-system-icu, currently not working)
* SUNWicud (if you build with --with-system-icu, currently not working)
* SUNWsvn (if you like to checkout sources via Subversion)

You will need the Archive::Zip.pm Perl module which does not ship with OpenSolaris per default. You can manually install it (and its prerequisites) using CPAN with invoking the following commands:
# export PATH=/usr/bin:/opt/SunStudioExpress/bin:$PATH
Note that the command above makes sure that Perl does not use GNU make, which can cause trouble at this point. Later you will need GNU make to build OOo.
# /usr/perl5/bin/perl -MCPAN -e 'shell'
cpan> install Archive::Zip
cpan> exit

You will need a Sun Studio 11 (version 12 currently not supported).

As on all other platforms you need the unowinreg.dll from http://tools.openoffice.org/unowinreg_prebuild/680/ .

== Environment variables ==

CC=/opt/SunStudioExpress/bin/cc
CXX=/opt/SunStudioExpress/bin/CC
PKG_CONFIG=/opt/csw/bin/pkg-config
PKG_CONFIG_PATH=/usr/lib/pkgconfig
GNUMAKE=/usr/bin/gmake

Comment : if $GNUMAKE undefined, make is used instead, and causes breakage in moz e.g.

== Special switches ==

As it requires more work you may want to disable specific features on OpenSolaris. The following configure switches make life easier:

./configure --disable-cups --disable-mozilla --disable-Xaw --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/gnu/bin/cp --disable-gtk --with-system-curl --with-jdk-home=/usr/jdk/instances/jdk1.6.0 --with-use-shell=bash

Please note that some of these switches may disable common features of OOo, but currently there is no practical way to enable them (if you know one, please edit this document).

==<font color=red>''' Experimental''' </font>==

There is a work in progress, to make seamonkey1.1.13 (or superior) buildable on OpenSolaris (2008-11). See {{CWS|moz2seamonkey01 |DEV300}} cws

'''Current status is, only moz does build''' (the OOo build is broken on OpenSolaris) but The zipped archive build is ok, and just some little changes remain to be done (code factorization, be sure the right options are used and so on)

More info on http://eric.bachard.free.fr/mac/moz/OpenSolaris/ , where you'll find :

* [http://eric.bachard.free.fr/mac/moz/OpenSolaris/config.parms config.parms] (please prefer download and build the moz from moz2seamonkey cws)
* the zipped archives for OpenSolaris (32 bits for now) :
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iinc.zip the include archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Ilib.zip the lib archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iruntime.zip the runtime archive]

== Known issues ==

If you meet unresolved dependencies in libjawt.so, [http://defect.opensolaris.org/bz/show_bug.cgi?id=4394 this issue] might be interesting for you.

If the build of module automation failes because libXm.so cannot be found, try to link /var/lib/libXmu.so => /var/lib/Xm.so.

There are of course bugs that prevent OOo from building, see [http://www.openoffice.org/servlets/Search?resultsPerPage=40&scope=domain&artifact=issuezilla+ALL&Button=Search&query=opensolaris Issuetracker].

If configure cannot find the ant-libs, download ANT manually and provide configure the ant home dir with --with-ant-home=<myanthome> .

[[Category:Development]]
[[Category:Build_System]]
[[Category: Distribution-Specific Build Instructions]]

OpenSolaris Build Instructions

2009-03-20T15:28:14Z

Cli: /* Prerequisites */

The page should be filled with useful information about how to build a recent version of OOo on the OpenSolaris platform. Some mailing list postings showed that this may not be an easy task.

This description refers to an OpenSolaris 2008.11 (svn_100). Please note that you need at least 1.5 GB virtual memory to succesfully build OOo on OpenSolaris.

<font color="red">svn_101a contains a new Sun Studio Compiler that is currently incompatible with OOo stlport, use Compiler STLport instead!</font>

== Prerequisites ==

If you have a freshly installed OpenSolaris you may need the following packages to build OpenOffice.org.
A package can be installed with:

pfexec pkg install <packagename>

* SUNWxorg-headers
* IPSgawk (from blastwave.org)
* IPSpkgconfig (from blastwave.org)
* SUNWant (currently OOo configure is not able to detect the system ANT properly, you have to manually install ANT and use --with-ant-home)
* SUNWbison
* SUNWcurl (if you build with --with-system-curl)
* SUNWflexlex
* SUNWgcc (if you build with gcc, not with Sun Studio. Note: this gcc package is linked against Sun ld and currently won't work for OOo)
* SUNWgmake (although not required to build OOo, it is necessary to compile the OOo dmake...)
* SUNWgnu-gperf
* SUNWicu (if you build with --with-system-icu, currently not working)
* SUNWicud (if you build with --with-system-icu, currently not working)
* SUNWsvn (if you like to checkout sources via Subversion)

You will need the Archive::Zip.pm Perl module which does not ship with OpenSolaris per default. You can manually install it (and its prerequisites) using CPAN with invoking the following commands:
# export PATH=/usr/bin:/opt/SunStudioExpress/bin:$PATH
Note that the command above makes sure that Perl does not use GNU make, which can cause trouble at this point. Later you will need GNU make to build OOo.
# /usr/perl5/bin/perl -MCPAN -e 'shell'
cpan> install Archive::Zip
cpan> exit

You will need a Sun Studio 11 (version 12 currently not supported).

As on all other platforms you need the unowinreg.dll from http://tools.openoffice.org/unowinreg_prebuild/680/ .

== Environment variables ==

CC=/opt/SunStudioExpress/bin/cc
CXX=/opt/SunStudioExpress/bin/CC
PKG_CONFIG=/opt/csw/bin/pkg-config
PKG_CONFIG_PATH=/usr/lib/pkgconfig
GNUMAKE=/usr/bin/gmake

Comment : if $GNUMAKE undefined, make is used instead, and causes breakage in moz e.g.

== Special switches ==

As it requires more work you may want to disable specific features on OpenSolaris. The following configure switches make life easier:

./configure --disable-cups --disable-mozilla --disable-Xaw --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/gnu/bin/cp --disable-gtk --with-system-curl --with-jdk-home=/usr/jdk/instances/jdk1.6.0 --with-use-shell=tcsh

Please note that some of these switches may disable common features of OOo, but currently there is no practical way to enable them (if you know one, please edit this document).

==<font color=red>''' Experimental''' </font>==

There is a work in progress, to make seamonkey1.1.13 (or superior) buildable on OpenSolaris (2008-11). See {{CWS|moz2seamonkey01 |DEV300}} cws

'''Current status is, only moz does build''' (the OOo build is broken on OpenSolaris) but The zipped archive build is ok, and just some little changes remain to be done (code factorization, be sure the right options are used and so on)

More info on http://eric.bachard.free.fr/mac/moz/OpenSolaris/ , where you'll find :

* [http://eric.bachard.free.fr/mac/moz/OpenSolaris/config.parms config.parms] (please prefer download and build the moz from moz2seamonkey cws)
* the zipped archives for OpenSolaris (32 bits for now) :
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iinc.zip the include archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Ilib.zip the lib archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iruntime.zip the runtime archive]

== Known issues ==

If you meet unresolved dependencies in libjawt.so, [http://defect.opensolaris.org/bz/show_bug.cgi?id=4394 this issue] might be interesting for you.

If the build of module automation failes because libXm.so cannot be found, try to link /var/lib/libXmu.so => /var/lib/Xm.so.

There are of course bugs that prevent OOo from building, see [http://www.openoffice.org/servlets/Search?resultsPerPage=40&scope=domain&artifact=issuezilla+ALL&Button=Search&query=opensolaris Issuetracker].

If configure cannot find the ant-libs, download ANT manually and provide configure the ant home dir with --with-ant-home=<myanthome> .

[[Category:Development]]
[[Category:Build_System]]
[[Category: Distribution-Specific Build Instructions]]

Buildbot

2009-03-20T14:59:53Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-java --without-stlport</td>
<td></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

OpenSolaris Build Instructions

2009-03-20T14:36:56Z

Cli: /* Prerequisites */

The page should be filled with useful information about how to build a recent version of OOo on the OpenSolaris platform. Some mailing list postings showed that this may not be an easy task.

This description refers to an OpenSolaris 2008.11 (svn_100). Please note that you need at least 1.5 GB virtual memory to succesfully build OOo on OpenSolaris.

<font color="red">svn_101a contains a new Sun Studio Compiler that is currently incompatible with OOo stlport, use Compiler STLport instead!</font>

== Prerequisites ==

If you have a freshly installed OpenSolaris you may need the following packages to build OpenOffice.org.
A package can be installed with:

pfexec pkg install <packagename>

* FSWxorg-headers
* IPSgawk (from blastwave.org)
* IPSpkgconfig (from blastwave.org)
* SUNWant (currently OOo configure is not able to detect the system ANT properly, you have to manually install ANT and use --with-ant-home)
* SUNWbison
* SUNWcurl (if you build with --with-system-curl)
* SUNWflexlex
* SUNWgcc (if you build with gcc, not with Sun Studio. Note: this gcc package is linked against Sun ld and currently won't work for OOo)
* SUNWgmake (although not required to build OOo, it is necessary to compile the OOo dmake...)
* SUNWgnu-gperf
* SUNWicu (if you build with --with-system-icu, currently not working)
* SUNWicud (if you build with --with-system-icu, currently not working)
* SUNWsvn (if you like to checkout sources via Subversion)
* SUNWtcsh

You will need the Archive::Zip.pm Perl module which does not ship with OpenSolaris per default. You can manually install it (and its prerequisites) using CPAN with invoking the following commands:
# export PATH=/usr/bin:/opt/SunStudioExpress/bin:$PATH
Note that the command above makes sure that Perl does not use GNU make, which can cause trouble at this point. Later you will need GNU make to build OOo.
# /usr/perl5/bin/perl -MCPAN -e 'shell'
cpan> install Archive::Zip
cpan> exit

You will need a Sun Studio 11 (version 12 currently not supported).

As on all other platforms you need the unowinreg.dll from http://tools.openoffice.org/unowinreg_prebuild/680/ .

== Environment variables ==

CC=/opt/SunStudioExpress/bin/cc
CXX=/opt/SunStudioExpress/bin/CC
PKG_CONFIG=/opt/csw/bin/pkg-config
PKG_CONFIG_PATH=/usr/lib/pkgconfig
GNUMAKE=/usr/bin/gmake

Comment : if $GNUMAKE undefined, make is used instead, and causes breakage in moz e.g.

== Special switches ==

As it requires more work you may want to disable specific features on OpenSolaris. The following configure switches make life easier:

./configure --disable-cups --disable-mozilla --disable-Xaw --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/gnu/bin/cp --disable-gtk --with-system-curl --with-jdk-home=/usr/jdk/instances/jdk1.6.0 --with-use-shell=tcsh

Please note that some of these switches may disable common features of OOo, but currently there is no practical way to enable them (if you know one, please edit this document).

==<font color=red>''' Experimental''' </font>==

There is a work in progress, to make seamonkey1.1.13 (or superior) buildable on OpenSolaris (2008-11). See {{CWS|moz2seamonkey01 |DEV300}} cws

'''Current status is, only moz does build''' (the OOo build is broken on OpenSolaris) but The zipped archive build is ok, and just some little changes remain to be done (code factorization, be sure the right options are used and so on)

More info on http://eric.bachard.free.fr/mac/moz/OpenSolaris/ , where you'll find :

* [http://eric.bachard.free.fr/mac/moz/OpenSolaris/config.parms config.parms] (please prefer download and build the moz from moz2seamonkey cws)
* the zipped archives for OpenSolaris (32 bits for now) :
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iinc.zip the include archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Ilib.zip the lib archive]
** [http://eric.bachard.free.fr/mac/moz/OpenSolaris/SOLARISC52Iruntime.zip the runtime archive]

== Known issues ==

If you meet unresolved dependencies in libjawt.so, [http://defect.opensolaris.org/bz/show_bug.cgi?id=4394 this issue] might be interesting for you.

If the build of module automation failes because libXm.so cannot be found, try to link /var/lib/libXmu.so => /var/lib/Xm.so.

There are of course bugs that prevent OOo from building, see [http://www.openoffice.org/servlets/Search?resultsPerPage=40&scope=domain&artifact=issuezilla+ALL&Button=Search&query=opensolaris Issuetracker].

If configure cannot find the ant-libs, download ANT manually and provide configure the ant home dir with --with-ant-home=<myanthome> .

[[Category:Development]]
[[Category:Build_System]]
[[Category: Distribution-Specific Build Instructions]]

Buildbot

2009-03-20T12:39:08Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-system-zlib --with-use-shell=bash --without-stlport</td>
<td></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-19T19:35:03Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--disable-binfilter --disable-cups --disable-fontconfig --disable-gconf --disable-gnome-vfs --disable-gtk --disable-mozilla --disable-odk --disable-pam --disable-randr --disable-Xaw --with-system-hsqldb --with-system-hunspell --with-system-libxml --with-system-lbxslt --with-system-python --with-use-shell=bash --without-stlport</td>
<td></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-17T09:32:05Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10-i386]
</td>
<td>--with-system-python --with-system-hunspell --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-binfilter --disable-build-mozilla</td>
<td></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-17T09:31:42Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.10-i386 Ubuntu-8.10]
</td>
<td>--with-system-python --with-system-hunspell --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-binfilter --disable-build-mozilla</td>
<td></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T11:27:57Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror --disable-build-mozilla</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T11:11:13Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>--disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:53:17Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>(no switches)</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td valign="top">[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:52:43Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.
The used configure call can be always obtained through a recent build log, but is summarized here for convenience.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>(no switches)</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/MacIntel MacIntel]
</td>
<td>--with-use-shell=bash --disable-gtk --disable-build-mozilla</td>
<td></td>
</tr>

<tr>
<td>[http://termite.go-oo.org/buildbot/builders/RedFlag RedFlag]</td>
<td>--with-java=yes --with-jdk-home=/usr/java/jdk1.5.0_16 --with-ant-home=/usr/lib/jvm/apache-ant-1.7.1 LDFLAGS=-L/usr/local/lib --with-x=yes --without-nas --without-fonts --with-system-stdlibs --with-package-format=rpm</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:49:13Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Fedora-10-i386 Fedora-10-i386]
</td>
<td>(no switches)</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:47:38Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-8.04-amd64 Ubuntu-8.04-amd64]
</td>
<td>--enable-werror</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:46:08Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr>
<td valign="top">
[http://termite.go-oo.org/buildbot/builders/Ubuntu-7.10-i386 Ubuntu-7.10-i386]
</td>
<td>--enable-werror --with-jdk-home=/usr/lib/jvm/java-6-sun</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:41:03Z

Cli: /* Slave system configurations */

A buildbot is now deployed for OpenOffice.org.
'''http://buildbot.go-oo.org/'''

The Buildbot adaption for OOo is done in a separate project: http://code.google.com/p/ootermite/

From the Buildbot README: http://buildbot.sourceforge.net/

The BuildBot is a system to automate the compile/test cycle required by most software projects to validate code changes. By automatically rebuilding and testing the tree each time something has changed, build problems are pinpointed quickly, before other developers are inconvenienced by the failure. The guilty developer can be identified and harassed without human intervention. By running the builds on a variety of platforms, developers who do not have the facilities to test their changes everywhere before checkin will at least know shortly afterwards whether they have broken the build or not. Warning counts, lint checks, image size, compile time, and other build parameters can be tracked over time, are more visible, and are therefore easier to improve.

== How to start a build ==

* Visit http://buildbot.go-oo.org/buildbot/
* Choose a machine you want to build on, and click on it
* Fill in the ''Your name'', ''Reason for build'', ''Branch to build'' (just the CWS name)
* If you want to have the resulting installation sets, check ''Install Set''
* Press ''Force Build''
* Wait until the installation sets appear in http://buildbot.go-oo.org/install_sets/ (if you wanted them)

If your build breaks it ''may'' be the Buildbot's fault as they are not perfect. If you are unsure feel free to contact the Buildslave's maintainer (contact address on the Builder's overview page). Generally speaking if the corresponding MWS builds fine a CWS break is the CWS' fault.

== Slave system configurations ==

The Buildbot slaves do not build agains a specific baseline as they have varying operating systems and compilers. This was done by intention because we want as different systems as possible to get the OOo code robust and portable. You can of course use the builds for QAing, but do not espect reproducable results.

Nevertheless, a developer must know the exact configure parameters and environment information when inspecting a build break. These information should be available through this page.

<table style="border: 1px solid black; padding: 10px">
<tr><td><b>Slavename/Builder</b></td><td><b>configure switches</b></td><td><b>System information</b></td></tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Intel Solaris-Intel]</td>
<td>--enable-werror --enable-report-builder=no --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/usr/sfw/bin/cp --with-ant-home=/usr/sfw --with-jdk-home=/usr/jdk/jdk1.5.0_16 --disable-pasf --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Solaris-Sparc Solaris-Sparc]</td>
<td>--enable-report-builder=no --with-use-shell=bash --disable-cups --disable-build-mozilla --disable-randr --with-gnu-patch=/usr/bin/gpatch --with-gnu-cp=/opt/sfw/bin/cp --with-ant-home=/space/termite/apache-ant-1.7.0 --with-jdk-home=/usr/jdk/jdk1.5.0_12 --disable-pasf --with-epm=internal --with-ant-home=/space/termite/prereqs/apache-ant-1.7.0 --disable-mediawiki</td>
<td></td>
</tr>

<tr style="border: 1px solid black">
<td valign="top">[http://termite.go-oo.org/buildbot/builders/Win-XP2 Win-XP2]</td>
<td>--enable-report-builder=no --with-use-shell=bash '--with-midl-path=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin' '--with-psdk-home=/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1' '--with-directx-home=/cygdrive/c/Program Files (x86)/Microsoft DirectX SDK (February 2007)' --with-ant-home=/cygdrive/f/termite/prereqs/apache-ant-1.7.1 --disable-build-mozilla --disable-mediawiki --with-gpc --with-csc-path=/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v2.0.50727 '--with-jdk-home=/cygdrive/c/Program Files (x86)/Java/jdk1.5.0_11' --disable-activex '--with-frame-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 8/SDK/v2.0' '--with-cl-home=/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0/VC' --with-nsis-path=/cygdrive/c/termite/prereq/NSIS '--with-package-format=installed msi ddd'</td>
<td>WindowsXP Server with SP2</td>
</tr>
</table>

[[Category:Build_System]]

Buildbot

2009-03-13T10:37:36Z

Cli: /* Slave system configurations */

Buildbot

2009-03-13T10:30:05Z

Cli: /* System configuration */

Buildbot

2009-03-13T10:28:59Z

Cli:

Buildbot

2009-03-06T11:49:07Z

Cli:

Basic

2009-01-28T15:10:43Z

Cli:

This module contais the StarBASIC Interpreter and the GUI for the VCLTestTool.

The VCLTestTool GUI is located in the directory source/app.

'''Be sure to relink the VCLTestTool in module automation if you change anything in here!'''

Object Inspector

2009-01-28T15:05:38Z

Cli: /* Development */

Object Inspector

2009-01-28T15:01:44Z

Cli: /* Screenshots */

Object Inspector

2009-01-28T15:00:48Z

Cli: /* Filtering */

File:ObjectInspector.png

2009-01-28T14:59:36Z

Cli: Screenshot of Object Inspector 2.0

Screenshot of Object Inspector 2.0

Object Inspector

2009-01-28T14:50:09Z

Cli: /* Usage */

Object Inspector

2009-01-28T12:49:38Z

Cli: /* See Also */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

=== Sourcecode generation ===

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

=== IDL help ===
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Development ==

=== Known issues ===

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

=== Future Enhancements ===

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0 Object Inspector binary file]
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:49:24Z

Cli: /* See Also */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

=== Sourcecode generation ===

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

=== IDL help ===
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Development ==

=== Known issues ===

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

=== Future Enhancements ===

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [hhttp://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0 Object Inspector binary file]
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:48:21Z

Cli:

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

=== Sourcecode generation ===

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

=== IDL help ===
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Development ==

=== Known issues ===

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

=== Future Enhancements ===

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:47:31Z

Cli: /* IDL help */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

=== Sourcecode generation ===

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

=== IDL help ===
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:47:13Z

Cli: /* Sourcecode generation */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

=== Sourcecode generation ===

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are code generators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:46:37Z

Cli: /* Calling from a Basic Macro */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=== Calling from a Basic Macro ===

The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:46:06Z

Cli: /* Filtering */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

=== Filtering ===

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:42:33Z

Cli: /* Usage */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/servlets/ProjectDocumentList?folderID=636&expandFolder=636&folderID=0] .

Together with the new package a new toolbar is added from which the object inspector may be started.
The initial UNO object is the document of the active frame. The UNO object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facets:

Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:40:30Z

Cli: /* Future Enhancements */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] .

Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

* Add a "Container" meta node that can be expanded to retrieve information about Elements. This node is only applicable when the UNO objects also depicts a container that exports interfaces like XIndexAccess.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:31:27Z

Cli: /* Usage */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== Usage ==
The Object Inspector may be installed using the package manager (menu "Tools/Options") by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] .

Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:24:55Z

Cli: /* The Solution */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== The Solution ==

The conclusion is that it has to be inspected during runtime what respective capabilities a UNO object actually has.
The Object Inspector is an OpenOffice.org extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a "living Uno-object" such as all supported services, exported interfaces, and their respective methods and properties in a TreeView window.

== '''Usage''' ==
The object inspector may be installed using the package manager (menu „Tools/Options“) by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] . Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:11:43Z

Cli: /* IDL help */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== '''The Solution''' ==
The conclusion is that it has be be inspected during runtime what respective capabilities a Uno-Object actually has. The new Object Inspector is an OpenOffice extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a „living Uno-object“ such as all supported services, exported interfaces, and their respective methods and properties in a treeview window.

== '''Usage''' ==
The object inspector may be installed using the package manager (menu „Tools/Options“) by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] . Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== IDL help ==
<font color="red">Currently broken</font>

The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:09:15Z

Cli: /* Future Enhancements */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== '''The Solution''' ==
The conclusion is that it has be be inspected during runtime what respective capabilities a Uno-Object actually has. The new Object Inspector is an OpenOffice extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a „living Uno-object“ such as all supported services, exported interfaces, and their respective methods and properties in a treeview window.

== '''Usage''' ==
The object inspector may be installed using the package manager (menu „Tools/Options“) by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] . Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== '''IDL help''' ==
The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions. As a new feature the Object inspector also offers to provide the path to a local SDK installation when no internet connection is available. To do so follow the menu "Options/SDK-Path" and select the path to the local SDK-installation in the raised folder picker. The path to the SDK-installation is stored persistently.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== Future Enhancements ==

* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
** Implementation of Array parameters with primitive elements.
** Implementation of structs.
** Implementation of an input mask to refere to UNO-Objects as method parameters.
**Consider multidimensional arrays as method parameters and for return values.

* An additional UNO GUI should be created, so that the extension integrates well in OOo and NetBeans. The existing model can be easily adapted to another GUI, hopefully.

* Interfaces that are exported by an UNO object although not being exported by any of the supported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:05:05Z

Cli: /* Known Issues */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== '''The Solution''' ==
The conclusion is that it has be be inspected during runtime what respective capabilities a Uno-Object actually has. The new Object Inspector is an OpenOffice extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a „living Uno-object“ such as all supported services, exported interfaces, and their respective methods and properties in a treeview window.

== '''Usage''' ==
The object inspector may be installed using the package manager (menu „Tools/Options“) by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] . Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== '''IDL help''' ==
The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions. As a new feature the Object inspector also offers to provide the path to a local SDK installation when no internet connection is available. To do so follow the menu "Options/SDK-Path" and select the path to the local SDK-installation in the raised folder picker. The path to the SDK-installation is stored persistently.

== Known issues ==

The Object inspector is still under development and the following list points to some known unresolved defects.

* Filtering is slow and uncomfortable as nodes are collapsing and need to be expanded manually
* IDL help is not working (including context sensitive help)

== '''Future Enhancements''' ==
* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
**Implementation of Array parameters with primitive elements. It would be suitable to provide a textfield for this where the elements have to be added comma-separated.
**Implementation of structs.For each member an own textfield may be provided.
** Implementation of an input mask to refere to Uno-Objects as method parameters. The reference of the Uno-Objects could be retrieved from the treeviewcontrol and the treepath of a node that represents this Uno-object. This reference must then be added to the method parameter's dialog's respective textfield. It must be considered that this dialog may no longer be modal then and that probably this object also has to be retrieved by invocation of methods (probably with complex parameters).
**Consider multidimensional arrays as method parameters and for return values.
*For some method parameters it would be helpful to provide a listbox with all possible values. For example to invoke the method "createInstance(String _sServiceName) a listbox with the return value of "getAvailableServiceNames()" could be offered. Both methods are always provided at the same Uno-Object. Other similar usecases are existent.
*At some time the whole user interface of the object inspector should be ported to Uno. The user interface has been implemented with Java.Swing, because of some missing functionality in Uno. Yet meanwhile treeview controls may be implemented by Uno, too. Tab controls and menus in Uno dialogs are unfortunately not yet available.
*Interfaces that are exported by an Uno-Object although not being exported by any of the suported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.
*Implementation of different views on the inspected Uno-objects is missing and should be specified.as already being mentioned above in the description of the „View“ menu
*Property-nodes are queried right after their creation. However their value might change during runtime and for this reason a context menu entry should be provided to explicitly query the node again.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]

Object Inspector

2009-01-28T12:00:23Z

Cli: /* Source-code generation */

The Object Inspector is an OpenOffice.org extension created to help the developer to inspect arbitrary Uno-Objects.
As Uno provides a service-oriented API with abstract service descriptions exporting defined interfaces the capabilities of a Uno Object does not open up to the developer at design time mainly due to several "deficiencies".
Please note that the Object Inspector is still under development.

== The Problem ==

Generic interfaces like [http://api.openoffice.org/docs/common/ref/com/sun/star/beans/XPropertySet.html XPropertySet] or [http://api.openoffice.org/docs/common/ref/com/sun/star/container/XIndexAccess.html IndexAccess] do not define their exact return value. Service descriptions that export these interfaces mostly do not contain such information either.

It is not always clear at design time which services a UNO object actually supports.

Documentation bugs: as service descriptions do not always show up all actually exported interfaces or properties there may be a certain difference between the theoretical and the practical capabilities of a UNO object.

== '''The Solution''' ==
The conclusion is that it has be be inspected during runtime what respective capabilities a Uno-Object actually has. The new Object Inspector is an OpenOffice extension that has been evolved from the ancient instance inspector that is part of the OpenOffice.org SDK. It displays the total capabilities of a „living Uno-object“ such as all supported services, exported interfaces, and their respective methods and properties in a treeview window.

== '''Usage''' ==
The object inspector may be installed using the package manager (menu „Tools/Options“) by adding the package from [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] . Together with the new package a new toolbar is added from which the object inspector may be started. The object inspector consists of a menu-controlled resizable dialog with a tab control. Each pane of the tab control contains a split pane whose upper component is occupied by a treeview control embedded in a tab pane (see Illustration 1: Object Inspector). The treeview control is to inspected an arbitrary Uno-object. The bottom component of the split control contains a text control used to display the SourceCode needed to create the Uno-Objects represented by nodes of the treeview control. The initial Uno-Object is the document of the currently active frame. The Uno-object of this document is represented by the root node of the treelist control. Expanding this node will create subnodes referencing all subordinate objects, properties, methods and other values of the root object. All this information is presented in various facettes:
Methods of Uno-objects are presented as subnodes under a „Method node“. All methods are listed under this node, no matter what their parental interfaces are. Expanding nodes that denote a method of a Uno-object will invoke the method and if necessary a dialog with an input mask for the method parameters will appear. Note that currently only methods with either no parameters or primitive parameters may be invoked.

Properties of Uno-objects are presented as subnodes under a „Properties“ node.

„Interface“ nodes offer a view to all methods by arranging them under their respective interface.

„Service“ nodes offer a view to all supported services of a Uno-object and their respectively exported interfaces and properties.
"Container" nodes may be expanded to retrieve information about Elements. This node is only applicable when the Uno-objects also depicts a container that exports interfaces like "com.sun.star.container.XIndexAccess"

Expanding any arbitrary subnode will inspect the Uno-object that is represented by the node in the same way as described above. Subnodes that describe methods will invoke this method at the Uno-object. If parameters have to be supplied these have to be delivered by the user in a special dialog that opens up when the node is expanded.

The menubar consists of several menus:

* A „File“ menu to remove tab panes and to quit the object inspector.

* An „Inspect“ menu in order to determine the Uno-objects to be inspected. Clicking on such a menu item will open a new tab pane for a certain Uno-object. Offered Uno-objects are derived from the following items in this menu:
**Empty documents of all given application. text document, empty spreadsheet, empty presentation, empty drawing. Selecting one of these menu entries opens a new tabpane and loads an empty hidden application document.
**Menu entries for each available so-called T-Docs („transient documents“). T-Docs describe the currently opened documents. The object inspector is started with the currently active document as the to-be inspected Uno-object.
**The currently selected object. This menu entry references the Uno-object of the currently selected node. This option is explicitly helpful in vast object hierarchies where the user can easily loose track.
**The global service manager, that can be used to instantiate a great variety of services.

* A„View“ menu: Developers may prefer different views on the respective Uno-Objects depending on the momentary situation and the used programming language. For example StarBasic developers are naturally not very interested what interfaces a Uno object supports as they use the methods directly. On the other hand in StarBasic many „getter“ and „setter“ methods are implemented as properties and should optionally turn up underneath the „Properties“ node. This menu and its underlying functionality has not yet been implementd nor has it been specified.

* An „Options“menu to be used to set all kind of options. In its current state it is possible to choose the to-be-generated sourcecode language and set the path to a local SDK-installation with contained idl-files (interface and service description files).

* A „Help“ menu to aquire help about Uno-objects behind selected nodes. Also via shortcut F1 the browser will open a help document about the used interface or service of a Uno-object , that is referenced by a selected node.
A context menu can be applied on selected nodes and offers some functions to
1) inspect the object behind the selected node in a new tabpane
2) add the source code needed to retrieve the Uno-object behind the node to the bottom component of the split pane.
3) get Help to the referred API functionality like via the "Help" menu

== '''Filtering''' ==

As can be see in Illustration 1: Object Inspector a filter can assist a determined search for subnodes. It also helps to keep the overview especially in large hierarchies.

[[Image:ObjectInspector.PNG]]

Illustration 1 Object Inspector

=='''Calling from a Basic Macro''' ==
The Object Inspector may be instantiated within a Basic script as can be seen in the following examplary script, where the current document is inspected:

<source lang="oobas">
Sub Main
oInspector = createUnoService("org.openoffice.InstanceInspector")
oInspector.inspect(ThisComponent, "My Document")
End Sub
</source>

== Sourcecode generation ==

The Object Inspector is also able to generate Sourcecode snippets that show how to:

* query an interface (if necessary in the selected language)
* invoke a method
* retrieve a property value

Currently there are Codegenerators for Java, C++, Python and Basic. The resulting code is not perfect, but ''should'' compile well.

== '''IDL help''' ==
The user may retrieve help about selected nodes from the idl files of the respective interface and service descriptions. As a new feature the Object inspector also offers to provide the path to a local SDK installation when no internet connection is available. To do so follow the menu "Options/SDK-Path" and select the path to the local SDK-installation in the raised folder picker. The path to the SDK-installation is stored persistently.

== '''Known Issues''' ==
The Object inspector is still under development and the following list points to some known unresolved defects.
*The sourcecode generator ignores nodes that do not contain instantiated objects. This is relevant for method nodes: If for some reason an invoked method node delivers a "null" object the source code generator will completey ignore this node.
*Sourcecode generation below "PropertySetInfo" nodes fail.
*As the depiction of node images of the treeview control caused problem this feature has been deactivated temporarily.
*Setting the filter sometimes lead to ArrayIndexOutOfBoundsException.
*Parameter descriptions of methods node are in the notation of the currently set programming language and not in "Idl" which is not consistant. What makes it worse is that it's not changed when the programming language is changed.
*When the Idl help document is opened an anchor that represents the method or property name of the selected node should be set (see Sourcecode in class UnoNode; Method openIdlDescription).
*invoking "getTypes()" creates the following sourcecode: "Type aTypes = xTypeProvider.getTypes();" Return variable should be sequence.
*The taborder in the „Method-Parameters-Dialog“ does not yet define a cycle. The first focus is not set and when the last control gains the focus the next focus component is not defined.
*SourceCode generation below container nodes is not yet implemented and will currently raise an exception.
*exceptions that are declared by methods are not added to the sourcecode. http://www.openoffice.org/issues/show_bug.cgi?id=74280 addresses this problem.
*After a Node that represents a Uno-object has been expanded it is not checked if subnodes have already been created beforehand.

== '''Future Enhancements''' ==
* Invocation of methods with complex parameters should be implemented. It should be implemented in several steps
**Implementation of Array parameters with primitive elements. It would be suitable to provide a textfield for this where the elements have to be added comma-separated.
**Implementation of structs.For each member an own textfield may be provided.
** Implementation of an input mask to refere to Uno-Objects as method parameters. The reference of the Uno-Objects could be retrieved from the treeviewcontrol and the treepath of a node that represents this Uno-object. This reference must then be added to the method parameter's dialog's respective textfield. It must be considered that this dialog may no longer be modal then and that probably this object also has to be retrieved by invocation of methods (probably with complex parameters).
**Consider multidimensional arrays as method parameters and for return values.
*For some method parameters it would be helpful to provide a listbox with all possible values. For example to invoke the method "createInstance(String _sServiceName) a listbox with the return value of "getAvailableServiceNames()" could be offered. Both methods are always provided at the same Uno-Object. Other similar usecases are existent.
*At some time the whole user interface of the object inspector should be ported to Uno. The user interface has been implemented with Java.Swing, because of some missing functionality in Uno. Yet meanwhile treeview controls may be implemented by Uno, too. Tab controls and menus in Uno dialogs are unfortunately not yet available.
*Interfaces that are exported by an Uno-Object although not being exported by any of the suported services should be distinguished from the other interfaces. There should be displayed some kind of alert as their usage is potentially hazardous, because it is merely based on an implementation detail.
*Implementation of different views on the inspected Uno-objects is missing and should be specified.as already being mentioned above in the description of the „View“ menu
*Property-nodes are queried right after their creation. However their value might change during runtime and for this reason a context menu entry should be provided to explicitly query the node again.

== See Also ==
* [http://api.openoffice.org/Projects/ObjectInspector/Inspector.oxt] Object Inspector binary file
* [[Constructing_Helpers#Reflection_Helper|C++ Reflection Helper]]
* Bernard Marcelly's [http://www.ooomacros.org/dev.php#101416 XRay OOoBasic tool] and a [[Extensions_development_basic#X-Ray_tool|XRay tool description]] in this wiki.
* [[IDL_Files_and_Cpp#Core_reflection_service__and_its_Interfaces| Core Reflection Service]]
* [[IDL_Files_and_Cpp#Using_Java_Inspector|Using Java Inspector]] (C++ and OOoBasic)
* Using [[Programming_OOoWriter#Going_further_with_Inspector|the new object inspector]] with OOoWriter

[[Category:Development]]
[[Category:API]]
[[Category:Extensions]]