util/style.py

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