Mac OS X Porting - Roadmap

2007-11-16T08:38:54Z

Ssa: display cws name cloph10 in EIS link, add obr

Mac OS X Porting - Roadmap

2007-11-15T16:12:55Z

Ssa: Mac OS X Porting Roadmap, initial version

Documentation/Building Guide/Building on MacOSX

2007-01-12T06:31:19Z

Ssa: /* checkout Aquavcl01 (50 MB): */

<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 buld the Aqua Version (besides the OS). Your 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-m196/
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 (November 8th 2006) is m195. 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-m196
cd src680-m196

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

==== checkout Milestone m196 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m196 OpenOffice2
</code>
Once done, you'll obtain milestone 196. 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-m196 and replace them with the one located in aquavcl01-src.

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

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-m196 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-m196
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-m176/
src680-m182/
...

Now I go to the 'config_office' subdir and link in my startscript:
<code>[bash,N]
cd src680-m196/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 m196''' (older milestones are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| ''' m196''' || 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) m195''' || 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''' ==

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-m196/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 MacOSXIntelEnv.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 'MacOSXIntelEnv.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-m195/vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m195/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-Intel]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-m196/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

2006-11-21T20:52:41Z

Ssa: /* checkout Aquavcl01 (50 MB): */

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. The main 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 buld the Aqua Version (besides the OS). Your 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]

=== Xcode ===
Xcode 2.2, 2.3 and 2.4 are known to work for Aqua development. Please add earlier versions work as well, please add them here.

=== Java 1.4.2+ ===

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

=== gpc ===
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 ===
Called ''pkgconfig'' in Fink.

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

=== gnu copy ===
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)

=== ccache (optional) ===
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 :
CC="ccache gcc"
CXX="ccache g++"

=== 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-m192/
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 Backgroud (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 (November 8th 2006) is m192. 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-m192
cd src680-m192

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

==== checkout Milestone m192 (1,5 GB): ====
<code>[bash,N]
cvs -z3 co -r SRC680_m192 OpenOffice2
</code>
Once done, you'll obtain milestone 192. 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 :

canvas
extensions
fpicker
padmin
scp2
sfx2
solenv
dtrans
freetype
psprint
sj2
vcl

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-m192 and replace them with the one located in aquavcl01-src.

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

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-m192 will contain :
<code>[bash,N]
#!/bin/bash
list="canvas extensions fpicker padmin scp2 sfx2 solenv dtrans freetype psprint sj2 vcl"
for i in $list ; do
cd $i
cvs up -j CWS_SRC680_AQUAVCL01_ANCHOR -j cws_src680_aquavcl01
cd ..
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-m176/
src680-m182/
...

Now I go to the 'config_office' subdir and link in my startscript:
<code>[bash,N]
cd src680-m192/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.

=== 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-m192/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 MacOSXIntelEnv.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 'MacOSXIntelEnv.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 ===

'''Is it possible to build the complete set ?'''

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-m192//vcl/unxmacxp.pro/bin/svdem
applicat.rdb -> /opt/src/openoffice/src680-m192//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-Intel]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-m192/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 AQUA_NATIVE_CONTROLS=TRUE ./soffice.bin -nofirststartwizard -norestore

Notice the enviroment variable here. It's experimental stuff created by Pavel. At the moment we have:

{| border="1" cellpadding="5" cellspacing="0"
|-
! Variable || Function
|-
| AQUA_NATIVE_CONTROLS=TRUE || enable 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.

'''UPDATE'''

<pre>
Soon, native menus and native controls will become default, and vcl native controls will continue to be available using
SAL_NO_NWF variable set to TRUE
</pre>

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

in vcl/aqua/source/gdi/salnativewidgets.cxx , around line 55 :

<code>
/*
static const char *pExperimental = getenv ("AQUA_NATIVE_CONTROLS");

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

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>

== 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 m192''' (older are deprecated)

