EFL Port of WebKit

About EFL

The ​Enlightenment Foundation Libraries (EFL for short) are a set of graphical libraries intended to provide easy-to-use resources for building rich user interfaces based applications. It is the core of the ​Enlightenment (E17) desktop shell and window manager. As mentioned in Enlightenment's official web site, "the libraries are meant to be portable and optimized to be functional even on devices such as mobile devices". Its core components are:

• Evas: Highly optimized raster canvas, supports software or hardware accelerated rendering
• Edje: Declarative UI library, provides rich theme
• Ecore: Event loop and utility classes to interface with system (X, DirectFB, Cocoa...)
• Eina: Basic data types

About the port

WebKit/EFL is a project aiming at porting WebKit to the Enlightenment Foundation Libraries. The port shares code with the GTK+ one, as we also use Cairo for rendering and LibSoup for networking.

Status

The port is being developed and maintained by ​ProFUSION, ​Samsung and ​Intel. An early version was started by ​INdT/OpenBossa, but it was changed significantly before inclusion in SVN (see their initial announcement at ​0.1 version (Jun/16/2009)). The current version is quite complete, featuring:

• Embedding API mostly consistent w/ Gtk, but following EFL naming scheme and conventions (such as usage of Evas Smart Objects and its callbacks);
• Theme support per Web Frame;
• Most of HTML5 features (video is missing);
• Various delegates to allow full customization of Pop-up and Context menus;
• Most of page settings (auto load images, disable flash or javascript, etc);
• Override-able input handling, allowing custom mouse and keyboard behavior;
• Override-able backing store, allows extensions such as tiled backing store or off screen rendering.

Future plans:

• NSAPI plugins, using windowless systems for integration into Evas;
• HTML5 feature completion (video, geolocation);
• Improving API coverage, exposing more features such as the Editor and Inspector clients;
• Exposing DOM;
• WebKit2 support.

Other desired features:

• Elementary widget wrapping up ewk_view into a convenient widget, providing default implementation for delegates;
• Remove strict X11 dependency, allowing DirectFB and FB at least;
• Less dependency on GNOME technologies, maybe remove Cairo and exchange LibSoup for an EFL-based network backend.

BuildBot

Samsung and Intel are maintaing 64bit Linux Release and 64bit Linux Debug Buildbots.

Getting the source

The port is entirely in the official SVN repository. Please follow the ​usual instructions for obtaining WebKit's source code.

Development

Dependencies

Below is a list of Debian package names you will need to install.

• bison (v2.4.1+)
• cmake (v2.8.3+)
• flex (v2.5.34+)
• gperf (v3.0.3+)
• gtk-doc-tools
• subversion
• ruby (v1.8.7+)
• g++

• libicu-dev
• libxslt1-dev
• libsqlite3-dev
• libjpeg-dev
• libpng-dev
• libxt-dev
• libgl1-mesa-dev
• libgnutls-dev (v2.12.14+)
• libdbus-1-dev
• libudev-dev
• liblua5.1-0-dev
• ragel (for harfbuzz)
• libfreetype6-dev
• libffi-dev
• libtiff4-dev
• libenchant-dev
• libxcomposite-dev
• libatk1.0-dev
• libtheora-dev
• libvorbis-dev
• libfaad-dev
• libpulse-dev
• libxrender-dev

sudo apt-get install bison cmake flex g++ gperf gtk-doc-tools subversion ruby libicu-dev libxslt1-dev libsqlite3-dev libjpeg-dev libpng-dev libxt-dev libgl1-mesa-dev libgnutls-dev libdbus-1-dev libudev-dev liblua5.1-0-dev ragel libfreetype6-dev libffi-dev libtiff4-dev libenchant-dev libxcomposite-dev libatk1.0-dev libtheora-dev libvorbis-dev libfaad-dev libpulse-dev libxrender-dev

If for some reason, you're not planning to use the dependencies for the EFL port that are pulled in via jhbuild, please make sure that (after ​bug 91864 lands you have an installed version of harfbuzz-ng on your system as well. Unfortunately, it usually doesn't come packaged with your distro, so grab it from ​http://www.freedesktop.org/software/harfbuzz/release/harfbuzz-0.9.2.tar.bz2 , build and install it manually.

