Bug 38666 – Synchronize NPAPI headers with npapi-headers project

• Status: RESOLVED
• Resolution: FIXED
• Component: Plug-ins

[Stuart Morgan]

As mentioned recently on plugin-futures, there is a new central repository for NPAPI headers:
http://code.google.com/p/npapi-headers/
The hope is that everyone can converge back to a single set of standard headers, instead of each browser vendor's headers continuing to drift further apart, increasing confusion.

Even if browsers aren't able to share completely identical headers, the closer we can get the easier real differences will be to understand.

[Stuart Morgan]

Created attachment 55278 [details]
Non-substantive changes

This only changes:
- Whitespace
- Comments
- Order of code in the file
No actual code is changed.

This makes it much easier to see where there are real differences between the two versions.

(I know the whitespace of the npapi-headers version isn't perfect either, but the diff-ability is a big win, and once things are essentially reconciled whitespace and comment fixes can be made upstream and trivially pulled into all the browsers at the same time.)

[WebKit Review Bot]

Attachment 55278 [details] did not pass style-queue:

Failed to run "['WebKitTools/Scripts/check-webkit-style', '--no-squash']" exit_code: 1
Last 3072 characters of output:
y/naming] [4]
WebCore/bridge/npapi.h:765:  NPN_PluginThreadAsyncCall is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:766:  Extra space before ( in function call  [whitespace/parens] [4]
WebCore/bridge/npapi.h:768:  NPN_GetValueForURL is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:771:  NPN_SetValueForURL is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:774:  NPN_GetAuthenticationInfo is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:782:  NPN_ScheduleTimer is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:783:  NPN_UnscheduleTimer is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:784:  NPN_PopUpContextMenu is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:785:  NPN_ConvertPoint is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:121:  NPN_ReleaseVariantValue is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:140:  Use 0 instead of NULL.  [readability/null] [5]
WebCore/bridge/npruntime.h:146:  Use 0 instead of NULL.  [readability/null] [5]
WebCore/bridge/npruntime.h:224:  NPN_GetStringIdentifiers is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:349:  NPN_ReleaseObject is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:363:  NPN_Invoke is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:365:  NPN_InvokeDefault is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:367:  NPN_Evaluate is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:369:  NPN_GetProperty is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:371:  NPN_SetProperty is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:376:  NPN_Enumerate is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:378:  NPN_Construct is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npruntime.h:387:  NPN_SetException is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
Total errors found: 205 in 3 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Stuart Morgan]

Created attachment 55412 [details]
Change header guard to match upstream

[WebKit Review Bot]

Attachment 55412 [details] did not pass style-queue:

Failed to run "['WebKitTools/Scripts/check-webkit-style', '--no-squash']" exit_code: 1
WebCore/bridge/npapi.h:43:  #ifndef header guard has wrong style, please use: npapi_h  [build/header_guard] [5]
Total errors found: 1 in 2 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[WebKit Commit Bot]

Comment on attachment 55278 [details]
Non-substantive changes

Clearing flags on attachment: 55278

Committed r59035: <http://trac.webkit.org/changeset/59035>

[WebKit Commit Bot]

Comment on attachment 55412 [details]
Change header guard to match upstream

Clearing flags on attachment: 55412

Committed r59039: <http://trac.webkit.org/changeset/59039>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Stuart Morgan]

There's still more reconciling to be done.

[Stuart Morgan]

Created attachment 55622 [details]
Add/remove platform-specific code

- Remove obsolete XP_MAC sections.
- Remove Metrowerks defines.
- Add OS/2 defines.
- Add Maemo defines.
- Add new version of the custom Carbon event definitions.

[WebKit Review Bot]

Attachment 55622 [details] did not pass style-queue:

Failed to run "['WebKitTools/Scripts/check-webkit-style', '--no-squash']" exit_code: 1
Last 3072 characters of output:
f spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:472:  This { should be at the end of the previous line  [whitespace/braces] [4]
WebCore/bridge/npapi.h:473:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:474:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:475:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:476:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:477:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:478:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:479:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:480:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:481:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:482:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:483:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:484:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:526:  This { should be at the end of the previous line  [whitespace/braces] [4]
WebCore/bridge/npapi.h:527:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:528:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:529:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:669:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:670:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:671:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:672:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:673:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:674:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:675:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
Total errors found: 33 in 2 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Stuart Morgan]

Created attachment 56028 [details]
Add/remove platform-specific code (v2)

Patch updated to be more comprehensive. This is most of the rest of the differences between the upstream npapi.h and the WebKit version.

[WebKit Review Bot]

Attachment 56028 [details] did not pass style-queue:

Failed to run "['WebKitTools/Scripts/check-webkit-style', '--no-squash']" exit_code: 1
Last 3072 characters of output:
space/indent] [3]
WebCore/bridge/npapi.h:477:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:478:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:479:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:480:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:481:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:482:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:483:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:484:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:485:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:486:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:528:  This { should be at the end of the previous line  [whitespace/braces] [4]
WebCore/bridge/npapi.h:529:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:530:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:531:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:671:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:672:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:673:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:674:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:675:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:676:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:677:  Weird number of spaces at line-start.  Are you using a 4-space indent?  [whitespace/indent] [3]
WebCore/bridge/npapi.h:836:  NPN_UserAgent is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:837:  NPN_MemAlloc is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
WebCore/bridge/npapi.h:841:  NPN_GetJavaEnv is incorrectly named. Don't use underscores in your identifier names.  [readability/naming] [4]
Total errors found: 36 in 2 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Stuart Morgan]

In case the reason this isn't being reviewed is the big list of style violations: this is third-party code, where minimizing forking is beneficial, so those are expected.

[Anders Carlsson]

Comment on attachment 56028 [details]
Add/remove platform-specific code (v2)

Great job, r=me!

[WebKit Commit Bot]

Comment on attachment 56028 [details]
Add/remove platform-specific code (v2)

Clearing flags on attachment: 56028

Committed r61277: <http://trac.webkit.org/changeset/61277>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Stuart Morgan]

Most of what's left that's not trivial (i.e., "Not implemented in WebKit" comments) will have ripple effects outside the code, I've filed separate bugs for the remaining work:
Bug 40782
Bug 40783
Bug 40784
Bug 40785