Bug 173765 – [GTK] Introspection: webkit_web_view_new_with_related_view needs to be marked as a constructor

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKitGTK

[Matijs van Zuijlen]

The webkit_web_view_new_with_related_view function works as a constructor, but gobject-introspection marks it as a method, possibly due to its first parameter. Please consider annotating it as a constructor.

This function is currently defined here: https://trac.webkit.org/browser/webkit/trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebViewGtk.cpp#L210

This report is a follow-up from this comment on a bug in Ruby-GNOME2: https://github.com/ruby-gnome2/ruby-gnome2/pull/1028#issuecomment-299650859

[Michael Catanzaro]

Hm, maybe we should use this annotation for all constructors, just to be on the safe side.

[Michael Catanzaro]

OK, I see the problem here is only because the first parameter is of the same type as the class, so this is probably the only problematic constructor in our API and it's not very likely we would accidentally add another in the future.

Unfortunately it's a significant introspection API break, and I've no doubt changing it will break some real applications. But the status quo is obviously broken, so I guess anyone who has used this constructor so far and not reported the breakage will just have to deal with it.

[Michael Catanzaro]

Created attachment 313764 [details]
Patch

[Michael Catanzaro]

I think it's going to need to be called out in the 2.18 release notes and not backported.

[Build Bot]

Thanks for the patch. If this patch contains new public API please make sure it follows the guidelines for new WebKit2 GTK+ API. See http://trac.webkit.org/wiki/WebKitGTK/AddingNewWebKit2API

[Carlos Garcia Campos]

WPE doesn't support introspection yet.

[Michael Catanzaro]

Created attachment 313785 [details]
Patch

[WebKit Commit Bot]

Comment on attachment 313785 [details]
Patch

Clearing flags on attachment: 313785

Committed r218787: <http://trac.webkit.org/changeset/218787>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Matijs van Zuijlen]

Awesome. Thanks for the quick response!