scripts/src_util/check_whitespace.py

   1 # -*- coding: utf-8 -*-
   2
   3 #-------------------------------------------------------------------------
   4 # drawElements Quality Program utilities
   5 # --------------------------------------
   6 #
   7 # Copyright 2015 The Android Open Source Project
   8 #
   9 # Licensed under the Apache License, Version 2.0 (the "License");
  10 # you may not use this file except in compliance with the License.
  11 # You may obtain a copy of the License at
  12 #
  13 #      http://www.apache.org/licenses/LICENSE-2.0
  14 #
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS,
  17 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18 # See the License for the specific language governing permissions and
  19 # limitations under the License.
  20 #
  21 #-------------------------------------------------------------------------
  22
  23 import sys
  24 from argparse import ArgumentParser
  25 from common import getChangedFiles, getAllProjectFiles, isTextFile
  26
  27 def checkFileWhitespace (file):
  28     f = open(file, 'rb')
  29     error = False
  30     for lineNum, line in enumerate(f):
  31         if line.endswith(" \n") or line.endswith("\t\n"):
  32             error = True
  33             print "%s:%i trailing whitespace" % (file, lineNum+1)
  34         if " \t" in line:
  35             error = True
  36             print "%s:%i merged <space><tab>" % (file, lineNum+1)
  37     f.close()
  38
  39     return not error
  40
  41 def checkWhitespace (files):
  42     error = False
  43     for file in files:
  44         if isTextFile(file):
  45             if not checkFileWhitespace(file):
  46                 error = True
  47
  48     return not error
  49
  50 if __name__ == "__main__":
  51     parser = ArgumentParser()
  52     parser.add_argument("-e", "--only-errors",  action="store_true", dest="onlyErrors",   default=False, help="Print only on error")
  53     parser.add_argument("-i", "--only-changed", action="store_true", dest="useGitIndex",  default=False, help="Check only modified files. Uses git.")
  54
  55     args = parser.parse_args()
  56
  57     if args.useGitIndex:
  58         files = getChangedFiles()
  59     else:
  60         files = getAllProjectFiles()
  61
  62     error = not checkWhitespace(files)
  63
  64     if error:
  65         print "One or more checks failed"
  66         sys.exit(1)
  67     if not args.onlyErrors:
  68         print "All checks passed"