Porting to Mac/gtk-mac-bundler - Revision history

Jpye: moved Porting to Mac/ige-mac-bundler to Porting to Mac/gtk-mac-bundler: upstream tool has been renamed

2012-07-05T17:28:55Z

moved Porting to Mac/ige-mac-bundler to Porting to Mac/gtk-mac-bundler: upstream tool has been renamed

← Older revision		Revision as of 17:28, 5 July 2012
(No difference)

Jpye at 16:34, 5 July 2012

2012-07-05T16:34:27Z

← Older revision		Revision as of 16:34, 5 July 2012
Line 1:		Line 1:
	[[Porting_to_Mac\|← Porting to Mac]]		[[Porting_to_Mac\|← Porting to Mac]]

	This page contains some notes on how [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler] (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview\|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.		This page contains some notes on how [https://live.gnome.org/GTK%2B/OSX/Bundling gtk-mac-bundler] (formerly called [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler]) (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview\|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.

	The following observations come from bundling up GtkDemo using ige-mac-bundler.		The following observations come from bundling up GtkDemo using ige-mac-bundler.

Jpye at 05:05, 2 November 2010

2010-11-02T05:05:23Z

← Older revision		Revision as of 05:05, 2 November 2010
Line 2:		Line 2:

	This page contains some notes on how [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler] (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview\|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.		This page contains some notes on how [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler] (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview\|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.


	The following observations come from bundling up GtkDemo using ige-mac-bundler.		The following observations come from bundling up GtkDemo using ige-mac-bundler.
Line 37:		Line 36:

	This contents of <tt>gdk-pixbuf.loaders</tt> are automatically edited by <tt>ige-mac-bundler</tt> to replace the absolute file paths with paths like <tt>@executable_path/../Resources/lib/gtk-2.0/loaders/libpixbufloader-png.so</tt>, etc.		This contents of <tt>gdk-pixbuf.loaders</tt> are automatically edited by <tt>ige-mac-bundler</tt> to replace the absolute file paths with paths like <tt>@executable_path/../Resources/lib/gtk-2.0/loaders/libpixbufloader-png.so</tt>, etc.


	The pixbuf loaders are copied into the locally-consistent location <tt>Contents/Resources/lib/gtk-2.0/2.xx.xx/loaders</tt>, where xx.xx is the particular GTK+ version being used.		The pixbuf loaders are copied into the locally-consistent location <tt>Contents/Resources/lib/gtk-2.0/2.xx.xx/loaders</tt>, where xx.xx is the particular GTK+ version being used.


	== Icons and themes ==		== Icons and themes ==
Line 78:		Line 75:

	Didn't see any sign of actual image or icon files anywhere... perhaps the default ones are embedded in the shared library somehow.		Didn't see any sign of actual image or icon files anywhere... perhaps the default ones are embedded in the shared library somehow.


	== Pango configuration files ==		== Pango configuration files ==
Line 91:		Line 87:

	The file <tt>pango.modules</tt> is present in the same directory, but is empty.		The file <tt>pango.modules</tt> is present in the same directory, but is empty.


	== GTK configuration files ==		== GTK configuration files ==
Line 104:		Line 99:

	In same directory, there is another empty file called <tt>gtk.immodules</tt>.		In same directory, there is another empty file called <tt>gtk.immodules</tt>.


	== Use of install_name_tool ==		== Use of install_name_tool ==
Line 111:		Line 105:

	'''Note''': for the case of PyGTK bundles, assuming Apple Python or MacPython are being used but not being included in the bundle, we can't pull this trick, because the @executable_path would then be outside the application bundle, and no help for locating GTK libraries. An alternative approach might be possible using @rpath set on the PyGTK shared libraries, and this needs to be tried out.		'''Note''': for the case of PyGTK bundles, assuming Apple Python or MacPython are being used but not being included in the bundle, we can't pull this trick, because the @executable_path would then be outside the application bundle, and no help for locating GTK libraries. An alternative approach might be possible using @rpath set on the PyGTK shared libraries, and this needs to be tried out.


	== Environment variables ==		== Environment variables ==

	The file <tt>Contents/MacOS/GtkDemo</tt> is the entry-point for the application (as directed by <tt>Info.plist</tt>) and is a shell-script that sets various required environment variables so that GTK can find all its stuff:		The file <tt>Contents/MacOS/GtkDemo</tt> is the entry-point for the application (as directed by <tt>Info.plist</tt>) and is a shell-script that sets various required environment variables so that GTK can find all its stuff:


	'''NOTE''': in the following, the "`pwd`/$0" causes problems if you invoke the <tt>ige-mac-bundler</tt>-bundled from the command line from any directory other than <tt>Contents/MacOS</tt>. I think that this is a bug.		'''NOTE''': in the following, the "`pwd`/$0" causes problems if you invoke the <tt>ige-mac-bundler</tt>-bundled from the command line from any directory other than <tt>Contents/MacOS</tt>. I think that this is a bug.

	<source lang="~~a4c~~">name="`basename $0`"		<source lang="sh">name="`basename $0`"
	tmp="`pwd`/$0"		tmp="`pwd`/$0"

Line 133:		Line 125:
	bundle_data="$bundle_res"/share		bundle_data="$bundle_res"/share
	bundle_etc="$bundle_res"/etc		bundle_etc="$bundle_res"/etc


	export DYLD_LIBRARY_PATH="$bundle_lib"		export DYLD_LIBRARY_PATH="$bundle_lib"
Line 153:		Line 144:
	Next the script does something with charset alias ('''FIXME''' what's this doing?):		Next the script does something with charset alias ('''FIXME''' what's this doing?):

	<source lang="~~a4c~~">if test -f "$bundle_lib/charset.alias"; then		<source lang="sh">if test -f "$bundle_lib/charset.alias"; then
	export CHARSETALIASDIR="$bundle_lib"		export CHARSETALIASDIR="$bundle_lib"

Line 162:		Line 153:
	Then, the script throws out some Mac-related command-line parameters that are useless to GTK:		Then, the script throws out some Mac-related command-line parameters that are useless to GTK:

	<source lang="~~a4c~~"># Strip out the argument added by the OS.		<source lang="sh"># Strip out the argument added by the OS.
	if [ x`echo "x$1" \| sed -e "s/^x-psn_.*//"` == x ]; then		if [ x`echo "x$1" \| sed -e "s/^x-psn_.*//"` == x ]; then

Line 170:		Line 161:
	Finally, the script launches the executable.		Finally, the script launches the executable.

	<source lang="~~a4c~~">$EXEC "$bundle_contents/MacOS/$name-bin" $* $EXTRA_ARGS</source>		<source lang="sh">$EXEC "$bundle_contents/MacOS/$name-bin" $* $EXTRA_ARGS</source>

	[[Category:Development]]		[[Category:Development]]

Jpye at 05:04, 2 November 2010

2010-11-02T05:04:33Z

← Older revision		Revision as of 05:04, 2 November 2010
Line 1:		Line 1:
	[[Porting_to_Mac\|&larr~~;&nbsp~~;Porting to Mac]]		[[Porting_to_Mac\|← Porting to Mac]]

	This page contains some notes on how [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler] (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview\|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.		This page contains some notes on how [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler] (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview\|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.
Line 99:		Line 99:
	<pre>		<pre>
	$ cat gtkrc		$ cat gtkrc
	gtk-icon-theme-name = ~~"~~Tango~~"~~		gtk-icon-theme-name = "Tango"
	gtk-enable-mnemonics = 0		gtk-enable-mnemonics = 0
	</pre>		</pre>
Line 120:		Line 120:
	'''NOTE''': in the following, the "`pwd`/$0" causes problems if you invoke the <tt>ige-mac-bundler</tt>-bundled from the command line from any directory other than <tt>Contents/MacOS</tt>. I think that this is a bug.		'''NOTE''': in the following, the "`pwd`/$0" causes problems if you invoke the <tt>ige-mac-bundler</tt>-bundled from the command line from any directory other than <tt>Contents/MacOS</tt>. I think that this is a bug.

	<source lang="a4c">name=~~"~~`basename $0`~~"~~		<source lang="a4c">name="`basename $0`"
	tmp=~~"~~`pwd`/$0~~"~~		tmp="`pwd`/$0"

	tmp=`dirname ~~"~~$tmp~~"~~`		tmp=`dirname "$tmp"`
	tmp=`dirname ~~"~~$tmp~~"~~`		tmp=`dirname "$tmp"`
	bundle=`dirname ~~"~~$tmp~~"~~`		bundle=`dirname "$tmp"`

	bundle_contents=~~"~~$bundle~~"~~/Contents		bundle_contents="$bundle"/Contents
	bundle_res=~~"~~$bundle_contents~~"~~/Resources		bundle_res="$bundle_contents"/Resources
	bundle_lib=~~"~~$bundle_res~~"~~/lib		bundle_lib="$bundle_res"/lib
	bundle_bin=~~"~~$bundle_res~~"~~/bin		bundle_bin="$bundle_res"/bin
	bundle_data=~~"~~$bundle_res~~"~~/share		bundle_data="$bundle_res"/share
	bundle_etc=~~"~~$bundle_res~~"~~/etc		bundle_etc="$bundle_res"/etc


	export DYLD_LIBRARY_PATH=~~"~~$bundle_lib~~"~~		export DYLD_LIBRARY_PATH="$bundle_lib"
	export XDG_CONFIG_DIRS=~~"~~$bundle_etc~~"~~/xdg		export XDG_CONFIG_DIRS="$bundle_etc"/xdg
	export XDG_DATA_DIRS=~~"~~$bundle_data~~"~~		export XDG_DATA_DIRS="$bundle_data"

	export GTK_DATA_PREFIX=~~"~~$bundle_res~~"~~		export GTK_DATA_PREFIX="$bundle_res"
	export GTK_EXE_PREFIX=~~"~~$bundle_res~~"~~		export GTK_EXE_PREFIX="$bundle_res"
	export GTK_PATH=~~"~~$bundle_res~~"~~		export GTK_PATH="$bundle_res"

	export GTK2_RC_FILES=~~"~~$bundle_etc/gtk-2.0/gtkrc~~"~~		export GTK2_RC_FILES="$bundle_etc/gtk-2.0/gtkrc"
	export GTK_IM_MODULE_FILE=~~"~~$bundle_etc/gtk-2.0/gtk.immodules~~"~~		export GTK_IM_MODULE_FILE="$bundle_etc/gtk-2.0/gtk.immodules"
	export GDK_PIXBUF_MODULE_FILE=~~"~~$bundle_etc/gtk-2.0/gdk-pixbuf.loaders~~"~~		export GDK_PIXBUF_MODULE_FILE="$bundle_etc/gtk-2.0/gdk-pixbuf.loaders"

	export PANGO_RC_FILE=~~"~~$bundle_etc/pango/pangorc~~"~~</source>		export PANGO_RC_FILE="$bundle_etc/pango/pangorc"</source>

	After the above, there is some locale-related stuff (see [http://github.com/jralls/ige-mac-bundler/blob/master/bundler/launcher.sh launcher.sh] for the details.		After the above, there is some locale-related stuff (see [http://github.com/jralls/ige-mac-bundler/blob/master/bundler/launcher.sh launcher.sh] for the details.
Line 153:		Line 153:
	Next the script does something with charset alias ('''FIXME''' what's this doing?):		Next the script does something with charset alias ('''FIXME''' what's this doing?):

	<source lang="a4c">if test -f ~~"~~$bundle_lib/charset.alias~~"~~; then		<source lang="a4c">if test -f "$bundle_lib/charset.alias"; then
	export CHARSETALIASDIR=~~"~~$bundle_lib~~"~~		export CHARSETALIASDIR="$bundle_lib"

	fi</source>		fi</source>
Line 163:		Line 163:

	<source lang="a4c"># Strip out the argument added by the OS.		<source lang="a4c"># Strip out the argument added by the OS.
	if [ x`echo ~~"~~x$1~~"~~ \| sed -e ~~"~~s/^x-psn_.*//~~"~~` == x ]; then		if [ x`echo "x$1" \| sed -e "s/^x-psn_.*//"` == x ]; then

	shift 1		shift 1
Line 170:		Line 170:
	Finally, the script launches the executable.		Finally, the script launches the executable.

	<source lang="a4c">$EXEC ~~"~~$bundle_contents/MacOS/$name-bin~~"~~ $* $EXTRA_ARGS</source>		<source lang="a4c">$EXEC "$bundle_contents/MacOS/$name-bin" $* $EXTRA_ARGS</source>

	[[Category:Development]]		[[Category:Development]]

Jpye at 00:50, 1 August 2010

2010-08-01T00:50:30Z

← Older revision		Revision as of 00:50, 1 August 2010
Line 171:		Line 171:

	<source lang="a4c">$EXEC "$bundle_contents/MacOS/$name-bin" $* $EXTRA_ARGS</source>		<source lang="a4c">$EXEC "$bundle_contents/MacOS/$name-bin" $* $EXTRA_ARGS</source>

			[[Category:Development]]

UploadBot: Restored page from Google Cache, uploaded by John Pye

2010-05-13T14:05:55Z

Restored page from Google Cache, uploaded by John Pye

New page

[[Porting_to_Mac|← Porting to Mac]]

This page contains some notes on how [http://sourceforge.net/apps/trac/gtk-osx/wiki/Bundle ige-mac-bundler] (and maybe other tools) do the job of making portable, self-contained GTK+ applications work on Mac. The notes were prepared during the course of porting [[ASCEND_overview|ASCEND]] to Mac. Please feel free to set me straight on any wrong observations, missing information, etc.

The following observations come from bundling up GtkDemo using ige-mac-bundler.

== GTK libraries ==
GTK libraries are copied into the Contents/Resources/lib directory in the application bundle. Their 'install names' are changed so that they look like:

<pre>
$ otool -L libgtk-quartz-2.0.0.dylib
libgtk-quartz-2.0.0.dylib:
/Users/john/gtk/inst/lib/libgtk-quartz-2.0.0.dylib (compatibility version 1801.0.0, current version 1801.2.0)
@executable_path/../Resources/lib/libgdk_pixbuf-2.0.0.dylib (compatibility version 1801.0.0, current version 1801.2.0)
@executable_path/../Resources/lib/libgdk-quartz-2.0.0.dylib (compatibility version 1801.0.0, current version 1801.2.0)
@executable_path/../Resources/lib/libpangocairo-1.0.0.dylib (compatibility version 2401.0.0, current version 2401.5.0)
</pre>

For the GtkDemo app, the following libraries are copied:

<pre>
$ ls
charset.alias libfreetype.6.dylib libgobject-2.0.0.dylib libpangoft2-1.0.0.dylib
gtk-2.0 libgdk-quartz-2.0.0.dylib libgtk-quartz-2.0.0.dylib libpixman-1.0.dylib
libatk-1.0.0.dylib libgdk_pixbuf-2.0.0.dylib libintl.8.dylib libpng12.0.dylib
libcairo.2.dylib libgio-2.0.0.dylib libjpeg.7.dylib libtiff.3.dylib
libexpat.1.dylib libglib-2.0.0.dylib libpango-1.0.0.dylib
libfontconfig.1.dylib libgmodule-2.0.0.dylib libpangocairo-1.0.0.dylib
</pre>

== Pixbuf loaders ==

The environment variable GDK_PIXBUF_MODULE_FILE is used to specify the path to a file usually named <tt>gdk-pixbuf.loaders</tt>. This file contains a list of shared libraries that perform the task of loading various kinds of images into GTK+.

This <tt>gdk-pixbuf.loaders</tt> file can be automatically generated by the script <tt>~/gtk/inst/bin/gdk-pixbuf-query-loaders</tt>.

This contents of <tt>gdk-pixbuf.loaders</tt> are automatically edited by <tt>ige-mac-bundler</tt> to replace the absolute file paths with paths like <tt>@executable_path/../Resources/lib/gtk-2.0/loaders/libpixbufloader-png.so</tt>, etc.

The pixbuf loaders are copied into the locally-consistent location <tt>Contents/Resources/lib/gtk-2.0/2.xx.xx/loaders</tt>, where xx.xx is the particular GTK+ version being used.

== Icons and themes ==

Icons and themes are copied into <tt>Contents/Resources/share</tt>. I got the following files:

<pre>$ ls -R
icons themes

./icons:
hicolor

./icons/hicolor:
index.theme

./themes:
Default Emacs Raleigh

./themes/Default:
gtk-2.0-key

./themes/Default/gtk-2.0-key:
gtkrc

./themes/Emacs:
gtk-2.0-key

./themes/Emacs/gtk-2.0-key:
gtkrc

./themes/Raleigh:
gtk-2.0

./themes/Raleigh/gtk-2.0:
gtkrc
</pre>

Didn't see any sign of actual image or icon files anywhere... perhaps the default ones are embedded in the shared library somehow.

== Pango configuration files ==

In <tt>Contents/Resources/etc/pango/pangorc</tt> the following text was found:

<pre>
$ cat pangorc
[Pango]
ModuleFiles=./pango.modules
</pre>

The file <tt>pango.modules</tt> is present in the same directory, but is empty.

== GTK configuration files ==

In <tt>Contents/Resources/etc/gtk-2.0/gtkrc</tt> the following text was found:

<pre>
$ cat gtkrc
gtk-icon-theme-name = "Tango"
gtk-enable-mnemonics = 0
</pre>

In same directory, there is another empty file called <tt>gtk.immodules</tt>.

== Use of install_name_tool ==

In <tt>ige-mac-bundler</tt>, all DYLD paths have been set relative to the @executable_path. The executable is kept inside the bundle as <tt>Contents/MacOS/GtkDemo-bin</tt>. This means, for example, that <tt>@executable_path/../Resources/lib</tt> takes the loader to folder containing all the GTK shared libraries.

'''Note''': for the case of PyGTK bundles, assuming Apple Python or MacPython are being used but not being included in the bundle, we can't pull this trick, because the @executable_path would then be outside the application bundle, and no help for locating GTK libraries. An alternative approach might be possible using @rpath set on the PyGTK shared libraries, and this needs to be tried out.

== Environment variables ==

The file <tt>Contents/MacOS/GtkDemo</tt> is the entry-point for the application (as directed by <tt>Info.plist</tt>) and is a shell-script that sets various required environment variables so that GTK can find all its stuff:

'''NOTE''': in the following, the "`pwd`/$0" causes problems if you invoke the <tt>ige-mac-bundler</tt>-bundled from the command line from any directory other than <tt>Contents/MacOS</tt>. I think that this is a bug.

<source lang="a4c">name="`basename $0`"
tmp="`pwd`/$0"

tmp=`dirname "$tmp"`
tmp=`dirname "$tmp"`
bundle=`dirname "$tmp"`

bundle_contents="$bundle"/Contents
bundle_res="$bundle_contents"/Resources
bundle_lib="$bundle_res"/lib
bundle_bin="$bundle_res"/bin
bundle_data="$bundle_res"/share
bundle_etc="$bundle_res"/etc

export DYLD_LIBRARY_PATH="$bundle_lib"
export XDG_CONFIG_DIRS="$bundle_etc"/xdg
export XDG_DATA_DIRS="$bundle_data"

export GTK_DATA_PREFIX="$bundle_res"
export GTK_EXE_PREFIX="$bundle_res"
export GTK_PATH="$bundle_res"

export GTK2_RC_FILES="$bundle_etc/gtk-2.0/gtkrc"
export GTK_IM_MODULE_FILE="$bundle_etc/gtk-2.0/gtk.immodules"
export GDK_PIXBUF_MODULE_FILE="$bundle_etc/gtk-2.0/gdk-pixbuf.loaders"

export PANGO_RC_FILE="$bundle_etc/pango/pangorc"</source>

After the above, there is some locale-related stuff (see [http://github.com/jralls/ige-mac-bundler/blob/master/bundler/launcher.sh launcher.sh] for the details.

Next the script does something with charset alias ('''FIXME''' what's this doing?):

<source lang="a4c">if test -f "$bundle_lib/charset.alias"; then
export CHARSETALIASDIR="$bundle_lib"

fi</source>

Next, a variable EXTRA_ARGS is initialised empty and an optional <tt>environment.sh</tt> is run, allowing command-line arguments to be appended to EXTRA_ARGS, or just to set additional application-specific or user-specific environment variables.

Then, the script throws out some Mac-related command-line parameters that are useless to GTK:

<source lang="a4c"># Strip out the argument added by the OS.
if [ x`echo "x$1" | sed -e "s/^x-psn_.*//"` == x ]; then

shift 1
fi</source>

Finally, the script launches the executable.

<source lang="a4c">$EXEC "$bundle_contents/MacOS/$name-bin" $* $EXTRA_ARGS</source>