Add tool to verify stringtable entries exist (#6889)

* Add tool to verify stringtable entries exist

* Update circle.yml

* test

* Allow running from root directory as well as from inside the tools directory
This commit is contained in:
PabstMirror 2019-03-31 15:27:51 -05:00 committed by GitHub
parent c7e6549eb2
commit 3769679237
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 107 additions and 3 deletions

View File

@ -1,4 +1,6 @@
class ACE_Settings { class ACE_Settings {
//IGNORE_STRING_WARNING(STR_ACE_Common_SettingName);
//IGNORE_STRING_WARNING(STR_ACE_Common_SettingDescription);
/* /*
* class GVAR(sampleSetting) { * class GVAR(sampleSetting) {
* value = 1; // Value * value = 1; // Value

View File

@ -113,7 +113,7 @@ private _settings = configProperties [configFile >> "ACE_Settings", "(isClass _x
_output pushBack ""; _output pushBack "";
_output pushBack format ["["]; _output pushBack format ["["];
_output pushBack format [" QGVAR(%1), ""%2"",", _gvarName, _cbaSettingType]; _output pushBack format [" QGVAR(%1), ""%2"",", _gvarName, _cbaSettingType];
_output pushBack format [" [LSTRING(), LSTRING()], // %1, %2", _localizedName, _localizedDescription]; _output pushBack format [" [LSTRING(), LSTRING()], // %1, %2", _localizedName, _localizedDescription]; //IGNORE_STRING_WARNING(str_ace_common_);
_output pushBack format [" ""%1"", // %2", ["localize LSTRING()", _category] select _uncat, _category]; _output pushBack format [" ""%1"", // %2", ["localize LSTRING()", _category] select _uncat, _category];
_output pushBack format [" %1, // %2", _cbaValueInfo, _cbaValueInfoHint]; _output pushBack format [" %1, // %2", _cbaValueInfo, _cbaValueInfoHint];
_output pushBack format [" %1, // isGlobal", _cbaIsGlobal]; _output pushBack format [" %1, // isGlobal", _cbaIsGlobal];

View File

@ -33,6 +33,7 @@ if (_track) then {
}; };
// Prepare first part of the string from stringtable // Prepare first part of the string from stringtable
//IGNORE_STRING_WARNING(str_ace_repair_hit);
private _text = LSTRING(Hit); private _text = LSTRING(Hit);
// Remove "Hit" from hitpoint name if one exists // Remove "Hit" from hitpoint name if one exists

View File

@ -6,8 +6,8 @@ jobs:
steps: steps:
- checkout - checkout
- run: - run:
name: Validate SQF and Config style name: Validate SQF and Config style and Stringtable entries
command: python tools/sqf_validator.py && python tools/config_style_checker.py command: python tools/sqf_validator.py && python tools/config_style_checker.py && python tools/check_strings.py
linting: linting:
docker: docker:

101
tools/check_strings.py Normal file
View File

@ -0,0 +1,101 @@
#!/usr/bin/env python3
# PabstMirror
# Checks all strings are defined, run with -u to return all unused strings
import fnmatch
import os
import re
import sys
def getDefinedStrings(filepath):
# print("getDefinedStrings {0}".format(filepath))
with open(filepath, 'r', encoding="latin-1") as file:
content = file.read()
srch = re.compile('Key ID\=\"(STR_ACE_[_a-zA-Z0-9]*)"', re.IGNORECASE)
modStrings = srch.findall(content)
modStrings = [s.lower() for s in modStrings]
return modStrings
def getStringUsage(filepath):
selfmodule = (re.search('addons[\W]*([_a-zA-Z0-9]*)', filepath)).group(1)
# print("Checking {0} from {1}".format(filepath,selfmodule))
fileStrings = []
with open(filepath, 'r') as file:
content = file.read()
srch = re.compile('(STR_ACE_[_a-zA-Z0-9]*)', re.IGNORECASE)
fileStrings = srch.findall(content)
srch = re.compile('[^E][CL]STRING\(([_a-zA-Z0-9]*)\)', re.IGNORECASE)
modStrings = srch.findall(content)
for localString in modStrings:
fileStrings.append("STR_ACE_{0}_{1}".format(selfmodule, localString))
srch = re.compile('E[CL]STRING\(([_a-zA-Z0-9]*),([_a-zA-Z0-9]*)\)')
exStrings = srch.findall(content)
for (exModule, exString) in exStrings:
fileStrings.append("STR_ACE_{0}_{1}".format(exModule, exString))
srch = re.compile('IGNORE_STRING_WARNING\([\'"]*([_a-zA-Z0-9]*)[\'"]*\)')
ignoreWarnings = srch.findall(content)
fileStrings = [s.lower() for s in fileStrings]
return [s for s in fileStrings if s not in (i.lower() for i in ignoreWarnings)]
def main(argv):
print("### check_strings.py {} ###".format(argv))
sqf_list = []
xml_list = []
allDefinedStrings = []
allUsedStrings = []
# Allow running from root directory as well as from inside the tools directory
rootDir = "../addons"
if (os.path.exists("addons")):
rootDir = "addons"
for root, dirnames, filenames in os.walk(rootDir):
for filename in fnmatch.filter(filenames, '*.sqf'):
sqf_list.append(os.path.join(root, filename))
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 filename in fnmatch.filter(filenames, '*.h'):
sqf_list.append(os.path.join(root, filename))
for filename in fnmatch.filter(filenames, '*.xml'):
xml_list.append(os.path.join(root, filename))
for filename in xml_list:
allDefinedStrings = allDefinedStrings + getDefinedStrings(filename)
for filename in sqf_list:
allUsedStrings = allUsedStrings + getStringUsage(filename)
allDefinedStrings = list(sorted(set(allDefinedStrings)))
allUsedStrings = list(sorted(set(allUsedStrings)))
print("-----------")
countUnusedStrings = 0
countUndefinedStrings = 0
for s in allDefinedStrings:
if (not (s in allUsedStrings)):
countUnusedStrings = countUnusedStrings + 1;
if ("-u" in argv):
print("String {} defined but not used".format(s))
print("-----------")
for s in allUsedStrings:
if (not (s in allDefinedStrings)):
print("String {} not defined".format(s))
countUndefinedStrings = countUndefinedStrings + 1;
print("-----------")
print("Defined Strings:{0} Used Strings:{1}".format(len(allDefinedStrings),len(allUsedStrings)))
print("Unused Strings:{0} Undefined Strings:{1}".format(countUnusedStrings,countUndefinedStrings))
return countUndefinedStrings
if __name__ == "__main__":
main(sys.argv)