{| border="1" cellpadding="5" cellspacing="0"
|-
! Milestone || Patch to apply || Status
|-
| '''m192''' || '''Patch 1''': to avoid systematical crashes in runtime you'll have to apply [http://eric.bachard.free.fr/patches/aqua/vcl67/vcl67.patch vcl67 patch] in vcl '''Patch 2''' : to simply start OpenOffice.org after applying Pavel's script (else, launch OpenOffice.org using a terminal is mandatory) apply [http://eric.bachard.free.fr/patches/aqua/fix_libsalsystools/i69373.diff.txt i69373]|| OK
|-
| '''m192''' || 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)''' m187 || '''Patch 1''': to avoid systematical crashes in runtime you'll have to apply [http://eric.bachard.free.fr/patches/aqua/vcl67/vcl67.patch vcl67 patch] in vcl '''Patch 2''' : to simply start OpenOffice.org after applying Pavel's script (else, launch OpenOffice.org using a terminal is mandatory) apply [http://eric.bachard.free.fr/patches/aqua/fix_libsalsystools/i69373.diff.txt i69373]|| OK
|-
|''' (deprecated)''' m187 || 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
|}

== 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/scrollbar_01sept
# 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]]

User:Ericb

2006-07-28T19:10:10Z

Ssa: /* '''2006''' */

==Public Documentation License Notice==

The contents of this Documentation (excepted Native Port Roadmap),are subject to the Public Documentation License Version 1.0 (the "License"); you may only use this Documentation if you comply with the terms of this License. A copy of the License is available at http://www.openoffice.org/licenses/PDL.html.
The Original Documentation is "Mac OS X native port". The Initial Writer of the Original Documentation is (JCA) Eric Bachard (C) 2005-2006. All Rights Reserved. (Initial Writer contact(s): ericb@openoffice.org.)

=='''Mac OS X Native port'''==

<div class="messagebox cleanup metadata" style="border:1px solid blue;background-color:#B3FFF5;padding:7px;">
'''The first Mac OS X native port objective is make OpenOffice.org run without X11 use, to make it a real Mac application.'''

'''The second one is respect Aqua Human interface Guidelines'''

''' This is a long term work, and every help and/or contributions, like donations** are welcome.'''
</div>

**see http://contributing.openoffice.org/index.html

=='''Native Port Roadmap'''==

==='''2006'''===

* June 2006 : work in progress

- Basis : frame, instances, threads, drawing, painting, resizing (Stephan Schaefer, Tino Rachui )

Done :
implement threads
create, manage instance
create, manage windows ( including parents)
create, manage events
create manage drawing, resizing
create, add menus ( Pavel Janik )
toggle window fullscreen( Pierre de Filippis )
make font server work (Stephan Schaefer )

* Current status font support (Stephan Schaefer, 2006/07/28): the following features are basically working now
** font selection
** font size
** simple font attributes (bold, italic)

Screenshot (svdem sample application: main window and font chooser)

[[Image:aquaport-svdem.png]]

[[Image:aquaport-fontdialog.png]]

Next step : document first part, and propose design

- native filepicker ( Oliver Braun )

- native printing implementation ( Oliver ? )

- native font implementation ( Eric Bachard )

* September 2006 :

- first proofs of concept : fonts, filepicker .. (more ?)
- show the results ( OOoCon 2006 ? )

==='''2007'''===

* January 2007 : first alpha implementation

=='''IRC Mac port meetings'''==

=== Description ===

You want to know last Mac OS x port development status ? You want to meet us ?

If you know how use IRC, weekly (excepted from 29th july to 20th august), Mac port meeting are scheduled.

Hours may vary, but most of the time friday or saturday.

IRC server : irc.freenode.net

Channel : #ooo_macport

'''These meetings are public, and everyone interested in OpenOffice.org development is welcome !'''

=== Agenda for the next meeting ===

'''Next Mac port meeting is scheduled''' : '''Friday 28th of July, 21:00 UTC , means 23:00 CEST''' ( Paris or Hambourg hour ), or even 6:00 hour Japanese hour.

Agenda :

1) Last news

welcome new devs ( Eric Bischoff if present)

last website changes (from Eric Hoch, if present)

native port news

X11 version : last changes for 2.0.4, last new issues

2) Tino's presentation ( proposed by Tino Rachui )

Action items :

3) aquavcl01 integration:
decide what can be integrated
decide a plan to write documentation about the changes
decide to write a todo list

4) create a dedicated list, to separate devel from users informations

5) decide next meeting date ( holidays ... )

Misc

=== Previous meetings logs ===

FYI, previous meetings logs are available :

'''[[previous Mac Meeting logs]]'''

[[User:Ericb|Ericb]] 15:21, 21 July 2006 (CEST)

==Description of the Native Port problem==

=== How does OpenOffice.org work on Mac OS X ? ===

Currently, on Mac OS X, OpenOffice.org uses X11, as "client" : X11 is a graphical server, coming from Unix world, and able to run under Linux, *BSD, Solaris, Mac OS X.

- X11 is run as an application, managed like other Apple applications.
- All unix like applications are managed by X11, and from Aqua environment, only X11 is seen as only one applicatiion,
even if other Unix/Linux (e.g. ) applications are runing.

OpenOffice.org asks X11 to display a window, waits for X11 acknowledgment, and OpenOffice.org displays the window. All transactions use the network, locally or not. the same mechanism is used for everything to be displayed.

[[User:Ericb|Ericb]] 11:39, 3 June 2006 (CEST)

=== Issues and known problems ===

All events are managed by OpenOffice.org and X11, using the Xlib

Only .ttf fonts type is currently available. Note : '''system fonts are available '''

The rendering is made by X11, not by Mac OS X rendering engine.

X11 and all its clients are seen as one application only : drag and drop protocol does not work because of that ( solution : Pasteboard Manager)

==== Other links ====

http://wiki.services.openoffice.org/wiki/List_of_OpenOffice.org_Mac_OS_X_issues_and_problems#

http://wiki.services.openoffice.org/wiki/Printing_problems_with_OpenOffice.org_2.0_for_Mac_OS_X#Reporting_printing_problems

[[User:Ericb|Ericb]] 11:39, 3 June 2006 (CEST)

== What do we have to do ?==

* Implement direct access to Apple graphical engine, using Apple API : Quartz2D/CoreGraphics (and replacing Xlib use )

like : instantiate, manage events and threads for a graphical instance + all needed objects, drawing : manage all drawing cases

* Implement native events management, using CarbonEventManager ( replacing Xlib management)

* Implement native font use, using Apple Type Server and ATSUI ( for Unicode Imagery) (replacing X11 management )

Work in progress : http://wiki.services.openoffice.org/wiki/Fonts_starting_point_and_documentation

* Implement native sound, using QuickTime (replacing Java Media Framework )

[[Native Sound Implementation on Mac OS X]]
(page under construction)

* Implement native Drag and drop, Implementing Pasteboard Manager

[[Native Drag and drop implementation on Mac OS X]] (page under construction)

* Implement Native Filepicker

* Implement Native Printing : current uses cups, but native printing is mandatory

[[Native Printing implementation on Mac OS X]] (page under construction)

* Implement Apple Spellchecker

=='''Where is the code located to be modified ?'''==

Most of the changes are located in vcl ( Visual Class Layer ), for everything graphical, events, fonts, rendering and printing.

Other, for sound and movies will be in avmedia ( where the player is implemented in OpenOffice.org sources).

For drag and drop, dtrans is concerned ( Pasteboard Manager implementation )

[FIXME] : Filepicker ? Apple Spellchecker ?

[[User:Ericb|Ericb]] 11:39, 3 June 2006 (CEST)

=='''How will the new implementation be tested ?==

Currently, all openOffice.org code can be compiled without using the Xlib. but of course, a lot of features are missing,

and the final package simply won't work

In vcl module", a '''toy''' called svdem is built at buildtime. This binary is linked to libvcl* and so all new stuff can be tested.

e.g. : draw anti-aliased lines works well.

Everything implemented in aqua vcl code will be included in libvclplug_aqua, and svdem source code will contain a specific part to proceed tests.

<div class="messagebox cleanup metadata" style="border:1px solid blue;background-color:#B3FFF5;padding:7px;">

'''The magic is : when all needed features will work with svdem, it will work in the new version of OpenOffice.org !!'''

</div>

[FIXME] : add more complete list of features to implement and test.

== '''Sort out documentation about VCL around Native Mac OS X port''' ==

Do we really need to understand how it works ? ;-)

