21043080682

Committed 15 Jan 2026 07:07PM UTC coverage: 91.835% (-0.9%) from 92.743%

Build # 21043080682

Build Type

Pull #628

github

Committed by

web-flow

Commit Message

Merge 453e86f68 into ada0e0686

Pull Request Pull Request #628: Feat/debugger

Coverage Stats

131 of 242 new or added lines in 10 files covered. (54.13%)

2 existing lines in 1 file now uncovered.

8571 of 9333 relevant lines covered (91.84%)

276580.72 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/include/Ark/VM/Debugger.hpp

/**
 * @file Debugger.hpp
 * @author Lexy Plateau (lexplt.dev@gmail.com)
 * @brief Debugger used by the VM when an error or a breakpoint is reached
 * @date 2026-01-12
 *
 * @copyright Copyright (c) 2026-01-12
 *
 */

#ifndef ARK_VM_DEBUGGER_HPP
#define ARK_VM_DEBUGGER_HPP

#include <vector>
#include <memory>
#include <string>
#include <optional>
#include <filesystem>

#include <Ark/VM/Value/Value.hpp>
#include <Ark/VM/ExecutionContext.hpp>

namespace Ark
{
    class VM;
}

namespace Ark::internal
{
    struct SavedState
    {
        std::size_t ip;
        std::size_t pp;
        uint16_t sp;
        uint16_t fc;
        std::vector<ScopeView> locals;
        std::vector<std::shared_ptr<ClosureScope>> closure_scopes;
    };

    class Debugger
    {
    public:
        /**
         * @brief Create a new Debugger object
         *
         * @param context context from the VM before displaying a backtrace
         * @param libenv
         * @param symbols symbols table of the VM
         * @param constants constants table of the VM
         */
        explicit Debugger(const ExecutionContext& context, const std::vector<std::filesystem::path>& libenv, const std::vector<std::string>& symbols, const std::vector<Value>& constants);

        /**
         * @brief Save the current VM state, to get back to it once the debugger is done running
         *
         * @param context
         */
        void saveState(const ExecutionContext& context);

        /**
         * @brief Reset a VM context to the last state saved by the debugger
         *
         * @param context context to reset
         */
        void resetContextToErrorState(ExecutionContext& context);

        /**
         * @brief Start the debugger shell
         *
         * @param vm
         * @param context
         */
        void run(VM& vm, ExecutionContext& context);

        inline bool isRunning() const noexcept
        {
            return m_running;
        }

    private:
        std::vector<std::unique_ptr<SavedState>> m_states;
        std::vector<std::filesystem::path> m_libenv;
        std::vector<std::string> m_symbols;
        std::vector<Value> m_constants;
        bool m_running;

        std::string m_code;  ///< Code added while inside the debugger

        /**
         * @brief Take care of compiling new code using the existing data tables
         *
         * @param code
         * @param start_page_at_offset offset to start the new pages at
         * @return std::optional<std::vector<bytecode_t>> optional set of bytecode pages if compilation succeeded
         */
        std::optional<std::vector<bytecode_t>> compile(const std::string& code, std::size_t start_page_at_offset);
    };
}

#endif  // ARK_VM_DEBUGGER_HPP

1	/**
2	* @file Debugger.hpp
3	* @author Lexy Plateau (lexplt.dev@gmail.com)
4	* @brief Debugger used by the VM when an error or a breakpoint is reached
5	* @date 2026-01-12
6	*
7	* @copyright Copyright (c) 2026-01-12
8	*
9	*/
10
11	#ifndef ARK_VM_DEBUGGER_HPP
12	#define ARK_VM_DEBUGGER_HPP
13
14	#include <vector>
15	#include <memory>
16	#include <string>
17	#include <optional>
18	#include <filesystem>
19
20	#include <Ark/VM/Value/Value.hpp>
21	#include <Ark/VM/ExecutionContext.hpp>
22
23	namespace Ark
24	{
25	class VM;
26	}
27
28	namespace Ark::internal
29	{
NEW 30	struct SavedState	×
31	{
32	std::size_t ip;
33	std::size_t pp;
34	uint16_t sp;
35	uint16_t fc;
36	std::vector<ScopeView> locals;
37	std::vector<std::shared_ptr<ClosureScope>> closure_scopes;
38	};
39
NEW 40	class Debugger	×
41	{
42	public:
43	/**
44	* @brief Create a new Debugger object
45	*
46	* @param context context from the VM before displaying a backtrace
47	* @param libenv
48	* @param symbols symbols table of the VM
49	* @param constants constants table of the VM
50	*/
51	explicit Debugger(const ExecutionContext& context, const std::vector<std::filesystem::path>& libenv, const std::vector<std::string>& symbols, const std::vector<Value>& constants);
52
53	/**
54	* @brief Save the current VM state, to get back to it once the debugger is done running
55	*
56	* @param context
57	*/
58	void saveState(const ExecutionContext& context);
59
60	/**
61	* @brief Reset a VM context to the last state saved by the debugger
62	*
63	* @param context context to reset
64	*/
65	void resetContextToErrorState(ExecutionContext& context);
66
67	/**
68	* @brief Start the debugger shell
69	*
70	* @param vm
71	* @param context
72	*/
73	void run(VM& vm, ExecutionContext& context);
74
NEW 75	inline bool isRunning() const noexcept	×
NEW 76	{	×
NEW 77	return m_running;	×
78	}
79
80	private:
81	std::vector<std::unique_ptr<SavedState>> m_states;
82	std::vector<std::filesystem::path> m_libenv;
83	std::vector<std::string> m_symbols;
84	std::vector<Value> m_constants;
85	bool m_running;
86
87	std::string m_code; ///< Code added while inside the debugger
88
89	/**
90	* @brief Take care of compiling new code using the existing data tables
91	*
92	* @param code
93	* @param start_page_at_offset offset to start the new pages at
94	* @return std::optional<std::vector<bytecode_t>> optional set of bytecode pages if compilation succeeded
95	*/
96	std::optional<std::vector<bytecode_t>> compile(const std::string& code, std::size_t start_page_at_offset);
97	};
98	}
99
100	#endif // ARK_VM_DEBUGGER_HPP

ArkScript-lang / Ark / 21043080682

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous