Bug 184376 – [WPE] Improve include hierarchy

• Status: RESOLVED
• Resolution: FIXED
• Component: WPE WebKit

[Michael Catanzaro]

Currently we have:

/usr/include/wpe-0.1/WPE/JavaScriptCore (see bug #184375)
/usr/include/wpe-0.1/WPE/jsc
/usr/include/wpe-0.1/WPE/wpe

And in the pkg-config:

Cflags: -I${includedir}/wpe-0.1 -I${includedir}/wpe-0.1/WPE

In contrast to WebKitGTK+:

/usr/include/webkit2gtk-4.0/JavaScriptCore
/usr/include/webkit2gtk-4.0/jsc (hopefully, haven't checked trunk :)
/usr/include/webkit2gtk-4.0/webkit2
/usr/include/webkit2gtk-4.0/webkitdom

Cflags: -I${includedir}/webkitgtk-4.0

It's desirable to eliminate the unnecessary WPE subdirectory. In theory, this could cause problems if WebKitGTK+ and WPE ever get pulled into the same include path, since the jsc headers could conflict, but such a case is guaranteed to explode at runtime due to symbol collisions, so this shouldn't ever be a problem in practice.

[Michael Catanzaro]

(In reply to Michael Catanzaro from comment #0)
> In theory,
> this could cause problems if WebKitGTK+ and WPE ever get pulled into the
> same include path, since the jsc headers could conflict

Sorry, I wasn't thinking properly. There's no difference because wpe-0.1/WPE was already previously in the Cflags.

[Michael Catanzaro]

Created attachment 337411 [details]
Patch

[Michael Catanzaro]

This will break any applications including headers as:

#include <WPE/wpe/webkit.h>

rather than:

#include <wpe/webkit.h>

Now only the later style is permitted.

[Michael Catanzaro]

This kinda-sorta conflicts with https://github.com/WebPlatformForEmbedded/WPEBackend/issues/10. It should be "fine" as in no build failures, but it's going to result in the headers being installed into the same place. We should still do this, but I further suggest switching WebKit from using /usr/include/wpe-0.1 to /usr/include/wpe-webkit-0.1 to further disambiguate.

Alternative schemes are possible, of course.

[Michael Catanzaro]

Let's change the include path to use wpe-webkit-0.1 instead of wpe-0.1, so we can have separate API versions for WebKit and libwpe.

[Michael Catanzaro]

Created attachment 337568 [details]
Patch

[WebKit Commit Bot]

Comment on attachment 337568 [details]
Patch

Clearing flags on attachment: 337568

Committed r230576: <https://trac.webkit.org/changeset/230576>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.