1/**************************************************************************/
2/* doc_data.cpp */
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#include "doc_data.h"
32
33String DocData::get_default_value_string(const Variant &p_value) {
34 if (p_value.get_type() == Variant::ARRAY) {
35 return Variant(Array(p_value, 0, StringName(), Variant())).get_construct_string().replace("\n", " ");
36 } else {
37 return p_value.get_construct_string().replace("\n", " ");
38 }
39}
40
41void DocData::return_doc_from_retinfo(DocData::MethodDoc &p_method, const PropertyInfo &p_retinfo) {
42 if (p_retinfo.type == Variant::INT && p_retinfo.hint == PROPERTY_HINT_INT_IS_POINTER) {
43 p_method.return_type = p_retinfo.hint_string;
44 if (p_method.return_type.is_empty()) {
45 p_method.return_type = "void*";
46 } else {
47 p_method.return_type += "*";
48 }
49 } else if (p_retinfo.type == Variant::INT && p_retinfo.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
50 p_method.return_enum = p_retinfo.class_name;
51 if (p_method.return_enum.begins_with("_")) { //proxy class
52 p_method.return_enum = p_method.return_enum.substr(1, p_method.return_enum.length());
53 }
54 p_method.return_is_bitfield = p_retinfo.usage & PROPERTY_USAGE_CLASS_IS_BITFIELD;
55 p_method.return_type = "int";
56 } else if (p_retinfo.class_name != StringName()) {
57 p_method.return_type = p_retinfo.class_name;
58 } else if (p_retinfo.type == Variant::ARRAY && p_retinfo.hint == PROPERTY_HINT_ARRAY_TYPE) {
59 p_method.return_type = p_retinfo.hint_string + "[]";
60 } else if (p_retinfo.hint == PROPERTY_HINT_RESOURCE_TYPE) {
61 p_method.return_type = p_retinfo.hint_string;
62 } else if (p_retinfo.type == Variant::NIL && p_retinfo.usage & PROPERTY_USAGE_NIL_IS_VARIANT) {
63 p_method.return_type = "Variant";
64 } else if (p_retinfo.type == Variant::NIL) {
65 p_method.return_type = "void";
66 } else {
67 p_method.return_type = Variant::get_type_name(p_retinfo.type);
68 }
69}
70
71void DocData::argument_doc_from_arginfo(DocData::ArgumentDoc &p_argument, const PropertyInfo &p_arginfo) {
72 p_argument.name = p_arginfo.name;
73
74 if (p_arginfo.type == Variant::INT && p_arginfo.hint == PROPERTY_HINT_INT_IS_POINTER) {
75 p_argument.type = p_arginfo.hint_string;
76 if (p_argument.type.is_empty()) {
77 p_argument.type = "void*";
78 } else {
79 p_argument.type += "*";
80 }
81 } else if (p_arginfo.type == Variant::INT && p_arginfo.usage & (PROPERTY_USAGE_CLASS_IS_ENUM | PROPERTY_USAGE_CLASS_IS_BITFIELD)) {
82 p_argument.enumeration = p_arginfo.class_name;
83 if (p_argument.enumeration.begins_with("_")) { //proxy class
84 p_argument.enumeration = p_argument.enumeration.substr(1, p_argument.enumeration.length());
85 }
86 p_argument.is_bitfield = p_arginfo.usage & PROPERTY_USAGE_CLASS_IS_BITFIELD;
87 p_argument.type = "int";
88 } else if (p_arginfo.class_name != StringName()) {
89 p_argument.type = p_arginfo.class_name;
90 } else if (p_arginfo.type == Variant::ARRAY && p_arginfo.hint == PROPERTY_HINT_ARRAY_TYPE) {
91 p_argument.type = p_arginfo.hint_string + "[]";
92 } else if (p_arginfo.hint == PROPERTY_HINT_RESOURCE_TYPE) {
93 p_argument.type = p_arginfo.hint_string;
94 } else if (p_arginfo.type == Variant::NIL) {
95 // Parameters cannot be void, so PROPERTY_USAGE_NIL_IS_VARIANT is not necessary
96 p_argument.type = "Variant";
97 } else {
98 p_argument.type = Variant::get_type_name(p_arginfo.type);
99 }
100}
101
102void DocData::property_doc_from_scriptmemberinfo(DocData::PropertyDoc &p_property, const ScriptMemberInfo &p_memberinfo) {
103 p_property.name = p_memberinfo.propinfo.name;
104 p_property.description = p_memberinfo.doc_string;
105
106 if (p_memberinfo.propinfo.type == Variant::OBJECT) {
107 p_property.type = p_memberinfo.propinfo.class_name;
108 } else if (p_memberinfo.propinfo.type == Variant::NIL && p_memberinfo.propinfo.usage & PROPERTY_USAGE_NIL_IS_VARIANT) {
109 p_property.type = "Variant";
110 } else {
111 p_property.type = Variant::get_type_name(p_memberinfo.propinfo.type);
112 }
113
114 p_property.setter = p_memberinfo.setter;
115 p_property.getter = p_memberinfo.getter;
116
117 if (p_memberinfo.has_default_value && p_memberinfo.default_value.get_type() != Variant::OBJECT) {
118 p_property.default_value = get_default_value_string(p_memberinfo.default_value);
119 }
120
121 p_property.overridden = false;
122}
123
124void DocData::method_doc_from_methodinfo(DocData::MethodDoc &p_method, const MethodInfo &p_methodinfo, const String &p_desc) {
125 p_method.name = p_methodinfo.name;
126 p_method.description = p_desc;
127
128 if (p_methodinfo.flags & METHOD_FLAG_VIRTUAL) {
129 p_method.qualifiers = "virtual";
130 }
131
132 if (p_methodinfo.flags & METHOD_FLAG_CONST) {
133 if (!p_method.qualifiers.is_empty()) {
134 p_method.qualifiers += " ";
135 }
136 p_method.qualifiers += "const";
137 }
138
139 if (p_methodinfo.flags & METHOD_FLAG_VARARG) {
140 if (!p_method.qualifiers.is_empty()) {
141 p_method.qualifiers += " ";
142 }
143 p_method.qualifiers += "vararg";
144 }
145
146 if (p_methodinfo.flags & METHOD_FLAG_STATIC) {
147 if (!p_method.qualifiers.is_empty()) {
148 p_method.qualifiers += " ";
149 }
150 p_method.qualifiers += "static";
151 }
152
153 return_doc_from_retinfo(p_method, p_methodinfo.return_val);
154
155 for (int i = 0; i < p_methodinfo.arguments.size(); i++) {
156 DocData::ArgumentDoc argument;
157 argument_doc_from_arginfo(argument, p_methodinfo.arguments[i]);
158 int default_arg_index = i - (p_methodinfo.arguments.size() - p_methodinfo.default_arguments.size());
159 if (default_arg_index >= 0) {
160 Variant default_arg = p_methodinfo.default_arguments[default_arg_index];
161 argument.default_value = get_default_value_string(default_arg);
162 }
163 p_method.arguments.push_back(argument);
164 }
165}
166
167void DocData::constant_doc_from_variant(DocData::ConstantDoc &p_const, const StringName &p_name, const Variant &p_value, const String &p_desc) {
168 p_const.name = p_name;
169 p_const.value = p_value;
170 p_const.is_value_valid = (p_value.get_type() != Variant::OBJECT);
171 p_const.description = p_desc;
172}
173
174void DocData::signal_doc_from_methodinfo(DocData::MethodDoc &p_signal, const MethodInfo &p_methodinfo, const String &p_desc) {
175 return method_doc_from_methodinfo(p_signal, p_methodinfo, p_desc);
176}
177