1/**************************************************************************/
2/* gdscript_translation_parser_plugin.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef GDSCRIPT_TRANSLATION_PARSER_PLUGIN_H
32#define GDSCRIPT_TRANSLATION_PARSER_PLUGIN_H
33
34#include "../gdscript_parser.h"
35
36#include "core/templates/hash_set.h"
37#include "editor/editor_translation_parser.h"
38
39class GDScriptEditorTranslationParserPlugin : public EditorTranslationParserPlugin {
40 GDCLASS(GDScriptEditorTranslationParserPlugin, EditorTranslationParserPlugin);
41
42 Vector<String> *ids = nullptr;
43 Vector<Vector<String>> *ids_ctx_plural = nullptr;
44
45 // List of patterns used for extracting translation strings.
46 StringName tr_func = "tr";
47 StringName trn_func = "tr_n";
48 HashSet<StringName> assignment_patterns;
49 HashSet<StringName> first_arg_patterns;
50 HashSet<StringName> second_arg_patterns;
51 // FileDialog patterns.
52 StringName fd_add_filter = "add_filter";
53 StringName fd_set_filter = "set_filters";
54 StringName fd_filters = "filters";
55
56 static bool _is_constant_string(const GDScriptParser::ExpressionNode *p_expression);
57
58 void _traverse_class(const GDScriptParser::ClassNode *p_class);
59 void _traverse_function(const GDScriptParser::FunctionNode *p_func);
60 void _traverse_block(const GDScriptParser::SuiteNode *p_suite);
61
62 void _read_variable(const GDScriptParser::VariableNode *p_var);
63 void _assess_expression(const GDScriptParser::ExpressionNode *p_expression);
64 void _assess_assignment(const GDScriptParser::AssignmentNode *p_assignment);
65 void _extract_from_call(const GDScriptParser::CallNode *p_call);
66 void _extract_fd_constant_strings(const GDScriptParser::ExpressionNode *p_expression);
67
68public:
69 virtual Error parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural) override;
70 virtual void get_recognized_extensions(List<String> *r_extensions) const override;
71
72 GDScriptEditorTranslationParserPlugin();
73};
74
75#endif // GDSCRIPT_TRANSLATION_PARSER_PLUGIN_H
76