vcl content :

ls -laR | wc -l
1750

-> Uff 1750 files to analyse :-/

Our purpose is to describe the vcl organisation. The content of vcl is so important, that at the begining, the content will looks a bit confused. e.g. class names ..etc have nothing to do, only description with words and sense, but this will need some time before we can understand everything.

How analyse with more efficiency ? After some months to anlalyse '''"horizontaly"''', it appears that list all the content of a directory is not the solution. Of course, we learned a lot, but we now have to complete with '''"orthogonal"''' method (compared to the previous one). The first method wasn't obviously not the good/best way to describe vcl.

[FIXME] a different approach (will ask confirmation to Philipp Lohman), could be a description of how it work in runtime. First define what an instance is, a frame, and what exactly is concerned by such "objects".

With that, we can write a list of different objects all using the same scheme : empty boxes (means pure virtual methods and classes in generic libvvcl), really implemented in the specific part, and finally, the API "encapsulated".

The most difficult is to see where the API is used. But for all the parts, this is the same.

Finally, '''what is important is the design of vcl'''. Which '''patterns''' are used ? What are the dependencies, how works the stack for the events, how works the scheduler, the timers too is very important, even fundamental for Aqua implementation. Will have a look at gsl mailing list, and other resources. Probably everything is already (randomly) written somewhere.

=== VCL organisation ===

Thank's to Philipp Lohmann for this short, but precise description :

Basically vcl is divided in the system dependent and the system independent part. The interface between these two is mostly the Sal interface (every interface name Sal*: SalInstance, SalFrame, SalGraphics, SalPrinter, etc.).

SalInstance is a factory that can create all the other abstracted interfaces of the system dependent part. It also provides the main loop SalInstance::Yield()

SalFrame abstracts any kind of system window.

SalVirtualDevice abstracts an offscreen window (e.g. a Pixmap on X11)

SalPrinter and SalInfoPrinter abstract the system print queues where SalInfoPrinter is for querying and SalPrinter for actual printing.

SalGraphics is an interface produced by either SalFrame, SalVirtualDevice or SalPrinter which is used for actual drawing operations (text, bitmaps, vector graphics)

SalSound is for sound playing.

SalBitmap provides memory for bitmap graphics as well as methods converting this memory to a system handle (e.g. a Pixmap on X11).

SalOpenGL provides OpenGL functionality if available.

SalTimer is an interface for periodically triggering the event queue (to timer implementation).

SalI18NImeStatus handles how the status window of an Input Method Editor (IME) should display (this is mainly X11 specific).

SalSystem has some system specific methods that did not belong anywhere else :-)

Of all these there interfaces is at least one implementation per system (Windows, X11 or Mac). The Unix implementation also has a plugin concept to allow for integration of different native toolkits (currently gtk and Qt) which became necessary for the implementation of Native Widget Framework (NWF) to display controls like their normal desktop counterparts.

