Bug 195754 – Move CommonCrypto SPI declarations to an appropriate PAL/spi header

• Status: RESOLVED
• Resolution: FIXED
• Component: WebCore Misc.

[Brent Fulgham]

Tidy up the CoreCrypto implementation by moving the forward declarations of SPI functions into an appropriate PAL/spi location.

[Brent Fulgham]

<rdar://problem/48591957>

[Brent Fulgham]

Created attachment 364674 [details]
Patch

[EWS Watchlist]

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


ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:28:  Misplaced OS version check. Please use a named macro in wtf/Platform.h, wtf/FeatureDefines.h, or an appropriate internal file.  [build/version_check] [5]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:56:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:57:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:62:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:63:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:64:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:91:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:92:  enum members should use InterCaps with an initial capital letter or initial 'k' for C-style enums.  [readability/enum_casing] [4]
ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:105:  Misplaced OS version check. Please use a named macro in wtf/Platform.h, wtf/FeatureDefines.h, or an appropriate internal file.  [build/version_check] [5]
Total errors found: 9 in 6 files


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

[Brent Fulgham]

(In reply to Build Bot from comment #3)
> Attachment 364674 [details] did not pass style-queue:
> 
> 
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:28:  Misplaced OS
> version check. Please use a named macro in wtf/Platform.h,
> wtf/FeatureDefines.h, or an appropriate internal file. 
> [build/version_check] [5]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:56:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:57:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:62:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:63:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:64:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:91:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:92:  enum members
> should use InterCaps with an initial capital letter or initial 'k' for
> C-style enums.  [readability/enum_casing] [4]
> ERROR: Source/WebCore/PAL/pal/spi/cocoa/CommonCryptoSPI.h:105:  Misplaced OS
> version check. Please use a named macro in wtf/Platform.h,
> wtf/FeatureDefines.h, or an appropriate internal file. 
> [build/version_check] [5]
> Total errors found: 9 in 6 files
> 
> 
> If any of these errors are false positives, please file a bug against
> check-webkit-style.

These style violations are because these are SPI declarations.

[Jiewen Tan]

Comment on attachment 364674 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=364674&action=review

Thanks Brent for making this change. Really appreciate it. r=me.

> Source/WebCore/ChangeLog:3
> +        Move CoreCrypto SPI declarations to an appropriate PAL/spi header

CommonCrypto will be more appropriate.

> Source/WebCore/ChangeLog:9
> +        Move the forward declarations of various CoreCrypto SPI to an appropriate PAL/spi header.

Ditto.

> Source/WebCore/PAL/ChangeLog:3
> +        Move CoreCrypto SPI declarations to an appropriate PAL/spi header

Ditto.

> Source/WebCore/PAL/ChangeLog:9
> +        Move the forward declarations of various CoreCrypto SPI to an appropriate PAL/spi header.

Ditto.

[Brent Fulgham]

Comment on attachment 364674 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=364674&action=review

>> Source/WebCore/ChangeLog:3
>> +        Move CoreCrypto SPI declarations to an appropriate PAL/spi header
> 
> CommonCrypto will be more appropriate.

Doh! Will fix (in all the places)

[Brent Fulgham]

Committed r242963: <https://trac.webkit.org/changeset/242963>

[Ryan Haddad]

Reverted r242963 for reason:

Breaks watchOS build.

Committed r242977: <https://trac.webkit.org/changeset/242977>

[Ryan Haddad]

Details in radar.

[Brent Fulgham]

Created attachment 364732 [details]
Patch for landing

[Jiewen Tan]

Comment on attachment 364732 [details]
Patch for landing

View in context: https://bugs.webkit.org/attachment.cgi?id=364732&action=review

> Source/WebCore/crypto/CommonCryptoUtilities.h:40
> +typedef struct _CCBigNumRef *CCBigNumRef;

Maybe this needs to be outside of namespace WebCore?

[WebKit Commit Bot]

The commit-queue encountered the following flaky tests while processing attachment 364732 [details]:

legacy-animation-engine/compositing/layer-creation/mismatched-rotated-transform-transition-overlap.html bug 195787 (authors: [e-mail] and [e-mail])
The commit-queue is continuing to process your patch.

[WebKit Commit Bot]

Comment on attachment 364732 [details]
Patch for landing

Clearing flags on attachment: 364732

Committed r242981: <https://trac.webkit.org/changeset/242981>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.

[Darin Adler]

Comment on attachment 364732 [details]
Patch for landing

View in context: https://bugs.webkit.org/attachment.cgi?id=364732&action=review

> Source/WebCore/crypto/mac/CryptoAlgorithmHKDFMac.cpp:44
> +#pragma clang diagnostic push
> +#pragma clang diagnostic ignored "-Wdeprecated-declarations"

Please use ALLOW_DEPRECATED_DECLARATIONS_BEGIN/END instead of using #pragma clang directly.

[Brent Fulgham]

Reopening to attach new patch.

[Brent Fulgham]

Created attachment 364760 [details]
Patch for landing

[Brent Fulgham]

(In reply to Darin Adler from comment #15)
> Comment on attachment 364732 [details]
> Patch for landing
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=364732&action=review
> 
> > Source/WebCore/crypto/mac/CryptoAlgorithmHKDFMac.cpp:44
> > +#pragma clang diagnostic push
> > +#pragma clang diagnostic ignored "-Wdeprecated-declarations"
> 
> Please use ALLOW_DEPRECATED_DECLARATIONS_BEGIN/END instead of using #pragma
> clang directly.

Will do!

[Brent Fulgham]

Created attachment 364762 [details]
Patch for landing

[Brent Fulgham]

Created attachment 364763 [details]
Patch for landing

[Brent Fulgham]

Created attachment 364764 [details]
Patch for landing

[WebKit Commit Bot]

Comment on attachment 364764 [details]
Patch for landing

Clearing flags on attachment: 364764

Committed r242988: <https://trac.webkit.org/changeset/242988>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.