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     if (sys.version_info < (3, 0)):
  29         f = open(file, 'rt')
  30     else:
  31         f = open(file, 'rt', encoding="ascii", errors='replace', newline='')
  32     error = False
  33     for lineNum, line in enumerate(f):
  34         if line.endswith(" \n") or line.endswith("\t\n"):
  35             error = True
  36             print("%s:%i trailing whitespace" % (file, lineNum+1))
  37         if " \t" in line:
  38             error = True
  39             print("%s:%i merged <space><tab>" % (file, lineNum+1))
  40         if line.endswith("\r") or line.endswith("\r\n"):
  41             error = True
  42             print("%s:%i incorrect line ending" % (file, lineNum+1))
  43     f.close()
  44
  45     return not error
  46
  47 def checkWhitespace (files):
  48     error = False
  49     for file in files:
  50         if isTextFile(file):
  51             if not checkFileWhitespace(file):
  52                 error = True
  53
  54     return not error
  55
  56 if __name__ == "__main__":
  57     parser = ArgumentParser()
  58     parser.add_argument("-e", "--only-errors",  action="store_true", dest="onlyErrors",   default=False, help="Print only on error")
  59     parser.add_argument("-i", "--only-changed", action="store_true", dest="useGitIndex",  default=False, help="Check only modified files. Uses git.")
  60
  61     args = parser.parse_args()
  62
  63     if args.useGitIndex:
  64         files = getChangedFiles()
  65     else:
  66         files = getAllProjectFiles()
  67
  68     error = not checkWhitespace(files)
  69
  70     if error:
  71         print("One or more checks failed")
  72         sys.exit(1)
  73     if not args.onlyErrors:
  74         print("All checks passed")