1/**************************************************************************/
2/* doc_tools.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 DOC_TOOLS_H
32#define DOC_TOOLS_H
33
34#include "core/doc_data.h"
35
36class DocTools {
37public:
38 String version;
39 HashMap<String, DocData::ClassDoc> class_list;
40
41 static Error erase_classes(const String &p_dir);
42
43 void merge_from(const DocTools &p_data);
44 void remove_from(const DocTools &p_data);
45 void add_doc(const DocData::ClassDoc &p_class_doc);
46 void remove_doc(const String &p_class_name);
47 bool has_doc(const String &p_class_name);
48 void generate(bool p_basic_types = false);
49 Error load_classes(const String &p_dir);
50 Error save_classes(const String &p_default_path, const HashMap<String, String> &p_class_path, bool p_include_xml_schema = true);
51
52 Error _load(Ref<XMLParser> parser);
53 Error load_compressed(const uint8_t *p_data, int p_compressed_size, int p_uncompressed_size);
54};
55
56#endif // DOC_TOOLS_H
57