Apache OpenOffice Wiki - User contributions [en]

Mac OS X Build Instructions (X11)

2007-10-28T04:27:53Z

Ponderability: /* Special Thanks */

The current build instructions also at: http://porting.openoffice.org/mac/build_680_X11.html. Those are being moved to this page at OOo Wiki.

For historical reasons, there is also [[Mac OS X Build Instructions of SRC_m71]]

Note: supported compilers for Mac can be found in [[Compiler versions used by port maintainers and release engineers]]

Other [[:Category:MacOSX|Mac OS X related Wiki pages]].

=== Building OpenOffice.org X11 for Mac OS X PPC and Mac OS X x86===

Authors: Eric Hoch

Revised 2006-01-23

=== Introduction===

These build instructions are based upon milestone 680_m140 and higher.

Due to the nature of a port in progress this document cannot give a general overview of all the current patches necessary to build a specific milestone. To get this information we recommend you to subscribe to our porting mailing list dev@porting.openoffice.org.

There you'll get all the latest information about patches and everything else related to and needed to port OpenOffice.org to the Mac.

=== Special Thanks===
Before we begin let me thank all the people without whom these build instructions would make no sense, the coders who are helping to bring OOo 2.0 to Mac OS X.
The coders and supporters behind the Mac port are:

Eric Bachard
Thorsten Behrens
Etsushi Kato
Florian Heckl
Pavel Janik
Nakata Maho
James McKenzie
Tino Rachui
Stephan Schäfer
Eric Hoch
Shaun McDonald

=== Requirements ===

* The fastest machine you can find. It'd be good if it had memory, too.
* Mac OS X 10.3.5 or Mac OS X 10.4.x including all the latest available Security Updates for
your version of Mac OS X
* on Mac OS X 10.3.x: XCode 1.5 plus November 2004 gcc 3.3 Update for
* on Mac OS X 10.4.x: XCode 2.1
Note: You can get both applications after a free registration at http://connect.apple.com
* JDK 1.4.2 plus latest SDK Updates (with full JDK SDK for the headers)
* an installed X-Server. We recommend Apple's X11 but you can also use the ones of X.org or Xfree86
* A minimum of 4 to 5GB for a standard build.
Note: Usage of disk space depends upon the number of localizations you build for.
More localizations means more disk space needed.
A minimum of 18GB for a full debug build.
* If you can afford it we recommend you to backup clean sources and work with a second set of sources.
With a second set of clean sources you can easily go back to clean sources if a module doesn't build,
a patch doesn't solve the problem, you have to revert a patch or for any other reason there may be.
In the meantime cvs sources could have been edited and you need to recompile more modules then just
one and that's probably not what you want...

===Determine the shell you use for compilation===

The default shell of a cleanly installed Mac OS X 10.3.x/Mac OS X 10.4.x is bash.
If you did an update to 10.3.x or 10.4.x from early versions of Mac OS X while keeping your personal settings you may still use the tcsh shell, the default shell of Mac OS X 10.0 to 10.2.x.

Where necessary this read-me distinguishes between bash and tcsh.

To determine the shell you currently use open Terminal.app and type the following command:

ps -p $$

The output shows you which shell you're currently using.

-/bin/bash or -bash means you are using bash

-/bin/tcsh or -tcsh means you are using the c-shell

===Getting OpenOffice.org and External Sources===

====Getting OpenOffice.org Source from CVS====

Once you have X properly installed, it's time to get the OpenOffice.org sources and other external sources. If you've built OpenOffice.org from previous sources and have applied other patches, you will need to start from scratch with a fresh CVS version of the sources.

Download the CVS distribution for SRC680_mXXX (replace XXX by the current milestonenumber):

1. Open a new Terminal (/Applications/Utilities/Terminal)
2. mkdir 680_mXXX/source
3. cd 680_mXXX/source
4. Now set the CVSROOT
* for bash do:
export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
* for tcsh do:
setenv CVSROOT :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
5. cvs login
6. Enter the password anoncvs
7. cvs -z3 co -r SRC680_mXXX OpenOffice2
for later milestones simply replace the XXX with the most current milestonenumber
8. go get some coffee, or a beer, since it'll take a while to get it all

Note that if your computer is behind a firewall and you're trying to get the sources from the CVS server, you may need to find a proper way to get it to tunnel through the firewall. The protocol runs on port 2401, and some firewalls will not allow communication on this port.

Attention: We recommend a broadband connection and a not too small amount of volume or time left within your contract since the sources are about 300MB and the checkout could take up to an hour or longer depending on the server load.

For further information on this topic see get the source

To get a second copy of the sources use the following commands within your 680_mXXX directory:

1. cd ..
2. mkdir build
3. cd build
4. cp -R ../source/* .

==== Additional software that's not in the official OpenOffice.org sources ====

Now that you have the sources it's time to get the software that is not in the official OOo Source Code Tree.

* The perl module Archive::Zip
* gpc - optional - NOT NEEDED
* pkg-config
* gtk2 - optional - not needed
* X11
* unowinreg.dll

To install Archive::Zip use the following commands in Terminal.app:

1. perl -MCPAN -eshell
2. install Archive::Zip

If this is your first installation of a module using CPAN you're asked to configure the CPAN environment. If you're not 100% sure what to answer simply accept the default answers.

Note: In some cases using CPAN with Mac OS X is a bit problematic. In this case simply follow the instructions given here on this website http://sial.org/howto/perl/life-with-cpan/macosx/ to solve the problem.

GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>

Attention: Direct Link to the download but it's only a few hundred KB.

Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

Since OS X comes with no pkg-config, or to be more specific it's simply not complete in OS X, you have to install it via fink (http://fink.sourceforge.net), MacPorts (http://www.macports.org) or the gentoo port system (http://www.metadistribution.org/macos/).

If you need cups headers (on Mac OS X 10.3., building reports "cups.h missing"), then download them from http://ftp.cusoo.org/MacOSX/Utilities/PowerPC/cups_Panther/cups.tar.gz and put the headers to "/usr/include/cups".

If you want to compile OpenOffice.org with gtk2 support you have to install gtk2 via your porting_mechanism
Note: The most current versions of gkt2 and pkg-config are in about 90% of all cases only available as sources that you need to compile and not as binaries. Please consider this while preparing your mac.

Additional Note for fink users: You need to install both packages gtk2 and gtk2-devel using fink install </package name>

Yes, there are other porting mechanisms out there such as the one of NetBSD or you can get precompiled versions of gtk, gnu_copy and pkg-config via pages like osxgnu but the author of these build instructions has no experiences with these so no recommendation for them here.

Note: If you need help with installing or maintaining packages please contact the project that provides the porting_mechanism.

It's also possible to compile pkg-config, gnu_copy as part of the gnu-coreutils and gtk2 without fink or Macports. Be aware that in this case you need to resolve the various dependencies yourself. So we recommend using one of the porting mechanisms.

Because OS X does not install X11 by default and up to now you haven't installed one, now may be the time do so.
There are various X for Mac OS X out there e.g. Apple's X11, XDarwin.org's XDarwin or simply use your porting_mechanism to install either X.org 6.8.x or Xfree86 >=4.3.
For help with your X11 please contact the provider of the package or your porting mechanism project

By default OOo builds an Office Development Kit. This ODK requires you to download the unowinreg.dll from here http://tools.openoffice.org/unowinreg_prebuild/680/.

===Preparing to Build===

====Adding gpc to OOo sources====

1. uncompress <path to gpc>/gpc231.tar.Z
2. tar xvf <path to gpc>/gpc231.tar
3. cp <path to gpc>/gpc.[hc] <ooo source directory>/build/external/gpc/
4. rmdir gpc231

====Adding unowinreg.dll to OOo sources====

Copy the downloaded unowinreg.dll to <ooo source directory>/build/external/unowinreg/

====Applying Patches====

To apply a patch
cd
into the direcotory for the module which needs to be patched and do a:
patch -p0 <path/to/the patch>

Most of the patches use the naming scheme
modul_(subdirectory_subdirectory_etc)_filetopatch.patch.

To find all current patches do a search for issues in component subcomponent MacOSX.

You can grab the patches necessary to avoid the freetype crash from my idisk public folder

Due to the fact that not all the patches are from one author it's sometimes necessary to change to the subdirectory/ies or not. In this case the patch knows which subdirectories to jump over.

===Building OpenOffice.org===
Now that we've got it all the source, it's time to execute the build!

1. Open up a new Terminal.
2. Configure for your build
3. cd <path to ooo>/680_mXXX/build/config_office
4. ./configure --with-x --with-lang="de fr en-US"
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home/
--disable-build-mozilla --disable-neon --disable-gtk

Instead of using --with-freetype2=... you can also use --with-system-freetype
Attention: Darwinports gnu_copy is named gcp to avoid conflicts with Mac OS X cp

If you want to build with gtk-support please add --with-gtk2 to your configure script
and/or want to use your own apache-ant add --with-ant-home=<your path>/680_mxx/apache-ant-1.6.5

5. If configure fails it will output an error message saying what's missing or
what else causes it's breakage.
Be sure to also check the warnings configure outputs at the end of the configuration process.
Please report any breakage here with the error message output to dev@porting.openoffice.org
6. cd ..
7. ./bootstrap
8. Set up your shell build enviroment:
* for bash do:
PPC: source MacOSXPPCEnv.Set.sh
Intel: source MacOSXX86Env.Set.sh
* for tcsh do:
PPC: source MacOSXPPCEnv.Set
Intel: source MacOSXX86Env.Set
9. dmake
10. Report any and all build failures to mac@porting.openoffice.org mail list
11. cd instsetoo_native/unxmacxp.pro/OpenOffice/install
Within this directory you will find a folder for each language that
you build OpenOffice.org for. Those folders contain the installation disk images.

====Additional Information for Macports Users====
When using Darwinports be sure to use ./configure without freetype since it leads to OpenOffice.org crashing with a version mismatch error when using Macport's freetype. You will find the additional patches needed to build freetype within OpenOffice.org in the subdirectory freetype2_patches of the patch archive.

====Using Mozilla within OpenOffice.org====

If you decided to use Mozilla packages to get special functions OpenOffice.org provides you, as I did in the example configure script, you have two choices to get them:

First:

You let OpenOffice.org compile them. Be aware that this adds additional tim to your compiling time.

If you decide to let OpenOffice.org compile Mozilla remove --disable-build-mozilla from the
./configure script and OpenOffice.org will compile Mozilla within the moz directory.

1. Before building Mozilla be sure to download Mozilla Sources. You can get them e.g. here:
http://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.5/source/
2. cp mozilla-source-1.7.5.tar.gz <your path>/680_mXXX/moz/download
3. cd <your path>/680_mXXX/moz
4. cd config_office
5. Use the same ./configure script out of but this time remove --disable-build-mozilla
6. Continue with Step 5 of the "Building OpenOffice.org" paragraph

OpenOffice.org should now compile mozilla within its build process.

Second:

You grab the Mozilla packages for PPC here:
http://florian-heckl.de/ooo/MACOSXGCCPinc.zip
http://florian-heckl.de/ooo/MACOSXGCCPlib.zip
http://florian-heckl.de/ooo/MACOSXGCCPruntime.zip
and put them into <ooo build directory>/680_mXXX/moz/zipped
OpenOffice.org should detect and use them.

Please use the Mozilla packages from http://eric.bachard.free.fr/mac/moz/zipped/ these libraries are universal binaries. If you want to build using them on PPC 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'''runtime.zip
|-
| libs || MACOSXGCC'''I'''lib.zip || MACOSXGCC'''P'''lib.zip
|}

As you can see, '''P''' means PowerPC, and '''I''' means Intel

===Building the whole OpenOffice.org suite or just a single Project with Debug Information===

To build the whole OpenOffice.org Suite with debug informations add
--enable-debug
to the configure command.

To rebuild a complete project with debug information, remove all object files by removing the unxmacxp.pro directory. Then run dmake with the debug option set to true:

cd $SRC_ROOT/(module-name)
$SRC_ROOT/(module-name)> rm -rf unxmacxp.pro
$SRC_ROOT/(module-name)> build debug=true
$SRC_ROOT/(module-name)> deliver

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

Mac OS X Build Instructions (X11)

2007-10-28T04:26:55Z

Ponderability: /* Introduction */

