Correct chunkname

[actboy168]

The chunkname specification is not part of the Lua standard, but following the specification can be more compatible with debugging and profiling tools.

The chunkname specification is included in the lua manual.

source: the source of the chunk that created the function. If source starts with a '@', it means that the function was defined in a file where the file name follows the '@'. If source starts with a '=', the remainder of its contents describes the source in a user-dependent manner. Otherwise, the function was defined in a string where source is that string.

[mikke89]

Thanks!

The first change makes sense (adding the @). The second one however makes it harder to figure out where the script was loaded from when it gives an error, unless I am missing something?

[actboy168]

I added the source url as a comment to the first line. In the error message, it is just a little bit different from before.

Before:

[string "luainvaders/data/game.rml"]:5: error

After:

[string "--luainvaders/data/game.rml..."]:5: error

[mikke89]

I still don't understand the motivation for doing the second change. Do you need the debugger to print the whole code?

Instead of modifying the original code / buffer, perhaps this could be a reasonable change:

Interpreter::DoString(buffer, this->GetSourceURL() + '\n' + buffer);

[actboy168]

Lua does not keep a copy of the source code in memory after compiling the source code. The debugging tool can only find the source code of this function through the chunkname of the function.

Lua's manual defines three specifications for chunkname. One starts with'@', which means that chunkname is the path of the lua source code file; the other starts with'=', which means that chunkname is a custom format, which is useful for debugging tools. In other words, it is equivalent to the source code is not visible; the third is the case outside of the above two formats, which means that chunkname is a piece of Lua source code.

So for your modification, if there is no ‘--’ at the beginning, it means that it is not a legal Lua source code. Secondly, chunkname is one line more than the real source code, which will cause the debugging tool to have a wrong offset in the positioning of the source code.

[mikke89]

Oh, I see now, so the debugger uses the chunkname for viewing and stepping through the code. Thanks for explaining, this is just me not well versed in the Lua world.