skacekamen / sqflint Goto Github PK

View Code? Open in Web Editor NEW

17.0 17.0 5.0 1.02 MB

Provides basic syntax error checking for SQF language.

License: MIT License

Batchfile 0.05% Java 82.00% SQF 16.43% Inno Setup 0.58% Dockerfile 0.93%

sqf sqf-language

sqflint's People

Contributors

Stargazers

Watchers

Forkers

dahlgren hpy billw2012 veteran29 mr-guard

sqflint's Issues

Quotes in strings

Input

_string = "my string ""with"" quotes";
_string2 = 'my other string "with" quotes';

Expected
Should be valid according to https://community.bistudio.com/wiki/String

Error

Exception in thread "main" cz.zipek.sqflint.parser.TokenMgrError: Lexical error at line 2, column 29.  Encountered: "\"" (34), after : "\'my other string "
	at cz.zipek.sqflint.parser.SQFParserTokenManager.getNextToken(SQFParserTokenManager.java:1214)
	at cz.zipek.sqflint.parser.SQFParser.jj_ntk_f(SQFParser.java:1047)
	at cz.zipek.sqflint.parser.SQFParser.Expression(SQFParser.java:259)
	at cz.zipek.sqflint.parser.SQFParser.Expression(SQFParser.java:273)
	at cz.zipek.sqflint.parser.SQFParser.Expression(SQFParser.java:273)
	at cz.zipek.sqflint.parser.SQFParser.Expression(SQFParser.java:273)
	at cz.zipek.sqflint.parser.SQFParser.Expression(SQFParser.java:273)
	at cz.zipek.sqflint.parser.SQFParser.StatementExpression(SQFParser.java:518)
	at cz.zipek.sqflint.parser.SQFParser.Statement(SQFParser.java:503)
	at cz.zipek.sqflint.parser.SQFParser.BlockStatement(SQFParser.java:458)
	at cz.zipek.sqflint.parser.SQFParser.CompilationUnit(SQFParser.java:55)
	at cz.zipek.sqflint.linter.Linter.start(Linter.java:56)
	at cz.zipek.sqflint.SQFLint.main(SQFLint.java:68)

with _namespace do produces an error

with missionNamespace do {
	//anything
};

This produces a lint error, yet syntax is correct.

Functions declared through a class with a folder name are not recognized as functions

Functions declared through a class with a folder name are not recognized as functions, functions are in folders that are located in the folder "functions", called according to the principle "fn_nameFunction1.sqf". LInter does not recognize them, which causes thousands of extra warnings

0.11.0 crashes on Arch Linux

I am not experienced with java, however I believe this means you are not importing the commons jar correctly?
0.10.1 works fine.

undefined variable with params

It would be nice if variables declared using param/params were detected

Example

params ["_var"];
hint _var;

Current Result
Warning: Possibly undefined variable _var at line 2 column 6

additional search paths

I think, it would be an enhancement, if you could define additional searchpaths.

#include "\x\cba\addons\main\script_macros_common.hpp"
private _testvar = QUOTE(Hello World);

With additional paths, you could check for scripts in your arma3 home directory.
This could be usefull for the sqflint.checkPaths option too.

Static analysis of while loop seems to lack type checking

This is fine:

while { true } do
{

};

This however, produces an error:

_condition = { true };
while _condition do
{

};

Screenshot:

Non-literal if-then-else arguments

if-then-else expects code literals.

_then = {};

if true then _then;

Complex statements...

The last fix of complex statements just fixed the if statement.
But there are two more: the switch (...) do {} and try { ... } catch { ... } statement, which can be applied for example:

switch (...) do {}

... format["%1", (
    switch (true): {
        case "example1": {};
        ...
    }
)];
...

try { ... } catch { ... }

... format["%1", (
    try {
        ...
    } catch {
        ...
    }
)];
...

Because every of those clauses/statements can return only one type of any you can use them in this commands.
It is important to know that even the engine of BI needs some () brackets around these statements (like the array after format []).

I hope you can fix this.

And for me: Happy testing :)

error when parsing classes in description.ext when dividing by the number

