1/**************************************************************************/
2/* editor_translation_parser.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 EDITOR_TRANSLATION_PARSER_H
32#define EDITOR_TRANSLATION_PARSER_H
33
34#include "core/error/error_list.h"
35#include "core/object/gdvirtual.gen.inc"
36#include "core/object/ref_counted.h"
37#include "core/variant/typed_array.h"
38
39class EditorTranslationParserPlugin : public RefCounted {
40 GDCLASS(EditorTranslationParserPlugin, RefCounted);
41
42protected:
43 static void _bind_methods();
44
45 GDVIRTUAL3(_parse_file, String, TypedArray<String>, TypedArray<Array>)
46 GDVIRTUAL0RC(Vector<String>, _get_recognized_extensions)
47
48public:
49 virtual Error parse_file(const String &p_path, Vector<String> *r_ids, Vector<Vector<String>> *r_ids_ctx_plural);
50 virtual void get_recognized_extensions(List<String> *r_extensions) const;
51};
52
53class EditorTranslationParser {
54 static EditorTranslationParser *singleton;
55
56public:
57 enum ParserType {
58 STANDARD, // GDScript, CSharp, ...
59 CUSTOM // User-defined parser plugins. This will override standard parsers if the same extension type is defined.
60 };
61
62 static EditorTranslationParser *get_singleton();
63
64 Vector<Ref<EditorTranslationParserPlugin>> standard_parsers;
65 Vector<Ref<EditorTranslationParserPlugin>> custom_parsers;
66
67 void get_recognized_extensions(List<String> *r_extensions) const;
68 bool can_parse(const String &p_extension) const;
69 Ref<EditorTranslationParserPlugin> get_parser(const String &p_extension) const;
70 void add_parser(const Ref<EditorTranslationParserPlugin> &p_parser, ParserType p_type);
71 void remove_parser(const Ref<EditorTranslationParserPlugin> &p_parser, ParserType p_type);
72 void clean_parsers();
73
74 EditorTranslationParser();
75 ~EditorTranslationParser();
76};
77
78#endif // EDITOR_TRANSLATION_PARSER_H
79