Fix script errors reporting wrong line numbers

[dedmen]

preprocessFileLineNumbers "x\cba\addons\common\fnc_currentUnit.sqf"
Before: https://gist.github.com/dedmen/896504ced548b9e2f9de738525908510
After: https://gist.github.com/dedmen/1ffc539dbec1d016d602b62888f94943

Let's superimpose the actual script together with the line numbers.

Before:

Was the getVariable on line 6? Is that correct? NO!

CBA_A3/addons/common/fnc_currentUnit.sqf

Line 19 in ffd5fa7

missionNamespace getVariable ["bis_fnc_moduleRemoteControl_unit", player]

That's line 19!

After:

Was the getVariable on line 19? Is that correct? YES!

CBA_A3/addons/common/fnc_currentUnit.sqf

Line 19 in ffd5fa7

missionNamespace getVariable ["bis_fnc_moduleRemoteControl_unit", player]

That's indeed line 19!

The above will cause script error messages to be on the wrong line exactly like I showed you here. Because the in-engine representation is broken because of this preprocessor bug.
And because the game doesn't know where the F it is right now, neither does my debugger. Which makes CBA not debugable. You set a breakpoint on Line 19, but never hit it because Line 19 is actually Line 6.

This PR is WIP. I will add all the other files too. Just wanted to get this visualization out before I actually get everything done.

Scripts that grab the header to generate documentation probably also have to be updated.

[ViperMaul]

Nice @dedmen
Also what we need is a regex script to apply your same fix to all of the other SQF files that have this issue. There are well over 300+ additional files where #include "script_component.hpp" is located below comments.

Looks like you are already on that path. Thank you!

[kymckay]

This has bugged me for so long in ace too, good solve 👍

[kymckay]

For the regex this should do it:

^\s*(/\*.+?\*/)\s*#include\s*"script_component\.hpp"

In sublime add the flags (?s)(?-m) to the front to disable multiline and enable dotall.

Replace with:

#include "script_component.hpp"\n\1

[dedmen]

Looks like you are already on that path. Thank you!

correct I wanted to... Oh.. @SilentSpike Don't steal my work!!!!!111!11"
I'll also do the ACE PR when I find the time. Expect atleast a couple weeks
My main priority is Debugger support. And the Debugger plugin will still take a bit-ish.

[dedmen]

Does anyone know if the documentation generator tool thingy can handle this without problems?
Could already use this in new PR's like https://github.com/CBATeam/CBA_A3/pull/939/files#diff-57a7e296bee76251cea2aa15e625db0bR25 before this is ready so that I don't have to change new things.
I'll try to think about this task tomorrow. Maybe I can get it all done in a day

[dedmen]

This doesn't match the default style. So I'd say it's okey that, that newline is gone?

[kymckay]

Yeah, not sure if you used my regex, but I specifically made it account for cases where there might be space and strip it out

[dedmen]

I used yours. But slightly modified [\s\S] instead of .

[dedmen]

What about files that don't have the include? Like https://github.com/CBATeam/CBA_A3/blob/master/addons/ai/fnc_searchNearby.sqf

lol wtf

CBA_A3/addons/common/fnc_getFov.sqf

Line 28 in ffd5fa7

#include <script_component.hpp>

What should I do with this:

CBA_A3/addons/strings/fnc_formatElapsedTime.sqf

Lines 21 to 22 in 815dac2

	#define DEBUG_MODE_NORMAL
	#include "script_component.hpp"

CBA_A3/addons/strings/fnc_formatNumber.sqf

Lines 58 to 59 in 815dac2

	#define DEBUG_MODE_NORMAL
	#include "script_component.hpp"

CBA_A3/addons/vectors/fnc_polar2vect.sqf

Lines 23 to 26 in fd62c89

	scriptName "fnc_polar2vect.sqf";
	#include "script_component.hpp"
	SCRIPT(polar2vect);

Shouldn't the SCRIPT macro take care of scriptName?

CBA_A3/addons/xeh/fnc_init.sqf

Line 22 in 7f53215

#define DEBUG_SYNCHRONOUS

?

[dedmen]

The last commit has stuff that was not just done automatically. Take special care about that when reviewing the PR.

I'm done now. Just need someone to check the makeDocs script with this. I don't have perl or "NaturalDocs"

[commy2]

Merge asap, to avoid merge conflicts.

[dedmen]

I'll happily fix conflicts. If you merge #939 I'll have to add these anyway.
I'd rather wait for atleast 2 reviews to make sure this is right. Also there are open questions from me above and the documenation generator needs to be tested.

If something is wrong in here it could break CBA at any point, sensitive or not. Don't wanna take that risk

[kymckay]

The last commit looks all good 👍

[dedmen]

Just waiting for #937 (comment)
and #937 (comment)
🕐 ⏳ ⏲ 🌳 🍪

[commy2]

Patience. Will review this week. Promised.

[dedmen]

You wanted it merged asap, not me :D
merge conflicts shouldn't be an issue as this only changes essentially the first line of the scripts. Which is usually never touched.