From: The Squid Software Foundation <>
Date: Wed, 2 Oct 2013 01:21:11 +0000 (-0600)
Subject: A script to add or update C/C++ boilerplate.
X-Git-Tag: SQUID_3_5_0_1~98^2~16
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a53382b445f80b538337d80eef5c6572d9e6dfa6;p=thirdparty%2Fsquid.git

A script to add or update C/C++ boilerplate.

Needs more work to handle more common cases.
---

diff --git a/scripts/source-mangler.pl b/scripts/source-mangler.pl
new file mode 100755
index 0000000000..c042695a22
--- /dev/null
+++ b/scripts/source-mangler.pl
@@ -0,0 +1,104 @@
+#!/usr/bin/perl -w
+
+# Adds or adjust the source file boilerplate, such as a Copyright statement.
+# The boilerplate does not change from one source file to another and is
+# assumed to be the first /* comment */ in a source file, before
+# the first #include statement.
+#
+# TODO: Adjust ifndef/define/endif guards for source header files as well.
+
+use strict;
+use warnings;
+
+die("usage: $0 <boilerplate-file> <source-file> ...\n") unless @ARGV >= 2;
+my ($BoilerName, @FileNames) = @ARGV;
+
+my $CorrectBoiler = `cat $BoilerName` or
+	die("cannot load boilerplate from $BoilerName: $!, stopped");
+$CorrectBoiler = &trimL(&trimR($CorrectBoiler));
+
+my $FileName; # for Warn()ings
+
+# process each file in-place; do not touch files on known failures
+foreach my $fname (@FileNames) {
+
+	$FileName = $fname;
+	my $code = &readFile($fname);
+	my $virginCode = $code;
+
+	&Warn("Correct boilerplate already present, skipping"), next if
+		$code =~ /\Q$CorrectBoiler\E/s;
+
+	# Look for the current boiler, which may be absent.
+	my $boiler;
+
+	# The first /* comment */ before a preprocessor instruction is a boiler.
+	my $re = qr{
+		^\s*         # optional whitespace before the comment
+		(/\*.*?\*/)  # the first comment itself
+		[^#]*        # optional non-preprocessor code after the comment
+		[#]          # followed by a preprocessor instruction
+	}xs;
+
+	$re = qr{
+		(/\*.*?\*/)  # a comment
+	}xs;
+
+	if ($code =~ s/$re/$CorrectBoiler/) {
+		# updated!
+		# TODO: if $& contains a DEBUG section, add it after the boiler.
+	} else {
+		# TODO: we should try other patterns before giving up
+
+		&Warn("Cannot find old boilerplate, skipping");
+		next; # TODO: We should add a boilerplate instead of skipping
+	}
+
+	&writeFile($fname, $code) unless $code eq $virginCode;
+	undef $FileName;
+}
+
+exit(0);
+
+sub readFile() {
+	my ($fname) = @_;
+
+	my $code = '';
+	open(IF, "<$fname") or die("cannot open $fname: $!, stopped");
+	while (<IF>) {
+		$code .= $_;
+	}
+	close(IF);
+
+	&Warn("empty file") unless length $code;
+	return $code;
+}
+
+sub writeFile {
+	my ($fname, $code) = @_;
+	open(OF, ">$fname") or die("cannot open $fname for writing: $!, stopped");
+
+	print(OF $code) or die("cannot write to $fname: $!, stopped");
+
+	close(OF) or die("cannot finish updating $fname: $!, stopped");
+}
+
+# removes all opening whitespace
+sub trimL {
+	my ($code) = @_;
+	$code =~ s/^\n[\n\s]*//m;
+	return $code;
+}
+
+# removes all trailing whitespace
+sub trimR {
+	my ($code) = @_;
+	$code =~ s/\n[\n\s]*$//m;
+	return $code;
+}
+
+sub Warn {
+	my ($msg) = @_;
+	$msg = sprintf("%s: WARNING: %s\n", $FileName, $msg) if defined $FileName;
+	warn($msg);
+}