Apache OpenOffice Wiki - User contributions [en]

User:Dyrcona/LeopardBuild

2008-12-09T21:39:21Z

Dyrcona: /* Hacking OO.o */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via read-only svn, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page, but it also builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no \
--disable-vba
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
source MacOSXX86Env.Set.sh
./bootstrap
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

If, like me, you use GNU Emacs to edit your source code files, then you might want to add the following line to your .emacs file so that .mm files will be treated as Objective-C++ source code and not nroff code:

<code>
(add-to-list 'auto-mode-alist '("\\.mm" . objc-mode))
</code>

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-06T01:25:53Z

Dyrcona: /* build.sh */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via read-only svn, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page, but it also builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no \
--disable-vba
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
source MacOSXX86Env.Set.sh
./bootstrap
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-06T00:48:49Z

Dyrcona: /* build.sh */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
export MACOSX_DEPLOYMENT_TARGET=10.4
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via read-only svn, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page, but it also builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no \
--disable-vba
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
source MacOSXX86Env.Set.sh
./bootstrap
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-05T23:46:46Z

Dyrcona: /* The Build */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
export MACOSX_DEPLOYMENT_TARGET=10.4
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via read-only svn, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
source MacOSXX86Env.Set.sh
./bootstrap
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-05T23:45:39Z

Dyrcona: /* env.sh */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
export MACOSX_DEPLOYMENT_TARGET=10.4
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via read-only svn, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-05T18:04:59Z

Dyrcona: /* mkBuildDir.sh */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via read-only svn, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-05T18:04:19Z

Dyrcona: /* mkBuildDir.sh */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
cd ${cvsTag}
# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
fi

</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-05T18:00:59Z

Dyrcona: /* mkBuildDir.sh */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
exit 0
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
fi

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./${cvsTag}/moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./${cvsTag}/external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-12-05T17:00:54Z

Dyrcona:

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== svn ====

Since OpenOffice.org has switched to using subversion (svn) for source code control, you will need to use svn rather than cvs to get code.

The version (1.4.4) that ships with Xcode 3.x is sufficient for doing simple checkouts. However, if you wish to switch revisions on a working copy or you have checkin access to the repository, then you will need to install a more recent version (1.5.4) from MacPorts.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Doing update instead of checkout"
cd "${cvsTag}"
svn update
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
svn checkout svn://svn.services.openoffice.org/ooo/tags/${cvsTag}
fi

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffice.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona - OpenOffice.org Wiki

2008-11-20T15:33:23Z

Dyrcona: Removing all content from page

User:Dyrcona - OpenOffice.org Wiki

2008-11-18T21:30:08Z

Dyrcona: New page: <nowiki></nowiki><nowiki><!--[if IE 5.5000]><style type="text/css">@import "/w/...

