Bug 12284 – Clean up the header guards

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

[Eric Seidel (no email)]

Everyone enjoys a good full-recompile every now and then.

It's like fiber.  Good for the system, and all that.

[Eric Seidel (no email)]

Created attachment 12456 [details]
do it

[Eric Seidel (no email)]

Created attachment 12458 [details]
better patch

[Rob Buis]

Comment on attachment 12458 [details]
better patch

Only issue is _h vs. _H, but apart from that looks fine.

[Eric Seidel (no email)]

Created attachment 12459 [details]
go whole-hog

What started as a small waste of time, turned into a big waste of time, ugh.

I compiled with andersca, weinig, and rwlbuis's request to change _H to _h.  I even updated the style guidelines to help with future consistency.  There are still a few strange guards in the editing files, but most all of the headers now have consistently named header guards.

[Darin Adler]

I'd like to see a script that fixes all the header guards that we could run from time to time. That could eliminate any future waste of time on this.

[Rob Buis]

Comment on attachment 12459 [details]
go whole-hog

IMHO the line between #ifndef and #define should go, as well as the empty line after that (bad regexp?).

Apart from that you probably want HTMLPARSER_h not too be all uppercase.

Finally it would be neat if #endif could comment the include header too (#endif // Foo_h)

[Eric Seidel (no email)]

I wrote one eons ago.  But at 4 am I didn't know where to find it.

I've since found it... or at least one partial version, attached to:
http://bugs.webkit.org/show_bug.cgi?id=10490

[Eric Seidel (no email)]

Created attachment 12467 [details]
updated patch

[Eric Seidel (no email)]

Created attachment 12468 [details]
a script to do this in the future

[Eric Seidel (no email)]

Created attachment 12469 [details]
real, working script.

[Eric Seidel (no email)]

Created attachment 12471 [details]
automatic changes from script

I just chucked the manual changes and beefed up the script.  An updated script coming in the next patch.

[Eric Seidel (no email)]

Created attachment 12472 [details]
even better script (with changelog!)

[Eric Seidel (no email)]

Created attachment 12473 [details]
now pimped out with spinners and neons, oh boy.  (and a --prefix option for darin)

[Eric Seidel (no email)]

I'll explain some of the ruby-isms in this script:

+options = {}
+OptionParser.new do |opts|

I'm not sure why ruby invented yet another OptionParser.  But yeah, it's pretty cool.  More powerful (and in some ways easier to use) than getoptlong once you get used to it.

Like so many things in ruby, it uses a block (the do, end block) and passes an object to that block (in the |args, go, here|).  the .new method calls "yield" to call that block with arguments.


+IgnoredFilenamePatterns = [
+  # ignore headers which are known not to have guard
+  /WebCorePrefix/, 
+  /ForwardingHeaders/,
+  %r|bindings/objc|, 
+  /vcproj/, # anything inside a vcproj is in the windows wasteland
+  
+  # we don't own any of these headers
+  %r|icu/unicode|,
+  %r|platform/graphics/cairo|,
+  %r|platform/image-decoders|,
+  
+  /config.h/ # changing this one sounds scary
+].freeze

I'm making an array of regexps there.  Then "freezing" it as a constant.  The freeze part is not absolutely required, but recommended.

+IgnoreFileNamesPattern = Regexp.union(*IgnoredFilenamePatterns).freeze

*array means "expand this array as though it were passed as arguments"
Regexp.union makes one big compiled regexp out of the array of regexps

+    match_results = contents.match(/#ifndef (\S+)\n#define \1/s)

This is a "MatchData" object, the objectified version of $0, $1, etc. (although those work in Ruby too)


+      new_guard = options[:prefix] + '_' + new_guard  if options[:prefix]

:foo is a "symbol" in ruby, an atomic string, basically.  string.to_sym and symbol.to_s can be used to convert back and forth.

+      contents.gsub!(current_guard, new_guard)

All methods with ! at the end of their name modify the caller.  (all methods with ? return a bool)

+      puts "Ignoring #{filename}, failed to find existing header guards."

#{} is the ruby way of variable substitution in strings.