doc_data.cpp 7.4 KB

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