The current build instructions also at: http://porting.openoffice.org/mac/build_680_X11.html. Those are being moved to this page at OOo Wiki.

For historical reasons, there is also [[Mac OS X Build Instructions of SRC_m71]]

Note: supported compilers for Mac can be found in [[Compiler versions used by port maintainers and release engineers]]

Other [[:Category:MacOSX|Mac OS X related Wiki pages]].

=== Building OpenOffice.org X11 for Mac OS X PPC and Mac OS X x86===

Authors: Eric Hoch

Revised 2006-01-23

=== Introduction===

These build instructions are based upon milestone 680_m140 and higher.

Due to the nature of a port in progress this document cannot give a general overview of all the current patches necessary to build a specific milestone. To get this information we recommend you to subscribe to our porting mailing list dev@porting.openoffice.org.

There you'll get all the latest information about patches and everything else related to and needed to port OpenOffice.org to the Mac.

=== Special Thanks===
Before we begin let me thank all the people without whom those build instructions would make no sense, the coders that help bringing OOo 2.0 to Mac OS X.
The coders and supporters behind the Mac port are:

Eric Bachard
Thorsten Behrens
Etsushi Kato
Florian Heckl
Pavel Janik
Nakata Maho
James McKenzie
Tino Rachui
Stephan Schäfer
Eric Hoch
Shaun McDonald

=== Requirements ===

* The fastest machine you can find. It'd be good if it had memory, too.
* Mac OS X 10.3.5 or Mac OS X 10.4.x including all the latest available Security Updates for
your version of Mac OS X
* on Mac OS X 10.3.x: XCode 1.5 plus November 2004 gcc 3.3 Update for
* on Mac OS X 10.4.x: XCode 2.1
Note: You can get both applications after a free registration at http://connect.apple.com
* JDK 1.4.2 plus latest SDK Updates (with full JDK SDK for the headers)
* an installed X-Server. We recommend Apple's X11 but you can also use the ones of X.org or Xfree86
* A minimum of 4 to 5GB for a standard build.
Note: Usage of disk space depends upon the number of localizations you build for.
More localizations means more disk space needed.
A minimum of 18GB for a full debug build.
* If you can afford it we recommend you to backup clean sources and work with a second set of sources.
With a second set of clean sources you can easily go back to clean sources if a module doesn't build,
a patch doesn't solve the problem, you have to revert a patch or for any other reason there may be.
In the meantime cvs sources could have been edited and you need to recompile more modules then just
one and that's probably not what you want...

===Determine the shell you use for compilation===

The default shell of a cleanly installed Mac OS X 10.3.x/Mac OS X 10.4.x is bash.
If you did an update to 10.3.x or 10.4.x from early versions of Mac OS X while keeping your personal settings you may still use the tcsh shell, the default shell of Mac OS X 10.0 to 10.2.x.

Where necessary this read-me distinguishes between bash and tcsh.

To determine the shell you currently use open Terminal.app and type the following command:

ps -p $$

The output shows you which shell you're currently using.

-/bin/bash or -bash means you are using bash

-/bin/tcsh or -tcsh means you are using the c-shell

===Getting OpenOffice.org and External Sources===

====Getting OpenOffice.org Source from CVS====

Once you have X properly installed, it's time to get the OpenOffice.org sources and other external sources. If you've built OpenOffice.org from previous sources and have applied other patches, you will need to start from scratch with a fresh CVS version of the sources.

Download the CVS distribution for SRC680_mXXX (replace XXX by the current milestonenumber):

1. Open a new Terminal (/Applications/Utilities/Terminal)
2. mkdir 680_mXXX/source
3. cd 680_mXXX/source
4. Now set the CVSROOT
* for bash do:
export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
* for tcsh do:
setenv CVSROOT :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
5. cvs login
6. Enter the password anoncvs
7. cvs -z3 co -r SRC680_mXXX OpenOffice2
for later milestones simply replace the XXX with the most current milestonenumber
8. go get some coffee, or a beer, since it'll take a while to get it all

Note that if your computer is behind a firewall and you're trying to get the sources from the CVS server, you may need to find a proper way to get it to tunnel through the firewall. The protocol runs on port 2401, and some firewalls will not allow communication on this port.

Attention: We recommend a broadband connection and a not too small amount of volume or time left within your contract since the sources are about 300MB and the checkout could take up to an hour or longer depending on the server load.

For further information on this topic see get the source

To get a second copy of the sources use the following commands within your 680_mXXX directory:

1. cd ..
2. mkdir build
3. cd build
4. cp -R ../source/* .

==== Additional software that's not in the official OpenOffice.org sources ====

Now that you have the sources it's time to get the software that is not in the official OOo Source Code Tree.

* The perl module Archive::Zip
* gpc - optional - NOT NEEDED
* pkg-config
* gtk2 - optional - not needed
* X11
* unowinreg.dll

To install Archive::Zip use the following commands in Terminal.app:

1. perl -MCPAN -eshell
2. install Archive::Zip

If this is your first installation of a module using CPAN you're asked to configure the CPAN environment. If you're not 100% sure what to answer simply accept the default answers.

Note: In some cases using CPAN with Mac OS X is a bit problematic. In this case simply follow the instructions given here on this website http://sial.org/howto/perl/life-with-cpan/macosx/ to solve the problem.

GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>

Attention: Direct Link to the download but it's only a few hundred KB.

Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

Since OS X comes with no pkg-config, or to be more specific it's simply not complete in OS X, you have to install it via fink (http://fink.sourceforge.net), MacPorts (http://www.macports.org) or the gentoo port system (http://www.metadistribution.org/macos/).

If you need cups headers (on Mac OS X 10.3., building reports "cups.h missing"), then download them from http://ftp.cusoo.org/MacOSX/Utilities/PowerPC/cups_Panther/cups.tar.gz and put the headers to "/usr/include/cups".

If you want to compile OpenOffice.org with gtk2 support you have to install gtk2 via your porting_mechanism
Note: The most current versions of gkt2 and pkg-config are in about 90% of all cases only available as sources that you need to compile and not as binaries. Please consider this while preparing your mac.

Additional Note for fink users: You need to install both packages gtk2 and gtk2-devel using fink install </package name>

Yes, there are other porting mechanisms out there such as the one of NetBSD or you can get precompiled versions of gtk, gnu_copy and pkg-config via pages like osxgnu but the author of these build instructions has no experiences with these so no recommendation for them here.

Note: If you need help with installing or maintaining packages please contact the project that provides the porting_mechanism.

It's also possible to compile pkg-config, gnu_copy as part of the gnu-coreutils and gtk2 without fink or Macports. Be aware that in this case you need to resolve the various dependencies yourself. So we recommend using one of the porting mechanisms.

Because OS X does not install X11 by default and up to now you haven't installed one, now may be the time do so.
There are various X for Mac OS X out there e.g. Apple's X11, XDarwin.org's XDarwin or simply use your porting_mechanism to install either X.org 6.8.x or Xfree86 >=4.3.
For help with your X11 please contact the provider of the package or your porting mechanism project

By default OOo builds an Office Development Kit. This ODK requires you to download the unowinreg.dll from here http://tools.openoffice.org/unowinreg_prebuild/680/.

===Preparing to Build===

====Adding gpc to OOo sources====

1. uncompress <path to gpc>/gpc231.tar.Z
2. tar xvf <path to gpc>/gpc231.tar
3. cp <path to gpc>/gpc.[hc] <ooo source directory>/build/external/gpc/
4. rmdir gpc231

====Adding unowinreg.dll to OOo sources====

Copy the downloaded unowinreg.dll to <ooo source directory>/build/external/unowinreg/

====Applying Patches====

To apply a patch
cd
into the direcotory for the module which needs to be patched and do a:
patch -p0 <path/to/the patch>

Most of the patches use the naming scheme
modul_(subdirectory_subdirectory_etc)_filetopatch.patch.

To find all current patches do a search for issues in component subcomponent MacOSX.

You can grab the patches necessary to avoid the freetype crash from my idisk public folder

Due to the fact that not all the patches are from one author it's sometimes necessary to change to the subdirectory/ies or not. In this case the patch knows which subdirectories to jump over.

===Building OpenOffice.org===
Now that we've got it all the source, it's time to execute the build!

1. Open up a new Terminal.
2. Configure for your build
3. cd <path to ooo>/680_mXXX/build/config_office
4. ./configure --with-x --with-lang="de fr en-US"
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home/
--disable-build-mozilla --disable-neon --disable-gtk

Instead of using --with-freetype2=... you can also use --with-system-freetype
Attention: Darwinports gnu_copy is named gcp to avoid conflicts with Mac OS X cp

If you want to build with gtk-support please add --with-gtk2 to your configure script
and/or want to use your own apache-ant add --with-ant-home=<your path>/680_mxx/apache-ant-1.6.5

5. If configure fails it will output an error message saying what's missing or
what else causes it's breakage.
Be sure to also check the warnings configure outputs at the end of the configuration process.
Please report any breakage here with the error message output to dev@porting.openoffice.org
6. cd ..
7. ./bootstrap
8. Set up your shell build enviroment:
* for bash do:
PPC: source MacOSXPPCEnv.Set.sh
Intel: source MacOSXX86Env.Set.sh
* for tcsh do:
PPC: source MacOSXPPCEnv.Set
Intel: source MacOSXX86Env.Set
9. dmake
10. Report any and all build failures to mac@porting.openoffice.org mail list
11. cd instsetoo_native/unxmacxp.pro/OpenOffice/install
Within this directory you will find a folder for each language that
you build OpenOffice.org for. Those folders contain the installation disk images.

====Additional Information for Macports Users====
When using Darwinports be sure to use ./configure without freetype since it leads to OpenOffice.org crashing with a version mismatch error when using Macport's freetype. You will find the additional patches needed to build freetype within OpenOffice.org in the subdirectory freetype2_patches of the patch archive.

====Using Mozilla within OpenOffice.org====

If you decided to use Mozilla packages to get special functions OpenOffice.org provides you, as I did in the example configure script, you have two choices to get them:

First:

You let OpenOffice.org compile them. Be aware that this adds additional tim to your compiling time.

If you decide to let OpenOffice.org compile Mozilla remove --disable-build-mozilla from the
./configure script and OpenOffice.org will compile Mozilla within the moz directory.

1. Before building Mozilla be sure to download Mozilla Sources. You can get them e.g. here:
http://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.5/source/
2. cp mozilla-source-1.7.5.tar.gz <your path>/680_mXXX/moz/download
3. cd <your path>/680_mXXX/moz
4. cd config_office
5. Use the same ./configure script out of but this time remove --disable-build-mozilla
6. Continue with Step 5 of the "Building OpenOffice.org" paragraph

OpenOffice.org should now compile mozilla within its build process.

Second:

You grab the Mozilla packages for PPC here:
http://florian-heckl.de/ooo/MACOSXGCCPinc.zip
http://florian-heckl.de/ooo/MACOSXGCCPlib.zip
http://florian-heckl.de/ooo/MACOSXGCCPruntime.zip
and put them into <ooo build directory>/680_mXXX/moz/zipped
OpenOffice.org should detect and use them.

Please use the Mozilla packages from http://eric.bachard.free.fr/mac/moz/zipped/ these libraries are universal binaries. If you want to build using them on PPC 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'''runtime.zip
|-
| libs || MACOSXGCC'''I'''lib.zip || MACOSXGCC'''P'''lib.zip
|}

As you can see, '''P''' means PowerPC, and '''I''' means Intel

===Building the whole OpenOffice.org suite or just a single Project with Debug Information===

To build the whole OpenOffice.org Suite with debug informations add
--enable-debug
to the configure command.

To rebuild a complete project with debug information, remove all object files by removing the unxmacxp.pro directory. Then run dmake with the debug option set to true:

cd $SRC_ROOT/(module-name)
$SRC_ROOT/(module-name)> rm -rf unxmacxp.pro
$SRC_ROOT/(module-name)> build debug=true
$SRC_ROOT/(module-name)> deliver

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

Mac OS X Build Instructions (X11)

2007-10-19T14:55:45Z

Ponderability: /* Additional Informations for Macports Users */

The current build instructions also at: http://porting.openoffice.org/mac/build_680_X11.html. Those are being moved to this page at OOo Wiki.

For historical reasons, there is also [[Mac OS X Build Instructions of SRC_m71]]

Note: supported compilers for Mac can be found in [[Compiler versions used by port maintainers and release engineers]]

Other [[:Category:MacOSX|Mac OS X related Wiki pages]].

=== Building OpenOffice.org X11 for Mac OS X PPC and Mac OS X x86===

Authors: Eric Hoch

Revised 2006-01-23

=== Introduction===

These build instructions are based upon milestone 680_m140 and higher.

Due to the nature of a port in progress this document cannot give a general overview of all the current patches necessary to build a specific milestone. To get this informations we recommend you to subscribe to our porting mailing list dev@porting.openoffice.org.

There you'll get all the latest informations about patches and everything else related to and needed to port OpenOffice.org to the Mac.

=== Special Thanks===
Before we begin let me thank all the people without whom those build instructions would make no sense, the coders that help bringing OOo 2.0 to Mac OS X.
The coders and supporters behind the Mac port are:

Eric Bachard
Thorsten Behrens
Etsushi Kato
Florian Heckl
Pavel Janik
Nakata Maho
James McKenzie
Tino Rachui
Stephan Schäfer
Eric Hoch
Shaun McDonald

=== Requirements ===

* The fastest machine you can find. It'd be good if it had memory, too.
* Mac OS X 10.3.5 or Mac OS X 10.4.x including all the latest available Security Updates for
your version of Mac OS X
* on Mac OS X 10.3.x: XCode 1.5 plus November 2004 gcc 3.3 Update for
* on Mac OS X 10.4.x: XCode 2.1
Note: You can get both applications after a free registration at http://connect.apple.com
* JDK 1.4.2 plus latest SDK Updates (with full JDK SDK for the headers)
* an installed X-Server. We recommend Apple's X11 but you can also use the ones of X.org or Xfree86
* A minimum of 4 to 5GB for a standard build.
Note: Usage of disk space depends upon the number of localizations you build for.
More localizations means more disk space needed.
A minimum of 18GB for a full debug build.
* If you can afford it we recommend you to backup clean sources and work with a second set of sources.
With a second set of clean sources you can easily go back to clean sources if a module doesn't build,
a patch doesn't solve the problem, you have to revert a patch or for any other reason there may be.
In the meantime cvs sources could have been edited and you need to recompile more modules then just
one and that's probably not what you want...