Basically the independent part (what is beneath vcl/source directory) has generic methods for drawing, window handling and stuff which it brings into a suitable form and then delegates to the system specific implementaion (located beneath vcl/win for Windows and vcl/unx for the X11 platforms).

[[User:Ericb|Ericb]] 16:12, 1 July 2006 (CEST)

===Sub-directories description ===

==== '''Organisation of vcl directories''' ====

[[Image:aquavcl_organisation_complete_02.jpg]]

==== '''Directories in vcl. Short description''' ====

''' aqua ''' : The name Aqua means Apple look and feel, and is well known as [http://developer.apple.com/documentation/UserExperience/Conceptual/OSXHIGuidelines/XHIGIntro/chapter_1_section_1.html Aqua Human Interface Guidelines]. This look and feel means Mac OS X. The work was begun by (probably) P. luby, Dan Williams Herbert Duerr (most of fonts stuff) and Ed Peterlin. Currently in ruin, this directory does contain a lot of ideas to investigate. The most important part of needed changes for native version (3.0) will be done inside aqua dir inc : does contain all vcl relative includes [PART1]

''' prj ''' : Does contain build.lst and d.lst build.lst give us dependencies : probably a lot for vcl, build 98th module over ~148. Everything graphical depends in vcl.

''' qa ''' does contain all quality assurancy stuff

'''source''' : the most important :-) This directory contains common sources for all architectures and OS. Mainly : Windows, Unix : Linux , Mac OS X (X11), Solaris, including generic, kde and gtk plugins, and Aqua ( Mac OS X without X11, work currently in progress).

Depending on the OS and the architecture, binaries are built or not.

''' test ''' : This directory does contain all the needed stuff for tests. As example, in qa/testdocuments, you'll find three documents (one writer, one calc and one impress) for tests purpose.
Other available tests are about memcheck and persistent window state.

''' unx ''' : this directory does contain all unixes stuff. We have to understand what is inside to implement aqua port. For example, a lot of classes/strutures and objects use Xlib calls we have to replace with Carbon/Cocoa call (at least at first time) for Mac OS X native port.

''' win ''' : Doing Mac OS X native port, I first believed this directory was not interesting for us, but I was wrong : OpenOffice.org roots are inside this directory, and a lot of comments and resources are inside. Mainly interesting if Carbon is used.

'''workben''' : Does contain a toy called "svdem". svdem is a binary, used for new implementations. For example, actual aqua development uses svdem intensively, to verify all important properties we need :

- display a window first ( al least ... :) )

- close cleanly this window

- display a point

- trace a line

- trace an area

- superpose two areas doing some important graphical operations, (like xor),

- display a character

- display a menu.

- intercept events correctly.

[FIXME] add more tests

[[User:Ericb|Ericb]] 13:21, 3 June 2006 (CEST)

==Naming convention ==

* Class names start with upper case letters, to improve readability.

* Implemented Class names are derived from the virtual classes but can of course take arbitrary names.
To increase readability, it's recommended to closely follow the base class name.

* '''Impl prefix : means Implementation details'''. The concerned class or method or function is not used outside of this module, so no external code (or other libraries) can see it.

'''[[ Events types using Carbon API (Mac OS X) : ]]''' A lot of events have to be managed in runtime. Here is a short description

- do not freeze because bad event loops

- event types implementation : currently, they are defined in vcl/aqua/inc/aquavclevents.hxx

Apart : exact sense of hedabu ? -> [FIXME] looks like a hash list of available includes is build while products are delivered in every module... not sure

== '''What do we have to build in vcl ?'''==

Two libraries, corresponding ressources (localized) and a toy so called « svdem »

'''Common part''' :

in grey on right. The result will be a non architecture dependant library, built in all cases : for instance, libvcl680mxi.dylib on Mac Intel.

'''Specific part " a plugin " ''' :

Light yellow : aqua part will only concern Mac OS X (non X11) the name will probably be libvcl_aqua680mxi.dylib

As you can see, win means windows part, in blue

For Unix build ( Linux, Solaris or current Mac OS X X11), in purple.

Result will be :

libvclplug_PLUGIN680mxi.DLLSUFFIX , where PLUGIN can be iether gen (generic) or gtk (using gtk+ ) or kde (using qt), and DLLSUFFIX can be either .so (linux) or .dylib (Mac OS X) ...etc (I'm not sure for other cases).

Example : libvcl680mxi.dylib and libvclplug_aqua680mxi.dylib

'''In runtime''', libvclplug_aqua will be linked to libvcl680. the first one will contain the real implementation ( respecting the API, e.g. Carbon ) while the generic libvcl will only contain pure virtual methods ...etc like "empty boxes".

=== Current Aqua content ===

A more complete description of aqua (Mac OS X / no X11 specific ) : [[Image:Vcl_aqua_organisation_02_tree.jpg]]

==EXISTING objects to build in aqua==

===Sal APP "everything application"===

[FIXME] add all objects descriptions

==== saldata ====

* '''Defined in plugin exclusively''' (i.e. for headers)

Unix : unx/source/app/saldata.cxx (header in unx/inc )

'''Aqua : aqua/source/app/saldata.cxx (header in win/inc )'''

Windows : win/source/app/saldata.cxx (header in aqua/inc )

* Role : saldata contains various kind of data used by the implementation for the concerned platform. '''It is a bunch of global data collections reserved for the platform'''

It is just completely platform dependent, and nobody except this plugin can see it.

'''Saldata is something like a "second sal", but providing an abstraction regarding windowing and graphics''', while SAL module provides an abstraction more Operating System oriented )

