Tools - Add script to check sqf/config with sqfvm (#8137)

This commit is contained in:
PabstMirror 2021-04-20 05:39:05 -05:00 committed by GitHub
parent 28cad69947
commit 88b1c5b917
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 98 additions and 5 deletions

1
.gitignore vendored
View File

@ -13,3 +13,4 @@ texHeaders.bin
*.biprivatekey
Thumbs.db
CHANGELOG.md
sqfvm.exe

View File

@ -1,3 +1,4 @@
//pragma SKIP_COMPILE
diag_log text "-------------------------------------------";
INFO("Showing entries with custom configs");
diag_log text "-------------------------------------------";

View File

@ -1,3 +1,4 @@
//pragma SKIP_COMPILE
// #include "\z\ace\addons\artillerytables\script_component.hpp"
INFO("showing shot info");

View File

@ -61,9 +61,9 @@ class ACE_Rsc_Control_Base {
#include "ACE_Settings.hpp"
#include "define.hpp"
#include <ProgressScreen.hpp>
#include <HintConfig.hpp>
#include <RscInfoType.hpp>
#include "ProgressScreen.hpp"
#include "HintConfig.hpp"
#include "RscInfoType.hpp"
#include "CompassControl.hpp"
#include "CfgUIGrids.hpp"

View File

@ -1,3 +1,5 @@
//pragma SKIP_COMPILE - Inline file
GVAR(stateMachine) = [{call EFUNC(common,getLocalUnits)}, true] call CBA_statemachine_fnc_create;
// Add states [statemachine, onState, onStateEntered, onStateLeaving, name]

View File

@ -19,4 +19,4 @@ class CfgPatches {
#include "CfgFactionClasses.hpp"
#include "CfgVehicles.hpp"
#include <RscTitles.hpp>
#include "RscTitles.hpp"

View File

@ -1,4 +1,3 @@
["ACE3 Equipment", QGVAR(DistanceKey), LLSTRING(PowerButtonKey),
{
// Conditions: canInteract

89
tools/sqfvmChecker.py Normal file
View File

@ -0,0 +1,89 @@
import os
import sys
import subprocess
import concurrent.futures
addon_base_path = os.path.dirname(os.getcwd())
files_to_ignore_lower = [
x.lower() for x in ["initSettings.sqf", "initKeybinds.sqf", "XEH_PREP.sqf"]
]
sqfvm_exe = os.path.join(addon_base_path, "sqfvm.exe")
virtual_paths = [
# would need to add more even more to /include to use it
"P:/a3|/a3", # "{}|/a3".format(os.path.join(addon_base_path, "include", "a3")),
"P:/a3|/A3",
"P:/x/cba|/x/cba",
"{}|/z/ace".format(addon_base_path),
]
def get_files_to_process(basePath):
arma_files = []
for root, _dirs, files in os.walk(os.path.join(addon_base_path, "addons")):
for file in files:
if file.endswith(".sqf") or file == "config.cpp":
if file.lower() in files_to_ignore_lower:
continue
filePath = os.path.join(root, file)
arma_files.append(filePath)
return arma_files
def process_file(filePath, skipA3Warnings=True):
with open(filePath, "r", encoding="utf-8", errors="ignore") as file:
content = file.read()
if content.startswith("//pragma SKIP_COMPILE"):
return False
cmd = [sqfvm_exe, "--input", filePath, "--parse-only", "--automated"]
for v in virtual_paths:
cmd.append("-v")
cmd.append(v)
# cmd.append("-V")
proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, universal_newlines=True)
try:
ret = proc.wait(7) # max wait - seconds
except Exception as _e:
print("sqfvm timed out: {}".format(filePath))
return True
# print("{} = {}".format(filePath, ret))
fileHasError = False
keepReadingLines = True
while keepReadingLines:
line = proc.stdout.readline()
if not line:
keepReadingLines = False
else:
line = line.rstrip()
if line.startswith("[ERR]"):
fileHasError = True
if not (
skipA3Warnings
and line.startswith("[WRN]")
and ("a3/" in line)
and (("Unexpected IFDEF" in line) or ("defined twice" in line))
):
print(" {}".format(line))
return fileHasError
def main():
if not os.path.isfile(sqfvm_exe):
print("Error: sqfvm.exe not found in base folder [{}]".format(sqfvm_exe))
return 1
error_count = 0
arma_files = get_files_to_process(addon_base_path)
print("Checking {} files".format(len(arma_files)))
with concurrent.futures.ThreadPoolExecutor(max_workers=12) as executor:
for fileError in executor.map(process_file, arma_files):
if fileError:
error_count += 1
print("Errors: {}".format(error_count))
return error_count
if __name__ == "__main__":
sys.exit(main())