d95794ec8a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
79 lines
3.9 KiB
C++
79 lines
3.9 KiB
C++
/**************************************************************************/
|
|
/* script_debugger.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#ifndef SCRIPT_DEBUGGER_H
|
|
#define SCRIPT_DEBUGGER_H
|
|
|
|
#include "core/object/script_language.h"
|
|
#include "core/string/string_name.h"
|
|
#include "core/templates/hash_set.h"
|
|
#include "core/templates/rb_map.h"
|
|
#include "core/templates/vector.h"
|
|
|
|
class ScriptDebugger {
|
|
typedef ScriptLanguage::StackInfo StackInfo;
|
|
|
|
int lines_left = -1;
|
|
int depth = -1;
|
|
bool skip_breakpoints = false;
|
|
|
|
HashMap<int, HashSet<StringName>> breakpoints;
|
|
|
|
ScriptLanguage *break_lang = nullptr;
|
|
Vector<StackInfo> error_stack_info;
|
|
|
|
public:
|
|
void set_lines_left(int p_left);
|
|
int get_lines_left() const;
|
|
|
|
void set_depth(int p_depth);
|
|
int get_depth() const;
|
|
|
|
String breakpoint_find_source(const String &p_source) const;
|
|
void set_break_language(ScriptLanguage *p_lang) { break_lang = p_lang; }
|
|
ScriptLanguage *get_break_language() { return break_lang; }
|
|
void set_skip_breakpoints(bool p_skip_breakpoints);
|
|
bool is_skipping_breakpoints();
|
|
void insert_breakpoint(int p_line, const StringName &p_source);
|
|
void remove_breakpoint(int p_line, const StringName &p_source);
|
|
bool is_breakpoint(int p_line, const StringName &p_source) const;
|
|
bool is_breakpoint_line(int p_line) const;
|
|
void clear_breakpoints();
|
|
const HashMap<int, HashSet<StringName>> &get_breakpoints() const { return breakpoints; }
|
|
|
|
void debug(ScriptLanguage *p_lang, bool p_can_continue = true, bool p_is_error_breakpoint = false);
|
|
ScriptLanguage *get_break_language() const;
|
|
|
|
void send_error(const String &p_func, const String &p_file, int p_line, const String &p_err, const String &p_descr, bool p_editor_notify, ErrorHandlerType p_type, const Vector<StackInfo> &p_stack_info);
|
|
Vector<StackInfo> get_error_stack_info() const;
|
|
ScriptDebugger() {}
|
|
};
|
|
|
|
#endif // SCRIPT_DEBUGGER_H
|