e.g. : have a look at XRequest array in vcl/unx/source/app/saldata.cxx => all calls are for Xlib (X11). Ok, useless there, but interesting :-)

[FIXME] : use Windows implementation could be a good starting point. Nothing is the same, but the current aquavcl cws uses similar objects, and it works very correctly.

saldatax.cxx uses classes SalInstance, SalObject, SalFrame, SalVirtualDevice, SalPrinter and fontList.

Current list of possible objects who can be instantiated/released :

structure SalData : does contain pointers on all kind of objects from other classes used in saldata.

inline functions : [FIXME] : complete the description

- SetSalData :
- GetSalData :
- GetAppSalData :

==== salinst ====

=> implemented in vcl/aqua/source/app/salinst.cxx

Role:

* get environment, mutexes, instantiate AquaSalInstance (Ctor, Dtor ),

* instantiates/releases a lot of other objects using Get( ) / CreateObject() / DestroyObject() methods.

Current list of possible objects who can be instantiated/released :

* VirtualDevice [FIXME] : exact role ?

*Printer

- GetDefaultPrinter/ CreatePrinter() / DestroyPrinter - what a name ;-) -

- InfoPrinter ( Get/Create/Delete )

- PrinterQueue ( DeletePrinterQueueInfo / GetPrinterQueueInfo / GetPrinterQueueState )

* System ( Create / Delete ) [FIXME] : what means system here ?

* Events :

AquaSalInstance::SetEventCallback( )

AquaSalInstance::SetErrorEvenCallback( )

AquaSalInstance::GetConnectionIdentifier( )

* Menu / MenuItem :

AquaSalInstance::CreateMenu( ) / same for DestroyMenu( )

AquaSalInstance::CreateMenuItem / same DestroyMenuItem( )

* Sound :

AquaSalInstance::CreateSalSound( ) => object to a pointer of SalSound type

Note : AquaSalInstance::DestroySalSound is not implemented (? )

* Timer : CreateTimer( ) /

AquaSalInstance:: DestroyTimer( ) is not yet implemented ( ? )

Class MacImeStatus : inherits of SalI18NImeStatus

-> only there to see if there is a window to toggle into menubar [FIXME] ??

AquaSalInstance::CreateI18NImeStatus( ) : instantiates MacImeStatus

'''For futher informations, see: ''' '''[[Content of salinst.cxx]]'''

( [[User:Ericb|Ericb]] 16:11, 20 May 2006 (CEST) )

==== salmain ====

Role : if possible, runs the standard vcl application code SVMain( )

( [[User:Ericb|Ericb]] 16:15, 20 May 2006 (CEST) )

==== salsound ====

==== salsys ====

==== saltimer ====

=== Sal GDI ( everything Graphical Display Interface ) ===

==== salatslayout ====

==== salatsuiutils ====

==== salfontutils ====

==== salmathutils ====

==== sal bmp ====

==== salvd ====

==== salframe ====

==== salpixmaputils====

==== salprn ====

====salrectangle====

==== salvd ====

=== Sal Window===

==== salframe ====

====salobj====

== TO BE IMPLEMENTED (missing in Aqua)==

===Audio===

====audioconvert====
(obsolete ?)

====devaudio====
(obsolete ? )

====native sound====

====salimpsound====

====vsound====

===i18n===

===keysymnames===

===saldisp===

===sm===

[FIXME]: is session manager usefull ?

== What is used for Linux, Windows, Mac OS X ...build ? ==

'''[[Description of the dependencies]]'''

'''[[Windows]]'''

'''[[MacOS X]]'''

'''[[Linux]]'''

'''[[Solaris]]'''

== Content of Aqua ==

'''[[Click here to see the complete list]]'''

'''Content of vcl/inc'''

Notes :

1) Where to find includes

<foo/bar.hxx> means you can find bar.hxx in the foo module. The new style file is foo/inc/foo/bar.hxx, old style is foo/inc/bar.hxx and sometimes the file is somewhere else in the tree or generated. The deliver process copies/generates the file into solver at solver/680/build_type/inc/foo. Good for fixing broken builds. ;-)

2)
suffix .h (for C calls or first version ?) or .hxx (C++ )

'''A) Family of includes''' :

Looking more closely at the list brings to the fore (expression from dictionary ;-) ) that include names are
informatives. Most of the time, the name gives the function/role.
What is interesting is the files with name begining with "sal". sal means System Abstraction Layer + include's function (or explicit name).

Partial list, for example :

salatype.hxx

salbmp.hxx

salctrlhandle.hxx

salctype.hxx

salframe.hxx

salgdi.hxx

salgeom.hxx

sallayout.hxx ( main header for fonts services )
...
salmenu
salnativewidgets
...etc

Other important families are "sv" and "uno" or "win" (window) prefixed. sal family will be analysed apart.

