void DocDump::dump(const String &p_file) { List<StringName> class_list; ClassDB::get_class_list(&class_list); class_list.sort_custom<StringName::AlphCompare>(); FileAccess *f = FileAccess::open(p_file, FileAccess::WRITE); _write_string(f, 0, "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>"); _write_string(f, 0, "<doc version=\"" + String(VERSION_MKSTRING) + "\" name=\"Engine Types\">"); while (class_list.size()) { String name = class_list.front()->get(); String header = "<class name=\"" + name + "\""; String inherits = ClassDB::get_parent_class(name); if (inherits != "") header += " inherits=\"" + inherits + "\""; String category = ClassDB::get_category(name); if (category == "") category = "Core"; header += " category=\"" + category + "\""; header += ">"; _write_string(f, 0, header); _write_string(f, 1, "<brief_description>"); _write_string(f, 1, "</brief_description>"); _write_string(f, 1, "<description>"); _write_string(f, 1, "</description>"); _write_string(f, 1, "<methods>"); List<MethodInfo> method_list; ClassDB::get_method_list(name, &method_list, true); method_list.sort(); for (List<MethodInfo>::Element *E = method_list.front(); E; E = E->next()) { if (E->get().name == "" || E->get().name[0] == '_') continue; //hiden MethodBind *m = ClassDB::get_method(name, E->get().name); String qualifiers; if (E->get().flags & METHOD_FLAG_CONST) qualifiers += "qualifiers=\"const\""; _write_string(f, 2, "<method name=\"" + _escape_string(E->get().name) + "\" " + qualifiers + " >"); for (int i = -1; i < E->get().arguments.size(); i++) { PropertyInfo arginfo; if (i == -1) { arginfo = E->get().return_val; String type_name = (arginfo.hint == PROPERTY_HINT_RESOURCE_TYPE) ? arginfo.hint_string : Variant::get_type_name(arginfo.type); if (arginfo.type == Variant::NIL) continue; _write_string(f, 3, "<return type=\"" + type_name + "\">"); } else { arginfo = E->get().arguments[i]; String type_name; if (arginfo.hint == PROPERTY_HINT_RESOURCE_TYPE) type_name = arginfo.hint_string; else if (arginfo.type == Variant::NIL) type_name = "var"; else type_name = Variant::get_type_name(arginfo.type); if (m && m->has_default_argument(i)) { Variant default_arg = m->get_default_argument(i); String default_arg_text = String(_escape_string(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::VECTOR2: // 5 case Variant::RECT2: case Variant::VECTOR3: case Variant::PLANE: case Variant::QUAT: case Variant::RECT3: //sorry naming convention fail :( not like it's used often // 10 case Variant::BASIS: case Variant::COLOR: case Variant::POOL_BYTE_ARRAY: case Variant::POOL_INT_ARRAY: case Variant::POOL_REAL_ARRAY: case Variant::POOL_STRING_ARRAY: //25 case Variant::POOL_VECTOR3_ARRAY: case Variant::POOL_COLOR_ARRAY: default_arg_text = Variant::get_type_name(default_arg.get_type()) + "(" + default_arg_text + ")"; break; case Variant::OBJECT: 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: {} } _write_string(f, 3, "<argument index=\"" + itos(i) + "\" name=\"" + _escape_string(arginfo.name) + "\" type=\"" + type_name + "\" default=\"" + _escape_string(default_arg_text) + "\">"); } else _write_string(f, 3, "<argument index=\"" + itos(i) + "\" name=\"" + arginfo.name + "\" type=\"" + type_name + "\">"); } 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; j < arginfo.hint_string.get_slice_count(","); j++) { if (j > 0) 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; j < arginfo.hint_string.get_slice_count(","); j++) { if (j > 0) hint += ", "; hint += arginfo.hint_string.get_slice(",", j) + "=" + itos(1 << j); } break; case PROPERTY_HINT_FILE: hint = "A file:"; break; default: {} //case PROPERTY_HINT_RESOURCE_TYPE: hint="Type: "+arginfo.hint_string; break; }; if (hint != "") _write_string(f, 4, hint); _write_string(f, 3, (i == -1) ? "</return>" : "</argument>"); } _write_string(f, 3, "<description>"); _write_string(f, 3, "</description>"); _write_string(f, 2, "</method>"); } _write_string(f, 1, "</methods>"); List<MethodInfo> signal_list; ClassDB::get_signal_list(name, &signal_list, true); if (signal_list.size()) { _write_string(f, 1, "<signals>"); for (List<MethodInfo>::Element *EV = signal_list.front(); EV; EV = EV->next()) { _write_string(f, 2, "<signal name=\"" + EV->get().name + "\">"); for (int i = 0; i < EV->get().arguments.size(); i++) { PropertyInfo arginfo = EV->get().arguments[i]; _write_string(f, 3, "<argument index=\"" + itos(i) + "\" name=\"" + arginfo.name + "\" type=\"" + Variant::get_type_name(arginfo.type) + "\">"); _write_string(f, 3, "</argument>"); } _write_string(f, 3, "<description>"); _write_string(f, 3, "</description>"); _write_string(f, 2, "</signal>"); } _write_string(f, 1, "</signals>"); } _write_string(f, 1, "<constants>"); List<String> constant_list; ClassDB::get_integer_constant_list(name, &constant_list, true); /* constants are sorted in a special way */ List<_ConstantSort> constant_sort; for (List<String>::Element *E = constant_list.front(); E; E = E->next()) { _ConstantSort cs; cs.name = E->get(); cs.value = ClassDB::get_integer_constant(name, E->get()); constant_sort.push_back(cs); } constant_sort.sort(); for (List<_ConstantSort>::Element *E = constant_sort.front(); E; E = E->next()) { _write_string(f, 2, "<constant name=\"" + E->get().name + "\" value=\"" + itos(E->get().value) + "\">"); _write_string(f, 2, "</constant>"); } _write_string(f, 1, "</constants>"); _write_string(f, 0, "</class>"); class_list.erase(name); } _write_string(f, 0, "</doc>"); f->close(); memdelete(f); }
void ClassDB::get_method_list(StringName p_class, List<MethodInfo> *p_methods, bool p_no_inheritance, bool p_exclude_from_properties) { OBJTYPE_RLOCK; ClassInfo *type = classes.getptr(p_class); while (type) { if (type->disabled) { if (p_no_inheritance) break; type = type->inherits_ptr; continue; } #ifdef DEBUG_METHODS_ENABLED for (List<MethodInfo>::Element *E = type->virtual_methods.front(); E; E = E->next()) { p_methods->push_back(E->get()); } for (List<StringName>::Element *E = type->method_order.front(); E; E = E->next()) { MethodBind *method = type->method_map.get(E->get()); MethodInfo minfo; minfo.name = E->get(); minfo.id = method->get_method_id(); if (p_exclude_from_properties && type->methods_in_properties.has(minfo.name)) continue; for (int i = 0; i < method->get_argument_count(); i++) { //Variant::Type t=method->get_argument_type(i); minfo.arguments.push_back(method->get_argument_info(i)); } minfo.return_val = method->get_return_info(); minfo.flags = method->get_hint_flags(); for (int i = 0; i < method->get_argument_count(); i++) { if (method->has_default_argument(i)) minfo.default_arguments.push_back(method->get_default_argument(i)); } p_methods->push_back(minfo); } #else const StringName *K = NULL; while ((K = type->method_map.next(K))) { MethodBind *m = type->method_map[*K]; MethodInfo mi; mi.name = m->get_name(); p_methods->push_back(mi); } #endif if (p_no_inheritance) break; type = type->inherits_ptr; } }
void DocData::generate(bool p_basic_types) { List<StringName> classes; ObjectTypeDB::get_type_list(&classes); classes.sort_custom<StringName::AlphCompare>(); 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<MethodInfo> method_list; ObjectTypeDB::get_method_list(name,&method_list,true); method_list.sort(); for(List<MethodInfo>::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::VECTOR2: // 5 case Variant::RECT2: case Variant::VECTOR3: case Variant::PLANE: case Variant::QUAT: case Variant::_AABB: //sorry naming convention fail :( not like it's used often // 10 case Variant::MATRIX3: case Variant::COLOR: 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::OBJECT: 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;j<arginfo.hint_string.get_slice_count(",");j++) { if (j>0) 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;j<arginfo.hint_string.get_slice_count(",");j++) { if (j>0) hint+=", "; hint+=arginfo.hint_string.get_slice(",",j)+"="+itos(1<<j); } break; case PROPERTY_HINT_FILE: hint="A file:"; break; //case PROPERTY_HINT_RESOURCE_TYPE: hint="Type: "+arginfo.hint_string; break; }; if (hint!="") _write_string(f,4,hint); */ } c.methods.push_back(method); } List<MethodInfo> signal_list; ObjectTypeDB::get_signal_list(name,&signal_list,true); if (signal_list.size()) { for(List<MethodInfo>::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<String> constant_list; ObjectTypeDB::get_integer_constant_list(name, &constant_list, true); for(List<String>::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<StringName> l; Theme::get_default()->get_constant_list(cname,&l); for (List<StringName>::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<StringName>::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<StringName>::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<StringName>::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<StringName>::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<MethodInfo> method_list; v.get_method_list(&method_list); method_list.sort(); Variant::get_constructor_list(Variant::Type(i),&method_list); for(List<MethodInfo>::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<PropertyInfo> properties; v.get_property_list(&properties); for(List<PropertyInfo>::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<StringName> constants; Variant::get_numeric_constants_for_type(Variant::Type(i),&constants); for(List<StringName>::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<Globals::Singleton> singletons; Globals::get_singleton()->get_singletons(&singletons); //servers (this is kind of hackish) for(List<Globals::Singleton>::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<MethodInfo> minfo; lang->get_public_functions(&minfo); for(List<MethodInfo>::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<Pair<String,Variant> > cinfo; lang->get_public_constants(&cinfo); for(List<Pair<String,Variant> >::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); } } } }