===Determine the shell you use for compilation===

The default shell of a cleanly installed Mac OS X 10.3.x/Mac OS X 10.4.x is bash.
If you did an update to 10.3.x or 10.4.x from early versions of Mac OS X while keeping your personal settings you may still use the tcsh shell, the default shell of Mac OS X 10.0 to 10.2.x.

Where necessary this read-me distinguishes between bash and tcsh.

To determine the shell you currently use open Terminal.app and type the following command:

ps -p $$

The output shows you which shell you're currently using.

-/bin/bash or -bash means you are using bash

-/bin/tcsh or -tcsh means you are using the c-shell

===Getting OpenOffice.org and External Sources===

====Getting OpenOffice.org Source from CVS====

Once you have X properly installed, it's time to get the OpenOffice.org sources and other external sources. If you've built OpenOffice.org from previous sources and have applied other patches, you will need to start from scratch with a fresh CVS version of the sources.

Download the CVS distribution for SRC680_mXXX (replace XXX by the current milestonenumber):

1. Open a new Terminal (/Applications/Utilities/Terminal)
2. mkdir 680_mXXX/source
3. cd 680_mXXX/source
4. Now set the CVSROOT
* for bash do:
export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
* for tcsh do:
setenv CVSROOT :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
5. cvs login
6. Enter the password anoncvs
7. cvs -z3 co -r SRC680_mXXX OpenOffice2
for later milestones simply replace the XXX with the most current milestonenumber
8. go get some coffee, or a beer, since it'll take a while to get it all

Note that if your computer is behind a firewall and you're trying to get the sources from the CVS server, you may need to find a proper way to get it to tunnel through the firewall. The protocol runs on port 2401, and some firewalls will not allow communication on this port.

Attention: We recommend a broadband connection and a not too small amount of volume or time left within your contract since the sources are about 300MB and the checkout could take up to an hour or longer depending on the server load.

For further information on this topic see get the source

To get a second copy of the sources use the following commands within your 680_mXXX directory:

1. cd ..
2. mkdir build
3. cd build
4. cp -R ../source/* .

==== Additional software that's not in the official OpenOffice.org sources ====

Now that you have the sources it's time to get the software that is not in the official OOo Source Code Tree.

* The perl module Archive::Zip
* gpc - optional - NOT NEEDED
* pkg-config
* gtk2 - optional - not needed
* X11
* unowinreg.dll

To install Archive::Zip use the following commands in Terminal.app:

1. perl -MCPAN -eshell
2. install Archive::Zip

If this is your first installation of a module using CPAN you're asked to configure the CPAN environment. If you're not 100% sure what to answer simply accept the default answers.

Note: In some cases using CPAN with Mac OS X is a bit problematic. In this case simply follow the instructions given here on this website http://sial.org/howto/perl/life-with-cpan/macosx/ to solve the problem.

GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>

Attention: Direct Link to the download but it's only a few hundred KB.

Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

Since OS X comes with no pkg-config, or to be more specific it's simply not complete in OS X, you have to install it via fink (http://fink.sourceforge.net), MacPorts (http://www.macports.org) or the gentoo port system (http://www.metadistribution.org/macos/).

If you need cups headers (on Mac OS X 10.3., building reports "cups.h missing"), then download them from http://ftp.cusoo.org/MacOSX/Utilities/PowerPC/cups_Panther/cups.tar.gz and put the headers to "/usr/include/cups".

If you want to compile OpenOffice.org with gtk2 support you have to install gtk2 via your porting_mechanism
Note: The most current versions of gkt2 and pkg-config are in about 90% of all cases only available as sources that you need to compile and not as binaries. Please consider this while preparing your mac.

Additional Note for fink users: You need to install both packages gtk2 and gtk2-devel using fink install </package name>

Yes, there are other porting mechanisms out there such as the one of NetBSD or you can get precompiled versions of gtk, gnu_copy and pkg-config via pages like osxgnu but the author of these build instructions has no experiences with these so no recommendation for them here.

Note: If you need help with installing or maintaining packages please contact the project that provides the porting_mechanism.

It's also possible to compile pkg-config, gnu_copy as part of the gnu-coreutils and gtk2 without fink or Macports. Be aware that in this case you need to resolve the various dependencies yourself. So we recommend using one of the porting mechanisms.

Because OS X does not install X11 by default and up to now you haven't installed one, now may be the time do so.
There are various X for Mac OS X out there e.g. Apple's X11, XDarwin.org's XDarwin or simply use your porting_mechanism to install either X.org 6.8.x or Xfree86 >=4.3.
For help with your X11 please contact the provider of the package or your porting mechanism project

By default OOo builds an Office Development Kit. This ODK requires you to download the unowinreg.dll from here http://tools.openoffice.org/unowinreg_prebuild/680/.

===Preparing to Build===

====Adding gpc to OOo sources====

1. uncompress <path to gpc>/gpc231.tar.Z
2. tar xvf <path to gpc>/gpc231.tar
3. cp <path to gpc>/gpc.[hc] <ooo source directory>/build/external/gpc/
4. rmdir gpc231

====Adding unowinreg.dll to OOo sources====

Copy the downloaded unowinreg.dll to <ooo source directory>/build/external/unowinreg/

====Applying Patches====

To apply a patch
cd
into the direcotory for the module which needs to be patched and do a:
patch -p0 <path/to/the patch>

Most of the patches use the naming scheme
modul_(subdirectory_subdirectory_etc)_filetopatch.patch.

To find all current patches do a search for issues in component subcomponent MacOSX.

You can grab the patches necessary to avoid the freetype crash from my idisk public folder

Due to the fact that not all the patches are from one author it's sometimes necessary to change to the subdirectory/ies or not. In this case the patch knows which subdirectories to jump over.

===Building OpenOffice.org===
Now that we've got it all the source, it's time to execute the build!

1. Open up a new Terminal.
2. Configure for your build
3. cd <path to ooo>/680_mXXX/build/config_office
4. ./configure --with-x --with-lang="de fr en-US"
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home/
--disable-build-mozilla --disable-neon --disable-gtk

Instead of using --with-freetype2=... you can also use --with-system-freetype
Attention: Darwinports gnu_copy is named gcp to avoid conflicts with Mac OS X cp

If you want to build with gtk-support please add --with-gtk2 to your configure script
and/or want to use your own apache-ant add --with-ant-home=<your path>/680_mxx/apache-ant-1.6.5

5. If configure fails it will output an error message saying what's missing or
what else causes it's breakage.
Be sure to also check the warnings configure outputs at the end of the configuration process.
Please report any breakage here with the error message output to dev@porting.openoffice.org
6. cd ..
7. ./bootstrap
8. Set up your shell build enviroment:
* for bash do:
PPC: source MacOSXPPCEnv.Set.sh
Intel: source MacOSXX86Env.Set.sh
* for tcsh do:
PPC: source MacOSXPPCEnv.Set
Intel: source MacOSXX86Env.Set
9. dmake
10. Report any and all build failures to mac@porting.openoffice.org mail list
11. cd instsetoo_native/unxmacxp.pro/OpenOffice/install
Within this directory you will find a folder for each language that
you build OpenOffice.org for. Those folders contain the installation disk images.

====Additional Information for Macports Users====
When using Darwinports be sure to use ./configure without freetype since it leads to OpenOffice.org crashing with a version mismatch error when using Macport's freetype. You will find the additional patches needed to build freetype within OpenOffice.org in the subdirectory freetype2_patches of the patch archive.

====Using Mozilla within OpenOffice.org====

If you decided to use Mozilla packages to get special functions OpenOffice.org provides you, as I did in the example configure script, you have two choices to get them:

First:

You let OpenOffice.org compile them. Be aware that this adds additional tim to your compiling time.

If you decide to let OpenOffice.org compile Mozilla remove --disable-build-mozilla from the
./configure script and OpenOffice.org will compile Mozilla within the moz directory.

1. Before building Mozilla be sure to download Mozilla Sources. You can get them e.g. here:
http://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.5/source/
2. cp mozilla-source-1.7.5.tar.gz <your path>/680_mXXX/moz/download
3. cd <your path>/680_mXXX/moz
4. cd config_office
5. Use the same ./configure script out of but this time remove --disable-build-mozilla
6. Continue with Step 5 of the "Building OpenOffice.org" paragraph

OpenOffice.org should now compile mozilla within its build process.

Second:

You grab the Mozilla packages for PPC here:
http://florian-heckl.de/ooo/MACOSXGCCPinc.zip
http://florian-heckl.de/ooo/MACOSXGCCPlib.zip
http://florian-heckl.de/ooo/MACOSXGCCPruntime.zip
and put them into <ooo build directory>/680_mXXX/moz/zipped
OpenOffice.org should detect and use them.

Please use the Mozilla packages from http://eric.bachard.free.fr/mac/moz/zipped/ these libraries are universal binaries. If you want to build using them on PPC 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'''runtime.zip
|-
| libs || MACOSXGCC'''I'''lib.zip || MACOSXGCC'''P'''lib.zip
|}

As you can see, '''P''' means PowerPC, and '''I''' means Intel

===Building the whole OpenOffice.org suite or just a single Project with Debug Information===

To build the whole OpenOffice.org Suite with debug informations add
--enable-debug
to the configure command.

To rebuild a complete project with debug information, remove all object files by removing the unxmacxp.pro directory. Then run dmake with the debug option set to true:

cd $SRC_ROOT/(module-name)
$SRC_ROOT/(module-name)> rm -rf unxmacxp.pro
$SRC_ROOT/(module-name)> build debug=true
$SRC_ROOT/(module-name)> deliver

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

Mac OS X Build Instructions (X11)

2007-10-19T14:31:24Z

Ponderability: /* Getting OpenOffice.org Source from CVS */