'''B) Includes of includes'''

Some includes are more important than other. To prove this, just have a look is sufficient : some are always needed, and some more rarely.

To verify, a simple test to do in vcl/inc :

egrep -H "#include" ./* | wc -l gives me 681 lines ! And some of them are the same...

To know more, the precedent command line can be modified to make appear the numerous call
to the same includes files.

egrep -H "#include" ./* | cut -d"#" -f2 | sort > liste.txt

The content of liste.txt is explicit : dllapi.h, sv.h and some other are very important, while some other includes are only one or two times used. We can see too that vos includes are numerous, even if vos is deprecated**

**see http://wiki.services.openoffice.org/wiki/Source_code_directories

I'm nearly sure that a complete analysis of just this result will give us a lot of information.

I propose to change the order of analysis starting with dllapi.h and sv.h.

[to be continued]

'''B1) "sal" includes family'''

[[salinst.hxx]] This seems to be the main include file

[[salatype.hxx]]

[[salctrlhandle.hxx]]

[[salctype.hxx]]

[[salframe.hxx]]

[[salgdi.hxx]]

[[salgeom.hxx]]

'''[[ sallayout.hxx ]]''' <-- see Native Fonts implementation

[[salgtype.hxx]]

[[vcl/inc/salobj.hxx]]

'''B2) Classicals includes'''

file : abstdlg.hxx [ means abstract dialog ]

This includes does contain the following classes definitions:

[FIXME] : choose a precise presentation template for classes

VclAbstractDialog,

VclAbstractTerminateDialog,

VclAbstractRefreshableDialog,

VclAbstractDialogFactory,

uses <tools/solar.h> , <tools/string.hxx> +

"dllapi.h"

Note : dllapi.h is very interesting because when we have to find (for example) a library suffix, SAL_DLLEXTENSSION can replace all suffixes (every OS's and archs). Just including sal/config.h does it !

Classes :

Window -> what ? [FIXME]
ResId -> what ?

Does contain the prototype of VclAbstractDialog, inherit of VCL_DLLPUBLIC

file : dllapi.h [ dll for dynamic linked library ]
Uses : <sal/config.h> and >sal/types/h>
includes : VCL_DLLPUBLIC macro

file : accel.h [ means accelerator ]

Classes :

Accelerator
{
}
ImplAccelEntry
{
public members :

Names

mnId
maKeyCode
mpAccel
mpAutoAccel
mbEnabled
}

function / returns / parameters

ImplGetKeyCode / void / KeyFuncType eFunc, ref rCode1 , ref rCode2, ref rCode3

file : accel.hxx

Uses : <sv.h> , "dllapi.h" ,<tools/resid.hxx>, <<tools/rc.hxx>

Classes:

ImplAccelData;
ImplAccelEntry;

== Important Links ==

'''[[Progressive implementation]]'''

'''Native Font server Implementation''' '''[[Fonts starting point and documentation]]'''

'''Native Sound Implementation''' : http://wiki.services.openoffice.org/wiki/Native_Sound_Implementation_on_Mac_OS_X

'''Native Printing Implementation''' : http://wiki.services.openoffice.org/wiki/Native_Printing_implementation_on_Mac_OS_X

'''Drag and Drop implementation''' : http://wiki.services.openoffice.org/wiki/Native_Drag_and_drop_implementation_on_Mac_OS_X

This work is part of http://wiki.services.openoffice.org/wiki/Mac_OS_X_Porting_-_Work_Areas/Todo%27s

'''Wish list for Mac OS X port''' : [[Mac OS X port : wish list]]

[to be continued :-) ]

--[[User:Ericb|Ericb]] 15:00, 22 Jul 2005 (EDT)

[[Category:Porting]]

Mac OS X Porting - Work Areas/Todo's

2006-06-16T20:02:51Z

Ssa: /* Areas and ToDo's Aqua Version */

This page is intended to serve as a living ToDo's list for the OpenOffice.org Mac OS X port. To keep things simple it contains the ToDo's for both the X11 version and the upcoming Aqua version of OpenOffice.org for Mac OS X. The page is divided into different work areas which either assigned to a person in charge or are unassigned yet. Below each area there is a detailed list of todo's which has to be maintained by the respective people himself.
Persons who are in charge of a certain area are responsible for keeping their respective part of the page up-to-date.

If you're interested in contributing to the project please coordinate with Eric Bachard [mailto:ericb@openoffice.org]

