Dev:Building On Mac OS X

Category:Building

There is currently no up-to-date build of Synfig for Mac OS X.

Build environment

Since these instructions assume one is using MacPorts, make sure the following environment variables are set accordingly:

export PATH="/opt/local/bin:$PATH"
export ACLOCAL_FLAGS="-I /opt/local/share/aclocal"
export PKG_CONFIG_PATH="/opt/local/lib/pkgconfig"

There seem to be two ways of building GTK applications for OS X:

Using the native GTK port

In order to build Synfig natively on Mac OS X using the native GTK port (as opposed to using X11), you will require the following:

• Mac OS X developer tools (i.e. XCode)
• git ("git-core" port on macports)
• subversion ("subversion" port on macports)
• jhbuild
• libxml++
• Imendio's GTK port's ".jhbuildrc" file
• Subversion checkout of "etl", "synfig-core", and "synfig-studio"

Boot strapping

First of all make sure you have a Terminal window open. This will be used in order to perform all the steps necessary to compile synfig.

You might also want to compile as a different user, as one tool used, "jhbuild", requires files to be placed in the current user's home directory. This can be done by typing the following into the terminal:

su <other username>
<type in other username's password>

I shall assume you only have XCode and MacPorts installed. In order to get subversion and git, you should be able to type the following into the terminal:

sudo port install git-core
sudo port install subversion

Assuming MacPorts installed subversion and git correctly, you'll now need to grab and compile a copy of jhbuild from the gnome repository, which can be done like so:

svn co http://svn.gnome.org/svn/jhbuild/trunk jhbuild
cd jhbuild && make -f Makefile.plain install

You will also need the .jhbuildrc file from Imendio. It is also a good idea to ensure your PATH contains your "~/bin" directory and "/opt/gtk/bin", the latter being important when you start to build everything else. Finally, make sure that "/opt/gtk/" exists and is owned by your build user:

curl http://developer.imendio.com/svn/gtk-osx-build/jhbuildrc-gtk-osx > ~/.jhbuildrc
export PATH="/opt/gtk/bin:~/bin:$PATH"
sudo mkdir -p /opt/gtk && sudo chown <username>:<username> /opt/gtk

Note: The jhbuildrc file may have been moved. If the above location fails, try:

curl http://people.imendio.com/richard/gtk-osx-build/jhbuildrc-gtk-osx > ~/.jhbuildrc

Now you can type in the following to build the bootstrap environment:

jhbuild bootstrap

Compiling GTK and other dependencies

Assuming jhbuild has finished building all of the bootstrap lib's and such, you will not have to tell it to build "gtkmm", which is the C++ interface to GTK.

jhbuild build gtkmm

Note(SS): You may get an error asking for gtk-doc:

You must have gtk-doc installed to compile GLib.

If you do, stop the build and install gtk-doc with:

jhbuild build gtk-doc

Then, re-issue the build command:

jhbuild build gtkmm

This will also build GTK and all of its dependencies. However it falls short of providing another dependency which Synfig requires, which is libxml++. This can be grabbed and built as follows:

curl -L http://ftp.gnome.org/pub/GNOME/sources/libxml++/2.19/libxml++-2.19.2.tar.gz > libxml++-2.19.2.tar.gz
tar -xzf libxml++-2.19.2.tar.gz
cd libxml++-2.19.2 && ./configure --prefix=/opt/gtk && make && sudo make install

Optionally you might also want to grab and build OpenEXR. This should of course be a simple configure, make, make install job like libxml++.

Synfig itself

You should now be able to follow the Build instructions to compile ETL, synfig-core, and synfig-studio. The only thing different you should do is add "--prefix=/opt/gtk --exec-prefix=/opt/gtk" to the "./configure" options when building each package.

Assuming you manage to build it correctly, you should now be able to type the following in order for Synfig to pop up on your desktop:

synfigstudio

Note though that this isn't the end of the story: we still need to package everything up into an .app so that the more sane of us can run Synfig without having to resort to opening a terminal.

TODO: Describe how to properly package everything into an .app.

Issues

There are currently numerous issues with Synfig with Imendio's GTK port. Watch out for:

• Window focus can sometimes be lost. If this happens, just select a window from another Mac OS X app and then select the Synfig window again.
• Menus do not function correctly.
• The file browser doesn't work, so you have to load files from startup.
• Sometimes mouse focus on windows is lost. To solve this, try moving the affected window. Failing that, you should still be able to use the keyboard to navigate.
• No input devices are enumerated by GTK.
• XCode project files exist, but they are currently broken. Thus we just use the terminal to compile everything.
• Because we made the prefix "/opt/gtk", synfig will go looking for interface images there, which obviously won't quite work right if we want to package everything into an .app.

Using X11

In order to compile synfig for X11, you will need to install gtkmm and libxml++ via MacPorts (or Fink). This can be done as follows:

sudo port install gtkmm libxmlxx2

This will also install all the other dependencies (such as X11), so it make take some time to compile.

You need to set PKG_CONFIG_PATH so that the ETL and synfig-core header files and libraries can be found:

export PKG_CONFIG_PATH=/opt/local/lib/pkgconfig

For some unknown reason compiling ETL, synfig-core and synfig-studio doesn't work properly when using MacPorts auto* tools. However, it does work with the bootstrap toolset used to compile Imendio's native GTK port. So it is suggested that you follow the Boot strapping section up to and including the 'jhbuild bootstrap' line and make sure "/opt/gtk/bin" is first in your $PATH in order to properly compile etl, synfig-core and synfig-studio.

You should now be able to follow the Build instructions to compile ETL, synfig-core, and synfig-studio. The only thing different you should do is add "--prefix=/opt/local --exec-prefix=/opt/local" to the "./configure" options when building each package.

Assuming you manage to build it correctly, you should now be able to type the following in order for Synfig to pop up on your desktop:

synfigstudio

Note though that this isn't the end of the story: we still need to package everything up into an .app so that the more sane of us can run Synfig without having to resort to opening a terminal.

TODO: Describe how to properly package everything into an .app.

Troubleshooting

no "awk"

If you get an error during building MacPorts ports complaining that a program called "awk" cannot be found, then you should install the 'gawk' port like so:

sudo port install gawk

"no command found" when running jhbuild

When using jhbuild, you might get an error back like this:

$ jhbuild glibmm
jhbuild glibmm: no command found

This is because you need to specify the "build" command when building a package, like so:

jhbuild build glibmm

problem building "doxygen" via jhbuild

When building doxygen, you may get an error during the build process mentioning "lipo" failed to find a file. To fix this, you should go into the shell (option 4) when prompted, and enter the following:

./configure --prefix /opt/gtk --platform macosx-c++ --install /usr/bin/install
make && exit

Then when prompted again, choose "ignore error and continue to build" (option 2).

problems with external libraries

If your build doesn't find external graphics libraries (such as libpng), but you know they're installed, you may need to set some additional environment variables, like so:

export CPPFLAGS=-I/opt/local/include
export LDFLAGS=-L/opt/local/lib

If you're using native GTK+, change "/opt/local" to "/opt/gtk".

other problems building via jhbuild

Solving other issues with building packages in jhbuild is beyond the scope of this document as all of the packages are still under development by their respective authors.