2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* gdscript_highlighter.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. */
|
|
|
|
/**************************************************************************/
|
2018-04-02 11:41:44 +00:00
|
|
|
|
|
|
|
#ifndef GDSCRIPT_HIGHLIGHTER_H
|
|
|
|
#define GDSCRIPT_HIGHLIGHTER_H
|
|
|
|
|
2020-05-03 16:08:15 +00:00
|
|
|
#include "editor/plugins/script_editor_plugin.h"
|
2018-04-02 11:41:44 +00:00
|
|
|
#include "scene/gui/text_edit.h"
|
|
|
|
|
2020-05-03 16:08:15 +00:00
|
|
|
class GDScriptSyntaxHighlighter : public EditorSyntaxHighlighter {
|
|
|
|
GDCLASS(GDScriptSyntaxHighlighter, EditorSyntaxHighlighter)
|
2020-03-07 14:29:44 +00:00
|
|
|
|
2018-04-02 11:41:44 +00:00
|
|
|
private:
|
2020-05-03 16:08:15 +00:00
|
|
|
struct ColorRegion {
|
|
|
|
Color color;
|
|
|
|
String start_key;
|
|
|
|
String end_key;
|
2020-11-24 09:12:55 +00:00
|
|
|
bool line_only = false;
|
2020-05-03 16:08:15 +00:00
|
|
|
};
|
|
|
|
Vector<ColorRegion> color_regions;
|
2022-05-13 13:04:37 +00:00
|
|
|
HashMap<int, int> color_region_cache;
|
2020-05-03 16:08:15 +00:00
|
|
|
|
2022-10-12 05:18:19 +00:00
|
|
|
HashMap<StringName, Color> class_names;
|
|
|
|
HashMap<StringName, Color> reserved_keywords;
|
2021-08-14 06:42:18 +00:00
|
|
|
HashMap<StringName, Color> member_keywords;
|
2022-08-20 09:23:31 +00:00
|
|
|
HashSet<StringName> global_functions;
|
2020-05-03 16:08:15 +00:00
|
|
|
|
2018-04-12 20:46:10 +00:00
|
|
|
enum Type {
|
|
|
|
NONE,
|
|
|
|
REGION,
|
2018-04-12 22:49:44 +00:00
|
|
|
NODE_PATH,
|
2022-06-26 19:33:13 +00:00
|
|
|
NODE_REF,
|
2021-06-06 19:19:59 +00:00
|
|
|
ANNOTATION,
|
2022-06-26 19:33:13 +00:00
|
|
|
STRING_NAME,
|
2018-04-12 20:46:10 +00:00
|
|
|
SYMBOL,
|
|
|
|
NUMBER,
|
|
|
|
FUNCTION,
|
2021-08-20 10:21:34 +00:00
|
|
|
SIGNAL,
|
2018-04-12 20:46:10 +00:00
|
|
|
KEYWORD,
|
|
|
|
MEMBER,
|
2018-05-30 02:16:58 +00:00
|
|
|
IDENTIFIER,
|
|
|
|
TYPE,
|
2018-04-12 20:46:10 +00:00
|
|
|
};
|
|
|
|
|
2022-08-20 09:23:31 +00:00
|
|
|
// Colors.
|
2018-04-02 11:41:44 +00:00
|
|
|
Color font_color;
|
|
|
|
Color symbol_color;
|
|
|
|
Color function_color;
|
2022-08-20 09:23:31 +00:00
|
|
|
Color global_function_color;
|
2018-04-12 21:26:15 +00:00
|
|
|
Color function_definition_color;
|
2018-04-02 11:41:44 +00:00
|
|
|
Color built_in_type_color;
|
|
|
|
Color number_color;
|
|
|
|
Color member_color;
|
2018-04-12 22:49:44 +00:00
|
|
|
Color node_path_color;
|
2022-06-26 19:33:13 +00:00
|
|
|
Color node_ref_color;
|
2021-06-06 19:19:59 +00:00
|
|
|
Color annotation_color;
|
2022-06-26 19:33:13 +00:00
|
|
|
Color string_name_color;
|
2018-05-30 02:16:58 +00:00
|
|
|
Color type_color;
|
2018-04-02 11:41:44 +00:00
|
|
|
|
2023-07-21 18:31:52 +00:00
|
|
|
enum CommentMarkerLevel {
|
|
|
|
COMMENT_MARKER_CRITICAL,
|
|
|
|
COMMENT_MARKER_WARNING,
|
|
|
|
COMMENT_MARKER_NOTICE,
|
|
|
|
COMMENT_MARKER_MAX,
|
|
|
|
};
|
|
|
|
Color comment_marker_colors[COMMENT_MARKER_MAX];
|
|
|
|
HashMap<String, CommentMarkerLevel> comment_markers;
|
|
|
|
|
2020-05-03 16:08:15 +00:00
|
|
|
void add_color_region(const String &p_start_key, const String &p_end_key, const Color &p_color, bool p_line_only = false);
|
|
|
|
|
2018-04-02 11:41:44 +00:00
|
|
|
public:
|
2020-03-07 14:29:44 +00:00
|
|
|
virtual void _update_cache() override;
|
2021-08-22 01:52:44 +00:00
|
|
|
virtual Dictionary _get_line_syntax_highlighting_impl(int p_line) override;
|
2018-04-02 11:41:44 +00:00
|
|
|
|
2020-03-07 14:29:44 +00:00
|
|
|
virtual String _get_name() const override;
|
2022-08-05 01:41:48 +00:00
|
|
|
virtual PackedStringArray _get_supported_languages() const override;
|
2018-04-02 11:41:44 +00:00
|
|
|
|
2020-05-03 16:08:15 +00:00
|
|
|
virtual Ref<EditorSyntaxHighlighter> _create() const override;
|
2018-04-02 11:41:44 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // GDSCRIPT_HIGHLIGHTER_H
|