Feat/inst locations #530

SuperFola · 2025-04-22T16:42:30Z

Description

Provide instruction source location at runtime, so that we can display better error messages.

Checklist

I have read the Contributor guide
My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have updated the documentation if needed
I have added tests that prove my fix/feature is working
New and existing tests pass locally with my changes

…e generated bytecode This will allow the VM to show source location information when an error is thrown, as well as display nicer error messages to the user.

…ror messages at runtime

…indSourceLocation (was refering to the next instruction instead of the last executed one)

github-actions · 2025-04-22T16:44:30Z

Static analysis report

Lizard report

Listing only functions with cyclomatic complexity >= 15 or NLOC >= 100 or parameters >= 6.

Filename	Start line:end line	Function name	Parameters	NLOC	CCN
src/arkreactor/VM/VM.cpp	327:1584	`Ark::VM::safeRun`	3	1046	212
src/arkreactor/Compiler/BytecodeReader.cpp	274:557	`Ark::BytecodeReader::display`	4	241	95
src/arkreactor/Compiler/Lowerer/ASTLowerer.cpp	485:663	`Ark::internal::ASTLowerer::handleCalls`	5	146	44
src/arkreactor/Compiler/Lowerer/ASTLowerer.cpp	127:231	`Ark::internal::ASTLowerer::compileExpression`	5	86	27
src/arkreactor/Compiler/Lowerer/ASTLowerer.cpp	257:315	`Ark::internal::ASTLowerer::compileListInstruction`	4	48	22
src/arkreactor/VM/VM.cpp	1639:1745	`Ark::VM::backtrace`	3	91	20
src/arkreactor/TypeChecker.cpp	28:108	`Ark::types::displayContract`	4	70	19
src/arkreactor/TypeChecker.cpp	110:188	`Ark::types::generateError`	5	67	18
src/arkreactor/Exceptions.cpp	86:151	`Ark::Diagnostics::makeContext`	7	49	17
src/arkreactor/Exceptions.cpp	154:167	`Ark::Diagnostics::helper`	9	12	4
include/Ark/Exceptions.hpp	111:120	`Ark::ARK_APICodeError::CodeError`	6	10	1

Report about files you didn't modify in this PR

Filename	Start line:end line	Function name	Parameters	NLOC	CCN
src/arkreactor/Compiler/Macros/Processor.cpp	235:608	`Ark::internal::MacroProcessor::evaluate`	3	350	124
src/arkscript/JsonCompiler.cpp	27:257	`JsonCompiler::_compile`	1	198	37
include/Ark/Compiler/AST/Parser.hpp	105:194	`Ark::internal::ARK_APIParser::string`	0	87	32
src/arkreactor/Compiler/NameResolution/NameResolutionPass.cpp	160:267	`Ark::internal::NameResolutionPass::visitKeyword`	3	89	32
src/arkscript/main.cpp	17:346	`main`	2	284	31
src/arkreactor/Compiler/Macros/Processor.cpp	102:185	`Ark::internal::MacroProcessor::processNode`	3	61	27
src/arkreactor/Compiler/AST/Node.cpp	233:306	`Ark::internal::Node::debugPrint`	1	64	24
src/arkreactor/Compiler/NameResolution/NameResolutionPass.cpp	55:158	`Ark::internal::NameResolutionPass::visit`	2	84	23
src/arkreactor/Compiler/AST/Parser.cpp	272:406	`Ark::internal::Parser::import_`	0	108	23
src/arkscript/REPL/Utils.cpp	46:173	`Ark::internal::getColorPerKeyword`	0	106	22
include/utf8.hpp	138:184	`utf8::isValid`	1	44	21
src/arkreactor/Compiler/AST/Optimizer.cpp	33:83	`Ark::internal::Optimizer::countAndPruneDeadCode`	1	42	20
src/arkreactor/Compiler/NameResolution/StaticScope.cpp	67:108	`Ark::internal::NamespaceScope::get`	2	32	18
src/arkreactor/Compiler/AST/Node.cpp	160:231	`Ark::internal::Node::repr`	0	59	18
src/arkreactor/VM/Value.cpp	67:127	`Ark::Value::toString`	1	48	18
src/arkreactor/Compiler/Macros/Executors/Function.cpp	16:88	`Ark::internal::FunctionExecutor::applyMacro`	2	55	17
include/Ark/Compiler/AST/Predicates.hpp	132:156	`Ark::internal::IsSymbol::operator ( )`	1	24	16
src/arkscript/Formatter.cpp	168:224	`Formatter::format`	3	53	16
src/arkreactor/Compiler/Macros/Processor.cpp	690:729	`Ark::internal::MacroProcessor::isConstEval`	1	35	16