<nowiki></nowiki><nowiki></nowiki><nowiki></nowiki><nowiki></nowiki><nowiki></nowiki>Head Scripts= User:Dyrcona =
=== From OpenOffice.org Wiki ===
Jump to: [#column-one navigation], [#searchInput search]start contentHi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have started a [http://dyrcona-ooo.blogspot.com/ blog] where I'll post updates about my progress on working with OO.o and the Mac OS X native port.

I have added a page, called [http://wiki.services.openoffice.org/wiki/User:Dyrcona/LeopardBuild /LeopardBuild], with my procedures for building the native Aqua OO.o on Mac OS X Leopard. The instructions on that page are meant to supplement the [http://wiki.services.openoffice.org/wiki/AquaBuild AquaBuild] instructions and not to serve as a replacement for them. I assume that you have already the AquaBuild instructions and understand them.

For those using Colloquy in IRC, I have a modified version of the plaintext.xsl to convert Colloquy transcripts to plaintext. This one addresses the problem that the "official" one has when the same person says more than one thing in a row. [http://wiki.services.openoffice.org/wiki/User:Dyrcona/Colloquy /Colloquy]

Blah, blah, blah.

Saved in parser cache with key wikidb:pcache:idhash:12790-0!1!0!!en!2!edit=0 and timestamp 20081118210740Retrieved from "[http://wiki.services.openoffice.org/wiki/User:Dyrcona http://wiki.services.openoffice.org/wiki/User:Dyrcona]"[http://wiki.services.openoffice.org/wiki/Special:Categories Categories]: [http://wiki.services.openoffice.org/wiki/Category:Porting Porting] | [http://wiki.services.openoffice.org/wiki/Category:MacOSX MacOSX] | [http://wiki.services.openoffice.org/wiki/Category:Aqua Aqua]===== Views =====
* [http://wiki.services.openoffice.org/wiki/User:Dyrcona User page]
* [http://wiki.services.openoffice.org/w/index.php?title=User_talk:Dyrcona&action=edit Discussion]
* [http://wiki.services.openoffice.org/w/index.php?title=User:Dyrcona&action=edit View source]
* [http://wiki.services.openoffice.org/w/index.php?title=User:Dyrcona&action=history History]

===== Personal tools =====
* [http://wiki.services.openoffice.org/w/index.php?title=Special:Userlogin&returnto=User:Dyrcona Log in / create account]

<nowiki></nowiki>===== Navigation =====
* [http://wiki.services.openoffice.org/wiki/Main_Page Main Page]
* [http://wiki.services.openoffice.org/wiki/Special:Recentchanges Recent changes]
* [http://wiki.services.openoffice.org/wiki/Special:Random Random page]
* [http://wiki.services.openoffice.org/wiki/Help:Contents Help]

===== Search =====
  ===== Toolbox =====
* [http://wiki.services.openoffice.org/wiki/Special:Whatlinkshere/User:Dyrcona What links here]
* [http://wiki.services.openoffice.org/wiki/Special:Recentchangeslinked/User:Dyrcona Related changes]
* [http://wiki.services.openoffice.org/wiki/Special:Contributions/Dyrcona User contributions]
* [http://wiki.services.openoffice.org/w/index.php?title=Special:Log&user=Dyrcona Logs]
* [http://wiki.services.openoffice.org/wiki/Special:Upload Upload file]
* [http://wiki.services.openoffice.org/wiki/Special:Specialpages Special pages]
* [http://wiki.services.openoffice.org/w/index.php?title=User:Dyrcona&printable=yes Printable version]
* [http://wiki.services.openoffice.org/w/index.php?title=User:Dyrcona&oldid=71759 Permanent link]
* [http://wiki.services.openoffice.org/w/index.php?title=Special:Collection/render_article/&arttitle=User:Dyrcona&writer=rl Download as PDF]
* [http://wiki.services.openoffice.org/w/index.php?title=Special:Collection/render_article/&arttitle=User:Dyrcona&writer=odf Download as ODF]

===== Create a book =====
* [http://wiki.services.openoffice.org/w/index.php?title=Special:Collection/add_article/&arttitle=User:Dyrcona&oldid=0 Add wiki page]
* [http://wiki.services.openoffice.org/wiki/Help:Collections Collections help]

The category contains more than %PARAM% pages, only the first %PARAM% pages can be added to your collection. Do you want to add them?end of the left (by default at least) column[[Image:poweredby_mediawiki_88x31.png]][[Image:mysql_sun_logo.gif]]* This page was last modified 16:57, 26 March 2008.
* This page has been accessed 255 times.
* Content is available under [http://wiki.services.openoffice.org/wiki/OpenOffice.org_Wiki:Copyrights OpenOffice.org Wiki:Copyrights].
* [http://wiki.services.openoffice.org/wiki/OpenOffice.org_Wiki:Privacy_policy Privacy policy]
* [http://wiki.services.openoffice.org/wiki/OpenOffice.org_Wiki:About About OpenOffice.org Wiki]
* [http://wiki.services.openoffice.org/wiki/OpenOffice.org_Wiki:General_disclaimer Disclaimers]

Served in 0.258 secs.

Pending SCAs

2008-06-05T10:56:06Z

Dyrcona: Remove myself from the list and state that the list has been updated.

The following [[Joint Copyright Assignment]]s are not yet [http://www.openoffice.org/copyright/copyrightapproved.html listed]:
This is not necessarily the contributors fault.
Please list your name below, if it doesn't appear after a week or so.

* Sharif FarsiWeb, Inc. <br> emailed on 2006-02-02. <br> Sent again on 2007-07-22.
* Toshie Abe <br> emailed on 2007-10-02.
* Michel Renon <br> emailed on 2007-12-16
* Goran Rakic <br>SCA emailed on 2008-04-01.
*   <missing JCAs go here>

The list was updated on 2008-06-03.

We will help to track down where the JCA got stuck. The following information helps us to find your JCA.

* Has the JCA been sent via email, fax or postal mail?
* At which date has the email / fax / letter has been sent?

If all fails you might want to resend the JCA.

--[[User:St|stx12]] 22:20, 15 November 2005 (CET)

Pending SCAs

2008-05-24T13:00:45Z

Dyrcona:

The following [[Joint Copyright Assignment]]s are not yet [http://www.openoffice.org/copyright/copyrightapproved.html listed]:
This is not necessarily the contributors fault.
Please list your name below, if it doesn't appear after a week or so.

* Sharif FarsiWeb, Inc. <br> emailed on 2006-02-02. <br> Sent again on 2007-07-22.
* Marcin Miłkowski <br>emailed on 2007-01-10. <br> Sent again on 2007-10-04.
* Toshie Abe <br> emailed on 2007-10-02.
* Michel Renon <br> emailed on 2007-12-16
* Jason Stephenson <br> JCA sent in February 2008 <br> SCA emailed on 2008-03-07
*   <missing JCAs go here>

We will help to track down where the JCA got stuck. The following information helps us to find your JCA.

* Has the JCA been sent via email, fax or postal mail?
* At which date has the email / fax / letter has been sent?

If all fails you might want to resend the JCA.

--[[User:St|stx12]] 22:20, 15 November 2005 (CET)

User:Dyrcona/Colloquy

2008-03-31T00:39:01Z

Dyrcona:

Here is the script, just copy and paste and run it like the official one with xsltproc:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">

<xsl:output method="text" />

<xsl:template match="/log/event | /log/envelope">
<xsl:choose>
<xsl:when test="local-name() = 'event'">
<xsl:call-template name="timestamp">
<xsl:with-param name="date" select="@occurred" />
</xsl:call-template>
<xsl:text>» </xsl:text>
<xsl:value-of select="normalize-space(message)" />
</xsl:when>
<xsl:when test="local-name() = 'envelope'">
<xsl:for-each select="message">
<xsl:call-template name="timestamp">
<xsl:with-param name="date" select="@received" />
</xsl:call-template>
<xsl:value-of select="../sender" /><xsl:text>: </xsl:text>
<xsl:value-of select="normalize-space()" />
<xsl:text>
</xsl:text>
</xsl:for-each>
</xsl:when>
<xsl:otherwise>
<xsl:text>ERROR: can't handle "</xsl:text><xsl:value-of select="local-name()" /><xsl:text>"</xsl:text>
</xsl:otherwise>
</xsl:choose>
<xsl:text>
</xsl:text>
</xsl:template>

<xsl:template name="timestamp">
<xsl:param name="date" /> 

<xsl:text>[</xsl:text>
<xsl:variable name='hour' select='substring($date, 1, 14)' />
<xsl:variable name='minute' select='substring($date, 15, 5)' />

<xsl:value-of select="concat($hour,':',$minute)" />
<xsl:text>] </xsl:text>
</xsl:template>

</xsl:stylesheet>

User:Dyrcona/LeopardBuild

2008-03-27T00:32:54Z

Dyrcona: /* flex */ Add some more information.

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The [http://flex.sourceforge.net/ flex] that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functional Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

If you install flex from MacPorts, you will want to make sure that <code>/opt/local/bin</code> is in your path before <code>/usr/bin</code> or you will end up using the flex that came with Leopard. You could achieve this on a temporary basis by adding <code>export PATH=/opt/local/bin:$PATH</code> to the env.sh file (described below).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffic.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

Documentation/Building Guide/Building on MacOSX

2008-03-26T23:07:08Z

Dyrcona: /* Mac OS X version */

<div align="left" style="color:blue; font-size:18px">'''Cocoa migration is in progress '''</div>
<br>
<div align="left" style="color:red; font-size:18px">'''Please note the new Master Work space (MWS) is now DEV300, means DO NO LONGER USE SRC680 '''</div>
<br>
<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on Mac OS X using the native windowing-toolkit of the platform named Aqua.''' </big>

=== Important links for Cocoa development ===

[http://www.cocoadev.com Cocoadev ]

[http://ktd.club.fr/programmation/objective-c.php Pierre Chatelier page about C++ to Cocoa conversion ]

Note: .pdf available in both english and french versions. Excellent.

(Outdated): To give a kickstart in the coding involved to get VCL ported to Carbon, please have a look at the excellent Pierre de Filippis [[Intro To Mac Porting]].

We use the bash shell in all examples, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description of the build environment here: [http://tools.openoffice.org/build_env.html OpenOffice.org Build Environment].

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]].

'''Here we would like to outline the things you need to build the Aqua Version''' (besides the OS).

=== <div align="left" style="color:red; font-size:18px">'''Mandatory'''</div>===

==== Mac OS X version ====

=> '''Minimal version for AquaBuild is Mac OS X 10.4 (aka Tiger).'''

If you are building on Mac OS X 10.5 (aka Leopard), you will need to be aware of [[User:Dyrcona/LeopardBuild#flex]].

==== Xcode ====

This is the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is '''XCode 2.4.1'''. Older are deprecated.

==== Java ====

Aqua version of OpenOffice.org does not build yet using Java SDK 1.6.0.

'''Please use either J2SDK 1.4.2 or 1.5.0'''

To change the Java version -> go into folder : Applications -> Utilities -> Java and modify.

Else, you'll meet unfixed build breakers (patches are welcome anyway)

Note: If you are interested in helping us with Java 1.6 a patch which enables the build using java 1.6 is available [http://eric.bachard.free.fr/mac/aquavcl/patches/aquavcl03_august2007/java1.6/java_1.6_build.diff '''here''']. e.g. several known build issues have to be fixed e.g. hsqldb, but probably other modules are concerned.

Be aware that it may impact important work and/or incompatibilities will occur. Feel free to submit your patches at mac@porting mailing list.

==== gperf ====

You need a build of [[http://www.gnu.org/software/gperf/gperf.html gperf]] in your path for some modules.

=== <div align="left" style="color:blue; font-size:18px">''' Strongly recommended'''</div>===

==== ccache ====
If you intend to build OpenOffice.org several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using '''[http://www.finkproject.org/ Fink]'''. It is simply named "ccache". For '''[http://www.macports.org/ MacPorts]''' users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

In order to use ccache you need to change the following environment variables '''assuming you're using bash, and just before doing configure command line''':

<pre>
export CC="ccache gcc"
export CXX="ccache g++"
</pre>

== '''Everything is installed ? Now build it... '''==

<br><br>
<div align="left" style="color:green; font-size:22px">'''=> Current Milestone is m4, and current MWS is DEV300'''</div>
<br><br>

== '''Getting the code (checkout, merge and patch the puppy)''' ==

=== Create a directory for a given milestone, setup CVS access: ===

<code>
mkdir DEV300_m4
cd DEV300_m4
export CVSROOT=":pserver:anoncvs@anoncvs.services.openoffice.org:/cvs"
cvs login
(password is 'anoncvs' ) + Enter
</code>

<code>
Note: The source should be downloaded to a path that does not contain any spaces, otherwise compiling might be troublesome.
</code>

=== checkout DEV300 (Master workspace since 3.0 branch creation) (1,5 GB): ===
<code>
cvs -z3 co -r DEV300_m4 OpenOffice2 # don't forget the "2" !!
</code>
Once done, you'll obtain milestone m4 from DEV300 Master workspace

=== <div align="left" style="color:green; font-size:18px">'''Additional dependencies for current Milestone builds'''</div>===

==== prebuilt Mozilla archives ====

To enable the use of macros (disabled by default for security reasons), you'll have to put the prebuilt archives of mozilla binaries in moz/zipped directory after renaming them properly.

Note: archives are Universal Binaries, and you'll have to rename them, depending on your architecture (either Intel or PowerPC)

'''Archives to be downloaded''' :

http://eric.bachard.free.fr/mac/moz/sb83/UB/MACOSXGCCUinc.zip

http://eric.bachard.free.fr/mac/moz/sb83/UB/MACOSXGCCUlib.zip

http://eric.bachard.free.fr/mac/moz/sb83/UB/MACOSXGCCUruntime.zip



'''IMPORTANT : if you want to build OpenOffice.org on Mac OS X using SRC680 sources or DEV300 before sb83 integration (means before DEV300_m4) ,

you MUST use the mozilla archives below''' :

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBinc.zip

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBlib.zip

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBruntime.zip

If you want to build using them on PowerPC or Intel architecture (with Tiger) please rename them this way :

{| border="1"
|Archive || Name in Intel architecture || Name on PowerPC architecture
|-
| headers || MACOSXGCC'''I'''inc.zip || MACOSXGCC'''P'''inc.zip
|-
| runtime || MACOSXGCC'''I'''runtime.zip || MACOSXGCC'''P'''lib.zip
|-
| libs || MACOSXGCC'''I'''lib.zip || MACOSXGCC'''P'''lib.zip
|}

As you can see, '''P''' means PowerPC, and '''I''' means Intel (replacing '''U''' or the '''UB''' (it depends on the builder) in the original name)

.. and put them into '''<ooo build directory>/DEV300_m4/moz/zipped'''
Once done, you'll obtain milestone m0 from DEV300.

OpenOffice.org should detect and use them if you respect the configure command line as described in Milestone build.

=== One-Time preparations and scripts ===

OpenOffice.org's build environment is configured using the popular open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, but in our case this is done in the 'config_office' subdirectory. To save the configure parameters and use them with different milestones I used to link-in my shellscript to fire up the ./configure line.

My directory-structure looks like this:

bin/
DEV300_m4/
DEV300_m2/
DEV300_m0/
SRC680_m248/
...

Now I go to the 'config_office' subdir and link in my startscript:
cd DEV300_m4/config_office/
ln -s ../../bin/build.sh

And this is how 'build.sh' (to be written) looks like :

<code>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US de fr" \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-headless \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</code>

Note : --disable-neon has been removed since m217 resync. See issue : [[http://qa.openoffice.org/issues/show_bug.cgi?id=78206 --disable-neon breaks aqua build]]

--disable-odk : disables SDK build, and will avoid you to download some windows dll which is not needed for aqua-build.

--disable-pasf : pasf stands for Portable Audio System file. As we want to use system library rather than portable ones, we disabled this. However, at this time not all functionality will be available with pasf disabled. You might willing to use --with-pasf if you want working audio in your build.

--without-nas : nas stands for Network Audio System, it uses X11, if you want to use it in your build, just remove this flag. You will need to install the X11 package provided in your CDs/DVD Mac OS X installation. X11 SDK from xCode tools is not required for build this.

--disable-build-mozilla: will disable the mozilla build (in the moz module), but mozilla pre-built archives will be used instead (they are mandatory to enable the macro security configuration dialog (see [http://www.openoffice.org/issues/show_bug.cgi?id=79885 issue 79885]).

--enable-dbgutil: add this option to enable assertions and other functionality useful for debugging

--with-jdk-home must be set as above with XCode 3.0

--with-stlport=no uses Apple's built-in STL, but will cause some warnings

== '''Doing the build (about 4,5 GB)''' ==

Fine, now we have a (hopefully) working 'build.sh' in the config_office subdir. We need to run it beforehand:

cd DEV300_m4/config_office/

./build.sh

This will setup the necessary includefiles and create a couple of files in the '''parent''' directory (bootstrap, MacOSXPPCEnv.Set.sh, MacOSXPPCEnv.Set). If you are using the sh, ksh or bash you only need to take care for 'MacOSXPPCEnv.Set.sh'.

Now we need to get back to our base-directory, run the bootstrap script, source our Enviroment (MacOSXPPCEnv.Set.sh) and finally start the build-process:

==== Mac Intel ====

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
export TMP=/tmp
export SYSTEM_OPENSSL=YES

+
build --all -P4 --dlv_switch -link --dontgraboutput

or

build --all -P4

if you run into trouble with --dlv_switch (see: [http://qa.openoffice.org/issues/show_bug.cgi?id=77360 | issue 77360])

==== On PowerPC ====

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
cd instsetoo_native
export TMP=/tmp
export SYSTEM_OPENSSL=YES

+

build --all -P2 --dlv_switch -link --dontgraboutput

or

build --all -P2

===== Comments on above =====

if you run into trouble with --dlv_switch (see: [http://qa.openoffice.org/issues/show_bug.cgi?id=77360|issue 77360])

The main purpose of the '''bootstrap''' script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for '''running''' svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see [[Environment_Variables]]. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two '''build''' options to get a comfortable view:

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file '''unxmacxi.pro.build.html''' via the in Mac OS X included Apache web server or diretctly form the directory ''/Users/$USER/Sites/''. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

== '''Installing, preparing and running OpenOffice.org''' ==

===''' Find the Bundle''' ===

Once the build completed, the Final product ( en-US version ) is named : OOo_3.0.0_080312_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

[[Image:Bundle_Location3.0beta.jpg]]

<br><br>

=== '''Run the soffice.bin''' ===

In one line :

<big>'''Double click the .dmg , drag the OpenOffice.org icon in the folder you want, and double click to run it !!'''</big>

Note : soffice.bin leads XCode to not work (because of the dot in the name). The issue has been reported to xcode-users list.

We're nearly through, let's fire-off the binary:

But a lot has to be done, and if you want to trace (using gdb e.g.), just do:

cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS

and run:

gdb --args soffice.bin

(add any breakpoint you want)

r to run OpenOffice.org

=== Use vcl menubar and / or vcl menus ===

Native menus are defaults. If you want to use vcl menus, do:

<pre>
AQUA_NATIVE_MENUS=FALSE ./soffice.bin
</pre>

Note: options to not recover is -norestore , and to bypass the user informations to fill in, use -nofirststartwizard

AQUA_NATIVE_MENUS=FALSE ./soffice.bin -nofirststartwizard -norestore

You can also insert environement variables in a Dictionary Class of Info.plist located in the Contents directory of OpenOffice.org bundle.

For example, you can add the following XML in a text editor (or make it generated by Property List Editor) in your Info.plist :

<key>LSEnvironment</key>
<dict>
<key>AQUA_NATIVE_MENUS</key>
<string>TRUE</string>
<key>OOO_DISABLE_RECOVERY</key>
<string>TRUE</string>
<key>SAL_NO_NWF</key>
<string>TRUE</string>
<dict>

Notice that in order to work, the OOO_DISABLE_RECOVERY variable detection must be manually inserted in OOo code using the following patch :
http://www.go-oo.org/patches/src680/disable-recovery.diff

This patch is outdated, but you can make the modifications yourself.

Notice the enviroment variable here. AQUA_NATIVE_MENUS is experimental stuff created by Pavel, SAL_NO_NWF was created some times ago, and is located in vcl/source/window/window.cxx . At the moment we have:

{| border="1" cellpadding="15" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_NWF=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=FALSE || disable native menus code
|}

Both changes are marked with comments in the source code, and when we remove them in the future, native controls and native menus will be enabled by default.

== '''Debug and contribute ''' ==
<ul>
<li>You want to provide crash issue details? Please see [[Providing_a_gdb_backtrace]]</li>
<li>You want to debug using XCode? Please see [[MacOSX_Debug_OpenOffice.org_using_XCode]]</li>
<li>You want to debug using Xemacs? Please see [http://www.mikesicotte.com/2007/02/21/debugging-ooo-with-xemacs-and-gdb Michael Sicotte's blog entry]</li>
</ul>

<br>

<div align="left" style="color:green; font-size:18px">'''[[AquaBuild/Cocoa Informations]] <== Additionnal informations for advanced developers '''</div>

<br>

== '''Current Work in progress''' ==

==='''Developers are working on the following Child workspaces, all Mac OSX dedicated (not integrated )''' ===

* aquavcl06 (planned)

* macosxscanner (planned)

==='''Closed for development''' ===

*'''quicklookplugin01''' : This cws provides a plugin for the QuickLook system available in MacOSX from versions 10.5 onwards

Concerned modules : extensions scp2

==='''Integrated''' ===

Integrated in dev300_m2

*'''[http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Faquavcl05 aquavcl05]''':

concerned modules : automation avmedia connectivity default_images desktop filter framework

instsetoo_native jvmfwk lingucomponent officecfg sal sc scp2 sfx2 shell vcl

*'''aquafilepicker02''' : replace Carbon native FilePicker with Cocoa native FilePicker

Concerned module : fpicker sfx2 solenv svtools

*'''nativeprintdlg01''' : add support for native print dialog

Concerned modules: offapi, vcl, sfx2, svtools, sw

Integrated m248

*'''macosxdnd''' Drag and Drop for Aqua

Concerned modules : dtrans svtools vcl

Integrated m247

* '''obr07'''

Remove a few Mac OS X specialties

Concerned modules: desktop instsetoo_native scp2 setup_native solenv sysui vcl

Integrated in m243

*'''stl4leopardppc''' : allow OpenOffice.org to be built on Mac OS X 10.5 PowerPC using system stl, using --without-stlport4 configure option.

If possible, continue with other builds (Leopard / Tiger Intel and PowerPC).

Concerned modules : connectivity, cosv, fpicker, autodoc

*'''[http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Faquavcl04 aquavcl04]''':

concerned modules : desktop vcl rsc shell svx sw solenv instsetoo_native

Integrated in m239

*'''macosxquicktime01''' : use QTKit for sounds and movies

Concerned modules : avmedia scp2 vcl

Integrated in m238

*'''macosx24dmg''' : fix bad icon positionning in the mounted disk image ( already Approved by QA )

Concerned module : instsetoo_native

Integrated in m237

*'''pj86''' : Make module sw warning free on Mac OS X

Concerned modules : sw , solenv

*'''macleopardbuild''' : be Leopard compatible, when building on Tiger

Concerned modules : idlc soltools jvmfwk extensions stlport

Integrated in m233

*'''readme4macintel'''

concerned module : readlicense_oo

Integrated in m233

*'''aquavcl03''' ( Carbon -> Cocoa migration )

concerned modules are desktop, instsetoo_native, solenv, svtools, vcl

*'''spotlightplugin01''' ( add a new Sportlight plugin )

Concerned modules: extensions, scp2

Integrated in m229

*'''macaddressbook01''' (QA in progress )

concerned modules are : scp2, dbaccess, extensions, connectivity

*'''macosxspellchecker''' : use Mac OS X spellchecker

Concerned modules: lingucomponent, solenv

*'''aquavclcarbonfixes''' ( Carbon version of Aqua OpenOffice.org ): fix the 5 most important issues.

concerned modules are : desktop, vcl, fpicker, libxmlsec, xmlsecurity, basic

Integrated in m228

*'''cloph09''' ( remove X11SDK dependance for Aquabuild )

Concerned modules: np_sdk

Integrated in m227

*'''aquaremovescripts''': remove useless Applescripts from Aqua version

concerned module: instsetoo_native

Integrated in m223:

*'''aquavcl02'''

Integrated in m222 :

*'''aquaremovefondu'''

*macosxdmg23

Integrated in m221:

*'''aquafilepicker01'''

All patches that developers have that need testing or peer review should be added here.

== '''Known build issues '''==

*'''Panther''' build (X11 only) : currently broken ( work in progress )

Since latest resync, no build issues have been reported.

*'''Tiger''': no problem nor for X11 nor Aqua versions (main baseline)

*'''Leopard''' Intel : builds OK now. Build is broken in cppu for PowerPC architecture, and builds fine using --without-stlport4 flag

*Native FilePicker is fixed (aquafilepicker02 + pl fixed repaint issue )

*Lot of warnings in vcl, due to other deprecated stuff

<div align="left" style="color:grey; font-size:12px">[[AquaBuild/Some Background | '''Some Background (what is aquavcl01, EIS) (click me to know more) ''']]</div><br><br>

== '''External links''' ==

# [http://www.openoffice.org/issues/query.cgi Bug Database]
# Mailinglist: [http://porting.openoffice.org/servlets/ProjectMailingListList mac@porting.openoffice.org] (subscribe is mandatory )
# IRC Meeting-Logs (#ooo_macport@freenode.org): [[Previous_Mac_Meeting_logs]] [[MacOSXPortMeetings]]
# TX20: http://eric.bachard.free.fr/UTBM_TX20/reports/Carbon_vcl.pdf
# OpenOffice Source Directory Structure: http://wiki.services.openoffice.org/wiki/Source_code_directories
# Pavels Patch Wiki: http://blog.janik.cz/
# Eric Bachard Wiki: http://wiki.services.openoffice.org/wiki/User:Ericb
# Sebastien Plisson Wiki: http://splisson.blogspot.com/
# Christian Lippka Wiki: http://wiki.services.openoffice.org/wiki/User:CL
# Carbon: http://developer.apple.com/carbon
# EIS: http://eis.services.openoffice.org/EIS2/servlet/Logon
# Runtime Configuration: http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/index.html
# OpenOffice Domain Developer http://wiki.services.openoffice.org/wiki/DomainDeveloper
# Nakata Maho's package build service http://ooopackages.good-day.net/pub/OpenOffice.org/MacOSX/

== '''Screenshots''' ==

# Eric Bachard screenshots (some are from Stephan Schaefer) http://eric.bachard.free.fr/mac/aquavcl/screenshots/
# Most recent: http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_menus_05_nov_06/
# Pavel Janik screenshots http://blog.janik.cz/images/MacOSX/2006-08-10
# Important screenshot (eventloop issue): http://blog.janik.cz/images/MacOSX/ => See: OOoMenus-separator-and-disabled_entries.png
# current Aqua look (taken from CWS aquavcl05):
[[image:Aqualook.png]]

More menus: http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_menus_05_nov_06/index.html

[[Category:MacOSX]]
[[Category:Porting]]
[[Category:Development]]
[[Category:Aqua]]
[[Category:Build_System]]

Documentation/Building Guide/Building on MacOSX

2008-03-26T23:06:52Z

Dyrcona: /* Mac OS X version */ Add not about flex.

<div align="left" style="color:blue; font-size:18px">'''Cocoa migration is in progress '''</div>
<br>
<div align="left" style="color:red; font-size:18px">'''Please note the new Master Work space (MWS) is now DEV300, means DO NO LONGER USE SRC680 '''</div>
<br>
<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on Mac OS X using the native windowing-toolkit of the platform named Aqua.''' </big>

=== Important links for Cocoa development ===

[http://www.cocoadev.com Cocoadev ]

[http://ktd.club.fr/programmation/objective-c.php Pierre Chatelier page about C++ to Cocoa conversion ]

Note: .pdf available in both english and french versions. Excellent.

(Outdated): To give a kickstart in the coding involved to get VCL ported to Carbon, please have a look at the excellent Pierre de Filippis [[Intro To Mac Porting]].

We use the bash shell in all examples, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description of the build environment here: [http://tools.openoffice.org/build_env.html OpenOffice.org Build Environment].

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]].

'''Here we would like to outline the things you need to build the Aqua Version''' (besides the OS).

=== <div align="left" style="color:red; font-size:18px">'''Mandatory'''</div>===

==== Mac OS X version ====

=> '''Minimal version for AquaBuild is Mac OS X 10.4 (aka Tiger).'''

I you are building on Mac OS X 10.5 (aka Leopard), you will need to be aware of [[User:Dyrcona/LeopardBuild#flex]].

==== Xcode ====

This is the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is '''XCode 2.4.1'''. Older are deprecated.

==== Java ====

Aqua version of OpenOffice.org does not build yet using Java SDK 1.6.0.

'''Please use either J2SDK 1.4.2 or 1.5.0'''

To change the Java version -> go into folder : Applications -> Utilities -> Java and modify.

Else, you'll meet unfixed build breakers (patches are welcome anyway)

Note: If you are interested in helping us with Java 1.6 a patch which enables the build using java 1.6 is available [http://eric.bachard.free.fr/mac/aquavcl/patches/aquavcl03_august2007/java1.6/java_1.6_build.diff '''here''']. e.g. several known build issues have to be fixed e.g. hsqldb, but probably other modules are concerned.

Be aware that it may impact important work and/or incompatibilities will occur. Feel free to submit your patches at mac@porting mailing list.

==== gperf ====

You need a build of [[http://www.gnu.org/software/gperf/gperf.html gperf]] in your path for some modules.

=== <div align="left" style="color:blue; font-size:18px">''' Strongly recommended'''</div>===

==== ccache ====
If you intend to build OpenOffice.org several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using '''[http://www.finkproject.org/ Fink]'''. It is simply named "ccache". For '''[http://www.macports.org/ MacPorts]''' users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

In order to use ccache you need to change the following environment variables '''assuming you're using bash, and just before doing configure command line''':

<pre>
export CC="ccache gcc"
export CXX="ccache g++"
</pre>

== '''Everything is installed ? Now build it... '''==

<br><br>
<div align="left" style="color:green; font-size:22px">'''=> Current Milestone is m4, and current MWS is DEV300'''</div>
<br><br>

== '''Getting the code (checkout, merge and patch the puppy)''' ==

=== Create a directory for a given milestone, setup CVS access: ===

<code>
mkdir DEV300_m4
cd DEV300_m4
export CVSROOT=":pserver:anoncvs@anoncvs.services.openoffice.org:/cvs"
cvs login
(password is 'anoncvs' ) + Enter
</code>

<code>
Note: The source should be downloaded to a path that does not contain any spaces, otherwise compiling might be troublesome.
</code>

=== checkout DEV300 (Master workspace since 3.0 branch creation) (1,5 GB): ===
<code>
cvs -z3 co -r DEV300_m4 OpenOffice2 # don't forget the "2" !!
</code>
Once done, you'll obtain milestone m4 from DEV300 Master workspace

=== <div align="left" style="color:green; font-size:18px">'''Additional dependencies for current Milestone builds'''</div>===

==== prebuilt Mozilla archives ====

To enable the use of macros (disabled by default for security reasons), you'll have to put the prebuilt archives of mozilla binaries in moz/zipped directory after renaming them properly.

Note: archives are Universal Binaries, and you'll have to rename them, depending on your architecture (either Intel or PowerPC)

'''Archives to be downloaded''' :

http://eric.bachard.free.fr/mac/moz/sb83/UB/MACOSXGCCUinc.zip

http://eric.bachard.free.fr/mac/moz/sb83/UB/MACOSXGCCUlib.zip

http://eric.bachard.free.fr/mac/moz/sb83/UB/MACOSXGCCUruntime.zip



'''IMPORTANT : if you want to build OpenOffice.org on Mac OS X using SRC680 sources or DEV300 before sb83 integration (means before DEV300_m4) ,

you MUST use the mozilla archives below''' :

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBinc.zip

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBlib.zip

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBruntime.zip

If you want to build using them on PowerPC or Intel architecture (with Tiger) please rename them this way :

{| border="1"
|Archive || Name in Intel architecture || Name on PowerPC architecture
|-
| headers || MACOSXGCC'''I'''inc.zip || MACOSXGCC'''P'''inc.zip
|-
| runtime || MACOSXGCC'''I'''runtime.zip || MACOSXGCC'''P'''lib.zip
|-
| libs || MACOSXGCC'''I'''lib.zip || MACOSXGCC'''P'''lib.zip
|}

As you can see, '''P''' means PowerPC, and '''I''' means Intel (replacing '''U''' or the '''UB''' (it depends on the builder) in the original name)

.. and put them into '''<ooo build directory>/DEV300_m4/moz/zipped'''
Once done, you'll obtain milestone m0 from DEV300.

OpenOffice.org should detect and use them if you respect the configure command line as described in Milestone build.

=== One-Time preparations and scripts ===

OpenOffice.org's build environment is configured using the popular open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, but in our case this is done in the 'config_office' subdirectory. To save the configure parameters and use them with different milestones I used to link-in my shellscript to fire up the ./configure line.

My directory-structure looks like this:

bin/
DEV300_m4/
DEV300_m2/
DEV300_m0/
SRC680_m248/
...

Now I go to the 'config_office' subdir and link in my startscript:
cd DEV300_m4/config_office/
ln -s ../../bin/build.sh

And this is how 'build.sh' (to be written) looks like :

<code>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US de fr" \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-headless \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</code>

Note : --disable-neon has been removed since m217 resync. See issue : [[http://qa.openoffice.org/issues/show_bug.cgi?id=78206 --disable-neon breaks aqua build]]

--disable-odk : disables SDK build, and will avoid you to download some windows dll which is not needed for aqua-build.

--disable-pasf : pasf stands for Portable Audio System file. As we want to use system library rather than portable ones, we disabled this. However, at this time not all functionality will be available with pasf disabled. You might willing to use --with-pasf if you want working audio in your build.

--without-nas : nas stands for Network Audio System, it uses X11, if you want to use it in your build, just remove this flag. You will need to install the X11 package provided in your CDs/DVD Mac OS X installation. X11 SDK from xCode tools is not required for build this.

--disable-build-mozilla: will disable the mozilla build (in the moz module), but mozilla pre-built archives will be used instead (they are mandatory to enable the macro security configuration dialog (see [http://www.openoffice.org/issues/show_bug.cgi?id=79885 issue 79885]).

--enable-dbgutil: add this option to enable assertions and other functionality useful for debugging

--with-jdk-home must be set as above with XCode 3.0

--with-stlport=no uses Apple's built-in STL, but will cause some warnings

== '''Doing the build (about 4,5 GB)''' ==

Fine, now we have a (hopefully) working 'build.sh' in the config_office subdir. We need to run it beforehand:

cd DEV300_m4/config_office/

./build.sh

This will setup the necessary includefiles and create a couple of files in the '''parent''' directory (bootstrap, MacOSXPPCEnv.Set.sh, MacOSXPPCEnv.Set). If you are using the sh, ksh or bash you only need to take care for 'MacOSXPPCEnv.Set.sh'.

Now we need to get back to our base-directory, run the bootstrap script, source our Enviroment (MacOSXPPCEnv.Set.sh) and finally start the build-process:

==== Mac Intel ====

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
export TMP=/tmp
export SYSTEM_OPENSSL=YES

+
build --all -P4 --dlv_switch -link --dontgraboutput

or

build --all -P4

if you run into trouble with --dlv_switch (see: [http://qa.openoffice.org/issues/show_bug.cgi?id=77360 | issue 77360])

==== On PowerPC ====

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
cd instsetoo_native
export TMP=/tmp
export SYSTEM_OPENSSL=YES

+

build --all -P2 --dlv_switch -link --dontgraboutput

or

build --all -P2

===== Comments on above =====

if you run into trouble with --dlv_switch (see: [http://qa.openoffice.org/issues/show_bug.cgi?id=77360|issue 77360])

The main purpose of the '''bootstrap''' script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for '''running''' svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see [[Environment_Variables]]. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two '''build''' options to get a comfortable view:

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file '''unxmacxi.pro.build.html''' via the in Mac OS X included Apache web server or diretctly form the directory ''/Users/$USER/Sites/''. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

== '''Installing, preparing and running OpenOffice.org''' ==

===''' Find the Bundle''' ===

Once the build completed, the Final product ( en-US version ) is named : OOo_3.0.0_080312_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

[[Image:Bundle_Location3.0beta.jpg]]

<br><br>

=== '''Run the soffice.bin''' ===

In one line :

<big>'''Double click the .dmg , drag the OpenOffice.org icon in the folder you want, and double click to run it !!'''</big>

Note : soffice.bin leads XCode to not work (because of the dot in the name). The issue has been reported to xcode-users list.

We're nearly through, let's fire-off the binary:

But a lot has to be done, and if you want to trace (using gdb e.g.), just do:

cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS

and run:

gdb --args soffice.bin

(add any breakpoint you want)

r to run OpenOffice.org

=== Use vcl menubar and / or vcl menus ===

Native menus are defaults. If you want to use vcl menus, do:

<pre>
AQUA_NATIVE_MENUS=FALSE ./soffice.bin
</pre>

Note: options to not recover is -norestore , and to bypass the user informations to fill in, use -nofirststartwizard

AQUA_NATIVE_MENUS=FALSE ./soffice.bin -nofirststartwizard -norestore

You can also insert environement variables in a Dictionary Class of Info.plist located in the Contents directory of OpenOffice.org bundle.

For example, you can add the following XML in a text editor (or make it generated by Property List Editor) in your Info.plist :

<key>LSEnvironment</key>
<dict>
<key>AQUA_NATIVE_MENUS</key>
<string>TRUE</string>
<key>OOO_DISABLE_RECOVERY</key>
<string>TRUE</string>
<key>SAL_NO_NWF</key>
<string>TRUE</string>
<dict>

Notice that in order to work, the OOO_DISABLE_RECOVERY variable detection must be manually inserted in OOo code using the following patch :
http://www.go-oo.org/patches/src680/disable-recovery.diff

This patch is outdated, but you can make the modifications yourself.

Notice the enviroment variable here. AQUA_NATIVE_MENUS is experimental stuff created by Pavel, SAL_NO_NWF was created some times ago, and is located in vcl/source/window/window.cxx . At the moment we have:

{| border="1" cellpadding="15" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_NWF=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=FALSE || disable native menus code
|}

Both changes are marked with comments in the source code, and when we remove them in the future, native controls and native menus will be enabled by default.

== '''Debug and contribute ''' ==
<ul>
<li>You want to provide crash issue details? Please see [[Providing_a_gdb_backtrace]]</li>
<li>You want to debug using XCode? Please see [[MacOSX_Debug_OpenOffice.org_using_XCode]]</li>
<li>You want to debug using Xemacs? Please see [http://www.mikesicotte.com/2007/02/21/debugging-ooo-with-xemacs-and-gdb Michael Sicotte's blog entry]</li>
</ul>

<br>

<div align="left" style="color:green; font-size:18px">'''[[AquaBuild/Cocoa Informations]] <== Additionnal informations for advanced developers '''</div>

<br>

== '''Current Work in progress''' ==

==='''Developers are working on the following Child workspaces, all Mac OSX dedicated (not integrated )''' ===

* aquavcl06 (planned)

* macosxscanner (planned)

==='''Closed for development''' ===

*'''quicklookplugin01''' : This cws provides a plugin for the QuickLook system available in MacOSX from versions 10.5 onwards

Concerned modules : extensions scp2

==='''Integrated''' ===

Integrated in dev300_m2

*'''[http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Faquavcl05 aquavcl05]''':

concerned modules : automation avmedia connectivity default_images desktop filter framework

instsetoo_native jvmfwk lingucomponent officecfg sal sc scp2 sfx2 shell vcl

*'''aquafilepicker02''' : replace Carbon native FilePicker with Cocoa native FilePicker

Concerned module : fpicker sfx2 solenv svtools

*'''nativeprintdlg01''' : add support for native print dialog

Concerned modules: offapi, vcl, sfx2, svtools, sw

Integrated m248

*'''macosxdnd''' Drag and Drop for Aqua

Concerned modules : dtrans svtools vcl

Integrated m247

* '''obr07'''

Remove a few Mac OS X specialties

Concerned modules: desktop instsetoo_native scp2 setup_native solenv sysui vcl

Integrated in m243

*'''stl4leopardppc''' : allow OpenOffice.org to be built on Mac OS X 10.5 PowerPC using system stl, using --without-stlport4 configure option.

If possible, continue with other builds (Leopard / Tiger Intel and PowerPC).

Concerned modules : connectivity, cosv, fpicker, autodoc

*'''[http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Path=SRC680%2Faquavcl04 aquavcl04]''':

concerned modules : desktop vcl rsc shell svx sw solenv instsetoo_native

Integrated in m239

*'''macosxquicktime01''' : use QTKit for sounds and movies

Concerned modules : avmedia scp2 vcl

Integrated in m238

*'''macosx24dmg''' : fix bad icon positionning in the mounted disk image ( already Approved by QA )

Concerned module : instsetoo_native

Integrated in m237

*'''pj86''' : Make module sw warning free on Mac OS X

Concerned modules : sw , solenv

*'''macleopardbuild''' : be Leopard compatible, when building on Tiger

Concerned modules : idlc soltools jvmfwk extensions stlport

Integrated in m233

*'''readme4macintel'''

concerned module : readlicense_oo

Integrated in m233

*'''aquavcl03''' ( Carbon -> Cocoa migration )

concerned modules are desktop, instsetoo_native, solenv, svtools, vcl

*'''spotlightplugin01''' ( add a new Sportlight plugin )

Concerned modules: extensions, scp2

Integrated in m229

*'''macaddressbook01''' (QA in progress )

concerned modules are : scp2, dbaccess, extensions, connectivity

*'''macosxspellchecker''' : use Mac OS X spellchecker

Concerned modules: lingucomponent, solenv

*'''aquavclcarbonfixes''' ( Carbon version of Aqua OpenOffice.org ): fix the 5 most important issues.

concerned modules are : desktop, vcl, fpicker, libxmlsec, xmlsecurity, basic

Integrated in m228

*'''cloph09''' ( remove X11SDK dependance for Aquabuild )

Concerned modules: np_sdk

Integrated in m227

*'''aquaremovescripts''': remove useless Applescripts from Aqua version

concerned module: instsetoo_native

Integrated in m223:

*'''aquavcl02'''

Integrated in m222 :

*'''aquaremovefondu'''

*macosxdmg23

Integrated in m221:

*'''aquafilepicker01'''

All patches that developers have that need testing or peer review should be added here.

== '''Known build issues '''==

*'''Panther''' build (X11 only) : currently broken ( work in progress )

Since latest resync, no build issues have been reported.

*'''Tiger''': no problem nor for X11 nor Aqua versions (main baseline)

*'''Leopard''' Intel : builds OK now. Build is broken in cppu for PowerPC architecture, and builds fine using --without-stlport4 flag

*Native FilePicker is fixed (aquafilepicker02 + pl fixed repaint issue )

*Lot of warnings in vcl, due to other deprecated stuff

<div align="left" style="color:grey; font-size:12px">[[AquaBuild/Some Background | '''Some Background (what is aquavcl01, EIS) (click me to know more) ''']]</div><br><br>

== '''External links''' ==

# [http://www.openoffice.org/issues/query.cgi Bug Database]
# Mailinglist: [http://porting.openoffice.org/servlets/ProjectMailingListList mac@porting.openoffice.org] (subscribe is mandatory )
# IRC Meeting-Logs (#ooo_macport@freenode.org): [[Previous_Mac_Meeting_logs]] [[MacOSXPortMeetings]]
# TX20: http://eric.bachard.free.fr/UTBM_TX20/reports/Carbon_vcl.pdf
# OpenOffice Source Directory Structure: http://wiki.services.openoffice.org/wiki/Source_code_directories
# Pavels Patch Wiki: http://blog.janik.cz/
# Eric Bachard Wiki: http://wiki.services.openoffice.org/wiki/User:Ericb
# Sebastien Plisson Wiki: http://splisson.blogspot.com/
# Christian Lippka Wiki: http://wiki.services.openoffice.org/wiki/User:CL
# Carbon: http://developer.apple.com/carbon
# EIS: http://eis.services.openoffice.org/EIS2/servlet/Logon
# Runtime Configuration: http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/index.html
# OpenOffice Domain Developer http://wiki.services.openoffice.org/wiki/DomainDeveloper
# Nakata Maho's package build service http://ooopackages.good-day.net/pub/OpenOffice.org/MacOSX/

== '''Screenshots''' ==

# Eric Bachard screenshots (some are from Stephan Schaefer) http://eric.bachard.free.fr/mac/aquavcl/screenshots/
# Most recent: http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_menus_05_nov_06/
# Pavel Janik screenshots http://blog.janik.cz/images/MacOSX/2006-08-10
# Important screenshot (eventloop issue): http://blog.janik.cz/images/MacOSX/ => See: OOoMenus-separator-and-disabled_entries.png
# current Aqua look (taken from CWS aquavcl05):
[[image:Aqualook.png]]

More menus: http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_menus_05_nov_06/index.html

[[Category:MacOSX]]
[[Category:Porting]]
[[Category:Development]]
[[Category:Aqua]]
[[Category:Build_System]]

User:Dyrcona/LeopardBuild

2008-03-26T22:37:46Z

Dyrcona: /* Prerequisites */ Fill it out.

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

If you are a serious f/oss programmer, then you will definitely want to install [http://www.macports.org/ MacPorts] on your development computer. It contains easy to install ports of many free software packages. All of the packages listed below are available in MacPorts and have proved indispensable to me in my programming.

It is beyond the scope of this document to tell you how to install and work with MacPorts. Those topics are already covered by their ample documentation.

==== ccache ====

The ccache program is highly recommended on the [[AquaBuild#ccache]] page. My scripts and environment files listed below assume that you have installed this package. I find it very useful when changing build options or trying out various patches. It greatly speeds up build times in those cases. You can install this from MacPorts.

==== flex ====

The flex that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functioning Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffic.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-26T18:34:38Z

Dyrcona: Add prerequisites section.

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Prerequisites ===

In addition to XCode 3.0, you will want the following software.

==== MacPorts ====

To be filled in.

==== ccache ====

To be filled in.

==== flex ====

The flex that comes with Leopard is not useful for building OO.o. Specifically, the SQL syntax checker in Base ends up broken and you have a very hard time working with databases. If you want a functioning Base, you will need to install an alternate version of flex. I highly recommend installing whatever the latest version is in MacPorts (2.5.35 as of this writing).

==== gperf ====

Leopard comes with an acceptable version of gperf in /usr/bin. However, you might want to install the one from MacPorts, or it may have been installed by another package along the way.

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffic.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/Colloquy

2008-03-26T17:02:02Z

Dyrcona: New page: Here is the script, just copy and paste and run it like the official one with xsltproc: <pre> <?xml version="1.0" encoding="UTF-8"?> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/...

User:Dyrcona

2008-03-26T16:57:11Z

Dyrcona: Add Colloquy transcript converter.

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have started a [http://dyrcona-ooo.blogspot.com/ blog] where I'll post updates about my progress on working with OO.o and the Mac OS X native port.

I have added a page, called [[/LeopardBuild]], with my procedures for building the native Aqua OO.o on Mac OS X Leopard. The instructions on that page are meant to supplement the [[AquaBuild]] instructions and not to serve as a replacement for them. I assume that you have already the AquaBuild instructions and understand them.

For those using Colloquy in IRC, I have a modified version of the plaintext.xsl to convert Colloquy transcripts to plaintext. This one addresses the problem that the "official" one has when the same person says more than one thing in a row. [[/Colloquy]]

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-21T13:58:55Z

Dyrcona: /* The Build */ Add some explanatory text.

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m3) comprises 98,117 files in 13,307 directories that occupy about 1.8 GB of space on disk. Those 13,307 directories are themselves split among 179 modules, each module being a top-level directory. Good file organization is necessary to work effectively with such a large project.

If you work on several different projects, not just OO.o, you might like to keep your code files neatly organized and separate from your other files. To that end, I suggest creating a subdirectory, called <code>Sources</code>, in your home directory. In this directory, you could create a subdirectory for each of your major projects. Thus, the code for each project is neatly organized and distinct from the others.

In the case of OO.o, a further subdivision of the project directory helps to organize the various builds and other files. First, one has the main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where all of the OpenOffice.org-related code and build files may be kept. Under this main project directory, a <code>bin</code> subdirectory is a useful place to keep some scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that are recommended to speed up the total OO.o build process. If you work on more than one release at a time, or if you try different milestones, then you will likely want a subdirectory name for each milestone CVS tag that you checkout. You might also want to incorporate the name of any CWS that you integrate into that build. Finally, once you begin actually making changes to the OpenOffice.org code, or if you receive any patches from another developer, you will want a directory to store these. I call this directory <code>diff</code> in my setup.

The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
diff/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

You can get pre-built binaries for a couple of things that OO.o relies on to speed up your build. Otherwise, you will have to build these yourself.

==== Mozilla ====

You should follow the instructions in the main [[AquaBuild#prebuilt_Mozilla_archives]] page if you want to get pre-built Mozilla binaries.

==== unowinreg.dll ====

The unowinreg.dll is only required if you plan to build and use the OO.o SDK with Java. (My instructions and build script posted here assume that you do.) You can find the latest unowinreg.dll binary as of this writing at the [http://tools.openoffice.org/unowinreg_prebuild/680/ tools website]. ('''NOTE:''' This is a MS Windows DLL, and you cannot actually build this file on Mac OS X at this time. You do actually have the source for it in your checkout, though.)

=== Scripts and Environment Files ===

The following are useful snippets to store in files under your <code>$HOME/Sources/OpenOffice.org/bin/</code> subdirectory.

==== env.sh ====

This file sets up some useful environment settings before doing a build. It is best run in the subdirectory named for the CVS tag that you are building.

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

==== mkBuildDir.sh ====

This script will setup a new build directory based on a CVS tag. It does everything to create the new directory, download the files via anonymous CVS, and copy pre-built binary files into the appropriate places in the build directory. You generally run this one in <code>$HOME/Sources/OpenOffice.org/</code>.

<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

==== build.sh ====

The following is the build script that I use to configure OpenOffice.org builds. It is copied from the one provided on the AquaBuild page. However, this script differs in that it disables binfilter (the StarOffice 5.2 compatibility layer) and builds the SDK.

<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-binfilter \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no
</pre>

=== The Build ===

The following steps when executed in a Terminal window under the default bash shell will get you a build directory checked out and then start a build of OpenOffice.org. Hopefully, you are a patient person as the below can take over 6 hours depending on the speed of your computer's CPU, how much RAM it has, and just what else you're doing on the computer. I often do the build just before going to bed, so it is usually ready when I wake up in the morning.

<pre>
cd ~/Sources/OpenOffic.org/
bin/mkBuilDir.sh {CVSTAG}
cd {CVSTAG}
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

You will, of course, want to replace <code>{CVSTAG}</code> in the above example with the actual CVS tag of the milestone or snapshot that you wish to build, <code>DEV300_m3</code> for example.

More advanced users might also wish to insert some steps to apply patches or to checkout code from various CWS before doing the build. Such advanced topics are best left for another discussion.

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

Inside the OpenOffice_SDK dmg file is a folder that you can drag to wherever you want to put it on your disk. (I'd suggest somewhere under <code>$HOME/Sources/</code>.) It is beyond the scope this document to tell you how to use the SDK, but there is a [http://api.openoffice.org/ whole site] dedicated to that very thing.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-21T13:35:51Z

Dyrcona: /* Scripts and Environment Files */ Add some explanatory text.

User:Dyrcona/LeopardBuild

2008-03-21T12:50:30Z

Dyrcona: /* Installing/Using the Result */ Tell how to install the SDK.

User:Dyrcona/LeopardBuild

2008-03-21T12:42:54Z

Dyrcona: /* Getting Pre-built Binaries */ Add some content to this part.

User:Dyrcona/LeopardBuild

2008-03-21T01:16:14Z

Dyrcona: /* File Organization */ Add mention of diff subdirectory.

User:Dyrcona/LeopardBuild

2008-03-21T01:09:44Z

Dyrcona: /* Scripts and Environment Files */ Add --disable-binfilter to reflect what I'm actually building at the moment.

User:Dyrcona/LeopardBuild

2008-03-16T16:57:16Z

Dyrcona: /* Scripts and Environment Files */ Remove extaneous space in script.

User:Dyrcona/LeopardBuild

2008-03-16T16:53:11Z

Dyrcona: /* File Organization */ Provide more accurate numbers and make the language less egocentric.

User:Dyrcona/LeopardBuild

2008-03-16T15:15:32Z

Dyrcona: /* Installing/Using the Result */ Fix some punctuation.

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly 180,000 files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files number over 370,000 and occupy 6.1 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary as they will include the date of the build, but there should be only 1 dmg file per directory unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

At the time of this edit, I don't exactly know what to do with the SDK dmg. I'll do some investigation and come back when I know more.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-16T15:12:53Z

Dyrcona: /* Installing/Using the Result */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly 180,000 files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files number over 370,000 and occupy 6.1 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

You will find .dmg images files with installable apps in the following two directories under your main build directory, the one named for the CVS tag that you checked out earlier. The exact names of the dmg files will vary, as they will include the date of the build, but there should be only 1 dmg file per directory, unless you've done multiple builds.

<pre>
instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US
instsetoo_native/unxmacxi.pro/OpenOffice_SDK/dmg/install/en-US
</pre>

You can install the OpenOffice.org.app from the dmg to almost anywhere on your system and it should work just fine. I usually place it in my Applications folder. You can also drag the icon to the dock, and that works. If you have a previous installation of OpenOffice.org in your Applications folder, I highly recommend dragging it to the Trash before installing the new OO.o in the Applicaitons folder. If you wish to have multiple versions of OO.o installed for testing or whatever reason, then it is best to install the OO.o that you just built some place other than the Applications folder.

At the time of this edit, I don't exactly know what to do with the SDK dmg. I'll do some investigation and come back when I know more.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-16T13:02:37Z

Dyrcona: /* File Organization */

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly 180,000 files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files number over 370,000 and occupy 6.1 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

I need to tell where to find the disk image file that is created, etc.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona

2008-03-16T03:38:17Z

Dyrcona: Add disclaimer about the Leopard Build instructions.

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have started a [http://dyrcona-ooo.blogspot.com/ blog] where I'll post updates about my progress on working with OO.o and the Mac OS X native port.

I have added a page, called [[/LeopardBuild]], with my procedures for building the native Aqua OO.o on Mac OS X Leopard. The instructions on that page are meant to supplement the [[AquaBuild]] instructions and not to serve as a replacement for them. I assume that you have already the AquaBuild instructions and understand them.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-16T03:32:08Z

Dyrcona: Add braces around cvsTag in mkBuildDir.sh.

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly half a million files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files balloon to occupy 5.9 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d ${cvsTag} ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

I need to tell where to find the disk image file that is created, etc.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-16T03:15:00Z

Dyrcona: Remove an unnecessary semicolon in mkBuildDir.sh

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly half a million files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files balloon to occupy 5.9 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1}
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d $cvsTag ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

I need to tell where to find the disk image file that is created, etc.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-16T03:12:08Z

Dyrcona:

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly half a million files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files balloon to occupy 5.9 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1};
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d $cvsTag ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

I need to tell where to find the disk image file that is created, etc.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona/LeopardBuild

2008-03-16T03:06:31Z

Dyrcona: Building OO.o on Mac OS X Leopard

== Building OO.o Aqua on Mac OS X ==

The following are the steps and tools that I use to build development milestones on my MacBook running Mac OS X Leopard (10.5.2).

=== File Organization ===

OpenOffice.org is a large project. A fresh checkout of a recent development milestone (DEV300_m0) comprises roughly half a million files, spread over 184 modules, that occupy about 1.8 GB of space on disk. After compilation, the project files balloon to occupy 5.9 GB of space. Each of those 184 modules is itself a directory full of subdirectories. Therefore, it is important that you give some thought to the organization of these files before you begin building and hacking OO.o.

As a programmer who works on several different projects, not just OO.o, I like to keep my code files neatly organized and separate from my other files. To that end, I have created a subdirectory, called <code>Sources</code>, in my home directory. In this directory, I create a subdirectory for each of my major projects. Thus, the code for each project is neatly organized and distinct.

In the case of OO.o, I have developed a further subdivision of the project directory that helps to organize my various builds and other files. First, I have created a main OO.o project directory, <code>${HOME}/Sources/OpenOffice.org/</code>, where I keep all of my OpenOffice.org-related code and build files. Under this main project directory, I have added a <code>bin</code> subdirectory where I keep some useful scripts and environment files. Side by side with this <code>bin</code> subdirectory sits another called <code>prebuild</code>. It stores the various pre-built binaries that I use to speed up the total OO.o build process. Finally, one of the scripts in the <code>bin</code> will create a build directory for a milestone based on the CVS tag. The structure of this layout looks something like the following:

<pre>
${HOME}/Sources/OpenOffice.org/
bin/
prebuild/
${CVSTAG}/
.../
</pre>

=== Getting Pre-built Binaries ===

This is currently in a state of flux, but I'll soon post the links and other information needed to get the pre-built binaries for

==== Mozilla ====

==== unowinreg.dll ====

=== Scripts and Environment Files ===

(Some text needs to be filled in here, but it is getting late and I'm tired, so I'll finish this tomorrow.)

env.sh:
<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

mkBuildDir.sh:
<pre>
#!/bin/sh

cvsTag=${1};
CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
where=$(pwd)

if [ "${where}" != "${HOME}/Sources/OpenOffice.org" ]; then
cd ${HOME}/Sources/OpenOffice.org
fi

if [ -e ${cvsTag} ]; then
if [ -d $cvsTag ]; then
echo "${cvsTag} already exists and is a directory"
read -p "Do you wish to continue (y|n)? " readContinue
case "${readContinue}" in
y|Y|yes|YES)
echo "Expect undesired results if ${cvsTag} is not empty"
cd "${cvsTag}"
;;
*)
exit 1
;;
esac
else
echo "${cvsTag} is not a directory"
exit 1;
fi
else
mkdir ${cvsTag}
cd ${cvsTag}
fi

cvs -z4 -d ${CVSROOT} co -r ${cvsTag} OpenOffice2

# Copy the Mozilla and unowinreg.dll pre-builts to the proper place.
cp ${HOME}/Sources/OpenOffice.org/prebuild/MACOSXGCC*.zip ./moz/zipped/
cp ${HOME}/Sources/OpenOffice.org/prebuild/unowinreg.dll ./external/unowinreg/

# Link the pre-existing build script
cd config_office/
ln -s ../../bin/build.sh
</pre>

build.sh:
<pre>
#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US" \
--disable-pasf \
--disable-gtk \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-headless \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no

</pre>

=== The Build ===

Again, some explanatory text should go here.

In the ${CVSTAG} directory:
<pre>
source ../bin/env.sh
cd config_office/
./build.sh
cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
build --all -P4 --dlv_switch -link
</pre>

=== Installing/Using the Result ===

I need to tell where to find the disk image file that is created, etc.

=== Hacking OO.o ===

Once I've had some more time for code changes of my own, I'll add a subpage about hacking OO.o on Mac OS X, managing patches, etc. I have an idea for an example hack, too.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona

2008-03-16T01:54:18Z

Dyrcona:

User:Dyrcona

2008-03-16T01:49:20Z

Dyrcona:

User:Dyrcona

2008-03-13T20:41:40Z

Dyrcona:

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have started a [http://dyrcona-ooo.blogspot.com/ blog] where I'll post updates about my progress on working with OO.o and the Mac OS X native port.

Below are some tips for building OO.o on Mac OS X Leopard. Soon, I'll have my complete build methodology laid out.

One thing I do is put the following in a text file, so I can source it into my build environment before starting:

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
</pre>

I source the above in my DEV300_m0 directory so that the cache is stored there.

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

User:Dyrcona

2008-03-11T23:58:39Z

Dyrcona:

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have started a [http://dyrcona-ooo.blogspot.com/ blog] where I'll post updates about my progress on working with OO.o and the Mac OS X native port.

Below are some tips for building OO.o on Mac OS X Leopard. Soon, I'll have my complete build methodology laid out.

One thing I do is put the following in a text file, so I can source it into my build environment before starting:

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:2401/cvs
</pre>

I source the above in my DEV300_m0 directory so that the cache is stored there.

User:Dyrcona

2008-03-11T23:56:42Z

Dyrcona:

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have started a [http://dyrcona-ooo.blogspot.com/ blog] where I'll post updates about my progress on working with OO.o and the Mac OS X native port.

Below are some tips for building OO.o on Mac OS X Leopard. Soon, I'll have my complete build methodology laid out.

One thing I do is put the following in a text file, so I can source it into my build environment before starting:

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

I source the above in my DEV300_m0 directory so that the cache is stored there.

Education Project/Effort/Improve Scanner Use

2008-03-11T23:51:29Z

Dyrcona: /* Mac OS X side */

Draft :

Current Scanner implementation is .. hmm

Improve it is mandatory

Todo: analyse current implementation

== '''Todo ''' ==

* document the existing extensions/source/scanner implementation

* define tasks in the Team: (ericb, valeuf, Dyrcona )

* document everything

* play with Image Capture SDK : create a little application,

* test all features

* design: classes, naming conventions, API description

* define OpenOffice.org source code changes for new scanmacosx.cxx file, and it's compilation

* file an issue about the new feature

* define new specs

* create a cws : explain the steps

* start with new implementation (code and debug )

* define tests to validate new features

== '''Agenda''' ==

{| style="text-align:left; background:ivory" border="1"
|+ '''Imprpove Scanner Use on Mac OS X
|- style="background:royalblue; color:white"
! width="150"|Task !! week A !! week B !! week C !! week D !! week E !! week F !! Status !! Assigned to !! Comments
|- |
| task1 ||bgcolor="#2a8ad8"| || || || || || || || ||
|- |
|task2|| bgcolor="#287cc1"| ||bgcolor="#287cc1"| || bgcolor="#287cc1" | || || || || || ||
|- |
| task3 || || bgcolor="#2370b0"| ||bgcolor="#2370b0"| || || || || || ||
|- |
| task4 || ||bgcolor="#2370b0"| ||bgcolor="#2370b0"| ||bgcolor="#2370b0"| || || || || ||
|-|
| task5 || || ||bgcolor="#135892"| ||bgcolor="#135892"| || || || || ||
|-|
| task6 || || || bgcolor="#135892"| ||bgcolor="#135892"| || bgcolor="#135892"| || || || ||
|-|
| Write specs || bgcolor="#0c4676"| ||bgcolor="#0c4676"| || bgcolor="#0c4676"| ||bgcolor="#0c4676"| || bgcolor="#0c4676"| || || || ||
|}

== '''Current design in OpenOffice.org''' ==

===OpenOffice.org code location===

extensions/source/scanner

[FIXME]: Twain interface should work on Mac OS X version of OpenOffice.org, and configure does accept

--with-system-sane
--with-sane-headers

command line options. Tests scheduled

===Products built ===

All : scanner , scnserv

Windows( WNT) : scanwin

Other ( UNX or OS2 ) :

sane, sandlg scanunx and grid

=== Code documentation ===

'''See OpenOffice.org [http://eric.bachard.free.fr/Education/Documentation/AquaScanner/html/ extensions/source/scanner source code documentation]'''

Contains:

* Class description
* Methods description
* some diagrams (inheritance)
* source code

important: the documentation above has been generated using '''[http://www.stack.nl/~dimitri/doxygen/ Doxygen]''', made with current code (from DEV300_m0)

Does not contain : libscn generation + build process, and Design about the Mac OS X lib

(FIXME )

scanner.cxx: uses libsane (3rd part library, must be installed separately). All system calls in libscn extension, are using SANE macros constants, while Apple does provide Twain blob for all scanners.

grid.* : defines the look of the dialog box + the implementation.

To be done: thre is an existing Image Capture device, using Twain on Mac OS X. The idea is to bind with Image Capture device instead of the heavy SANE thing.

The Apple Image Capture SDK does contain code sample ( Model View Controler paradigm in objective C ( to be modified in objc++ )

=== Interface description ===

==== Offapi ====

The complete interface is defined in (list to be confirmed ):

In OpenOffice.org source code :

offapi/com/sun/star/scanner

ScanError.idl

ScannerContext.idl

ScannerException.idl

ScannerManager.idl

XScannerManager.idl

offapi/com/sun/star/awt ( lot of references )

+Includes :

* grid.cxx
cstdio, cmath, grid.hxx, /* stl, for ::std::sort */ algorithm ,

+ (from grid.hxx) : vcl/window.hxx, vcl/button.hxx, vcl/listbox.hxx, vcl/dialog.hxx

*
==== Dialog boxes ====

The dialog boxes are defined in :

extensions/source/scanner/sanedlg.src

extensions/source/scanner/grid.src

== Implementation description ==

GridWindow

==Important Links==

===Mac port Links===

This work is part of http://wiki.services.openoffice.org/wiki/Mac_OS_X_Porting_-_Work_Areas/Todo%27s

[[MacOSX_Debug_OpenOffice.org_using_XCode | '''Debug using Xcode (click me)''']]

[[Mac_OS_X_Porting_-_Roadmap | '''Aqua Roadmap''']]

<br>
<br>

===Mac OS X side===

Links :

[http://developer.apple.com/documentation/DeviceDrivers/Conceptual/AccessingHardware/AH_Intro/chapter_1_section_1.html#//apple_ref/doc/uid/TP40002714-BAJDAJDJ '''Accessing Hardware from Applications''' ]

[http://www.twain.org/mac.htm '''Twain Mac''']

[http://developer.apple.com/technotes/tn2002/tn2088.html#TAN4 '''TN2088 / Twain Data Sources for Mac OS X''']

[http://www.twain.org/docs/TWAIN19.pdf '''PDF : How use TWAIN'''] (Direct link with a PDF)

[http://dl.valeuf.org/AC20/mac_addendum.pdf '''Some specification to use TWAIN with Mac OS'''] (Direct link with a pdf)

[http://developer.apple.com/documentation/Carbon/Conceptual/ImageCaptureServicesProgrammingGuide/01Introduction/chapter_1_section_1.html#//apple_ref/doc/uid/TP40005196-CH1-DontLinkElementID_23 '''Image Capture Services Programming Guide for Carbon''' ]

SDK :

[ftp://ftp.apple.com/developer/Development_Kits/ImageCapture_Tiger_SDK.dmg '''Apple Image SDK''' ]

Other :

[http://www.twain.org/docs/TWAIN2d_proposal.pdf '''Twain 2.0 specifications (draft)''']

[http://www.sane-project.org/ Sane Project]

[http://www.sane-project.org/sane-supported-devices.html Supported devices]

[http://www.ellert.se/twain-sane/ Mac OS X Sane]

[http://www.hamrick.com/vsm.html Vuescan]

[[User:Ericb|Ericb]] 23:40, 5 October 2006 (CEST)

[[Category:Porting]]
[[Category:MacOSX]]
[[Category:Aqua]]

Education Project/Effort

2008-03-11T23:44:45Z

Dyrcona: /* '''Contacts''' */

{{:Uno/Term/Effort}}

We propose '''applications''', doable in one or two month of work for a student ( time to discover everything, and do the real work).
All these applications below are correlated with '''IssueZilla issues''', and need new code to be solved.

What we propose is to accompany the peers teachers/students solving the issues: the work must be done by the student, and we are resources. This means, most of the time, we have no clue about the solution (but we could work on it), or the needed changes, and sometimes, just a little change in the code can solve the issue. Sometimes, a lot of code can be needed.

The most important is to work together, and make the students discover OpenOffice.org source code and organisation.

The applications are classed

- by difficulty level (more stars means means more work and more difficult to be solved )

- by themes. e.g. Mac OS X

Last but not least, have a look at [[Cpp_Coding_Standards]] cannot be bad :-)

== '''Applications for Mac OS X only''' ==

=== [[Education_Project/Effort/Write_a_new_canvas | Implement new canvas using Core Graphics (click me)]]===

FIXME: description needs to be updated

* '''Goal''' : Implement a new canvas on Mac OS X

* '''Problem''' : nothing yet

* '''Time plan''' : TBD

Contacts:

* for Education project: ericb , (please add your name )

* for the task : Thorsten Behrens thb/ Ismael Merzaq ismael87 / Eric Bachard ericb : all @openofice.org

Difficulty: *****

Needs:

* experimental tests in canvas, with dummy methods, for proof of concept

* good Core Graphics understanding

* good C++ skills

* good Cairo understanding ( we use the existing implementation)

=== [[Education_Project/Effort/Complete_feature_send_active_document_as | Support of more mail clients for send active document as (click me)]] ===

* '''Goal''' : Support multiple mail client applications on Mac OS X (currently Mail.app only) and determine the user's default mail client for the "send document as e-mail" feature

* '''Problem''' : Only Mail.app support creating a new message with a document already attached using the 'open -a' command.

* '''Time plan''' : TBD

Contacts:

* for Education project: ericb , (please add your name )
* for the task : obr @openofice.org

Difficulty: ***

=== [[Education_Project/Effort/Use_system_security_API | Use system security API ( click me)]] ===

* '''Goal''' : Make Apple key signing API work

* '''Problem''' : currently, a strange hack does use Mozilla libnss and co, and this is not easy to maintain. Use Apple API would simplify the build, and help to improve the OpenOffice.org integration on Mac OS X.

* '''Time plan''' : long term work. TBD completely

* '''Links''' : [http://developer.apple.com/documentation/Security/Conceptual/keychainServConcepts/01introduction/chapter_1_section_1.html Apple Keychain Documentation]

Contacts:

* for Education project: ericb , (please add your name )
* for the task : jl/obr @openofice.org

Difficulty: *****

* no information available yet

=== [[Education_Project/Effort/Improve_Scanner_Use | Improve Scanner Use (click me)]] ===

==== '''Description of the application''' ====

* '''Goal''' : Implement Apple way of Image Capture

* '''Target''' : Mac OS X Aqua version is concerned firstly (not sure a backport is possible)

* '''Problem''' : the current implementation :

- needs a third part installation ( libsane , libusb ..etc )

- is obsolete

- is not User Experience compliant

* '''Strategy (draft, to be completed)'''

Mac OS X does use a blob interfaced with most of existing scanners (undocumented), named " Image Capture ". This blob seems to use Twain implementation.

The scanner is an abstraction in every subpart like scandlg.cxx grid.cxx, and scnserv.cxx. '''The Mac OS X implementation does only concern scanunx.cxx'''.

The problem is, scanunx.cxx does use SANE implementation, and will become useless. Thus, '''the idea is to create scanmacosx.cxx, and use both scanwin.cxx existing implementation . the result will be a mix of what Image Catpure SDK + Apple documentation will provide us, and the need we have for the implementation'''.

We firstly have to :

- analyze scanunx.cxx completely

- design TwainHolder, TwainThread, BitmapManager, ScannerManager (reused from scanwin.cxx ) implementation in scanmacosx.cxx

- define a process for the progressive implementation

- FIXME: complete ..

* '''Time plan''' : a first try must work on early of June 2008

===='''Contacts''' ====

* Volunteers :

- '''Valentin JANIAUT''' student from [http://www.utbm.fr '''UTBM (France )''']

- [[User:Dyrcona | '''Jason STEPHENSON''']], from USA

- [[User:Ericb | '''Eric Bachard''']]

Jason is a skilled developer ( Cocoa ) helping for the feature implementation.

Valentin should be able to validate a Value Unit for his own cursus, writing code for OpenOffice.org project.

* Contact for School : Eric Bachard

* for Education Project : ericb , (please add your name )

* To be defined

This application is a try. Main idea is : analyse current interface, improve the current implementation, and more if possible.

Difficulty: ****

Needs:

* C++ skills

* Twain and Sane skills

* interface understanding (offapi )

* Design skills

== '''Application concerning all ports''' ==

=== [[Education_Project/Effort/Math_baseline_alignment | Implement Math Baseline Alignement (click me)]] ===

* '''Goal''' : Fix [http://www.openoffice.org/issues/show_bug.cgi?id=972 issue972] Implementing a correct baseline alignment for equations anchored as characters in Writer documents ( should work for "to character" too ).

Side effects: a change in .odt specification will result, and specs must be written in parallel

* '''Problem''' : the current implementation does not work, and equations are misaligned.

'''Important consequence: OpenOffice.org acceptance is low in Educationnnal system (all locales concerned)'''

* '''Time plan''' : (will be defined soon)

Note: the application could be proposed as Google Summer of Code ( including other tasks.

Contacts:

* for Education Project : ericb , (please add your name )
* Framework/Starmath projects : mba/tl @openoffice.org

Difficulty: ****

New: needs

* new interface definition ( offapi),
* new file format extension ( needs ODF TC agreement ),
* new implementation ( starmath )
* Serious QA

Skills : C++

=== [[Education_Project/Effort/Fix_Mousewheel_Jump_in_Calc | Fix MouseWheel jump in Calc (click me)]] ===

==== '''Description of the application''' ====

* '''Goal''' : Fix [http://www.openoffice.org/issues/show_bug.cgi?id=81907 issue 81907] Implementing a method allowing smooth scrolling in Calc sheets, even when cells are half if the screen high

* '''Problem''' : the current implementation uses integers for the scrolling, and whenever a cell is half of the screen high, some cells are no longer accessible.

* '''Time plan''' : (will be defined soon)
Contacts:

* for Education Project : ericb , (please add your name )

* Framework Project : nn/ @openoffice.org

Difficulty: **

Needs:

* a correct understanding of the existing code

* define the new feature fixing the issue

* implement it

* integrate it respecting OpenOffice.org project rules

== '''Other Applications (later)''' ==

===[[Education_Project/Effort/Maxima Integration |Maxima Integration (click me)]] ===



=== [[Education_Project/Effort/OpenOffice.org_Installation | Write OpenOffice.org Installation HowTo]] ===

[[Category:Education]]

[[Category:Effort]]

User:Dyrcona

2008-03-02T13:20:16Z

Dyrcona:

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I have begun adding some of my tips for building OO.o on Mac OS X Leopard. Soon, I'll have my complete build methodology laid out.

One thing I do is put the following in a text file, so I can source it into my build environment before starting:

<pre>
export CCACHE_DIR="$(pwd)/.ccache"
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

I source the above in my DEV300_m0 directory so that the cache is stored there.

User:Dyrcona

2008-03-01T21:46:04Z

Dyrcona:

Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port.

I don't have a lot of time to put stuff in this page right now, but in the coming days and weeks, I'll add some tips for those who are also new to the Mac OS X port of OpenOffice.org. These tips will mostly cover working with the DEV300 source code branch.

One thing I do is put the following in a text file, so I can source it into my build environment before starting:

<pre>
export CC="ccache gcc"
export CXX="ccache g++"
export TMP=/tmp
export SYSTEM_OPENSSL=YES
</pre>

User:Dyrcona

2008-02-24T15:04:43Z

Dyrcona: New page: Hi, there! My name is [http://www.sigio.com/~jason/ Jason Stephenson]. I am new to OpenOffice.org, but I plan to help out with the native Mac OS X port. I don't have a lot of time to put ...