"message": "Expected "/*", "//", ";", comment, end of line, or whitespace but "/" found.",

example class:

class Menu_Frame : RscFrame {
	colorText[] = MENU_TEXT_COLOR;
	colorBackground[] = MENU_BG_COLOR;
	sizeEx = 0.01925 / (getResolution select 5);
	x = (UI_BASE_X + 0.15) * safezoneW + safezoneX;
	y = (UI_BASE_Y + 0.343) * safezoneH + safezoneY;
	w = 0.1 * safezoneW;
	h = 0.165 * safezoneH;
};

Token errors aren't correctly handled.

Token errors thrown as expcetion leak to main function without being properly handled. They should be handled same way as parse errors.

JSON flag ignored under certain circumstances

Not entirely sure what's causing this, initially I thought it was related to multiple errors, but I now believe it has something specific to do with the pattern.

When linting this code, with --json passed to sqflint.exe, it returns the result in text, and not in JSON. If <>; is removed from line 1, the result is properly returned in JSON.

Code (testfile.sqf):

        _caller = _this select 1;<>;
        _nearstuff = nearestobjects [_lc, ["landvehicle", "camanbase"], 8];qsdasrfd1234adf;'l[;a.d;[sd,c[opsalfksf'
        .]';.'/d'a.d';asd['asdsd;a;sdasd;a[s/';;'d'asd/]asd
        _attachedObjs = [];

Result 1 (with `<>;`):

PS C:\sqflint> .\sqflint.exe --json .\testfile.sqf
Encountered " "<" "< "" at line 1, column 28.
Was expecting one of:
    <EOF>
    "!" ...
    "not " ...
    "for" ...
    "if" ...
    "objNull" ...
    "switch" ...
    "while" ...
    "true" ...
    "false" ...
    <INTEGER_LITERAL> ...
    <FLOATING_POINT_LITERAL> ...
    <STRING_LITERAL> ...
    <STRING_LITERAL_OTHER> ...
    <IDENTIFIER> ...
    "(" ...
    "{" ...
    "[" ...
    ";" ...

Result 2 (without `<>;`):

PS C:\sqflint> .\sqflint.exe --json .\testfile.sqf
{"line":[3,3],"column":[3,3],"type":"error","message":"Encountered \".\".\r\nWas expecting one of:\r\n    \"=\" ...\r\n    \">\" ...\r\n    \"<\" ...\r\n    \">=\" ...\r\n    \"<=\" ...\r\n    \"!\" ...\r\n    \"not \" ...\r\n    \"==\" ...\r\n    \"||\" ...\r\n    \"&&\" ...\r\n    \"+\" ...\r\n    \"-\" ...\r\n    \"*\" ...\r\n    \"/\" ...\r\n    \"^\" ...\r\n    \"%\" ...\r\n    \"mod\" ...\r\n    \">>\" ...\r\n    \"objNull\" ...\r\n    \"true\" ...\r\n    \"false\" ...\r\n    <INTEGER_LITERAL> ...\r\n    <FLOATING_POINT_LITERAL> ...\r\n    <STRING_LITERAL> ...\r\n    <STRING_LITERAL_OTHER> ...\r\n    <IDENTIFIER> ...\r\n    \"(\" ...\r\n    \"{\" ...\r\n    \"[\" ...\r\n    \";\" ...\r\n    \"!=\" ...\r\n    "}
{"line":[2,2],"column":[32,34],"type":"warning","message":"Possibly undefined variable _lc"}

Empty statements and preprocessor control flow

Empty statements are treated as errors:

_x =
{
    ;
};

The error was initially caused by this:

#define DEBUG_LOG_TRACE

#define Debug_Log_Impl(mode, message) (diag_log format ['mode: %1', message])

#ifdef DEBUG_LOG_TRACE
	#define Debug_LogTrace(message) Debug_Log_Impl(TRACE,message)
#else
	#define Debug_LogTrace(message)
#endif

Debug_LogTrace("");

_exit =
{
	endMission "END1";
};

It seems that the preprocessor flow control is ignored, and Debug_LogTrace("") is incorrectly expanded as nothing, creating an empty statement. The empty statement in itself is of course perfectly valid.

Current behaviour

#define SVAR(name,subname) SCRIPT_##subname##_##name
SVAR(test, test) = 5;
  ^      ^--- error unexpected ','
   \--------- warning, undefined SVAR

Expected behaviour

#define SVAR(name,subname) SCRIPT_##subname##_##name
SVAR(test, test) = 5;

should resolve into

SCRIPT_test_test = 5;

References

https://community.bistudio.com/wiki/PreProcessor_Commands