pytest is not correctly auto-installed
[WebKit-https.git] / Tools / Scripts / SpacingHeuristics.pm
1 #!/usr/bin/env perl
2
3 # Copyright (C) 2006 Apple 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 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 # Used for helping remove extra blank lines from files when processing.
30 # see split-class for an example usage (or other scripts in bugzilla)
31
32 use warnings;
33
34 BEGIN {
35    use Exporter   ();
36    our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
37    $VERSION     = 1.00;
38    @ISA         = qw(Exporter);
39    @EXPORT      = qw(&resetSpacingHeuristics &isOnlyWhiteSpace &applySpacingHeuristicsAndPrint &setPreviousAllowedLine &setPreviousAllowedLine &printPendingEmptyLines &ignoringLine);
40    %EXPORT_TAGS = ();
41    @EXPORT_OK   = ();
42 }
43
44 our @EXPORT_OK;
45
46 my $justFoundEmptyLine = 0;
47 my $previousLineWasDisallowed = 0;
48 my $previousAllowedLine = "";
49 my $pendingEmptyLines = "";
50
51 sub resetSpacingHeuristics
52 {
53     $justFoundEmptyLine = 0;
54     $previousLineWasDisallowed = 0;
55     $previousAllowedLine = "";
56     $pendingEmptyLines = "";
57 }
58
59 sub isOnlyWhiteSpace
60 {
61     my $line = shift;
62     my $isOnlyWhiteSpace = ($line =~ m/^\s+$/);
63     $pendingEmptyLines .= $line if ($isOnlyWhiteSpace);
64     return $isOnlyWhiteSpace;
65 }
66
67 sub applySpacingHeuristicsAndPrint
68 {
69     my ($out, $line) = @_;
70     
71     printPendingEmptyLines($out, $line);
72     $previousLineWasDisallowed = 0;
73     print $out $line;
74 }
75
76 sub setPreviousAllowedLine
77 {
78     my $line = shift;
79     $previousAllowedLine = $line;
80 }
81
82 sub printPendingEmptyLines
83 {
84     my $out = shift;
85     my $line = shift;
86     if ($previousLineWasDisallowed) {
87         if (!($pendingEmptyLines eq "") && !($previousAllowedLine =~ m/{\s*$/) && !($line =~ m/^\s*}/)) {
88             $pendingEmptyLines = "\n";
89         } else {
90             $pendingEmptyLines = "";
91         }
92     }
93     print $out $pendingEmptyLines;
94     $pendingEmptyLines = "";
95 }
96
97 sub ignoringLine
98 {
99     # my $line = shift; # ignoring input argument
100     $previousLineWasDisallowed = 1;
101 }
102
103 1;