Jason Lowe-Power | 87b9f0b | 2017-02-10 10:00:18 -0500 | [diff] [blame] | 1 | #! /usr/bin/env python2 |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 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 | |
| 40 | import os |
| 41 | import sys |
| 42 | |
| 43 | from style.file_types import lang_type |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 44 | import style.verifiers |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 45 | from style.region import all_regions |
| 46 | |
| 47 | from style.style import StdioUI |
| 48 | from style import repo |
| 49 | |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 50 | verifier_names = dict([ |
| 51 | (c.__name__, c) for c in style.verifiers.all_verifiers ]) |
| 52 | |
| 53 | def verify(filename, regions=all_regions, verbose=False, verifiers=None, |
| 54 | auto_fix=False): |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 55 | ui = StdioUI() |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 56 | opts = { |
| 57 | "fix_all" : auto_fix, |
| 58 | } |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 59 | base = os.path.join(os.path.dirname(__file__), "..") |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 60 | if verifiers is None: |
| 61 | verifiers = style.verifiers.all_verifiers |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 62 | |
| 63 | if verbose: |
| 64 | print "Verifying %s[%s]..." % (filename, regions) |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 65 | for verifier in [ v(ui, opts, base=base) for v in verifiers ]: |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 66 | if verbose: |
| 67 | print "Applying %s (%s)" % ( |
| 68 | verifier.test_name, verifier.__class__.__name__) |
| 69 | if verifier.apply(filename, regions=regions): |
| 70 | return False |
| 71 | return True |
| 72 | |
| 73 | def detect_repo(): |
| 74 | repo_classes = repo.detect_repo() |
| 75 | if not repo_classes: |
| 76 | print >> sys.stderr, "Error: Failed to detect repository type, no " \ |
| 77 | "known repository type found." |
| 78 | sys.exit(1) |
| 79 | elif len(repo_classes) > 1: |
| 80 | print >> sys.stderr, "Error: Detected multiple repository types." |
| 81 | sys.exit(1) |
| 82 | else: |
| 83 | return repo_classes[0]() |
| 84 | |
| 85 | repo_types = { |
| 86 | "auto" : detect_repo, |
| 87 | "none" : lambda : None, |
| 88 | "git" : repo.GitRepo, |
| 89 | "hg" : repo.MercurialRepo, |
| 90 | } |
| 91 | |
| 92 | if __name__ == '__main__': |
| 93 | import argparse |
| 94 | |
| 95 | parser = argparse.ArgumentParser( |
| 96 | description="Check a file for gem5 style violations", |
| 97 | epilog="""If no files are specified, the style checker tries to |
| 98 | determine the list of modified and added files from the version |
| 99 | control system and checks those.""" |
| 100 | ) |
| 101 | |
| 102 | parser.add_argument("--verbose", "-v", action="count", |
| 103 | help="Produce verbose output") |
| 104 | |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 105 | parser.add_argument("--fix", "-f", action="store_true", |
| 106 | help="Automatically fix style violations.") |
| 107 | |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 108 | parser.add_argument("--modifications", "-m", action="store_true", |
| 109 | help="""Apply the style checker to modified regions |
| 110 | instead of whole files""") |
| 111 | |
| 112 | parser.add_argument("--repo-type", choices=repo_types, default="auto", |
| 113 | help="Repository type to use to detect changes") |
| 114 | |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 115 | parser.add_argument("--checker", "-c", choices=verifier_names, default=[], |
| 116 | action="append", |
| 117 | help="""Style checkers to run. Can be specified |
| 118 | multiple times.""") |
| 119 | |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 120 | parser.add_argument("files", metavar="FILE", nargs="*", |
| 121 | type=str, |
| 122 | help="Source file(s) to inspect") |
| 123 | |
| 124 | args = parser.parse_args() |
| 125 | |
| 126 | repo = repo_types[args.repo_type]() |
| 127 | |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 128 | verifiers = [ verifier_names[name] for name in args.checker ] \ |
| 129 | if args.checker else None |
| 130 | |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 131 | files = args.files |
| 132 | if not files and repo: |
| 133 | added, modified = repo.staged_files() |
| 134 | files = [ repo.file_path(f) for f in added + modified ] |
| 135 | |
| 136 | for filename in files: |
| 137 | if args.modifications and repo and repo.in_repo(filename): |
| 138 | regions = repo.modified_regions(filename) |
| 139 | else: |
| 140 | regions = all_regions |
| 141 | |
| 142 | if not verify(filename, regions=regions, |
Andreas Sandberg | faaf2d3 | 2016-11-25 10:33:15 +0000 | [diff] [blame] | 143 | verbose=args.verbose, |
| 144 | verifiers=verifiers, |
| 145 | auto_fix=args.fix): |
Andreas Sandberg | 5dc1790 | 2016-03-30 15:36:16 +0100 | [diff] [blame] | 146 | sys.exit(1) |