Documentation/Building Guide/Building on MacOSX
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.
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: OpenOffice.org Build Environment.
- 1 Prerequisites
- 2 Getting the code (checkout, merge and patch the puppy)
- 3 List of Patches requiring testing before for integration
- 4 Known build issues
- 5 Doing the build (about 4,5 GB)
- 6 Installing, preparing and running OpenOffice.org
- 7 Debug and contribute
- 8 External links
- 9 Screenshots
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).
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
If you really cannot use XCode 2.4.1 nor XCode 2.4:
Xcode 2.2, 2.3 are known to work for Aqua development. If any earlier versions work as well, please add them here.
X11SDK (soon optional)
A dependency for Mozilla plugin needs some prototype defined in some Xlib.h header.
Please note, this dependency is not needed in runtime, but only at buildtime.
X11SDK.pkg archive is located in your Tiger's DVD, and has to be installed in the case of you're using Mozilla prebuild archives
This issue should be fixed soon.
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 -> go into folder : Applications -> Utilities -> Java and modify.
Else, you'll meet unfixed build breakers (patches are welcome anyway)
If you intend to build several times OpenOffice, you probably can benefit of ccache. ccache will speed up your future builds. The first time you make a build with ccache you won't notice it, but then the build will go up to five times faster.
You can install it using fink. It is simply named "ccache".
If you don't use fink, you can download it and build it yourself using the source provided at http://ccache.samba.org/
Then, in order to use it, you need to change the following environment variables using bash, and just before doing configure command line:
export CC="ccache gcc" export CXX="ccache g++"
Getting the code (checkout, merge and patch the puppy)
aquavcl02 cws does use SRC680 master workspace, and is regularly resynchronized with recent milestones.
The current_milestone is m221 as of now (July 11th 2007)
Aquavcl01 has been integrated in m221. Now, all the changes are commited in aquavcl02, and all what you have to do is : - checkout SRC680 sources - checkout aquavcl02 modules. Currently : basic, desktop, dtrans, instsetoo_native, padmin, solenv, svtools and vcl
All these milestone numbers below highly depend on the given point-in-time. You can find the current milestone of each cws in the EIS database.
You also need to bear in mind that you have to access to the CVS-Server's default port (2401). If a firewall stop's you here you have to setup a CVS-Tunnel.
Create a directory for a given milestone, setup CVS access:
mkdir SRC680_m221 cd SRC680_m221
export CVSROOT=":pserver:email@example.com:/cvs" cvs login
(password is 'anoncvs' ) + Enter
Note: The source should be downloaded to a path that does not contain any spaces, otherwise compiling might be troublesome.
checkout SRC680 (Master workspace since aquavcl01 integration) (1,5 GB):
cvs -z3 co -r SRC680_m221 OpenOffice2
Once done, you'll obtain milestone 221. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are included, but not te last changes, now in aquavcl02. To complete, we need to check aquavcl02 changes.
checkout Aquavcl02 (50 MB):
1) First possibility: create a dedicated tree (cool backup)
To check aquavcl02 Child workspace, the most simple is to create aquavcl02 directory, and go inside this dir
mkdir aquavcl02-src cd aquavcl02-src
(assuming you already did cvs login, and typing all the command line below in one line)
cvs -z3 co -r cws_src680_aquavcl02 basic desktop dtrans freetype instsetoo_native padmin scp2 solenv svtools vcl
All the modules listed above will be present at the end ( everyone represents a new directory ) and they are the ones we modified to create the native version.
To verify nothing's wrong, all are tagged "aquavcl02" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in SRC680_m221 and replace them with the one located in aquavcl02-src.
e.g. : vcl in SRC680_m221 will become vcl_m221 , and then, cp canvas from aquavcl02-src into src_m221
This applies for all the modules listed above.
2) Second possibility: use a little script to extract changes: extract_aquavcl02.sh
This shell script, located in SRC680_m221 will contain:
list="basic desktop dtrans freetype instsetoo_native padmin scp2 solenv svtools vcl" for i in $list ; do
mv $i $i_m221 cvs -z3 co -r cws_src680_aquavcl02 $i
Then chmod +x extract_aquavcl02.sh
and run it:
When finished, and if no problem occurs, you should have a complete tree of aquavcl02.
One-Time preparations and scripts
OpenOffice building gets configured by 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/ SRC680_m182/ SRC680_m196/ ...
Now I go to the 'config_office' subdir and link in my startscript:
cd SRC680_m221/config_office/ ln -s ../../bin/build.sh
And this is how 'build.sh' (to be written) looks like :
#!/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="de en-US" \ --with-jdk-home=/Library/Java/Home/ \ --with-epm=internal \ --disable-mozab \ --disable-odk \ --disable-pasf \ --disable-gtk \ --disable-headless \ --disable-mozilla \ --with-build-version=$OOVERSION-`date +%d-%m-%y` \ --disable-fontconfig \ --without-nas
Note : --disable-neon has been removed since m217 resync. See issue : [--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.
This is allowedly a pretty much limited setup for now, but it will progressively change, with the progress we'll do with Aqua port.
List of Patches requiring testing before for integration
IMPORTANT : *aquafilepicker01 has been integrated in m221
Developers are working on the following Child workspaces (Mac OSX dedicated) :
concerned modules are : scp2, dbaccess, extensions, connectivity
- aquaremovescripts (soon) :
concerned module: instsetoo_native
- readme4macintel :
concerned module : readlicense_oo
All patches that developers have that need testing or peer review should be added here.
Known build issues
Since latest resync, no build issues have been reported.
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 SRC680_m221/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:
cd .. ./bootstrap source MacOSXX86Env.Set.sh cd instsetoo_native
build --all -P4 --dlv_switch -link --dontgraboutput
build --all -P4
if you run into trouble with --dlv_switch (see: 77360)
cd .. ./bootstrap source MacOSXPPCEnv.Set.sh cd instsetoo_native
build --all -P2 --dlv_switch -link --dontgraboutput
build --all -P2
if you run into trouble with --dlv_switch (see: 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' should be substituted with 'MacOSXX86Env.Set'.
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 : OpenOffice.org-2.3.0_en-US.dmg ( for version 2.3.0 e.g.)
And is located in instsetoo_native/unxmacxi.pro/OpenOffice/install/en-US directory ( replace en-US with your locale )
Run the soffice.bin
In one line :
Double click the .dmg , drag the OpenOffice.org icon in the folder you want, and double click to run it !!
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\ 2.3.app/Contents/MacOS
gdb --args soffice.bin
(add any breakpoint you want)
r to run OpenOffice.org
Native menus are defaults. If you want to use vcl menus, do:
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:
|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
- You want to provide crash issue details? Please see Providing_a_gdb_backtrace
- You want to debug using XCode? Please see MacOSX_Debug_OpenOffice.org_using_XCode
- You want to debug using Xemacs? Please see Michael Sicotte's blog entry
- Bug Database
- Mailinglist: firstname.lastname@example.org (subscribe is mandatory )
- IRC Meeting-Logs (#email@example.com): 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
- 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
- Aqua look (the begining):