/*************************************************************************/ /* doc_data.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2018 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. */ /*************************************************************************/ #include "doc_data.h" #include "version.h" #include "global_constants.h" #include "globals.h" #include "io/compression.h" #include "io/marshalls.h" #include "scene/resources/theme.h" #include "script_language.h" void DocData::merge_from(const DocData &p_data) { for (Map::Element *E = class_list.front(); E; E = E->next()) { ClassDoc &c = E->get(); if (!p_data.class_list.has(c.name)) continue; const ClassDoc &cf = p_data.class_list[c.name]; c.description = cf.description; c.brief_description = cf.brief_description; for (int i = 0; i < c.methods.size(); i++) { MethodDoc &m = c.methods[i]; for (int j = 0; j < cf.methods.size(); j++) { if (cf.methods[j].name != m.name) continue; if (cf.methods[j].arguments.size() != m.arguments.size()) continue; // since polymorphic functions are allowed we need to check the type of // the arguments so we make sure they are different. int arg_count = cf.methods[j].arguments.size(); Vector arg_used; arg_used.resize(arg_count); for (int l = 0; l < arg_count; ++l) arg_used[l] = false; // also there is no guarantee that argument ordering will match, so we // have to check one by one so we make sure we have an exact match for (int k = 0; k < arg_count; ++k) { for (int l = 0; l < arg_count; ++l) if (cf.methods[j].arguments[k].type == m.arguments[l].type && !arg_used[l]) { arg_used[l] = true; break; } } bool not_the_same = false; for (int l = 0; l < arg_count; ++l) if (!arg_used[l]) // at least one of the arguments was different not_the_same = true; if (not_the_same) continue; const MethodDoc &mf = cf.methods[j]; m.description = mf.description; break; } } for (int i = 0; i < c.signals.size(); i++) { MethodDoc &m = c.signals[i]; for (int j = 0; j < cf.signals.size(); j++) { if (cf.signals[j].name != m.name) continue; const MethodDoc &mf = cf.signals[j]; m.description = mf.description; break; } } for (int i = 0; i < c.constants.size(); i++) { ConstantDoc &m = c.constants[i]; for (int j = 0; j < cf.constants.size(); j++) { if (cf.constants[j].name != m.name) continue; const ConstantDoc &mf = cf.constants[j]; m.description = mf.description; break; } } for (int i = 0; i < c.properties.size(); i++) { PropertyDoc &p = c.properties[i]; for (int j = 0; j < cf.properties.size(); j++) { if (cf.properties[j].name != p.name) continue; const PropertyDoc &pf = cf.properties[j]; p.description = pf.description; break; } } for (int i = 0; i < c.theme_properties.size(); i++) { PropertyDoc &p = c.theme_properties[i]; for (int j = 0; j < cf.theme_properties.size(); j++) { if (cf.theme_properties[j].name != p.name) continue; const PropertyDoc &pf = cf.theme_properties[j]; p.description = pf.description; break; } } } } void DocData::generate(bool p_basic_types) { List classes; ObjectTypeDB::get_type_list(&classes); classes.sort_custom(); while (classes.size()) { String name = classes.front()->get(); String cname = name; if (cname.begins_with("_")) //proxy class cname = cname.substr(1, name.length()); class_list[cname] = ClassDoc(); ClassDoc &c = class_list[cname]; c.name = cname; c.inherits = ObjectTypeDB::type_inherits_from(name); c.category = ObjectTypeDB::get_category(name); List method_list; ObjectTypeDB::get_method_list(name, &method_list, true); method_list.sort(); for (List::Element *E = method_list.front(); E; E = E->next()) { if (E->get().name == "" || (E->get().name[0] == '_' && !(E->get().flags & METHOD_FLAG_VIRTUAL))) continue; //hiden, dont count MethodDoc method; method.name = E->get().name; MethodBind *m = ObjectTypeDB::get_method(name, E->get().name); if (E->get().flags & METHOD_FLAG_VIRTUAL) method.qualifiers = "virtual"; if (E->get().flags & METHOD_FLAG_CONST) { if (method.qualifiers != "") method.qualifiers += " "; method.qualifiers += "const"; } for (int i = -1; i < E->get().arguments.size(); i++) { PropertyInfo arginfo; if (i == -1) { arginfo = E->get().return_val; #ifdef DEBUG_METHODS_ENABLED if (m && m->get_return_type() != StringName()) method.return_type = m->get_return_type(); else if (method.name.find(":") != -1) { method.return_type = method.name.get_slice(":", 1); method.name = method.name.get_slice(":", 0); } else if (arginfo.type != Variant::NIL) // { #endif method.return_type = (arginfo.hint == PROPERTY_HINT_RESOURCE_TYPE) ? arginfo.hint_string : Variant::get_type_name(arginfo.type); // } } else { ArgumentDoc argument; arginfo = E->get().arguments[i]; String type_name; if (arginfo.name.find(":") != -1) { type_name = arginfo.name.get_slice(":", 1); arginfo.name = arginfo.name.get_slice(":", 0); } else if (arginfo.hint == PROPERTY_HINT_RESOURCE_TYPE) { type_name = arginfo.hint_string; } else if (arginfo.type == Variant::NIL) type_name = "Variant"; else type_name = Variant::get_type_name(arginfo.type); if (arginfo.type == Variant::OBJECT) { //print_line("validate: "+cname+"::"+method.name); } if (m && m->has_default_argument(i)) { Variant default_arg = m->get_default_argument(i); String default_arg_text = m->get_default_argument(i); switch (default_arg.get_type()) { case Variant::NIL: default_arg_text = "NULL"; break; // atomic types case Variant::BOOL: if (bool(default_arg)) default_arg_text = "true"; else default_arg_text = "false"; break; case Variant::INT: case Variant::REAL: //keep it break; case Variant::STRING: // 15 case Variant::NODE_PATH: // 15 default_arg_text = "\"" + default_arg_text + "\""; break; case Variant::TRANSFORM: if (default_arg.operator Transform() == Transform()) { default_arg_text = ""; } default_arg_text = Variant::get_type_name(default_arg.get_type()) + "(" + default_arg_text + ")"; break; case Variant::_AABB: //sorry naming convention fail :( not like it's used often // 10 case Variant::COLOR: case Variant::PLANE: case Variant::RAW_ARRAY: case Variant::INT_ARRAY: case Variant::REAL_ARRAY: case Variant::STRING_ARRAY: //25 case Variant::VECTOR2_ARRAY: case Variant::VECTOR3_ARRAY: case Variant::COLOR_ARRAY: default_arg_text = Variant::get_type_name(default_arg.get_type()) + "(" + default_arg_text + ")"; break; case Variant::VECTOR2: // 5 case Variant::RECT2: case Variant::VECTOR3: case Variant::QUAT: case Variant::MATRIX3: default_arg_text = Variant::get_type_name(default_arg.get_type()) + default_arg_text; break; case Variant::OBJECT: if (default_arg.is_zero()) { default_arg_text = "NULL"; break; } case Variant::INPUT_EVENT: case Variant::DICTIONARY: // 20 case Variant::ARRAY: case Variant::_RID: case Variant::IMAGE: //case Variant::RESOURCE: default_arg_text = Variant::get_type_name(default_arg.get_type()) + "()"; break; default: {} } argument.type = type_name; argument.name = arginfo.name; argument.default_value = default_arg_text; } else { argument.type = type_name; argument.name = arginfo.name; } if (arginfo.type == Variant::OBJECT) { //print_line("validate: "+cname+"::"+method.name); } method.arguments.push_back(argument); } /* String hint; switch(arginfo.hint) { case PROPERTY_HINT_DIR: hint="A directory."; break; case PROPERTY_HINT_RANGE: hint="Range - min: "+arginfo.hint_string.get_slice(",",0)+" max: "+arginfo.hint_string.get_slice(",",1)+" step: "+arginfo.hint_string.get_slice(",",2); break; case PROPERTY_HINT_ENUM: hint="Values: "; for(int j=0;j0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(j); } break; case PROPERTY_HINT_LENGTH: hint="Length: "+arginfo.hint_string; break; case PROPERTY_HINT_FLAGS: hint="Values: "; for(int j=0;j0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(1< signal_list; ObjectTypeDB::get_signal_list(name, &signal_list, true); if (signal_list.size()) { for (List::Element *EV = signal_list.front(); EV; EV = EV->next()) { MethodDoc signal; signal.name = EV->get().name; for (int i = 0; i < EV->get().arguments.size(); i++) { PropertyInfo arginfo = EV->get().arguments[i]; ArgumentDoc argument; argument.name = arginfo.name; argument.type = Variant::get_type_name(arginfo.type); signal.arguments.push_back(argument); } c.signals.push_back(signal); } } List constant_list; ObjectTypeDB::get_integer_constant_list(name, &constant_list, true); for (List::Element *E = constant_list.front(); E; E = E->next()) { ConstantDoc constant; constant.name = E->get(); constant.value = itos(ObjectTypeDB::get_integer_constant(name, E->get())); c.constants.push_back(constant); } //theme stuff { List l; Theme::get_default()->get_constant_list(cname, &l); for (List::Element *E = l.front(); E; E = E->next()) { PropertyDoc pd; pd.name = E->get(); pd.type = "int"; c.theme_properties.push_back(pd); } l.clear(); Theme::get_default()->get_color_list(cname, &l); for (List::Element *E = l.front(); E; E = E->next()) { PropertyDoc pd; pd.name = E->get(); pd.type = "Color"; c.theme_properties.push_back(pd); } l.clear(); Theme::get_default()->get_icon_list(cname, &l); for (List::Element *E = l.front(); E; E = E->next()) { PropertyDoc pd; pd.name = E->get(); pd.type = "Texture"; c.theme_properties.push_back(pd); } l.clear(); Theme::get_default()->get_font_list(cname, &l); for (List::Element *E = l.front(); E; E = E->next()) { PropertyDoc pd; pd.name = E->get(); pd.type = "Font"; c.theme_properties.push_back(pd); } l.clear(); Theme::get_default()->get_stylebox_list(cname, &l); for (List::Element *E = l.front(); E; E = E->next()) { PropertyDoc pd; pd.name = E->get(); pd.type = "StyleBox"; c.theme_properties.push_back(pd); } } classes.pop_front(); } { //so it can be documented that it does not exist class_list["Variant"] = ClassDoc(); class_list["Variant"].name = "Variant"; } if (!p_basic_types) return; for (int i = 0; i < Variant::VARIANT_MAX; i++) { if (i == Variant::OBJECT) continue; //use the core type instead int loops = 1; if (i == Variant::INPUT_EVENT) loops = InputEvent::TYPE_MAX; for (int j = 0; j < loops; j++) { String cname = Variant::get_type_name(Variant::Type(i)); if (i == Variant::INPUT_EVENT) { static const char *ie_type[InputEvent::TYPE_MAX] = { "", "Key", "MouseMotion", "MouseButton", "JoystickMotion", "JoystickButton", "ScreenTouch", "ScreenDrag", "Action" }; cname += ie_type[j]; } class_list[cname] = ClassDoc(); ClassDoc &c = class_list[cname]; c.name = cname; c.category = "Built-In Types"; Variant::CallError cerror; Variant v = Variant::construct(Variant::Type(i), NULL, 0, cerror); if (i == Variant::INPUT_EVENT) { v.set("type", j); } List method_list; v.get_method_list(&method_list); method_list.sort(); Variant::get_constructor_list(Variant::Type(i), &method_list); for (List::Element *E = method_list.front(); E; E = E->next()) { MethodInfo &mi = E->get(); MethodDoc method; method.name = mi.name; for (int i = 0; i < mi.arguments.size(); i++) { ArgumentDoc arg; PropertyInfo pi = mi.arguments[i]; arg.name = pi.name; //print_line("arg name: "+arg.name); if (pi.type == Variant::NIL) arg.type = "var"; else arg.type = Variant::get_type_name(pi.type); int defarg = mi.default_arguments.size() - mi.arguments.size() + i; if (defarg >= 0) arg.default_value = mi.default_arguments[defarg]; method.arguments.push_back(arg); } if (mi.return_val.type == Variant::NIL) { if (mi.return_val.name != "") method.return_type = "var"; } else { method.return_type = Variant::get_type_name(mi.return_val.type); } c.methods.push_back(method); } List properties; v.get_property_list(&properties); for (List::Element *E = properties.front(); E; E = E->next()) { PropertyInfo pi = E->get(); PropertyDoc property; property.name = pi.name; property.type = Variant::get_type_name(pi.type); c.properties.push_back(property); } List constants; Variant::get_numeric_constants_for_type(Variant::Type(i), &constants); for (List::Element *E = constants.front(); E; E = E->next()) { ConstantDoc constant; constant.name = E->get(); constant.value = itos(Variant::get_numeric_constant_value(Variant::Type(i), E->get())); c.constants.push_back(constant); } } } //built in constants and functions { String cname = "@Global Scope"; class_list[cname] = ClassDoc(); ClassDoc &c = class_list[cname]; c.name = cname; for (int i = 0; i < GlobalConstants::get_global_constant_count(); i++) { ConstantDoc cd; cd.name = GlobalConstants::get_global_constant_name(i); cd.value = itos(GlobalConstants::get_global_constant_value(i)); c.constants.push_back(cd); } List singletons; Globals::get_singleton()->get_singletons(&singletons); //servers (this is kind of hackish) for (List::Element *E = singletons.front(); E; E = E->next()) { PropertyDoc pd; Globals::Singleton &s = E->get(); pd.name = s.name; pd.type = s.ptr->get_type(); while (String(ObjectTypeDB::type_inherits_from(pd.type)) != "Object") pd.type = ObjectTypeDB::type_inherits_from(pd.type); if (pd.type.begins_with("_")) pd.type = pd.type.substr(1, pd.type.length()); c.properties.push_back(pd); } } //built in script reference { for (int i = 0; i < ScriptServer::get_language_count(); i++) { ScriptLanguage *lang = ScriptServer::get_language(i); String cname = "@" + lang->get_name(); class_list[cname] = ClassDoc(); ClassDoc &c = class_list[cname]; c.name = cname; List minfo; lang->get_public_functions(&minfo); for (List::Element *E = minfo.front(); E; E = E->next()) { MethodInfo &mi = E->get(); MethodDoc md; md.name = mi.name; if (mi.return_val.name != "") md.return_type = mi.return_val.name; else if (mi.name.find(":") != -1) { md.return_type = mi.name.get_slice(":", 1); md.name = mi.name.get_slice(":", 0); } else md.return_type = Variant::get_type_name(mi.return_val.type); for (int i = 0; i < mi.arguments.size(); i++) { PropertyInfo &pi = mi.arguments[i]; ArgumentDoc ad; ad.name = pi.name; if (pi.type == Variant::NIL) ad.type = "Variant"; else ad.type = Variant::get_type_name(pi.type); md.arguments.push_back(ad); } c.methods.push_back(md); } List > cinfo; lang->get_public_constants(&cinfo); for (List >::Element *E = cinfo.front(); E; E = E->next()) { ConstantDoc cd; cd.name = E->get().first; cd.value = E->get().second; c.constants.push_back(cd); } } } } static Error _parse_methods(Ref &parser, Vector &methods) { String section = parser->get_node_name(); String element = section.substr(0, section.length() - 1); while (parser->read() == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { if (parser->get_node_name() == element) { DocData::MethodDoc method; ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); method.name = parser->get_attribute_value("name"); if (parser->has_attribute("qualifiers")) method.qualifiers = parser->get_attribute_value("qualifiers"); while (parser->read() == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { String name = parser->get_node_name(); if (name == "return") { ERR_FAIL_COND_V(!parser->has_attribute("type"), ERR_FILE_CORRUPT); method.return_type = parser->get_attribute_value("type"); } else if (name == "argument") { DocData::ArgumentDoc argument; ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); argument.name = parser->get_attribute_value("name"); ERR_FAIL_COND_V(!parser->has_attribute("type"), ERR_FILE_CORRUPT); argument.type = parser->get_attribute_value("type"); method.arguments.push_back(argument); } else if (name == "description") { parser->read(); if (parser->get_node_type() == XMLParser::NODE_TEXT) method.description = parser->get_node_data().strip_edges(); } } else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == element) break; } methods.push_back(method); } else { ERR_EXPLAIN("Invalid tag in doc file: " + parser->get_node_name()); ERR_FAIL_V(ERR_FILE_CORRUPT); } } else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == section) break; } return OK; } Error DocData::load(const String &p_path) { Ref parser = memnew(XMLParser); Error err = parser->open(p_path); if (err) return err; return _load(parser); } Error DocData::_load(Ref parser) { Error err = OK; while ((err = parser->read()) == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { if (parser->get_node_name() == "doc") { break; } else if (!parser->is_empty()) parser->skip_section(); // unknown section, likely headers } } if (parser->has_attribute("version")) version = parser->get_attribute_value("version"); while ((err = parser->read()) == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == "doc") break; //end of if (parser->get_node_type() != XMLParser::NODE_ELEMENT) continue; //no idea what this may be, but skipping anyway ERR_FAIL_COND_V(parser->get_node_name() != "class", ERR_FILE_CORRUPT); ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); String name = parser->get_attribute_value("name"); class_list[name] = ClassDoc(); ClassDoc &c = class_list[name]; // print_line("class: "+name); c.name = name; if (parser->has_attribute("inherits")) c.inherits = parser->get_attribute_value("inherits"); if (parser->has_attribute("category")) c.category = parser->get_attribute_value("category"); while (parser->read() == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { String name = parser->get_node_name(); if (name == "brief_description") { parser->read(); if (parser->get_node_type() == XMLParser::NODE_TEXT) c.brief_description = parser->get_node_data().strip_edges(); } else if (name == "description") { parser->read(); if (parser->get_node_type() == XMLParser::NODE_TEXT) c.description = parser->get_node_data().strip_edges(); } else if (name == "methods") { Error err = _parse_methods(parser, c.methods); ERR_FAIL_COND_V(err, err); } else if (name == "signals") { Error err = _parse_methods(parser, c.signals); ERR_FAIL_COND_V(err, err); } else if (name == "members") { while (parser->read() == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { String name = parser->get_node_name(); if (name == "member") { PropertyDoc prop; ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); prop.name = parser->get_attribute_value("name"); ERR_FAIL_COND_V(!parser->has_attribute("type"), ERR_FILE_CORRUPT); prop.type = parser->get_attribute_value("type"); parser->read(); if (parser->get_node_type() == XMLParser::NODE_TEXT) prop.description = parser->get_node_data().strip_edges(); c.properties.push_back(prop); } else { ERR_EXPLAIN("Invalid tag in doc file: " + name); ERR_FAIL_V(ERR_FILE_CORRUPT); } } else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == "members") break; //end of } } else if (name == "theme_items") { while (parser->read() == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { String name = parser->get_node_name(); if (name == "theme_item") { PropertyDoc prop; ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); prop.name = parser->get_attribute_value("name"); ERR_FAIL_COND_V(!parser->has_attribute("type"), ERR_FILE_CORRUPT); prop.type = parser->get_attribute_value("type"); parser->read(); if (parser->get_node_type() == XMLParser::NODE_TEXT) prop.description = parser->get_node_data().strip_edges(); c.theme_properties.push_back(prop); } else { ERR_EXPLAIN("Invalid tag in doc file: " + name); ERR_FAIL_V(ERR_FILE_CORRUPT); } } else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == "theme_items") break; //end of } } else if (name == "constants") { while (parser->read() == OK) { if (parser->get_node_type() == XMLParser::NODE_ELEMENT) { String name = parser->get_node_name(); if (name == "constant") { ConstantDoc constant; ERR_FAIL_COND_V(!parser->has_attribute("name"), ERR_FILE_CORRUPT); constant.name = parser->get_attribute_value("name"); ERR_FAIL_COND_V(!parser->has_attribute("value"), ERR_FILE_CORRUPT); constant.value = parser->get_attribute_value("value"); parser->read(); if (parser->get_node_type() == XMLParser::NODE_TEXT) constant.description = parser->get_node_data().strip_edges(); c.constants.push_back(constant); } else { ERR_EXPLAIN("Invalid tag in doc file: " + name); ERR_FAIL_V(ERR_FILE_CORRUPT); } } else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == "constants") break; //end of } } else { ERR_EXPLAIN("Invalid tag in doc file: " + name); ERR_FAIL_V(ERR_FILE_CORRUPT); } } else if (parser->get_node_type() == XMLParser::NODE_ELEMENT_END && parser->get_node_name() == "class") break; //end of } } return OK; } static void _write_string(FileAccess *f, int p_tablevel, const String &p_string) { String tab; for (int i = 0; i < p_tablevel; i++) tab += "\t"; f->store_string(tab + p_string + "\n"); } Error DocData::save(const String &p_path) { Error err; FileAccess *f = FileAccess::open(p_path, FileAccess::WRITE, &err); if (err) { ERR_EXPLAIN("Can't write doc file: " + p_path); ERR_FAIL_V(err); } _write_string(f, 0, ""); _write_string(f, 0, ""); for (Map::Element *E = class_list.front(); E; E = E->next()) { ClassDoc &c = E->get(); String header = ""); if (c.brief_description != "") _write_string(f, 2, c.brief_description.xml_escape()); _write_string(f, 1, ""); _write_string(f, 1, ""); if (c.description != "") _write_string(f, 2, c.description.xml_escape()); _write_string(f, 1, ""); _write_string(f, 1, ""); c.methods.sort(); for (int i = 0; i < c.methods.size(); i++) { MethodDoc &m = c.methods[i]; String qualifiers; if (m.qualifiers != "") qualifiers += " qualifiers=\"" + m.qualifiers.xml_escape() + "\""; _write_string(f, 2, ""); if (m.return_type != "") { _write_string(f, 3, ""); _write_string(f, 3, ""); } for (int j = 0; j < m.arguments.size(); j++) { ArgumentDoc &a = m.arguments[j]; if (a.default_value != "") _write_string(f, 3, ""); else _write_string(f, 3, ""); _write_string(f, 3, ""); } _write_string(f, 3, ""); if (m.description != "") _write_string(f, 4, m.description.xml_escape()); _write_string(f, 3, ""); _write_string(f, 2, ""); } _write_string(f, 1, ""); if (c.properties.size()) { _write_string(f, 1, ""); c.properties.sort(); for (int i = 0; i < c.properties.size(); i++) { PropertyDoc &p = c.properties[i]; _write_string(f, 2, ""); if (p.description != "") _write_string(f, 3, p.description.xml_escape()); _write_string(f, 2, ""); } _write_string(f, 1, ""); } if (c.signals.size()) { c.signals.sort(); _write_string(f, 1, ""); for (int i = 0; i < c.signals.size(); i++) { MethodDoc &m = c.signals[i]; _write_string(f, 2, ""); for (int j = 0; j < m.arguments.size(); j++) { ArgumentDoc &a = m.arguments[j]; _write_string(f, 3, ""); _write_string(f, 3, ""); } _write_string(f, 3, ""); if (m.description != "") _write_string(f, 4, m.description.xml_escape()); _write_string(f, 3, ""); _write_string(f, 2, ""); } _write_string(f, 1, ""); } _write_string(f, 1, ""); for (int i = 0; i < c.constants.size(); i++) { ConstantDoc &k = c.constants[i]; _write_string(f, 2, ""); if (k.description != "") _write_string(f, 3, k.description.xml_escape()); _write_string(f, 2, ""); } _write_string(f, 1, ""); if (c.theme_properties.size()) { c.theme_properties.sort(); _write_string(f, 1, ""); for (int i = 0; i < c.theme_properties.size(); i++) { PropertyDoc &p = c.theme_properties[i]; _write_string(f, 2, ""); _write_string(f, 2, ""); } _write_string(f, 1, ""); } _write_string(f, 0, ""); } _write_string(f, 0, ""); f->close(); memdelete(f); return OK; } Error DocData::load_compressed(const uint8_t *p_data, int p_compressed_size, int p_uncompressed_size) { Vector data; data.resize(p_uncompressed_size); Compression::decompress(data.ptr(), p_uncompressed_size, p_data, p_compressed_size, Compression::MODE_DEFLATE); class_list.clear(); Ref parser = memnew(XMLParser); Error err = parser->open_buffer(data); if (err) return err; _load(parser); return OK; }