The current build instructions also at: http://porting.openoffice.org/mac/build_680_X11.html. Those are being moved to this page at OOo Wiki.

For historical reasons, there is also [[Mac OS X Build Instructions of SRC_m71]]

Note: supported compilers for Mac can be found in [[Compiler versions used by port maintainers and release engineers]]

Other [[:Category:MacOSX|Mac OS X related Wiki pages]].

=== Building OpenOffice.org X11 for Mac OS X PPC and Mac OS X x86===

Authors: Eric Hoch

Revised 2006-01-23

=== Introduction===

These build instructions are based upon milestone 680_m140 and higher.

Due to the nature of a port in progress this document cannot give a general overview of all the current patches necessary to build a specific milestone. To get this informations we recommend you to subscribe to our porting mailing list dev@porting.openoffice.org.

There you'll get all the latest informations about patches and everything else related to and needed to port OpenOffice.org to the Mac.

=== Special Thanks===
Before we begin let me thank all the people without whom those build instructions would make no sense, the coders that help bringing OOo 2.0 to Mac OS X.
The coders and supporters behind the Mac port are:

Eric Bachard
Thorsten Behrens
Etsushi Kato
Florian Heckl
Pavel Janik
Nakata Maho
James McKenzie
Tino Rachui
Stephan Schäfer
Eric Hoch
Shaun McDonald

=== Requirements ===

* The fastest machine you can find. It'd be good if it had memory, too.
* Mac OS X 10.3.5 or Mac OS X 10.4.x including all the latest available Security Updates for
your version of Mac OS X
* on Mac OS X 10.3.x: XCode 1.5 plus November 2004 gcc 3.3 Update for
* on Mac OS X 10.4.x: XCode 2.1
Note: You can get both applications after a free registration at http://connect.apple.com
* JDK 1.4.2 plus latest SDK Updates (with full JDK SDK for the headers)
* an installed X-Server. We recommend Apple's X11 but you can also use the ones of X.org or Xfree86
* A minimum of 4 to 5GB for a standard build.
Note: Usage of disk space depends upon the number of localizations you build for.
More localizations means more disk space needed.
A minimum of 18GB for a full debug build.
* If you can afford it we recommend you to backup clean sources and work with a second set of sources.
With a second set of clean sources you can easily go back to clean sources if a module doesn't build,
a patch doesn't solve the problem, you have to revert a patch or for any other reason there may be.
In the meantime cvs sources could have been edited and you need to recompile more modules then just
one and that's probably not what you want...

===Determine the shell you use for compilation===

The default shell of a cleanly installed Mac OS X 10.3.x/Mac OS X 10.4.x is bash.
If you did an update to 10.3.x or 10.4.x from early versions of Mac OS X while keeping your personal settings you may still use the tcsh shell, the default shell of Mac OS X 10.0 to 10.2.x.

Where necessary this read-me distinguishes between bash and tcsh.

To determine the shell you currently use open Terminal.app and type the following command:

ps -p $$

The output shows you which shell you're currently using.

-/bin/bash or -bash means you are using bash

-/bin/tcsh or -tcsh means you are using the c-shell

===Getting OpenOffice.org and External Sources===

====Getting OpenOffice.org Source from CVS====

Once you have X properly installed, it's time to get the OpenOffice.org sources and other external sources. If you've built OpenOffice.org from previous sources and have applied other patches, you will need to start from scratch with a fresh CVS version of the sources.

Download the CVS distribution for SRC680_mXXX (replace XXX by the current milestonenumber):

1. Open a new Terminal (/Applications/Utilities/Terminal)
2. mkdir 680_mXXX/source
3. cd 680_mXXX/source
4. Now set the CVSROOT
* for bash do:
export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
* for tcsh do:
setenv CVSROOT :pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
5. cvs login
6. Enter the password anoncvs
7. cvs -z3 co -r SRC680_mXXX OpenOffice2
for later milestones simply replace the XXX with the most current milestonenumber
8. go get some coffee, or a beer, since it'll take a while to get it all

Note that if your computer is behind a firewall and you're trying to get the sources from the CVS server, you may need to find a proper way to get it to tunnel through the firewall. The protocol runs on port 2401, and some firewalls will not allow communication on this port.

Attention: We recommend a broadband connection and a not too small amount of volume or time left within your contract since the sources are about 300MB and the checkout could take up to an hour or longer depending on the server load.

For further information on this topic see get the source

To get a second copy of the sources use the following commands within your 680_mXXX directory:

