1#!/usr/bin/env python2.7
2#
3# Copyright (c) 2016 ARM Limited
4# All rights reserved
5#
6# The license below extends only to copyright in the software and shall
7# not be construed as granting a license to any other intellectual
8# property including but not limited to intellectual property relating
9# to a hardware implementation of the functionality of the software
10# licensed hereunder.  You may use the software subject to the license
11# terms below provided that you ensure that this notice is replicated
12# unmodified and in its entirety in all distributions of the software,
13# modified or unmodified, in source code or in binary form.
14#
15# Redistribution and use in source and binary forms, with or without
16# modification, are permitted provided that the following conditions are
17# met: redistributions of source code must retain the above copyright
18# notice, this list of conditions and the following disclaimer;
19# redistributions in binary form must reproduce the above copyright
20# notice, this list of conditions and the following disclaimer in the
21# documentation and/or other materials provided with the distribution;
22# neither the name of the copyright holders nor the names of its
23# contributors may be used to endorse or promote products derived from
24# this software without specific prior written permission.
25#
26# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37#
38# Authors: Andreas Sandberg
39
40from tempfile import TemporaryFile
41import os
42import subprocess
43import sys
44
45from style.repo import GitRepo
46from style.verifiers import all_verifiers, all_regions
47from style.style import StdioUI, check_ignores
48
49import argparse
50
51parser = argparse.ArgumentParser(
52    description="gem5 git style checker hook")
53
54parser.add_argument("--verbose", "-v", action="store_true",
55                    help="Produce verbose output")
56
57args = parser.parse_args()
58
59git = GitRepo()
60
61opts = {}
62repo_base = git.repo_base()
63ui = StdioUI()
64
65os.chdir(repo_base)
66failing_files = set()
67staged_mismatch = set()
68
69for status, fname in git.status(filter="MA", cached=True):
70    if args.verbose:
71        print "Checking %s..." % fname
72    if check_ignores(fname):
73        continue
74    if status == "M":
75        regions = git.staged_regions(fname)
76    else:
77        regions = all_regions
78
79    # Show they appropriate object and dump it to a file
80    status = git.file_from_index(fname)
81    f = TemporaryFile()
82    f.write(status)
83
84    verifiers = [ v(ui, opts, base=repo_base) for v in all_verifiers ]
85    for v in verifiers:
86        f.seek(0)
87        # It is prefered that the first check is silent as it is in the
88        # staged file. If the check fails, then we will do it non-silently
89        # on the current file, reporting meaningful shortcomings
90        if not v.skip(fname) and v.check(fname, regions, fobj=f, silent=True):
91            failing_files.add(fname)
92            if not v.check(fname, regions):
93                staged_mismatch.add(fname)
94    f.close()
95
96if failing_files:
97    if len(failing_files) > len(staged_mismatch):
98        print >> sys.stderr
99        print >> sys.stderr, "Style checker failed for the following files:"
100        for f in failing_files:
101            if f not in staged_mismatch:
102                print >> sys.stderr, "\t%s" % f
103        print >> sys.stderr
104        print >> sys.stderr, \
105        "Please run the style checker manually to fix the offending files.\n" \
106        "To check your modifications, run: util/style.py -m"
107
108    print >> sys.stderr
109    if staged_mismatch:
110        print >> sys.stderr, \
111        "It looks like you have forgotten to stage your fixes for commit in\n"\
112        "the following files: "
113        for f in staged_mismatch:
114            print >> sys.stderr, "\t%s" % f
115        print >> sys.stderr, "Please `git --add' them"
116    sys.exit(1)
117