Inkscape Wiki - User contributions [en]

Debugging Inkscape

2008-02-17T17:18:43Z

Jfaith:

* If you're hunting down a GTK warning, you can set a breakpoint in gdb for "g_logv" so you can capture a backtrace. ("br g_logv", "run", "bt")

* Bug list
- w32 version asks for (that crappy) Verdana typeface (which is not the most usual w32 typeface, also some users have deleted it to save disk space)

== Debugging Tips for OS X ==

When running the .app package for OS X, it can be difficult to get a backtrace because the application binary is launched through another application and 2 scripts. One way to get a backtrace is:
* Add '-g' to $CFLAGS in your build script before building.
* Remove the signal() calls (<code>segv_handler = signal (SIGSEGV,... </code>) ) in inkscape_application_init() in src/inkscape.cpp.
* In the Resources/bin/inkscpe script, change the last line from:
<code>exec "$CWD/inkscape-bin" "$@"</code>
to:
<code>exec "/usr/bin/gdb" "stuff/inkscape-bin"</code>
* Build and package the app (see [[CompilingMacOsX]]).
* Run the application in Terminal:
<code>
$ cd packaging/macosx
$ Inkscape.app/Contents/MacOS/Inkscape
...
(gdb) run
</code>

== Debugging Tips for Windows ==

First, have a look at the [[Using Eclipse]] page for how to use that program on Windows to debug Inkscape.

Second, make use of the '''View > Messages...''' dialog from within the program. Capturing the log here will show you messages printed with g_message(), g_warning(), and g_error()..