About unstable dependencies requirement

The webkit-gtk folks have bumped the needed dependency some time ago to an unstable libsoup version (they track GNOME's release cycle). As we share the backend's code, we have to follow the required versions.

For our needs, at least following versions will do:

• glib >= 2.31.8
• glib-networking >= 2.33.2
• libsoup >= 2.39.4.1

Build and Install

The port can be built using WebKit's ​default build-webkit script. By default, WebKit will be built in the WebKitBuild/<release type> directory, where <release type> is either Release or Debug. To override the default settings, you can set the WEBKITOUTPUTDIR environment variable to set a different build location.

After having ​checked out the source code, run the script, which will take care of calling both CMake and make.

Dependencies

WebKit EFL makes it easy to pull in dependencies using jhbuild. Before your first build, depending on your OS and installed libs, you need to retrieve the dependencies. You can do that manually by calling

WebKit$ ./Tools/Scripts/update-webkitefl-libs

or alternatively by adding the parameter

--update-efl

to the build-webkit command below.

Building

WebKit$ ./Tools/Scripts/build-webkit --efl [--update-efl]

A variety of features can be enabled or disabled by the build-webkit script, pass the --help argument to it to see all possible options (please notice some options have no effect as they depend on features which have not been implemented on the port yet):

WebKit$ ./Tools/Scripts/build-webkit --help
WebKit$ ./Tools/Scripts/build-webkit --efl --debug --prefix=/opt/webkit-efl --makeargs="-j8" --no-svg --page-visibility-api

It is also possible to pass extra arguments directly to CMake by using the --cmakeargs option.

WebKit$ ./Tools/Scripts/build-webkit --efl --cmakeargs="-DCMAKE_CXX_COMPILER=/opt/c++ -DCMAKE_PREFIX_PATH=/usr/local -DCMAKE_VERBOSE_MAKEFILE=TRUE"

To create a build with WebKit2-only support (no WebKit1) use the following:

WebKit$ ./Tools/Scripts/build-webkit --efl --cmakeargs="-DENABLE_WEBKIT=OFF"

As with any CMake project, it is later possible to edit the existing build configuration by using tools such as ccmake or cmake-gui.

WebKit$ ./Tools/Scripts/build-webkit --efl --debug
WebKit$ cd WebKitBuild/Debug
WebKit/WebKitBuild/Debug$ cmake-gui . # Change a few options
WebKit/WebKitBuild/Debug$ make # Build again

Building WebKit faster

• ​building WebKit faster by Thiago Marcos P. Santos

The SHARED_CORE option

By default, internal WebKit libraries such as JavaScriptCore and WebCore are built as static libraries and linked into the libewebkit shared library, which is the actual port library. It is also possible to build all libraries as shared libraries, which reduces link time and memory consumption but has a slight performance hit during application startup (obviously, all the shared libraries then need to be distributed and installed).

In order to enable the SHARED_CORE option, pass --cmakeargs="-DSHARED_CORE=ON" to the built-webkit` script.

WebKit$ ./Tools/Scripts/build-webkit --efl --cmakeargs="-DSHARED_CORE=ON"

API Unit Tests

• WebKitEFL Unit Tests

LayoutTests

• WebKitEFL LayoutTest

Coding Style

• Coding Style of WebKit EFL port

Questions, feedback

If you have questions please join #webkit, #webkit-efl or #edevelop on irc.freenode.net. You may ask k-s, antognolli, acidx, demarchi, rakuco, gyuyoung or other developer there.

• IRC: #webkit, #webkit-efl on irc.freenode.net
• The ​webkit-efl mailing list (development discussion, low traffic)

Information about API

• WebKitEFL History API
• WebkitEFL Settings API
• WebkitEFL Cookies API
• WebKit2-EFL Text Checker API usage
• Ewk_frame tutorial

Using Web Inspector

• Web Inspector can be opened by pressing 'ctrl + i' on a web page. (for EWebLauncher/MiniBrowser)
• Remote Web Inspector. (for MiniBrowser only)
  • The server listens on port 2999 by default. IP address of the server can be set in 'WEBKIT_INSPECTOR_SERVER'. (for example export WEBKIT_INSPECTOR_SERVER="127.0.0.1:2999")