Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

config_style_checker: Pylint fixes #1418

Merged
merged 2 commits into from
Feb 13, 2021
Merged

config_style_checker: Pylint fixes #1418

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8682456
config_style_checker: Pylint fixes
Killswitch00 Feb 7, 2021
5e6e625
fixup! config_style_checker: Pylint fixes
Killswitch00 Feb 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
204 changes: 115 additions & 89 deletions tools/config_style_checker.py
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,161 +1,187 @@
#!/usr/bin/env python

"""Config style validator"""

import argparse
import fnmatch
import os
import re
import ntpath
import sys
import argparse

Killswitch00 marked this conversation as resolved.
Show resolved Hide resolved
if sys.version_info.major == 2:
import codecs
open = codecs.open
open = codecs.open # pylint: disable=invalid-name,redefined-builtin

def checkConfigStyle(filepath): # pylint: disable=too-many-branches,too-many-statements
"""Do a sanity check on a .cpp or .hpp config file

def check_config_style(filepath):
bad_count_file = 0
def pushClosing(t):
closingStack.append(closing.expr)
closing << Literal( closingFor[t[0]] )
In code that is not inside comments or string literals,

def popClosing():
closing << closingStack.pop()
* check for tabs
* check for mismatched pairs of parentheses, brackets and braces (), [], {}

Returns the number of possible syntax issues found
"""
badCountFile = 0

with open(filepath, 'r', encoding='utf-8', errors='ignore') as file:
content = file.read()

# Store all brackets we find in this file, so we can validate everything on the end
brackets_list = []
bracketsList = []

# To check if we are in a comment block
isInCommentBlock = False
checkIfInComment = False
# Used in case we are in a line comment (//)
ignoreTillEndOfLine = False
# Used in case we are in a comment block (/* */). This is true if we detect a * inside a comment block.
# Used in case we are in a comment block (/* */).
# This is true if we detect a * inside a comment block.
# If the next character is a /, it means we end our comment block.
checkIfNextIsClosingBlock = False

# We ignore everything inside a string
isInString = False
# Used to store the starting type of a string, so we can match that to the end of a string
inStringType = '';
inStringType = ''

lastIsCurlyBrace = False
checkForSemiColumn = False

# Extra information so we know what line we find errors at
lineNumber = 1

indexOfCharacter = 0
# Parse all characters in the content of this file to search for potential errors
for c in content:
if (lastIsCurlyBrace):
for c in content: # pylint: disable=invalid-name,too-many-nested-blocks
if lastIsCurlyBrace:
lastIsCurlyBrace = False
if c == '\n': # Keeping track of our line numbers
lineNumber += 1 # so we can print accurate line number information when we detect a possible error
if (isInString): # while we are in a string, we can ignore everything else, except the end of the string
if (c == inStringType):
# so we can print accurate line number information when
# we detect a possible error
lineNumber += 1
if isInString:
# while we are in a string, we can ignore everything else
# except the end of the string
if c == inStringType:
isInString = False
# if we are not in a comment block, we will check if we are at the start of one or count the () {} and []
elif (isInCommentBlock == False):
# if we are not in a comment block, we will check if we are at
# the start of one or count the () {} and []
elif not isInCommentBlock:

# This means we have encountered a /, so we are now checking if this is an inline comment or a comment block
if (checkIfInComment):
# This means we have encountered a /, so we are now checking
# if this is an inline comment or a comment block
if checkIfInComment:
checkIfInComment = False
if c == '*': # if the next character after / is a *, we are at the start of a comment block
# if the next character after / is a *, we are
# at the start of a comment block
if c == '*':
isInCommentBlock = True
elif (c == '/'): # Otherwise, will check if we are in an line comment
ignoreTillEndOfLine = True # and an line comment is a / followed by another / (//) We won't care about anything that comes after it

if (isInCommentBlock == False):
if (ignoreTillEndOfLine): # we are in a line comment, just continue going through the characters until we find an end of line
if (c == '\n'):
elif c == '/':
# Otherwise, will check if we are in a line comment
# and a line comment is a / followed by another / (//)
# We won't care about anything that comes after it
ignoreTillEndOfLine = True

