core_bind.cpp 89 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623
  1. /*************************************************************************/
  2. /* core_bind.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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. #include "core_bind.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/crypto/crypto_core.h"
  33. #include "core/debugger/engine_debugger.h"
  34. #include "core/io/file_access_compressed.h"
  35. #include "core/io/file_access_encrypted.h"
  36. #include "core/io/json.h"
  37. #include "core/io/marshalls.h"
  38. #include "core/math/geometry_2d.h"
  39. #include "core/math/geometry_3d.h"
  40. #include "core/os/keyboard.h"
  41. #include "core/os/os.h"
  42. /**
  43. * Time constants borrowed from loc_time.h
  44. */
  45. #define EPOCH_YR 1970 /* EPOCH = Jan 1 1970 00:00:00 */
  46. #define SECS_DAY (24L * 60L * 60L)
  47. #define LEAPYEAR(year) (!((year) % 4) && (((year) % 100) || !((year) % 400)))
  48. #define YEARSIZE(year) (LEAPYEAR(year) ? 366 : 365)
  49. #define SECOND_KEY "second"
  50. #define MINUTE_KEY "minute"
  51. #define HOUR_KEY "hour"
  52. #define DAY_KEY "day"
  53. #define MONTH_KEY "month"
  54. #define YEAR_KEY "year"
  55. #define WEEKDAY_KEY "weekday"
  56. #define DST_KEY "dst"
  57. /// Table of number of days in each month (for regular year and leap year)
  58. static const unsigned int MONTH_DAYS_TABLE[2][12] = {
  59. { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 },
  60. { 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
  61. };
  62. ////// _ResourceLoader //////
  63. _ResourceLoader *_ResourceLoader::singleton = nullptr;
  64. Error _ResourceLoader::load_threaded_request(const String &p_path, const String &p_type_hint, bool p_use_sub_threads) {
  65. return ResourceLoader::load_threaded_request(p_path, p_type_hint, p_use_sub_threads);
  66. }
  67. _ResourceLoader::ThreadLoadStatus _ResourceLoader::load_threaded_get_status(const String &p_path, Array r_progress) {
  68. float progress = 0;
  69. ResourceLoader::ThreadLoadStatus tls = ResourceLoader::load_threaded_get_status(p_path, &progress);
  70. r_progress.resize(1);
  71. r_progress[0] = progress;
  72. return (ThreadLoadStatus)tls;
  73. }
  74. RES _ResourceLoader::load_threaded_get(const String &p_path) {
  75. Error error;
  76. RES res = ResourceLoader::load_threaded_get(p_path, &error);
  77. return res;
  78. }
  79. RES _ResourceLoader::load(const String &p_path, const String &p_type_hint, bool p_no_cache) {
  80. Error err = OK;
  81. RES ret = ResourceLoader::load(p_path, p_type_hint, p_no_cache, &err);
  82. ERR_FAIL_COND_V_MSG(err != OK, ret, "Error loading resource: '" + p_path + "'.");
  83. return ret;
  84. }
  85. Vector<String> _ResourceLoader::get_recognized_extensions_for_type(const String &p_type) {
  86. List<String> exts;
  87. ResourceLoader::get_recognized_extensions_for_type(p_type, &exts);
  88. Vector<String> ret;
  89. for (List<String>::Element *E = exts.front(); E; E = E->next()) {
  90. ret.push_back(E->get());
  91. }
  92. return ret;
  93. }
  94. void _ResourceLoader::set_abort_on_missing_resources(bool p_abort) {
  95. ResourceLoader::set_abort_on_missing_resources(p_abort);
  96. }
  97. PackedStringArray _ResourceLoader::get_dependencies(const String &p_path) {
  98. List<String> deps;
  99. ResourceLoader::get_dependencies(p_path, &deps);
  100. PackedStringArray ret;
  101. for (List<String>::Element *E = deps.front(); E; E = E->next()) {
  102. ret.push_back(E->get());
  103. }
  104. return ret;
  105. }
  106. bool _ResourceLoader::has_cached(const String &p_path) {
  107. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  108. return ResourceCache::has(local_path);
  109. }
  110. bool _ResourceLoader::exists(const String &p_path, const String &p_type_hint) {
  111. return ResourceLoader::exists(p_path, p_type_hint);
  112. }
  113. void _ResourceLoader::_bind_methods() {
  114. ClassDB::bind_method(D_METHOD("load_threaded_request", "path", "type_hint", "use_sub_threads"), &_ResourceLoader::load_threaded_request, DEFVAL(""), DEFVAL(false));
  115. ClassDB::bind_method(D_METHOD("load_threaded_get_status", "path", "progress"), &_ResourceLoader::load_threaded_get_status, DEFVAL(Array()));
  116. ClassDB::bind_method(D_METHOD("load_threaded_get", "path"), &_ResourceLoader::load_threaded_get);
  117. ClassDB::bind_method(D_METHOD("load", "path", "type_hint", "no_cache"), &_ResourceLoader::load, DEFVAL(""), DEFVAL(false));
  118. ClassDB::bind_method(D_METHOD("get_recognized_extensions_for_type", "type"), &_ResourceLoader::get_recognized_extensions_for_type);
  119. ClassDB::bind_method(D_METHOD("set_abort_on_missing_resources", "abort"), &_ResourceLoader::set_abort_on_missing_resources);
  120. ClassDB::bind_method(D_METHOD("get_dependencies", "path"), &_ResourceLoader::get_dependencies);
  121. ClassDB::bind_method(D_METHOD("has_cached", "path"), &_ResourceLoader::has_cached);
  122. ClassDB::bind_method(D_METHOD("exists", "path", "type_hint"), &_ResourceLoader::exists, DEFVAL(""));
  123. BIND_ENUM_CONSTANT(THREAD_LOAD_INVALID_RESOURCE);
  124. BIND_ENUM_CONSTANT(THREAD_LOAD_IN_PROGRESS);
  125. BIND_ENUM_CONSTANT(THREAD_LOAD_FAILED);
  126. BIND_ENUM_CONSTANT(THREAD_LOAD_LOADED);
  127. }
  128. ////// _ResourceSaver //////
  129. Error _ResourceSaver::save(const String &p_path, const RES &p_resource, SaverFlags p_flags) {
  130. ERR_FAIL_COND_V_MSG(p_resource.is_null(), ERR_INVALID_PARAMETER, "Can't save empty resource to path '" + String(p_path) + "'.");
  131. return ResourceSaver::save(p_path, p_resource, p_flags);
  132. }
  133. Vector<String> _ResourceSaver::get_recognized_extensions(const RES &p_resource) {
  134. ERR_FAIL_COND_V_MSG(p_resource.is_null(), Vector<String>(), "It's not a reference to a valid Resource object.");
  135. List<String> exts;
  136. ResourceSaver::get_recognized_extensions(p_resource, &exts);
  137. Vector<String> ret;
  138. for (List<String>::Element *E = exts.front(); E; E = E->next()) {
  139. ret.push_back(E->get());
  140. }
  141. return ret;
  142. }
  143. _ResourceSaver *_ResourceSaver::singleton = nullptr;
  144. void _ResourceSaver::_bind_methods() {
  145. ClassDB::bind_method(D_METHOD("save", "path", "resource", "flags"), &_ResourceSaver::save, DEFVAL(0));
  146. ClassDB::bind_method(D_METHOD("get_recognized_extensions", "type"), &_ResourceSaver::get_recognized_extensions);
  147. BIND_ENUM_CONSTANT(FLAG_RELATIVE_PATHS);
  148. BIND_ENUM_CONSTANT(FLAG_BUNDLE_RESOURCES);
  149. BIND_ENUM_CONSTANT(FLAG_CHANGE_PATH);
  150. BIND_ENUM_CONSTANT(FLAG_OMIT_EDITOR_PROPERTIES);
  151. BIND_ENUM_CONSTANT(FLAG_SAVE_BIG_ENDIAN);
  152. BIND_ENUM_CONSTANT(FLAG_COMPRESS);
  153. BIND_ENUM_CONSTANT(FLAG_REPLACE_SUBRESOURCE_PATHS);
  154. }
  155. ////// _OS //////
  156. PackedStringArray _OS::get_connected_midi_inputs() {
  157. return OS::get_singleton()->get_connected_midi_inputs();
  158. }
  159. void _OS::open_midi_inputs() {
  160. OS::get_singleton()->open_midi_inputs();
  161. }
  162. void _OS::close_midi_inputs() {
  163. OS::get_singleton()->close_midi_inputs();
  164. }
  165. void _OS::set_use_file_access_save_and_swap(bool p_enable) {
  166. FileAccess::set_backup_save(p_enable);
  167. }
  168. void _OS::set_low_processor_usage_mode(bool p_enabled) {
  169. OS::get_singleton()->set_low_processor_usage_mode(p_enabled);
  170. }
  171. bool _OS::is_in_low_processor_usage_mode() const {
  172. return OS::get_singleton()->is_in_low_processor_usage_mode();
  173. }
  174. void _OS::set_low_processor_usage_mode_sleep_usec(int p_usec) {
  175. OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(p_usec);
  176. }
  177. int _OS::get_low_processor_usage_mode_sleep_usec() const {
  178. return OS::get_singleton()->get_low_processor_usage_mode_sleep_usec();
  179. }
  180. String _OS::get_executable_path() const {
  181. return OS::get_singleton()->get_executable_path();
  182. }
  183. Error _OS::shell_open(String p_uri) {
  184. if (p_uri.begins_with("res://")) {
  185. WARN_PRINT("Attempting to open an URL with the \"res://\" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_open()`.");
  186. } else if (p_uri.begins_with("user://")) {
  187. WARN_PRINT("Attempting to open an URL with the \"user://\" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_open()`.");
  188. }
  189. return OS::get_singleton()->shell_open(p_uri);
  190. }
  191. int _OS::execute(const String &p_path, const Vector<String> &p_arguments, Array r_output, bool p_read_stderr) {
  192. List<String> args;
  193. for (int i = 0; i < p_arguments.size(); i++) {
  194. args.push_back(p_arguments[i]);
  195. }
  196. String pipe;
  197. int exitcode = 0;
  198. Error err = OS::get_singleton()->execute(p_path, args, &pipe, &exitcode, p_read_stderr);
  199. r_output.push_back(pipe);
  200. if (err != OK) {
  201. return -1;
  202. }
  203. return exitcode;
  204. }
  205. int _OS::create_process(const String &p_path, const Vector<String> &p_arguments) {
  206. List<String> args;
  207. for (int i = 0; i < p_arguments.size(); i++) {
  208. args.push_back(p_arguments[i]);
  209. }
  210. OS::ProcessID pid = 0;
  211. Error err = OS::get_singleton()->create_process(p_path, args, &pid);
  212. if (err != OK) {
  213. return -1;
  214. }
  215. return pid;
  216. }
  217. Error _OS::kill(int p_pid) {
  218. return OS::get_singleton()->kill(p_pid);
  219. }
  220. int _OS::get_process_id() const {
  221. return OS::get_singleton()->get_process_id();
  222. }
  223. bool _OS::has_environment(const String &p_var) const {
  224. return OS::get_singleton()->has_environment(p_var);
  225. }
  226. String _OS::get_environment(const String &p_var) const {
  227. return OS::get_singleton()->get_environment(p_var);
  228. }
  229. String _OS::get_name() const {
  230. return OS::get_singleton()->get_name();
  231. }
  232. Vector<String> _OS::get_cmdline_args() {
  233. List<String> cmdline = OS::get_singleton()->get_cmdline_args();
  234. Vector<String> cmdlinev;
  235. for (List<String>::Element *E = cmdline.front(); E; E = E->next()) {
  236. cmdlinev.push_back(E->get());
  237. }
  238. return cmdlinev;
  239. }
  240. String _OS::get_locale() const {
  241. return OS::get_singleton()->get_locale();
  242. }
  243. String _OS::get_model_name() const {
  244. return OS::get_singleton()->get_model_name();
  245. }
  246. Error _OS::set_thread_name(const String &p_name) {
  247. return Thread::set_name(p_name);
  248. }
  249. Thread::ID _OS::get_thread_caller_id() const {
  250. return Thread::get_caller_id();
  251. };
  252. bool _OS::has_feature(const String &p_feature) const {
  253. return OS::get_singleton()->has_feature(p_feature);
  254. }
  255. uint64_t _OS::get_static_memory_usage() const {
  256. return OS::get_singleton()->get_static_memory_usage();
  257. }
  258. uint64_t _OS::get_static_memory_peak_usage() const {
  259. return OS::get_singleton()->get_static_memory_peak_usage();
  260. }
  261. int _OS::get_exit_code() const {
  262. return OS::get_singleton()->get_exit_code();
  263. }
  264. void _OS::set_exit_code(int p_code) {
  265. if (p_code < 0 || p_code > 125) {
  266. WARN_PRINT("For portability reasons, the exit code should be set between 0 and 125 (inclusive).");
  267. }
  268. OS::get_singleton()->set_exit_code(p_code);
  269. }
  270. /**
  271. * Get current datetime with consideration for utc and
  272. * dst
  273. */
  274. Dictionary _OS::get_datetime(bool utc) const {
  275. Dictionary dated = get_date(utc);
  276. Dictionary timed = get_time(utc);
  277. List<Variant> keys;
  278. timed.get_key_list(&keys);
  279. for (int i = 0; i < keys.size(); i++) {
  280. dated[keys[i]] = timed[keys[i]];
  281. }
  282. return dated;
  283. }
  284. Dictionary _OS::get_date(bool utc) const {
  285. OS::Date date = OS::get_singleton()->get_date(utc);
  286. Dictionary dated;
  287. dated[YEAR_KEY] = date.year;
  288. dated[MONTH_KEY] = date.month;
  289. dated[DAY_KEY] = date.day;
  290. dated[WEEKDAY_KEY] = date.weekday;
  291. dated[DST_KEY] = date.dst;
  292. return dated;
  293. }
  294. Dictionary _OS::get_time(bool utc) const {
  295. OS::Time time = OS::get_singleton()->get_time(utc);
  296. Dictionary timed;
  297. timed[HOUR_KEY] = time.hour;
  298. timed[MINUTE_KEY] = time.min;
  299. timed[SECOND_KEY] = time.sec;
  300. return timed;
  301. }
  302. /**
  303. * Get an epoch time value from a dictionary of time values
  304. * @p datetime must be populated with the following keys:
  305. * day, hour, minute, month, second, year. (dst is ignored).
  306. *
  307. * You can pass the output from
  308. * get_datetime_from_unix_time directly into this function
  309. *
  310. * @param datetime dictionary of date and time values to convert
  311. *
  312. * @return epoch calculated
  313. */
  314. int64_t _OS::get_unix_time_from_datetime(Dictionary datetime) const {
  315. // Bunch of conversion constants
  316. static const unsigned int SECONDS_PER_MINUTE = 60;
  317. static const unsigned int MINUTES_PER_HOUR = 60;
  318. static const unsigned int HOURS_PER_DAY = 24;
  319. static const unsigned int SECONDS_PER_HOUR = MINUTES_PER_HOUR * SECONDS_PER_MINUTE;
  320. static const unsigned int SECONDS_PER_DAY = SECONDS_PER_HOUR * HOURS_PER_DAY;
  321. // Get all time values from the dictionary, set to zero if it doesn't exist.
  322. // Risk incorrect calculation over throwing errors
  323. unsigned int second = ((datetime.has(SECOND_KEY)) ? static_cast<unsigned int>(datetime[SECOND_KEY]) : 0);
  324. unsigned int minute = ((datetime.has(MINUTE_KEY)) ? static_cast<unsigned int>(datetime[MINUTE_KEY]) : 0);
  325. unsigned int hour = ((datetime.has(HOUR_KEY)) ? static_cast<unsigned int>(datetime[HOUR_KEY]) : 0);
  326. unsigned int day = ((datetime.has(DAY_KEY)) ? static_cast<unsigned int>(datetime[DAY_KEY]) : 1);
  327. unsigned int month = ((datetime.has(MONTH_KEY)) ? static_cast<unsigned int>(datetime[MONTH_KEY]) : 1);
  328. unsigned int year = ((datetime.has(YEAR_KEY)) ? static_cast<unsigned int>(datetime[YEAR_KEY]) : 0);
  329. /// How many days come before each month (0-12)
  330. static const unsigned short int DAYS_PAST_THIS_YEAR_TABLE[2][13] = {
  331. /* Normal years. */
  332. { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365 },
  333. /* Leap years. */
  334. { 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366 }
  335. };
  336. ERR_FAIL_COND_V_MSG(second > 59, 0, "Invalid second value of: " + itos(second) + ".");
  337. ERR_FAIL_COND_V_MSG(minute > 59, 0, "Invalid minute value of: " + itos(minute) + ".");
  338. ERR_FAIL_COND_V_MSG(hour > 23, 0, "Invalid hour value of: " + itos(hour) + ".");
  339. ERR_FAIL_COND_V_MSG(month > 12 || month == 0, 0, "Invalid month value of: " + itos(month) + ".");
  340. // Do this check after month is tested as valid
  341. ERR_FAIL_COND_V_MSG(day > MONTH_DAYS_TABLE[LEAPYEAR(year)][month - 1] || day == 0, 0, "Invalid day value of '" + itos(day) + "' which is larger than '" + itos(MONTH_DAYS_TABLE[LEAPYEAR(year)][month - 1]) + "' or 0.");
  342. // Calculate all the seconds from months past in this year
  343. uint64_t SECONDS_FROM_MONTHS_PAST_THIS_YEAR = DAYS_PAST_THIS_YEAR_TABLE[LEAPYEAR(year)][month - 1] * SECONDS_PER_DAY;
  344. int64_t SECONDS_FROM_YEARS_PAST = 0;
  345. if (year >= EPOCH_YR) {
  346. for (unsigned int iyear = EPOCH_YR; iyear < year; iyear++) {
  347. SECONDS_FROM_YEARS_PAST += YEARSIZE(iyear) * SECONDS_PER_DAY;
  348. }
  349. } else {
  350. for (unsigned int iyear = EPOCH_YR - 1; iyear >= year; iyear--) {
  351. SECONDS_FROM_YEARS_PAST -= YEARSIZE(iyear) * SECONDS_PER_DAY;
  352. }
  353. }
  354. int64_t epoch =
  355. second +
  356. minute * SECONDS_PER_MINUTE +
  357. hour * SECONDS_PER_HOUR +
  358. // Subtract 1 from day, since the current day isn't over yet
  359. // and we cannot count all 24 hours.
  360. (day - 1) * SECONDS_PER_DAY +
  361. SECONDS_FROM_MONTHS_PAST_THIS_YEAR +
  362. SECONDS_FROM_YEARS_PAST;
  363. return epoch;
  364. }
  365. /**
  366. * Get a dictionary of time values when given epoch time
  367. *
  368. * Dictionary Time values will be a union if values from #get_time
  369. * and #get_date dictionaries (with the exception of dst =
  370. * day light standard time, as it cannot be determined from epoch)
  371. *
  372. * @param unix_time_val epoch time to convert
  373. *
  374. * @return dictionary of date and time values
  375. */
  376. Dictionary _OS::get_datetime_from_unix_time(int64_t unix_time_val) const {
  377. OS::Date date;
  378. OS::Time time;
  379. long dayclock, dayno;
  380. int year = EPOCH_YR;
  381. if (unix_time_val >= 0) {
  382. dayno = unix_time_val / SECS_DAY;
  383. dayclock = unix_time_val % SECS_DAY;
  384. /* day 0 was a thursday */
  385. date.weekday = static_cast<OS::Weekday>((dayno + 4) % 7);
  386. while (dayno >= YEARSIZE(year)) {
  387. dayno -= YEARSIZE(year);
  388. year++;
  389. }
  390. } else {
  391. dayno = (unix_time_val - SECS_DAY + 1) / SECS_DAY;
  392. dayclock = unix_time_val - dayno * SECS_DAY;
  393. date.weekday = static_cast<OS::Weekday>(((dayno % 7) + 11) % 7);
  394. do {
  395. year--;
  396. dayno += YEARSIZE(year);
  397. } while (dayno < 0);
  398. }
  399. time.sec = dayclock % 60;
  400. time.min = (dayclock % 3600) / 60;
  401. time.hour = dayclock / 3600;
  402. date.year = year;
  403. size_t imonth = 0;
  404. while ((unsigned long)dayno >= MONTH_DAYS_TABLE[LEAPYEAR(year)][imonth]) {
  405. dayno -= MONTH_DAYS_TABLE[LEAPYEAR(year)][imonth];
  406. imonth++;
  407. }
  408. /// Add 1 to month to make sure months are indexed starting at 1
  409. date.month = static_cast<OS::Month>(imonth + 1);
  410. date.day = dayno + 1;
  411. Dictionary timed;
  412. timed[HOUR_KEY] = time.hour;
  413. timed[MINUTE_KEY] = time.min;
  414. timed[SECOND_KEY] = time.sec;
  415. timed[YEAR_KEY] = date.year;
  416. timed[MONTH_KEY] = date.month;
  417. timed[DAY_KEY] = date.day;
  418. timed[WEEKDAY_KEY] = date.weekday;
  419. return timed;
  420. }
  421. Dictionary _OS::get_time_zone_info() const {
  422. OS::TimeZoneInfo info = OS::get_singleton()->get_time_zone_info();
  423. Dictionary infod;
  424. infod["bias"] = info.bias;
  425. infod["name"] = info.name;
  426. return infod;
  427. }
  428. double _OS::get_unix_time() const {
  429. return OS::get_singleton()->get_unix_time();
  430. }
  431. void _OS::delay_usec(uint32_t p_usec) const {
  432. OS::get_singleton()->delay_usec(p_usec);
  433. }
  434. void _OS::delay_msec(uint32_t p_msec) const {
  435. OS::get_singleton()->delay_usec(int64_t(p_msec) * 1000);
  436. }
  437. uint32_t _OS::get_ticks_msec() const {
  438. return OS::get_singleton()->get_ticks_msec();
  439. }
  440. uint64_t _OS::get_ticks_usec() const {
  441. return OS::get_singleton()->get_ticks_usec();
  442. }
  443. bool _OS::can_use_threads() const {
  444. return OS::get_singleton()->can_use_threads();
  445. }
  446. bool _OS::is_userfs_persistent() const {
  447. return OS::get_singleton()->is_userfs_persistent();
  448. }
  449. int _OS::get_processor_count() const {
  450. return OS::get_singleton()->get_processor_count();
  451. }
  452. bool _OS::is_stdout_verbose() const {
  453. return OS::get_singleton()->is_stdout_verbose();
  454. }
  455. void _OS::dump_memory_to_file(const String &p_file) {
  456. OS::get_singleton()->dump_memory_to_file(p_file.utf8().get_data());
  457. }
  458. struct _OSCoreBindImg {
  459. String path;
  460. Size2 size;
  461. int fmt = 0;
  462. ObjectID id;
  463. int vram = 0;
  464. bool operator<(const _OSCoreBindImg &p_img) const { return vram == p_img.vram ? id < p_img.id : vram > p_img.vram; }
  465. };
  466. void _OS::print_all_textures_by_size() {
  467. List<_OSCoreBindImg> imgs;
  468. int total = 0;
  469. {
  470. List<Ref<Resource>> rsrc;
  471. ResourceCache::get_cached_resources(&rsrc);
  472. for (List<Ref<Resource>>::Element *E = rsrc.front(); E; E = E->next()) {
  473. if (!E->get()->is_class("ImageTexture")) {
  474. continue;
  475. }
  476. Size2 size = E->get()->call("get_size");
  477. int fmt = E->get()->call("get_format");
  478. _OSCoreBindImg img;
  479. img.size = size;
  480. img.fmt = fmt;
  481. img.path = E->get()->get_path();
  482. img.vram = Image::get_image_data_size(img.size.width, img.size.height, Image::Format(img.fmt));
  483. img.id = E->get()->get_instance_id();
  484. total += img.vram;
  485. imgs.push_back(img);
  486. }
  487. }
  488. imgs.sort();
  489. for (List<_OSCoreBindImg>::Element *E = imgs.front(); E; E = E->next()) {
  490. total -= E->get().vram;
  491. }
  492. }
  493. void _OS::print_resources_by_type(const Vector<String> &p_types) {
  494. Map<String, int> type_count;
  495. List<Ref<Resource>> resources;
  496. ResourceCache::get_cached_resources(&resources);
  497. for (List<Ref<Resource>>::Element *E = resources.front(); E; E = E->next()) {
  498. Ref<Resource> r = E->get();
  499. bool found = false;
  500. for (int i = 0; i < p_types.size(); i++) {
  501. if (r->is_class(p_types[i])) {
  502. found = true;
  503. }
  504. }
  505. if (!found) {
  506. continue;
  507. }
  508. if (!type_count.has(r->get_class())) {
  509. type_count[r->get_class()] = 0;
  510. }
  511. type_count[r->get_class()]++;
  512. }
  513. }
  514. void _OS::print_all_resources(const String &p_to_file) {
  515. OS::get_singleton()->print_all_resources(p_to_file);
  516. }
  517. void _OS::print_resources_in_use(bool p_short) {
  518. OS::get_singleton()->print_resources_in_use(p_short);
  519. }
  520. void _OS::dump_resources_to_file(const String &p_file) {
  521. OS::get_singleton()->dump_resources_to_file(p_file.utf8().get_data());
  522. }
  523. String _OS::get_user_data_dir() const {
  524. return OS::get_singleton()->get_user_data_dir();
  525. }
  526. bool _OS::is_debug_build() const {
  527. #ifdef DEBUG_ENABLED
  528. return true;
  529. #else
  530. return false;
  531. #endif
  532. }
  533. String _OS::get_system_dir(SystemDir p_dir) const {
  534. return OS::get_singleton()->get_system_dir(OS::SystemDir(p_dir));
  535. }
  536. String _OS::get_keycode_string(uint32_t p_code) const {
  537. return keycode_get_string(p_code);
  538. }
  539. bool _OS::is_keycode_unicode(uint32_t p_unicode) const {
  540. return keycode_has_unicode(p_unicode);
  541. }
  542. int _OS::find_keycode_from_string(const String &p_code) const {
  543. return find_keycode(p_code);
  544. }
  545. bool _OS::request_permission(const String &p_name) {
  546. return OS::get_singleton()->request_permission(p_name);
  547. }
  548. bool _OS::request_permissions() {
  549. return OS::get_singleton()->request_permissions();
  550. }
  551. Vector<String> _OS::get_granted_permissions() const {
  552. return OS::get_singleton()->get_granted_permissions();
  553. }
  554. String _OS::get_unique_id() const {
  555. return OS::get_singleton()->get_unique_id();
  556. }
  557. int _OS::get_tablet_driver_count() const {
  558. return OS::get_singleton()->get_tablet_driver_count();
  559. }
  560. String _OS::get_tablet_driver_name(int p_driver) const {
  561. return OS::get_singleton()->get_tablet_driver_name(p_driver);
  562. }
  563. String _OS::get_current_tablet_driver() const {
  564. return OS::get_singleton()->get_current_tablet_driver();
  565. }
  566. void _OS::set_current_tablet_driver(const String &p_driver) {
  567. OS::get_singleton()->set_current_tablet_driver(p_driver);
  568. }
  569. _OS *_OS::singleton = nullptr;
  570. void _OS::_bind_methods() {
  571. ClassDB::bind_method(D_METHOD("get_connected_midi_inputs"), &_OS::get_connected_midi_inputs);
  572. ClassDB::bind_method(D_METHOD("open_midi_inputs"), &_OS::open_midi_inputs);
  573. ClassDB::bind_method(D_METHOD("close_midi_inputs"), &_OS::close_midi_inputs);
  574. ClassDB::bind_method(D_METHOD("set_low_processor_usage_mode", "enable"), &_OS::set_low_processor_usage_mode);
  575. ClassDB::bind_method(D_METHOD("is_in_low_processor_usage_mode"), &_OS::is_in_low_processor_usage_mode);
  576. ClassDB::bind_method(D_METHOD("set_low_processor_usage_mode_sleep_usec", "usec"), &_OS::set_low_processor_usage_mode_sleep_usec);
  577. ClassDB::bind_method(D_METHOD("get_low_processor_usage_mode_sleep_usec"), &_OS::get_low_processor_usage_mode_sleep_usec);
  578. ClassDB::bind_method(D_METHOD("get_processor_count"), &_OS::get_processor_count);
  579. ClassDB::bind_method(D_METHOD("get_executable_path"), &_OS::get_executable_path);
  580. ClassDB::bind_method(D_METHOD("execute", "path", "arguments", "output", "read_stderr"), &_OS::execute, DEFVAL(Array()), DEFVAL(false));
  581. ClassDB::bind_method(D_METHOD("create_process", "path", "arguments"), &_OS::create_process);
  582. ClassDB::bind_method(D_METHOD("kill", "pid"), &_OS::kill);
  583. ClassDB::bind_method(D_METHOD("shell_open", "uri"), &_OS::shell_open);
  584. ClassDB::bind_method(D_METHOD("get_process_id"), &_OS::get_process_id);
  585. ClassDB::bind_method(D_METHOD("get_environment", "environment"), &_OS::get_environment);
  586. ClassDB::bind_method(D_METHOD("has_environment", "environment"), &_OS::has_environment);
  587. ClassDB::bind_method(D_METHOD("get_name"), &_OS::get_name);
  588. ClassDB::bind_method(D_METHOD("get_cmdline_args"), &_OS::get_cmdline_args);
  589. ClassDB::bind_method(D_METHOD("get_datetime", "utc"), &_OS::get_datetime, DEFVAL(false));
  590. ClassDB::bind_method(D_METHOD("get_date", "utc"), &_OS::get_date, DEFVAL(false));
  591. ClassDB::bind_method(D_METHOD("get_time", "utc"), &_OS::get_time, DEFVAL(false));
  592. ClassDB::bind_method(D_METHOD("get_time_zone_info"), &_OS::get_time_zone_info);
  593. ClassDB::bind_method(D_METHOD("get_unix_time"), &_OS::get_unix_time);
  594. ClassDB::bind_method(D_METHOD("get_datetime_from_unix_time", "unix_time_val"), &_OS::get_datetime_from_unix_time);
  595. ClassDB::bind_method(D_METHOD("get_unix_time_from_datetime", "datetime"), &_OS::get_unix_time_from_datetime);
  596. ClassDB::bind_method(D_METHOD("get_exit_code"), &_OS::get_exit_code);
  597. ClassDB::bind_method(D_METHOD("set_exit_code", "code"), &_OS::set_exit_code);
  598. ClassDB::bind_method(D_METHOD("delay_usec", "usec"), &_OS::delay_usec);
  599. ClassDB::bind_method(D_METHOD("delay_msec", "msec"), &_OS::delay_msec);
  600. ClassDB::bind_method(D_METHOD("get_ticks_msec"), &_OS::get_ticks_msec);
  601. ClassDB::bind_method(D_METHOD("get_ticks_usec"), &_OS::get_ticks_usec);
  602. ClassDB::bind_method(D_METHOD("get_locale"), &_OS::get_locale);
  603. ClassDB::bind_method(D_METHOD("get_model_name"), &_OS::get_model_name);
  604. ClassDB::bind_method(D_METHOD("is_userfs_persistent"), &_OS::is_userfs_persistent);
  605. ClassDB::bind_method(D_METHOD("is_stdout_verbose"), &_OS::is_stdout_verbose);
  606. ClassDB::bind_method(D_METHOD("can_use_threads"), &_OS::can_use_threads);
  607. ClassDB::bind_method(D_METHOD("is_debug_build"), &_OS::is_debug_build);
  608. ClassDB::bind_method(D_METHOD("dump_memory_to_file", "file"), &_OS::dump_memory_to_file);
  609. ClassDB::bind_method(D_METHOD("dump_resources_to_file", "file"), &_OS::dump_resources_to_file);
  610. ClassDB::bind_method(D_METHOD("print_resources_in_use", "short"), &_OS::print_resources_in_use, DEFVAL(false));
  611. ClassDB::bind_method(D_METHOD("print_all_resources", "tofile"), &_OS::print_all_resources, DEFVAL(""));
  612. ClassDB::bind_method(D_METHOD("get_static_memory_usage"), &_OS::get_static_memory_usage);
  613. ClassDB::bind_method(D_METHOD("get_static_memory_peak_usage"), &_OS::get_static_memory_peak_usage);
  614. ClassDB::bind_method(D_METHOD("get_user_data_dir"), &_OS::get_user_data_dir);
  615. ClassDB::bind_method(D_METHOD("get_system_dir", "dir"), &_OS::get_system_dir);
  616. ClassDB::bind_method(D_METHOD("get_unique_id"), &_OS::get_unique_id);
  617. ClassDB::bind_method(D_METHOD("print_all_textures_by_size"), &_OS::print_all_textures_by_size);
  618. ClassDB::bind_method(D_METHOD("print_resources_by_type", "types"), &_OS::print_resources_by_type);
  619. ClassDB::bind_method(D_METHOD("get_keycode_string", "code"), &_OS::get_keycode_string);
  620. ClassDB::bind_method(D_METHOD("is_keycode_unicode", "code"), &_OS::is_keycode_unicode);
  621. ClassDB::bind_method(D_METHOD("find_keycode_from_string", "string"), &_OS::find_keycode_from_string);
  622. ClassDB::bind_method(D_METHOD("set_use_file_access_save_and_swap", "enabled"), &_OS::set_use_file_access_save_and_swap);
  623. ClassDB::bind_method(D_METHOD("set_thread_name", "name"), &_OS::set_thread_name);
  624. ClassDB::bind_method(D_METHOD("get_thread_caller_id"), &_OS::get_thread_caller_id);
  625. ClassDB::bind_method(D_METHOD("has_feature", "tag_name"), &_OS::has_feature);
  626. ClassDB::bind_method(D_METHOD("request_permission", "name"), &_OS::request_permission);
  627. ClassDB::bind_method(D_METHOD("request_permissions"), &_OS::request_permissions);
  628. ClassDB::bind_method(D_METHOD("get_granted_permissions"), &_OS::get_granted_permissions);
  629. ClassDB::bind_method(D_METHOD("get_tablet_driver_count"), &_OS::get_tablet_driver_count);
  630. ClassDB::bind_method(D_METHOD("get_tablet_driver_name", "idx"), &_OS::get_tablet_driver_name);
  631. ClassDB::bind_method(D_METHOD("get_current_tablet_driver"), &_OS::get_current_tablet_driver);
  632. ClassDB::bind_method(D_METHOD("set_current_tablet_driver", "name"), &_OS::set_current_tablet_driver);
  633. ADD_PROPERTY(PropertyInfo(Variant::INT, "exit_code"), "set_exit_code", "get_exit_code");
  634. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "low_processor_usage_mode"), "set_low_processor_usage_mode", "is_in_low_processor_usage_mode");
  635. ADD_PROPERTY(PropertyInfo(Variant::INT, "low_processor_usage_mode_sleep_usec"), "set_low_processor_usage_mode_sleep_usec", "get_low_processor_usage_mode_sleep_usec");
  636. ADD_PROPERTY(PropertyInfo(Variant::STRING, "tablet_driver"), "set_current_tablet_driver", "get_current_tablet_driver");
  637. // Those default values need to be specified for the docs generator,
  638. // to avoid using values from the documentation writer's own OS instance.
  639. ADD_PROPERTY_DEFAULT("tablet_driver", "");
  640. ADD_PROPERTY_DEFAULT("exit_code", 0);
  641. ADD_PROPERTY_DEFAULT("low_processor_usage_mode", false);
  642. ADD_PROPERTY_DEFAULT("low_processor_usage_mode_sleep_usec", 6900);
  643. BIND_ENUM_CONSTANT(VIDEO_DRIVER_GLES2);
  644. BIND_ENUM_CONSTANT(VIDEO_DRIVER_VULKAN);
  645. BIND_ENUM_CONSTANT(DAY_SUNDAY);
  646. BIND_ENUM_CONSTANT(DAY_MONDAY);
  647. BIND_ENUM_CONSTANT(DAY_TUESDAY);
  648. BIND_ENUM_CONSTANT(DAY_WEDNESDAY);
  649. BIND_ENUM_CONSTANT(DAY_THURSDAY);
  650. BIND_ENUM_CONSTANT(DAY_FRIDAY);
  651. BIND_ENUM_CONSTANT(DAY_SATURDAY);
  652. BIND_ENUM_CONSTANT(MONTH_JANUARY);
  653. BIND_ENUM_CONSTANT(MONTH_FEBRUARY);
  654. BIND_ENUM_CONSTANT(MONTH_MARCH);
  655. BIND_ENUM_CONSTANT(MONTH_APRIL);
  656. BIND_ENUM_CONSTANT(MONTH_MAY);
  657. BIND_ENUM_CONSTANT(MONTH_JUNE);
  658. BIND_ENUM_CONSTANT(MONTH_JULY);
  659. BIND_ENUM_CONSTANT(MONTH_AUGUST);
  660. BIND_ENUM_CONSTANT(MONTH_SEPTEMBER);
  661. BIND_ENUM_CONSTANT(MONTH_OCTOBER);
  662. BIND_ENUM_CONSTANT(MONTH_NOVEMBER);
  663. BIND_ENUM_CONSTANT(MONTH_DECEMBER);
  664. BIND_ENUM_CONSTANT(SYSTEM_DIR_DESKTOP);
  665. BIND_ENUM_CONSTANT(SYSTEM_DIR_DCIM);
  666. BIND_ENUM_CONSTANT(SYSTEM_DIR_DOCUMENTS);
  667. BIND_ENUM_CONSTANT(SYSTEM_DIR_DOWNLOADS);
  668. BIND_ENUM_CONSTANT(SYSTEM_DIR_MOVIES);
  669. BIND_ENUM_CONSTANT(SYSTEM_DIR_MUSIC);
  670. BIND_ENUM_CONSTANT(SYSTEM_DIR_PICTURES);
  671. BIND_ENUM_CONSTANT(SYSTEM_DIR_RINGTONES);
  672. }
  673. ////// _Geometry2D //////
  674. _Geometry2D *_Geometry2D::singleton = nullptr;
  675. _Geometry2D *_Geometry2D::get_singleton() {
  676. return singleton;
  677. }
  678. bool _Geometry2D::is_point_in_circle(const Vector2 &p_point, const Vector2 &p_circle_pos, real_t p_circle_radius) {
  679. return Geometry2D::is_point_in_circle(p_point, p_circle_pos, p_circle_radius);
  680. }
  681. real_t _Geometry2D::segment_intersects_circle(const Vector2 &p_from, const Vector2 &p_to, const Vector2 &p_circle_pos, real_t p_circle_radius) {
  682. return Geometry2D::segment_intersects_circle(p_from, p_to, p_circle_pos, p_circle_radius);
  683. }
  684. Variant _Geometry2D::segment_intersects_segment(const Vector2 &p_from_a, const Vector2 &p_to_a, const Vector2 &p_from_b, const Vector2 &p_to_b) {
  685. Vector2 result;
  686. if (Geometry2D::segment_intersects_segment(p_from_a, p_to_a, p_from_b, p_to_b, &result)) {
  687. return result;
  688. } else {
  689. return Variant();
  690. }
  691. }
  692. Variant _Geometry2D::line_intersects_line(const Vector2 &p_from_a, const Vector2 &p_dir_a, const Vector2 &p_from_b, const Vector2 &p_dir_b) {
  693. Vector2 result;
  694. if (Geometry2D::line_intersects_line(p_from_a, p_dir_a, p_from_b, p_dir_b, result)) {
  695. return result;
  696. } else {
  697. return Variant();
  698. }
  699. }
  700. Vector<Vector2> _Geometry2D::get_closest_points_between_segments(const Vector2 &p1, const Vector2 &q1, const Vector2 &p2, const Vector2 &q2) {
  701. Vector2 r1, r2;
  702. Geometry2D::get_closest_points_between_segments(p1, q1, p2, q2, r1, r2);
  703. Vector<Vector2> r;
  704. r.resize(2);
  705. r.set(0, r1);
  706. r.set(1, r2);
  707. return r;
  708. }
  709. Vector2 _Geometry2D::get_closest_point_to_segment(const Vector2 &p_point, const Vector2 &p_a, const Vector2 &p_b) {
  710. Vector2 s[2] = { p_a, p_b };
  711. return Geometry2D::get_closest_point_to_segment(p_point, s);
  712. }
  713. Vector2 _Geometry2D::get_closest_point_to_segment_uncapped(const Vector2 &p_point, const Vector2 &p_a, const Vector2 &p_b) {
  714. Vector2 s[2] = { p_a, p_b };
  715. return Geometry2D::get_closest_point_to_segment_uncapped(p_point, s);
  716. }
  717. bool _Geometry2D::point_is_inside_triangle(const Vector2 &s, const Vector2 &a, const Vector2 &b, const Vector2 &c) const {
  718. return Geometry2D::is_point_in_triangle(s, a, b, c);
  719. }
  720. bool _Geometry2D::is_polygon_clockwise(const Vector<Vector2> &p_polygon) {
  721. return Geometry2D::is_polygon_clockwise(p_polygon);
  722. }
  723. bool _Geometry2D::is_point_in_polygon(const Point2 &p_point, const Vector<Vector2> &p_polygon) {
  724. return Geometry2D::is_point_in_polygon(p_point, p_polygon);
  725. }
  726. Vector<int> _Geometry2D::triangulate_polygon(const Vector<Vector2> &p_polygon) {
  727. return Geometry2D::triangulate_polygon(p_polygon);
  728. }
  729. Vector<int> _Geometry2D::triangulate_delaunay(const Vector<Vector2> &p_points) {
  730. return Geometry2D::triangulate_delaunay(p_points);
  731. }
  732. Vector<Point2> _Geometry2D::convex_hull(const Vector<Point2> &p_points) {
  733. return Geometry2D::convex_hull(p_points);
  734. }
  735. Array _Geometry2D::merge_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  736. Vector<Vector<Point2>> polys = Geometry2D::merge_polygons(p_polygon_a, p_polygon_b);
  737. Array ret;
  738. for (int i = 0; i < polys.size(); ++i) {
  739. ret.push_back(polys[i]);
  740. }
  741. return ret;
  742. }
  743. Array _Geometry2D::clip_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  744. Vector<Vector<Point2>> polys = Geometry2D::clip_polygons(p_polygon_a, p_polygon_b);
  745. Array ret;
  746. for (int i = 0; i < polys.size(); ++i) {
  747. ret.push_back(polys[i]);
  748. }
  749. return ret;
  750. }
  751. Array _Geometry2D::intersect_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  752. Vector<Vector<Point2>> polys = Geometry2D::intersect_polygons(p_polygon_a, p_polygon_b);
  753. Array ret;
  754. for (int i = 0; i < polys.size(); ++i) {
  755. ret.push_back(polys[i]);
  756. }
  757. return ret;
  758. }
  759. Array _Geometry2D::exclude_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  760. Vector<Vector<Point2>> polys = Geometry2D::exclude_polygons(p_polygon_a, p_polygon_b);
  761. Array ret;
  762. for (int i = 0; i < polys.size(); ++i) {
  763. ret.push_back(polys[i]);
  764. }
  765. return ret;
  766. }
  767. Array _Geometry2D::clip_polyline_with_polygon(const Vector<Vector2> &p_polyline, const Vector<Vector2> &p_polygon) {
  768. Vector<Vector<Point2>> polys = Geometry2D::clip_polyline_with_polygon(p_polyline, p_polygon);
  769. Array ret;
  770. for (int i = 0; i < polys.size(); ++i) {
  771. ret.push_back(polys[i]);
  772. }
  773. return ret;
  774. }
  775. Array _Geometry2D::intersect_polyline_with_polygon(const Vector<Vector2> &p_polyline, const Vector<Vector2> &p_polygon) {
  776. Vector<Vector<Point2>> polys = Geometry2D::intersect_polyline_with_polygon(p_polyline, p_polygon);
  777. Array ret;
  778. for (int i = 0; i < polys.size(); ++i) {
  779. ret.push_back(polys[i]);
  780. }
  781. return ret;
  782. }
  783. Array _Geometry2D::offset_polygon(const Vector<Vector2> &p_polygon, real_t p_delta, PolyJoinType p_join_type) {
  784. Vector<Vector<Point2>> polys = Geometry2D::offset_polygon(p_polygon, p_delta, Geometry2D::PolyJoinType(p_join_type));
  785. Array ret;
  786. for (int i = 0; i < polys.size(); ++i) {
  787. ret.push_back(polys[i]);
  788. }
  789. return ret;
  790. }
  791. Array _Geometry2D::offset_polyline(const Vector<Vector2> &p_polygon, real_t p_delta, PolyJoinType p_join_type, PolyEndType p_end_type) {
  792. Vector<Vector<Point2>> polys = Geometry2D::offset_polyline(p_polygon, p_delta, Geometry2D::PolyJoinType(p_join_type), Geometry2D::PolyEndType(p_end_type));
  793. Array ret;
  794. for (int i = 0; i < polys.size(); ++i) {
  795. ret.push_back(polys[i]);
  796. }
  797. return ret;
  798. }
  799. Dictionary _Geometry2D::make_atlas(const Vector<Size2> &p_rects) {
  800. Dictionary ret;
  801. Vector<Size2i> rects;
  802. for (int i = 0; i < p_rects.size(); i++) {
  803. rects.push_back(p_rects[i]);
  804. }
  805. Vector<Point2i> result;
  806. Size2i size;
  807. Geometry2D::make_atlas(rects, result, size);
  808. Size2 r_size = size;
  809. Vector<Point2> r_result;
  810. for (int i = 0; i < result.size(); i++) {
  811. r_result.push_back(result[i]);
  812. }
  813. ret["points"] = r_result;
  814. ret["size"] = r_size;
  815. return ret;
  816. }
  817. void _Geometry2D::_bind_methods() {
  818. ClassDB::bind_method(D_METHOD("is_point_in_circle", "point", "circle_position", "circle_radius"), &_Geometry2D::is_point_in_circle);
  819. ClassDB::bind_method(D_METHOD("segment_intersects_segment", "from_a", "to_a", "from_b", "to_b"), &_Geometry2D::segment_intersects_segment);
  820. ClassDB::bind_method(D_METHOD("line_intersects_line", "from_a", "dir_a", "from_b", "dir_b"), &_Geometry2D::line_intersects_line);
  821. ClassDB::bind_method(D_METHOD("get_closest_points_between_segments", "p1", "q1", "p2", "q2"), &_Geometry2D::get_closest_points_between_segments);
  822. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment", "point", "s1", "s2"), &_Geometry2D::get_closest_point_to_segment);
  823. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment_uncapped", "point", "s1", "s2"), &_Geometry2D::get_closest_point_to_segment_uncapped);
  824. ClassDB::bind_method(D_METHOD("point_is_inside_triangle", "point", "a", "b", "c"), &_Geometry2D::point_is_inside_triangle);
  825. ClassDB::bind_method(D_METHOD("is_polygon_clockwise", "polygon"), &_Geometry2D::is_polygon_clockwise);
  826. ClassDB::bind_method(D_METHOD("is_point_in_polygon", "point", "polygon"), &_Geometry2D::is_point_in_polygon);
  827. ClassDB::bind_method(D_METHOD("triangulate_polygon", "polygon"), &_Geometry2D::triangulate_polygon);
  828. ClassDB::bind_method(D_METHOD("triangulate_delaunay", "points"), &_Geometry2D::triangulate_delaunay);
  829. ClassDB::bind_method(D_METHOD("convex_hull", "points"), &_Geometry2D::convex_hull);
  830. ClassDB::bind_method(D_METHOD("merge_polygons", "polygon_a", "polygon_b"), &_Geometry2D::merge_polygons);
  831. ClassDB::bind_method(D_METHOD("clip_polygons", "polygon_a", "polygon_b"), &_Geometry2D::clip_polygons);
  832. ClassDB::bind_method(D_METHOD("intersect_polygons", "polygon_a", "polygon_b"), &_Geometry2D::intersect_polygons);
  833. ClassDB::bind_method(D_METHOD("exclude_polygons", "polygon_a", "polygon_b"), &_Geometry2D::exclude_polygons);
  834. ClassDB::bind_method(D_METHOD("clip_polyline_with_polygon", "polyline", "polygon"), &_Geometry2D::clip_polyline_with_polygon);
  835. ClassDB::bind_method(D_METHOD("intersect_polyline_with_polygon", "polyline", "polygon"), &_Geometry2D::intersect_polyline_with_polygon);
  836. ClassDB::bind_method(D_METHOD("offset_polygon", "polygon", "delta", "join_type"), &_Geometry2D::offset_polygon, DEFVAL(JOIN_SQUARE));
  837. ClassDB::bind_method(D_METHOD("offset_polyline", "polyline", "delta", "join_type", "end_type"), &_Geometry2D::offset_polyline, DEFVAL(JOIN_SQUARE), DEFVAL(END_SQUARE));
  838. ClassDB::bind_method(D_METHOD("make_atlas", "sizes"), &_Geometry2D::make_atlas);
  839. BIND_ENUM_CONSTANT(OPERATION_UNION);
  840. BIND_ENUM_CONSTANT(OPERATION_DIFFERENCE);
  841. BIND_ENUM_CONSTANT(OPERATION_INTERSECTION);
  842. BIND_ENUM_CONSTANT(OPERATION_XOR);
  843. BIND_ENUM_CONSTANT(JOIN_SQUARE);
  844. BIND_ENUM_CONSTANT(JOIN_ROUND);
  845. BIND_ENUM_CONSTANT(JOIN_MITER);
  846. BIND_ENUM_CONSTANT(END_POLYGON);
  847. BIND_ENUM_CONSTANT(END_JOINED);
  848. BIND_ENUM_CONSTANT(END_BUTT);
  849. BIND_ENUM_CONSTANT(END_SQUARE);
  850. BIND_ENUM_CONSTANT(END_ROUND);
  851. }
  852. ////// _Geometry3D //////
  853. _Geometry3D *_Geometry3D::singleton = nullptr;
  854. _Geometry3D *_Geometry3D::get_singleton() {
  855. return singleton;
  856. }
  857. Vector<Plane> _Geometry3D::build_box_planes(const Vector3 &p_extents) {
  858. return Geometry3D::build_box_planes(p_extents);
  859. }
  860. Vector<Plane> _Geometry3D::build_cylinder_planes(float p_radius, float p_height, int p_sides, Vector3::Axis p_axis) {
  861. return Geometry3D::build_cylinder_planes(p_radius, p_height, p_sides, p_axis);
  862. }
  863. Vector<Plane> _Geometry3D::build_capsule_planes(float p_radius, float p_height, int p_sides, int p_lats, Vector3::Axis p_axis) {
  864. return Geometry3D::build_capsule_planes(p_radius, p_height, p_sides, p_lats, p_axis);
  865. }
  866. Vector<Vector3> _Geometry3D::get_closest_points_between_segments(const Vector3 &p1, const Vector3 &p2, const Vector3 &q1, const Vector3 &q2) {
  867. Vector3 r1, r2;
  868. Geometry3D::get_closest_points_between_segments(p1, p2, q1, q2, r1, r2);
  869. Vector<Vector3> r;
  870. r.resize(2);
  871. r.set(0, r1);
  872. r.set(1, r2);
  873. return r;
  874. }
  875. Vector3 _Geometry3D::get_closest_point_to_segment(const Vector3 &p_point, const Vector3 &p_a, const Vector3 &p_b) {
  876. Vector3 s[2] = { p_a, p_b };
  877. return Geometry3D::get_closest_point_to_segment(p_point, s);
  878. }
  879. Vector3 _Geometry3D::get_closest_point_to_segment_uncapped(const Vector3 &p_point, const Vector3 &p_a, const Vector3 &p_b) {
  880. Vector3 s[2] = { p_a, p_b };
  881. return Geometry3D::get_closest_point_to_segment_uncapped(p_point, s);
  882. }
  883. Variant _Geometry3D::ray_intersects_triangle(const Vector3 &p_from, const Vector3 &p_dir, const Vector3 &p_v0, const Vector3 &p_v1, const Vector3 &p_v2) {
  884. Vector3 res;
  885. if (Geometry3D::ray_intersects_triangle(p_from, p_dir, p_v0, p_v1, p_v2, &res)) {
  886. return res;
  887. } else {
  888. return Variant();
  889. }
  890. }
  891. Variant _Geometry3D::segment_intersects_triangle(const Vector3 &p_from, const Vector3 &p_to, const Vector3 &p_v0, const Vector3 &p_v1, const Vector3 &p_v2) {
  892. Vector3 res;
  893. if (Geometry3D::segment_intersects_triangle(p_from, p_to, p_v0, p_v1, p_v2, &res)) {
  894. return res;
  895. } else {
  896. return Variant();
  897. }
  898. }
  899. Vector<Vector3> _Geometry3D::segment_intersects_sphere(const Vector3 &p_from, const Vector3 &p_to, const Vector3 &p_sphere_pos, real_t p_sphere_radius) {
  900. Vector<Vector3> r;
  901. Vector3 res, norm;
  902. if (!Geometry3D::segment_intersects_sphere(p_from, p_to, p_sphere_pos, p_sphere_radius, &res, &norm)) {
  903. return r;
  904. }
  905. r.resize(2);
  906. r.set(0, res);
  907. r.set(1, norm);
  908. return r;
  909. }
  910. Vector<Vector3> _Geometry3D::segment_intersects_cylinder(const Vector3 &p_from, const Vector3 &p_to, float p_height, float p_radius) {
  911. Vector<Vector3> r;
  912. Vector3 res, norm;
  913. if (!Geometry3D::segment_intersects_cylinder(p_from, p_to, p_height, p_radius, &res, &norm)) {
  914. return r;
  915. }
  916. r.resize(2);
  917. r.set(0, res);
  918. r.set(1, norm);
  919. return r;
  920. }
  921. Vector<Vector3> _Geometry3D::segment_intersects_convex(const Vector3 &p_from, const Vector3 &p_to, const Vector<Plane> &p_planes) {
  922. Vector<Vector3> r;
  923. Vector3 res, norm;
  924. if (!Geometry3D::segment_intersects_convex(p_from, p_to, p_planes.ptr(), p_planes.size(), &res, &norm)) {
  925. return r;
  926. }
  927. r.resize(2);
  928. r.set(0, res);
  929. r.set(1, norm);
  930. return r;
  931. }
  932. Vector<Vector3> _Geometry3D::clip_polygon(const Vector<Vector3> &p_points, const Plane &p_plane) {
  933. return Geometry3D::clip_polygon(p_points, p_plane);
  934. }
  935. void _Geometry3D::_bind_methods() {
  936. ClassDB::bind_method(D_METHOD("build_box_planes", "extents"), &_Geometry3D::build_box_planes);
  937. ClassDB::bind_method(D_METHOD("build_cylinder_planes", "radius", "height", "sides", "axis"), &_Geometry3D::build_cylinder_planes, DEFVAL(Vector3::AXIS_Z));
  938. ClassDB::bind_method(D_METHOD("build_capsule_planes", "radius", "height", "sides", "lats", "axis"), &_Geometry3D::build_capsule_planes, DEFVAL(Vector3::AXIS_Z));
  939. ClassDB::bind_method(D_METHOD("get_closest_points_between_segments", "p1", "p2", "q1", "q2"), &_Geometry3D::get_closest_points_between_segments);
  940. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment", "point", "s1", "s2"), &_Geometry3D::get_closest_point_to_segment);
  941. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment_uncapped", "point", "s1", "s2"), &_Geometry3D::get_closest_point_to_segment_uncapped);
  942. ClassDB::bind_method(D_METHOD("ray_intersects_triangle", "from", "dir", "a", "b", "c"), &_Geometry3D::ray_intersects_triangle);
  943. ClassDB::bind_method(D_METHOD("segment_intersects_triangle", "from", "to", "a", "b", "c"), &_Geometry3D::segment_intersects_triangle);
  944. ClassDB::bind_method(D_METHOD("segment_intersects_sphere", "from", "to", "sphere_position", "sphere_radius"), &_Geometry3D::segment_intersects_sphere);
  945. ClassDB::bind_method(D_METHOD("segment_intersects_cylinder", "from", "to", "height", "radius"), &_Geometry3D::segment_intersects_cylinder);
  946. ClassDB::bind_method(D_METHOD("segment_intersects_convex", "from", "to", "planes"), &_Geometry3D::segment_intersects_convex);
  947. ClassDB::bind_method(D_METHOD("clip_polygon", "points", "plane"), &_Geometry3D::clip_polygon);
  948. }
  949. ////// _File //////
  950. Error _File::open_encrypted(const String &p_path, ModeFlags p_mode_flags, const Vector<uint8_t> &p_key) {
  951. Error err = open(p_path, p_mode_flags);
  952. if (err) {
  953. return err;
  954. }
  955. FileAccessEncrypted *fae = memnew(FileAccessEncrypted);
  956. err = fae->open_and_parse(f, p_key, (p_mode_flags == WRITE) ? FileAccessEncrypted::MODE_WRITE_AES256 : FileAccessEncrypted::MODE_READ);
  957. if (err) {
  958. memdelete(fae);
  959. close();
  960. return err;
  961. }
  962. f = fae;
  963. return OK;
  964. }
  965. Error _File::open_encrypted_pass(const String &p_path, ModeFlags p_mode_flags, const String &p_pass) {
  966. Error err = open(p_path, p_mode_flags);
  967. if (err) {
  968. return err;
  969. }
  970. FileAccessEncrypted *fae = memnew(FileAccessEncrypted);
  971. err = fae->open_and_parse_password(f, p_pass, (p_mode_flags == WRITE) ? FileAccessEncrypted::MODE_WRITE_AES256 : FileAccessEncrypted::MODE_READ);
  972. if (err) {
  973. memdelete(fae);
  974. close();
  975. return err;
  976. }
  977. f = fae;
  978. return OK;
  979. }
  980. Error _File::open_compressed(const String &p_path, ModeFlags p_mode_flags, CompressionMode p_compress_mode) {
  981. FileAccessCompressed *fac = memnew(FileAccessCompressed);
  982. fac->configure("GCPF", (Compression::Mode)p_compress_mode);
  983. Error err = fac->_open(p_path, p_mode_flags);
  984. if (err) {
  985. memdelete(fac);
  986. return err;
  987. }
  988. f = fac;
  989. return OK;
  990. }
  991. Error _File::open(const String &p_path, ModeFlags p_mode_flags) {
  992. close();
  993. Error err;
  994. f = FileAccess::open(p_path, p_mode_flags, &err);
  995. if (f) {
  996. f->set_endian_swap(eswap);
  997. }
  998. return err;
  999. }
  1000. void _File::close() {
  1001. if (f) {
  1002. memdelete(f);
  1003. }
  1004. f = nullptr;
  1005. }
  1006. bool _File::is_open() const {
  1007. return f != nullptr;
  1008. }
  1009. String _File::get_path() const {
  1010. ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use.");
  1011. return f->get_path();
  1012. }
  1013. String _File::get_path_absolute() const {
  1014. ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use.");
  1015. return f->get_path_absolute();
  1016. }
  1017. void _File::seek(int64_t p_position) {
  1018. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1019. f->seek(p_position);
  1020. }
  1021. void _File::seek_end(int64_t p_position) {
  1022. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1023. f->seek_end(p_position);
  1024. }
  1025. int64_t _File::get_position() const {
  1026. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1027. return f->get_position();
  1028. }
  1029. int64_t _File::get_len() const {
  1030. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1031. return f->get_len();
  1032. }
  1033. bool _File::eof_reached() const {
  1034. ERR_FAIL_COND_V_MSG(!f, false, "File must be opened before use.");
  1035. return f->eof_reached();
  1036. }
  1037. uint8_t _File::get_8() const {
  1038. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1039. return f->get_8();
  1040. }
  1041. uint16_t _File::get_16() const {
  1042. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1043. return f->get_16();
  1044. }
  1045. uint32_t _File::get_32() const {
  1046. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1047. return f->get_32();
  1048. }
  1049. uint64_t _File::get_64() const {
  1050. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1051. return f->get_64();
  1052. }
  1053. float _File::get_float() const {
  1054. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1055. return f->get_float();
  1056. }
  1057. double _File::get_double() const {
  1058. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1059. return f->get_double();
  1060. }
  1061. real_t _File::get_real() const {
  1062. ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use.");
  1063. return f->get_real();
  1064. }
  1065. Vector<uint8_t> _File::get_buffer(int p_length) const {
  1066. Vector<uint8_t> data;
  1067. ERR_FAIL_COND_V_MSG(!f, data, "File must be opened before use.");
  1068. ERR_FAIL_COND_V_MSG(p_length < 0, data, "Length of buffer cannot be smaller than 0.");
  1069. if (p_length == 0) {
  1070. return data;
  1071. }
  1072. Error err = data.resize(p_length);
  1073. ERR_FAIL_COND_V_MSG(err != OK, data, "Can't resize data to " + itos(p_length) + " elements.");
  1074. uint8_t *w = data.ptrw();
  1075. int len = f->get_buffer(&w[0], p_length);
  1076. ERR_FAIL_COND_V(len < 0, Vector<uint8_t>());
  1077. if (len < p_length) {
  1078. data.resize(p_length);
  1079. }
  1080. return data;
  1081. }
  1082. String _File::get_as_text() const {
  1083. ERR_FAIL_COND_V_MSG(!f, String(), "File must be opened before use.");
  1084. String text;
  1085. size_t original_pos = f->get_position();
  1086. f->seek(0);
  1087. String l = get_line();
  1088. while (!eof_reached()) {
  1089. text += l + "\n";
  1090. l = get_line();
  1091. }
  1092. text += l;
  1093. f->seek(original_pos);
  1094. return text;
  1095. }
  1096. String _File::get_md5(const String &p_path) const {
  1097. return FileAccess::get_md5(p_path);
  1098. }
  1099. String _File::get_sha256(const String &p_path) const {
  1100. return FileAccess::get_sha256(p_path);
  1101. }
  1102. String _File::get_line() const {
  1103. ERR_FAIL_COND_V_MSG(!f, String(), "File must be opened before use.");
  1104. return f->get_line();
  1105. }
  1106. Vector<String> _File::get_csv_line(const String &p_delim) const {
  1107. ERR_FAIL_COND_V_MSG(!f, Vector<String>(), "File must be opened before use.");
  1108. return f->get_csv_line(p_delim);
  1109. }
  1110. /**< use this for files WRITTEN in _big_ endian machines (ie, amiga/mac)
  1111. * It's not about the current CPU type but file formats.
  1112. * this flags get reset to false (little endian) on each open
  1113. */
  1114. void _File::set_endian_swap(bool p_swap) {
  1115. eswap = p_swap;
  1116. if (f) {
  1117. f->set_endian_swap(p_swap);
  1118. }
  1119. }
  1120. bool _File::get_endian_swap() {
  1121. return eswap;
  1122. }
  1123. Error _File::get_error() const {
  1124. if (!f) {
  1125. return ERR_UNCONFIGURED;
  1126. }
  1127. return f->get_error();
  1128. }
  1129. void _File::store_8(uint8_t p_dest) {
  1130. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1131. f->store_8(p_dest);
  1132. }
  1133. void _File::store_16(uint16_t p_dest) {
  1134. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1135. f->store_16(p_dest);
  1136. }
  1137. void _File::store_32(uint32_t p_dest) {
  1138. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1139. f->store_32(p_dest);
  1140. }
  1141. void _File::store_64(uint64_t p_dest) {
  1142. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1143. f->store_64(p_dest);
  1144. }
  1145. void _File::store_float(float p_dest) {
  1146. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1147. f->store_float(p_dest);
  1148. }
  1149. void _File::store_double(double p_dest) {
  1150. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1151. f->store_double(p_dest);
  1152. }
  1153. void _File::store_real(real_t p_real) {
  1154. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1155. f->store_real(p_real);
  1156. }
  1157. void _File::store_string(const String &p_string) {
  1158. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1159. f->store_string(p_string);
  1160. }
  1161. void _File::store_pascal_string(const String &p_string) {
  1162. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1163. f->store_pascal_string(p_string);
  1164. }
  1165. String _File::get_pascal_string() {
  1166. ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use.");
  1167. return f->get_pascal_string();
  1168. }
  1169. void _File::store_line(const String &p_string) {
  1170. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1171. f->store_line(p_string);
  1172. }
  1173. void _File::store_csv_line(const Vector<String> &p_values, const String &p_delim) {
  1174. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1175. f->store_csv_line(p_values, p_delim);
  1176. }
  1177. void _File::store_buffer(const Vector<uint8_t> &p_buffer) {
  1178. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1179. int len = p_buffer.size();
  1180. if (len == 0) {
  1181. return;
  1182. }
  1183. const uint8_t *r = p_buffer.ptr();
  1184. f->store_buffer(&r[0], len);
  1185. }
  1186. bool _File::file_exists(const String &p_name) const {
  1187. return FileAccess::exists(p_name);
  1188. }
  1189. void _File::store_var(const Variant &p_var, bool p_full_objects) {
  1190. ERR_FAIL_COND_MSG(!f, "File must be opened before use.");
  1191. int len;
  1192. Error err = encode_variant(p_var, nullptr, len, p_full_objects);
  1193. ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
  1194. Vector<uint8_t> buff;
  1195. buff.resize(len);
  1196. uint8_t *w = buff.ptrw();
  1197. err = encode_variant(p_var, &w[0], len, p_full_objects);
  1198. ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
  1199. store_32(len);
  1200. store_buffer(buff);
  1201. }
  1202. Variant _File::get_var(bool p_allow_objects) const {
  1203. ERR_FAIL_COND_V_MSG(!f, Variant(), "File must be opened before use.");
  1204. uint32_t len = get_32();
  1205. Vector<uint8_t> buff = get_buffer(len);
  1206. ERR_FAIL_COND_V((uint32_t)buff.size() != len, Variant());
  1207. const uint8_t *r = buff.ptr();
  1208. Variant v;
  1209. Error err = decode_variant(v, &r[0], len, nullptr, p_allow_objects);
  1210. ERR_FAIL_COND_V_MSG(err != OK, Variant(), "Error when trying to encode Variant.");
  1211. return v;
  1212. }
  1213. uint64_t _File::get_modified_time(const String &p_file) const {
  1214. return FileAccess::get_modified_time(p_file);
  1215. }
  1216. void _File::_bind_methods() {
  1217. ClassDB::bind_method(D_METHOD("open_encrypted", "path", "mode_flags", "key"), &_File::open_encrypted);
  1218. ClassDB::bind_method(D_METHOD("open_encrypted_with_pass", "path", "mode_flags", "pass"), &_File::open_encrypted_pass);
  1219. ClassDB::bind_method(D_METHOD("open_compressed", "path", "mode_flags", "compression_mode"), &_File::open_compressed, DEFVAL(0));
  1220. ClassDB::bind_method(D_METHOD("open", "path", "flags"), &_File::open);
  1221. ClassDB::bind_method(D_METHOD("close"), &_File::close);
  1222. ClassDB::bind_method(D_METHOD("get_path"), &_File::get_path);
  1223. ClassDB::bind_method(D_METHOD("get_path_absolute"), &_File::get_path_absolute);
  1224. ClassDB::bind_method(D_METHOD("is_open"), &_File::is_open);
  1225. ClassDB::bind_method(D_METHOD("seek", "position"), &_File::seek);
  1226. ClassDB::bind_method(D_METHOD("seek_end", "position"), &_File::seek_end, DEFVAL(0));
  1227. ClassDB::bind_method(D_METHOD("get_position"), &_File::get_position);
  1228. ClassDB::bind_method(D_METHOD("get_len"), &_File::get_len);
  1229. ClassDB::bind_method(D_METHOD("eof_reached"), &_File::eof_reached);
  1230. ClassDB::bind_method(D_METHOD("get_8"), &_File::get_8);
  1231. ClassDB::bind_method(D_METHOD("get_16"), &_File::get_16);
  1232. ClassDB::bind_method(D_METHOD("get_32"), &_File::get_32);
  1233. ClassDB::bind_method(D_METHOD("get_64"), &_File::get_64);
  1234. ClassDB::bind_method(D_METHOD("get_float"), &_File::get_float);
  1235. ClassDB::bind_method(D_METHOD("get_double"), &_File::get_double);
  1236. ClassDB::bind_method(D_METHOD("get_real"), &_File::get_real);
  1237. ClassDB::bind_method(D_METHOD("get_buffer", "len"), &_File::get_buffer);
  1238. ClassDB::bind_method(D_METHOD("get_line"), &_File::get_line);
  1239. ClassDB::bind_method(D_METHOD("get_csv_line", "delim"), &_File::get_csv_line, DEFVAL(","));
  1240. ClassDB::bind_method(D_METHOD("get_as_text"), &_File::get_as_text);
  1241. ClassDB::bind_method(D_METHOD("get_md5", "path"), &_File::get_md5);
  1242. ClassDB::bind_method(D_METHOD("get_sha256", "path"), &_File::get_sha256);
  1243. ClassDB::bind_method(D_METHOD("get_endian_swap"), &_File::get_endian_swap);
  1244. ClassDB::bind_method(D_METHOD("set_endian_swap", "enable"), &_File::set_endian_swap);
  1245. ClassDB::bind_method(D_METHOD("get_error"), &_File::get_error);
  1246. ClassDB::bind_method(D_METHOD("get_var", "allow_objects"), &_File::get_var, DEFVAL(false));
  1247. ClassDB::bind_method(D_METHOD("store_8", "value"), &_File::store_8);
  1248. ClassDB::bind_method(D_METHOD("store_16", "value"), &_File::store_16);
  1249. ClassDB::bind_method(D_METHOD("store_32", "value"), &_File::store_32);
  1250. ClassDB::bind_method(D_METHOD("store_64", "value"), &_File::store_64);
  1251. ClassDB::bind_method(D_METHOD("store_float", "value"), &_File::store_float);
  1252. ClassDB::bind_method(D_METHOD("store_double", "value"), &_File::store_double);
  1253. ClassDB::bind_method(D_METHOD("store_real", "value"), &_File::store_real);
  1254. ClassDB::bind_method(D_METHOD("store_buffer", "buffer"), &_File::store_buffer);
  1255. ClassDB::bind_method(D_METHOD("store_line", "line"), &_File::store_line);
  1256. ClassDB::bind_method(D_METHOD("store_csv_line", "values", "delim"), &_File::store_csv_line, DEFVAL(","));
  1257. ClassDB::bind_method(D_METHOD("store_string", "string"), &_File::store_string);
  1258. ClassDB::bind_method(D_METHOD("store_var", "value", "full_objects"), &_File::store_var, DEFVAL(false));
  1259. ClassDB::bind_method(D_METHOD("store_pascal_string", "string"), &_File::store_pascal_string);
  1260. ClassDB::bind_method(D_METHOD("get_pascal_string"), &_File::get_pascal_string);
  1261. ClassDB::bind_method(D_METHOD("file_exists", "path"), &_File::file_exists);
  1262. ClassDB::bind_method(D_METHOD("get_modified_time", "file"), &_File::get_modified_time);
  1263. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "endian_swap"), "set_endian_swap", "get_endian_swap");
  1264. BIND_ENUM_CONSTANT(READ);
  1265. BIND_ENUM_CONSTANT(WRITE);
  1266. BIND_ENUM_CONSTANT(READ_WRITE);
  1267. BIND_ENUM_CONSTANT(WRITE_READ);
  1268. BIND_ENUM_CONSTANT(COMPRESSION_FASTLZ);
  1269. BIND_ENUM_CONSTANT(COMPRESSION_DEFLATE);
  1270. BIND_ENUM_CONSTANT(COMPRESSION_ZSTD);
  1271. BIND_ENUM_CONSTANT(COMPRESSION_GZIP);
  1272. }
  1273. _File::~_File() {
  1274. if (f) {
  1275. memdelete(f);
  1276. }
  1277. }
  1278. ////// _Directory //////
  1279. Error _Directory::open(const String &p_path) {
  1280. Error err;
  1281. DirAccess *alt = DirAccess::open(p_path, &err);
  1282. if (!alt) {
  1283. return err;
  1284. }
  1285. if (d) {
  1286. memdelete(d);
  1287. }
  1288. d = alt;
  1289. dir_open = true;
  1290. return OK;
  1291. }
  1292. bool _Directory::is_open() const {
  1293. return d && dir_open;
  1294. }
  1295. Error _Directory::list_dir_begin(bool p_skip_navigational, bool p_skip_hidden) {
  1296. ERR_FAIL_COND_V_MSG(!is_open(), ERR_UNCONFIGURED, "Directory must be opened before use.");
  1297. _list_skip_navigational = p_skip_navigational;
  1298. _list_skip_hidden = p_skip_hidden;
  1299. return d->list_dir_begin();
  1300. }
  1301. String _Directory::get_next() {
  1302. ERR_FAIL_COND_V_MSG(!is_open(), "", "Directory must be opened before use.");
  1303. String next = d->get_next();
  1304. while (next != "" && ((_list_skip_navigational && (next == "." || next == "..")) || (_list_skip_hidden && d->current_is_hidden()))) {
  1305. next = d->get_next();
  1306. }
  1307. return next;
  1308. }
  1309. bool _Directory::current_is_dir() const {
  1310. ERR_FAIL_COND_V_MSG(!is_open(), false, "Directory must be opened before use.");
  1311. return d->current_is_dir();
  1312. }
  1313. void _Directory::list_dir_end() {
  1314. ERR_FAIL_COND_MSG(!is_open(), "Directory must be opened before use.");
  1315. d->list_dir_end();
  1316. }
  1317. int _Directory::get_drive_count() {
  1318. ERR_FAIL_COND_V_MSG(!is_open(), 0, "Directory must be opened before use.");
  1319. return d->get_drive_count();
  1320. }
  1321. String _Directory::get_drive(int p_drive) {
  1322. ERR_FAIL_COND_V_MSG(!is_open(), "", "Directory must be opened before use.");
  1323. return d->get_drive(p_drive);
  1324. }
  1325. int _Directory::get_current_drive() {
  1326. ERR_FAIL_COND_V_MSG(!is_open(), 0, "Directory must be opened before use.");
  1327. return d->get_current_drive();
  1328. }
  1329. Error _Directory::change_dir(String p_dir) {
  1330. ERR_FAIL_COND_V_MSG(!d, ERR_UNCONFIGURED, "Directory is not configured properly.");
  1331. Error err = d->change_dir(p_dir);
  1332. if (err != OK) {
  1333. return err;
  1334. }
  1335. dir_open = true;
  1336. return OK;
  1337. }
  1338. String _Directory::get_current_dir() {
  1339. ERR_FAIL_COND_V_MSG(!is_open(), "", "Directory must be opened before use.");
  1340. return d->get_current_dir();
  1341. }
  1342. Error _Directory::make_dir(String p_dir) {
  1343. ERR_FAIL_COND_V_MSG(!d, ERR_UNCONFIGURED, "Directory is not configured properly.");
  1344. if (!p_dir.is_rel_path()) {
  1345. DirAccess *d = DirAccess::create_for_path(p_dir);
  1346. Error err = d->make_dir(p_dir);
  1347. memdelete(d);
  1348. return err;
  1349. }
  1350. return d->make_dir(p_dir);
  1351. }
  1352. Error _Directory::make_dir_recursive(String p_dir) {
  1353. ERR_FAIL_COND_V_MSG(!d, ERR_UNCONFIGURED, "Directory is not configured properly.");
  1354. if (!p_dir.is_rel_path()) {
  1355. DirAccess *d = DirAccess::create_for_path(p_dir);
  1356. Error err = d->make_dir_recursive(p_dir);
  1357. memdelete(d);
  1358. return err;
  1359. }
  1360. return d->make_dir_recursive(p_dir);
  1361. }
  1362. bool _Directory::file_exists(String p_file) {
  1363. ERR_FAIL_COND_V_MSG(!d, false, "Directory is not configured properly.");
  1364. if (!p_file.is_rel_path()) {
  1365. return FileAccess::exists(p_file);
  1366. }
  1367. return d->file_exists(p_file);
  1368. }
  1369. bool _Directory::dir_exists(String p_dir) {
  1370. ERR_FAIL_COND_V_MSG(!d, false, "Directory is not configured properly.");
  1371. if (!p_dir.is_rel_path()) {
  1372. DirAccess *d = DirAccess::create_for_path(p_dir);
  1373. bool exists = d->dir_exists(p_dir);
  1374. memdelete(d);
  1375. return exists;
  1376. }
  1377. return d->dir_exists(p_dir);
  1378. }
  1379. int _Directory::get_space_left() {
  1380. ERR_FAIL_COND_V_MSG(!is_open(), 0, "Directory must be opened before use.");
  1381. return d->get_space_left() / 1024 * 1024; //return value in megabytes, given binding is int
  1382. }
  1383. Error _Directory::copy(String p_from, String p_to) {
  1384. ERR_FAIL_COND_V_MSG(!is_open(), ERR_UNCONFIGURED, "Directory must be opened before use.");
  1385. return d->copy(p_from, p_to);
  1386. }
  1387. Error _Directory::rename(String p_from, String p_to) {
  1388. ERR_FAIL_COND_V_MSG(!is_open(), ERR_UNCONFIGURED, "Directory must be opened before use.");
  1389. if (!p_from.is_rel_path()) {
  1390. DirAccess *d = DirAccess::create_for_path(p_from);
  1391. ERR_FAIL_COND_V_MSG(!d->file_exists(p_from), ERR_DOES_NOT_EXIST, "File does not exist.");
  1392. Error err = d->rename(p_from, p_to);
  1393. memdelete(d);
  1394. return err;
  1395. }
  1396. ERR_FAIL_COND_V_MSG(!d->file_exists(p_from), ERR_DOES_NOT_EXIST, "File does not exist.");
  1397. return d->rename(p_from, p_to);
  1398. }
  1399. Error _Directory::remove(String p_name) {
  1400. ERR_FAIL_COND_V_MSG(!is_open(), ERR_UNCONFIGURED, "Directory must be opened before use.");
  1401. if (!p_name.is_rel_path()) {
  1402. DirAccess *d = DirAccess::create_for_path(p_name);
  1403. Error err = d->remove(p_name);
  1404. memdelete(d);
  1405. return err;
  1406. }
  1407. return d->remove(p_name);
  1408. }
  1409. void _Directory::_bind_methods() {
  1410. ClassDB::bind_method(D_METHOD("open", "path"), &_Directory::open);
  1411. ClassDB::bind_method(D_METHOD("list_dir_begin", "skip_navigational", "skip_hidden"), &_Directory::list_dir_begin, DEFVAL(false), DEFVAL(false));
  1412. ClassDB::bind_method(D_METHOD("get_next"), &_Directory::get_next);
  1413. ClassDB::bind_method(D_METHOD("current_is_dir"), &_Directory::current_is_dir);
  1414. ClassDB::bind_method(D_METHOD("list_dir_end"), &_Directory::list_dir_end);
  1415. ClassDB::bind_method(D_METHOD("get_drive_count"), &_Directory::get_drive_count);
  1416. ClassDB::bind_method(D_METHOD("get_drive", "idx"), &_Directory::get_drive);
  1417. ClassDB::bind_method(D_METHOD("get_current_drive"), &_Directory::get_current_drive);
  1418. ClassDB::bind_method(D_METHOD("change_dir", "todir"), &_Directory::change_dir);
  1419. ClassDB::bind_method(D_METHOD("get_current_dir"), &_Directory::get_current_dir);
  1420. ClassDB::bind_method(D_METHOD("make_dir", "path"), &_Directory::make_dir);
  1421. ClassDB::bind_method(D_METHOD("make_dir_recursive", "path"), &_Directory::make_dir_recursive);
  1422. ClassDB::bind_method(D_METHOD("file_exists", "path"), &_Directory::file_exists);
  1423. ClassDB::bind_method(D_METHOD("dir_exists", "path"), &_Directory::dir_exists);
  1424. //ClassDB::bind_method(D_METHOD("get_modified_time","file"),&_Directory::get_modified_time);
  1425. ClassDB::bind_method(D_METHOD("get_space_left"), &_Directory::get_space_left);
  1426. ClassDB::bind_method(D_METHOD("copy", "from", "to"), &_Directory::copy);
  1427. ClassDB::bind_method(D_METHOD("rename", "from", "to"), &_Directory::rename);
  1428. ClassDB::bind_method(D_METHOD("remove", "path"), &_Directory::remove);
  1429. }
  1430. _Directory::_Directory() {
  1431. d = DirAccess::create(DirAccess::ACCESS_RESOURCES);
  1432. }
  1433. _Directory::~_Directory() {
  1434. if (d) {
  1435. memdelete(d);
  1436. }
  1437. }
  1438. ////// _Marshalls //////
  1439. _Marshalls *_Marshalls::singleton = nullptr;
  1440. _Marshalls *_Marshalls::get_singleton() {
  1441. return singleton;
  1442. }
  1443. String _Marshalls::variant_to_base64(const Variant &p_var, bool p_full_objects) {
  1444. int len;
  1445. Error err = encode_variant(p_var, nullptr, len, p_full_objects);
  1446. ERR_FAIL_COND_V_MSG(err != OK, "", "Error when trying to encode Variant.");
  1447. Vector<uint8_t> buff;
  1448. buff.resize(len);
  1449. uint8_t *w = buff.ptrw();
  1450. err = encode_variant(p_var, &w[0], len, p_full_objects);
  1451. ERR_FAIL_COND_V_MSG(err != OK, "", "Error when trying to encode Variant.");
  1452. String ret = CryptoCore::b64_encode_str(&w[0], len);
  1453. ERR_FAIL_COND_V(ret == "", ret);
  1454. return ret;
  1455. }
  1456. Variant _Marshalls::base64_to_variant(const String &p_str, bool p_allow_objects) {
  1457. int strlen = p_str.length();
  1458. CharString cstr = p_str.ascii();
  1459. Vector<uint8_t> buf;
  1460. buf.resize(strlen / 4 * 3 + 1);
  1461. uint8_t *w = buf.ptrw();
  1462. size_t len = 0;
  1463. ERR_FAIL_COND_V(CryptoCore::b64_decode(&w[0], buf.size(), &len, (unsigned char *)cstr.get_data(), strlen) != OK, Variant());
  1464. Variant v;
  1465. Error err = decode_variant(v, &w[0], len, nullptr, p_allow_objects);
  1466. ERR_FAIL_COND_V_MSG(err != OK, Variant(), "Error when trying to decode Variant.");
  1467. return v;
  1468. }
  1469. String _Marshalls::raw_to_base64(const Vector<uint8_t> &p_arr) {
  1470. String ret = CryptoCore::b64_encode_str(p_arr.ptr(), p_arr.size());
  1471. ERR_FAIL_COND_V(ret == "", ret);
  1472. return ret;
  1473. }
  1474. Vector<uint8_t> _Marshalls::base64_to_raw(const String &p_str) {
  1475. int strlen = p_str.length();
  1476. CharString cstr = p_str.ascii();
  1477. size_t arr_len = 0;
  1478. Vector<uint8_t> buf;
  1479. {
  1480. buf.resize(strlen / 4 * 3 + 1);
  1481. uint8_t *w = buf.ptrw();
  1482. ERR_FAIL_COND_V(CryptoCore::b64_decode(&w[0], buf.size(), &arr_len, (unsigned char *)cstr.get_data(), strlen) != OK, Vector<uint8_t>());
  1483. }
  1484. buf.resize(arr_len);
  1485. return buf;
  1486. }
  1487. String _Marshalls::utf8_to_base64(const String &p_str) {
  1488. CharString cstr = p_str.utf8();
  1489. String ret = CryptoCore::b64_encode_str((unsigned char *)cstr.get_data(), cstr.length());
  1490. ERR_FAIL_COND_V(ret == "", ret);
  1491. return ret;
  1492. }
  1493. String _Marshalls::base64_to_utf8(const String &p_str) {
  1494. int strlen = p_str.length();
  1495. CharString cstr = p_str.ascii();
  1496. Vector<uint8_t> buf;
  1497. buf.resize(strlen / 4 * 3 + 1 + 1);
  1498. uint8_t *w = buf.ptrw();
  1499. size_t len = 0;
  1500. ERR_FAIL_COND_V(CryptoCore::b64_decode(&w[0], buf.size(), &len, (unsigned char *)cstr.get_data(), strlen) != OK, String());
  1501. w[len] = 0;
  1502. String ret = String::utf8((char *)&w[0]);
  1503. return ret;
  1504. }
  1505. void _Marshalls::_bind_methods() {
  1506. ClassDB::bind_method(D_METHOD("variant_to_base64", "variant", "full_objects"), &_Marshalls::variant_to_base64, DEFVAL(false));
  1507. ClassDB::bind_method(D_METHOD("base64_to_variant", "base64_str", "allow_objects"), &_Marshalls::base64_to_variant, DEFVAL(false));
  1508. ClassDB::bind_method(D_METHOD("raw_to_base64", "array"), &_Marshalls::raw_to_base64);
  1509. ClassDB::bind_method(D_METHOD("base64_to_raw", "base64_str"), &_Marshalls::base64_to_raw);
  1510. ClassDB::bind_method(D_METHOD("utf8_to_base64", "utf8_str"), &_Marshalls::utf8_to_base64);
  1511. ClassDB::bind_method(D_METHOD("base64_to_utf8", "base64_str"), &_Marshalls::base64_to_utf8);
  1512. }
  1513. ////// _Semaphore //////
  1514. void _Semaphore::wait() {
  1515. semaphore.wait();
  1516. }
  1517. Error _Semaphore::try_wait() {
  1518. return semaphore.try_wait() ? OK : ERR_BUSY;
  1519. }
  1520. void _Semaphore::post() {
  1521. semaphore.post();
  1522. }
  1523. void _Semaphore::_bind_methods() {
  1524. ClassDB::bind_method(D_METHOD("wait"), &_Semaphore::wait);
  1525. ClassDB::bind_method(D_METHOD("try_wait"), &_Semaphore::try_wait);
  1526. ClassDB::bind_method(D_METHOD("post"), &_Semaphore::post);
  1527. }
  1528. ////// _Mutex //////
  1529. void _Mutex::lock() {
  1530. mutex.lock();
  1531. }
  1532. Error _Mutex::try_lock() {
  1533. return mutex.try_lock();
  1534. }
  1535. void _Mutex::unlock() {
  1536. mutex.unlock();
  1537. }
  1538. void _Mutex::_bind_methods() {
  1539. ClassDB::bind_method(D_METHOD("lock"), &_Mutex::lock);
  1540. ClassDB::bind_method(D_METHOD("try_lock"), &_Mutex::try_lock);
  1541. ClassDB::bind_method(D_METHOD("unlock"), &_Mutex::unlock);
  1542. }
  1543. ////// _Thread //////
  1544. void _Thread::_start_func(void *ud) {
  1545. Ref<_Thread> *tud = (Ref<_Thread> *)ud;
  1546. Ref<_Thread> t = *tud;
  1547. memdelete(tud);
  1548. Callable::CallError ce;
  1549. const Variant *arg[1] = { &t->userdata };
  1550. Thread::set_name(t->target_method);
  1551. t->ret = t->target_instance->call(t->target_method, arg, 1, ce);
  1552. if (ce.error != Callable::CallError::CALL_OK) {
  1553. String reason;
  1554. switch (ce.error) {
  1555. case Callable::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  1556. reason = "Invalid Argument #" + itos(ce.argument);
  1557. } break;
  1558. case Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS: {
  1559. reason = "Too Many Arguments";
  1560. } break;
  1561. case Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS: {
  1562. reason = "Too Few Arguments";
  1563. } break;
  1564. case Callable::CallError::CALL_ERROR_INVALID_METHOD: {
  1565. reason = "Method Not Found";
  1566. } break;
  1567. default: {
  1568. }
  1569. }
  1570. ERR_FAIL_MSG("Could not call function '" + t->target_method.operator String() + "' to start thread " + t->get_id() + ": " + reason + ".");
  1571. }
  1572. }
  1573. Error _Thread::start(Object *p_instance, const StringName &p_method, const Variant &p_userdata, Priority p_priority) {
  1574. ERR_FAIL_COND_V_MSG(active, ERR_ALREADY_IN_USE, "Thread already started.");
  1575. ERR_FAIL_COND_V(!p_instance, ERR_INVALID_PARAMETER);
  1576. ERR_FAIL_COND_V(p_method == StringName(), ERR_INVALID_PARAMETER);
  1577. ERR_FAIL_INDEX_V(p_priority, PRIORITY_MAX, ERR_INVALID_PARAMETER);
  1578. ret = Variant();
  1579. target_method = p_method;
  1580. target_instance = p_instance;
  1581. userdata = p_userdata;
  1582. active = true;
  1583. Ref<_Thread> *ud = memnew(Ref<_Thread>(this));
  1584. Thread::Settings s;
  1585. s.priority = (Thread::Priority)p_priority;
  1586. thread = Thread::create(_start_func, ud, s);
  1587. if (!thread) {
  1588. active = false;
  1589. target_method = StringName();
  1590. target_instance = nullptr;
  1591. userdata = Variant();
  1592. return ERR_CANT_CREATE;
  1593. }
  1594. return OK;
  1595. }
  1596. String _Thread::get_id() const {
  1597. if (!thread) {
  1598. return String();
  1599. }
  1600. return itos(thread->get_id());
  1601. }
  1602. bool _Thread::is_active() const {
  1603. return active;
  1604. }
  1605. Variant _Thread::wait_to_finish() {
  1606. ERR_FAIL_COND_V_MSG(!thread, Variant(), "Thread must exist to wait for its completion.");
  1607. ERR_FAIL_COND_V_MSG(!active, Variant(), "Thread must be active to wait for its completion.");
  1608. Thread::wait_to_finish(thread);
  1609. Variant r = ret;
  1610. active = false;
  1611. target_method = StringName();
  1612. target_instance = nullptr;
  1613. userdata = Variant();
  1614. if (thread) {
  1615. memdelete(thread);
  1616. }
  1617. thread = nullptr;
  1618. return r;
  1619. }
  1620. void _Thread::_bind_methods() {
  1621. ClassDB::bind_method(D_METHOD("start", "instance", "method", "userdata", "priority"), &_Thread::start, DEFVAL(Variant()), DEFVAL(PRIORITY_NORMAL));
  1622. ClassDB::bind_method(D_METHOD("get_id"), &_Thread::get_id);
  1623. ClassDB::bind_method(D_METHOD("is_active"), &_Thread::is_active);
  1624. ClassDB::bind_method(D_METHOD("wait_to_finish"), &_Thread::wait_to_finish);
  1625. BIND_ENUM_CONSTANT(PRIORITY_LOW);
  1626. BIND_ENUM_CONSTANT(PRIORITY_NORMAL);
  1627. BIND_ENUM_CONSTANT(PRIORITY_HIGH);
  1628. }
  1629. _Thread::~_Thread() {
  1630. ERR_FAIL_COND_MSG(active, "Reference to a Thread object was lost while the thread is still running...");
  1631. }
  1632. ////// _ClassDB //////
  1633. PackedStringArray _ClassDB::get_class_list() const {
  1634. List<StringName> classes;
  1635. ClassDB::get_class_list(&classes);
  1636. PackedStringArray ret;
  1637. ret.resize(classes.size());
  1638. int idx = 0;
  1639. for (List<StringName>::Element *E = classes.front(); E; E = E->next()) {
  1640. ret.set(idx++, E->get());
  1641. }
  1642. return ret;
  1643. }
  1644. PackedStringArray _ClassDB::get_inheriters_from_class(const StringName &p_class) const {
  1645. List<StringName> classes;
  1646. ClassDB::get_inheriters_from_class(p_class, &classes);
  1647. PackedStringArray ret;
  1648. ret.resize(classes.size());
  1649. int idx = 0;
  1650. for (List<StringName>::Element *E = classes.front(); E; E = E->next()) {
  1651. ret.set(idx++, E->get());
  1652. }
  1653. return ret;
  1654. }
  1655. StringName _ClassDB::get_parent_class(const StringName &p_class) const {
  1656. return ClassDB::get_parent_class(p_class);
  1657. }
  1658. bool _ClassDB::class_exists(const StringName &p_class) const {
  1659. return ClassDB::class_exists(p_class);
  1660. }
  1661. bool _ClassDB::is_parent_class(const StringName &p_class, const StringName &p_inherits) const {
  1662. return ClassDB::is_parent_class(p_class, p_inherits);
  1663. }
  1664. bool _ClassDB::can_instance(const StringName &p_class) const {
  1665. return ClassDB::can_instance(p_class);
  1666. }
  1667. Variant _ClassDB::instance(const StringName &p_class) const {
  1668. Object *obj = ClassDB::instance(p_class);
  1669. if (!obj) {
  1670. return Variant();
  1671. }
  1672. Reference *r = Object::cast_to<Reference>(obj);
  1673. if (r) {
  1674. return REF(r);
  1675. } else {
  1676. return obj;
  1677. }
  1678. }
  1679. bool _ClassDB::has_signal(StringName p_class, StringName p_signal) const {
  1680. return ClassDB::has_signal(p_class, p_signal);
  1681. }
  1682. Dictionary _ClassDB::get_signal(StringName p_class, StringName p_signal) const {
  1683. MethodInfo signal;
  1684. if (ClassDB::get_signal(p_class, p_signal, &signal)) {
  1685. return signal.operator Dictionary();
  1686. } else {
  1687. return Dictionary();
  1688. }
  1689. }
  1690. Array _ClassDB::get_signal_list(StringName p_class, bool p_no_inheritance) const {
  1691. List<MethodInfo> signals;
  1692. ClassDB::get_signal_list(p_class, &signals, p_no_inheritance);
  1693. Array ret;
  1694. for (List<MethodInfo>::Element *E = signals.front(); E; E = E->next()) {
  1695. ret.push_back(E->get().operator Dictionary());
  1696. }
  1697. return ret;
  1698. }
  1699. Array _ClassDB::get_property_list(StringName p_class, bool p_no_inheritance) const {
  1700. List<PropertyInfo> plist;
  1701. ClassDB::get_property_list(p_class, &plist, p_no_inheritance);
  1702. Array ret;
  1703. for (List<PropertyInfo>::Element *E = plist.front(); E; E = E->next()) {
  1704. ret.push_back(E->get().operator Dictionary());
  1705. }
  1706. return ret;
  1707. }
  1708. Variant _ClassDB::get_property(Object *p_object, const StringName &p_property) const {
  1709. Variant ret;
  1710. ClassDB::get_property(p_object, p_property, ret);
  1711. return ret;
  1712. }
  1713. Error _ClassDB::set_property(Object *p_object, const StringName &p_property, const Variant &p_value) const {
  1714. Variant ret;
  1715. bool valid;
  1716. if (!ClassDB::set_property(p_object, p_property, p_value, &valid)) {
  1717. return ERR_UNAVAILABLE;
  1718. } else if (!valid) {
  1719. return ERR_INVALID_DATA;
  1720. }
  1721. return OK;
  1722. }
  1723. bool _ClassDB::has_method(StringName p_class, StringName p_method, bool p_no_inheritance) const {
  1724. return ClassDB::has_method(p_class, p_method, p_no_inheritance);
  1725. }
  1726. Array _ClassDB::get_method_list(StringName p_class, bool p_no_inheritance) const {
  1727. List<MethodInfo> methods;
  1728. ClassDB::get_method_list(p_class, &methods, p_no_inheritance);
  1729. Array ret;
  1730. for (List<MethodInfo>::Element *E = methods.front(); E; E = E->next()) {
  1731. #ifdef DEBUG_METHODS_ENABLED
  1732. ret.push_back(E->get().operator Dictionary());
  1733. #else
  1734. Dictionary dict;
  1735. dict["name"] = E->get().name;
  1736. ret.push_back(dict);
  1737. #endif
  1738. }
  1739. return ret;
  1740. }
  1741. PackedStringArray _ClassDB::get_integer_constant_list(const StringName &p_class, bool p_no_inheritance) const {
  1742. List<String> constants;
  1743. ClassDB::get_integer_constant_list(p_class, &constants, p_no_inheritance);
  1744. PackedStringArray ret;
  1745. ret.resize(constants.size());
  1746. int idx = 0;
  1747. for (List<String>::Element *E = constants.front(); E; E = E->next()) {
  1748. ret.set(idx++, E->get());
  1749. }
  1750. return ret;
  1751. }
  1752. bool _ClassDB::has_integer_constant(const StringName &p_class, const StringName &p_name) const {
  1753. bool success;
  1754. ClassDB::get_integer_constant(p_class, p_name, &success);
  1755. return success;
  1756. }
  1757. int _ClassDB::get_integer_constant(const StringName &p_class, const StringName &p_name) const {
  1758. bool found;
  1759. int c = ClassDB::get_integer_constant(p_class, p_name, &found);
  1760. ERR_FAIL_COND_V(!found, 0);
  1761. return c;
  1762. }
  1763. StringName _ClassDB::get_category(const StringName &p_node) const {
  1764. return ClassDB::get_category(p_node);
  1765. }
  1766. bool _ClassDB::is_class_enabled(StringName p_class) const {
  1767. return ClassDB::is_class_enabled(p_class);
  1768. }
  1769. void _ClassDB::_bind_methods() {
  1770. ClassDB::bind_method(D_METHOD("get_class_list"), &_ClassDB::get_class_list);
  1771. ClassDB::bind_method(D_METHOD("get_inheriters_from_class", "class"), &_ClassDB::get_inheriters_from_class);
  1772. ClassDB::bind_method(D_METHOD("get_parent_class", "class"), &_ClassDB::get_parent_class);
  1773. ClassDB::bind_method(D_METHOD("class_exists", "class"), &_ClassDB::class_exists);
  1774. ClassDB::bind_method(D_METHOD("is_parent_class", "class", "inherits"), &_ClassDB::is_parent_class);
  1775. ClassDB::bind_method(D_METHOD("can_instance", "class"), &_ClassDB::can_instance);
  1776. ClassDB::bind_method(D_METHOD("instance", "class"), &_ClassDB::instance);
  1777. ClassDB::bind_method(D_METHOD("class_has_signal", "class", "signal"), &_ClassDB::has_signal);
  1778. ClassDB::bind_method(D_METHOD("class_get_signal", "class", "signal"), &_ClassDB::get_signal);
  1779. ClassDB::bind_method(D_METHOD("class_get_signal_list", "class", "no_inheritance"), &_ClassDB::get_signal_list, DEFVAL(false));
  1780. ClassDB::bind_method(D_METHOD("class_get_property_list", "class", "no_inheritance"), &_ClassDB::get_property_list, DEFVAL(false));
  1781. ClassDB::bind_method(D_METHOD("class_get_property", "object", "property"), &_ClassDB::get_property);
  1782. ClassDB::bind_method(D_METHOD("class_set_property", "object", "property", "value"), &_ClassDB::set_property);
  1783. ClassDB::bind_method(D_METHOD("class_has_method", "class", "method", "no_inheritance"), &_ClassDB::has_method, DEFVAL(false));
  1784. ClassDB::bind_method(D_METHOD("class_get_method_list", "class", "no_inheritance"), &_ClassDB::get_method_list, DEFVAL(false));
  1785. ClassDB::bind_method(D_METHOD("class_get_integer_constant_list", "class", "no_inheritance"), &_ClassDB::get_integer_constant_list, DEFVAL(false));
  1786. ClassDB::bind_method(D_METHOD("class_has_integer_constant", "class", "name"), &_ClassDB::has_integer_constant);
  1787. ClassDB::bind_method(D_METHOD("class_get_integer_constant", "class", "name"), &_ClassDB::get_integer_constant);
  1788. ClassDB::bind_method(D_METHOD("class_get_category", "class"), &_ClassDB::get_category);
  1789. ClassDB::bind_method(D_METHOD("is_class_enabled", "class"), &_ClassDB::is_class_enabled);
  1790. }
  1791. ////// _Engine //////
  1792. void _Engine::set_iterations_per_second(int p_ips) {
  1793. Engine::get_singleton()->set_iterations_per_second(p_ips);
  1794. }
  1795. int _Engine::get_iterations_per_second() const {
  1796. return Engine::get_singleton()->get_iterations_per_second();
  1797. }
  1798. void _Engine::set_physics_jitter_fix(float p_threshold) {
  1799. Engine::get_singleton()->set_physics_jitter_fix(p_threshold);
  1800. }
  1801. float _Engine::get_physics_jitter_fix() const {
  1802. return Engine::get_singleton()->get_physics_jitter_fix();
  1803. }
  1804. float _Engine::get_physics_interpolation_fraction() const {
  1805. return Engine::get_singleton()->get_physics_interpolation_fraction();
  1806. }
  1807. void _Engine::set_target_fps(int p_fps) {
  1808. Engine::get_singleton()->set_target_fps(p_fps);
  1809. }
  1810. int _Engine::get_target_fps() const {
  1811. return Engine::get_singleton()->get_target_fps();
  1812. }
  1813. float _Engine::get_frames_per_second() const {
  1814. return Engine::get_singleton()->get_frames_per_second();
  1815. }
  1816. uint64_t _Engine::get_physics_frames() const {
  1817. return Engine::get_singleton()->get_physics_frames();
  1818. }
  1819. uint64_t _Engine::get_process_frames() const {
  1820. return Engine::get_singleton()->get_process_frames();
  1821. }
  1822. void _Engine::set_time_scale(float p_scale) {
  1823. Engine::get_singleton()->set_time_scale(p_scale);
  1824. }
  1825. float _Engine::get_time_scale() {
  1826. return Engine::get_singleton()->get_time_scale();
  1827. }
  1828. int _Engine::get_frames_drawn() {
  1829. return Engine::get_singleton()->get_frames_drawn();
  1830. }
  1831. MainLoop *_Engine::get_main_loop() const {
  1832. //needs to remain in OS, since it's actually OS that interacts with it, but it's better exposed here
  1833. return OS::get_singleton()->get_main_loop();
  1834. }
  1835. Dictionary _Engine::get_version_info() const {
  1836. return Engine::get_singleton()->get_version_info();
  1837. }
  1838. Dictionary _Engine::get_author_info() const {
  1839. return Engine::get_singleton()->get_author_info();
  1840. }
  1841. Array _Engine::get_copyright_info() const {
  1842. return Engine::get_singleton()->get_copyright_info();
  1843. }
  1844. Dictionary _Engine::get_donor_info() const {
  1845. return Engine::get_singleton()->get_donor_info();
  1846. }
  1847. Dictionary _Engine::get_license_info() const {
  1848. return Engine::get_singleton()->get_license_info();
  1849. }
  1850. String _Engine::get_license_text() const {
  1851. return Engine::get_singleton()->get_license_text();
  1852. }
  1853. bool _Engine::is_in_physics_frame() const {
  1854. return Engine::get_singleton()->is_in_physics_frame();
  1855. }
  1856. bool _Engine::has_singleton(const String &p_name) const {
  1857. return Engine::get_singleton()->has_singleton(p_name);
  1858. }
  1859. Object *_Engine::get_singleton_object(const String &p_name) const {
  1860. return Engine::get_singleton()->get_singleton_object(p_name);
  1861. }
  1862. void _Engine::set_editor_hint(bool p_enabled) {
  1863. Engine::get_singleton()->set_editor_hint(p_enabled);
  1864. }
  1865. bool _Engine::is_editor_hint() const {
  1866. return Engine::get_singleton()->is_editor_hint();
  1867. }
  1868. void _Engine::_bind_methods() {
  1869. ClassDB::bind_method(D_METHOD("set_iterations_per_second", "iterations_per_second"), &_Engine::set_iterations_per_second);
  1870. ClassDB::bind_method(D_METHOD("get_iterations_per_second"), &_Engine::get_iterations_per_second);
  1871. ClassDB::bind_method(D_METHOD("set_physics_jitter_fix", "physics_jitter_fix"), &_Engine::set_physics_jitter_fix);
  1872. ClassDB::bind_method(D_METHOD("get_physics_jitter_fix"), &_Engine::get_physics_jitter_fix);
  1873. ClassDB::bind_method(D_METHOD("get_physics_interpolation_fraction"), &_Engine::get_physics_interpolation_fraction);
  1874. ClassDB::bind_method(D_METHOD("set_target_fps", "target_fps"), &_Engine::set_target_fps);
  1875. ClassDB::bind_method(D_METHOD("get_target_fps"), &_Engine::get_target_fps);
  1876. ClassDB::bind_method(D_METHOD("set_time_scale", "time_scale"), &_Engine::set_time_scale);
  1877. ClassDB::bind_method(D_METHOD("get_time_scale"), &_Engine::get_time_scale);
  1878. ClassDB::bind_method(D_METHOD("get_frames_drawn"), &_Engine::get_frames_drawn);
  1879. ClassDB::bind_method(D_METHOD("get_frames_per_second"), &_Engine::get_frames_per_second);
  1880. ClassDB::bind_method(D_METHOD("get_physics_frames"), &_Engine::get_physics_frames);
  1881. ClassDB::bind_method(D_METHOD("get_process_frames"), &_Engine::get_process_frames);
  1882. ClassDB::bind_method(D_METHOD("get_main_loop"), &_Engine::get_main_loop);
  1883. ClassDB::bind_method(D_METHOD("get_version_info"), &_Engine::get_version_info);
  1884. ClassDB::bind_method(D_METHOD("get_author_info"), &_Engine::get_author_info);
  1885. ClassDB::bind_method(D_METHOD("get_copyright_info"), &_Engine::get_copyright_info);
  1886. ClassDB::bind_method(D_METHOD("get_donor_info"), &_Engine::get_donor_info);
  1887. ClassDB::bind_method(D_METHOD("get_license_info"), &_Engine::get_license_info);
  1888. ClassDB::bind_method(D_METHOD("get_license_text"), &_Engine::get_license_text);
  1889. ClassDB::bind_method(D_METHOD("is_in_physics_frame"), &_Engine::is_in_physics_frame);
  1890. ClassDB::bind_method(D_METHOD("has_singleton", "name"), &_Engine::has_singleton);
  1891. ClassDB::bind_method(D_METHOD("get_singleton", "name"), &_Engine::get_singleton_object);
  1892. ClassDB::bind_method(D_METHOD("set_editor_hint", "enabled"), &_Engine::set_editor_hint);
  1893. ClassDB::bind_method(D_METHOD("is_editor_hint"), &_Engine::is_editor_hint);
  1894. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "editor_hint"), "set_editor_hint", "is_editor_hint");
  1895. ADD_PROPERTY(PropertyInfo(Variant::INT, "iterations_per_second"), "set_iterations_per_second", "get_iterations_per_second");
  1896. ADD_PROPERTY(PropertyInfo(Variant::INT, "target_fps"), "set_target_fps", "get_target_fps");
  1897. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "time_scale"), "set_time_scale", "get_time_scale");
  1898. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "physics_jitter_fix"), "set_physics_jitter_fix", "get_physics_jitter_fix");
  1899. }
  1900. _Engine *_Engine::singleton = nullptr;
  1901. ////// _JSON //////
  1902. void JSONParseResult::_bind_methods() {
  1903. ClassDB::bind_method(D_METHOD("get_error"), &JSONParseResult::get_error);
  1904. ClassDB::bind_method(D_METHOD("get_error_string"), &JSONParseResult::get_error_string);
  1905. ClassDB::bind_method(D_METHOD("get_error_line"), &JSONParseResult::get_error_line);
  1906. ClassDB::bind_method(D_METHOD("get_result"), &JSONParseResult::get_result);
  1907. ClassDB::bind_method(D_METHOD("set_error", "error"), &JSONParseResult::set_error);
  1908. ClassDB::bind_method(D_METHOD("set_error_string", "error_string"), &JSONParseResult::set_error_string);
  1909. ClassDB::bind_method(D_METHOD("set_error_line", "error_line"), &JSONParseResult::set_error_line);
  1910. ClassDB::bind_method(D_METHOD("set_result", "result"), &JSONParseResult::set_result);
  1911. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "error", PROPERTY_HINT_NONE, "Error", PROPERTY_USAGE_CLASS_IS_ENUM), "set_error", "get_error");
  1912. ADD_PROPERTY(PropertyInfo(Variant::STRING, "error_string"), "set_error_string", "get_error_string");
  1913. ADD_PROPERTY(PropertyInfo(Variant::INT, "error_line"), "set_error_line", "get_error_line");
  1914. ADD_PROPERTY(PropertyInfo(Variant::NIL, "result", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NIL_IS_VARIANT), "set_result", "get_result");
  1915. }
  1916. void JSONParseResult::set_error(Error p_error) {
  1917. error = p_error;
  1918. }
  1919. Error JSONParseResult::get_error() const {
  1920. return error;
  1921. }
  1922. void JSONParseResult::set_error_string(const String &p_error_string) {
  1923. error_string = p_error_string;
  1924. }
  1925. String JSONParseResult::get_error_string() const {
  1926. return error_string;
  1927. }
  1928. void JSONParseResult::set_error_line(int p_error_line) {
  1929. error_line = p_error_line;
  1930. }
  1931. int JSONParseResult::get_error_line() const {
  1932. return error_line;
  1933. }
  1934. void JSONParseResult::set_result(const Variant &p_result) {
  1935. result = p_result;
  1936. }
  1937. Variant JSONParseResult::get_result() const {
  1938. return result;
  1939. }
  1940. void _JSON::_bind_methods() {
  1941. ClassDB::bind_method(D_METHOD("print", "value", "indent", "sort_keys"), &_JSON::print, DEFVAL(String()), DEFVAL(false));
  1942. ClassDB::bind_method(D_METHOD("parse", "json"), &_JSON::parse);
  1943. }
  1944. String _JSON::print(const Variant &p_value, const String &p_indent, bool p_sort_keys) {
  1945. return JSON::print(p_value, p_indent, p_sort_keys);
  1946. }
  1947. Ref<JSONParseResult> _JSON::parse(const String &p_json) {
  1948. Ref<JSONParseResult> result;
  1949. result.instance();
  1950. result->error = JSON::parse(p_json, result->result, result->error_string, result->error_line);
  1951. if (result->error != OK) {
  1952. ERR_PRINT(vformat("Error parsing JSON at line %s: %s", result->error_line, result->error_string));
  1953. }
  1954. return result;
  1955. }
  1956. _JSON *_JSON::singleton = nullptr;
  1957. ////// _EngineDebugger //////
  1958. void _EngineDebugger::_bind_methods() {
  1959. ClassDB::bind_method(D_METHOD("is_active"), &_EngineDebugger::is_active);
  1960. ClassDB::bind_method(D_METHOD("register_profiler", "name", "toggle", "add", "tick"), &_EngineDebugger::register_profiler);
  1961. ClassDB::bind_method(D_METHOD("unregister_profiler", "name"), &_EngineDebugger::unregister_profiler);
  1962. ClassDB::bind_method(D_METHOD("is_profiling", "name"), &_EngineDebugger::is_profiling);
  1963. ClassDB::bind_method(D_METHOD("has_profiler", "name"), &_EngineDebugger::has_profiler);
  1964. ClassDB::bind_method(D_METHOD("profiler_add_frame_data", "name", "data"), &_EngineDebugger::profiler_add_frame_data);
  1965. ClassDB::bind_method(D_METHOD("profiler_enable", "name", "enable", "arguments"), &_EngineDebugger::profiler_enable, DEFVAL(Array()));
  1966. ClassDB::bind_method(D_METHOD("register_message_capture", "name", "callable"), &_EngineDebugger::register_message_capture);
  1967. ClassDB::bind_method(D_METHOD("unregister_message_capture", "name"), &_EngineDebugger::unregister_message_capture);
  1968. ClassDB::bind_method(D_METHOD("has_capture", "name"), &_EngineDebugger::has_capture);
  1969. ClassDB::bind_method(D_METHOD("send_message", "message", "data"), &_EngineDebugger::send_message);
  1970. }
  1971. bool _EngineDebugger::is_active() {
  1972. return EngineDebugger::is_active();
  1973. }
  1974. void _EngineDebugger::register_profiler(const StringName &p_name, const Callable &p_toggle, const Callable &p_add, const Callable &p_tick) {
  1975. ERR_FAIL_COND_MSG(profilers.has(p_name) || has_profiler(p_name), "Profiler already registered: " + p_name);
  1976. profilers.insert(p_name, ProfilerCallable(p_toggle, p_add, p_tick));
  1977. ProfilerCallable &p = profilers[p_name];
  1978. EngineDebugger::Profiler profiler(
  1979. &p,
  1980. &_EngineDebugger::call_toggle,
  1981. &_EngineDebugger::call_add,
  1982. &_EngineDebugger::call_tick);
  1983. EngineDebugger::register_profiler(p_name, profiler);
  1984. }
  1985. void _EngineDebugger::unregister_profiler(const StringName &p_name) {
  1986. ERR_FAIL_COND_MSG(!profilers.has(p_name), "Profiler not registered: " + p_name);
  1987. EngineDebugger::unregister_profiler(p_name);
  1988. profilers.erase(p_name);
  1989. }
  1990. bool _EngineDebugger::_EngineDebugger::is_profiling(const StringName &p_name) {
  1991. return EngineDebugger::is_profiling(p_name);
  1992. }
  1993. bool _EngineDebugger::has_profiler(const StringName &p_name) {
  1994. return EngineDebugger::has_profiler(p_name);
  1995. }
  1996. void _EngineDebugger::profiler_add_frame_data(const StringName &p_name, const Array &p_data) {
  1997. EngineDebugger::profiler_add_frame_data(p_name, p_data);
  1998. }
  1999. void _EngineDebugger::profiler_enable(const StringName &p_name, bool p_enabled, const Array &p_opts) {
  2000. if (EngineDebugger::get_singleton()) {
  2001. EngineDebugger::get_singleton()->profiler_enable(p_name, p_enabled, p_opts);
  2002. }
  2003. }
  2004. void _EngineDebugger::register_message_capture(const StringName &p_name, const Callable &p_callable) {
  2005. ERR_FAIL_COND_MSG(captures.has(p_name) || has_capture(p_name), "Capture already registered: " + p_name);
  2006. captures.insert(p_name, p_callable);
  2007. Callable &c = captures[p_name];
  2008. EngineDebugger::Capture capture(&c, &_EngineDebugger::call_capture);
  2009. EngineDebugger::register_message_capture(p_name, capture);
  2010. }
  2011. void _EngineDebugger::unregister_message_capture(const StringName &p_name) {
  2012. ERR_FAIL_COND_MSG(!captures.has(p_name), "Capture not registered: " + p_name);
  2013. EngineDebugger::unregister_message_capture(p_name);
  2014. captures.erase(p_name);
  2015. }
  2016. bool _EngineDebugger::has_capture(const StringName &p_name) {
  2017. return EngineDebugger::has_capture(p_name);
  2018. }
  2019. void _EngineDebugger::send_message(const String &p_msg, const Array &p_data) {
  2020. ERR_FAIL_COND_MSG(!EngineDebugger::is_active(), "Can't send message. No active debugger");
  2021. EngineDebugger::get_singleton()->send_message(p_msg, p_data);
  2022. }
  2023. void _EngineDebugger::call_toggle(void *p_user, bool p_enable, const Array &p_opts) {
  2024. Callable &toggle = ((ProfilerCallable *)p_user)->callable_toggle;
  2025. if (toggle.is_null()) {
  2026. return;
  2027. }
  2028. Variant enable = p_enable, opts = p_opts;
  2029. const Variant *args[2] = { &enable, &opts };
  2030. Variant retval;
  2031. Callable::CallError err;
  2032. toggle.call(args, 2, retval, err);
  2033. ERR_FAIL_COND_MSG(err.error != Callable::CallError::CALL_OK, "Error calling 'toggle' to callable: " + Variant::get_callable_error_text(toggle, args, 2, err));
  2034. }
  2035. void _EngineDebugger::call_add(void *p_user, const Array &p_data) {
  2036. Callable &add = ((ProfilerCallable *)p_user)->callable_add;
  2037. if (add.is_null()) {
  2038. return;
  2039. }
  2040. Variant data = p_data;
  2041. const Variant *args[1] = { &data };
  2042. Variant retval;
  2043. Callable::CallError err;
  2044. add.call(args, 1, retval, err);
  2045. ERR_FAIL_COND_MSG(err.error != Callable::CallError::CALL_OK, "Error calling 'add' to callable: " + Variant::get_callable_error_text(add, args, 1, err));
  2046. }
  2047. void _EngineDebugger::call_tick(void *p_user, float p_frame_time, float p_idle_time, float p_physics_time, float p_physics_frame_time) {
  2048. Callable &tick = ((ProfilerCallable *)p_user)->callable_tick;
  2049. if (tick.is_null()) {
  2050. return;
  2051. }
  2052. Variant frame_time = p_frame_time, idle_time = p_idle_time, physics_time = p_physics_time, physics_frame_time = p_physics_frame_time;
  2053. const Variant *args[4] = { &frame_time, &idle_time, &physics_time, &physics_frame_time };
  2054. Variant retval;
  2055. Callable::CallError err;
  2056. tick.call(args, 4, retval, err);
  2057. ERR_FAIL_COND_MSG(err.error != Callable::CallError::CALL_OK, "Error calling 'tick' to callable: " + Variant::get_callable_error_text(tick, args, 4, err));
  2058. }
  2059. Error _EngineDebugger::call_capture(void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  2060. Callable &capture = *(Callable *)p_user;
  2061. if (capture.is_null()) {
  2062. return FAILED;
  2063. }
  2064. Variant cmd = p_cmd, data = p_data;
  2065. const Variant *args[2] = { &cmd, &data };
  2066. Variant retval;
  2067. Callable::CallError err;
  2068. capture.call(args, 2, retval, err);
  2069. ERR_FAIL_COND_V_MSG(err.error != Callable::CallError::CALL_OK, FAILED, "Error calling 'capture' to callable: " + Variant::get_callable_error_text(capture, args, 2, err));
  2070. ERR_FAIL_COND_V_MSG(retval.get_type() != Variant::BOOL, FAILED, "Error calling 'capture' to callable: " + String(capture) + ". Return type is not bool.");
  2071. r_captured = retval;
  2072. return OK;
  2073. }
  2074. _EngineDebugger::~_EngineDebugger() {
  2075. for (Map<StringName, Callable>::Element *E = captures.front(); E; E = E->next()) {
  2076. EngineDebugger::unregister_message_capture(E->key());
  2077. }
  2078. captures.clear();
  2079. for (Map<StringName, ProfilerCallable>::Element *E = profilers.front(); E; E = E->next()) {
  2080. EngineDebugger::unregister_profiler(E->key());
  2081. }
  2082. profilers.clear();
  2083. }
  2084. _EngineDebugger *_EngineDebugger::singleton = nullptr;