Difference between revisions of "CompilingMacOsX"

From Inkscape Wiki
Jump to navigation Jump to search
(libsoup@2 as pointed out by Meow Day in https://gitlab.com/inkscape/inkscape/-/issues/3317)
 
(172 intermediate revisions by 27 users not shown)
Line 1: Line 1:
== Compiling Inkscape ==
__TOC__


=== Requirements ===
= Using MacPorts =
To compile Inkscape from source you will need:
*Mac OS X 10.3 (Power PC) or higher
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://www.inkscape.org/cvs-snap/ SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*XCode 2.3 on OS X 10.4 (gcc 4.0.1)


To install Inkscape dependencies you can use:
<ol>
*Fink with an [http://fink.sourceforge.net/faq/usage-fink.php?phpLang=en#unstable unstable installation] (does not provide support for loudmouth, the librarie that Inkboard uses, therefore you won't be able to use Inkboard)
<li>Download and install [http://www.macports.org/ MacPorts]
*[http://darwinports.opendarwin.org/ DarwinPorts]
<li>Edit the MacPorts variants config (optional).
<br>Add this line to <code>/opt/local/etc/macports/variants.conf</code>
<pre>-x11 +quartz</pre>
<li>In Terminal (Applications>Utilities>Terminal) type
<syntaxhighlight lang="bash">sudo port install \
    adwaita-icon-theme \
    boehmgc \
    boost \
    cairo \
    ccache \
    cmake \
    double-conversion \
    gdl3 \
    gettext \
    gsl \
    gtkmm3 \
    gtk-osx-application-gtk3 \
    lcms2 \
    libsoup \
    libxslt \
    ninja \
    poppler \
    potrace \
    py-lxml \
    py-numpy \
    -x11 +quartz
</syntaxhighlight>
<li>In Terminal, get Inkscape
<syntaxhighlight lang="bash">git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git</syntaxhighlight>
<li>And build inkscape
<syntaxhighlight lang="bash">
# use a clean MacPorts environment (optional)
LIBPREFIX="/opt/local"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"


=== Preparing the build using Fink ===
# where to install
PREFIX="$PWD/install-prefix"


====Installing dependencies====
# where to build
Inkscape can be installed via Fink. Therefore, as for any other package, Fink provides you with a list of its dependencies:
mkdir build
<pre>fink show-deps inkscape</pre>
cd build


Some are mandatory and you must install them:
cmake \
<pre>fink install gtkmm2.4-dev  gconf2-dev gnome-vfs2-dev\
    -G Ninja \
  gtkspell2-dev intltool lcms libbonobo2-dev libxslt gc</pre>
    -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
    -DCMAKE_INSTALL_PREFIX="$PREFIX" \
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
    -DWITH_OPENMP=OFF \
    ../inkscape


Some provide additional functionality in Inkscape
ninja
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
ninja install
* <code>boost >= 1.32</code> : auto-organisation of connectors [Note: is boost still needed?]
</syntaxhighlight>
* <code>gnome-print</code>
''Note: Using [https://en.wikipedia.org/wiki/Ccache ccache] and [https://ninja-build.org/ ninja] is not required, but very common because it speeds up compilation.''
<pre>fink install aspell-dev boost gnome-print-dev</pre>
<li>Run Inkscape
<syntaxhighlight lang="bash">
$PREFIX/bin/inkscape
</syntaxhighlight>
</ol>


If you use [http://en.wikipedia.org/wiki/MMX MMX optimization] (available on Intel processors) you need version 1.8.5 of automake (and not 1.9.6 which is the latest in Fink). Otherwise you will need suppress the check on the version of automake (see the Configuring section).
= Using Homebrew =
<pre>fink install automake1.8</pre>


====Setting the build environment====
If you are using [https://brew.sh/ Homebrew] instead, you can still use the above guidelines with small modifications.
Fink's hierarchy is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here. You can create a file named <code>set_env_variables.sh</code> and copy/paste this inside:
<pre>
#!/bin/bash
FINK="/sw"
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
export CPPFLAGS="-I$FINK/include"
export LDFLAGS="-L$FINK/lib"
export CPATH="$FINK/include"
export PATH="/usr/X11R6/bin:$PATH"
export LIBRARY_PATH="/usr/X11R6/lib:$FINK/lib"
export PKG_CONFIG_PATH="$FINK/lib/pkgconfig"
</pre>


In addition, you must make sure that Inkscape is compiled with the compiler version that Fink uses, otherwise Inkscape will not link properly. To determine which compiler to use type:
List of '''packages''' to install with brew
<pre>head -n 5 $FINK/etc/fink.conf | grep "Distribution"</pre>
(for Inkscape 1.1):
If your fink distribution is 10.4 add:
<pre>
export CC="gcc-4.0"
export CXX="g++-4.0"
</pre>
to <code>set_env_variables.sh</code>, else (10.3, 10.4-transitional) add:
<pre>
export CC="gcc-3.3"
export CXX="g++-3.3"
</pre>


You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>fink install ccache</code>) to speed up the compilation a bit. To do so, modify the compiler lines accordingly:
<syntaxhighlight lang="bash">
<pre>
brew install \
export CC="ccache gcc-??"
    adwaita-icon-theme \
export CXX="ccache g++-??"
    bdw-gc \
</pre>
    boost \
    cairomm \
    ccache \
    cmake \
    double-conversion \
    gettext \
    gsl \
    gspell \
    gtk-mac-integration \
    gtkmm3 \
    imagemagick \
    intltool \
    lcms2 \
    libomp \
    libsoup@2 \
    libxslt \
    ninja \
    poppler \
    potrace
</syntaxhighlight>


Eventually, open a Terminal and, in the directory where you created the file <code>set_env_variables.sh</code>, type:
You may substitute <code>imagemagick</code> with <code>graphicsmagick</code>.
<pre>source set_env_variables.sh</pre>


You are ready to configure, compile and install Inkscape. Go to the section 'Configuring' now.
<code>gtk-mac-integration</code> is not needed with latest <code>1.2-dev</code>.


=== Preparing the build using DarwinPorts ===
Some keg-only libraries need to be added to <code>$PKG_CONFIG_PATH</code>
====Installing dependencies====
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>
Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>


Others provide additional functionality to Inkscape:
Some libraries can cause trouble if they are picked up from the SDK instead of Homebrew (observed with <code>libxslt</code> and <code>libxml2</code>). Adding them to <code>$PKG_CONFIG_PATH</code> should fix this.
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>boost</code> : auto-organisation of connectors [Note: is boost still needed?]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>


Using [http://en.wikipedia.org/wiki/MMX MMX optimization] (available on Intel processors only) requires that you use automake 1.8 but only automake 1.9.6 is available in DarwinPorts. Therefore, unless you install version 1.8.5 by hand ([http://ftp.gnu.org/gnu/automake/automake-1.8.5.tar.gz]) you will need to disable MMX optimization and to disable the check on automake version during the configure step.
This was tested on an M1 MacBook Air with macOS 11.6 and Inkscape 1.2-dev.


====Setting the build environment====
<syntaxhighlight lang="bash">
# use a clean Homebrew environment (optional)
LIBPREFIX="/opt/homebrew"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"


# keg-only libraries
export PKG_CONFIG_PATH="$LIBPREFIX/opt/icu4c/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libsoup@2/lib/pkgconfig"


# prevent picking up libxslt and libxml2 from the (wrong) SDK
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxslt/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxml2/lib/pkgconfig"


# where to install
PREFIX="$PWD/install-prefix"


=== Configuring ===
mkdir -p build
cd build


First, if you have and Intel processor, you need to decide if you use [http://en.wikipedia.org/wiki/MMX MMX optimization] or not. If you have a G3/G4/G5 processor you cannot use it anyway.
cmake \
[Note: please someone confirm that MMX optimization is available on Mac Intel processors]
    -G Ninja \
If you do not use MMX optimization, you can use automake 1.9 and you need to disable the check on automake version in <code>autogen.sh</code> by commenting the lines (around line 110):
     -DCMAKE_SHARED_LINKER_FLAGS="-L$LIBPREFIX/lib" \
<pre>    # Exclude automake 1.9.[0-6]
    -DCMAKE_EXE_LINKER_FLAGS="-L$LIBPREFIX/lib" \
     if expr $VER \>= 1.9.0 >/dev/null && expr $VER \<= 1.9.6 >/dev/null ; then
    -DCMAKE_INSTALL_PREFIX=$PREFIX \
        echo
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
        echo "  You must have automake less than 1.9.0 or newer than 1.9.6"
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
        echo "  Get ftp://ftp.gnu.org/pub/gnu/automake/automake-1.8.5.tar.gz"
     -DWITH_DBUS=OFF \
        echo "  (or a newer version of 1.8 if it is available)"
    ..
        DIE=1
     fi
</pre>


Then, you might need to build the configure script (if you compile Inkscape for the first time for example). Cd to Inkscape's source directory and run:
ninja
<pre>./autogen.sh</pre>
ninja install
</syntaxhighlight>


Then run the configure script with the option <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
=See also=
<pre>./configure --prefix=/path/to/build/products/</pre>
* [[Tracking Dependencies]]
 
* [[Extension requirements]]
If you decided to disable MMX optimization on Intel procesors, add the <code>--disable-mmx</code> option.
*[[Compiling Inkscape]]
 
*[[Notes on Packaging for OS X]]
I you want to package Inkscape into an <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
* https://github.com/valerioa/Inkscape-MacOS-Curated-Build
<pre>./configure --prefix=/path/to/build/products/ --enable-osxapp</pre>
* [https://github.com/ipatch/homebrew-us-05/blob/master/inkscape/inkscape-building-for-macOS.md ipatch's collection of notes] about building Inkscape using Homebrew
 
If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.
 
Other configuration options can be set, check the list of options by using:
<pre>./configure --help</pre>
 
=== Building and Installing ===
 
Just run:
<pre>
make
make install
</pre>
 
 
===Automated compilation===
You can try downloading a bash script which automates the processes of updating Inkscape from the svn repository, setting the build environment, building and producing a package of Inkscape. Modify it with your favorite text editor in order to set a correct install prefix and to change configuration options according to your needs.
Two scripts are prodived, depending on wether you use Fink or DarwinPorts.
[http://jo.irisson.free.fr/dropbox/inkscape/osxmake_fink.sh]  
[http://jo.irisson.free.fr/dropbox/inkscape/osxmake_dp.sh]
 
To use this script, place it in the directory where Inkscape source code is and make it executable
<pre>chmod +x osxmake_???.sh</pre>
To obtain help on how to use it run it with the <code>-h</code> option:
<pre>./osxmake_???.sh -h</pre>
To run the whole process use the command:
<pre>./osxmake_???.sh -s -a -c -b -i -p</pre>
 
== Packaging Inkscape into an .app bundle ==
 
 
=== Creating the .app and a simple .dmg ===
 
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, the process is fully automatized. You just have to open a Terminal, cd to Inkscape's sources directory and type:
<pre>
cd packaging
./osx-app.sh -s /path/to/build/products/bin/inkscape ../Info.plist macosx
</pre>
The <code>-s</code> options produces an app bundle stripped of debugging information (which is therefore smaller). Omit this option if you want to keep debugging info.
 
Either way, this creates two files in current directory: Inkscape.app that you can copy to your Applications directory and Inkscape.dmg for distribution.
 
 
=== Creating a more complete .dmg ===
 
The steps that used to comprise this section have since been integrated into the official Inkscape.app build script, refered to above.
 
== Enabling python effects ==
 
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but not with pyXML which is needed by Inkscape effects.
You can install a binary version downloadable with the developement builds of Inkscape:
 
:http://inkscape.modevia.com/macosx-snap/?M=D
 
Or you can install it from source:
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to the number of your operating system (10.3 for Panther, 10.4 for Tiger. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions<pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.
 
== Links ==
 
=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.
 
=== Packaging ===
 
* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html  Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.


[[Category:Developer Documentation]]
[[Category:Developer Documentation]]

Latest revision as of 19:18, 10 April 2022

Using MacPorts

  1. Download and install MacPorts
  2. Edit the MacPorts variants config (optional).
    Add this line to /opt/local/etc/macports/variants.conf
    -x11 +quartz
  3. In Terminal (Applications>Utilities>Terminal) type
    sudo port install \
         adwaita-icon-theme \
         boehmgc \
         boost \
         cairo \
         ccache \
         cmake \
         double-conversion \
         gdl3 \
         gettext \
         gsl \
         gtkmm3 \
         gtk-osx-application-gtk3 \
         lcms2 \
         libsoup \
         libxslt \
         ninja \
         poppler \
         potrace \
         py-lxml \
         py-numpy \
         -x11 +quartz
    
  4. In Terminal, get Inkscape
    git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git
    
  5. And build inkscape
    # use a clean MacPorts environment (optional)
    LIBPREFIX="/opt/local"
    export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"
    
    # where to install
    PREFIX="$PWD/install-prefix"
    
    # where to build
    mkdir build
    cd build
    
    cmake \
        -G Ninja \
        -DCMAKE_PREFIX_PATH="$LIBPREFIX" \
        -DCMAKE_INSTALL_PREFIX="$PREFIX" \
        -DCMAKE_C_COMPILER_LAUNCHER=ccache \
        -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
        -DWITH_OPENMP=OFF \
        ../inkscape
    
    ninja
    ninja install
    

    Note: Using ccache and ninja is not required, but very common because it speeds up compilation.

  6. Run Inkscape
    $PREFIX/bin/inkscape
    

Using Homebrew

If you are using Homebrew instead, you can still use the above guidelines with small modifications.

List of packages to install with brew (for Inkscape 1.1):

brew install \
    adwaita-icon-theme \
    bdw-gc \
    boost \
    cairomm \
    ccache \
    cmake \
    double-conversion \
    gettext \
    gsl \
    gspell \
    gtk-mac-integration \
    gtkmm3 \
    imagemagick \
    intltool \
    lcms2 \
    libomp \
    libsoup@2 \
    libxslt \
    ninja \
    poppler \
    potrace

You may substitute imagemagick with graphicsmagick.

gtk-mac-integration is not needed with latest 1.2-dev.

Some keg-only libraries need to be added to $PKG_CONFIG_PATH

Some libraries can cause trouble if they are picked up from the SDK instead of Homebrew (observed with libxslt and libxml2). Adding them to $PKG_CONFIG_PATH should fix this.

This was tested on an M1 MacBook Air with macOS 11.6 and Inkscape 1.2-dev.

# use a clean Homebrew environment (optional)
LIBPREFIX="/opt/homebrew"
export PATH="$LIBPREFIX/bin:/usr/bin:/bin:/usr/sbin:/sbin"

# keg-only libraries
export PKG_CONFIG_PATH="$LIBPREFIX/opt/icu4c/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libsoup@2/lib/pkgconfig"

# prevent picking up libxslt and libxml2 from the (wrong) SDK
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxslt/lib/pkgconfig"
export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:$LIBPREFIX/opt/libxml2/lib/pkgconfig"

# where to install
PREFIX="$PWD/install-prefix"

mkdir -p build
cd build

cmake \
    -G Ninja \
    -DCMAKE_SHARED_LINKER_FLAGS="-L$LIBPREFIX/lib" \
    -DCMAKE_EXE_LINKER_FLAGS="-L$LIBPREFIX/lib" \
    -DCMAKE_INSTALL_PREFIX=$PREFIX \
    -DCMAKE_C_COMPILER_LAUNCHER=ccache \
    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
    -DWITH_DBUS=OFF \
    ..

ninja
ninja install

See also