Bug 163575 – check-webkit-style: fix false-positive warnings about using #pragma once header guard

• Component: Tools / Tests
• Status: RESOLVED FIXED

[Megan Gardner]

The style guide gave me false positives for errors in TestRunnerWKWebView.h and WKWebViewPrivate.h about the #pragma once header guards. Not needed because of obj-c #import.

[Joseph Pecoraro]

Ooo good point... I wonder if we can tell if such a file will be ObjC/ObjC++.

We could employ heuristics like "if there is an #import".

[Brady Eidson]

I think the simple solution is to detect *if* there is a header guard, *then* it has to be pragma once.

Headers without guards are clearly okay (as if they weren't okay then the builds would be failing)

[Joseph Pecoraro]

> Headers without guards are clearly okay (as if they weren't okay then the
> builds would be failing)

It would be nice to detect and warn when a header is missing header guards that _should_ have header guards. A build may succeed if its missing, but later when someone else double includes the header it could fail.

That said, your suggestion should catch the majority of cases. Patch coming.

[Joseph Pecoraro]

Created attachment 292084 [details]
[PATCH] Proposed Fix

[Brady Eidson]

(In reply to comment #3)
> > Headers without guards are clearly okay (as if they weren't okay then the
> > builds would be failing)
> 
> It would be nice to detect and warn when a header is missing header guards
> that _should_ have header guards. A build may succeed if its missing, but
> later when someone else double includes the header it could fail.

Yah, I guess that was the unspoken subtext of what I meant.

I also am not sure what the actual compiler error is when you double include a header - Whether it's unintelligible random errors, or if the compiler explicitly points it out.

In the later case, I think it'd be fine to just ignore it until an error pops up.

[Brady Eidson]

Comment on attachment 292084 [details]
[PATCH] Proposed Fix

lgtm

[WebKit Commit Bot]

Comment on attachment 292084 [details]
[PATCH] Proposed Fix

Clearing flags on attachment: 292084

Committed r207559: <http://trac.webkit.org/changeset/207559>

[WebKit Commit Bot]

All reviewed patches have been landed.  Closing bug.