1. cd ..
2. mkdir build
3. cd build
4. cp -R ../source/* .

==== Additional software that's not in the official OpenOffice.org sources ====

Now that you have the sources it's time to get the software that is not in the official OOo Source Code Tree.

* The perl module Archive::Zip
* gpc - optional - NOT NEEDED
* pkg-config
* gtk2 - optional - not needed
* X11
* unowinreg.dll

To install Archive::Zip use the following commands in Terminal.app:

1. perl -MCPAN -eshell
2. install Archive::Zip

If this is your first installation of a module using CPAN you're asked to configure the CPAN environment. If you're not 100% sure what to answer simply accept the default answers.

Note: In some cases using CPAN with Mac OS X is a bit problematic. In this case simply follow the instructions given here on this website http://sial.org/howto/perl/life-with-cpan/macosx/ to solve the problem.

GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>

Attention: Direct Link to the download but it's only a few hundred KB.

Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

Since OS X comes with no pkg-config, or to be more specific it's simply not complete in OS X, you have to install it via fink (http://fink.sourceforge.net), MacPorts (http://www.macports.org) or the gentoo port system (http://www.metadistribution.org/macos/).

If you need cups headers (on Mac OS X 10.3., building reports "cups.h missing"), then download them from http://ftp.cusoo.org/MacOSX/Utilities/PowerPC/cups_Panther/cups.tar.gz and put the headers to "/usr/include/cups".

If you want to compile OpenOffice.org with gtk2 support you have to install gtk2 via your porting_mechanism
Note: The most current versions of gkt2 and pkg-config are in about 90% of all cases only available as sources that you need to compile and not as binaries. Please consider this while preparing your mac.

Additional Note for fink users: You need to install both packages gtk2 and gtk2-devel using fink install </package name>

Yes, there are other porting mechanisms out there such as the one of NetBSD or you can get precompiled versions of gtk, gnu_copy and pkg-config via pages like osxgnu but the author of these build instructions has no experiences with these so no recommendation for them here.

Note: If you need help with installing or maintaining packages please contact the project that provides the porting_mechanism.

It's also possible to compile pkg-config, gnu_copy as part of the gnu-coreutils and gtk2 without fink or Macports. Be aware that in this case you need to resolve the various dependencies yourself. So we recommend using one of the porting mechanisms.

Because OS X does not install X11 by default and up to now you haven't installed one, now may be the time do so.
There are various X for Mac OS X out there e.g. Apple's X11, XDarwin.org's XDarwin or simply use your porting_mechanism to install either X.org 6.8.x or Xfree86 >=4.3.
For help with your X11 please contact the provider of the package or your porting mechanism project

By default OOo builds an Office Development Kit. This ODK requires you to download the unowinreg.dll from here http://tools.openoffice.org/unowinreg_prebuild/680/.

===Preparing to Build===

====Adding gpc to OOo sources====

1. uncompress <path to gpc>/gpc231.tar.Z
2. tar xvf <path to gpc>/gpc231.tar
3. cp <path to gpc>/gpc.[hc] <ooo source directory>/build/external/gpc/
4. rmdir gpc231

====Adding unowinreg.dll to OOo sources====

Copy the downloaded unowinreg.dll to <ooo source directory>/build/external/unowinreg/

====Applying Patches====

To apply a patch
cd
into the direcotory for the module which needs to be patched and do a:
patch -p0 <path/to/the patch>

Most of the patches use the naming scheme
modul_(subdirectory_subdirectory_etc)_filetopatch.patch.

To find all current patches do a search for issues in component subcomponent MacOSX.

You can grab the patches necessary to avoid the freetype crash from my idisk public folder

Due to the fact that not all the patches are from one author it's sometimes necessary to change to the subdirectory/ies or not. In this case the patch knows which subdirectories to jump over.

===Building OpenOffice.org===
Now that we've got it all the source, it's time to execute the build!

1. Open up a new Terminal.
2. Configure for your build
3. cd <path to ooo>/680_mXXX/build/config_office
4. ./configure --with-x --with-lang="de fr en-US"
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home/
--disable-build-mozilla --disable-neon --disable-gtk

Instead of using --with-freetype2=... you can also use --with-system-freetype
Attention: Darwinports gnu_copy is named gcp to avoid conflicts with Mac OS X cp

If you want to build with gtk-support please add --with-gtk2 to your configure script
and/or want to use your own apache-ant add --with-ant-home=<your path>/680_mxx/apache-ant-1.6.5

5. If configure fails it will output an error message saying what's missing or
what else causes it's breakage.
Be sure to also check the warnings configure outputs at the end of the configuration process.
Please report any breakage here with the error message output to dev@porting.openoffice.org
6. cd ..
7. ./bootstrap
8. Set up your shell build enviroment:
* for bash do:
PPC: source MacOSXPPCEnv.Set.sh
Intel: source MacOSXX86Env.Set.sh
* for tcsh do:
PPC: source MacOSXPPCEnv.Set
Intel: source MacOSXX86Env.Set
9. dmake
10. Report any and all build failures to mac@porting.openoffice.org mail list
11. cd instsetoo_native/unxmacxp.pro/OpenOffice/install
Within this directory you will find a folder for each language that
you build OpenOffice.org for. Those folders contain the installation disk images.

====Additional Informations for Macports Users====
When using Darwinports be sure to use ./configure without freetype since it leads to OpenOffice.org crashing with a version mismatch error when using Macport's freetype. You will find the additional patches needed to build freetype within OpenOffice.org in the subdirectory freetype2_patches of the patch archive.
====Using Mozilla within OpenOffice.org====

If you decided to use Mozilla packages to get special functions OpenOffice.org provides you, as I did in the example configure script, you have two choices to get them:

First:

You let OpenOffice.org compile them. Be aware that this adds additional tim to your compiling time.

If you decide to let OpenOffice.org compile Mozilla remove --disable-build-mozilla from the
./configure script and OpenOffice.org will compile Mozilla within the moz directory.

1. Before building Mozilla be sure to download Mozilla Sources. You can get them e.g. here:
http://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.5/source/
2. cp mozilla-source-1.7.5.tar.gz <your path>/680_mXXX/moz/download
3. cd <your path>/680_mXXX/moz
4. cd config_office
5. Use the same ./configure script out of but this time remove --disable-build-mozilla
6. Continue with Step 5 of the "Building OpenOffice.org" paragraph

OpenOffice.org should now compile mozilla within its build process.

Second:

You grab the Mozilla packages for PPC here:
http://florian-heckl.de/ooo/MACOSXGCCPinc.zip
http://florian-heckl.de/ooo/MACOSXGCCPlib.zip
http://florian-heckl.de/ooo/MACOSXGCCPruntime.zip
and put them into <ooo build directory>/680_mXXX/moz/zipped
OpenOffice.org should detect and use them.

Please use the Mozilla packages from http://eric.bachard.free.fr/mac/moz/zipped/ these libraries are universal binaries. If you want to build using them on PPC 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'''runtime.zip
|-
| libs || MACOSXGCC'''I'''lib.zip || MACOSXGCC'''P'''lib.zip
|}

As you can see, '''P''' means PowerPC, and '''I''' means Intel

===Building the whole OpenOffice.org suite or just a single Project with Debug Information===

To build the whole OpenOffice.org Suite with debug informations add
--enable-debug
to the configure command.

To rebuild a complete project with debug information, remove all object files by removing the unxmacxp.pro directory. Then run dmake with the debug option set to true:

cd $SRC_ROOT/(module-name)
$SRC_ROOT/(module-name)> rm -rf unxmacxp.pro
$SRC_ROOT/(module-name)> build debug=true
$SRC_ROOT/(module-name)> deliver

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

Documentation/Building Guide/Building on MacOSX

2007-02-04T15:44:56Z

Ponderability: /* '''Creating Debug-Versions of Modules''' */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS).

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is 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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
If X11 and /or X11SDK is(are) not installed :
sudo mkdir -p /usr/X11R6

sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

=== Strongly recommended ===

==== ccache ====
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) :

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

=== Optional ===

==== gnu copy ( optional since m201) ====

cp provided with XCode is now sufficient. If you prefer install GNU cp :

Install Fink version : in Fink terms this is in the package ''fileutils''.

Install Darwin version

Last, if you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

==== Java ====

Normally installed with XCode.

==== Fink ====

You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m202/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (February 2nd 2007) is m202. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m202
cd src680-m202

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m202 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m202 OpenOffice2
</code>
Once done, you'll obtain milestone 202. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m202 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m202 will become canvas_m202 , and then, cp canvas from aquavcl01-src into src-m202

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m202 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m202
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m202/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m202''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m202''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|-
| ''' (deprecated) m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

'''(deprecated) m200''': Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m202/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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. Be patient. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not advised.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m202/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m202/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m202/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.2_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.2" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.2.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

'''Soon optional (tests in progress) '''

After the OpenOffice 2.2 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.2.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-04T15:43:52Z

Ponderability: /* '''Doing the build (about 4,5 GB)''' */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS).

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is 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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
If X11 and /or X11SDK is(are) not installed :
sudo mkdir -p /usr/X11R6

sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

=== Strongly recommended ===

==== ccache ====
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) :

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

=== Optional ===

==== gnu copy ( optional since m201) ====

cp provided with XCode is now sufficient. If you prefer install GNU cp :

Install Fink version : in Fink terms this is in the package ''fileutils''.

Install Darwin version

Last, if you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

==== Java ====

Normally installed with XCode.

==== Fink ====

You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m202/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (February 2nd 2007) is m202. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m202
cd src680-m202

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m202 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m202 OpenOffice2
</code>
Once done, you'll obtain milestone 202. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m202 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m202 will become canvas_m202 , and then, cp canvas from aquavcl01-src into src-m202

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m202 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m202
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m202/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m202''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m202''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|-
| ''' (deprecated) m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

'''(deprecated) m200''': Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m202/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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. Be patient. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m202/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m202/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m202/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.2_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.2" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.2.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

'''Soon optional (tests in progress) '''

After the OpenOffice 2.2 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.2.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:42:33Z

Ponderability: /* Xcode */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is 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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:40:38Z

Ponderability: /* Xcode */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is XCode 2.4, which can be downloaded at http://developer.apple.com/tools/download/.

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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:39:39Z

Ponderability: /* Xcode */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is 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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:38:39Z

Ponderability: /* Xcode */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is XCode 2.4, which can be downloaded at http://www.apple.com/macosx/features/xcode/.

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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:38:02Z

