From cfd84625f0dbd5590e94ecf851bd7b7db5c7665b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= <rverschelde@gmail.com>
Date: Tue, 24 Mar 2020 09:54:49 +0100
Subject: Move DocData and Collada out of their subfolders

Now that the unused DocDump was removed, the `editor/doc` subfolder is
redundant.

Similarly, there's no reason for Collada to have a subfolder for itself
when glTF or OBJ don't.
---
 editor/doc_data.h | 117 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 117 insertions(+)
 create mode 100644 editor/doc_data.h

(limited to 'editor/doc_data.h')

diff --git a/editor/doc_data.h b/editor/doc_data.h
new file mode 100644
index 0000000000..073705f0b1
--- /dev/null
+++ b/editor/doc_data.h
@@ -0,0 +1,117 @@
+/*************************************************************************/
+/*  doc_data.h                                                           */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
+/*                                                                       */
+/* 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 DOC_DATA_H
+#define DOC_DATA_H
+
+#include "core/io/xml_parser.h"
+#include "core/map.h"
+#include "core/variant.h"
+
+class DocData {
+public:
+	struct ArgumentDoc {
+
+		String name;
+		String type;
+		String enumeration;
+		String default_value;
+	};
+
+	struct MethodDoc {
+
+		String name;
+		String return_type;
+		String return_enum;
+		String qualifiers;
+		String description;
+		Vector<ArgumentDoc> arguments;
+		bool operator<(const MethodDoc &p_md) const {
+			return name < p_md.name;
+		}
+	};
+
+	struct ConstantDoc {
+
+		String name;
+		String value;
+		String enumeration;
+		String description;
+	};
+
+	struct PropertyDoc {
+
+		String name;
+		String type;
+		String enumeration;
+		String description;
+		String setter, getter;
+		String default_value;
+		bool overridden;
+		bool operator<(const PropertyDoc &p_prop) const {
+			return name < p_prop.name;
+		}
+		PropertyDoc() {
+			overridden = false;
+		}
+	};
+
+	struct ClassDoc {
+
+		String name;
+		String inherits;
+		String category;
+		String brief_description;
+		String description;
+		Vector<String> tutorials;
+		Vector<MethodDoc> methods;
+		Vector<MethodDoc> signals;
+		Vector<ConstantDoc> constants;
+		Vector<PropertyDoc> properties;
+		Vector<PropertyDoc> theme_properties;
+	};
+
+	String version;
+
+	Map<String, ClassDoc> class_list;
+	Error _load(Ref<XMLParser> parser);
+
+public:
+	void merge_from(const DocData &p_data);
+	void remove_from(const DocData &p_data);
+	void generate(bool p_basic_types = false);
+	Error load_classes(const String &p_dir);
+	static Error erase_classes(const String &p_dir);
+	Error save_classes(const String &p_default_path, const Map<String, String> &p_class_path);
+
+	Error load_compressed(const uint8_t *p_data, int p_compressed_size, int p_uncompressed_size);
+};
+
+#endif // DOC_DATA_H
-- 
cgit v1.2.3