project_settings.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. /*************************************************************************/
  2. /* project_settings.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  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. #ifndef PROJECT_SETTINGS_H
  31. #define PROJECT_SETTINGS_H
  32. #include "core/object/class_db.h"
  33. #include "core/os/thread_safe.h"
  34. #include "core/templates/hash_map.h"
  35. #include "core/templates/rb_set.h"
  36. class ProjectSettings : public Object {
  37. GDCLASS(ProjectSettings, Object);
  38. _THREAD_SAFE_CLASS_
  39. public:
  40. typedef HashMap<String, Variant> CustomMap;
  41. static const String PROJECT_DATA_DIR_NAME_SUFFIX;
  42. enum {
  43. //properties that are not for built in values begin from this value, so builtin ones are displayed first
  44. NO_BUILTIN_ORDER_BASE = 1 << 16
  45. };
  46. const static PackedStringArray get_required_features();
  47. const static PackedStringArray get_unsupported_features(const PackedStringArray &p_project_features);
  48. struct AutoloadInfo {
  49. StringName name;
  50. String path;
  51. bool is_singleton = false;
  52. };
  53. protected:
  54. struct VariantContainer {
  55. int order = 0;
  56. bool persist = false;
  57. bool basic = false;
  58. Variant variant;
  59. Variant initial;
  60. bool hide_from_editor = false;
  61. bool overridden = false;
  62. bool restart_if_changed = false;
  63. #ifdef DEBUG_METHODS_ENABLED
  64. bool ignore_value_in_docs = false;
  65. #endif
  66. VariantContainer() {}
  67. VariantContainer(const Variant &p_variant, int p_order, bool p_persist = false) :
  68. order(p_order),
  69. persist(p_persist),
  70. variant(p_variant) {
  71. }
  72. };
  73. int last_order = NO_BUILTIN_ORDER_BASE;
  74. int last_builtin_order = 0;
  75. uint64_t last_save_time = 0;
  76. HashMap<StringName, VariantContainer> props;
  77. String resource_path;
  78. HashMap<StringName, PropertyInfo> custom_prop_info;
  79. bool disable_feature_overrides = false;
  80. bool using_datapack = false;
  81. List<String> input_presets;
  82. RBSet<String> custom_features;
  83. HashMap<StringName, StringName> feature_overrides;
  84. HashMap<StringName, AutoloadInfo> autoloads;
  85. String project_data_dir_name;
  86. bool _set(const StringName &p_name, const Variant &p_value);
  87. bool _get(const StringName &p_name, Variant &r_ret) const;
  88. void _get_property_list(List<PropertyInfo> *p_list) const;
  89. static ProjectSettings *singleton;
  90. Error _load_settings_text(const String &p_path);
  91. Error _load_settings_binary(const String &p_path);
  92. Error _load_settings_text_or_binary(const String &p_text_path, const String &p_bin_path);
  93. Error _save_settings_text(const String &p_file, const HashMap<String, List<String>> &props, const CustomMap &p_custom = CustomMap(), const String &p_custom_features = String());
  94. Error _save_settings_binary(const String &p_file, const HashMap<String, List<String>> &props, const CustomMap &p_custom = CustomMap(), const String &p_custom_features = String());
  95. Error _save_custom_bnd(const String &p_file);
  96. const static PackedStringArray _get_supported_features();
  97. const static PackedStringArray _trim_to_supported_features(const PackedStringArray &p_project_features);
  98. void _convert_to_last_version(int p_from_version);
  99. bool _load_resource_pack(const String &p_pack, bool p_replace_files = true, int p_offset = 0);
  100. void _add_property_info_bind(const Dictionary &p_info);
  101. Error _setup(const String &p_path, const String &p_main_pack, bool p_upwards = false, bool p_ignore_override = false);
  102. void _add_builtin_input_map();
  103. protected:
  104. static void _bind_methods();
  105. public:
  106. static const int CONFIG_VERSION = 5;
  107. void set_setting(const String &p_setting, const Variant &p_value);
  108. Variant get_setting(const String &p_setting) const;
  109. bool has_setting(String p_var) const;
  110. String localize_path(const String &p_path) const;
  111. String globalize_path(const String &p_path) const;
  112. void set_initial_value(const String &p_name, const Variant &p_value);
  113. void set_as_basic(const String &p_name, bool p_basic);
  114. void set_restart_if_changed(const String &p_name, bool p_restart);
  115. void set_ignore_value_in_docs(const String &p_name, bool p_ignore);
  116. bool get_ignore_value_in_docs(const String &p_name) const;
  117. bool property_can_revert(const String &p_name);
  118. Variant property_get_revert(const String &p_name);
  119. String get_project_data_dir_name() const;
  120. String get_project_data_path() const;
  121. String get_resource_path() const;
  122. String get_safe_project_name() const;
  123. String get_imported_files_path() const;
  124. static ProjectSettings *get_singleton();
  125. void clear(const String &p_name);
  126. int get_order(const String &p_name) const;
  127. void set_order(const String &p_name, int p_order);
  128. void set_builtin_order(const String &p_name);
  129. bool is_builtin_setting(const String &p_name) const;
  130. Error setup(const String &p_path, const String &p_main_pack, bool p_upwards = false, bool p_ignore_override = false);
  131. Error load_custom(const String &p_path);
  132. Error save_custom(const String &p_path = "", const CustomMap &p_custom = CustomMap(), const Vector<String> &p_custom_features = Vector<String>(), bool p_merge_with_current = true);
  133. Error save();
  134. void set_custom_property_info(const String &p_prop, const PropertyInfo &p_info);
  135. const HashMap<StringName, PropertyInfo> &get_custom_property_info() const;
  136. uint64_t get_last_saved_time() { return last_save_time; }
  137. Vector<String> get_optimizer_presets() const;
  138. List<String> get_input_presets() const { return input_presets; }
  139. void set_disable_feature_overrides(bool p_disable);
  140. bool is_using_datapack() const;
  141. bool has_custom_feature(const String &p_feature) const;
  142. const HashMap<StringName, AutoloadInfo> &get_autoload_list() const;
  143. void add_autoload(const AutoloadInfo &p_autoload);
  144. void remove_autoload(const StringName &p_autoload);
  145. bool has_autoload(const StringName &p_autoload) const;
  146. AutoloadInfo get_autoload(const StringName &p_name) const;
  147. ProjectSettings();
  148. ~ProjectSettings();
  149. };
  150. //not a macro any longer
  151. Variant _GLOBAL_DEF(const String &p_var, const Variant &p_default, bool p_restart_if_changed = false, bool p_ignore_value_in_docs = false, bool p_basic = false);
  152. #define GLOBAL_DEF(m_var, m_value) _GLOBAL_DEF(m_var, m_value)
  153. #define GLOBAL_DEF_RST(m_var, m_value) _GLOBAL_DEF(m_var, m_value, true)
  154. #define GLOBAL_DEF_NOVAL(m_var, m_value) _GLOBAL_DEF(m_var, m_value, false, true)
  155. #define GLOBAL_DEF_RST_NOVAL(m_var, m_value) _GLOBAL_DEF(m_var, m_value, true, true)
  156. #define GLOBAL_GET(m_var) ProjectSettings::get_singleton()->get(m_var)
  157. #define GLOBAL_DEF_BASIC(m_var, m_value) _GLOBAL_DEF(m_var, m_value, false, false, true)
  158. #define GLOBAL_DEF_RST_BASIC(m_var, m_value) _GLOBAL_DEF(m_var, m_value, true, false, true)
  159. #define GLOBAL_DEF_NOVAL_BASIC(m_var, m_value) _GLOBAL_DEF(m_var, m_value, false, true, true)
  160. #define GLOBAL_DEF_RST_NOVAL_BASIC(m_var, m_value) _GLOBAL_DEF(m_var, m_value, true, true, true)
  161. #endif // PROJECT_SETTINGS_H