if not isInCommentBlock:
if ignoreTillEndOfLine:
# we are in a line comment, just continue going
# through the characters until we find an end of line
if c == '\n':
ignoreTillEndOfLine = False
else: # validate brackets
if (c == '"' or c == "'"):
if c in ('"', "'"):
isInString = True
inStringType = c
elif (c == '/'):
elif c == '/':
checkIfInComment = True
elif (c == '('):
brackets_list.append('(')
elif (c == ')'):
if (len(brackets_list) > 0 and brackets_list[-1] in ['{', '[']):
print("ERROR: Possible missing round bracket ')' detected at {0} Line number: {1}".format(filepath,lineNumber))
bad_count_file += 1
brackets_list.append(')')
elif (c == '['):
brackets_list.append('[')
elif (c == ']'):
if (len(brackets_list) > 0 and brackets_list[-1] in ['{', '(']):
print("ERROR: Possible missing square bracket ']' detected at {0} Line number: {1}".format(filepath,lineNumber))
bad_count_file += 1
brackets_list.append(']')
elif (c == '{'):
brackets_list.append('{')
elif (c == '}'):
elif c == '(':
bracketsList.append('(')
elif c == ')':
if (len(bracketsList) > 0 and bracketsList[-1] in ['{', '[']):
print("ERROR: Possible missing round bracket ')' detected"
" at {0} Line number: {1}".format(filepath, lineNumber))
badCountFile += 1
bracketsList.append(')')
elif c == '[':
bracketsList.append('[')
elif c == ']':
if (len(bracketsList) > 0 and bracketsList[-1] in ['{', '(']):
print("ERROR: Possible missing square bracket ']' detected"
" at {0} Line number: {1}".format(filepath, lineNumber))
badCountFile += 1
bracketsList.append(']')
elif c == '{':
bracketsList.append('{')
elif c == '}':
lastIsCurlyBrace = True
if (len(brackets_list) > 0 and brackets_list[-1] in ['(', '[']):
print("ERROR: Possible missing curly brace '}}' detected at {0} Line number: {1}".format(filepath,lineNumber))
bad_count_file += 1
brackets_list.append('}')
elif (c== '\t'):
print("ERROR: Tab detected at {0} Line number: {1}".format(filepath,lineNumber))
bad_count_file += 1
if (len(bracketsList) > 0 and bracketsList[-1] in ['(', '[']):
print("ERROR: Possible missing curly brace '}}' detected"
" at {0} Line number: {1}".format(filepath, lineNumber))
badCountFile += 1
bracketsList.append('}')
elif c == '\t':
print("ERROR: Tab detected at {0} Line number: {1}".format(filepath,
lineNumber))
badCountFile += 1

else: # Look for the end of our comment block
if (c == '*'):
checkIfNextIsClosingBlock = True;
elif (checkIfNextIsClosingBlock):
if (c == '/'):
if c == '*':
checkIfNextIsClosingBlock = True
elif checkIfNextIsClosingBlock:
if c == '/':
isInCommentBlock = False
elif (c != '*'):
elif c != '*':
checkIfNextIsClosingBlock = False
indexOfCharacter += 1

if brackets_list.count('[') != brackets_list.count(']'):
print("ERROR: A possible missing square bracket [ or ] in file {0} [ = {1} ] = {2}".format(filepath,brackets_list.count('['),brackets_list.count(']')))
bad_count_file += 1
if brackets_list.count('(') != brackets_list.count(')'):
print("ERROR: A possible missing round bracket ( or ) in file {0} ( = {1} ) = {2}".format(filepath,brackets_list.count('('),brackets_list.count(')')))
bad_count_file += 1
if brackets_list.count('{') != brackets_list.count('}'):
print("ERROR: A possible missing curly brace {{ or }} in file {0} {{ = {1} }} = {2}".format(filepath,brackets_list.count('{'),brackets_list.count('}')))
bad_count_file += 1
return bad_count_file

def main():

if bracketsList.count('[') != bracketsList.count(']'):
print("ERROR: A possible missing square bracket [ or ] in file {0}"
" [ = {1} ] = {2}".format(filepath, bracketsList.count('['),
bracketsList.count(']')))
badCountFile += 1
if bracketsList.count('(') != bracketsList.count(')'):
print("ERROR: A possible missing round bracket ( or ) in file {0}"
" ( = {1} ) = {2}".format(filepath, bracketsList.count('('),
bracketsList.count(')')))
badCountFile += 1
if bracketsList.count('{') != bracketsList.count('}'):
print("ERROR: A possible missing curly brace {{ or }} in file {0}"
" {{ = {1} }} = {2}".format(filepath, bracketsList.count('{'),
bracketsList.count('}')))
badCountFile += 1
return badCountFile

def main(): # pylint: disable=missing-function-docstring
print("Validating Config Style")

sqf_list = []
bad_count = 0
sqfList = []
badCount = 0

parser = argparse.ArgumentParser()
parser.add_argument('-m','--module', help='only search specified module addon folder', required=False, default="")
parser.add_argument('-m', '--module', help='only search specified module addon folder',
required=False, default="")
args = parser.parse_args()

# Allow running from root directory as well as from inside the tools directory
rootDir = "../addons"
if (os.path.exists("addons")):
if os.path.exists("addons"):
rootDir = "addons"

for root, dirnames, filenames in os.walk(rootDir + '/' + args.module):
for filename in fnmatch.filter(filenames, '*.cpp'):
sqf_list.append(os.path.join(root, filename))
for filename in fnmatch.filter(filenames, '*.hpp'):
sqf_list.append(os.path.join(root, filename))
for root, _, filenames in os.walk(rootDir + '/' + args.module):
for filename in fnmatch.filter(filenames, '*.cpp'):
sqfList.append(os.path.join(root, filename))
for filename in fnmatch.filter(filenames, '*.hpp'):
sqfList.append(os.path.join(root, filename))

for filename in sqf_list:
bad_count = bad_count + check_config_style(filename)
for filename in sqfList:
badCount = badCount + checkConfigStyle(filename)

print("------\nChecked {0} files\nErrors detected: {1}".format(len(sqf_list), bad_count))
if (bad_count == 0):
print("------\nChecked {0} files\nErrors detected: {1}".format(len(sqfList), badCount))
if badCount == 0:
print("Config validation PASSED")
else:
print("Config validation FAILED")

return bad_count
return badCount

if __name__ == "__main__":
sys.exit(main())