Changes between Initial Version and Version 1 of HackingGtk


Ignore:
Timestamp:
Nov 23, 2007 4:11:09 PM (14 years ago)
Author:
alp@atoker.com
Comment:

Add GTK+ hacking information verbatim

Legend:

Unmodified
Added
Removed
Modified
  • HackingGtk

    v1 v1  
     1[[PageOutline]]
     2
     3= Hacker's guide to WebKit/GTK+ =
     4
     5== Code layout ==
     6
     7The GTK+ port targets the cross-platform GLib and GTK+ APIs. This means that it can be built against any of the windowing systems supported by GTK+ and Cairo without modification -- those tested so far are X11 and DirectFB. Windows should work too, possibly needing a couple of tweaks.
     8
     9This means that developers adding code specific to a certain windowing system should make sure their changes are conditionally compiled only when that windowing system is available. This might be done at configure time or with a switch passed to the build system, or even just using the definitions provided by the gdk headers.
     10
     11The main components of the port:
     12
     13=== Gtk+-specific modules ===
     14
     15 * Gtk+/Gtk UI platform: [http://trac.webkit.org/projects/webkit/browser/trunk/WebCore/platform/gtk WebCore/platform/gtk]
     16
     17 * "Page/Gtk": [http://trac.webkit.org/projects/webkit/browser/trunk/WebCore/page/gtk WebCore/page/gtk]
     18
     19 * "Loader/Gtk": [http://trac.webkit.org/projects/webkit/browser/trunk/WebCore/loader/gtk WebCore/loader/gtk]
     20
     21 * Public API: [http://trac.webkit.org/projects/webkit/browser/trunk/WebKit/gtk WebKit/gtk]
     22
     23 * GtkLauncher (example application): [http://trac.webkit.org/projects/webkit/browser/trunk/WebKitTools/GtkLauncher WebKitTools/GtkLauncher]
     24
     25There may be other gtk-port related directories which have yet to be listed here.
     26
     27=== Shared code modules ===
     28
     29While the Gtk+ port is the primary consumer of these backends, we aim to keep them portable, avoiding even ifdef'd sections specific to the Gtk+ port:
     30
     31 * curl http backend: [http://trac.webkit.org/projects/webkit/browser/trunk/WebCore/platform/network/curl WebCore/platform/network/curl]
     32
     33 * cairo graphics backend: [http://trac.webkit.org/projects/webkit/browser/trunk/WebCore/platform/graphics/cairo WebCore/platform/graphics/cairo]
     34
     35 * cairo graphics SVG backend: [http://trac.webkit.org/projects/webkit/browser/trunk/WebCore/platform/graphics/svg/cairo WebCore/platform/graphics/svg/cairo]
     36
     37== Current tasks (July '07) ==
     38
     39 * Make things work with debugging enabled (when NDEBUG is removed, assertions are triggered right now)
     40 * Fix animated GIF images -- consider using GdkPixbuf?
     41 * Continue to fix the curl backend
     42 * Start to consider consolidating the widget into a single place as the Qt port has done, and look into implementing eg. createFrame()
     43 * Look into supporting the canvas
     44 * Attempt to merge the Cairo code in the Win32 port -- the equivalent code is copy-and-pasted into the "Gdk" port in some places. This will help reduce code duplication but also help towards getting WebKit/Gdk/Gtk+ working on Windows
     45
     46
     47== Issues known ==
     48
     49=== CURL ===
     50 * Review and possibly integrate the [http://www.sand-labs.org/svn/trunk/BAL/Implementations/Network/CURL/ sand-labs CURL backend] code. It has a slightly different API, so needs to be back-ported, but looks like it may be more feature-complete, able to handle redirects properly etc.
     51 * The non zero select timeout feels bad. Make it possible to write a GSourceFunc to not poll the sockets and have a timeout: This can probably be done by integrating code from MIT/X11 licensed [http://atterer.net/glibcurl/ glibcurl].
     52 * Cookie handling is completely lacking as pointed out on the mailing list
     53 * Errors of curl need to be properly populated
     54
     55=== Gtk ===
     56 * A lot of classes are not yet implemented
     57 * For painting we have some issues in regard to Expose Events and when WebKit will call paint.
     58
     59=== Theming ===
     60 * Consider taking code directly from Mozilla's LGPL licensed Gtk+ theming backend. They deal with a lot of corner cases which don't look fun to re-implement.
     61 * Focus ring drawing
     62 * Scrollbars for PlatformScrollbar will be terrible as we need to implement a HitTest but don't know where the elements of the scrollbar hide
     63 * Native theming for text entries
     64 * Find a way to draw a GtkComboBox, at least the button part.  This is needed to implement theming of the <select> element properly.