GTK+ 3 migration - Revision history

Tavmjong at 12:24, 6 March 2017

2017-03-06T12:24:34Z

← Older revision		Revision as of 12:24, 6 March 2017
Line 1:		Line 1:
			<big style="color:darkred"><center>This page is out-of-date. Inkscape trunk must be built with GTK+ 3. See: [[Gtk issues]]</center></big>

	<big><center>''Inkscape trunk will soon stop supporting GTK+ 2 builds.<br />The forthcoming Inkscape 0.92 release '''will''' still use GTK+ 2.<br />See the [[Notice of removal of GTK+ 2 support\|migration page]] for details.''</center></big>		<big><center>''Inkscape trunk will soon stop supporting GTK+ 2 builds.<br />The forthcoming Inkscape 0.92 release '''will''' still use GTK+ 2.<br />See the [[Notice of removal of GTK+ 2 support\|migration page]] for details.''</center></big>

	Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.		Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.

	~~More up-to-date page: [[Gtk issues]]~~

	== Building Inkscape against GTK+ 3 ==		== Building Inkscape against GTK+ 3 ==

Valavanisalex: Fix link

2016-07-26T10:42:11Z

Fix link

← Older revision		Revision as of 10:42, 26 July 2016
Line 1:		Line 1:
	<big><center>''Inkscape trunk will soon stop supporting GTK+ 2 builds.<br />The forthcoming Inkscape 0.92 release '''will''' still use GTK+ 2.<br />See the [[~~migration page\|Removal~~ of GTK+ 2 support]] for details.''</center></big>		<big><center>''Inkscape trunk will soon stop supporting GTK+ 2 builds.<br />The forthcoming Inkscape 0.92 release '''will''' still use GTK+ 2.<br />See the [[Notice of removal of GTK+ 2 support\|migration page]] for details.''</center></big>

	Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.		Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.

Valavanisalex: Add notice about GTK+ 3 switchover

2016-07-26T10:41:38Z

Add notice about GTK+ 3 switchover

← Older revision		Revision as of 10:41, 26 July 2016
Line 1:		Line 1:
			<big><center>''Inkscape trunk will soon stop supporting GTK+ 2 builds.<br />The forthcoming Inkscape 0.92 release '''will''' still use GTK+ 2.<br />See the [[migration page\|Removal of GTK+ 2 support]] for details.''</center></big>

	Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.		Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.

Tavmjong at 19:08, 14 May 2016

2016-05-14T19:08:12Z

← Older revision		Revision as of 19:08, 14 May 2016
Line 1:		Line 1:
	Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.		Inkscape currently makes use of the GTK+ 2.20 library API. Ultimately, we will need to switch to the new GTK+ 3 API. This version of the library introduces a number of major changes that are incompatible with GTK, so we need to make some changes to Inkscape.

			More up-to-date page: [[Gtk issues]]

	== Building Inkscape against GTK+ 3 ==		== Building Inkscape against GTK+ 3 ==

Valavanisalex: /* Current status */ fix link

2012-12-21T11:54:51Z

Current status: fix link