Ponderability: /* Xcode */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is XCode 2.4, which can be downloaded at [[http://www.apple.com/macosx/features/xcode/]].

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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:27:57Z

Ponderability:

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The purpose of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is 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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to successfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you already did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:21:31Z

Ponderability: /* Xcode */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The bias of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 enviroment here: [http://tools.openoffice.org/build_env.html Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is 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 Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to succsessfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. You can finde 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you arelady did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]

Documentation/Building Guide/Building on MacOSX

2007-02-01T01:20:27Z

Ponderability: /* '''Prerequisites''' */

<big>'''This document tries to wrap-up the build process for [[OpenOffice.org]] on MacOS X using the native windowing-toolkit of the platform named Aqua.''' </big>

An important goal is to get the demonstration programs "svdem" up and running. They act as a fairly good starting point to further endeavours, since they are used to test the capabilities of the underlying [[VCL]] layer. If this is achieved, one can build and Install the full-fledged OpenOffice.org Package. The bias of this document is to describe the cumbersome build process of OpenOffice.org rather than to give a kickstart in the coding involved to get VCL ported to Carbon. A starting point for this is Pierre de Filippis excellent [[Intro To Mac Porting]].

I use the bash shell in all examples, since to my 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 enviroment here: [http://tools.openoffice.org/build_env.html Open OfficeBuild Environment].

Many thanks for help and assistance go to Pavel Janik and Eric Bachard.

== '''Prerequisites''' ==

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: [[MacOSXBuildInstructions]]. Here I like to outline the things you need to build the Aqua Version (besides the OS). You are much better off to install the Fink Package Manager on your Apple, to resolve these dependencies (and get some cool stuff too). Go to [http://fink.sourceforge.net Fink]

=== Mandatory ===

==== Xcode ====

This is (with GNU cp, soon optional) the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is XCode 2.4

Xcode 2.2, 2.3 are known to work for Aqua development. Please add earlier versions work as well, please add them here.

==== X11SDK (soon optional) ====

A dependency for Mozilla plugin needs some prototype defined in some Xllib.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

'''Workaround''' : XCode does contain Xlib headers. Just modify INCLUDE path properly will solve the build issue.

Meant replace ( not existing)
/usr/X11R6/include

with (existing) : /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include

Doing a symlink between them :
<code>
sudo ln -s /Developer/SDKs/MacOSX10.4u.sdk/usr/X11R6/include /usr/X11R6/include
</code>

<pre>This issue should be fixed soon.</pre>

==== gnu copy ( soon optional ) ====

Note : cloph05 will fix GNU cp version needed, and the one provided with XCode will become sufficient.

In Fink terms this is in the package ''fileutils''.

If you prefer direct download, GNU coreutils can be found at http://www.gnu.org/software/coreutils/coreutils.html.

After installing, you should copy or rename the newly installed cp to gnucp (located at /usr/local/bin/cp or /sw/bin/cp if you used Fink) (cf. http://qa.openoffice.org/issues/show_bug.cgi?id=69711)

=== Strongly recommended ===

==== ccache ====
If you indend 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) :

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

=== Optional ===

==== Java ====

Normally installed with XCode.

==== The perl module Archive::Zip ( optional ) ====

Nothing is needed anymore with recent versions of XCode (means : not needed with XCode 2.4 at least).

If you still have issues doing configure because of that, please install Archive::Zip repecting the instructions below :

<code>[bash,N]
perl -MCPAN -eshell
install Archive::Zip
</code>

==== gpc ( optional) ====
GPC is available here: ftp://ftp.cs.man.ac.uk/pub/toby/gpc/gpc231.tar.Z>
Attention: Direct Link to the download but it's only a few hundred KB.
Note: You can alternatively use the libart_lgpl library instead of GPC. This requires an additional configure flag (--enable-libart) and a precompiled libart library installed in a standard location, such as /usr/lib.

==== pkg-config (optional) ====

Nothing to install on Aqua build, since --disable-gtk is forced

Called ''pkgconfig'' in Fink.

pkg-config can be found here : http://pkgconfig.freedesktop.org/wiki/

==== Apache Ant 1.6.5 (optional) ====
'''Not Adviced''' : XCode does provide a perfectly working version of ant.

It is up to you if you prefer use this one.

An up to date version of ant is shipped with XCode.

For the OpenOffice Builds you need to have Apache's Ant in the source-directory. You have to have Ant Version 1.6.5+. My Ant usually resides in /opt/ant so i link it in from there:
<code>[bash,N]
cd src680-m200/
ln -s /opt/ant/ apache-ant-1.6.5
</code>

To set them, you just need to add these two previous parameters to your build.sh (see [[#One-Time preparations and scripts]] for details).

== '''Some Background (what is aquavcl01, EIS)''' ==

=== EIS ===
OpenOffice sources are basically kept in the CVS server located at anoncvs.services.openoffice.org. However this repository is managed by a database on top called EIS (Environment Information System) which is used to keep track of Master- and Client Workspaces. Master Workspaces are used to keep track of changes going back of the mainline trunk and undergo extensive QA-cycles. These Master Workspaces are driven to official releases. Child workspaces in contrast are copies of certain Master Workspaces used to develop and test bugfixes and additional functionality. These Child Workspaces are later (hopefully) merged back to mainlain Master Workspaces. The TX20 Report mentioned in the Links section gives a very good overview about the overall process. To learn more about Childworkspaces (CWS) have a look here: [[CWS]].

Go to EIS http://eis.services.openoffice.org/EIS2/servlet/Logon and Logon as guest/guest to get yourself an impression. You can find information about the different workspaces, their dates and times there.

=== VCL (Visual Class Libraries) ===

Porting OpenOffice.org to a new Windowing Toolkit is mostly porting of the OpenOffice's VCL Layer (Visual Class Libraries) to the new platforms toolkit. The VCL-Layer is responsible of mapping the OpenOffice Application calls to the windowing toolkit.

The (native) OpenOffice port to MacOSX using the Aqua Windowing Toolkit is developed in a child workspace called '''aquavcl01'''. This child workspace consists of the modules (aka subdirs): canvas dtrans extensions freetype padmin scp2 sj2 solenv vcl.

The basic approach to prepare a developer's client system to succsessfully build OpenOffice/Aqua is the following:

# checkout a given OpenOffice Milestone.
# checkout aquavcl01 Child Workspace.
# merge them together.
# apply the latest patches.

The last point here is a cumbersome but nevertheless necessary operation, since this porting project is in flux. Thanks to Pavel and many others improvements are happening at tremendous pace at the moment. All of these improvements get distributed as patches/diffs against aquavcl01. Aquavcl01 needs to remain stable all the time, therefore the team needs to work on this patch-by-patch aproach at the moment.

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

Now let's have a look what to check-out and where. All these milestone numbers below highly depend on the given point-in-time. The current milestone as of now (January 27th 2007) is m200. You may change this to your needs. You can finde 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: ====
<code>[bash,N]
mkdir src680-m200
cd src680-m200

export CVSROOT=:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs
cvs login
</code>
Please Enter the password 'anoncvs'

==== checkout Milestone m200 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m200 OpenOffice2
</code>
Once done, you'll obtain milestone 200. this not exactly what we want, because all changes concerning aquavcl01 Child workspace are not included. To complete, we need to check aquavcl01 changes.

==== checkout Aquavcl01 (50 MB): ====

1) First possibility : create a dedicated tree (cool backup )

To check aquavcl01 Child workspace, the most simple is to create aquavcl01 directory, and go inside this dir
<code>[bash,N]
mkdir aquavcl01-src

cd aquavcl01-src
</code>
(assuming you arelady did cvs login ..etc )
<code>[bash,N]
cvs -z3 co -r cws_src680_aquavcl01 OpenOffice2
</code>
The following modules will be present at the end :
<div style="background-color: lightyellow; border: 1px red dashed; padding: 3px 0 3px 15px;">
canvas

extensions

fpicker

padmin

sal

scp2

sfx2

solenv

dtrans

freetype

psprint

sj2

vcl

toolkit
</div>

All these modules are the ones we modified to create the native version : they all are tagged "aquavcl01" (see all CVS/Tag files in the tree) and all you have to do is either rename or delete the one located in src680-m200 and replace them with the one located in aquavcl01-src.

e.g. : canvas in src680-m200 will become canvas_m200 , and then, cp canvas from aquavcl01-src into src-m200

This applies for all the modules listed above.

2) Second possibility : use a little script to extract changes : extract_aquavcl01.sh

This shell script, located in src680-m200 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl sal toolkit"
for i in $list ; do
mv $i $i-m200
cvs -z3 co -r cws_src680_aquavcl01 $i
done
</code>

Then chmod +x extract_aquavcl01.sh

and run it :

./extract_aquavcl01.sh

When finished, and if no problem occurs, you should have a complete tree.

=== 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:
<code>[bash,N]
cd src680-m200/config_office/
ln -s ../../bin/build.sh
</code>
And this is how 'build.sh' looks like:

<code>[bash,N]
#!/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-gnu-cp=/sw/bin/cp \
--with-epm=internal \
--disable-mozab \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--disable-neon \
--without-nas
</code>

--disable-odk 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.

--disable-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, but my overall goal is to get people to have 'svdem' build to start coding rather than to have a production ready build for the final release. Therefore I switched off most of the stuff. How these offical builds are done in the long run is to be decided when we get there.

== '''List of Patches for a given Milestone''' ==

Here is a list of Patches one has to apply against a given Milestone of SRC680 (including CWS aquavcl01). Please keep the older Milestones here, since people are probably still on these Versions.



PLEASE NOTE : '''Current milestone for Aqua build is m200''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m200''' || To avoid crashes with several entries in menu apply [http://eric.bachard.free.fr/patches/aqua/about_workaround/diff_salframe.diff about_workaround patch] in vcl/aqua/source/window ||Work in progress
|}

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

m200: Breakage in instsetoo_native

See [http://eric.bachard.free.fr/mac/aquavcl/patches/m200_aquavcl01/instsetoo_native_util_makefile.mk.diff Fix for instsetoo_native breakage]

how apply the patch ?

Place it in <install_dir>/instsetoo_native/util

type :

patch -p0<instsetoo_native_util_makefile.mk.diff

m196: Breakage in pyuno

See [http://www.openoffice.org/issues/show_bug.cgi?id=72372 pyuno not found]

'''Workaround''' :

<pre>
1) either use the patch provided in issue 72372

2) or simply do ( in the same terminal, or please source the environment before):

cd bridges
build && deliver
cd ../pyuno
build && deliver

-> pyuno should build without any problem

cd .. && dmake

will complete your build

</pre>
[[User:Ericb|Ericb]] 14:52, 13 December 2006 (CET)

== '''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-m200/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:

On PowerPC :

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
time dmake

Or (on Mac Intel ) :

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
time dmake

The main purpose of the '''boostrap''' 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 Enviroment-Variables for the Build will be set up. For a detailed descripton 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. Be paitioned. What can you do meanwhile? Do this:
<code>[bash,N]
while true ; do find . -maxdepth 1 -type d -anewer MacOSXPPCEnv.Set.sh |wc -l ; sleep 5; done
</code>
and wait till the number reaches 174

== '''Creating Debug-Versions of Modules''' ==

<pre> Important: a new section about use XCode for OpenOffice.org debug has been created.
See :</pre>

[[MacOSX_Debug_OpenOffice.org_using_XCode]]

'''Is it possible to build the complete set with symbols included ?'''

Currently not possible, and not adviced.

''' is it possible to build some modules with symbols ?'''

Yes, and that's the simplest way to proceed. Some modules, like sal and vcl can be rebuilt using debug.

Example :

To rebuild sal with symbols included, do:

<code>[bash,N]
cd sal
rm -rf unxmacxp.pro
build debug=true
</code>

and recopy the libs into the bundle. gdb will display the symbols, and make your life easier.

Note : debug string is tested, and DEBUG is active when debug string is not empty. So debug=t works too.

''' How change gdb options, and use e.g. -g -ggdb or -gdwarf-2 ?'''

To rebuild the module, you just have to modify the option in solenv/inc/unxmacx.mk, replacing -g with -ggdb

'''Known issues'''

Sometimes a build error, or a runtime error, may be seen in the normal build,
but the error goes away when --enable-debug is used or if the module is compiled with debug=true.

The DEBUG build turns off optimisation, so this is a hint that compiler optimisation causes the error.

The error might be due to incorrect code or a compiler fault. Such errors might not be seen on all platforms,

and might not be seen in different compiler versions on one platform.

If the code can not be fixed there is a workaround using NOOPTFILES to build specified files with no optimisation.

Example :

jvmfwk on Mac OS X: build jvmfwk in m183 on Mac OS X Intel leads to Bus Error when javaldx is run.

Solution : use trial and error to rebuild individual files with debug=true. This proves the problem lies with vendorbase.cxx

Have a look in sc/source/core/data/makefile.mk for an example to use NOOPTFILES

To solve our problem: just add : NOOPTFILES= $(SLO)$/vendorbase.obj in the corresponding makefile.

Take care in case some .IF is needed to prevent interference with other platforms.

There's some additional information around debugging on Christians Page [[User:CL#2006-09-03]]

== Building and running svdem ==

We want to run the demonstration programs called "svdem". There are a couple of binaries called "svdem", which area they cover is still somewhat unclear to me, I hope some of you guys can shed some light here. But hey, this is a wiki! Just correct here :-).

==== svdem from VCL ====
To have the VCL Testprogram build you have to do:

'''[FIXME] replace this scetion with the same, but about svdem from svtools'''

cd vcl; build --all

This should have created a file called "svdem" here: vcl/unxmacxp.pro/bin/svdem. If you managed to build these binaries, you are nearly there. What you need now, is a wrapper directory structure to make this binary a fellow Mac OSX application. I mean the ones which have this structure:

svdem.app/
svdem.app/Contents
svdem.app/Contents/Info.plist
svdem.app/Contents/MacOS
svdem.app/Contents/MacOS/applicat.rdb
svdem.app/Contents/MacOS/svdem

You can basically create this structure anywhere you want. And you can link-in the file you just created (svdem). So you build up this structure once and link-in the freshly created svdem there:

ls -l svdem applicat.rdb
svdem -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m200/vcl/unxmacxp.pro/bin/applicat.rdb

Now only the Info.plist file is missing, so here we go:

<code>[xml,N]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleDisplayName</key>
<string>SvDem</string>
<key>CFBundleExecutable</key>
<string>svdem</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.svdem</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0</string>
<key>LSRequiresCarbon</key>
<true/>
</dict>
</plist>
</code>

If you created the directory structure properly you can do './svdem' in the 'svdem.app/Contents/MacOS/' directory. You should see the svdem coming up.

==== svdem from svtools ====
* Copy the application package you created for the vcl svdem.
* Source your MacOSX[PPC-X86]Env.Set.sh
* Go into svtools/workben
* build svdem using dmake in the workben directory
* link the svdem and applicat.rdb from Contents/MacOS to the ones located in svtools/unxmacxp.pro/bin

You are done : you can now source your environment and run svdem using your usual shell.

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

Here I like to outline the steps to run OpenOffice.org after a successful build from the sources. Running the native Aqua Version of OpenOffice.org is somewhat tricky at the moment, since the installation procedure and mode are not in their final state. So right now one has to manually do some preparations to run the Office suite. This will change in the future when we are about to release some Alpha Builds to a wider audience.

=== Drag & Drop Install the Application from the Diskimage ===

When you are one of the lucky few (Don't give up, Eric!), who have a successful build, you are going to see something like this as the last lines of the build:

.
.
.
......................................................................................................................................................
(CRC32 $11685D33: DiscRecording 3.1.3f2 (Apple_HFS : 2))
Ressourcen hinzufügen…
......................................................................................................................................................
Dauer: 15.406s
Dateigröße: 144732418 Bytes, Prüfsumme: CRC32 $14E0BB67
Bearbeitete Sektoren: 773848, 773845 komprimiert
Geschwindigkeit: 24.5M Bytes/Sek
Ersparnis: 63.5 %
created: /opt/src/openoffice/src680-m200/instsetoo_native/unxmacxp.pro/OpenOffice/install/de/OpenOffice.org-2.1_de.dmg

In this final step the ""instsetoo_native"" target creates the install Diskimages using Apple's 'hdiutil'. In my case it gives its output in German. After this disk image(s) have been created, double click the disk image to mount it (or type open <path to the DMG Image>) , and then move the icon named "OpenOffice.org 2.1" to your ''Applications'' folder (or any other folder you want this program to reside). The "OpenOffice.org 2.1" icon shown in the Finder is in fact a subdirectory called "OpenOffice.org 2.1.app". Subdirectories named ".app" (along with some well-know files inside like Info.plist, etc) are called ''Bundles'' in Apple's lingo.

=== Prepare the installation ===

After the OpenOffice 2.1 Application has been copied to its destination, you have to go into this bundle and run a small shell script provided by Pavel Janik to prepare soffice.bin (OpenOffice.org launcher) for running. You have to run this script in the directory where a Universal Binary called "droplet" is located. This "droplet" binary was used to fire-off the X11 version of OpenOffice.org. Expect this to change, but as of now we have to do it like this.

I have put my OpenOffice.org build in my home directory's private "Application" folder (/Users/schmidtm/Applications), so please change this path to your installation. Now go to into the bundle and run the script:

cd /Users/schmidtm/Applications/OpenOffice.org 2.1.app/Contents/MacOS
/opt/src/openoffice/bin/fix_installed_OOo

<code>[bash,N]
#!/bin/bash

[ ! -f droplet ] && {
echo "Please run me in the directory, where binary named droplet is located."
exit 0
}

mv THIRDPARTYLICENSEREADME.html help presets share ..
mv droplet droplet.orig
mv program/* .
rmdir program

cd ..
ln -sf MacOS program
sed 's#droplet#soffice.bin#' Info.plist >Info.plist.new
mv Info.plist.new Info.plist
cd MacOS
</code>

=== Run the soffice.bin ===

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

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

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="5" cellspacing="0"
|-
! Variable || Function
|-
| SAL_NO_VCL=TRUE || disable native controls code
|-
| AQUA_NATIVE_MENUS=TRUE || enable experimental 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.

'''HACK''' : with current code, to enable native menus by defaut without have to define an environment variable, just comment as follow :

in vcl/aqua/source/window/salmenu.cxx, around line 124 :
<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_MENUS");

if ( !pExperimental || strcasecmp(pExperimental, "TRUE") )
return FALSE;
*/
</code>

== External links ==

# Bug Database: http://www.openoffice.org/issues/query.cgi
# Mailinglist: mac@porting.openoffice.org
# IRC Meeting-Logs (#ooo_macport@freenode.org): http://eric.bachard.free.fr/mac/aquavcl/logs_meetings/
# 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
# 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

== 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
# Native Menus : http://eric.bachard.free.fr/mac/aquavcl/screenshots/aqua_native_controls_03_11_06/aqua_menus_01.jpg

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]]