CppCheck report

Filename	Line	Type	Description
src/arkreactor/Builtins/IO.cpp	26	style	Variable 'value' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	45	style	Variable 'value' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	61	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	147	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	172	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	192	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	218	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	238	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/IO.cpp	260	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	22	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	42	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	65	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	85	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	106	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	127	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	151	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	175	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	196	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	217	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	237	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	257	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	277	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	294	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	311	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	328	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	345	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	362	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	379	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/Mathematics.cpp	401	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/String.cpp	166	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/System.cpp	43	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/System.cpp	75	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Builtins/System.cpp	99	style	Parameter 'n' can be declared as reference to const
src/arkreactor/Compiler/BytecodeReader.cpp	440	style	struct member 'Arg::kind' is never used.
src/arkreactor/Compiler/IntermediateRepresentation/Entity.cpp	22	style	Local variable 'label' shadows outer function
src/arkreactor/Compiler/IntermediateRepresentation/IROptimizer.cpp	18	performance	Variable 'm_ruleset_two' is assigned in constructor body. Consider performing initialization in initialization list.
src/arkreactor/Compiler/IntermediateRepresentation/IROptimizer.cpp	212	style	Consider using std::find_if algorithm instead of a raw loop.
src/arkreactor/Compiler/IntermediateRepresentation/IROptimizer.cpp	12	style	struct member 'EntityWithOffset::offset' is never used.
src/arkreactor/VM/State.cpp	57	style	Variable 'p' can be declared as reference to const
src/arkreactor/VM/State.cpp	106	style	Variable 'p' can be declared as reference to const
src/arkreactor/VM/VM.cpp	458	style	Statements following 'goto' will never be executed.
src/arkreactor/VM/VM.cpp	1703	style	Variable 'ip' can be declared as pointer to const
src/arkreactor/VM/VM.cpp	365	error	syntax error

Report files about files you didn't modify in this PR

Filename	Line	Type	Description
include/Ark/Compiler/AST/Node.hpp	35	warning	Member variable 'Node::m_type' is not initialized in the constructor.
include/Ark/VM/VM.inl	320	style	Variable 'c' can be declared as reference to const
include/Ark/Compiler/NameResolution/StaticScope.hpp	152	style	Consider using std::any_of algorithm instead of a raw loop.
src/arkreactor/Compiler/AST/BaseParser.cpp	29	style	Local variable 'next' shadows outer function
src/arkreactor/Compiler/AST/Node.cpp	33	performance	Function parameter 'namespace_' should be passed by const reference.
src/arkreactor/Compiler/AST/Optimizer.cpp	54	warning	Either the condition 'node.constList().size()>1' is redundant or node.constList() size can be 2. Expression 'node.constList()[2]' cause access out of bounds.
src/arkreactor/Compiler/AST/Parser.cpp	158	style	Local variable 'symbol' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	188	style	Local variable 'symbol' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	212	style	Local variable 'condition' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	255	style	Local variable 'condition' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	365	style	Local variable 'symbol' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	471	style	Local variable 'node' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	478	style	Local variable 'symbol' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	487	style	Local variable 'node' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	584	style	Local variable 'condition' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	692	style	Local variable 'symbol' shadows outer function
src/arkreactor/Compiler/AST/Parser.cpp	761	style	Local variable 'atom' shadows outer function
src/arkreactor/Compiler/Macros/Processor.cpp	69	warning	Assert statement calls a function which may have desired side effects: 'list'.
src/arkreactor/Compiler/Macros/Processor.cpp	568	style	Local variable 'ast' shadows outer function
src/arkreactor/Compiler/NameResolution/NameResolutionPass.cpp	141	style	Consider using std::find_if algorithm instead of a raw loop.
src/arkreactor/Compiler/NameResolution/ScopeResolver.cpp	55	style	Consider using std::any_of algorithm instead of a raw loop.
src/arkreactor/VM/Value/Closure.cpp	23	style	Consider using std::any_of algorithm instead of a raw loop.
src/arkscript/Formatter.cpp	170	style	Local variable 'output' shadows outer function
src/arkscript/Formatter.cpp	228	style	Local variable 'output' shadows outer function
src/arkscript/Formatter.cpp	396	style	Local variable 'output' shadows outer function
src/arkscript/Formatter.cpp	495	style	Local variable 'output' shadows outer function
src/arkscript/Formatter.cpp	515	style	Local variable 'output' shadows outer function
src/arkscript/JsonCompiler.cpp	184	style	Consider using std::transform algorithm instead of a raw loop.
src/arkscript/REPL/Repl.cpp	21	performance	Variable 'm_keywords' is assigned in constructor body. Consider performing initialization in initialization list.
src/arkscript/REPL/Utils.cpp	33	style	Consider using std::copy algorithm instead of a raw loop.
src/arkscript/REPL/Utils.cpp	35	style	Consider using std::copy algorithm instead of a raw loop.
src/arkscript/REPL/Utils.cpp	37	style	Consider using std::copy algorithm instead of a raw loop.
src/arkscript/REPL/Utils.cpp	39	style	Consider using std::copy algorithm instead of a raw loop.
src/arkscript/REPL/Utils.cpp	53	style	Consider using std::transform algorithm instead of a raw loop.
src/arkscript/REPL/Utils.cpp	55	style	Consider using std::transform algorithm instead of a raw loop.
src/arkscript/REPL/Utils.cpp	64	style	Consider using std::transform algorithm instead of a raw loop.