← Older revision		Revision as of 11:54, 21 December 2012
Line 19:		Line 19:

	* Several significant bugs affect the GTK+ 3 builds. Please see the [https://bugs.launchpad.net/inkscape/+bugs?field.tag=gtk3 list of known bugs], and please report any more that you find!		* Several significant bugs affect the GTK+ 3 builds. Please see the [https://bugs.launchpad.net/inkscape/+bugs?field.tag=gtk3 list of known bugs], and please report any more that you find!
	* The Gtk+ 3 builds introduce a number of dependencies, including version 3.3.4 of the GDL dockable-dialog library (Gtk+ 2 builds use an internal copy of the library). Most linux distributions now provide this. We're [[tracking the dependencies]]... keep an eye on the list.		* The Gtk+ 3 builds introduce a number of dependencies, including version 3.3.4 of the GDL dockable-dialog library (Gtk+ 2 builds use an internal copy of the library). Most linux distributions now provide this. We're [[Tracking Dependencies\|tracking the dependencies]]... keep an eye on the list.
	* There is currently no easy way of building against Gtk+ 3 on Windows. However, there is [https://bugs.launchpad.net/inkscape/+bug/1088612 work in progress].		* There is currently no easy way of building against Gtk+ 3 on Windows. However, there is [https://bugs.launchpad.net/inkscape/+bug/1088612 work in progress].
	* Gtk+ 3 is still evolving. To avoid being affected by the level of pain we experienced with the Gtk+ 2 -> Gtk+ 3 migration, we should aim to stay as up-to-date with our API usage as possible... i.e., eliminate [[#deprecated symbols]] as soon as possible!		* Gtk+ 3 is still evolving. To avoid being affected by the level of pain we experienced with the Gtk+ 2 -> Gtk+ 3 migration, we should aim to stay as up-to-date with our API usage as possible... i.e., eliminate [[#deprecated symbols]] as soon as possible!

Valavanisalex: Updated

2012-12-16T16:41:09Z

Updated

← Older revision		Revision as of 16:41, 16 December 2012
Line 14:		Line 14:

	After this, you can build as usual.		After this, you can build as usual.

			== Current status ==
			Inkscape builds successfully against GTK+ 3, but the resulting program is unstable and isn't recommended for users yet. A few key issues are as follows:

			* Several significant bugs affect the GTK+ 3 builds. Please see the [https://bugs.launchpad.net/inkscape/+bugs?field.tag=gtk3 list of known bugs], and please report any more that you find!
			* The Gtk+ 3 builds introduce a number of dependencies, including version 3.3.4 of the GDL dockable-dialog library (Gtk+ 2 builds use an internal copy of the library). Most linux distributions now provide this. We're [[tracking the dependencies]]... keep an eye on the list.
			* There is currently no easy way of building against Gtk+ 3 on Windows. However, there is [https://bugs.launchpad.net/inkscape/+bug/1088612 work in progress].
			* Gtk+ 3 is still evolving. To avoid being affected by the level of pain we experienced with the Gtk+ 2 -> Gtk+ 3 migration, we should aim to stay as up-to-date with our API usage as possible... i.e., eliminate [[#deprecated symbols]] as soon as possible!

	== Guidance from upstream ==		== Guidance from upstream ==
Line 19:		Line 27:

	== Deprecated symbols ==		== Deprecated symbols ==
	~~Inkscape currently makes use of~~ a ~~number~~ of deprecated GTK+ symbols~~. We need to get rid of all of these as part of the migration. Some are very easy to replace. Some are a little more challenging.~~		There are a few macros that can be defined during compilation to protect us against usage of deprecated GTK+ 3 symbols, by doing something like:
			<pre>make -k CPPFLAGS+="-DMACRO"</pre>
	~~Although Inkscape is configured to use the "-DGTK_DISABLE_DEPRECATED" compiler flag~~, ~~this does not trap all deprecated symbols (because many Gtkmm headers disable the flag!).~~		where "<nowiki>MACRO</nowiki>" should be replaced by a macro from the following list:
			* GTK_DISABLE_DEPRECATED - prevent usage of deprecated GTK+ symbols
	~~An incomplete "to do" list follows~~:		* GDK_DISABLE_DEPRECATED - prevent usage of deprecated GDK symbols
			* GTKMM_DISABLE_DEPRECATED - prevent usage of deprecated Gtkmm symbols
	~~=== Switch to gobject ===~~		* GDKMM_DISABLE_DEPRECATED - prevent usage of deprecated Gtkmm symbols
	<~~https://bugs.launchpad.net/inkscape/~~+~~bug/813212>~~

	The GtkType and GtkObject API has been replaced by the gobject library. One of the few remaining issues here is that SPCanvasItem is a subclass of GtkObject. However, this part of the class hierarchy is currently being rewritten, and will be based on a different parent class.

	~~=== Use accessor functions to GtkWidget ===~~
	~~Accessor functions such as <code>gtk_widget_has_focus()</code> should be used instead of deprecated macros such as <code>GTK_WIDGET_HAS_FOCUS()</code>~~

	==~~= Get rid of~~ "~~visual~~" ~~functions for GtkWidgets ===~~
	The visual for a widget, and also the default visual is now derived from the colormap for the widget and the default colormap. <code>gtk_widget_set_visual()</code>, <code>gtk_widget_set_default_visual()</code>, <code>gtk_widget_push_visual()</~~code~~> ~~and <code>gtk_widget_pop_visual()</code> now do nothing. Since the visual always had to match that of the colormap, it is safe to simply delete all references to these functions.~~
	~~:Done [[User:Valavanisalex\|Valavanisalex]] 09:55, 23 June 2011 (UTC)~~

	~~=== Don't use GtkNotebookPage ===~~
	~~The~~ <~~code~~>~~GtkNotebookPage~~</~~code~~> ~~structure has been removed from the public header files; this was never meant to~~ be a ~~public structure, and all functionality that could be done by accessing~~ the ~~struct fields of this structure should be accessible otherwise.~~

	~~=== Switch from GtkCombo to GtkComboBoxEntry ===~~
	~~See [http~~:~~//developer.gnome.org/gtk/2.24/migrating-GtkCombo.html]~~
	~~:Done. A few symbols are left in #if/#else blocks in src/dialogs/text~~-edit.cpp to allow build compatibility with GTK+ 2.20. These can be removed once Inkscape has bumped its dependency level to GTK+ >= 2.24. [[User:Valavanisalex\|Valavanisalex]] 09:46, 23 June 2011 (UTC)

	~~=== Get rid~~ of ~~GtkAction proxy functions ===~~
	~~gtk_action_connect_proxy has been~~ deprecated ~~since version 2.16 and should not be used in newly-written code. Use gtk_activatable_set_related_action() instead.~~

	~~=== Merge GtkRuler into Inkscape ===~~
	~~The GtkRuler class has been completely removed from~~ GTK+ ~~3, and will not be replaced. GIMP got around the problem by merging the GtkRuler code into their own project.~~
	~~:'''Done.''' [[User:Valavanisalex\|Valavanisalex]] 14:24, 14 April 2012 (UTC)~~

	~~== Build against external GDL ==~~
	~~We currently use our own fork~~ of the GDL library (based on GDL 2.30.0). Eventually, we need to get rid of our own fork, and build against the external library. Progress is being tracked at https://bugs.launchpad.net/inkscape/+bug/792115

	~~Most~~ of ~~our local changes to GDL have been accepted upstream in GDL 3.3.4 and higher. The only remaining issues are minor:~~
	* ~~the title bars~~ of ~~docked dialogs do not change colour when they gain focus~~
	* floating docks will show up in the system taskbar

	~~Fixes for both~~ of these ~~issues are being worked on upstream.~~		In addition to this, several deprecated symbols (in a number of libraries) have been tagged with the "deprecated" attribute in their C/C++ declarations. Most compilers will therefore warn you at compile time if the symbol is in use. To turn these warnings into errors, you can do something like:
			<pre>make -k CPPFLAGS+="-Werror=deprecated-declarations"</pre>

	~~When [[#Building Inkscape against GTK+ 3\|experimental builds are configured]]~~, ~~a search~~ is ~~made for~~ a ~~suitable external version~~ of ~~GDL. If GDL >= 3.3.4 is available, then it will be used~~ in ~~place of our internal fork~~.		In all the above cases, the "-k" flag is used to tell make to keep processing after errors have been found. This lets us generate a complete "todo" list of errors in the code rather than just seeing the first.

Valavanisalex: /* Building Inkscape against GTK+ 3 */ Build now succeeds

2012-12-16T16:06:33Z

Building Inkscape against GTK+ 3: Build now succeeds

← Older revision		Revision as of 16:06, 16 December 2012
Line 2:		Line 2:

	== Building Inkscape against GTK+ 3 ==		== Building Inkscape against GTK+ 3 ==
	First, configure Inkscape to build against GTK+ 3 using <code>configure --enable-gtk3-experimental</code>. I prefer to use a separate subfolder for these ~~(broken)~~ builds.		First, configure Inkscape to build against GTK+ 3 using <code>configure --enable-gtk3-experimental</code>. I prefer to use a separate subfolder for these experimental builds.

	<pre>		<pre>
Line 13:		Line 13:
	</pre>		</pre>

	After this, you can build as usual. However, as there are a huge number of errors, it is useful to instruct the build to continue even if errors are encountered. This is achieved by using the "<code>-k</code>" flag with Make. It is also helpful to dump a log of the errors (>5000 lines at the time of writing!). In summary, I use something like:		After this, you can build as usual.

	~~<pre>~~
	~~make -k 2> gtk3-experimental.txt~~
	~~</pre>~~

	~~Finally, note that it's possible (as usual) to speed up compilation by using the <code>-j</code> flag to specify a parallel build. The disadvantage of this is that it can produce messy build logs~~.

	== Guidance from upstream ==		== Guidance from upstream ==

Valavanisalex: /* Building Inkscape against GTK+ 3 */ note about parallel builds

2012-04-17T11:24:00Z

Building Inkscape against GTK+ 3: note about parallel builds

← Older revision		Revision as of 11:24, 17 April 2012
Line 18:		Line 18:
	make -k 2> gtk3-experimental.txt		make -k 2> gtk3-experimental.txt
	</pre>		</pre>

			Finally, note that it's possible (as usual) to speed up compilation by using the <code>-j</code> flag to specify a parallel build. The disadvantage of this is that it can produce messy build logs.

	== Guidance from upstream ==		== Guidance from upstream ==

Valavanisalex: /* Deprecated symbols */ Ruler has been imported

2012-04-14T14:24:41Z

Deprecated symbols: Ruler has been imported

← Older revision		Revision as of 14:24, 14 April 2012
Line 53:		Line 53:
	=== Merge GtkRuler into Inkscape ===		=== Merge GtkRuler into Inkscape ===
	The GtkRuler class has been completely removed from GTK+ 3, and will not be replaced. GIMP got around the problem by merging the GtkRuler code into their own project.		The GtkRuler class has been completely removed from GTK+ 3, and will not be replaced. GIMP got around the problem by merging the GtkRuler code into their own project.
			:'''Done.''' [[User:Valavanisalex\|Valavanisalex]] 14:24, 14 April 2012 (UTC)

	== Build against external GDL ==		== Build against external GDL ==

Valavanisalex: /* Deprecated symbols */ Updated status of deprecated symbol usage

2012-04-14T14:24:05Z

Deprecated symbols: Updated status of deprecated symbol usage

← Older revision		Revision as of 14:24, 14 April 2012
Line 23:		Line 23:

	== Deprecated symbols ==		== Deprecated symbols ==
	Inkscape currently makes use of a number of deprecated GTK+ symbols. We need to get rid of all of these ~~before we can upgrade~~. Some are very easy to replace. Some are a little more challenging. ~~We need~~ to ~~ensure that Inkscape still builds correctly when~~ the "-DGTK_DISABLE_DEPRECATED" compiler flag ~~is applied~~. An incomplete "to do" list follows:		Inkscape currently makes use of a number of deprecated GTK+ symbols. We need to get rid of all of these as part of the migration. Some are very easy to replace. Some are a little more challenging.

			Although Inkscape is configured to use the "-DGTK_DISABLE_DEPRECATED" compiler flag, this does not trap all deprecated symbols (because many Gtkmm headers disable the flag!).

			An incomplete "to do" list follows:

	=== Switch to gobject ===		=== Switch to gobject ===