bb07ec95daebe0b93a13b0a86b674d3baff216e5
[WebKit-https.git] / WebKitTools / Scripts / cvs-create-patch
1 #!/usr/bin/perl -w
2
3 # Copyright (C) 2005 Apple Computer, Inc.  All rights reserved.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 #
9 # 1.  Redistributions of source code must retain the above copyright
10 #     notice, this list of conditions and the following disclaimer. 
11 # 2.  Redistributions in binary form must reproduce the above copyright
12 #     notice, this list of conditions and the following disclaimer in the
13 #     documentation and/or other materials provided with the distribution. 
14 # 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 #     its contributors may be used to endorse or promote products derived
16 #     from this software without specific prior written permission. 
17 #
18 # THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 # DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 # THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 # Simplified but improved "cvs diff" script for Web Kit Open Source Project, used to make patches.
30
31 # Differences from standard "cvs diff":
32 #
33 #   Always passes "-N" to diff so it will include deleted and added files.
34 #   Always passes "-u" to diff so it will use unified diff format.
35 #   Always passes "-p" to diff so it will try to include function names.
36 #   Other command line options are not supported.
37 #   Works in mixed CVS root situations like the mix of internal and open source CVS repositories
38 #       for Apple's Safari and WebKit team, by doing a separate cvs invocation for each directory.
39 #   Fixes diff output paths so they will work with the "patch" tool.
40 #
41 # Missing feature:
42 #
43 #   Handle binary files (some text form of the binary file).
44
45 use strict;
46 use Cwd;
47
48 my $startDir = getcwd();
49
50 my %paths;
51
52 # Create list of paths to diff.
53 if (!@ARGV) {
54     $paths{"."} = 1;
55 } else {
56     for my $file (@ARGV) {
57         die "can't handle absolute paths like \"$file\"\n" if $file =~ m|^/|;
58         die "can't handle empty string path\n" if $file eq "";
59         die "can't handle path with ' in the name like \"$file\"\n" if $file =~ /'/; # ' (keep Xcode syntax highlighting happy)
60
61         my $untouchedFile = $file;
62         
63         # Add a leading and trailing slash to simplify logic below.
64         $file = "/$file/";
65
66         # Remove repeated slashes.
67         $file =~ s|//+|/|g;
68
69         # Remove meaningless sequences involving ".".
70         $file =~ s|/\./|/|g;
71
72         # Remove meaningless sequences involving "..".
73         $file =~ s|/[^./]/\.\./|/|g;
74         $file =~ s|/[^/]+[^./]/\.\./|/|g;
75         $file =~ s|/[^./][^/]+/\.\./|/|g;
76         die "can't handle paths with .. like \"$untouchedFile\"\n" if $file =~ m|/\.\./|;
77
78         # Remove the leading and trailing slash.
79         $file =~ s|^/(.*)/$|$1|;
80
81         $paths{$file} = 1;
82     }
83 }
84
85 # Remove any paths that also have a parent listed.
86 for my $path (keys %paths) {
87     my $parent = $path;
88     while ($parent =~ s|/+[^/]+$||) {
89         if ($paths{$parent}) {
90             delete $paths{$path};
91             last;
92         }
93     }
94 }
95
96 sub getDirAndBase
97 {
98     my ($path) = @_;
99     if (-d $path) {
100         $path =~ s|/+$||;
101         return ($path, ".");
102     }
103     return ($1, $2) if $path =~ m|^(.+)/([^/]+)$|;
104     $path !~ m|/| or die "Could not parse path name $path.\n";
105     return (".", $path);
106 }
107
108 # Function to generate a diff.
109 sub diff
110 {
111     my ($path) = @_;
112     my ($dir, $base) = getDirAndBase($path);
113     my $errors = "";
114     chdir $dir or die;
115     open DIFF, "cvs diff -lNpu '$base' |" or die;
116     my $indexPath;
117     while (<DIFF>) {
118         if (/^Index: (.*)/) {
119             $indexPath = $1;
120             if ($dir ne ".") {
121                 $indexPath = "$dir/$indexPath";
122                 s/Index: .*/Index: $indexPath/;
123             }
124         }
125         if ($indexPath) {
126             # Fix paths on diff, ---, and +++ lines to match preceding Index: line.
127             s/\S+$/$indexPath/ if /^diff/;
128             s/^--- \S+/--- $indexPath/;
129             s/^\+\+\+ \S+/+++ $indexPath/;
130         }
131         if (/^\?/) {
132             $errors .= $_;
133         } else {
134             print;
135         }
136     }
137     close DIFF;
138     chdir $startDir or die;
139     print STDERR $errors;
140 }
141
142 # Generate the diff for each passed file or directory.
143 for my $path (sort keys %paths) {
144     my $prefix = $path eq "." ? "" : "$path/";
145     if (-d $path) {
146         for my $CVS (`find '$path' -name CVS`) {
147             chomp $CVS;
148             die "can't handle files named CVS like \"$CVS\"\n" if !-d $CVS;
149             my $dir = $CVS;
150             $dir =~ s|/CVS$||;
151             diff($dir);
152         }
153     } else {
154         diff($path);
155     }
156 }