coveralls · 2025-04-22T16:46:06Z

coverage: 83.196% (+2.8%) from 80.417%
when pulling 718abfd on feat/inst-locations
into 32828a0 on dev.

github-actions · 2025-04-22T17:09:01Z

Fuzzing report

/usr/local/bin/afl-whatsup status check tool for afl-fuzz by Michal Zalewski

Summary stats

    Fuzzers alive : 0
   Dead or remote : 1 (included in stats)
   Total run time : 5 minutes, 0 seconds
      Total execs : 40 thousands
 Cumulative speed : 134 execs/sec
    Pending items : 142 faves, 934 total
 Coverage reached : 11.46%
    Crashes saved : 0
      Hangs saved : 0

Cycles without finds : 0
Time without finds : 0

[+] Captured 40242 tuples (map size 204224, highest value 255, total values 292281376) in '/dev/null'.
[+] A coverage of 40242 edges were achieved out of 204224 existing (19.70%) with 944 input files.

…'s empty

…the error from the context

… of an error

SuperFola added 3 commits April 21, 2025 19:09

feat(compiler, vm): adding instruction source location tracking to th…

f433f9e

…e generated bytecode This will allow the VM to show source location information when an error is thrown, as well as display nicer error messages to the user.

feat(vm): using the instruction source locations to display better er…

d6c110b

…ror messages at runtime

feat(tests, vm): update the diagnostic tests and fixes a bug inside f…

ae6ab6b

…indSourceLocation (was refering to the next instruction instead of the last executed one)

SuperFola force-pushed the feat/inst-locations branch 2 times, most recently from 8232728 to c696372 Compare April 22, 2025 16:57

feat(tests, vm): adding tests for type checking error messages

718abfd

SuperFola force-pushed the feat/inst-locations branch from c696372 to 718abfd Compare April 24, 2025 11:46

SuperFola added 3 commits April 24, 2025 13:54

chore(bytecodereader): fix instruction location table display when it…

aecaa9e

…'s empty

chore(vm): adding some breathing room in error messages, to separate …

59ec307

…the error from the context

feat(vm): compressing identical traces when displaying the stacktrace…

46f10c2

… of an error

SuperFola merged commit 1fc0dc0 into dev Apr 24, 2025
23 checks passed

SuperFola deleted the feat/inst-locations branch April 24, 2025 17:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Feat/inst locations #530

Feat/inst locations #530

Uh oh!

SuperFola commented Apr 22, 2025

Uh oh!

github-actions bot commented Apr 22, 2025 •

edited

Loading

Uh oh!

coveralls commented Apr 22, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 22, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Feat/inst locations #530

Feat/inst locations #530

Uh oh!

Conversation

SuperFola commented Apr 22, 2025

Description

Checklist

Uh oh!

github-actions bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Static analysis report

Lizard report

CppCheck report

Uh oh!

coveralls commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fuzzing report

Summary stats

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 22, 2025 •

edited

Loading

coveralls commented Apr 22, 2025 •

edited

Loading

github-actions bot commented Apr 22, 2025 •

edited

Loading