gd_script.cpp 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879
  1. /*************************************************************************/
  2. /* gd_script.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* http://www.godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. */
  9. /* */
  10. /* Permission is hereby granted, free of charge, to any person obtaining */
  11. /* a copy of this software and associated documentation files (the */
  12. /* "Software"), to deal in the Software without restriction, including */
  13. /* without limitation the rights to use, copy, modify, merge, publish, */
  14. /* distribute, sublicense, and/or sell copies of the Software, and to */
  15. /* permit persons to whom the Software is furnished to do so, subject to */
  16. /* the following conditions: */
  17. /* */
  18. /* The above copyright notice and this permission notice shall be */
  19. /* included in all copies or substantial portions of the Software. */
  20. /* */
  21. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  22. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  23. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  24. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  25. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  26. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  27. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  28. /*************************************************************************/
  29. #include "gd_script.h"
  30. #include "globals.h"
  31. #include "global_constants.h"
  32. #include "gd_compiler.h"
  33. #include "os/file_access.h"
  34. #include "io/file_access_encrypted.h"
  35. Variant *GDFunction::_get_variant(int p_address,GDInstance *p_instance,GDScript *p_script,Variant &self, Variant *p_stack,String& r_error) const{
  36. int address = p_address&ADDR_MASK;
  37. //sequential table (jump table generated by compiler)
  38. switch((p_address&ADDR_TYPE_MASK)>>ADDR_BITS) {
  39. case ADDR_TYPE_SELF: {
  40. if (!p_instance) {
  41. r_error="Cannot access self without instance.";
  42. return NULL;
  43. }
  44. return &self;
  45. } break;
  46. case ADDR_TYPE_CLASS: {
  47. return &p_script->_static_ref;
  48. } break;
  49. case ADDR_TYPE_MEMBER: {
  50. //member indexing is O(1)
  51. if (!p_instance) {
  52. r_error="Cannot access member without instance.";
  53. return NULL;
  54. }
  55. return &p_instance->members[address];
  56. } break;
  57. case ADDR_TYPE_CLASS_CONSTANT: {
  58. //todo change to index!
  59. GDScript *o=p_script;
  60. ERR_FAIL_INDEX_V(address,_global_names_count,NULL);
  61. const StringName *sn = &_global_names_ptr[address];
  62. while(o) {
  63. GDScript *s=o;
  64. while(s) {
  65. Map<StringName,Variant>::Element *E=s->constants.find(*sn);
  66. if (E) {
  67. return &E->get();
  68. }
  69. s=s->_base;
  70. }
  71. o=o->_owner;
  72. }
  73. ERR_EXPLAIN("GDCompiler bug..");
  74. ERR_FAIL_V(NULL);
  75. } break;
  76. case ADDR_TYPE_LOCAL_CONSTANT: {
  77. ERR_FAIL_INDEX_V(address,_constant_count,NULL);
  78. return &_constants_ptr[address];
  79. } break;
  80. case ADDR_TYPE_STACK:
  81. case ADDR_TYPE_STACK_VARIABLE: {
  82. ERR_FAIL_INDEX_V(address,_stack_size,NULL);
  83. return &p_stack[address];
  84. } break;
  85. case ADDR_TYPE_GLOBAL: {
  86. ERR_FAIL_INDEX_V(address,GDScriptLanguage::get_singleton()->get_global_array_size(),NULL);
  87. return &GDScriptLanguage::get_singleton()->get_global_array()[address];
  88. } break;
  89. case ADDR_TYPE_NIL: {
  90. return &nil;
  91. } break;
  92. }
  93. ERR_EXPLAIN("Bad Code! (Addressing Mode)");
  94. ERR_FAIL_V(NULL);
  95. return NULL;
  96. }
  97. String GDFunction::_get_call_error(const Variant::CallError& p_err, const String& p_where,const Variant**argptrs) const {
  98. String err_text;
  99. if (p_err.error==Variant::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  100. int errorarg=p_err.argument;
  101. err_text="Invalid type in "+p_where+". Cannot convert argument "+itos(errorarg+1)+" from "+Variant::get_type_name(argptrs[errorarg]->get_type())+" to "+Variant::get_type_name(p_err.expected)+".";
  102. } else if (p_err.error==Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS) {
  103. err_text="Invalid call to "+p_where+". Expected "+itos(p_err.argument)+" arguments.";
  104. } else if (p_err.error==Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS) {
  105. err_text="Invalid call to "+p_where+". Expected "+itos(p_err.argument)+" arguments.";
  106. } else if (p_err.error==Variant::CallError::CALL_ERROR_INVALID_METHOD) {
  107. err_text="Invalid call. Nonexistent "+p_where+".";
  108. } else if (p_err.error==Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL) {
  109. err_text="Attempt to call "+p_where+" on a null instance.";
  110. } else {
  111. err_text="Bug, call error: #"+itos(p_err.error);
  112. }
  113. return err_text;
  114. }
  115. static String _get_var_type(const Variant* p_type) {
  116. String basestr;
  117. if (p_type->get_type()==Variant::OBJECT) {
  118. Object *bobj = *p_type;
  119. if (!bobj) {
  120. basestr = "null instance";
  121. } else {
  122. #ifdef DEBUG_ENABLED
  123. if (ObjectDB::instance_validate(bobj)) {
  124. if (bobj->get_script_instance())
  125. basestr= bobj->get_type()+" ("+bobj->get_script_instance()->get_script()->get_path().get_file()+")";
  126. else
  127. basestr = bobj->get_type();
  128. } else {
  129. basestr="previously freed instance";
  130. }
  131. #else
  132. basestr="Object";
  133. #endif
  134. }
  135. } else {
  136. basestr = Variant::get_type_name(p_type->get_type());
  137. }
  138. return basestr;
  139. }
  140. Variant GDFunction::call(GDInstance *p_instance, const Variant **p_args, int p_argcount, Variant::CallError& r_err, CallState *p_state) {
  141. if (!_code_ptr) {
  142. return Variant();
  143. }
  144. r_err.error=Variant::CallError::CALL_OK;
  145. Variant self;
  146. Variant retvalue;
  147. Variant *stack = NULL;
  148. Variant **call_args;
  149. int defarg=0;
  150. #ifdef DEBUG_ENABLED
  151. //GDScriptLanguage::get_singleton()->calls++;
  152. #endif
  153. uint32_t alloca_size=0;
  154. GDScript *_class;
  155. int ip=0;
  156. int line=_initial_line;
  157. if (p_state) {
  158. //use existing (supplied) state (yielded)
  159. stack=(Variant*)p_state->stack.ptr();
  160. call_args=(Variant**)&p_state->stack[sizeof(Variant)*p_state->stack_size];
  161. line=p_state->line;
  162. ip=p_state->ip;
  163. alloca_size=p_state->stack.size();
  164. _class=p_state->_class;
  165. p_instance=p_state->instance;
  166. defarg=p_state->defarg;
  167. self=p_state->self;
  168. //stack[p_state->result_pos]=p_state->result; //assign stack with result
  169. } else {
  170. if (p_argcount!=_argument_count) {
  171. if (p_argcount>_argument_count) {
  172. r_err.error=Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  173. r_err.argument=_argument_count;
  174. return Variant();
  175. } else if (p_argcount < _argument_count - _default_arg_count) {
  176. r_err.error=Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  177. r_err.argument=_argument_count - _default_arg_count;
  178. return Variant();
  179. } else {
  180. defarg=_argument_count-p_argcount;
  181. }
  182. }
  183. alloca_size = sizeof(Variant*)*_call_size + sizeof(Variant)*_stack_size;
  184. if (alloca_size) {
  185. uint8_t *aptr = (uint8_t*)alloca(alloca_size);
  186. if (_stack_size) {
  187. stack=(Variant*)aptr;
  188. for(int i=0;i<p_argcount;i++)
  189. memnew_placement(&stack[i],Variant(*p_args[i]));
  190. for(int i=p_argcount;i<_stack_size;i++)
  191. memnew_placement(&stack[i],Variant);
  192. } else {
  193. stack=NULL;
  194. }
  195. if (_call_size) {
  196. call_args = (Variant**)&aptr[sizeof(Variant)*_stack_size];
  197. } else {
  198. call_args=NULL;
  199. }
  200. } else {
  201. stack=NULL;
  202. call_args=NULL;
  203. }
  204. if (p_instance) {
  205. if (p_instance->base_ref && static_cast<Reference*>(p_instance->owner)->is_referenced()) {
  206. self=REF(static_cast<Reference*>(p_instance->owner));
  207. } else {
  208. self=p_instance->owner;
  209. }
  210. _class=p_instance->script.ptr();
  211. } else {
  212. _class=_script;
  213. }
  214. }
  215. String err_text;
  216. #ifdef DEBUG_ENABLED
  217. if (ScriptDebugger::get_singleton())
  218. GDScriptLanguage::get_singleton()->enter_function(p_instance,this,stack,&ip,&line);
  219. #define CHECK_SPACE(m_space)\
  220. ERR_BREAK((ip+m_space)>_code_size)
  221. #define GET_VARIANT_PTR(m_v,m_code_ofs) \
  222. Variant *m_v; \
  223. m_v = _get_variant(_code_ptr[ip+m_code_ofs],p_instance,_class,self,stack,err_text);\
  224. if (!m_v)\
  225. break;
  226. #else
  227. #define CHECK_SPACE(m_space)
  228. #define GET_VARIANT_PTR(m_v,m_code_ofs) \
  229. Variant *m_v; \
  230. m_v = _get_variant(_code_ptr[ip+m_code_ofs],p_instance,_class,self,stack,err_text);
  231. #endif
  232. bool exit_ok=false;
  233. while(ip<_code_size) {
  234. int last_opcode=_code_ptr[ip];
  235. switch(_code_ptr[ip]) {
  236. case OPCODE_OPERATOR: {
  237. CHECK_SPACE(5);
  238. bool valid;
  239. Variant::Operator op = (Variant::Operator)_code_ptr[ip+1];
  240. ERR_BREAK(op>=Variant::OP_MAX);
  241. GET_VARIANT_PTR(a,2);
  242. GET_VARIANT_PTR(b,3);
  243. GET_VARIANT_PTR(dst,4);
  244. #ifdef DEBUG_ENABLED
  245. Variant ret;
  246. Variant::evaluate(op,*a,*b,ret,valid);
  247. #else
  248. Variant::evaluate(op,*a,*b,*dst,valid);
  249. #endif
  250. if (!valid) {
  251. #ifdef DEBUG_ENABLED
  252. if (ret.get_type()==Variant::STRING) {
  253. //return a string when invalid with the error
  254. err_text=ret;
  255. err_text += " in operator '"+Variant::get_operator_name(op)+"'.";
  256. } else {
  257. err_text="Invalid operands '"+Variant::get_type_name(a->get_type())+"' and '"+Variant::get_type_name(b->get_type())+"' in operator '"+Variant::get_operator_name(op)+"'.";
  258. }
  259. #endif
  260. break;
  261. }
  262. #ifdef DEBUG_ENABLED
  263. *dst=ret;
  264. #endif
  265. ip+=5;
  266. } continue;
  267. case OPCODE_EXTENDS_TEST: {
  268. CHECK_SPACE(4);
  269. GET_VARIANT_PTR(a,1);
  270. GET_VARIANT_PTR(b,2);
  271. GET_VARIANT_PTR(dst,3);
  272. #ifdef DEBUG_ENABLED
  273. if (a->get_type()!=Variant::OBJECT || a->operator Object*()==NULL) {
  274. err_text="Left operand of 'extends' is not an instance of anything.";
  275. break;
  276. }
  277. if (b->get_type()!=Variant::OBJECT || b->operator Object*()==NULL) {
  278. err_text="Right operand of 'extends' is not a class.";
  279. break;
  280. }
  281. #endif
  282. Object *obj_A = *a;
  283. Object *obj_B = *b;
  284. GDScript *scr_B = obj_B->cast_to<GDScript>();
  285. bool extends_ok=false;
  286. if (scr_B) {
  287. //if B is a script, the only valid condition is that A has an instance which inherits from the script
  288. //in other situation, this shoul return false.
  289. if (obj_A->get_script_instance() && obj_A->get_script_instance()->get_language()==GDScriptLanguage::get_singleton()) {
  290. GDInstance *ins = static_cast<GDInstance*>(obj_A->get_script_instance());
  291. GDScript *cmp = ins->script.ptr();
  292. //bool found=false;
  293. while(cmp) {
  294. if (cmp==scr_B) {
  295. //inherits from script, all ok
  296. extends_ok=true;
  297. break;
  298. }
  299. cmp=cmp->_base;
  300. }
  301. }
  302. } else {
  303. GDNativeClass *nc= obj_B->cast_to<GDNativeClass>();
  304. if (!nc) {
  305. err_text="Right operand of 'extends' is not a class (type: '"+obj_B->get_type()+"').";
  306. break;
  307. }
  308. extends_ok=ObjectTypeDB::is_type(obj_A->get_type_name(),nc->get_name());
  309. }
  310. *dst=extends_ok;
  311. ip+=4;
  312. } continue;
  313. case OPCODE_SET: {
  314. CHECK_SPACE(3);
  315. GET_VARIANT_PTR(dst,1);
  316. GET_VARIANT_PTR(index,2);
  317. GET_VARIANT_PTR(value,3);
  318. bool valid;
  319. dst->set(*index,*value,&valid);
  320. if (!valid) {
  321. String v = index->operator String();
  322. if (v!="") {
  323. v="'"+v+"'";
  324. } else {
  325. v="of type '"+_get_var_type(index)+"'";
  326. }
  327. err_text="Invalid set index "+v+" (on base: '"+_get_var_type(dst)+"').";
  328. break;
  329. }
  330. ip+=4;
  331. } continue;
  332. case OPCODE_GET: {
  333. CHECK_SPACE(3);
  334. GET_VARIANT_PTR(src,1);
  335. GET_VARIANT_PTR(index,2);
  336. GET_VARIANT_PTR(dst,3);
  337. bool valid;
  338. #ifdef DEBUG_ENABLED
  339. //allow better error message in cases where src and dst are the same stack position
  340. Variant ret = src->get(*index,&valid);
  341. #else
  342. *dst = src->get(*index,&valid);
  343. #endif
  344. if (!valid) {
  345. String v = index->operator String();
  346. if (v!="") {
  347. v="'"+v+"'";
  348. } else {
  349. v="of type '"+_get_var_type(index)+"'";
  350. }
  351. err_text="Invalid get index "+v+" (on base: '"+_get_var_type(src)+"').";
  352. break;
  353. }
  354. #ifdef DEBUG_ENABLED
  355. *dst=ret;
  356. #endif
  357. ip+=4;
  358. } continue;
  359. case OPCODE_SET_NAMED: {
  360. CHECK_SPACE(3);
  361. GET_VARIANT_PTR(dst,1);
  362. GET_VARIANT_PTR(value,3);
  363. int indexname = _code_ptr[ip+2];
  364. ERR_BREAK(indexname<0 || indexname>=_global_names_count);
  365. const StringName *index = &_global_names_ptr[indexname];
  366. bool valid;
  367. dst->set_named(*index,*value,&valid);
  368. if (!valid) {
  369. String err_type;
  370. err_text="Invalid set index '"+String(*index)+"' (on base: '"+_get_var_type(dst)+"').";
  371. break;
  372. }
  373. ip+=4;
  374. } continue;
  375. case OPCODE_GET_NAMED: {
  376. CHECK_SPACE(3);
  377. GET_VARIANT_PTR(src,1);
  378. GET_VARIANT_PTR(dst,3);
  379. int indexname = _code_ptr[ip+2];
  380. ERR_BREAK(indexname<0 || indexname>=_global_names_count);
  381. const StringName *index = &_global_names_ptr[indexname];
  382. bool valid;
  383. #ifdef DEBUG_ENABLED
  384. //allow better error message in cases where src and dst are the same stack position
  385. Variant ret = src->get_named(*index,&valid);
  386. #else
  387. *dst = src->get_named(*index,&valid);
  388. #endif
  389. if (!valid) {
  390. if (src->has_method(*index)) {
  391. err_text="Invalid get index '"+index->operator String()+"' (on base: '"+_get_var_type(src)+"'). Did you mean '."+index->operator String()+"()' ?";
  392. } else {
  393. err_text="Invalid get index '"+index->operator String()+"' (on base: '"+_get_var_type(src)+"').";
  394. }
  395. break;
  396. }
  397. #ifdef DEBUG_ENABLED
  398. *dst=ret;
  399. #endif
  400. ip+=4;
  401. } continue;
  402. case OPCODE_ASSIGN: {
  403. CHECK_SPACE(3);
  404. GET_VARIANT_PTR(dst,1);
  405. GET_VARIANT_PTR(src,2);
  406. *dst = *src;
  407. ip+=3;
  408. } continue;
  409. case OPCODE_ASSIGN_TRUE: {
  410. CHECK_SPACE(2);
  411. GET_VARIANT_PTR(dst,1);
  412. *dst = true;
  413. ip+=2;
  414. } continue;
  415. case OPCODE_ASSIGN_FALSE: {
  416. CHECK_SPACE(2);
  417. GET_VARIANT_PTR(dst,1);
  418. *dst = false;
  419. ip+=2;
  420. } continue;
  421. case OPCODE_CONSTRUCT: {
  422. CHECK_SPACE(2);
  423. Variant::Type t=Variant::Type(_code_ptr[ip+1]);
  424. int argc=_code_ptr[ip+2];
  425. CHECK_SPACE(argc+2);
  426. Variant **argptrs = call_args;
  427. for(int i=0;i<argc;i++) {
  428. GET_VARIANT_PTR(v,3+i);
  429. argptrs[i]=v;
  430. }
  431. GET_VARIANT_PTR(dst,3+argc);
  432. Variant::CallError err;
  433. *dst = Variant::construct(t,(const Variant**)argptrs,argc,err);
  434. if (err.error!=Variant::CallError::CALL_OK) {
  435. err_text=_get_call_error(err,"'"+Variant::get_type_name(t)+"' constructor",(const Variant**)argptrs);
  436. break;
  437. }
  438. ip+=4+argc;
  439. //construct a basic type
  440. } continue;
  441. case OPCODE_CONSTRUCT_ARRAY: {
  442. CHECK_SPACE(1);
  443. int argc=_code_ptr[ip+1];
  444. Array array(true); //arrays are always shared
  445. array.resize(argc);
  446. CHECK_SPACE(argc+2);
  447. for(int i=0;i<argc;i++) {
  448. GET_VARIANT_PTR(v,2+i);
  449. array[i]=*v;
  450. }
  451. GET_VARIANT_PTR(dst,2+argc);
  452. *dst=array;
  453. ip+=3+argc;
  454. } continue;
  455. case OPCODE_CONSTRUCT_DICTIONARY: {
  456. CHECK_SPACE(1);
  457. int argc=_code_ptr[ip+1];
  458. Dictionary dict(true); //arrays are always shared
  459. CHECK_SPACE(argc*2+2);
  460. for(int i=0;i<argc;i++) {
  461. GET_VARIANT_PTR(k,2+i*2+0);
  462. GET_VARIANT_PTR(v,2+i*2+1);
  463. dict[*k]=*v;
  464. }
  465. GET_VARIANT_PTR(dst,2+argc*2);
  466. *dst=dict;
  467. ip+=3+argc*2;
  468. } continue;
  469. case OPCODE_CALL_RETURN:
  470. case OPCODE_CALL: {
  471. CHECK_SPACE(4);
  472. bool call_ret = _code_ptr[ip]==OPCODE_CALL_RETURN;
  473. int argc=_code_ptr[ip+1];
  474. GET_VARIANT_PTR(base,2);
  475. int nameg=_code_ptr[ip+3];
  476. ERR_BREAK(nameg<0 || nameg>=_global_names_count);
  477. const StringName *methodname = &_global_names_ptr[nameg];
  478. ERR_BREAK(argc<0);
  479. ip+=4;
  480. CHECK_SPACE(argc+1);
  481. Variant **argptrs = call_args;
  482. for(int i=0;i<argc;i++) {
  483. GET_VARIANT_PTR(v,i);
  484. argptrs[i]=v;
  485. }
  486. Variant::CallError err;
  487. if (call_ret) {
  488. GET_VARIANT_PTR(ret,argc);
  489. *ret = base->call(*methodname,(const Variant**)argptrs,argc,err);
  490. } else {
  491. base->call(*methodname,(const Variant**)argptrs,argc,err);
  492. }
  493. if (err.error!=Variant::CallError::CALL_OK) {
  494. String methodstr = *methodname;
  495. String basestr = _get_var_type(base);
  496. if (methodstr=="call") {
  497. if (argc>=1) {
  498. methodstr=String(*argptrs[0])+" (via call)";
  499. if (err.error==Variant::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  500. err.argument-=1;
  501. }
  502. }
  503. } if (methodstr=="free") {
  504. if (err.error==Variant::CallError::CALL_ERROR_INVALID_METHOD) {
  505. if (base->is_ref()) {
  506. err_text="Attempted to free a reference.";
  507. break;
  508. } else if (base->get_type()==Variant::OBJECT) {
  509. err_text="Attempted to free a locked object (calling or emitting).";
  510. break;
  511. }
  512. }
  513. }
  514. err_text=_get_call_error(err,"function '"+methodstr+"' in base '"+basestr+"'",(const Variant**)argptrs);
  515. break;
  516. }
  517. //_call_func(NULL,base,*methodname,ip,argc,p_instance,stack);
  518. ip+=argc+1;
  519. } continue;
  520. case OPCODE_CALL_BUILT_IN: {
  521. CHECK_SPACE(4);
  522. GDFunctions::Function func = GDFunctions::Function(_code_ptr[ip+1]);
  523. int argc=_code_ptr[ip+2];
  524. ERR_BREAK(argc<0);
  525. ip+=3;
  526. CHECK_SPACE(argc+1);
  527. Variant **argptrs = call_args;
  528. for(int i=0;i<argc;i++) {
  529. GET_VARIANT_PTR(v,i);
  530. argptrs[i]=v;
  531. }
  532. GET_VARIANT_PTR(dst,argc);
  533. Variant::CallError err;
  534. GDFunctions::call(func,(const Variant**)argptrs,argc,*dst,err);
  535. if (err.error!=Variant::CallError::CALL_OK) {
  536. String methodstr = GDFunctions::get_func_name(func);
  537. err_text=_get_call_error(err,"built-in function '"+methodstr+"'",(const Variant**)argptrs);
  538. break;
  539. }
  540. ip+=argc+1;
  541. } continue;
  542. case OPCODE_CALL_SELF: {
  543. } break;
  544. case OPCODE_CALL_SELF_BASE: {
  545. CHECK_SPACE(2);
  546. int self_fun = _code_ptr[ip+1];
  547. #ifdef DEBUG_ENABLED
  548. if (self_fun<0 || self_fun>=_global_names_count) {
  549. err_text="compiler bug, function name not found";
  550. break;
  551. }
  552. #endif
  553. const StringName *methodname = &_global_names_ptr[self_fun];
  554. int argc=_code_ptr[ip+2];
  555. CHECK_SPACE(2+argc+1);
  556. Variant **argptrs = call_args;
  557. for(int i=0;i<argc;i++) {
  558. GET_VARIANT_PTR(v,i+3);
  559. argptrs[i]=v;
  560. }
  561. GET_VARIANT_PTR(dst,argc+3);
  562. const GDScript *gds = _script;
  563. const Map<StringName,GDFunction>::Element *E=NULL;
  564. while (gds->base.ptr()) {
  565. gds=gds->base.ptr();
  566. E=gds->member_functions.find(*methodname);
  567. if (E)
  568. break;
  569. }
  570. Variant::CallError err;
  571. if (E) {
  572. *dst=((GDFunction*)&E->get())->call(p_instance,(const Variant**)argptrs,argc,err);
  573. } else if (gds->native.ptr()) {
  574. if (*methodname!=GDScriptLanguage::get_singleton()->strings._init) {
  575. MethodBind *mb = ObjectTypeDB::get_method(gds->native->get_name(),*methodname);
  576. if (!mb) {
  577. err.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  578. } else {
  579. *dst=mb->call(p_instance->owner,(const Variant**)argptrs,argc,err);
  580. }
  581. } else {
  582. err.error=Variant::CallError::CALL_OK;
  583. }
  584. } else {
  585. if (*methodname!=GDScriptLanguage::get_singleton()->strings._init) {
  586. err.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  587. } else {
  588. err.error=Variant::CallError::CALL_OK;
  589. }
  590. }
  591. if (err.error!=Variant::CallError::CALL_OK) {
  592. String methodstr = *methodname;
  593. err_text=_get_call_error(err,"function '"+methodstr+"'",(const Variant**)argptrs);
  594. break;
  595. }
  596. ip+=4+argc;
  597. } continue;
  598. case OPCODE_YIELD:
  599. case OPCODE_YIELD_SIGNAL: {
  600. int ipofs=1;
  601. if (_code_ptr[ip]==OPCODE_YIELD_SIGNAL) {
  602. CHECK_SPACE(4);
  603. ipofs+=2;
  604. } else {
  605. CHECK_SPACE(2);
  606. }
  607. Ref<GDFunctionState> gdfs = memnew( GDFunctionState );
  608. gdfs->function=this;
  609. gdfs->state.stack.resize(alloca_size);
  610. //copy variant stack
  611. for(int i=0;i<_stack_size;i++) {
  612. memnew_placement(&gdfs->state.stack[sizeof(Variant)*i],Variant(stack[i]));
  613. }
  614. gdfs->state.stack_size=_stack_size;
  615. gdfs->state.self=self;
  616. gdfs->state.alloca_size=alloca_size;
  617. gdfs->state._class=_class;
  618. gdfs->state.ip=ip+ipofs;
  619. gdfs->state.line=line;
  620. //gdfs->state.result_pos=ip+ipofs-1;
  621. gdfs->state.defarg=defarg;
  622. gdfs->state.instance=p_instance;
  623. gdfs->function=this;
  624. retvalue=gdfs;
  625. if (_code_ptr[ip]==OPCODE_YIELD_SIGNAL) {
  626. GET_VARIANT_PTR(argobj,1);
  627. GET_VARIANT_PTR(argname,2);
  628. //do the oneshot connect
  629. if (argobj->get_type()!=Variant::OBJECT) {
  630. err_text="First argument of yield() not of type object.";
  631. break;
  632. }
  633. if (argname->get_type()!=Variant::STRING) {
  634. err_text="Second argument of yield() not a string (for signal name).";
  635. break;
  636. }
  637. Object *obj=argobj->operator Object *();
  638. String signal = argname->operator String();
  639. #ifdef DEBUG_ENABLED
  640. if (!obj) {
  641. err_text="First argument of yield() is null.";
  642. break;
  643. }
  644. if (ScriptDebugger::get_singleton()) {
  645. if (!ObjectDB::instance_validate(obj)) {
  646. err_text="First argument of yield() is a previously freed instance.";
  647. break;
  648. }
  649. }
  650. if (signal.length()==0) {
  651. err_text="Second argument of yield() is an empty string (for signal name).";
  652. break;
  653. }
  654. #endif
  655. Error err = obj->connect(signal,gdfs.ptr(),"_signal_callback",varray(gdfs),Object::CONNECT_ONESHOT);
  656. if (err!=OK) {
  657. err_text="Error connecting to signal: "+signal+" during yield().";
  658. break;
  659. }
  660. }
  661. exit_ok=true;
  662. } break;
  663. case OPCODE_YIELD_RESUME: {
  664. CHECK_SPACE(2);
  665. if (!p_state) {
  666. err_text=("Invalid Resume (bug?)");
  667. break;
  668. }
  669. GET_VARIANT_PTR(result,1);
  670. *result=p_state->result;
  671. ip+=2;
  672. } continue;
  673. case OPCODE_JUMP: {
  674. CHECK_SPACE(2);
  675. int to = _code_ptr[ip+1];
  676. ERR_BREAK(to<0 || to>_code_size);
  677. ip=to;
  678. } continue;
  679. case OPCODE_JUMP_IF: {
  680. CHECK_SPACE(3);
  681. GET_VARIANT_PTR(test,1);
  682. bool valid;
  683. bool result = test->booleanize(valid);
  684. #ifdef DEBUG_ENABLED
  685. if (!valid) {
  686. err_text="cannot evaluate conditional expression of type: "+Variant::get_type_name(test->get_type());
  687. break;
  688. }
  689. #endif
  690. if (result) {
  691. int to = _code_ptr[ip+2];
  692. ERR_BREAK(to<0 || to>_code_size);
  693. ip=to;
  694. continue;
  695. }
  696. ip+=3;
  697. } continue;
  698. case OPCODE_JUMP_IF_NOT: {
  699. CHECK_SPACE(3);
  700. GET_VARIANT_PTR(test,1);
  701. bool valid;
  702. bool result = test->booleanize(valid);
  703. #ifdef DEBUG_ENABLED
  704. if (!valid) {
  705. err_text="cannot evaluate conditional expression of type: "+Variant::get_type_name(test->get_type());
  706. break;
  707. }
  708. #endif
  709. if (!result) {
  710. int to = _code_ptr[ip+2];
  711. ERR_BREAK(to<0 || to>_code_size);
  712. ip=to;
  713. continue;
  714. }
  715. ip+=3;
  716. } continue;
  717. case OPCODE_JUMP_TO_DEF_ARGUMENT: {
  718. CHECK_SPACE(2);
  719. ip=_default_arg_ptr[defarg];
  720. } continue;
  721. case OPCODE_RETURN: {
  722. CHECK_SPACE(2);
  723. GET_VARIANT_PTR(r,1);
  724. retvalue=*r;
  725. exit_ok=true;
  726. } break;
  727. case OPCODE_ITERATE_BEGIN: {
  728. CHECK_SPACE(8); //space for this an regular iterate
  729. GET_VARIANT_PTR(counter,1);
  730. GET_VARIANT_PTR(container,2);
  731. bool valid;
  732. if (!container->iter_init(*counter,valid)) {
  733. if (!valid) {
  734. err_text="Unable to iterate on object of type "+Variant::get_type_name(container->get_type())+"'.";
  735. break;
  736. }
  737. int jumpto=_code_ptr[ip+3];
  738. ERR_BREAK(jumpto<0 || jumpto>_code_size);
  739. ip=jumpto;
  740. continue;
  741. }
  742. GET_VARIANT_PTR(iterator,4);
  743. *iterator=container->iter_get(*counter,valid);
  744. if (!valid) {
  745. err_text="Unable to obtain iterator object of type "+Variant::get_type_name(container->get_type())+"'.";
  746. break;
  747. }
  748. ip+=5; //skip regular iterate which is always next
  749. } continue;
  750. case OPCODE_ITERATE: {
  751. CHECK_SPACE(4);
  752. GET_VARIANT_PTR(counter,1);
  753. GET_VARIANT_PTR(container,2);
  754. bool valid;
  755. if (!container->iter_next(*counter,valid)) {
  756. if (!valid) {
  757. err_text="Unable to iterate on object of type "+Variant::get_type_name(container->get_type())+"' (type changed since first iteration?).";
  758. break;
  759. }
  760. int jumpto=_code_ptr[ip+3];
  761. ERR_BREAK(jumpto<0 || jumpto>_code_size);
  762. ip=jumpto;
  763. continue;
  764. }
  765. GET_VARIANT_PTR(iterator,4);
  766. *iterator=container->iter_get(*counter,valid);
  767. if (!valid) {
  768. err_text="Unable to obtain iterator object of type "+Variant::get_type_name(container->get_type())+"' (but was obtained on first iteration?).";
  769. break;
  770. }
  771. ip+=5; //loop again
  772. } continue;
  773. case OPCODE_ASSERT: {
  774. CHECK_SPACE(2);
  775. GET_VARIANT_PTR(test,1);
  776. #ifdef DEBUG_ENABLED
  777. bool valid;
  778. bool result = test->booleanize(valid);
  779. if (!valid) {
  780. err_text="cannot evaluate conditional expression of type: "+Variant::get_type_name(test->get_type());
  781. break;
  782. }
  783. if (!result) {
  784. err_text="Assertion failed.";
  785. break;
  786. }
  787. #endif
  788. ip+=2;
  789. } continue;
  790. case OPCODE_BREAKPOINT: {
  791. #ifdef DEBUG_ENABLED
  792. if (ScriptDebugger::get_singleton()) {
  793. GDScriptLanguage::get_singleton()->debug_break("Breakpoint Statement",true);
  794. }
  795. #endif
  796. ip+=1;
  797. } continue;
  798. case OPCODE_LINE: {
  799. CHECK_SPACE(2);
  800. line=_code_ptr[ip+1];
  801. ip+=2;
  802. if (ScriptDebugger::get_singleton()) {
  803. // line
  804. bool do_break=false;
  805. if (ScriptDebugger::get_singleton()->get_lines_left()>0) {
  806. if (ScriptDebugger::get_singleton()->get_depth()<=0)
  807. ScriptDebugger::get_singleton()->set_lines_left( ScriptDebugger::get_singleton()->get_lines_left() -1 );
  808. if (ScriptDebugger::get_singleton()->get_lines_left()<=0)
  809. do_break=true;
  810. }
  811. if (ScriptDebugger::get_singleton()->is_breakpoint(line,source))
  812. do_break=true;
  813. if (do_break) {
  814. GDScriptLanguage::get_singleton()->debug_break("Breakpoint",true);
  815. }
  816. ScriptDebugger::get_singleton()->line_poll();
  817. }
  818. } continue;
  819. case OPCODE_END: {
  820. exit_ok=true;
  821. break;
  822. } break;
  823. default: {
  824. err_text="Illegal opcode "+itos(_code_ptr[ip])+" at address "+itos(ip);
  825. } break;
  826. }
  827. if (exit_ok)
  828. break;
  829. //error
  830. // function, file, line, error, explanation
  831. String err_file;
  832. if (p_instance)
  833. err_file=p_instance->script->path;
  834. else if (_class)
  835. err_file=_class->path;
  836. if (err_file=="")
  837. err_file="<built-in>";
  838. String err_func = name;
  839. if (p_instance && p_instance->script->name!="")
  840. err_func=p_instance->script->name+"."+err_func;
  841. int err_line=line;
  842. if (err_text=="") {
  843. err_text="Internal Script Error! - opcode #"+itos(last_opcode)+" (report please).";
  844. }
  845. if (!GDScriptLanguage::get_singleton()->debug_break(err_text,false)) {
  846. // debugger break did not happen
  847. _err_print_error(err_func.utf8().get_data(),err_file.utf8().get_data(),err_line,err_text.utf8().get_data(),ERR_HANDLER_SCRIPT);
  848. }
  849. break;
  850. }
  851. if (ScriptDebugger::get_singleton())
  852. GDScriptLanguage::get_singleton()->exit_function();
  853. if (_stack_size) {
  854. //free stack
  855. for(int i=0;i<_stack_size;i++)
  856. stack[i].~Variant();
  857. }
  858. return retvalue;
  859. }
  860. const int* GDFunction::get_code() const {
  861. return _code_ptr;
  862. }
  863. int GDFunction::get_code_size() const{
  864. return _code_size;
  865. }
  866. Variant GDFunction::get_constant(int p_idx) const {
  867. ERR_FAIL_INDEX_V(p_idx,constants.size(),"<errconst>");
  868. return constants[p_idx];
  869. }
  870. StringName GDFunction::get_global_name(int p_idx) const {
  871. ERR_FAIL_INDEX_V(p_idx,global_names.size(),"<errgname>");
  872. return global_names[p_idx];
  873. }
  874. int GDFunction::get_default_argument_count() const {
  875. return default_arguments.size();
  876. }
  877. int GDFunction::get_default_argument_addr(int p_arg) const{
  878. ERR_FAIL_INDEX_V(p_arg,default_arguments.size(),-1);
  879. return default_arguments[p_arg];
  880. }
  881. StringName GDFunction::get_name() const {
  882. return name;
  883. }
  884. int GDFunction::get_max_stack_size() const {
  885. return _stack_size;
  886. }
  887. struct _GDFKC {
  888. int order;
  889. List<int> pos;
  890. };
  891. struct _GDFKCS {
  892. int order;
  893. StringName id;
  894. int pos;
  895. bool operator<(const _GDFKCS &p_r) const {
  896. return order<p_r.order;
  897. }
  898. };
  899. void GDFunction::debug_get_stack_member_state(int p_line,List<Pair<StringName,int> > *r_stackvars) const {
  900. int oc=0;
  901. Map<StringName,_GDFKC> sdmap;
  902. for( const List<StackDebug>::Element *E=stack_debug.front();E;E=E->next()) {
  903. const StackDebug &sd=E->get();
  904. if (sd.line>p_line)
  905. break;
  906. if (sd.added) {
  907. if (!sdmap.has(sd.identifier)) {
  908. _GDFKC d;
  909. d.order=oc++;
  910. d.pos.push_back(sd.pos);
  911. sdmap[sd.identifier]=d;
  912. } else {
  913. sdmap[sd.identifier].pos.push_back(sd.pos);
  914. }
  915. } else {
  916. ERR_CONTINUE(!sdmap.has(sd.identifier));
  917. sdmap[sd.identifier].pos.pop_back();
  918. if (sdmap[sd.identifier].pos.empty())
  919. sdmap.erase(sd.identifier);
  920. }
  921. }
  922. List<_GDFKCS> stackpositions;
  923. for(Map<StringName,_GDFKC>::Element *E=sdmap.front();E;E=E->next() ) {
  924. _GDFKCS spp;
  925. spp.id=E->key();
  926. spp.order=E->get().order;
  927. spp.pos=E->get().pos.back()->get();
  928. stackpositions.push_back(spp);
  929. }
  930. stackpositions.sort();
  931. for(List<_GDFKCS>::Element *E=stackpositions.front();E;E=E->next()) {
  932. Pair<StringName,int> p;
  933. p.first=E->get().id;
  934. p.second=E->get().pos;
  935. r_stackvars->push_back(p);
  936. }
  937. }
  938. #if 0
  939. void GDFunction::clear() {
  940. name=StringName();
  941. constants.clear();
  942. _stack_size=0;
  943. code.clear();
  944. _constants_ptr=NULL;
  945. _constant_count=0;
  946. _global_names_ptr=NULL;
  947. _global_names_count=0;
  948. _code_ptr=NULL;
  949. _code_size=0;
  950. }
  951. #endif
  952. GDFunction::GDFunction() {
  953. _stack_size=0;
  954. _call_size=0;
  955. name="<anonymous>";
  956. #ifdef DEBUG_ENABLED
  957. _func_cname=NULL;
  958. #endif
  959. }
  960. /////////////////////
  961. Variant GDFunctionState::_signal_callback(const Variant** p_args, int p_argcount, Variant::CallError& r_error) {
  962. Variant arg;
  963. r_error.error=Variant::CallError::CALL_OK;
  964. ERR_FAIL_COND_V(!function,Variant());
  965. if (p_argcount==0) {
  966. r_error.error=Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  967. r_error.argument=1;
  968. return Variant();
  969. } else if (p_argcount==1) {
  970. //noooneee
  971. } else if (p_argcount==2) {
  972. arg=*p_args[0];
  973. } else {
  974. Array extra_args;
  975. for(int i=0;i<p_argcount-1;i++) {
  976. extra_args.push_back(*p_args[i]);
  977. }
  978. arg=extra_args;
  979. }
  980. Ref<GDFunctionState> self = *p_args[p_argcount-1];
  981. if (self.is_null()) {
  982. r_error.error=Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  983. r_error.argument=p_argcount-1;
  984. r_error.expected=Variant::OBJECT;
  985. return Variant();
  986. }
  987. state.result=arg;
  988. Variant ret = function->call(NULL,NULL,0,r_error,&state);
  989. function=NULL; //cleaned up;
  990. state.result=Variant();
  991. return ret;
  992. }
  993. bool GDFunctionState::is_valid() const {
  994. return function!=NULL;
  995. }
  996. Variant GDFunctionState::resume(const Variant& p_arg) {
  997. ERR_FAIL_COND_V(!function,Variant());
  998. state.result=p_arg;
  999. Variant::CallError err;
  1000. Variant ret = function->call(NULL,NULL,0,err,&state);
  1001. function=NULL; //cleaned up;
  1002. state.result=Variant();
  1003. return ret;
  1004. }
  1005. void GDFunctionState::_bind_methods() {
  1006. ObjectTypeDB::bind_method(_MD("resume:Variant","arg"),&GDFunctionState::resume,DEFVAL(Variant()));
  1007. ObjectTypeDB::bind_method(_MD("is_valid"),&GDFunctionState::is_valid);
  1008. ObjectTypeDB::bind_native_method(METHOD_FLAGS_DEFAULT,"_signal_callback",&GDFunctionState::_signal_callback,MethodInfo("_signal_callback"));
  1009. }
  1010. GDFunctionState::GDFunctionState() {
  1011. function=NULL;
  1012. }
  1013. GDFunctionState::~GDFunctionState() {
  1014. if (function!=NULL) {
  1015. //never called, deinitialize stack
  1016. for(int i=0;i<state.stack_size;i++) {
  1017. Variant *v=(Variant*)&state.stack[sizeof(Variant)*i];
  1018. v->~Variant();
  1019. }
  1020. }
  1021. }
  1022. ///////////////////////////
  1023. GDNativeClass::GDNativeClass(const StringName& p_name) {
  1024. name=p_name;
  1025. }
  1026. /*void GDNativeClass::call_multilevel(const StringName& p_method,const Variant** p_args,int p_argcount){
  1027. }*/
  1028. bool GDNativeClass::_get(const StringName& p_name,Variant &r_ret) const {
  1029. bool ok;
  1030. int v = ObjectTypeDB::get_integer_constant(name, p_name, &ok);
  1031. if (ok) {
  1032. r_ret=v;
  1033. return true;
  1034. } else {
  1035. return false;
  1036. }
  1037. }
  1038. void GDNativeClass::_bind_methods() {
  1039. ObjectTypeDB::bind_method(_MD("new"),&GDNativeClass::_new);
  1040. }
  1041. Variant GDNativeClass::_new() {
  1042. Object *o = instance();
  1043. if (!o) {
  1044. ERR_EXPLAIN("Class type: '"+String(name)+"' is not instantiable.");
  1045. ERR_FAIL_COND_V(!o,Variant());
  1046. }
  1047. Reference *ref = o->cast_to<Reference>();
  1048. if (ref) {
  1049. return REF(ref);
  1050. } else {
  1051. return o;
  1052. }
  1053. }
  1054. Object *GDNativeClass::instance() {
  1055. return ObjectTypeDB::instance(name);
  1056. }
  1057. GDInstance* GDScript::_create_instance(const Variant** p_args,int p_argcount,Object *p_owner,bool p_isref,Variant::CallError& r_error) {
  1058. /* STEP 1, CREATE */
  1059. GDInstance* instance = memnew( GDInstance );
  1060. instance->base_ref=p_isref;
  1061. instance->members.resize(member_indices.size());
  1062. instance->script=Ref<GDScript>(this);
  1063. instance->owner=p_owner;
  1064. instance->owner->set_script_instance(instance);
  1065. /* STEP 2, INITIALIZE AND CONSRTUCT */
  1066. instances.insert(instance->owner);
  1067. initializer->call(instance,p_args,p_argcount,r_error);
  1068. if (r_error.error!=Variant::CallError::CALL_OK) {
  1069. instance->script=Ref<GDScript>();
  1070. instance->owner->set_script_instance(NULL);
  1071. instances.erase(p_owner);
  1072. ERR_FAIL_COND_V(r_error.error!=Variant::CallError::CALL_OK, NULL); //error constructing
  1073. }
  1074. //@TODO make thread safe
  1075. return instance;
  1076. }
  1077. Variant GDScript::_new(const Variant** p_args,int p_argcount,Variant::CallError& r_error) {
  1078. /* STEP 1, CREATE */
  1079. r_error.error=Variant::CallError::CALL_OK;
  1080. REF ref;
  1081. Object *owner=NULL;
  1082. GDScript *_baseptr=this;
  1083. while (_baseptr->_base) {
  1084. _baseptr=_baseptr->_base;
  1085. }
  1086. if (_baseptr->native.ptr()) {
  1087. owner=_baseptr->native->instance();
  1088. } else {
  1089. owner=memnew( Reference ); //by default, no base means use reference
  1090. }
  1091. Reference *r=owner->cast_to<Reference>();
  1092. if (r) {
  1093. ref=REF(r);
  1094. }
  1095. GDInstance* instance = _create_instance(p_args,p_argcount,owner,r!=NULL,r_error);
  1096. if (!instance) {
  1097. if (ref.is_null()) {
  1098. memdelete(owner); //no owner, sorry
  1099. }
  1100. return Variant();
  1101. }
  1102. if (ref.is_valid()) {
  1103. return ref;
  1104. } else {
  1105. return owner;
  1106. }
  1107. }
  1108. bool GDScript::can_instance() const {
  1109. //return valid; //any script in GDscript can instance
  1110. return valid || (!tool && !ScriptServer::is_scripting_enabled());
  1111. }
  1112. StringName GDScript::get_instance_base_type() const {
  1113. if (native.is_valid())
  1114. return native->get_name();
  1115. if (base.is_valid())
  1116. return base->get_instance_base_type();
  1117. return StringName();
  1118. }
  1119. struct _GDScriptMemberSort {
  1120. int index;
  1121. StringName name;
  1122. _FORCE_INLINE_ bool operator<(const _GDScriptMemberSort& p_member) const { return index < p_member.index; }
  1123. };
  1124. #ifdef TOOLS_ENABLED
  1125. void GDScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  1126. placeholders.erase(p_placeholder);
  1127. }
  1128. /*
  1129. void GDScript::_update_placeholder(PlaceHolderScriptInstance *p_placeholder) {
  1130. List<PropertyInfo> plist;
  1131. GDScript *scr=this;
  1132. Map<StringName,Variant> default_values;
  1133. while(scr) {
  1134. Vector<_GDScriptMemberSort> msort;
  1135. for(Map<StringName,PropertyInfo>::Element *E=scr->member_info.front();E;E=E->next()) {
  1136. _GDScriptMemberSort ms;
  1137. ERR_CONTINUE(!scr->member_indices.has(E->key()));
  1138. ms.index=scr->member_indices[E->key()].index;
  1139. ms.name=E->key();
  1140. msort.push_back(ms);
  1141. }
  1142. msort.sort();
  1143. msort.invert();
  1144. for(int i=0;i<msort.size();i++) {
  1145. plist.push_front(scr->member_info[msort[i].name]);
  1146. if (scr->member_default_values.has(msort[i].name))
  1147. default_values[msort[i].name]=scr->member_default_values[msort[i].name];
  1148. else {
  1149. Variant::CallError err;
  1150. default_values[msort[i].name]=Variant::construct(scr->member_info[msort[i].name].type,NULL,0,err);
  1151. }
  1152. }
  1153. scr=scr->_base;
  1154. }
  1155. p_placeholder->update(plist,default_values);
  1156. }*/
  1157. #endif
  1158. bool GDScript::get_property_default_value(const StringName& p_property, Variant &r_value) const {
  1159. #ifdef TOOLS_ENABLED
  1160. //for (const Map<StringName,Variant>::Element *I=member_default_values.front();I;I=I->next()) {
  1161. // print_line("\t"+String(String(I->key())+":"+String(I->get())));
  1162. //}
  1163. const Map<StringName,Variant>::Element *E=member_default_values_cache.find(p_property);
  1164. if (E) {
  1165. r_value=E->get();
  1166. return true;
  1167. }
  1168. if (base_cache.is_valid()) {
  1169. return base_cache->get_property_default_value(p_property,r_value);
  1170. }
  1171. #endif
  1172. return false;
  1173. }
  1174. ScriptInstance* GDScript::instance_create(Object *p_this) {
  1175. if (!tool && !ScriptServer::is_scripting_enabled()) {
  1176. #ifdef TOOLS_ENABLED
  1177. //instance a fake script for editing the values
  1178. //plist.invert();
  1179. /*print_line("CREATING PLACEHOLDER");
  1180. for(List<PropertyInfo>::Element *E=plist.front();E;E=E->next()) {
  1181. print_line(E->get().name);
  1182. }*/
  1183. PlaceHolderScriptInstance *si = memnew( PlaceHolderScriptInstance(GDScriptLanguage::get_singleton(),Ref<Script>(this),p_this) );
  1184. placeholders.insert(si);
  1185. //_update_placeholder(si);
  1186. _update_exports();
  1187. return si;
  1188. #else
  1189. return NULL;
  1190. #endif
  1191. }
  1192. GDScript *top=this;
  1193. while(top->_base)
  1194. top=top->_base;
  1195. if (top->native.is_valid()) {
  1196. if (!ObjectTypeDB::is_type(p_this->get_type_name(),top->native->get_name())) {
  1197. if (ScriptDebugger::get_singleton()) {
  1198. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(),0,"Script inherits from native type '"+String(top->native->get_name())+"', so it can't be instanced in object of type: '"+p_this->get_type()+"'");
  1199. }
  1200. ERR_EXPLAIN("Script inherits from native type '"+String(top->native->get_name())+"', so it can't be instanced in object of type: '"+p_this->get_type()+"'");
  1201. ERR_FAIL_V(NULL);
  1202. }
  1203. }
  1204. Variant::CallError unchecked_error;
  1205. return _create_instance(NULL,0,p_this,p_this->cast_to<Reference>(),unchecked_error);
  1206. }
  1207. bool GDScript::instance_has(const Object *p_this) const {
  1208. return instances.has((Object*)p_this);
  1209. }
  1210. bool GDScript::has_source_code() const {
  1211. return source!="";
  1212. }
  1213. String GDScript::get_source_code() const {
  1214. return source;
  1215. }
  1216. void GDScript::set_source_code(const String& p_code) {
  1217. if (source==p_code)
  1218. return;
  1219. source=p_code;
  1220. #ifdef TOOLS_ENABLED
  1221. source_changed_cache=true;
  1222. //print_line("SC CHANGED "+get_path());
  1223. #endif
  1224. }
  1225. #ifdef TOOLS_ENABLED
  1226. void GDScript::_update_exports_values(Map<StringName,Variant>& values, List<PropertyInfo> &propnames) {
  1227. if (base_cache.is_valid()) {
  1228. base_cache->_update_exports_values(values,propnames);
  1229. }
  1230. for(Map<StringName,Variant>::Element *E=member_default_values_cache.front();E;E=E->next()) {
  1231. values[E->key()]=E->get();
  1232. }
  1233. for (List<PropertyInfo>::Element *E=members_cache.front();E;E=E->next()) {
  1234. propnames.push_back(E->get());
  1235. }
  1236. }
  1237. #endif
  1238. bool GDScript::_update_exports() {
  1239. #ifdef TOOLS_ENABLED
  1240. bool changed=false;
  1241. if (source_changed_cache) {
  1242. //print_line("updating source for "+get_path());
  1243. source_changed_cache=false;
  1244. changed=true;
  1245. String basedir=path;
  1246. if (basedir=="")
  1247. basedir=get_path();
  1248. if (basedir!="")
  1249. basedir=basedir.get_base_dir();
  1250. GDParser parser;
  1251. Error err = parser.parse(source,basedir,true,path);
  1252. if (err==OK) {
  1253. const GDParser::Node* root = parser.get_parse_tree();
  1254. ERR_FAIL_COND_V(root->type!=GDParser::Node::TYPE_CLASS,false);
  1255. const GDParser::ClassNode *c = static_cast<const GDParser::ClassNode*>(root);
  1256. if (base_cache.is_valid()) {
  1257. base_cache->inheriters_cache.erase(get_instance_ID());
  1258. base_cache=Ref<GDScript>();
  1259. }
  1260. if (c->extends_used && String(c->extends_file)!="" && String(c->extends_file) != get_path()) {
  1261. String path = c->extends_file;
  1262. if (path.is_rel_path()) {
  1263. String base = get_path();
  1264. if (base=="" || base.is_rel_path()) {
  1265. ERR_PRINT(("Could not resolve relative path for parent class: "+path).utf8().get_data());
  1266. } else {
  1267. path=base.get_base_dir().plus_file(path);
  1268. }
  1269. }
  1270. if (path!=get_path()) {
  1271. Ref<GDScript> bf = ResourceLoader::load(path);
  1272. if (bf.is_valid()) {
  1273. //print_line("parent is: "+bf->get_path());
  1274. base_cache=bf;
  1275. bf->inheriters_cache.insert(get_instance_ID());
  1276. //bf->_update_exports(p_instances,true,false);
  1277. }
  1278. } else {
  1279. ERR_PRINT(("Path extending itself in "+path).utf8().get_data());
  1280. }
  1281. }
  1282. members_cache.clear();;
  1283. member_default_values_cache.clear();
  1284. for(int i=0;i<c->variables.size();i++) {
  1285. if (c->variables[i]._export.type==Variant::NIL)
  1286. continue;
  1287. members_cache.push_back(c->variables[i]._export);
  1288. //print_line("found "+c->variables[i]._export.name);
  1289. member_default_values_cache[c->variables[i].identifier]=c->variables[i].default_value;
  1290. }
  1291. _signals.clear();
  1292. for(int i=0;i<c->_signals.size();i++) {
  1293. _signals[c->_signals[i].name]=c->_signals[i].arguments;
  1294. }
  1295. }
  1296. } else {
  1297. //print_line("unchaged is "+get_path());
  1298. }
  1299. if (base_cache.is_valid()) {
  1300. if (base_cache->_update_exports()) {
  1301. changed = true;
  1302. }
  1303. }
  1304. if (/*changed &&*/ placeholders.size()) { //hm :(
  1305. //print_line("updating placeholders for "+get_path());
  1306. //update placeholders if any
  1307. Map<StringName,Variant> values;
  1308. List<PropertyInfo> propnames;
  1309. _update_exports_values(values,propnames);
  1310. for (Set<PlaceHolderScriptInstance*>::Element *E=placeholders.front();E;E=E->next()) {
  1311. E->get()->update(propnames,values);
  1312. }
  1313. }
  1314. return changed;
  1315. #endif
  1316. return false;
  1317. }
  1318. void GDScript::update_exports() {
  1319. #ifdef TOOLS_ENABLED
  1320. _update_exports();
  1321. Set<ObjectID> copy=inheriters_cache; //might get modified
  1322. //print_line("update exports for "+get_path()+" ic: "+itos(copy.size()));
  1323. for(Set<ObjectID>::Element *E=copy.front();E;E=E->next()) {
  1324. Object *id=ObjectDB::get_instance(E->get());
  1325. if (!id)
  1326. continue;
  1327. GDScript *s=id->cast_to<GDScript>();
  1328. if (!s)
  1329. continue;
  1330. s->update_exports();
  1331. }
  1332. #endif
  1333. }
  1334. void GDScript::_set_subclass_path(Ref<GDScript>& p_sc,const String& p_path) {
  1335. p_sc->path=p_path;
  1336. for(Map<StringName,Ref<GDScript> >::Element *E=p_sc->subclasses.front();E;E=E->next()) {
  1337. _set_subclass_path(E->get(),p_path);
  1338. }
  1339. }
  1340. Error GDScript::reload() {
  1341. ERR_FAIL_COND_V(instances.size(),ERR_ALREADY_IN_USE);
  1342. String basedir=path;
  1343. if (basedir=="")
  1344. basedir=get_path();
  1345. if (basedir!="")
  1346. basedir=basedir.get_base_dir();
  1347. valid=false;
  1348. GDParser parser;
  1349. Error err = parser.parse(source,basedir,false,path);
  1350. if (err) {
  1351. if (ScriptDebugger::get_singleton()) {
  1352. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(),parser.get_error_line(),"Parser Error: "+parser.get_error());
  1353. }
  1354. _err_print_error("GDScript::reload",path.empty()?"built-in":(const char*)path.utf8().get_data(),parser.get_error_line(),("Parse Error: "+parser.get_error()).utf8().get_data(),ERR_HANDLER_SCRIPT);
  1355. ERR_FAIL_V(ERR_PARSE_ERROR);
  1356. }
  1357. bool can_run = ScriptServer::is_scripting_enabled() || parser.is_tool_script();
  1358. GDCompiler compiler;
  1359. err = compiler.compile(&parser,this);
  1360. if (err) {
  1361. if (can_run) {
  1362. if (ScriptDebugger::get_singleton()) {
  1363. GDScriptLanguage::get_singleton()->debug_break_parse(get_path(),compiler.get_error_line(),"Parser Error: "+compiler.get_error());
  1364. }
  1365. _err_print_error("GDScript::reload",path.empty()?"built-in":(const char*)path.utf8().get_data(),compiler.get_error_line(),("Compile Error: "+compiler.get_error()).utf8().get_data(),ERR_HANDLER_SCRIPT);
  1366. ERR_FAIL_V(ERR_COMPILATION_FAILED);
  1367. } else {
  1368. return err;
  1369. }
  1370. }
  1371. valid=true;
  1372. for(Map<StringName,Ref<GDScript> >::Element *E=subclasses.front();E;E=E->next()) {
  1373. _set_subclass_path(E->get(),path);
  1374. }
  1375. #ifdef TOOLS_ENABLED
  1376. /*for (Set<PlaceHolderScriptInstance*>::Element *E=placeholders.front();E;E=E->next()) {
  1377. _update_placeholder(E->get());
  1378. }*/
  1379. #endif
  1380. return OK;
  1381. }
  1382. String GDScript::get_node_type() const {
  1383. return ""; // ?
  1384. }
  1385. ScriptLanguage *GDScript::get_language() const {
  1386. return GDScriptLanguage::get_singleton();
  1387. }
  1388. Variant GDScript::call(const StringName& p_method,const Variant** p_args,int p_argcount,Variant::CallError &r_error) {
  1389. GDScript *top=this;
  1390. while(top) {
  1391. Map<StringName,GDFunction>::Element *E=top->member_functions.find(p_method);
  1392. if (E) {
  1393. if (!E->get().is_static()) {
  1394. WARN_PRINT(String("Can't call non-static function: '"+String(p_method)+"' in script.").utf8().get_data());
  1395. }
  1396. return E->get().call(NULL,p_args,p_argcount,r_error);
  1397. }
  1398. top=top->_base;
  1399. }
  1400. //none found, regular
  1401. return Script::call(p_method,p_args,p_argcount,r_error);
  1402. }
  1403. bool GDScript::_get(const StringName& p_name,Variant &r_ret) const {
  1404. {
  1405. const GDScript *top=this;
  1406. while(top) {
  1407. {
  1408. const Map<StringName,Variant>::Element *E=top->constants.find(p_name);
  1409. if (E) {
  1410. r_ret= E->get();
  1411. return true;
  1412. }
  1413. }
  1414. {
  1415. const Map<StringName,Ref<GDScript> >::Element *E=subclasses.find(p_name);
  1416. if (E) {
  1417. r_ret=E->get();
  1418. return true;
  1419. }
  1420. }
  1421. top=top->_base;
  1422. }
  1423. if (p_name==GDScriptLanguage::get_singleton()->strings._script_source) {
  1424. r_ret=get_source_code();
  1425. return true;
  1426. }
  1427. }
  1428. return false;
  1429. }
  1430. bool GDScript::_set(const StringName& p_name, const Variant& p_value) {
  1431. if (p_name==GDScriptLanguage::get_singleton()->strings._script_source) {
  1432. set_source_code(p_value);
  1433. reload();
  1434. } else
  1435. return false;
  1436. return true;
  1437. }
  1438. void GDScript::_get_property_list(List<PropertyInfo> *p_properties) const {
  1439. p_properties->push_back( PropertyInfo(Variant::STRING,"script/source",PROPERTY_HINT_NONE,"",PROPERTY_USAGE_NOEDITOR) );
  1440. }
  1441. void GDScript::_bind_methods() {
  1442. ObjectTypeDB::bind_native_method(METHOD_FLAGS_DEFAULT,"new",&GDScript::_new,MethodInfo("new"));
  1443. ObjectTypeDB::bind_method(_MD("get_as_byte_code"),&GDScript::get_as_byte_code);
  1444. }
  1445. Vector<uint8_t> GDScript::get_as_byte_code() const {
  1446. GDTokenizerBuffer tokenizer;
  1447. return tokenizer.parse_code_string(source);
  1448. };
  1449. Error GDScript::load_byte_code(const String& p_path) {
  1450. Vector<uint8_t> bytecode;
  1451. if (p_path.ends_with("gde")) {
  1452. FileAccess *fa = FileAccess::open(p_path,FileAccess::READ);
  1453. ERR_FAIL_COND_V(!fa,ERR_CANT_OPEN);
  1454. FileAccessEncrypted *fae = memnew( FileAccessEncrypted );
  1455. ERR_FAIL_COND_V(!fae,ERR_CANT_OPEN);
  1456. Vector<uint8_t> key;
  1457. key.resize(32);
  1458. for(int i=0;i<key.size();i++) {
  1459. key[i]=script_encryption_key[i];
  1460. }
  1461. Error err = fae->open_and_parse(fa,key,FileAccessEncrypted::MODE_READ);
  1462. ERR_FAIL_COND_V(err,err);
  1463. bytecode.resize(fae->get_len());
  1464. fae->get_buffer(bytecode.ptr(),bytecode.size());
  1465. memdelete(fae);
  1466. } else {
  1467. bytecode = FileAccess::get_file_as_array(p_path);
  1468. }
  1469. ERR_FAIL_COND_V(bytecode.size()==0,ERR_PARSE_ERROR);
  1470. path=p_path;
  1471. String basedir=path;
  1472. if (basedir=="")
  1473. basedir=get_path();
  1474. if (basedir!="")
  1475. basedir=basedir.get_base_dir();
  1476. valid=false;
  1477. GDParser parser;
  1478. Error err = parser.parse_bytecode(bytecode,basedir,get_path());
  1479. if (err) {
  1480. _err_print_error("GDScript::load_byte_code",path.empty()?"built-in":(const char*)path.utf8().get_data(),parser.get_error_line(),("Parse Error: "+parser.get_error()).utf8().get_data(),ERR_HANDLER_SCRIPT);
  1481. ERR_FAIL_V(ERR_PARSE_ERROR);
  1482. }
  1483. GDCompiler compiler;
  1484. err = compiler.compile(&parser,this);
  1485. if (err) {
  1486. _err_print_error("GDScript::load_byte_code",path.empty()?"built-in":(const char*)path.utf8().get_data(),compiler.get_error_line(),("Compile Error: "+compiler.get_error()).utf8().get_data(),ERR_HANDLER_SCRIPT);
  1487. ERR_FAIL_V(ERR_COMPILATION_FAILED);
  1488. }
  1489. valid=true;
  1490. for(Map<StringName,Ref<GDScript> >::Element *E=subclasses.front();E;E=E->next()) {
  1491. _set_subclass_path(E->get(),path);
  1492. }
  1493. return OK;
  1494. }
  1495. Error GDScript::load_source_code(const String& p_path) {
  1496. DVector<uint8_t> sourcef;
  1497. Error err;
  1498. FileAccess *f=FileAccess::open(p_path,FileAccess::READ,&err);
  1499. if (err) {
  1500. ERR_FAIL_COND_V(err,err);
  1501. }
  1502. int len = f->get_len();
  1503. sourcef.resize(len+1);
  1504. DVector<uint8_t>::Write w = sourcef.write();
  1505. int r = f->get_buffer(w.ptr(),len);
  1506. f->close();
  1507. memdelete(f);
  1508. ERR_FAIL_COND_V(r!=len,ERR_CANT_OPEN);
  1509. w[len]=0;
  1510. String s;
  1511. if (s.parse_utf8((const char*)w.ptr())) {
  1512. ERR_EXPLAIN("Script '"+p_path+"' contains invalid unicode (utf-8), so it was not loaded. Please ensure that scripts are saved in valid utf-8 unicode.");
  1513. ERR_FAIL_V(ERR_INVALID_DATA);
  1514. }
  1515. source=s;
  1516. #ifdef TOOLS_ENABLED
  1517. source_changed_cache=true;
  1518. #endif
  1519. //print_line("LSC :"+get_path());
  1520. path=p_path;
  1521. return OK;
  1522. }
  1523. const Map<StringName,GDFunction>& GDScript::debug_get_member_functions() const {
  1524. return member_functions;
  1525. }
  1526. StringName GDScript::debug_get_member_by_index(int p_idx) const {
  1527. for(const Map<StringName,MemberInfo>::Element *E=member_indices.front();E;E=E->next()) {
  1528. if (E->get().index==p_idx)
  1529. return E->key();
  1530. }
  1531. return "<error>";
  1532. }
  1533. Ref<GDScript> GDScript::get_base() const {
  1534. return base;
  1535. }
  1536. bool GDScript::has_script_signal(const StringName& p_signal) const {
  1537. if (_signals.has(p_signal))
  1538. return true;
  1539. if (base.is_valid()) {
  1540. return base->has_script_signal(p_signal);
  1541. }
  1542. #ifdef TOOLS_ENABLED
  1543. else if (base_cache.is_valid()){
  1544. return base_cache->has_script_signal(p_signal);
  1545. }
  1546. #endif
  1547. return false;
  1548. }
  1549. void GDScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  1550. for(const Map<StringName,Vector<StringName> >::Element *E=_signals.front();E;E=E->next()) {
  1551. MethodInfo mi;
  1552. mi.name=E->key();
  1553. for(int i=0;i<E->get().size();i++) {
  1554. PropertyInfo arg;
  1555. arg.name=E->get()[i];
  1556. mi.arguments.push_back(arg);
  1557. }
  1558. r_signals->push_back(mi);
  1559. }
  1560. if (base.is_valid()) {
  1561. base->get_script_signal_list(r_signals);
  1562. }
  1563. #ifdef TOOLS_ENABLED
  1564. else if (base_cache.is_valid()){
  1565. base_cache->get_script_signal_list(r_signals);
  1566. }
  1567. #endif
  1568. }
  1569. GDScript::GDScript() {
  1570. _static_ref=this;
  1571. valid=false;
  1572. subclass_count=0;
  1573. initializer=NULL;
  1574. _base=NULL;
  1575. _owner=NULL;
  1576. tool=false;
  1577. #ifdef TOOLS_ENABLED
  1578. source_changed_cache=false;
  1579. #endif
  1580. }
  1581. //////////////////////////////
  1582. // INSTANCE //
  1583. //////////////////////////////
  1584. bool GDInstance::set(const StringName& p_name, const Variant& p_value) {
  1585. //member
  1586. {
  1587. const Map<StringName,GDScript::MemberInfo>::Element *E = script->member_indices.find(p_name);
  1588. if (E) {
  1589. if (E->get().setter) {
  1590. const Variant *val=&p_value;
  1591. Variant::CallError err;
  1592. call(E->get().setter,&val,1,err);
  1593. if (err.error==Variant::CallError::CALL_OK) {
  1594. return true; //function exists, call was successful
  1595. }
  1596. }
  1597. else
  1598. members[E->get().index] = p_value;
  1599. return true;
  1600. }
  1601. }
  1602. GDScript *sptr=script.ptr();
  1603. while(sptr) {
  1604. Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._set);
  1605. if (E) {
  1606. Variant name=p_name;
  1607. const Variant *args[2]={&name,&p_value};
  1608. Variant::CallError err;
  1609. Variant ret = E->get().call(this,(const Variant**)args,2,err);
  1610. if (err.error==Variant::CallError::CALL_OK && ret.get_type()==Variant::BOOL && ret.operator bool())
  1611. return true;
  1612. }
  1613. sptr = sptr->_base;
  1614. }
  1615. return false;
  1616. }
  1617. bool GDInstance::get(const StringName& p_name, Variant &r_ret) const {
  1618. const GDScript *sptr=script.ptr();
  1619. while(sptr) {
  1620. {
  1621. const Map<StringName,GDScript::MemberInfo>::Element *E = script->member_indices.find(p_name);
  1622. if (E) {
  1623. if (E->get().getter) {
  1624. Variant::CallError err;
  1625. r_ret=const_cast<GDInstance*>(this)->call(E->get().getter,NULL,0,err);
  1626. if (err.error==Variant::CallError::CALL_OK) {
  1627. return true;
  1628. }
  1629. }
  1630. r_ret=members[E->get().index];
  1631. return true; //index found
  1632. }
  1633. }
  1634. {
  1635. const Map<StringName,Variant>::Element *E = script->constants.find(p_name);
  1636. if (E) {
  1637. r_ret=E->get();
  1638. return true; //index found
  1639. }
  1640. }
  1641. {
  1642. const Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get);
  1643. if (E) {
  1644. Variant name=p_name;
  1645. const Variant *args[1]={&name};
  1646. Variant::CallError err;
  1647. Variant ret = const_cast<GDFunction*>(&E->get())->call(const_cast<GDInstance*>(this),(const Variant**)args,1,err);
  1648. if (err.error==Variant::CallError::CALL_OK && ret.get_type()!=Variant::NIL) {
  1649. r_ret=ret;
  1650. return true;
  1651. }
  1652. }
  1653. }
  1654. sptr = sptr->_base;
  1655. }
  1656. return false;
  1657. }
  1658. Variant::Type GDInstance::get_property_type(const StringName& p_name,bool *r_is_valid) const {
  1659. const GDScript *sptr=script.ptr();
  1660. while(sptr) {
  1661. if (sptr->member_info.has(p_name)) {
  1662. if (r_is_valid)
  1663. *r_is_valid=true;
  1664. return sptr->member_info[p_name].type;
  1665. }
  1666. sptr = sptr->_base;
  1667. }
  1668. if (r_is_valid)
  1669. *r_is_valid=false;
  1670. return Variant::NIL;
  1671. }
  1672. void GDInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  1673. // exported members, not doen yet!
  1674. const GDScript *sptr=script.ptr();
  1675. List<PropertyInfo> props;
  1676. while(sptr) {
  1677. const Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get_property_list);
  1678. if (E) {
  1679. Variant::CallError err;
  1680. Variant ret = const_cast<GDFunction*>(&E->get())->call(const_cast<GDInstance*>(this),NULL,0,err);
  1681. if (err.error==Variant::CallError::CALL_OK) {
  1682. if (ret.get_type()!=Variant::ARRAY) {
  1683. ERR_EXPLAIN("Wrong type for _get_property list, must be an array of dictionaries.");
  1684. ERR_FAIL();
  1685. }
  1686. Array arr = ret;
  1687. for(int i=0;i<arr.size();i++) {
  1688. Dictionary d = arr[i];
  1689. ERR_CONTINUE(!d.has("name"));
  1690. ERR_CONTINUE(!d.has("type"));
  1691. PropertyInfo pinfo;
  1692. pinfo.type = Variant::Type( d["type"].operator int());
  1693. ERR_CONTINUE(pinfo.type<0 || pinfo.type>=Variant::VARIANT_MAX );
  1694. pinfo.name = d["name"];
  1695. ERR_CONTINUE(pinfo.name=="");
  1696. if (d.has("hint"))
  1697. pinfo.hint=PropertyHint(d["hint"].operator int());
  1698. if (d.has("hint_string"))
  1699. pinfo.hint_string=d["hint_string"];
  1700. if (d.has("usage"))
  1701. pinfo.usage=d["usage"];
  1702. props.push_back(pinfo);
  1703. }
  1704. }
  1705. }
  1706. //instance a fake script for editing the values
  1707. Vector<_GDScriptMemberSort> msort;
  1708. for(Map<StringName,PropertyInfo>::Element *E=sptr->member_info.front();E;E=E->next()) {
  1709. _GDScriptMemberSort ms;
  1710. ERR_CONTINUE(!sptr->member_indices.has(E->key()));
  1711. ms.index=sptr->member_indices[E->key()].index;
  1712. ms.name=E->key();
  1713. msort.push_back(ms);
  1714. }
  1715. msort.sort();
  1716. msort.invert();
  1717. for(int i=0;i<msort.size();i++) {
  1718. props.push_front(sptr->member_info[msort[i].name]);
  1719. }
  1720. #if 0
  1721. if (sptr->member_functions.has("_get_property_list")) {
  1722. Variant::CallError err;
  1723. GDFunction *f = const_cast<GDFunction*>(&sptr->member_functions["_get_property_list"]);
  1724. Variant plv = f->call(const_cast<GDInstance*>(this),NULL,0,err);
  1725. if (plv.get_type()!=Variant::ARRAY) {
  1726. ERR_PRINT("_get_property_list: expected array returned");
  1727. } else {
  1728. Array pl=plv;
  1729. for(int i=0;i<pl.size();i++) {
  1730. Dictionary p = pl[i];
  1731. PropertyInfo pinfo;
  1732. if (!p.has("name")) {
  1733. ERR_PRINT("_get_property_list: expected 'name' key of type string.")
  1734. continue;
  1735. }
  1736. if (!p.has("type")) {
  1737. ERR_PRINT("_get_property_list: expected 'type' key of type integer.")
  1738. continue;
  1739. }
  1740. pinfo.name=p["name"];
  1741. pinfo.type=Variant::Type(int(p["type"]));
  1742. if (p.has("hint"))
  1743. pinfo.hint=PropertyHint(int(p["hint"]));
  1744. if (p.has("hint_string"))
  1745. pinfo.hint_string=p["hint_string"];
  1746. if (p.has("usage"))
  1747. pinfo.usage=p["usage"];
  1748. props.push_back(pinfo);
  1749. }
  1750. }
  1751. }
  1752. #endif
  1753. sptr = sptr->_base;
  1754. }
  1755. //props.invert();
  1756. for (List<PropertyInfo>::Element *E=props.front();E;E=E->next()) {
  1757. p_properties->push_back(E->get());
  1758. }
  1759. }
  1760. void GDInstance::get_method_list(List<MethodInfo> *p_list) const {
  1761. const GDScript *sptr=script.ptr();
  1762. while(sptr) {
  1763. for (Map<StringName,GDFunction>::Element *E = sptr->member_functions.front();E;E=E->next()) {
  1764. MethodInfo mi;
  1765. mi.name=E->key();
  1766. mi.flags|=METHOD_FLAG_FROM_SCRIPT;
  1767. for(int i=0;i<E->get().get_argument_count();i++)
  1768. mi.arguments.push_back(PropertyInfo(Variant::NIL,"arg"+itos(i)));
  1769. p_list->push_back(mi);
  1770. }
  1771. sptr = sptr->_base;
  1772. }
  1773. }
  1774. bool GDInstance::has_method(const StringName& p_method) const {
  1775. const GDScript *sptr=script.ptr();
  1776. while(sptr) {
  1777. const Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(p_method);
  1778. if (E)
  1779. return true;
  1780. sptr = sptr->_base;
  1781. }
  1782. return false;
  1783. }
  1784. Variant GDInstance::call(const StringName& p_method,const Variant** p_args,int p_argcount,Variant::CallError &r_error) {
  1785. //printf("calling %ls:%i method %ls\n", script->get_path().c_str(), -1, String(p_method).c_str());
  1786. GDScript *sptr=script.ptr();
  1787. while(sptr) {
  1788. Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(p_method);
  1789. if (E) {
  1790. return E->get().call(this,p_args,p_argcount,r_error);
  1791. }
  1792. sptr = sptr->_base;
  1793. }
  1794. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1795. return Variant();
  1796. }
  1797. void GDInstance::call_multilevel(const StringName& p_method,const Variant** p_args,int p_argcount) {
  1798. GDScript *sptr=script.ptr();
  1799. Variant::CallError ce;
  1800. while(sptr) {
  1801. Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(p_method);
  1802. if (E) {
  1803. E->get().call(this,p_args,p_argcount,ce);
  1804. }
  1805. sptr = sptr->_base;
  1806. }
  1807. }
  1808. void GDInstance::_ml_call_reversed(GDScript *sptr,const StringName& p_method,const Variant** p_args,int p_argcount) {
  1809. if (sptr->_base)
  1810. _ml_call_reversed(sptr->_base,p_method,p_args,p_argcount);
  1811. Variant::CallError ce;
  1812. Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(p_method);
  1813. if (E) {
  1814. E->get().call(this,p_args,p_argcount,ce);
  1815. }
  1816. }
  1817. void GDInstance::call_multilevel_reversed(const StringName& p_method,const Variant** p_args,int p_argcount) {
  1818. if (script.ptr()) {
  1819. _ml_call_reversed(script.ptr(),p_method,p_args,p_argcount);
  1820. }
  1821. }
  1822. void GDInstance::notification(int p_notification) {
  1823. //notification is not virutal, it gets called at ALL levels just like in C.
  1824. Variant value=p_notification;
  1825. const Variant *args[1]={&value };
  1826. GDScript *sptr=script.ptr();
  1827. while(sptr) {
  1828. Map<StringName,GDFunction>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._notification);
  1829. if (E) {
  1830. Variant::CallError err;
  1831. E->get().call(this,args,1,err);
  1832. if (err.error!=Variant::CallError::CALL_OK) {
  1833. //print error about notification call
  1834. }
  1835. }
  1836. sptr = sptr->_base;
  1837. }
  1838. }
  1839. Ref<Script> GDInstance::get_script() const {
  1840. return script;
  1841. }
  1842. ScriptLanguage *GDInstance::get_language() {
  1843. return GDScriptLanguage::get_singleton();
  1844. }
  1845. GDInstance::GDInstance() {
  1846. owner=NULL;
  1847. base_ref=false;
  1848. }
  1849. GDInstance::~GDInstance() {
  1850. if (script.is_valid() && owner) {
  1851. script->instances.erase(owner);
  1852. }
  1853. }
  1854. /************* SCRIPT LANGUAGE **************/
  1855. /************* SCRIPT LANGUAGE **************/
  1856. /************* SCRIPT LANGUAGE **************/
  1857. /************* SCRIPT LANGUAGE **************/
  1858. /************* SCRIPT LANGUAGE **************/
  1859. GDScriptLanguage *GDScriptLanguage::singleton=NULL;
  1860. String GDScriptLanguage::get_name() const {
  1861. return "GDScript";
  1862. }
  1863. /* LANGUAGE FUNCTIONS */
  1864. void GDScriptLanguage::_add_global(const StringName& p_name,const Variant& p_value) {
  1865. if (globals.has(p_name)) {
  1866. //overwrite existing
  1867. global_array[globals[p_name]]=p_value;
  1868. return;
  1869. }
  1870. globals[p_name]=global_array.size();
  1871. global_array.push_back(p_value);
  1872. _global_array=global_array.ptr();
  1873. }
  1874. void GDScriptLanguage::add_global_constant(const StringName& p_variable,const Variant& p_value) {
  1875. _add_global(p_variable,p_value);
  1876. }
  1877. void GDScriptLanguage::init() {
  1878. //populate global constants
  1879. int gcc=GlobalConstants::get_global_constant_count();
  1880. for(int i=0;i<gcc;i++) {
  1881. _add_global(StaticCString::create(GlobalConstants::get_global_constant_name(i)),GlobalConstants::get_global_constant_value(i));
  1882. }
  1883. _add_global(StaticCString::create("PI"),Math_PI);
  1884. //populate native classes
  1885. List<StringName> class_list;
  1886. ObjectTypeDB::get_type_list(&class_list);
  1887. for(List<StringName>::Element *E=class_list.front();E;E=E->next()) {
  1888. StringName n = E->get();
  1889. String s = String(n);
  1890. if (s.begins_with("_"))
  1891. n=s.substr(1,s.length());
  1892. if (globals.has(n))
  1893. continue;
  1894. Ref<GDNativeClass> nc = memnew( GDNativeClass(E->get()) );
  1895. _add_global(n,nc);
  1896. }
  1897. //populate singletons
  1898. List<Globals::Singleton> singletons;
  1899. Globals::get_singleton()->get_singletons(&singletons);
  1900. for(List<Globals::Singleton>::Element *E=singletons.front();E;E=E->next()) {
  1901. _add_global(E->get().name,E->get().ptr);
  1902. }
  1903. }
  1904. String GDScriptLanguage::get_type() const {
  1905. return "GDScript";
  1906. }
  1907. String GDScriptLanguage::get_extension() const {
  1908. return "gd";
  1909. }
  1910. Error GDScriptLanguage::execute_file(const String& p_path) {
  1911. // ??
  1912. return OK;
  1913. }
  1914. void GDScriptLanguage::finish() {
  1915. }
  1916. void GDScriptLanguage::frame() {
  1917. // print_line("calls: "+itos(calls));
  1918. calls=0;
  1919. }
  1920. /* EDITOR FUNCTIONS */
  1921. void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
  1922. static const char *_reserved_words[]={
  1923. // operators
  1924. "and",
  1925. "in",
  1926. "not",
  1927. "or",
  1928. // types and values
  1929. "false",
  1930. "float",
  1931. "int",
  1932. "null",
  1933. "PI",
  1934. "self",
  1935. "true",
  1936. // functions
  1937. "assert",
  1938. "breakpoint",
  1939. "class",
  1940. "extends",
  1941. "func",
  1942. "preload",
  1943. "setget",
  1944. "signal",
  1945. "tool",
  1946. "yield",
  1947. // var
  1948. "const",
  1949. "enum",
  1950. "export",
  1951. "onready",
  1952. "static",
  1953. "var",
  1954. // control flow
  1955. "break",
  1956. "continue",
  1957. "if",
  1958. "elif",
  1959. "else",
  1960. "for",
  1961. "pass",
  1962. "return",
  1963. "while",
  1964. 0};
  1965. const char **w=_reserved_words;
  1966. while (*w) {
  1967. p_words->push_back(*w);
  1968. w++;
  1969. }
  1970. for(int i=0;i<GDFunctions::FUNC_MAX;i++) {
  1971. p_words->push_back(GDFunctions::get_func_name(GDFunctions::Function(i)));
  1972. }
  1973. }
  1974. GDScriptLanguage::GDScriptLanguage() {
  1975. calls=0;
  1976. ERR_FAIL_COND(singleton);
  1977. singleton=this;
  1978. strings._init = StaticCString::create("_init");
  1979. strings._notification = StaticCString::create("_notification");
  1980. strings._set= StaticCString::create("_set");
  1981. strings._get= StaticCString::create("_get");
  1982. strings._get_property_list= StaticCString::create("_get_property_list");
  1983. strings._script_source=StaticCString::create("script/source");
  1984. _debug_parse_err_line=-1;
  1985. _debug_parse_err_file="";
  1986. _debug_call_stack_pos=0;
  1987. int dmcs=GLOBAL_DEF("debug/script_max_call_stack",1024);
  1988. if (ScriptDebugger::get_singleton()) {
  1989. //debugging enabled!
  1990. _debug_max_call_stack = dmcs;
  1991. if (_debug_max_call_stack<1024)
  1992. _debug_max_call_stack=1024;
  1993. _call_stack = memnew_arr( CallLevel, _debug_max_call_stack+1 );
  1994. } else {
  1995. _debug_max_call_stack=0;
  1996. _call_stack=NULL;
  1997. }
  1998. }
  1999. GDScriptLanguage::~GDScriptLanguage() {
  2000. if (_call_stack) {
  2001. memdelete_arr(_call_stack);
  2002. }
  2003. singleton=NULL;
  2004. }
  2005. /*************** RESOURCE ***************/
  2006. RES ResourceFormatLoaderGDScript::load(const String &p_path, const String& p_original_path, Error *r_error) {
  2007. if (r_error)
  2008. *r_error=ERR_FILE_CANT_OPEN;
  2009. GDScript *script = memnew( GDScript );
  2010. Ref<GDScript> scriptres(script);
  2011. if (p_path.ends_with(".gde") || p_path.ends_with(".gdc")) {
  2012. script->set_script_path(p_original_path); // script needs this.
  2013. script->set_path(p_original_path);
  2014. Error err = script->load_byte_code(p_path);
  2015. if (err!=OK) {
  2016. ERR_FAIL_COND_V(err!=OK, RES());
  2017. }
  2018. } else {
  2019. Error err = script->load_source_code(p_path);
  2020. if (err!=OK) {
  2021. ERR_FAIL_COND_V(err!=OK, RES());
  2022. }
  2023. script->set_script_path(p_original_path); // script needs this.
  2024. script->set_path(p_original_path);
  2025. //script->set_name(p_path.get_file());
  2026. script->reload();
  2027. }
  2028. if (r_error)
  2029. *r_error=OK;
  2030. return scriptres;
  2031. }
  2032. void ResourceFormatLoaderGDScript::get_recognized_extensions(List<String> *p_extensions) const {
  2033. p_extensions->push_back("gd");
  2034. p_extensions->push_back("gdc");
  2035. p_extensions->push_back("gde");
  2036. }
  2037. bool ResourceFormatLoaderGDScript::handles_type(const String& p_type) const {
  2038. return (p_type=="Script" || p_type=="GDScript");
  2039. }
  2040. String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) const {
  2041. String el = p_path.extension().to_lower();
  2042. if (el=="gd" || el=="gdc" || el=="gde")
  2043. return "GDScript";
  2044. return "";
  2045. }
  2046. Error ResourceFormatSaverGDScript::save(const String &p_path,const RES& p_resource,uint32_t p_flags) {
  2047. Ref<GDScript> sqscr = p_resource;
  2048. ERR_FAIL_COND_V(sqscr.is_null(),ERR_INVALID_PARAMETER);
  2049. String source = sqscr->get_source_code();
  2050. Error err;
  2051. FileAccess *file = FileAccess::open(p_path,FileAccess::WRITE,&err);
  2052. if (err) {
  2053. ERR_FAIL_COND_V(err,err);
  2054. }
  2055. file->store_string(source);
  2056. if (file->get_error()!=OK && file->get_error()!=ERR_FILE_EOF) {
  2057. memdelete(file);
  2058. return ERR_CANT_CREATE;
  2059. }
  2060. file->close();
  2061. memdelete(file);
  2062. return OK;
  2063. }
  2064. void ResourceFormatSaverGDScript::get_recognized_extensions(const RES& p_resource,List<String> *p_extensions) const {
  2065. if (p_resource->cast_to<GDScript>()) {
  2066. p_extensions->push_back("gd");
  2067. }
  2068. }
  2069. bool ResourceFormatSaverGDScript::recognize(const RES& p_resource) const {
  2070. return p_resource->cast_to<GDScript>()!=NULL;
  2071. }