== Areas and ToDo's X11 Version ==

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Packaging Packaging related tasks || Oliver Braun [mailto:obr@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Improved packaging for OOo || Done || Oliver Braun
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Installation Installation related tasks || Oliver Braun [mailto:obr@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Provide an improved installer for OOo || New || Oliver Braun
|-
| Error messages during installation when no X11 is installed || New || Unassigned
|-
| Support language pack instalation || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Desktop Integration Desktop integration related tasks || Oliver Braun [mailto:obr@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Save documents in ~/Documents by default || New || Unassigned
|-
| Use the Mac OS X key chain for document signing || New || Unassigned
|-
| Read proxy settings and user information from the system settings || New || Unassigned
|-
| Mac OS X address book integration || New || Unassigned
|-
| Make use of the Mac OS X spell checker || New || Unassigned
|-
| Improved clipboard support || New || Unassigned
|-
| Support for standard Mac OS X shortcuts according to HI guideline || New || Unassigned
|-
| Integrate native FileOpen/FileSave dialog into OOo || Started || Florian Heckl [mailto:fheckl@openoffice.org]
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Printing || Unassigned [mailto: Name [??@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Improved printing support (CUPS) || Done || Mox Soini, Oliver Braun
|-
| Use the native print dialog in OOo || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Native sound support || Eric Bachard [mailto: Name [mailto:ericb@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement native sound support || Started || Eric Bachard
|}
Todo list :
- create manager ( using UNO services) [ done ]
- create uno layer [ done ]
- implement correct service name / implementation name using UNO [ work in progress ]
- create player (using QuickTime API) [ work in progress ]
Done (using existing Windows implementation) :
- all headers are defined
- usefull functions are identifed in Apple's API

Other work in progress :
- discuss with ka about new implementation and fix dark points
- reuse Windows immlementation for the player
- new implementation of -already defined- methods used in the player

Estimation of code remaining to write : 40%

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Ease of use || Unassigned [mailto: Name [??@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Reduce visible toolbars || New || Unassgined
|-
| Suppress icons in OOo menus by default || New || Unassigned
|-
| Suppress xterm window when launching OOo || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Implement NeoLight plugin || Unassigned [mailto: Name [??@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement NeoLight (spothlight plugin) in OpenOffice.org 2.0. For more informations, please have a look at [http://trinity.neooffice.org/modules.php?name=Forums&file=viewtopic&t=1328&sid=9fb65afa5ca4232a6f8fae420424a3fe]|| New || Unassigned
|}

 

== Areas and ToDo's Aqua Version ==

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Messaging || Tino Rachui [mailto: [tra@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement messaging infrastructure || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Windowing || Tino Rachui [mailto: [tra@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement salframe.cxx || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Drawing || [mailto:ssa@openoffice.org Stephan Schaefer]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement drawing support || In progress || [mailto:ssa@openoffice.org Stephan Schaefer]
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Key input || Unassigned [mailto: [???@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| ??? || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Native font support ||Eric Bachard [mailto:ericb@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| ATS || Started || Eric Bachard
|}

[FIXED] : where are the original headers. License ? see : http://qa.openoffice.org/issues/show_bug.cgi?id=23283]

Todo-list for native font implementation :

Missing :
- verify if PolyArgs class didn't chang to much, since basegfx ( e.g. ::basegfx::B2DPolyPolygonVector ) is used

- missing methods (to be implemented) :

ATSLayout::InitFont()
ATSLayout::MoveGlyph( )
ATSLayout::DropGlyph( )
ATSLayout::Simplify( )

- read Apple API [ Work in progress]
- describe current implementation : organisation / design [work in progress]
- test old implementation ( current does not build.
- provide a proof of concept
- testing : code sample
- design of new implementation [FIXME] find examples

Estimation of code remaining to write ~90 %

Roadmap

0.0
- understand current font implementation ( using old salatslayout.cxx ) ( work in progress : 40% done )
- analyse and describe Carbon binding in salatslayout.cxx [ 90% done]

0.1
- replace old SalGraphicsData object implementation (found in pre-aquavcl01 files, and now obsolete, because we won't use QDraw anymore)
- define correct naming convention
- verify salatsfontutils.cxx definition does match with new salatslayout.cxx content

0.2
- rewrite complete salatslayout.cxx
- fix all compilations issues
- run it and fix instant crashs and verity there is no freeze

0.3
- use sample code to test/initialize ATS server ( using e.g. ATSUIDirectAccessDemo )
- verify this server can be initialized inside OpenOffice.org (needs a CFRunLoop working to be correctly initialized )

0.4
- adapt salatslayout.cxx to make it match with sallayout.hxx, and salgdi.hxx, saldata.hxx .etc
to make it build with aquavlcl01, and do some tests :

Todo : make current source code match with recent implementation ( 80% done )

For more informations, see : http://wiki.services.openoffice.org/wiki/Fonts_starting_point_and_documentation

[[Category:Porting]]

Mac OS X Porting - Work Areas/Todo's

2006-06-16T19:54:49Z

Ssa: /* Areas and ToDo's Aqua Version */

This page is intended to serve as a living ToDo's list for the OpenOffice.org Mac OS X port. To keep things simple it contains the ToDo's for both the X11 version and the upcoming Aqua version of OpenOffice.org for Mac OS X. The page is divided into different work areas which either assigned to a person in charge or are unassigned yet. Below each area there is a detailed list of todo's which has to be maintained by the respective people himself.
Persons who are in charge of a certain area are responsible for keeping their respective part of the page up-to-date.

If you're interested in contributing to the project please coordinate with Eric Bachard [mailto:ericb@openoffice.org]

== Areas and ToDo's X11 Version ==

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Packaging Packaging related tasks || Oliver Braun [mailto:obr@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Improved packaging for OOo || Done || Oliver Braun
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Installation Installation related tasks || Oliver Braun [mailto:obr@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Provide an improved installer for OOo || New || Oliver Braun
|-
| Error messages during installation when no X11 is installed || New || Unassigned
|-
| Support language pack instalation || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Desktop Integration Desktop integration related tasks || Oliver Braun [mailto:obr@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Save documents in ~/Documents by default || New || Unassigned
|-
| Use the Mac OS X key chain for document signing || New || Unassigned
|-
| Read proxy settings and user information from the system settings || New || Unassigned
|-
| Mac OS X address book integration || New || Unassigned
|-
| Make use of the Mac OS X spell checker || New || Unassigned
|-
| Improved clipboard support || New || Unassigned
|-
| Support for standard Mac OS X shortcuts according to HI guideline || New || Unassigned
|-
| Integrate native FileOpen/FileSave dialog into OOo || Started || Florian Heckl [mailto:fheckl@openoffice.org]
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Printing || Unassigned [mailto: Name [??@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Improved printing support (CUPS) || Done || Mox Soini, Oliver Braun
|-
| Use the native print dialog in OOo || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Native sound support || Eric Bachard [mailto: Name [mailto:ericb@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement native sound support || Started || Eric Bachard
|}
Todo list :
- create manager ( using UNO services) [ done ]
- create uno layer [ done ]
- implement correct service name / implementation name using UNO [ work in progress ]
- create player (using QuickTime API) [ work in progress ]
Done (using existing Windows implementation) :
- all headers are defined
- usefull functions are identifed in Apple's API

Other work in progress :
- discuss with ka about new implementation and fix dark points
- reuse Windows immlementation for the player
- new implementation of -already defined- methods used in the player

Estimation of code remaining to write : 40%

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Ease of use || Unassigned [mailto: Name [??@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Reduce visible toolbars || New || Unassgined
|-
| Suppress icons in OOo menus by default || New || Unassigned
|-
| Suppress xterm window when launching OOo || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Implement NeoLight plugin || Unassigned [mailto: Name [??@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement NeoLight (spothlight plugin) in OpenOffice.org 2.0. For more informations, please have a look at [http://trinity.neooffice.org/modules.php?name=Forums&file=viewtopic&t=1328&sid=9fb65afa5ca4232a6f8fae420424a3fe]|| New || Unassigned
|}

 

== Areas and ToDo's Aqua Version ==

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Messaging || Tino Rachui [mailto: [tra@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement messaging infrastructure || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Windowing || Tino Rachui [mailto: [tra@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement salframe.cxx || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Drawing || Stephan Schaefer [mailto: [ssa@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| Implement drawing support || In progress || Stephan Schaefer
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Key input || Unassigned [mailto: [???@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| ??? || New || Unassigned
|}

 

{| style="vertical-align:top; text-align:left; background-color:#F0F0F0;"
|- style="background-color:#99CCFF; font-weight:bold;"
| Native font support ||Eric Bachard [mailto:ericb@openoffice.org]
|}

{| style="vertical-align:top; text-align:left; background-color:#efefef;"
|- style="background-color:#d6d6d6;font-weight:bold;"
| Todo || Status || Assigned to
|-
| ATS || Started || Eric Bachard
|}

[FIXED] : where are the original headers. License ? see : http://qa.openoffice.org/issues/show_bug.cgi?id=23283]

Todo-list for native font implementation :

Missing :
- verify if PolyArgs class didn't chang to much, since basegfx ( e.g. ::basegfx::B2DPolyPolygonVector ) is used

- missing methods (to be implemented) :

ATSLayout::InitFont()
ATSLayout::MoveGlyph( )
ATSLayout::DropGlyph( )
ATSLayout::Simplify( )

- read Apple API [ Work in progress]
- describe current implementation : organisation / design [work in progress]
- test old implementation ( current does not build.
- provide a proof of concept
- testing : code sample
- design of new implementation [FIXME] find examples

Estimation of code remaining to write ~90 %

Roadmap

0.0
- understand current font implementation ( using old salatslayout.cxx ) ( work in progress : 40% done )
- analyse and describe Carbon binding in salatslayout.cxx [ 90% done]

0.1
- replace old SalGraphicsData object implementation (found in pre-aquavcl01 files, and now obsolete, because we won't use QDraw anymore)
- define correct naming convention
- verify salatsfontutils.cxx definition does match with new salatslayout.cxx content

0.2
- rewrite complete salatslayout.cxx
- fix all compilations issues
- run it and fix instant crashs and verity there is no freeze

0.3
- use sample code to test/initialize ATS server ( using e.g. ATSUIDirectAccessDemo )
- verify this server can be initialized inside OpenOffice.org (needs a CFRunLoop working to be correctly initialized )

0.4
- adapt salatslayout.cxx to make it match with sallayout.hxx, and salgdi.hxx, saldata.hxx .etc
to make it build with aquavlcl01, and do some tests :

Todo : make current source code match with recent implementation ( 80% done )

For more informations, see : http://wiki.services.openoffice.org/wiki/Fonts_starting_point_and_documentation

[[Category:Porting]]