Finally, look into [http://wiki.inkscape.org/wiki/index.php/FAQ#I.27m_on_Windows.2C_and_command_line_parameters_don.27t_seem_to_work.21 how to compile Inkscape as a command line app] so you can capture debug messages at the prompt, more like you would do in Linux.

===How Johan works===
Of course I am always compiling with [http://wiki.inkscape.org/wiki/index.php/FAQ#I.27m_on_Windows.2C_and_command_line_parameters_don.27t_seem_to_work.21 -mconsole, instead of -mwindows]. I don't compile with -g or any other extra flags. This is unnecessary and reduces build times <i>significantly</i>.

For example for crashes, usually I add g_message("blah") to the code to see where the execution of code goes and to see on which line things break:

g_message("1");
some_piece_of_code1();
g_message("2");
some_piece_of_code2();
g_message("3");
some_piece_of_code3();
g_message("4");
some_piece_of_code4();
g_message("5");

If I see the message "2" but not "3" I know the crash happened in some_piece_of_code2.

I also use GDB to get backtraces. Again, don't compile with -g. Not necessary at all! One of the problems with running Inkscape in gdb is that you cannot open a file with the file dialog: Inkscape will hang. I don't know the reason, but I do know a solution! Open the file through Inkscape's cmdline parameters:

D:\Inkscape\inkscape>gdb
GNU gdb 6.6
Copyright (C) 2006 Free Software Foundation, Inc.
GDB is free software, covered by the GNU General Public License, and you are
welcome to change it and/or distribute copies of it under certain conditions.
Type "show copying" to see the conditions.
There is absolutely no warranty for GDB. Type "show warranty" for details.
This GDB was configured as "i686-pc-mingw32".
(gdb) file inkscape.exe inkscape.dbg
Reading symbols from D:\Inkscape\inkscape/inkscape.exe...(no debugging symbols found)...done.
Reading symbols from D:\Inkscape\inkscape/inkscape.dbg...done.
(gdb) run Tekening.svg
Starting program: D:\Inkscape\inkscape/inkscape.exe Tekening.svg

===Example of how to fix a bug===
See this bugreport:
https://bugs.launchpad.net/inkscape/+bug/169135

I started gdb like above. And then I saw this:
Program received signal SIGSEGV, Segmentation fault.
0x005c94ec in Inkscape::UI::Widget::Scalar::setValue ()
(gdb) bt
#0 0x005c94ec in Inkscape::UI::Widget::Scalar::setValue ()
#1 0x0044fc11 in Inkscape::CanvasXYGrid::readRepr ()
#2 0x0044de22 in Inkscape::CanvasXYGrid::onReprAttrChanged ()

The crashing piece of code looked like this:

void Scalar::setValue(double value)
{
g_assert(_widget != NULL);
setProgrammatically = true; // callback is supposed to reset back, if it cares
static_cast<Gtk::SpinButton*>(_widget)->set_value(value);
}

Nothing much can crash there, the assert checks that _widget is not NULL, and then the cast is valid aswell. So what crashed? What happens is that the setValue method is called for an object that does not exist. _widget is not NULL, but "this" is! this->_widget would crash. g_assert (this != NULL) would give an assertion message. (checked by adding " if (this==NULL) g_message("ja hoor"); " )

It is absurd to check for "this" to be non-NULL at the start of every method, so the bug is not in this method but in the function calling it! That's why we turn our attention to Inkscape::CanvasXYGrid::readRepr ().

readRepr is long, but we only have to look where it does something with a Scalar widget. It's the validateScalar functions. When we comment those out, the bug is solved. (it causes another bug with the specific SVG file, where Inkscape hangs when the grid spacing equals zero. validateScalar used to check for that...)
The strange thing is that the widgets are all created and initialized in the constructor of CanvasXYGrid. So perhaps readRepr is being called *during* construction of CanvasXYGrid, while the Scalar widget is still invalid? Using the g_message tip above I found out that the problem code was:
sutemp = _rsu_sx.getSU();
g_message("CanvasXYGrid 1");
sutemp->setDigits(4);
g_message("CanvasXYGrid 2");

Researching the setDigits path, I could not find a bug. Then it hit me: _rsu_sx is initialized, then readRepr is called, but this is <i>before</i> _rsu_sy is initialized. Then

void RegisteredScalarUnit::setValue (double val)
{
_widget->setValue (val);
}

is called, but _widget is still NULL, hence the crash.
As usual, the fix is easy:
void RegisteredScalarUnit::setValue (double val)
{
if (_widget)
_widget->setValue (val);
}

Don't forget to fix the setValue methods of the other Registered widgets!!!

The fix can be seen in [http://inkscape.svn.sourceforge.net/viewvc/inkscape?view=rev&revision=16544 SVN revision 16544].

[[Category:Developer Documentation]]

Help:Contents

2008-02-17T16:28:13Z

Jfaith: Added wiki help section

For general help with Inkscape, please see:
*Links on the wiki's [[Main_Page]]
*[[UserManual]]
*[http://lists.sourceforge.net/lists/listinfo/inkscape-user Inkscape Users Mailing List]

Related links:
*[[CommunicationChannels]] (for various other resources)
*[http://sourceforge.net/tracker/?group_id=93438&atid=604306 Inkscape Bug Tracker at Sourceforge]

Wiki help:
*[[Help:Editing]]

CompilingMacOsX

2007-06-15T14:27:52Z

Jfaith: /* Binary packages */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using Mac/DarwinPorts ==

=== 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:
* <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>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>

=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) 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.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <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>:
<pre>./configure {...} --enable-osxapp</pre>

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 issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==

To build a universal build of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] and [http://numpy.scipy.org/ numpy].

=== Binary packages ===
You can install a binary version compiled by us (thanks to krolco for the Intel version) downloadable with the developement builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus) and numpy (numpy) to /Library/Python/2.3/site-packages/ (there is a link in the dmg on which the folders can be droped).

On OS X 10.3, the _xmlplus and numpy folders should be copied to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages. This is a symlink back to /Library/Python/2.3 (note lack of "site-packages"!).

=== Compiling from source ===
If you prefer or if you are on an Intel machine, you can install them from source, it is really easy.

==== pyXML ====
# 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 version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. 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 by just typing <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.

==== numpy ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and 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]]