57328 2011-03-29 05:05:06 -0700 Introspection: missing signal annotations 2017-03-11 10:47:40 -0800 1 1 1 Unclassified WebKit WebKitGTK 528+ (Nightly build) PC Linux UNCONFIRMED P2 Normal --- 0 shana.ufie webkit-unassigned bugs-noreply christian gustavo oldest_to_newest 375201 0 shana.ufie 2011-03-29 05:05:06 -0700 There are several signals on webframe and webview that are missing introspection annotations: On webframe: hovering-over-link on webview: should-begin-editing, should-end-editing, should-insert-node, should-insert-text, should-delete-range, should-show-delete-interface-for-element, should-change-selected-range, should-apply-style, set-scroll-adjustments 375245 1 87305 martin.pitt 2011-03-29 06:21:26 -0700 Created attachment 87305 add signal annotations This patch adds annotations for all remaining signals which don't have void arguments, so that they at least get proper argument names in the gir (instead of "object", "p0", "p1", etc.). Note that the ones added to webkitwebview.cpp are mostly just stubs which just get the signal name and data type of the arguments right. The actual description of the arguments is still (mostly) missing, as it's not easy to infer from just the signal name and type signature. In particular, I have no idea what the 4th bool argument of should-change-selected-range is about, so I added a "TODO" there -- this should probably be filled when committing the patch. But at least I now have no stub argument names any more: $ grep '="p0"' WebKit-1.0.gir $ Wrt. copyright, I don't really care; hereby I agree to hand over copyright to you, and release the patch under the standard webkit licenses. 378870 2 87305 gustavo 2011-04-04 10:37:59 -0700 Comment on attachment 87305 add signal annotations Thanks for the patch! To land the patch we need a ChangeLog entry you can generate with ./Tools/Scripts/prepare-ChangeLog (use --git-commit HEAD if you are using git and committed the changes). Also, you can keep your copyright, the WebKit project does not require copyright assignment, feel free to add your name to the header. Now for comments on the content: the addition of documentation for hovering-over-link is welcome. Do we really need to add documentation to set-scroll-adjustments, since it's actually being overriden from GtkWidget? As for the other signals, they are undocumented on purpose - their design is not finished, and they only exist for internal purposes at this point (for the test runner). These signals may change, so perhaps we would need to annotate them to be ignored. Marking r- for these reasons and for lack of ChangeLog, thanks for working on this! 378913 3 christian 2011-04-04 11:33:17 -0700 See bug 19456 for discussion on editing API. From my point of view the signals are not usable for applications in their current form. 379114 4 shana.ufie 2011-04-04 15:08:10 -0700 Thank you for the review, I need to thank Martin Pitt a lot for the great work in hunting down these annotations - I'm trying to get an updated webkit-sharp release out, this is very helpful to get a reliable binding going. The signals that should be ignored are all those listed on the bug mentioned on comment #3, right? Any others I should be mindful of? 385697 5 gustavo 2011-04-14 06:12:31 -0700 (In reply to comment #4) > Thank you for the review, I need to thank Martin Pitt a lot for the great work in hunting down these annotations - I'm trying to get an updated webkit-sharp release out, this is very helpful to get a reliable binding going. The signals that should be ignored are all those listed on the bug mentioned on comment #3, right? Any others I should be mindful of? In general we've been very strict about documenting new API, so if something is not documented it is either very old, or not intended for public usage as of yet. If in doubt feel free to ping me, mrobinson, xan or anyone else who's available in #webkit-gtk@FreeNode and we'll be happy to help =) 87305 2011-03-29 06:21:26 -0700 2011-04-04 10:37:59 -0700 add signal annotations webkit.missing-signal-annotations.patch text/plain 6665 martin.pitt SW5kZXg6IFNvdXJjZS9XZWJLaXQvZ3RrL3dlYmtpdC93ZWJraXR3ZWJmcmFtZS5jcHAKPT09PT09 PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09 PT09PQotLS0gU291cmNlL1dlYktpdC9ndGsvd2Via2l0L3dlYmtpdHdlYmZyYW1lLmNwcAkoUmV2 aXNpb24gODIyMjApCisrKyBTb3VyY2UvV2ViS2l0L2d0ay93ZWJraXQvd2Via2l0d2ViZnJhbWUu Y3BwCShBcmJlaXRza29waWUpCkBAIC0yNTAsNiArMjUwLDE0IEBACiAgICAgICAgICAgICBHX1RZ UEVfTk9ORSwgMSwKICAgICAgICAgICAgIEdfVFlQRV9TVFJJTkcpOwogCisgICAgLyoqCisgICAg ICogV2ViS2l0V2ViRnJhbWU6OmhvdmVyaW5nLW92ZXItbGluazoKKyAgICAgKiBAZnJhbWU6IHRo ZSBvYmplY3Qgb24gd2hpY2ggdGhlIHNpZ25hbCBpcyBlbWl0dGVkCisgICAgICogQHRpdGxlOiB0 aGUgbGluaydzIHRpdGxlCisgICAgICogQHVyaTogdGhlIFVSSSB0aGUgbGluayBwb2ludHMgdG8K KyAgICAgKgorICAgICAqIFdoZW4gdGhlIGN1cnNvciBpcyBvdmVyIGEgbGluaywgdGhpcyBzaWdu YWwgaXMgZW1pdHRlZC4KKyAgICAgKi8KICAgICB3ZWJraXRfd2ViX2ZyYW1lX3NpZ25hbHNbSE9W RVJJTkdfT1ZFUl9MSU5LXSA9IGdfc2lnbmFsX25ldygiaG92ZXJpbmctb3Zlci1saW5rIiwKICAg ICAgICAgICAgIEdfVFlQRV9GUk9NX0NMQVNTKGZyYW1lQ2xhc3MpLAogICAgICAgICAgICAgKEdT aWduYWxGbGFncylHX1NJR05BTF9SVU5fTEFTVCwKSW5kZXg6IFNvdXJjZS9XZWJLaXQvZ3RrL3dl YmtpdC93ZWJraXR3ZWJ2aWV3LmNwcAo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09Ci0tLSBTb3VyY2UvV2ViS2l0L2d0ay93 ZWJraXQvd2Via2l0d2Vidmlldy5jcHAJKFJldmlzaW9uIDgyMjIwKQorKysgU291cmNlL1dlYktp dC9ndGsvd2Via2l0L3dlYmtpdHdlYnZpZXcuY3BwCShBcmJlaXRza29waWUpCkBAIC0yNzI4LDQ0 ICsyNzI4LDkyIEBACiAgICAgICAgICAgICBHX1RZUEVfTk9ORSwgMSwKICAgICAgICAgICAgIFdF QktJVF9UWVBFX1dFQl9GUkFNRSk7CiAKKyAgICAvKioKKyAgICAgKiBXZWJLaXRXZWJWaWV3Ojpz aG91bGQtYmVnaW4tZWRpdGluZworICAgICAqIEB3ZWJWaWV3OiB0aGUgb2JqZWN0IHdoaWNoIHJl Y2VpdmVkIHRoZSBzaWduYWwKKyAgICAgKiBAcmFuZ2U6IHRoZSAjV2ViS2l0RE9NUmFuZ2UKKyAg ICAgKi8KICAgICB3ZWJraXRfd2ViX3ZpZXdfc2lnbmFsc1tTSE9VTERfQkVHSU5fRURJVElOR10g PSBnX3NpZ25hbF9uZXcoInNob3VsZC1iZWdpbi1lZGl0aW5nIiwKICAgICAgICAgR19UWVBFX0ZS T01fQ0xBU1Mod2ViVmlld0NsYXNzKSwgc3RhdGljX2Nhc3Q8R1NpZ25hbEZsYWdzPihHX1NJR05B TF9SVU5fTEFTVCB8IEdfU0lHTkFMX0FDVElPTiksCiAgICAgICAgIEdfU1RSVUNUX09GRlNFVChX ZWJLaXRXZWJWaWV3Q2xhc3MsIHNob3VsZF9hbGxvd19lZGl0aW5nX2FjdGlvbiksIGdfc2lnbmFs X2FjY3VtdWxhdG9yX2ZpcnN0X3dpbnMsIDAsCiAgICAgICAgIHdlYmtpdF9tYXJzaGFsX0JPT0xF QU5fX09CSkVDVCwgR19UWVBFX0JPT0xFQU4sIDEsIFdFQktJVF9UWVBFX0RPTV9SQU5HRSk7CiAK KyAgICAvKioKKyAgICAgKiBXZWJLaXRXZWJWaWV3OjpzaG91bGQtZW5kLWVkaXRpbmcKKyAgICAg KiBAd2ViVmlldzogdGhlIG9iamVjdCB3aGljaCByZWNlaXZlZCB0aGUgc2lnbmFsCisgICAgICog QHJhbmdlOiB0aGUgI1dlYktpdERPTVJhbmdlCisgICAgICovCiAgICAgd2Via2l0X3dlYl92aWV3 X3NpZ25hbHNbU0hPVUxEX0VORF9FRElUSU5HXSA9IGdfc2lnbmFsX25ldygic2hvdWxkLWVuZC1l ZGl0aW5nIiwgR19UWVBFX0ZST01fQ0xBU1Mod2ViVmlld0NsYXNzKSwKICAgICAgICAgc3RhdGlj X2Nhc3Q8R1NpZ25hbEZsYWdzPihHX1NJR05BTF9SVU5fTEFTVCB8IEdfU0lHTkFMX0FDVElPTiks CiAgICAgICAgIEdfU1RSVUNUX09GRlNFVChXZWJLaXRXZWJWaWV3Q2xhc3MsIHNob3VsZF9hbGxv d19lZGl0aW5nX2FjdGlvbiksIGdfc2lnbmFsX2FjY3VtdWxhdG9yX2ZpcnN0X3dpbnMsIDAsCiAg ICAgICAgIHdlYmtpdF9tYXJzaGFsX0JPT0xFQU5fX09CSkVDVCwgR19UWVBFX0JPT0xFQU4sIDEs IFdFQktJVF9UWVBFX0RPTV9SQU5HRSk7CiAKKyAgICAvKioKKyAgICAgKiBXZWJLaXRXZWJWaWV3 OjpzaG91bGQtaW5zZXJ0LW5vZGUKKyAgICAgKiBAd2ViVmlldzogdGhlIG9iamVjdCB3aGljaCBy ZWNlaXZlZCB0aGUgc2lnbmFsCisgICAgICogQG5vZGU6IHRoZSAjV2ViS2l0RE9NTm9kZSB0byBp bnNlcnQKKyAgICAgKiBAcmFuZ2U6IHRoZSAjV2ViS2l0RE9NUmFuZ2UKKyAgICAgKiBAYWN0aW9u OiB0aGUgI1dlYktpdEluc2VydEFjdGlvbgorICAgICAqLwogICAgIHdlYmtpdF93ZWJfdmlld19z aWduYWxzW1NIT1VMRF9JTlNFUlRfTk9ERV0gPSBnX3NpZ25hbF9uZXcoInNob3VsZC1pbnNlcnQt bm9kZSIsIEdfVFlQRV9GUk9NX0NMQVNTKHdlYlZpZXdDbGFzcyksIAogICAgICAgICBzdGF0aWNf Y2FzdDxHU2lnbmFsRmxhZ3M+KEdfU0lHTkFMX1JVTl9MQVNUIHwgR19TSUdOQUxfQUNUSU9OKSwK ICAgICAgICAgR19TVFJVQ1RfT0ZGU0VUKFdlYktpdFdlYlZpZXdDbGFzcywgc2hvdWxkX2FsbG93 X2VkaXRpbmdfYWN0aW9uKSwgZ19zaWduYWxfYWNjdW11bGF0b3JfZmlyc3Rfd2lucywgMCwKICAg ICAgICAgd2Via2l0X21hcnNoYWxfQk9PTEVBTl9fT0JKRUNUX09CSkVDVF9FTlVNLCBHX1RZUEVf Qk9PTEVBTiwKICAgICAgICAgMywgV0VCS0lUX1RZUEVfRE9NX05PREUsIFdFQktJVF9UWVBFX0RP TV9SQU5HRSwgV0VCS0lUX1RZUEVfSU5TRVJUX0FDVElPTik7CiAKKyAgICAvKioKKyAgICAgKiBX ZWJLaXRXZWJWaWV3OjpzaG91bGQtaW5zZXJ0LXRleHQKKyAgICAgKiBAd2ViVmlldzogdGhlIG9i amVjdCB3aGljaCByZWNlaXZlZCB0aGUgc2lnbmFsCisgICAgICogQHRleHQ6IHRleHQgdG8gaW5z ZXJ0CisgICAgICogQHJhbmdlOiB0aGUgI1dlYktpdERPTVJhbmdlCisgICAgICogQGFjdGlvbjog dGhlICNXZWJLaXRJbnNlcnRBY3Rpb24KKyAgICAgKi8KICAgICB3ZWJraXRfd2ViX3ZpZXdfc2ln bmFsc1tTSE9VTERfSU5TRVJUX1RFWFRdID0gZ19zaWduYWxfbmV3KCJzaG91bGQtaW5zZXJ0LXRl eHQiLCBHX1RZUEVfRlJPTV9DTEFTUyh3ZWJWaWV3Q2xhc3MpLAogICAgICAgICBzdGF0aWNfY2Fz dDxHU2lnbmFsRmxhZ3M+KEdfU0lHTkFMX1JVTl9MQVNUIHwgR19TSUdOQUxfQUNUSU9OKSwKICAg ICAgICAgR19TVFJVQ1RfT0ZGU0VUKFdlYktpdFdlYlZpZXdDbGFzcywgc2hvdWxkX2FsbG93X2Vk aXRpbmdfYWN0aW9uKSwgZ19zaWduYWxfYWNjdW11bGF0b3JfZmlyc3Rfd2lucywgMCwKICAgICAg ICAgd2Via2l0X21hcnNoYWxfQk9PTEVBTl9fU1RSSU5HX09CSkVDVF9FTlVNLCBHX1RZUEVfQk9P TEVBTiwKICAgICAgICAgMywgR19UWVBFX1NUUklORywgV0VCS0lUX1RZUEVfRE9NX1JBTkdFLCBX RUJLSVRfVFlQRV9JTlNFUlRfQUNUSU9OKTsKIAorICAgIC8qKgorICAgICAqIFdlYktpdFdlYlZp ZXc6OnNob3VsZC1kZWxldGUtcmFuZ2UKKyAgICAgKiBAd2ViVmlldzogdGhlIG9iamVjdCB3aGlj aCByZWNlaXZlZCB0aGUgc2lnbmFsCisgICAgICogQHJhbmdlOiB0aGUgI1dlYktpdERPTVJhbmdl CisgICAgICovCiAgICAgd2Via2l0X3dlYl92aWV3X3NpZ25hbHNbU0hPVUxEX0RFTEVURV9SQU5H RV0gPSBnX3NpZ25hbF9uZXcoInNob3VsZC1kZWxldGUtcmFuZ2UiLCBHX1RZUEVfRlJPTV9DTEFT Uyh3ZWJWaWV3Q2xhc3MpLAogICAgICAgICBzdGF0aWNfY2FzdDxHU2lnbmFsRmxhZ3M+KEdfU0lH TkFMX1JVTl9MQVNUIHwgR19TSUdOQUxfQUNUSU9OKSwKICAgICAgICAgR19TVFJVQ1RfT0ZGU0VU KFdlYktpdFdlYlZpZXdDbGFzcywgc2hvdWxkX2FsbG93X2VkaXRpbmdfYWN0aW9uKSwgZ19zaWdu YWxfYWNjdW11bGF0b3JfZmlyc3Rfd2lucywgMCwKICAgICAgICAgd2Via2l0X21hcnNoYWxfQk9P TEVBTl9fT0JKRUNULCBHX1RZUEVfQk9PTEVBTiwgMSwgV0VCS0lUX1RZUEVfRE9NX1JBTkdFKTsK IAorICAgIC8qKgorICAgICAqIFdlYktpdFdlYlZpZXc6OnNob3VsZC1zaG93LWRlbGV0ZS1pbnRl cmZhY2UtZm9yLWVsZW1lbnQKKyAgICAgKiBAd2ViVmlldzogdGhlIG9iamVjdCB3aGljaCByZWNl aXZlZCB0aGUgc2lnbmFsCisgICAgICogQGVsZW1lbnQ6IHRoZSAjV2ViS2l0RE9NSFRNTEVsZW1l bnQKKyAgICAgKi8KICAgICB3ZWJraXRfd2ViX3ZpZXdfc2lnbmFsc1tTSE9VTERfU0hPV19ERUxF VEVfSU5URVJGQUNFX0ZPUl9FTEVNRU5UXSA9IGdfc2lnbmFsX25ldygic2hvdWxkLXNob3ctZGVs ZXRlLWludGVyZmFjZS1mb3ItZWxlbWVudCIsCiAgICAgICAgIEdfVFlQRV9GUk9NX0NMQVNTKHdl YlZpZXdDbGFzcyksIHN0YXRpY19jYXN0PEdTaWduYWxGbGFncz4oR19TSUdOQUxfUlVOX0xBU1Qg fCBHX1NJR05BTF9BQ1RJT04pLAogICAgICAgICBHX1NUUlVDVF9PRkZTRVQoV2ViS2l0V2ViVmll d0NsYXNzLCBzaG91bGRfYWxsb3dfZWRpdGluZ19hY3Rpb24pLCBnX3NpZ25hbF9hY2N1bXVsYXRv cl9maXJzdF93aW5zLCAwLAogICAgICAgICB3ZWJraXRfbWFyc2hhbF9CT09MRUFOX19PQkpFQ1Qs IEdfVFlQRV9CT09MRUFOLCAxLCBXRUJLSVRfVFlQRV9ET01fSFRNTF9FTEVNRU5UKTsKIAorICAg IC8qKgorICAgICAqIFdlYktpdFdlYlZpZXc6OnNob3VsZC1jaGFuZ2Utc2VsZWN0ZWQtcmFuZ2UK KyAgICAgKiBAd2ViVmlldzogdGhlIG9iamVjdCB3aGljaCByZWNlaXZlZCB0aGUgc2lnbmFsCisg ICAgICogQG9sZHJhbmdlOiBvbGQgI1dlYktpdERPTVJhbmdlCisgICAgICogQG5ld3JhbmdlOiBu ZXcgI1dlYktpdERPTVJhbmdlCisgICAgICogQGFmZmluaXR5OiB0aGUgI1dlYktpdFNlbGVjdGlv bkFmZmluaXR5CisgICAgICogQGZsYWc6IFRPRE86IGRvY3VtZW50CisgICAgICovCiAgICAgd2Vi a2l0X3dlYl92aWV3X3NpZ25hbHNbU0hPVUxEX0NIQU5HRV9TRUxFQ1RFRF9SQU5HRV0gPSBnX3Np Z25hbF9uZXcoInNob3VsZC1jaGFuZ2Utc2VsZWN0ZWQtcmFuZ2UiLAogICAgICAgICBHX1RZUEVf RlJPTV9DTEFTUyh3ZWJWaWV3Q2xhc3MpLCBzdGF0aWNfY2FzdDxHU2lnbmFsRmxhZ3M+KEdfU0lH TkFMX1JVTl9MQVNUIHwgR19TSUdOQUxfQUNUSU9OKSwKICAgICAgICAgR19TVFJVQ1RfT0ZGU0VU KFdlYktpdFdlYlZpZXdDbGFzcywgc2hvdWxkX2FsbG93X2VkaXRpbmdfYWN0aW9uKSwgZ19zaWdu YWxfYWNjdW11bGF0b3JfZmlyc3Rfd2lucywgMCwKICAgICAgICAgd2Via2l0X21hcnNoYWxfQk9P TEVBTl9fT0JKRUNUX09CSkVDVF9FTlVNX0JPT0xFQU4sIEdfVFlQRV9CT09MRUFOLAogICAgICAg ICAgNCwgV0VCS0lUX1RZUEVfRE9NX1JBTkdFLCBXRUJLSVRfVFlQRV9ET01fUkFOR0UsIFdFQktJ VF9UWVBFX1NFTEVDVElPTl9BRkZJTklUWSwgR19UWVBFX0JPT0xFQU4pOwogCisgICAgLyoqCisg ICAgICogV2ViS2l0V2ViVmlldzo6c2hvdWxkLWFwcGx5LXN0eWxlCisgICAgICogQHdlYlZpZXc6 IHRoZSBvYmplY3Qgd2hpY2ggcmVjZWl2ZWQgdGhlIHNpZ25hbAorICAgICAqIEBzdHlsZTogdGhl ICNXZWJLaXRET01DU1NTdHlsZURlY2xhcmF0aW9uCisgICAgICogQHJhbmdlOiB0aGUgI1dlYktp dERPTVJhbmdlCisgICAgICovCiAgICAgd2Via2l0X3dlYl92aWV3X3NpZ25hbHNbU0hPVUxEX0FQ UExZX1NUWUxFXSA9IGdfc2lnbmFsX25ldygic2hvdWxkLWFwcGx5LXN0eWxlIiwKICAgICAgICAg R19UWVBFX0ZST01fQ0xBU1Mod2ViVmlld0NsYXNzKSwgc3RhdGljX2Nhc3Q8R1NpZ25hbEZsYWdz PihHX1NJR05BTF9SVU5fTEFTVCB8IEdfU0lHTkFMX0FDVElPTiksCiAgICAgICAgIEdfU1RSVUNU X09GRlNFVChXZWJLaXRXZWJWaWV3Q2xhc3MsIHNob3VsZF9hbGxvd19lZGl0aW5nX2FjdGlvbiks IGdfc2lnbmFsX2FjY3VtdWxhdG9yX2ZpcnN0X3dpbnMsIDAsCkBAIC0yOTEyLDYgKzI5NjAsMTUg QEAKICAgICAgKi8KICNpZmRlZiBHVEtfQVBJX1ZFUlNJT05fMgogICAgIHdlYlZpZXdDbGFzcy0+ c2V0X3Njcm9sbF9hZGp1c3RtZW50cyA9IHdlYmtpdF93ZWJfdmlld19zZXRfc2Nyb2xsX2FkanVz dG1lbnRzOworCisgICAgLyoqCisgICAgICogV2ViS2l0V2ViVmlldzo6c2V0LXNjcm9sbC1hZGp1 c3RtZW50cworICAgICAqIEB3ZWJWaWV3OiB0aGUgb2JqZWN0IG9uIHdoaWNoIHRoZSBzaWduYWwg aXMgZW1pdHRlZAorICAgICAqIEBoYWRqdXN0bWVudDogdGhlIGhvcml6b250YWwgYWRqdXN0bWVu dAorICAgICAqIEB2YWRqdXN0bWVudDogdGhlIHZlcnRpY2FsIGFkanVzdG1lbnQKKyAgICAgKgor ICAgICAqIFNldCB0aGUgc2Nyb2xsIGFkanVzdG1lbnRzIGZvciB0aGUgd2ViIHZpZXcuCisgICAg ICovCiAgICAgR1RLX1dJREdFVF9DTEFTUyh3ZWJWaWV3Q2xhc3MpLT5zZXRfc2Nyb2xsX2FkanVz dG1lbnRzX3NpZ25hbCA9IGdfc2lnbmFsX25ldygic2V0LXNjcm9sbC1hZGp1c3RtZW50cyIsCiAg ICAgICAgICAgICBHX1RZUEVfRlJPTV9DTEFTUyh3ZWJWaWV3Q2xhc3MpLAogICAgICAgICAgICAg KEdTaWduYWxGbGFncykoR19TSUdOQUxfUlVOX0xBU1QgfCBHX1NJR05BTF9BQ1RJT04pLAo=