visual_script.cpp 69 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567
  1. #include "visual_script.h"
  2. #include "visual_script_nodes.h"
  3. #include "globals.h"
  4. #define SCRIPT_VARIABLES_PREFIX "script_variables/"
  5. //used by editor, this is not really saved
  6. void VisualScriptNode::set_breakpoint(bool p_breakpoint) {
  7. breakpoint=p_breakpoint;
  8. }
  9. bool VisualScriptNode::is_breakpoint() const {
  10. return breakpoint;
  11. }
  12. void VisualScriptNode::_notification(int p_what) {
  13. if (p_what==NOTIFICATION_POSTINITIALIZE) {
  14. int dvc = get_input_value_port_count();
  15. for(int i=0;i<dvc;i++) {
  16. Variant::Type expected = get_input_value_port_info(i).type;
  17. Variant::CallError ce;
  18. default_input_values.push_back(Variant::construct(expected,NULL,0,ce,false));
  19. }
  20. }
  21. }
  22. void VisualScriptNode::ports_changed_notify(){
  23. default_input_values.resize( MAX(default_input_values.size(),get_input_value_port_count()) ); //let it grow as big as possible, we don't want to lose values on resize
  24. emit_signal("ports_changed");
  25. }
  26. void VisualScriptNode::set_default_input_value(int p_port,const Variant& p_value) {
  27. ERR_FAIL_INDEX(p_port,default_input_values.size());
  28. default_input_values[p_port]=p_value;
  29. }
  30. Variant VisualScriptNode::get_default_input_value(int p_port) const {
  31. ERR_FAIL_INDEX_V(p_port,default_input_values.size(),Variant());
  32. return default_input_values[p_port];
  33. }
  34. void VisualScriptNode::_set_default_input_values(Array p_values) {
  35. default_input_values=p_values;
  36. }
  37. Array VisualScriptNode::_get_default_input_values() const {
  38. //validate on save, since on load there is little info about this
  39. Array saved_values;
  40. //actually validate on save
  41. for(int i=0;i<get_input_value_port_count();i++) {
  42. Variant::Type expected = get_input_value_port_info(i).type;
  43. if (i>=default_input_values.size()) {
  44. Variant::CallError ce;
  45. saved_values.push_back(Variant::construct(expected,NULL,0,ce,false));
  46. } else {
  47. if (expected==Variant::NIL || expected==default_input_values[i].get_type()) {
  48. saved_values.push_back(default_input_values[i]);
  49. } else {
  50. //not the same, reconvert
  51. Variant::CallError ce;
  52. Variant existing = default_input_values[i];
  53. const Variant *existingp=&existing;
  54. saved_values.push_back( Variant::construct(expected,&existingp,1,ce,false) );
  55. }
  56. }
  57. }
  58. return saved_values;
  59. }
  60. void VisualScriptNode::_bind_methods() {
  61. ObjectTypeDB::bind_method(_MD("get_visual_script:VisualScript"),&VisualScriptNode::get_visual_script);
  62. ObjectTypeDB::bind_method(_MD("set_default_input_value","port_idx","value:Variant"),&VisualScriptNode::set_default_input_value);
  63. ObjectTypeDB::bind_method(_MD("get_default_input_value:Variant","port_idx"),&VisualScriptNode::get_default_input_value);
  64. ObjectTypeDB::bind_method(_MD("_set_default_input_values","values"),&VisualScriptNode::_set_default_input_values);
  65. ObjectTypeDB::bind_method(_MD("_get_default_input_values"),&VisualScriptNode::_get_default_input_values);
  66. ADD_PROPERTY(PropertyInfo(Variant::ARRAY,"_default_input_values",PROPERTY_HINT_NONE,"",PROPERTY_USAGE_NOEDITOR),_SCS("_set_default_input_values"),_SCS("_get_default_input_values"));
  67. ADD_SIGNAL(MethodInfo("ports_changed"));
  68. }
  69. Ref<VisualScript> VisualScriptNode::get_visual_script() const {
  70. if (scripts_used.size())
  71. return Ref<VisualScript>(scripts_used.front()->get());
  72. return Ref<VisualScript>();
  73. }
  74. VisualScriptNode::VisualScriptNode() {
  75. breakpoint=false;
  76. }
  77. ////////////////
  78. /////////////////////
  79. VisualScriptNodeInstance::VisualScriptNodeInstance() {
  80. sequence_outputs=NULL;
  81. input_ports=NULL;
  82. }
  83. VisualScriptNodeInstance::~VisualScriptNodeInstance() {
  84. if (sequence_outputs) {
  85. memdelete(sequence_outputs);
  86. }
  87. if (input_ports) {
  88. memdelete(input_ports);
  89. }
  90. if (output_ports) {
  91. memdelete(output_ports);
  92. }
  93. }
  94. void VisualScript::add_function(const StringName& p_name) {
  95. ERR_FAIL_COND( instances.size() );
  96. ERR_FAIL_COND(!String(p_name).is_valid_identifier());
  97. ERR_FAIL_COND(functions.has(p_name));
  98. functions[p_name]=Function();
  99. functions[p_name].scroll=Vector2(-50,-100);
  100. }
  101. bool VisualScript::has_function(const StringName& p_name) const {
  102. return functions.has(p_name);
  103. }
  104. void VisualScript::remove_function(const StringName& p_name) {
  105. ERR_FAIL_COND( instances.size() );
  106. ERR_FAIL_COND(!functions.has(p_name));
  107. for (Map<int,Function::NodeData>::Element *E=functions[p_name].nodes.front();E;E=E->next()) {
  108. E->get().node->disconnect("ports_changed",this,"_node_ports_changed");
  109. E->get().node->scripts_used.erase(this);
  110. }
  111. functions.erase(p_name);
  112. }
  113. void VisualScript::rename_function(const StringName& p_name,const StringName& p_new_name) {
  114. ERR_FAIL_COND( instances.size() );
  115. ERR_FAIL_COND(!functions.has(p_name));
  116. if (p_new_name==p_name)
  117. return;
  118. ERR_FAIL_COND(!String(p_new_name).is_valid_identifier());
  119. ERR_FAIL_COND(functions.has(p_new_name));
  120. ERR_FAIL_COND(variables.has(p_new_name));
  121. ERR_FAIL_COND(custom_signals.has(p_new_name));
  122. functions[p_new_name]=functions[p_name];
  123. functions.erase(p_name);
  124. }
  125. void VisualScript::set_function_scroll(const StringName& p_name, const Vector2& p_scroll) {
  126. ERR_FAIL_COND(!functions.has(p_name));
  127. functions[p_name].scroll=p_scroll;
  128. }
  129. Vector2 VisualScript::get_function_scroll(const StringName& p_name) const {
  130. ERR_FAIL_COND_V(!functions.has(p_name),Vector2());
  131. return functions[p_name].scroll;
  132. }
  133. void VisualScript::get_function_list(List<StringName> *r_functions) const {
  134. for (const Map<StringName,Function>::Element *E=functions.front();E;E=E->next()) {
  135. r_functions->push_back(E->key());
  136. }
  137. r_functions->sort_custom<StringName::AlphCompare>();
  138. }
  139. int VisualScript::get_function_node_id(const StringName& p_name) const {
  140. ERR_FAIL_COND_V(!functions.has(p_name),-1);
  141. return functions[p_name].function_id;
  142. }
  143. void VisualScript::_node_ports_changed(int p_id) {
  144. StringName function;
  145. for (Map<StringName,Function>::Element *E=functions.front();E;E=E->next()) {
  146. if (E->get().nodes.has(p_id)) {
  147. function=E->key();
  148. break;
  149. }
  150. }
  151. ERR_FAIL_COND(function==StringName());
  152. Function &func = functions[function];
  153. Ref<VisualScriptNode> vsn = func.nodes[p_id].node;
  154. //must revalidate all the functions
  155. {
  156. List<SequenceConnection> to_remove;
  157. for (Set<SequenceConnection>::Element *E=func.sequence_connections.front();E;E=E->next()) {
  158. if (E->get().from_node==p_id && E->get().from_output>=vsn->get_output_sequence_port_count()) {
  159. to_remove.push_back(E->get());
  160. }
  161. if (E->get().to_node==p_id && !vsn->has_input_sequence_port()) {
  162. to_remove.push_back(E->get());
  163. }
  164. }
  165. while(to_remove.size()) {
  166. func.sequence_connections.erase(to_remove.front()->get());
  167. to_remove.pop_front();
  168. }
  169. }
  170. {
  171. List<DataConnection> to_remove;
  172. for (Set<DataConnection>::Element *E=func.data_connections.front();E;E=E->next()) {
  173. if (E->get().from_node==p_id && E->get().from_port>=vsn->get_output_value_port_count()) {
  174. to_remove.push_back(E->get());
  175. }
  176. if (E->get().to_node==p_id && E->get().to_port>=vsn->get_input_value_port_count()) {
  177. to_remove.push_back(E->get());
  178. }
  179. }
  180. while(to_remove.size()) {
  181. func.data_connections.erase(to_remove.front()->get());
  182. to_remove.pop_front();
  183. }
  184. }
  185. set_edited(true); //something changed, let's set as edited
  186. emit_signal("node_ports_changed",function,p_id);
  187. }
  188. void VisualScript::add_node(const StringName& p_func,int p_id, const Ref<VisualScriptNode>& p_node, const Point2 &p_pos) {
  189. ERR_FAIL_COND( instances.size() );
  190. ERR_FAIL_COND(!functions.has(p_func));
  191. for (Map<StringName,Function>::Element *E=functions.front();E;E=E->next()) {
  192. ERR_FAIL_COND(E->get().nodes.has(p_id)); //id can exist only one in script, even for different functions
  193. }
  194. Function &func = functions[p_func];
  195. if (p_node->cast_to<VisualScriptFunction>()) {
  196. //the function indeed
  197. ERR_EXPLAIN("A function node already has been set here.");
  198. ERR_FAIL_COND(func.function_id>=0);
  199. func.function_id=p_id;
  200. }
  201. Function::NodeData nd;
  202. nd.node=p_node;
  203. nd.pos=p_pos;
  204. Ref<VisualScriptNode> vsn = p_node;
  205. vsn->connect("ports_changed",this,"_node_ports_changed",varray(p_id));
  206. vsn->scripts_used.insert(this);
  207. func.nodes[p_id]=nd;
  208. }
  209. void VisualScript::remove_node(const StringName& p_func,int p_id){
  210. ERR_FAIL_COND( instances.size() );
  211. ERR_FAIL_COND(!functions.has(p_func));
  212. Function &func = functions[p_func];
  213. ERR_FAIL_COND(!func.nodes.has(p_id));
  214. {
  215. List<SequenceConnection> to_remove;
  216. for (Set<SequenceConnection>::Element *E=func.sequence_connections.front();E;E=E->next()) {
  217. if (E->get().from_node==p_id || E->get().to_node==p_id) {
  218. to_remove.push_back(E->get());
  219. }
  220. }
  221. while(to_remove.size()) {
  222. func.sequence_connections.erase(to_remove.front()->get());
  223. to_remove.pop_front();
  224. }
  225. }
  226. {
  227. List<DataConnection> to_remove;
  228. for (Set<DataConnection>::Element *E=func.data_connections.front();E;E=E->next()) {
  229. if (E->get().from_node==p_id || E->get().to_node==p_id) {
  230. to_remove.push_back(E->get());
  231. }
  232. }
  233. while(to_remove.size()) {
  234. func.data_connections.erase(to_remove.front()->get());
  235. to_remove.pop_front();
  236. }
  237. }
  238. if (func.nodes[p_id].node->cast_to<VisualScriptFunction>()) {
  239. func.function_id=-1; //revert to invalid
  240. }
  241. func.nodes[p_id].node->disconnect("ports_changed",this,"_node_ports_changed");
  242. func.nodes[p_id].node->scripts_used.erase(this);
  243. func.nodes.erase(p_id);
  244. }
  245. bool VisualScript::has_node(const StringName& p_func,int p_id) const {
  246. ERR_FAIL_COND_V(!functions.has(p_func),false);
  247. const Function &func = functions[p_func];
  248. return func.nodes.has(p_id);
  249. }
  250. Ref<VisualScriptNode> VisualScript::get_node(const StringName& p_func,int p_id) const{
  251. ERR_FAIL_COND_V(!functions.has(p_func),Ref<VisualScriptNode>());
  252. const Function &func = functions[p_func];
  253. ERR_FAIL_COND_V(!func.nodes.has(p_id),Ref<VisualScriptNode>());
  254. return func.nodes[p_id].node;
  255. }
  256. void VisualScript::set_node_pos(const StringName& p_func,int p_id,const Point2& p_pos) {
  257. ERR_FAIL_COND( instances.size() );
  258. ERR_FAIL_COND(!functions.has(p_func));
  259. Function &func = functions[p_func];
  260. ERR_FAIL_COND(!func.nodes.has(p_id));
  261. func.nodes[p_id].pos=p_pos;
  262. }
  263. Point2 VisualScript::get_node_pos(const StringName& p_func,int p_id) const{
  264. ERR_FAIL_COND_V(!functions.has(p_func),Point2());
  265. const Function &func = functions[p_func];
  266. ERR_FAIL_COND_V(!func.nodes.has(p_id),Point2());
  267. return func.nodes[p_id].pos;
  268. }
  269. void VisualScript::get_node_list(const StringName& p_func,List<int> *r_nodes) const{
  270. ERR_FAIL_COND(!functions.has(p_func));
  271. const Function &func = functions[p_func];
  272. for (const Map<int,Function::NodeData>::Element *E=func.nodes.front();E;E=E->next()) {
  273. r_nodes->push_back(E->key());
  274. }
  275. }
  276. void VisualScript::sequence_connect(const StringName& p_func,int p_from_node,int p_from_output,int p_to_node){
  277. ERR_FAIL_COND( instances.size() );
  278. ERR_FAIL_COND(!functions.has(p_func));
  279. Function &func = functions[p_func];
  280. SequenceConnection sc;
  281. sc.from_node=p_from_node;
  282. sc.from_output=p_from_output;
  283. sc.to_node=p_to_node;
  284. ERR_FAIL_COND(func.sequence_connections.has(sc));
  285. func.sequence_connections.insert(sc);
  286. }
  287. void VisualScript::sequence_disconnect(const StringName& p_func,int p_from_node,int p_from_output,int p_to_node){
  288. ERR_FAIL_COND(!functions.has(p_func));
  289. Function &func = functions[p_func];
  290. SequenceConnection sc;
  291. sc.from_node=p_from_node;
  292. sc.from_output=p_from_output;
  293. sc.to_node=p_to_node;
  294. ERR_FAIL_COND(!func.sequence_connections.has(sc));
  295. func.sequence_connections.erase(sc);
  296. }
  297. bool VisualScript::has_sequence_connection(const StringName& p_func,int p_from_node,int p_from_output,int p_to_node) const{
  298. ERR_FAIL_COND_V(!functions.has(p_func),false);
  299. const Function &func = functions[p_func];
  300. SequenceConnection sc;
  301. sc.from_node=p_from_node;
  302. sc.from_output=p_from_output;
  303. sc.to_node=p_to_node;
  304. return func.sequence_connections.has(sc);
  305. }
  306. void VisualScript::get_sequence_connection_list(const StringName& p_func,List<SequenceConnection> *r_connection) const {
  307. ERR_FAIL_COND(!functions.has(p_func));
  308. const Function &func = functions[p_func];
  309. for (const Set<SequenceConnection>::Element *E=func.sequence_connections.front();E;E=E->next()) {
  310. r_connection->push_back(E->get());
  311. }
  312. }
  313. void VisualScript::data_connect(const StringName& p_func,int p_from_node,int p_from_port,int p_to_node,int p_to_port) {
  314. ERR_FAIL_COND( instances.size() );
  315. ERR_FAIL_COND(!functions.has(p_func));
  316. Function &func = functions[p_func];
  317. DataConnection dc;
  318. dc.from_node=p_from_node;
  319. dc.from_port=p_from_port;
  320. dc.to_node=p_to_node;
  321. dc.to_port=p_to_port;
  322. ERR_FAIL_COND( func.data_connections.has(dc));
  323. func.data_connections.insert(dc);
  324. }
  325. void VisualScript::data_disconnect(const StringName& p_func,int p_from_node,int p_from_port,int p_to_node,int p_to_port) {
  326. ERR_FAIL_COND(!functions.has(p_func));
  327. Function &func = functions[p_func];
  328. DataConnection dc;
  329. dc.from_node=p_from_node;
  330. dc.from_port=p_from_port;
  331. dc.to_node=p_to_node;
  332. dc.to_port=p_to_port;
  333. ERR_FAIL_COND( !func.data_connections.has(dc));
  334. func.data_connections.erase(dc);
  335. }
  336. bool VisualScript::has_data_connection(const StringName& p_func,int p_from_node,int p_from_port,int p_to_node,int p_to_port) const {
  337. ERR_FAIL_COND_V(!functions.has(p_func),false);
  338. const Function &func = functions[p_func];
  339. DataConnection dc;
  340. dc.from_node=p_from_node;
  341. dc.from_port=p_from_port;
  342. dc.to_node=p_to_node;
  343. dc.to_port=p_to_port;
  344. return func.data_connections.has(dc);
  345. }
  346. bool VisualScript::is_input_value_port_connected(const StringName& p_func,int p_node,int p_port) const {
  347. ERR_FAIL_COND_V(!functions.has(p_func),false);
  348. const Function &func = functions[p_func];
  349. for (const Set<DataConnection>::Element *E=func.data_connections.front();E;E=E->next()) {
  350. if (E->get().to_node==p_node && E->get().to_port==p_port)
  351. return true;
  352. }
  353. return false;
  354. }
  355. void VisualScript::get_data_connection_list(const StringName& p_func,List<DataConnection> *r_connection) const {
  356. ERR_FAIL_COND(!functions.has(p_func));
  357. const Function &func = functions[p_func];
  358. for (const Set<DataConnection>::Element *E=func.data_connections.front();E;E=E->next()) {
  359. r_connection->push_back(E->get());
  360. }
  361. }
  362. void VisualScript::add_variable(const StringName& p_name,const Variant& p_default_value) {
  363. ERR_FAIL_COND( instances.size() );
  364. ERR_FAIL_COND(!String(p_name).is_valid_identifier());
  365. ERR_FAIL_COND(variables.has(p_name));
  366. Variable v;
  367. v.default_value=p_default_value;
  368. v.info.type=p_default_value.get_type();
  369. v.info.name=p_name;
  370. v.info.hint=PROPERTY_HINT_NONE;
  371. variables[p_name]=v;
  372. script_variable_remap[SCRIPT_VARIABLES_PREFIX+String(p_name)]=p_name;
  373. #ifdef TOOLS_ENABLED
  374. _update_placeholders();
  375. #endif
  376. }
  377. bool VisualScript::has_variable(const StringName& p_name) const {
  378. return variables.has(p_name);
  379. }
  380. void VisualScript::remove_variable(const StringName& p_name) {
  381. ERR_FAIL_COND(!variables.has(p_name));
  382. variables.erase(p_name);
  383. script_variable_remap.erase(SCRIPT_VARIABLES_PREFIX+String(p_name));
  384. #ifdef TOOLS_ENABLED
  385. _update_placeholders();
  386. #endif
  387. }
  388. void VisualScript::set_variable_default_value(const StringName& p_name,const Variant& p_value){
  389. ERR_FAIL_COND(!variables.has(p_name));
  390. variables[p_name].default_value=p_value;
  391. #ifdef TOOLS_ENABLED
  392. _update_placeholders();
  393. #endif
  394. }
  395. Variant VisualScript::get_variable_default_value(const StringName& p_name) const{
  396. ERR_FAIL_COND_V(!variables.has(p_name),Variant());
  397. return variables[p_name].default_value;
  398. }
  399. void VisualScript::set_variable_info(const StringName& p_name,const PropertyInfo& p_info){
  400. ERR_FAIL_COND( instances.size() );
  401. ERR_FAIL_COND(!variables.has(p_name));
  402. variables[p_name].info=p_info;
  403. variables[p_name].info.name=p_name;
  404. #ifdef TOOLS_ENABLED
  405. _update_placeholders();
  406. #endif
  407. }
  408. PropertyInfo VisualScript::get_variable_info(const StringName& p_name) const{
  409. ERR_FAIL_COND_V(!variables.has(p_name),PropertyInfo());
  410. return variables[p_name].info;
  411. }
  412. void VisualScript::_set_variable_info(const StringName& p_name,const Dictionary& p_info) {
  413. PropertyInfo pinfo;
  414. if (p_info.has("type"))
  415. pinfo.type=Variant::Type(int(p_info["type"]));
  416. if (p_info.has("name"))
  417. pinfo.name=p_info["name"];
  418. if (p_info.has("hint"))
  419. pinfo.hint=PropertyHint(int(p_info["hint"]));
  420. if (p_info.has("hint_string"))
  421. pinfo.hint_string=p_info["hint_string"];
  422. if (p_info.has("usage"))
  423. pinfo.usage=p_info["usage"];
  424. set_variable_info(p_name,pinfo);
  425. }
  426. Dictionary VisualScript::_get_variable_info(const StringName& p_name) const{
  427. PropertyInfo pinfo=get_variable_info(p_name);
  428. Dictionary d;
  429. d["type"]=pinfo.type;
  430. d["name"]=pinfo.name;
  431. d["hint"]=pinfo.hint;
  432. d["hint_string"]=pinfo.hint_string;
  433. d["usage"]=pinfo.usage;
  434. return d;
  435. }
  436. void VisualScript::get_variable_list(List<StringName> *r_variables){
  437. for (Map<StringName,Variable>::Element *E=variables.front();E;E=E->next()) {
  438. r_variables->push_back(E->key());
  439. }
  440. r_variables->sort_custom<StringName::AlphCompare>();
  441. }
  442. void VisualScript::set_instance_base_type(const StringName& p_type) {
  443. ERR_FAIL_COND( instances.size() );
  444. base_type=p_type;
  445. }
  446. void VisualScript::rename_variable(const StringName& p_name,const StringName& p_new_name) {
  447. ERR_FAIL_COND( instances.size() );
  448. ERR_FAIL_COND(!variables.has(p_name));
  449. if (p_new_name==p_name)
  450. return;
  451. ERR_FAIL_COND(!String(p_new_name).is_valid_identifier());
  452. ERR_FAIL_COND(functions.has(p_new_name));
  453. ERR_FAIL_COND(variables.has(p_new_name));
  454. ERR_FAIL_COND(custom_signals.has(p_new_name));
  455. variables[p_new_name]=variables[p_name];
  456. variables.erase(p_name);
  457. }
  458. void VisualScript::add_custom_signal(const StringName& p_name) {
  459. ERR_FAIL_COND( instances.size() );
  460. ERR_FAIL_COND(!String(p_name).is_valid_identifier());
  461. ERR_FAIL_COND(custom_signals.has(p_name));
  462. custom_signals[p_name]=Vector<Argument>();
  463. }
  464. bool VisualScript::has_custom_signal(const StringName& p_name) const {
  465. return custom_signals.has(p_name);
  466. }
  467. void VisualScript::custom_signal_add_argument(const StringName& p_func,Variant::Type p_type,const String& p_name,int p_index) {
  468. ERR_FAIL_COND( instances.size() );
  469. ERR_FAIL_COND(!custom_signals.has(p_func));
  470. Argument arg;
  471. arg.type=p_type;
  472. arg.name=p_name;
  473. if (p_index<0)
  474. custom_signals[p_func].push_back(arg);
  475. else
  476. custom_signals[p_func].insert(0,arg);
  477. }
  478. void VisualScript::custom_signal_set_argument_type(const StringName& p_func,int p_argidx,Variant::Type p_type) {
  479. ERR_FAIL_COND( instances.size() );
  480. ERR_FAIL_COND(!custom_signals.has(p_func));
  481. ERR_FAIL_INDEX(p_argidx,custom_signals[p_func].size());
  482. custom_signals[p_func][p_argidx].type=p_type;
  483. }
  484. Variant::Type VisualScript::custom_signal_get_argument_type(const StringName& p_func,int p_argidx) const {
  485. ERR_FAIL_COND_V(!custom_signals.has(p_func),Variant::NIL);
  486. ERR_FAIL_INDEX_V(p_argidx,custom_signals[p_func].size(),Variant::NIL);
  487. return custom_signals[p_func][p_argidx].type;
  488. }
  489. void VisualScript::custom_signal_set_argument_name(const StringName& p_func,int p_argidx,const String& p_name) {
  490. ERR_FAIL_COND( instances.size() );
  491. ERR_FAIL_COND(!custom_signals.has(p_func));
  492. ERR_FAIL_INDEX(p_argidx,custom_signals[p_func].size());
  493. custom_signals[p_func][p_argidx].name=p_name;
  494. }
  495. String VisualScript::custom_signal_get_argument_name(const StringName& p_func,int p_argidx) const {
  496. ERR_FAIL_COND_V(!custom_signals.has(p_func),String());
  497. ERR_FAIL_INDEX_V(p_argidx,custom_signals[p_func].size(),String());
  498. return custom_signals[p_func][p_argidx].name;
  499. }
  500. void VisualScript::custom_signal_remove_argument(const StringName& p_func,int p_argidx) {
  501. ERR_FAIL_COND( instances.size() );
  502. ERR_FAIL_COND(!custom_signals.has(p_func));
  503. ERR_FAIL_INDEX(p_argidx,custom_signals[p_func].size());
  504. custom_signals[p_func].remove(p_argidx);
  505. }
  506. int VisualScript::custom_signal_get_argument_count(const StringName& p_func) const {
  507. ERR_FAIL_COND_V(!custom_signals.has(p_func),0);
  508. return custom_signals[p_func].size();
  509. }
  510. void VisualScript::custom_signal_swap_argument(const StringName& p_func,int p_argidx,int p_with_argidx) {
  511. ERR_FAIL_COND( instances.size() );
  512. ERR_FAIL_COND(!custom_signals.has(p_func));
  513. ERR_FAIL_INDEX(p_argidx,custom_signals[p_func].size());
  514. ERR_FAIL_INDEX(p_with_argidx,custom_signals[p_func].size());
  515. SWAP( custom_signals[p_func][p_argidx], custom_signals[p_func][p_with_argidx] );
  516. }
  517. void VisualScript::remove_custom_signal(const StringName& p_name) {
  518. ERR_FAIL_COND( instances.size() );
  519. ERR_FAIL_COND(!custom_signals.has(p_name));
  520. custom_signals.erase(p_name);
  521. }
  522. void VisualScript::rename_custom_signal(const StringName& p_name,const StringName& p_new_name) {
  523. ERR_FAIL_COND( instances.size() );
  524. ERR_FAIL_COND(!custom_signals.has(p_name));
  525. if (p_new_name==p_name)
  526. return;
  527. ERR_FAIL_COND(!String(p_new_name).is_valid_identifier());
  528. ERR_FAIL_COND(functions.has(p_new_name));
  529. ERR_FAIL_COND(variables.has(p_new_name));
  530. ERR_FAIL_COND(custom_signals.has(p_new_name));
  531. custom_signals[p_new_name]=custom_signals[p_name];
  532. custom_signals.erase(p_name);
  533. }
  534. void VisualScript::get_custom_signal_list(List<StringName> *r_custom_signals) const {
  535. for (const Map<StringName,Vector<Argument> >::Element *E=custom_signals.front();E;E=E->next()) {
  536. r_custom_signals->push_back(E->key());
  537. }
  538. r_custom_signals->sort_custom<StringName::AlphCompare>();
  539. }
  540. int VisualScript::get_available_id() const {
  541. int max_id=0;
  542. for (Map<StringName,Function>::Element *E=functions.front();E;E=E->next()) {
  543. if (E->get().nodes.empty())
  544. continue;
  545. int last_id = E->get().nodes.back()->key();
  546. max_id=MAX(max_id,last_id+1);
  547. }
  548. return max_id;
  549. }
  550. /////////////////////////////////
  551. bool VisualScript::can_instance() const {
  552. return true;//ScriptServer::is_scripting_enabled();
  553. }
  554. StringName VisualScript::get_instance_base_type() const {
  555. return base_type;
  556. }
  557. #ifdef TOOLS_ENABLED
  558. void VisualScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  559. placeholders.erase(p_placeholder);
  560. }
  561. void VisualScript::_update_placeholders() {
  562. if (placeholders.size()==0)
  563. return; //no bother if no placeholders
  564. List<PropertyInfo> pinfo;
  565. Map<StringName,Variant> values;
  566. for (Map<StringName,Variable>::Element *E=variables.front();E;E=E->next()) {
  567. PropertyInfo p = E->get().info;
  568. p.name=SCRIPT_VARIABLES_PREFIX+String(E->key());
  569. pinfo.push_back(p);
  570. values[p.name]=E->get().default_value;
  571. }
  572. for (Set<PlaceHolderScriptInstance*>::Element *E=placeholders.front();E;E=E->next()) {
  573. E->get()->update(pinfo,values);
  574. }
  575. }
  576. #endif
  577. ScriptInstance* VisualScript::instance_create(Object *p_this) {
  578. #ifdef TOOLS_ENABLED
  579. if (!ScriptServer::is_scripting_enabled()) {
  580. PlaceHolderScriptInstance *sins = memnew( PlaceHolderScriptInstance(VisualScriptLanguage::singleton,Ref<Script>((Script*)this),p_this));
  581. placeholders.insert(sins);
  582. List<PropertyInfo> pinfo;
  583. Map<StringName,Variant> values;
  584. for (Map<StringName,Variable>::Element *E=variables.front();E;E=E->next()) {
  585. PropertyInfo p = E->get().info;
  586. p.name=SCRIPT_VARIABLES_PREFIX+String(E->key());
  587. pinfo.push_back(p);
  588. values[p.name]=E->get().default_value;
  589. }
  590. sins->update(pinfo,values);
  591. return sins;
  592. }
  593. #endif
  594. VisualScriptInstance *instance=memnew( VisualScriptInstance );
  595. instance->create(Ref<VisualScript>(this),p_this);
  596. if (VisualScriptLanguage::singleton->lock)
  597. VisualScriptLanguage::singleton->lock->lock();
  598. instances[p_this]=instance;
  599. if (VisualScriptLanguage::singleton->lock)
  600. VisualScriptLanguage::singleton->lock->unlock();
  601. return instance;
  602. }
  603. bool VisualScript::instance_has(const Object *p_this) const {
  604. return instances.has((Object*)p_this);
  605. }
  606. bool VisualScript::has_source_code() const {
  607. return false;
  608. }
  609. String VisualScript::get_source_code() const {
  610. return String();
  611. }
  612. void VisualScript::set_source_code(const String& p_code) {
  613. }
  614. Error VisualScript::reload(bool p_keep_state) {
  615. return OK;
  616. }
  617. bool VisualScript::is_tool() const {
  618. return false;
  619. }
  620. String VisualScript::get_node_type() const {
  621. return String();
  622. }
  623. ScriptLanguage *VisualScript::get_language() const {
  624. return VisualScriptLanguage::singleton;
  625. }
  626. bool VisualScript::has_script_signal(const StringName& p_signal) const {
  627. return custom_signals.has(p_signal);
  628. }
  629. void VisualScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  630. for (const Map<StringName,Vector<Argument> >::Element *E=custom_signals.front();E;E=E->next()) {
  631. MethodInfo mi;
  632. mi.name=E->key();
  633. for(int i=0;i<E->get().size();i++) {
  634. PropertyInfo arg;
  635. arg.type=E->get()[i].type;
  636. arg.name=E->get()[i].name;
  637. mi.arguments.push_back(arg);
  638. }
  639. r_signals->push_back(mi);
  640. }
  641. }
  642. bool VisualScript::get_property_default_value(const StringName& p_property,Variant& r_value) const {
  643. if (!script_variable_remap.has(p_property))
  644. return false;
  645. r_value=variables[ script_variable_remap[p_property] ].default_value;
  646. return true;
  647. }
  648. void VisualScript::get_method_list(List<MethodInfo> *p_list) const {
  649. for (Map<StringName,Function>::Element *E=functions.front();E;E=E->next()) {
  650. MethodInfo mi;
  651. mi.name=E->key();
  652. if (E->get().function_id>=0) {
  653. Ref<VisualScriptFunction> func=E->get().nodes[E->get().function_id].node;
  654. if (func.is_valid()) {
  655. for(int i=0;i<func->get_argument_count();i++) {
  656. PropertyInfo arg;
  657. arg.name=func->get_argument_name(i);
  658. arg.type=func->get_argument_type(i);
  659. mi.arguments.push_back(arg);
  660. }
  661. }
  662. }
  663. p_list->push_back(mi);
  664. }
  665. }
  666. void VisualScript::_set_data(const Dictionary& p_data) {
  667. Dictionary d = p_data;
  668. if (d.has("base_type"))
  669. base_type=d["base_type"];
  670. variables.clear();
  671. Array vars=d["variables"];
  672. for (int i=0;i<vars.size();i++) {
  673. Dictionary v=vars[i];
  674. StringName name = v["name"];
  675. add_variable(name);
  676. _set_variable_info(name,v);
  677. set_variable_default_value(name,v["default_value"]);
  678. }
  679. custom_signals.clear();
  680. Array sigs=d["signals"];
  681. for (int i=0;i<sigs.size();i++) {
  682. Dictionary cs=sigs[i];
  683. add_custom_signal(cs["name"]);
  684. Array args=cs["arguments"];
  685. for(int j=0;j<args.size();j+=2) {
  686. custom_signal_add_argument(cs["name"],Variant::Type(int(args[j+1])),args[j]);
  687. }
  688. }
  689. Array funcs=d["functions"];
  690. functions.clear();
  691. for (int i=0;i<funcs.size();i++) {
  692. Dictionary func=funcs[i];
  693. StringName name=func["name"];
  694. //int id=func["function_id"];
  695. add_function(name);
  696. set_function_scroll(name,func["scroll"]);
  697. Array nodes = func["nodes"];
  698. for(int i=0;i<nodes.size();i+=3) {
  699. add_node(name,nodes[i],nodes[i+2],nodes[i+1]);
  700. }
  701. Array sequence_connections=func["sequence_connections"];
  702. for (int j=0;j<sequence_connections.size();j+=3) {
  703. sequence_connect(name,sequence_connections[j+0],sequence_connections[j+1],sequence_connections[j+2]);
  704. }
  705. Array data_connections=func["data_connections"];
  706. for (int j=0;j<data_connections.size();j+=4) {
  707. data_connect(name,data_connections[j+0],data_connections[j+1],data_connections[j+2],data_connections[j+3]);
  708. }
  709. }
  710. }
  711. Dictionary VisualScript::_get_data() const{
  712. Dictionary d;
  713. d["base_type"]=base_type;
  714. Array vars;
  715. for (const Map<StringName,Variable>::Element *E=variables.front();E;E=E->next()) {
  716. Dictionary var = _get_variable_info(E->key());
  717. var["name"]=E->key(); //make sure it's the right one
  718. var["default_value"]=E->get().default_value;
  719. vars.push_back(var);
  720. }
  721. d["variables"]=vars;
  722. Array sigs;
  723. for (const Map<StringName,Vector<Argument> >::Element *E=custom_signals.front();E;E=E->next()) {
  724. Dictionary cs;
  725. cs["name"]=E->key();
  726. Array args;
  727. for(int i=0;i<E->get().size();i++) {
  728. args.push_back(E->get()[i].name);
  729. args.push_back(E->get()[i].type);
  730. }
  731. cs["arguments"]=args;
  732. sigs.push_back(cs);
  733. }
  734. d["signals"]=sigs;
  735. Array funcs;
  736. for (const Map<StringName,Function>::Element *E=functions.front();E;E=E->next()) {
  737. Dictionary func;
  738. func["name"]=E->key();
  739. func["function_id"]=E->get().function_id;
  740. func["scroll"]=E->get().scroll;
  741. Array nodes;
  742. for (const Map<int,Function::NodeData>::Element *F=E->get().nodes.front();F;F=F->next()) {
  743. nodes.push_back(F->key());
  744. nodes.push_back(F->get().pos);
  745. nodes.push_back(F->get().node);
  746. }
  747. func["nodes"]=nodes;
  748. Array sequence_connections;
  749. for (const Set<SequenceConnection>::Element *F=E->get().sequence_connections.front();F;F=F->next()) {
  750. sequence_connections.push_back(F->get().from_node);
  751. sequence_connections.push_back(F->get().from_output);
  752. sequence_connections.push_back(F->get().to_node);
  753. }
  754. func["sequence_connections"]=sequence_connections;
  755. Array data_connections;
  756. for (const Set<DataConnection>::Element *F=E->get().data_connections.front();F;F=F->next()) {
  757. data_connections.push_back(F->get().from_node);
  758. data_connections.push_back(F->get().from_port);
  759. data_connections.push_back(F->get().to_node);
  760. data_connections.push_back(F->get().to_port);
  761. }
  762. func["data_connections"]=data_connections;
  763. funcs.push_back(func);
  764. }
  765. d["functions"]=funcs;
  766. return d;
  767. }
  768. void VisualScript::_bind_methods() {
  769. ObjectTypeDB::bind_method(_MD("_node_ports_changed"),&VisualScript::_node_ports_changed);
  770. ObjectTypeDB::bind_method(_MD("add_function","name"),&VisualScript::add_function);
  771. ObjectTypeDB::bind_method(_MD("has_function","name"),&VisualScript::has_function);
  772. ObjectTypeDB::bind_method(_MD("remove_function","name"),&VisualScript::remove_function);
  773. ObjectTypeDB::bind_method(_MD("rename_function","name","new_name"),&VisualScript::rename_function);
  774. ObjectTypeDB::bind_method(_MD("set_function_scroll","ofs"),&VisualScript::set_function_scroll);
  775. ObjectTypeDB::bind_method(_MD("get_function_scroll"),&VisualScript::get_function_scroll);
  776. ObjectTypeDB::bind_method(_MD("add_node","func","id","node","pos"),&VisualScript::add_node,DEFVAL(Point2()));
  777. ObjectTypeDB::bind_method(_MD("remove_node","func","id"),&VisualScript::remove_node);
  778. ObjectTypeDB::bind_method(_MD("get_function_node_id","name"),&VisualScript::get_function_node_id);
  779. ObjectTypeDB::bind_method(_MD("get_node","func","id"),&VisualScript::get_node);
  780. ObjectTypeDB::bind_method(_MD("has_node","func","id"),&VisualScript::has_node);
  781. ObjectTypeDB::bind_method(_MD("set_node_pos","func","id","pos"),&VisualScript::set_node_pos);
  782. ObjectTypeDB::bind_method(_MD("get_node_pos","func","id"),&VisualScript::get_node_pos);
  783. ObjectTypeDB::bind_method(_MD("sequence_connect","func","from_node","from_output","to_node"),&VisualScript::sequence_connect);
  784. ObjectTypeDB::bind_method(_MD("sequence_disconnect","func","from_node","from_output","to_node"),&VisualScript::sequence_disconnect);
  785. ObjectTypeDB::bind_method(_MD("has_sequence_connection","func","from_node","from_output","to_node"),&VisualScript::has_sequence_connection);
  786. ObjectTypeDB::bind_method(_MD("data_connect","func","from_node","from_port","to_node","to_port"),&VisualScript::data_connect);
  787. ObjectTypeDB::bind_method(_MD("data_disconnect","func","from_node","from_port","to_node","to_port"),&VisualScript::data_disconnect);
  788. ObjectTypeDB::bind_method(_MD("has_data_connection","func","from_node","from_port","to_node","to_port"),&VisualScript::has_data_connection);
  789. ObjectTypeDB::bind_method(_MD("add_variable","name","default_value"),&VisualScript::add_variable,DEFVAL(Variant()));
  790. ObjectTypeDB::bind_method(_MD("has_variable","name"),&VisualScript::has_variable);
  791. ObjectTypeDB::bind_method(_MD("remove_variable","name"),&VisualScript::remove_variable);
  792. ObjectTypeDB::bind_method(_MD("set_variable_default_value","name","value"),&VisualScript::set_variable_default_value);
  793. ObjectTypeDB::bind_method(_MD("get_variable_default_value","name"),&VisualScript::get_variable_default_value);
  794. ObjectTypeDB::bind_method(_MD("set_variable_info","name","value"),&VisualScript::_set_variable_info);
  795. ObjectTypeDB::bind_method(_MD("get_variable_info","name"),&VisualScript::_get_variable_info);
  796. ObjectTypeDB::bind_method(_MD("rename_variable","name","new_name"),&VisualScript::rename_variable);
  797. ObjectTypeDB::bind_method(_MD("add_custom_signal","name"),&VisualScript::add_custom_signal);
  798. ObjectTypeDB::bind_method(_MD("has_custom_signal","name"),&VisualScript::has_custom_signal);
  799. ObjectTypeDB::bind_method(_MD("custom_signal_add_argument","name","type","argname","index"),&VisualScript::custom_signal_add_argument,DEFVAL(-1));
  800. ObjectTypeDB::bind_method(_MD("custom_signal_set_argument_type","name","argidx","type"),&VisualScript::custom_signal_set_argument_type);
  801. ObjectTypeDB::bind_method(_MD("custom_signal_get_argument_type","name","argidx"),&VisualScript::custom_signal_get_argument_type);
  802. ObjectTypeDB::bind_method(_MD("custom_signal_set_argument_name","name","argidx","argname"),&VisualScript::custom_signal_set_argument_name);
  803. ObjectTypeDB::bind_method(_MD("custom_signal_get_argument_name","name","argidx"),&VisualScript::custom_signal_get_argument_name);
  804. ObjectTypeDB::bind_method(_MD("custom_signal_remove_argument","argidx"),&VisualScript::custom_signal_remove_argument);
  805. ObjectTypeDB::bind_method(_MD("custom_signal_get_argument_count","name"),&VisualScript::custom_signal_get_argument_count);
  806. ObjectTypeDB::bind_method(_MD("custom_signal_swap_argument","name","argidx","withidx"),&VisualScript::custom_signal_swap_argument);
  807. ObjectTypeDB::bind_method(_MD("remove_custom_signal","name"),&VisualScript::remove_custom_signal);
  808. ObjectTypeDB::bind_method(_MD("rename_custom_signal","name","new_name"),&VisualScript::rename_custom_signal);
  809. //ObjectTypeDB::bind_method(_MD("set_variable_info","name","info"),&VScript::set_variable_info);
  810. //ObjectTypeDB::bind_method(_MD("get_variable_info","name"),&VScript::set_variable_info);
  811. ObjectTypeDB::bind_method(_MD("set_instance_base_type","type"),&VisualScript::set_instance_base_type);
  812. ObjectTypeDB::bind_method(_MD("_set_data","data"),&VisualScript::_set_data);
  813. ObjectTypeDB::bind_method(_MD("_get_data"),&VisualScript::_get_data);
  814. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY,"data",PROPERTY_HINT_NONE,"",PROPERTY_USAGE_NOEDITOR),_SCS("_set_data"),_SCS("_get_data"));
  815. ADD_SIGNAL(MethodInfo("node_ports_changed",PropertyInfo(Variant::STRING,"function"),PropertyInfo(Variant::INT,"id")));
  816. }
  817. VisualScript::VisualScript() {
  818. base_type="Object";
  819. }
  820. VisualScript::~VisualScript() {
  821. while(!functions.empty()) {
  822. remove_function(functions.front()->key());
  823. }
  824. }
  825. ////////////////////////////////////////////
  826. bool VisualScriptInstance::set(const StringName& p_name, const Variant& p_value) {
  827. const Map<StringName,StringName>::Element *remap = script->script_variable_remap.find(p_name);
  828. if (!remap)
  829. return false;
  830. Map<StringName,Variant>::Element *E=variables.find(remap->get());
  831. ERR_FAIL_COND_V(!E,false);
  832. E->get()=p_value;
  833. return true;
  834. }
  835. bool VisualScriptInstance::get(const StringName& p_name, Variant &r_ret) const {
  836. const Map<StringName,StringName>::Element *remap = script->script_variable_remap.find(p_name);
  837. if (!remap)
  838. return false;
  839. const Map<StringName,Variant>::Element *E=variables.find(remap->get());
  840. ERR_FAIL_COND_V(!E,false);
  841. return E->get();
  842. }
  843. void VisualScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const{
  844. for (const Map<StringName,VisualScript::Variable>::Element *E=script->variables.front();E;E=E->next()) {
  845. PropertyInfo p = E->get().info;
  846. p.name=SCRIPT_VARIABLES_PREFIX+String(E->key());
  847. p_properties->push_back(p);
  848. }
  849. }
  850. Variant::Type VisualScriptInstance::get_property_type(const StringName& p_name,bool *r_is_valid) const{
  851. const Map<StringName,StringName>::Element *remap = script->script_variable_remap.find(p_name);
  852. if (!remap) {
  853. if (r_is_valid)
  854. *r_is_valid=false;
  855. return Variant::NIL;
  856. }
  857. const Map<StringName,VisualScript::Variable>::Element *E=script->variables.find(remap->get());
  858. if (!E) {
  859. if (r_is_valid)
  860. *r_is_valid=false;
  861. ERR_FAIL_V(Variant::NIL);
  862. }
  863. if (r_is_valid)
  864. *r_is_valid=true;
  865. return E->get().info.type;
  866. }
  867. void VisualScriptInstance::get_method_list(List<MethodInfo> *p_list) const{
  868. for (const Map<StringName,VisualScript::Function>::Element *E=script->functions.front();E;E=E->next()) {
  869. MethodInfo mi;
  870. mi.name=E->key();
  871. if (E->get().function_id>=0 && E->get().nodes.has(E->get().function_id)) {
  872. Ref<VisualScriptFunction> vsf = E->get().nodes[E->get().function_id].node;
  873. if (vsf.is_valid()) {
  874. for(int i=0;i<vsf->get_argument_count();i++) {
  875. PropertyInfo arg;
  876. arg.name=vsf->get_argument_name(i);
  877. arg.type=vsf->get_argument_type(i);
  878. mi.arguments.push_back(arg);
  879. }
  880. //vsf->Get_ for now at least it does not return..
  881. }
  882. }
  883. p_list->push_back(mi);
  884. }
  885. }
  886. bool VisualScriptInstance::has_method(const StringName& p_method) const{
  887. return script->functions.has(p_method);
  888. }
  889. //#define VSDEBUG(m_text) print_line(m_text)
  890. #define VSDEBUG(m_text)
  891. Variant VisualScriptInstance::_call_internal(const StringName& p_method, void* p_stack, int p_stack_size, VisualScriptNodeInstance* p_node, int p_flow_stack_pos, bool p_resuming_yield, Variant::CallError &r_error) {
  892. Map<StringName,Function>::Element *F = functions.find(p_method);
  893. ERR_FAIL_COND_V(!F,Variant());
  894. Function *f=&F->get();
  895. //this call goes separate, so it can e yielded and suspended
  896. Variant *variant_stack=(Variant*)p_stack;
  897. bool *sequence_bits = (bool*)(variant_stack + f->max_stack);
  898. const Variant **input_args=(const Variant**)(sequence_bits+f->node_count);
  899. Variant **output_args=(Variant**)(input_args + max_input_args);
  900. int flow_max = f->flow_stack_size;
  901. int* flow_stack = flow_max? (int*)(output_args + max_output_args) : (int*)NULL;
  902. String error_str;
  903. VisualScriptNodeInstance* node=p_node;
  904. bool error=false;
  905. int current_node_id=f->node;
  906. Variant return_value;
  907. Variant *working_mem=NULL;
  908. int flow_stack_pos=p_flow_stack_pos;
  909. #ifdef DEBUG_ENABLED
  910. if (ScriptDebugger::get_singleton()) {
  911. VisualScriptLanguage::singleton->enter_function(this,&p_method,variant_stack,&working_mem,&current_node_id);
  912. }
  913. #endif
  914. while(true) {
  915. current_node_id=node->get_id();
  916. VSDEBUG("==========AT NODE: "+itos(current_node_id)+" base: "+node->get_base_node()->get_type());
  917. VSDEBUG("AT STACK POS: "+itos(flow_stack_pos));
  918. //setup working mem
  919. working_mem=node->working_mem_idx>=0 ? &variant_stack[node->working_mem_idx] : (Variant*)NULL;
  920. VSDEBUG("WORKING MEM: "+itos(node->working_mem_idx));
  921. if (current_node_id==f->node) {
  922. //if function node, set up function arguments from begining of stack
  923. for(int i=0;i<f->argument_count;i++) {
  924. input_args[i]=&variant_stack[i];
  925. }
  926. } else {
  927. //setup input pointers normally
  928. VSDEBUG("INPUT PORTS: "+itos(node->input_port_count));
  929. for(int i=0 ; i<node->input_port_count ; i++) {
  930. int index = node->input_ports[i] & VisualScriptNodeInstance::INPUT_MASK;
  931. if (node->input_ports[i] & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  932. //is a default value (unassigned input port)
  933. input_args[i]=&default_values[index];
  934. VSDEBUG("\tPORT "+itos(i)+" DEFAULT VAL");
  935. } else if (node->input_ports[i] & VisualScriptNodeInstance::INPUT_UNSEQUENCED_READ_BIT) {
  936. //from a node that requires read
  937. Function::UnsequencedGet *ug = &f->unsequenced_gets[index];
  938. bool ok = ug->from->get_output_port_unsequenced(i,&variant_stack[ug->to_stack],working_mem,error_str);
  939. if (!ok) {
  940. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  941. current_node_id=ug->from->get_id();
  942. error=true;
  943. working_mem=NULL;
  944. break;
  945. }
  946. VSDEBUG("\tPORT "+itos(i)+" UNSEQ READ TO STACK: " + itos(ug->to_stack));
  947. input_args[i]=&variant_stack[ug->to_stack];
  948. } else {
  949. //regular temporary in stack
  950. input_args[i]=&variant_stack[index];
  951. VSDEBUG("PORT "+itos(i)+" AT STACK "+itos(index));
  952. }
  953. }
  954. }
  955. if (error)
  956. break;
  957. //setup output pointers
  958. VSDEBUG("OUTPUT PORTS: "+itos(node->output_port_count));
  959. for(int i=0 ; i<node->output_port_count ; i++) {
  960. output_args[i] = &variant_stack[ node->output_ports[i] ];
  961. VSDEBUG("PORT "+itos(i)+" AT STACK "+itos(node->output_ports[i]));
  962. }
  963. //do step
  964. VisualScriptNodeInstance::StartMode start_mode;
  965. {
  966. if (p_resuming_yield)
  967. start_mode=VisualScriptNodeInstance::START_MODE_RESUME_YIELD;
  968. else if (flow_stack && !(flow_stack[flow_stack_pos] & VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT)) //if there is a push bit, it means we are continuing a sequence
  969. start_mode=VisualScriptNodeInstance::START_MODE_BEGIN_SEQUENCE;
  970. else
  971. start_mode=VisualScriptNodeInstance::START_MODE_CONTINUE_SEQUENCE;
  972. }
  973. VSDEBUG("STEP - STARTSEQ: "+itos(start_sequence));
  974. int ret = node->step(input_args,output_args,start_mode,working_mem,r_error,error_str);
  975. if (r_error.error!=Variant::CallError::CALL_OK) {
  976. //use error from step
  977. error=true;
  978. break;
  979. }
  980. if (ret&VisualScriptNodeInstance::STEP_YIELD_BIT) {
  981. //yielded!
  982. if (node->get_working_memory_size()==0) {
  983. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  984. error_str=RTR("A node yielded without working memory, please read the docs on how to yield properly!");
  985. error=true;
  986. break;
  987. } else {
  988. Ref<VisualScriptFunctionState> state = *working_mem;
  989. if (!state.is_valid()) {
  990. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  991. error_str=RTR("Node yielded, but did not return a function state in the first working memory.");
  992. error=true;
  993. break;
  994. }
  995. //step 1, capture all state
  996. state->instance_id=get_owner_ptr()->get_instance_ID();
  997. state->script_id=get_script()->get_instance_ID();
  998. state->instance=this;
  999. state->function=p_method;
  1000. state->working_mem_index=node->working_mem_idx;
  1001. state->variant_stack_size=f->max_stack;
  1002. state->node=node;
  1003. state->flow_stack_pos=flow_stack_pos;
  1004. state->stack.resize(p_stack_size);
  1005. copymem(state->stack.ptr(),p_stack,p_stack_size);
  1006. //step 2, run away, return directly
  1007. r_error.error=Variant::CallError::CALL_OK;
  1008. #ifdef DEBUG_ENABLED
  1009. //will re-enter later, so exiting
  1010. if (ScriptDebugger::get_singleton()) {
  1011. VisualScriptLanguage::singleton->exit_function();
  1012. }
  1013. #endif
  1014. return state;
  1015. }
  1016. }
  1017. #ifdef DEBUG_ENABLED
  1018. if (ScriptDebugger::get_singleton()) {
  1019. // line
  1020. bool do_break=false;
  1021. if (ScriptDebugger::get_singleton()->get_lines_left()>0) {
  1022. if (ScriptDebugger::get_singleton()->get_depth()<=0)
  1023. ScriptDebugger::get_singleton()->set_lines_left( ScriptDebugger::get_singleton()->get_lines_left() -1 );
  1024. if (ScriptDebugger::get_singleton()->get_lines_left()<=0)
  1025. do_break=true;
  1026. }
  1027. if (ScriptDebugger::get_singleton()->is_breakpoint(current_node_id,source))
  1028. do_break=true;
  1029. if (do_break) {
  1030. VisualScriptLanguage::singleton->debug_break("Breakpoint",true);
  1031. }
  1032. ScriptDebugger::get_singleton()->line_poll();
  1033. }
  1034. #endif
  1035. int output = ret & VisualScriptNodeInstance::STEP_MASK;
  1036. VSDEBUG("STEP RETURN: "+itos(ret));
  1037. if (ret & VisualScriptNodeInstance::STEP_EXIT_FUNCTION_BIT) {
  1038. if (node->get_working_memory_size()==0) {
  1039. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1040. error_str=RTR("Return value must be assigned to first element of node working memory! Fix your node please.");
  1041. error=true;
  1042. } else {
  1043. //assign from working memory, first element
  1044. return_value=*working_mem;
  1045. }
  1046. VSDEBUG("EXITING FUNCTION - VALUE "+String(return_value));
  1047. break; //exit function requested, bye
  1048. }
  1049. VisualScriptNodeInstance *next=NULL; //next node
  1050. if ( (ret==output || ret&VisualScriptNodeInstance::STEP_FLAG_PUSH_STACK_BIT) && node->sequence_output_count) {
  1051. //if no exit bit was set, and has sequence outputs, guess next node
  1052. if (output<0 || output>=node->sequence_output_count) {
  1053. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1054. error_str=RTR("Node returned an invalid sequence output: ")+itos(output);
  1055. error=true;
  1056. break;
  1057. }
  1058. next = node->sequence_outputs[output];
  1059. if (next) {
  1060. VSDEBUG("GOT NEXT NODE - "+itos(next->get_id()));
  1061. } else {
  1062. VSDEBUG("GOT NEXT NODE - NULL");
  1063. }
  1064. }
  1065. if (flow_stack) {
  1066. //update flow stack pos (may have changed)
  1067. flow_stack[flow_stack_pos] = current_node_id;
  1068. //add stack push bit if requested
  1069. if (ret & VisualScriptNodeInstance::STEP_FLAG_PUSH_STACK_BIT) {
  1070. flow_stack[flow_stack_pos] |= VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT;
  1071. sequence_bits[ node ->sequence_index ]=true; //remember sequence bit
  1072. VSDEBUG("NEXT SEQ - FLAG BIT");
  1073. } else {
  1074. sequence_bits[ node ->sequence_index ]=false; //forget sequence bit
  1075. VSDEBUG("NEXT SEQ - NORMAL");
  1076. }
  1077. if (ret & VisualScriptNodeInstance::STEP_FLAG_GO_BACK_BIT) {
  1078. //go back request
  1079. if (flow_stack_pos>0) {
  1080. flow_stack_pos--;
  1081. node = instances[ flow_stack[flow_stack_pos] & VisualScriptNodeInstance::FLOW_STACK_MASK ];
  1082. VSDEBUG("NEXT IS GO BACK");
  1083. } else {
  1084. VSDEBUG("NEXT IS GO BACK, BUT NO NEXT SO EXIT");
  1085. break; //simply exit without value or error
  1086. }
  1087. } else if (next) {
  1088. if (sequence_bits[next->sequence_index]) {
  1089. // what happened here is that we are entering a node that is in the middle of doing a sequence (pushed stack) from the front
  1090. // because each node has a working memory, we can't really do a sub-sequence
  1091. // as a result, the sequence will be restarted and the stack will roll back to find where this node
  1092. // started the sequence
  1093. bool found = false;
  1094. for(int i=flow_stack_pos;i>=0;i--) {
  1095. if ( (flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_MASK ) == next->get_id() ) {
  1096. flow_stack_pos=i; //roll back and remove bit
  1097. flow_stack[i]=next->get_id();
  1098. sequence_bits[next->sequence_index]=false;
  1099. found=true;
  1100. }
  1101. }
  1102. if (!found) {
  1103. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1104. error_str=RTR("Found sequence bit but not the node in the stack, report bug!");
  1105. error=true;
  1106. break;
  1107. }
  1108. node=next;
  1109. VSDEBUG("RE-ENTERED A LOOP, RETURNED STACK POS TO - "+itos(flow_stack_pos));
  1110. } else {
  1111. // check for stack overflow
  1112. if (flow_stack_pos+1 >= flow_max) {
  1113. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1114. error_str=RTR("Stack overflow with stack depth: ")+itos(output);
  1115. error=true;
  1116. break;
  1117. }
  1118. node = next;
  1119. flow_stack_pos++;
  1120. flow_stack[flow_stack_pos]=node->get_id();
  1121. VSDEBUG("INCREASE FLOW STACK");
  1122. }
  1123. } else {
  1124. //no next node, try to go back in stack to pushed bit
  1125. bool found = false;
  1126. for(int i=flow_stack_pos;i>=0;i--) {
  1127. VSDEBUG("FS "+itos(i)+" - "+itos(flow_stack[i]));
  1128. if (flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT) {
  1129. node = instances[ flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_MASK ];
  1130. flow_stack_pos=i;
  1131. found=true;
  1132. }
  1133. }
  1134. if (!found) {
  1135. VSDEBUG("NO NEXT NODE, NO GO BACK, EXITING");
  1136. break; //done, couldn't find a push stack bit
  1137. }
  1138. VSDEBUG("NO NEXT NODE, GO BACK TO: "+itos(flow_stack_pos));
  1139. }
  1140. } else {
  1141. node=next; //stackless mode, simply assign next node
  1142. }
  1143. }
  1144. if (error) {
  1145. //error
  1146. // function, file, line, error, explanation
  1147. String err_file = script->get_path();
  1148. String err_func = p_method;
  1149. int err_line=current_node_id; //not a line but it works as one
  1150. //if (!GDScriptLanguage::get_singleton()->debug_break(err_text,false)) {
  1151. // debugger break did not happen
  1152. if (!VisualScriptLanguage::singleton->debug_break(error_str,false)) {
  1153. _err_print_error(err_func.utf8().get_data(),err_file.utf8().get_data(),err_line,error_str.utf8().get_data(),ERR_HANDLER_SCRIPT);
  1154. }
  1155. //}
  1156. } else {
  1157. //return_value=
  1158. }
  1159. #ifdef DEBUG_ENABLED
  1160. if (ScriptDebugger::get_singleton()) {
  1161. VisualScriptLanguage::singleton->exit_function();
  1162. }
  1163. #endif
  1164. //clean up variant stack
  1165. for(int i=0;i<f->max_stack;i++) {
  1166. variant_stack[i].~Variant();
  1167. }
  1168. return return_value;
  1169. }
  1170. Variant VisualScriptInstance::call(const StringName& p_method,const Variant** p_args,int p_argcount,Variant::CallError &r_error){
  1171. r_error.error=Variant::CallError::CALL_OK; //ok by default
  1172. Map<StringName,Function>::Element *F = functions.find(p_method);
  1173. if (!F) {
  1174. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1175. return Variant();
  1176. }
  1177. VSDEBUG("CALLING: "+String(p_method));
  1178. Function *f=&F->get();
  1179. int total_stack_size=0;
  1180. total_stack_size+=f->max_stack*sizeof(Variant); //variants
  1181. total_stack_size+=f->node_count*sizeof(bool);
  1182. total_stack_size+=(max_input_args+max_output_args)*sizeof(Variant*); //arguments
  1183. total_stack_size+=f->flow_stack_size*sizeof(int); //flow
  1184. VSDEBUG("STACK SIZE: "+itos(total_stack_size));
  1185. VSDEBUG("STACK VARIANTS: : "+itos(f->max_stack));
  1186. VSDEBUG("SEQBITS: : "+itos(f->node_count));
  1187. VSDEBUG("MAX INPUT: "+itos(max_input_args));
  1188. VSDEBUG("MAX OUTPUT: "+itos(max_output_args));
  1189. VSDEBUG("FLOW STACK SIZE: "+itos(f->flow_stack_size));
  1190. void *stack = alloca(total_stack_size);
  1191. Variant *variant_stack=(Variant*)stack;
  1192. bool *sequence_bits = (bool*)(variant_stack + f->max_stack);
  1193. const Variant **input_args=(const Variant**)(sequence_bits+f->node_count);
  1194. Variant **output_args=(Variant**)(input_args + max_input_args);
  1195. int flow_max = f->flow_stack_size;
  1196. int* flow_stack = flow_max? (int*)(output_args + max_output_args) : (int*)NULL;
  1197. for(int i=0;i<f->node_count;i++) {
  1198. sequence_bits[i]=false; //all starts as false
  1199. }
  1200. Map<int,VisualScriptNodeInstance*>::Element *E = instances.find(f->node);
  1201. if (!E) {
  1202. r_error.error=Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1203. ERR_EXPLAIN("No VisualScriptFunction node in function!");
  1204. ERR_FAIL_V(Variant());
  1205. }
  1206. VisualScriptNodeInstance *node = E->get();
  1207. if (flow_stack) {
  1208. flow_stack[0]=node->get_id();
  1209. }
  1210. VSDEBUG("ARGUMENTS: "+itos(f->argument_count)=" RECEIVED: "+itos(p_argcount));
  1211. if (p_argcount<f->argument_count) {
  1212. r_error.error=Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1213. r_error.argument=node->get_input_port_count();
  1214. return Variant();
  1215. }
  1216. if (p_argcount>f->argument_count) {
  1217. r_error.error=Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1218. r_error.argument=node->get_input_port_count();
  1219. return Variant();
  1220. }
  1221. //allocate variant stack
  1222. for(int i=0;i<f->max_stack;i++) {
  1223. memnew_placement(&variant_stack[i],Variant);
  1224. }
  1225. //allocate function arguments (must be copied for yield to work properly)
  1226. for(int i=0;i<p_argcount;i++) {
  1227. variant_stack[i]=*p_args[i];
  1228. }
  1229. return _call_internal(p_method,stack,total_stack_size,node,0,false,r_error);
  1230. }
  1231. void VisualScriptInstance::notification(int p_notification){
  1232. //do nothing as this is called using virtual
  1233. Variant what=p_notification;
  1234. const Variant*whatp=&what;
  1235. Variant::CallError ce;
  1236. call(VisualScriptLanguage::singleton->notification,&whatp,1,ce); //do as call
  1237. }
  1238. Ref<Script> VisualScriptInstance::get_script() const{
  1239. return script;
  1240. }
  1241. void VisualScriptInstance::create(const Ref<VisualScript>& p_script,Object *p_owner) {
  1242. script=p_script;
  1243. owner=p_owner;
  1244. source=p_script->get_path();
  1245. max_input_args = 0;
  1246. max_output_args = 0;
  1247. for(const Map<StringName,VisualScript::Variable>::Element *E=script->variables.front();E;E=E->next()) {
  1248. variables[E->key()]=E->get().default_value;
  1249. }
  1250. for(const Map<StringName,VisualScript::Function>::Element *E=script->functions.front();E;E=E->next()) {
  1251. Function function;
  1252. function.node=E->get().function_id;
  1253. function.max_stack=0;
  1254. function.flow_stack_size=0;
  1255. function.node_count=0;
  1256. if (function.node<0) {
  1257. VisualScriptLanguage::singleton->debug_break_parse(get_script()->get_path(),0,"No start node in function: "+String(E->key()));
  1258. ERR_CONTINUE( function.node < 0 );
  1259. }
  1260. {
  1261. Ref<VisualScriptFunction> func_node = script->get_node(E->key(),E->get().function_id);
  1262. if (func_node.is_null()) {
  1263. VisualScriptLanguage::singleton->debug_break_parse(get_script()->get_path(),0,"No VisualScriptFunction typed start node in function: "+String(E->key()));
  1264. }
  1265. ERR_CONTINUE( !func_node.is_valid() );
  1266. function.argument_count=func_node->get_argument_count();
  1267. function.max_stack+=function.argument_count;
  1268. function.flow_stack_size= func_node->is_stack_less() ? 0 : func_node->get_stack_size();
  1269. }
  1270. //multiple passes are required to set up this complex thing..
  1271. //first create the nodes
  1272. for (const Map<int,VisualScript::Function::NodeData>::Element *F=E->get().nodes.front();F;F=F->next()) {
  1273. Ref<VisualScriptNode> node = F->get().node;
  1274. VisualScriptNodeInstance *instance = node->instance(this); //create instance
  1275. ERR_FAIL_COND(!instance);
  1276. instance->base=node.ptr();
  1277. instance->id=F->key();
  1278. instance->input_port_count = node->get_input_value_port_count();
  1279. instance->output_port_count = node->get_output_value_port_count();
  1280. instance->sequence_output_count = node->get_output_sequence_port_count();
  1281. instance->sequence_index=function.node_count++;
  1282. if (instance->input_port_count) {
  1283. instance->input_ports = memnew_arr(int,instance->input_port_count);
  1284. for(int i=0;i<instance->input_port_count;i++) {
  1285. instance->input_ports[i]=-1; //if not assigned, will become default value
  1286. }
  1287. }
  1288. if (instance->output_port_count) {
  1289. instance->output_ports = memnew_arr(int,instance->output_port_count);
  1290. for(int i=0;i<instance->output_port_count;i++) {
  1291. instance->output_ports[i]=-1; //if not assigned, will output to trash
  1292. }
  1293. }
  1294. if (instance->sequence_output_count) {
  1295. instance->sequence_outputs = memnew_arr(VisualScriptNodeInstance*,instance->sequence_output_count);
  1296. for(int i=0;i<instance->sequence_output_count;i++) {
  1297. instance->sequence_outputs[i]=NULL; //if it remains null, flow ends here
  1298. }
  1299. }
  1300. if (instance->get_working_memory_size()) {
  1301. instance->working_mem_idx = function.max_stack;
  1302. function.max_stack+=instance->get_working_memory_size();
  1303. } else {
  1304. instance->working_mem_idx=-1; //no working mem
  1305. }
  1306. max_input_args = MAX( max_input_args, instance->input_port_count );
  1307. max_output_args = MAX( max_output_args, instance->output_port_count );
  1308. instances[F->key()]=instance;
  1309. }
  1310. function.trash_pos = function.max_stack++; //create pos for trash
  1311. //second pass, do data connections
  1312. for(const Set<VisualScript::DataConnection>::Element *F=E->get().data_connections.front();F;F=F->next()) {
  1313. VisualScript::DataConnection dc = F->get();
  1314. ERR_CONTINUE(!instances.has(dc.from_node));
  1315. VisualScriptNodeInstance *from = instances[dc.from_node];
  1316. ERR_CONTINUE(!instances.has(dc.to_node));
  1317. VisualScriptNodeInstance *to = instances[dc.to_node];
  1318. ERR_CONTINUE(dc.from_port >= from->output_port_count);
  1319. ERR_CONTINUE(dc.to_port >= to->input_port_count);
  1320. if (from->output_ports[dc.from_port]==-1) {
  1321. int stack_pos = function.max_stack++;
  1322. from->output_ports[dc.from_port] = stack_pos;
  1323. }
  1324. if (from->is_output_port_unsequenced(dc.from_node)) {
  1325. //prepare an unsequenced read (must actually get the value from the output)
  1326. int stack_pos = function.max_stack++;
  1327. Function::UnsequencedGet uget;
  1328. uget.from=from;
  1329. uget.from_port=dc.from_port;
  1330. uget.to_stack=stack_pos;
  1331. to->input_ports[dc.to_port] = function.unsequenced_gets.size() | VisualScriptNodeInstance::INPUT_UNSEQUENCED_READ_BIT;
  1332. function.unsequenced_gets.push_back(uget);
  1333. } else {
  1334. to->input_ports[dc.to_port] = from->output_ports[dc.from_port]; //read from wherever the stack is
  1335. }
  1336. }
  1337. //third pass, do sequence connections
  1338. for(const Set<VisualScript::SequenceConnection>::Element *F=E->get().sequence_connections.front();F;F=F->next()) {
  1339. VisualScript::SequenceConnection sc = F->get();
  1340. ERR_CONTINUE(!instances.has(sc.from_node));
  1341. VisualScriptNodeInstance *from = instances[sc.from_node];
  1342. ERR_CONTINUE(!instances.has(sc.to_node));
  1343. VisualScriptNodeInstance *to = instances[sc.to_node];
  1344. ERR_CONTINUE(sc.from_output >= from->sequence_output_count);
  1345. from->sequence_outputs[sc.from_output]=to;
  1346. }
  1347. //fourth pass:
  1348. // 1) unassigned input ports to default values
  1349. // 2) connect unassigned output ports to trash
  1350. for (const Map<int,VisualScript::Function::NodeData>::Element *F=E->get().nodes.front();F;F=F->next()) {
  1351. ERR_CONTINUE(!instances.has(F->key()));
  1352. Ref<VisualScriptNode> node = F->get().node;
  1353. VisualScriptNodeInstance *instance = instances[F->key()];
  1354. // conect to default values
  1355. for(int i=0;i<instance->input_port_count;i++) {
  1356. if (instance->input_ports[i]==-1) {
  1357. //unassigned, connect to default val
  1358. instance->input_ports[i] = default_values.size() | VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT;
  1359. default_values.push_back( node->get_default_input_value(i) );
  1360. }
  1361. }
  1362. // conect to trash
  1363. for(int i=0;i<instance->output_port_count;i++) {
  1364. if (instance->output_ports[i]==-1) {
  1365. instance->output_ports[i] = function.trash_pos; //trash is same for all
  1366. }
  1367. }
  1368. }
  1369. functions[E->key()]=function;
  1370. }
  1371. }
  1372. ScriptLanguage *VisualScriptInstance::get_language(){
  1373. return VisualScriptLanguage::singleton;
  1374. }
  1375. VisualScriptInstance::VisualScriptInstance() {
  1376. }
  1377. VisualScriptInstance::~VisualScriptInstance() {
  1378. if (VisualScriptLanguage::singleton->lock)
  1379. VisualScriptLanguage::singleton->lock->lock();
  1380. script->instances.erase(owner);
  1381. if (VisualScriptLanguage::singleton->lock)
  1382. VisualScriptLanguage::singleton->lock->unlock();
  1383. for (Map<int,VisualScriptNodeInstance*>::Element *E=instances.front();E;E=E->next()) {
  1384. memdelete(E->get());
  1385. }
  1386. }
  1387. /////////////////////////////////////////////
  1388. /////////////////////
  1389. Variant VisualScriptFunctionState::_signal_callback(const Variant** p_args, int p_argcount, Variant::CallError& r_error) {
  1390. ERR_FAIL_COND_V(function==StringName(),Variant());
  1391. #ifdef DEBUG_ENABLED
  1392. if (instance_id && !ObjectDB::get_instance(instance_id)) {
  1393. ERR_EXPLAIN("Resumed after yield, but class instance is gone");
  1394. ERR_FAIL_V(Variant());
  1395. }
  1396. if (script_id && !ObjectDB::get_instance(script_id)) {
  1397. ERR_EXPLAIN("Resumed after yield, but script is gone");
  1398. ERR_FAIL_V(Variant());
  1399. }
  1400. #endif
  1401. r_error.error=Variant::CallError::CALL_OK;
  1402. Array args;
  1403. if (p_argcount==0) {
  1404. r_error.error=Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1405. r_error.argument=1;
  1406. return Variant();
  1407. } else if (p_argcount==1) {
  1408. //noooneee, reserved for me, me and only me.
  1409. } else {
  1410. for(int i=0;i<p_argcount-1;i++) {
  1411. args.push_back(*p_args[i]);
  1412. }
  1413. }
  1414. Ref<VisualScriptFunctionState> self = *p_args[p_argcount-1]; //hi, I'm myself, needed this to remain alive.
  1415. if (self.is_null()) {
  1416. r_error.error=Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1417. r_error.argument=p_argcount-1;
  1418. r_error.expected=Variant::OBJECT;
  1419. return Variant();
  1420. }
  1421. r_error.error=Variant::CallError::CALL_OK;
  1422. Variant *working_mem = ((Variant*)stack.ptr()) + working_mem_index;
  1423. *working_mem=args; //arguments go to working mem.
  1424. Variant ret = instance->_call_internal(function,stack.ptr(),stack.size(),node,flow_stack_pos,true,r_error);
  1425. function=StringName(); //invalidate
  1426. return ret;
  1427. }
  1428. void VisualScriptFunctionState::connect_to_signal(Object* p_obj, const String& p_signal, Array p_binds) {
  1429. Vector<Variant> binds;
  1430. for(int i=0;i<p_binds.size();i++) {
  1431. binds.push_back(p_binds[i]);
  1432. }
  1433. binds.push_back(Ref<VisualScriptFunctionState>(this)); //add myself on the back to avoid dying from unreferencing
  1434. p_obj->connect(p_signal,this,"_signal_callback",binds);
  1435. }
  1436. bool VisualScriptFunctionState::is_valid() const {
  1437. return function!=StringName();
  1438. }
  1439. Variant VisualScriptFunctionState::resume(Array p_args) {
  1440. ERR_FAIL_COND_V(function==StringName(),Variant());
  1441. #ifdef DEBUG_ENABLED
  1442. if (instance_id && !ObjectDB::get_instance(instance_id)) {
  1443. ERR_EXPLAIN("Resumed after yield, but class instance is gone");
  1444. ERR_FAIL_V(Variant());
  1445. }
  1446. if (script_id && !ObjectDB::get_instance(script_id)) {
  1447. ERR_EXPLAIN("Resumed after yield, but script is gone");
  1448. ERR_FAIL_V(Variant());
  1449. }
  1450. #endif
  1451. Variant::CallError r_error;
  1452. r_error.error=Variant::CallError::CALL_OK;
  1453. Variant *working_mem = ((Variant*)stack.ptr()) + working_mem_index;
  1454. *working_mem=p_args; //arguments go to working mem.
  1455. Variant ret= instance->_call_internal(function,stack.ptr(),stack.size(),node,flow_stack_pos,true,r_error);
  1456. function=StringName(); //invalidate
  1457. return ret;
  1458. }
  1459. void VisualScriptFunctionState::_bind_methods() {
  1460. ObjectTypeDB::bind_method(_MD("connect_to_signal","obj","signals","args"),&VisualScriptFunctionState::connect_to_signal);
  1461. ObjectTypeDB::bind_method(_MD("resume:Array","args"),&VisualScriptFunctionState::resume,DEFVAL(Variant()));
  1462. ObjectTypeDB::bind_method(_MD("is_valid"),&VisualScriptFunctionState::is_valid);
  1463. ObjectTypeDB::bind_native_method(METHOD_FLAGS_DEFAULT,"_signal_callback",&VisualScriptFunctionState::_signal_callback,MethodInfo("_signal_callback"));
  1464. }
  1465. VisualScriptFunctionState::VisualScriptFunctionState() {
  1466. }
  1467. VisualScriptFunctionState::~VisualScriptFunctionState() {
  1468. if (function!=StringName()) {
  1469. Variant *s = ((Variant*)stack.ptr());
  1470. for(int i=0;i<variant_stack_size;i++) {
  1471. s[i].~Variant();
  1472. }
  1473. }
  1474. }
  1475. ///////////////////////////////////////////////
  1476. String VisualScriptLanguage::get_name() const {
  1477. return "VisualScript";
  1478. }
  1479. /* LANGUAGE FUNCTIONS */
  1480. void VisualScriptLanguage::init() {
  1481. }
  1482. String VisualScriptLanguage::get_type() const {
  1483. return "VisualScript";
  1484. }
  1485. String VisualScriptLanguage::get_extension() const {
  1486. return "vs";
  1487. }
  1488. Error VisualScriptLanguage::execute_file(const String& p_path) {
  1489. return OK;
  1490. }
  1491. void VisualScriptLanguage::finish() {
  1492. }
  1493. /* EDITOR FUNCTIONS */
  1494. void VisualScriptLanguage::get_reserved_words(List<String> *p_words) const {
  1495. }
  1496. void VisualScriptLanguage::get_comment_delimiters(List<String> *p_delimiters) const {
  1497. }
  1498. void VisualScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const {
  1499. }
  1500. Ref<Script> VisualScriptLanguage::get_template(const String& p_class_name, const String& p_base_class_name) const {
  1501. Ref<VisualScript> script;
  1502. script.instance();
  1503. script->set_instance_base_type(p_base_class_name);
  1504. return script;
  1505. }
  1506. bool VisualScriptLanguage::validate(const String& p_script, int &r_line_error,int &r_col_error,String& r_test_error, const String& p_path,List<String> *r_functions) const {
  1507. return false;
  1508. }
  1509. Script *VisualScriptLanguage::create_script() const {
  1510. return memnew( VisualScript );
  1511. }
  1512. bool VisualScriptLanguage::has_named_classes() const {
  1513. return false;
  1514. }
  1515. int VisualScriptLanguage::find_function(const String& p_function,const String& p_code) const {
  1516. return -1;
  1517. }
  1518. String VisualScriptLanguage::make_function(const String& p_class,const String& p_name,const StringArray& p_args) const {
  1519. return String();
  1520. }
  1521. void VisualScriptLanguage::auto_indent_code(String& p_code,int p_from_line,int p_to_line) const {
  1522. }
  1523. void VisualScriptLanguage::add_global_constant(const StringName& p_variable,const Variant& p_value) {
  1524. }
  1525. /* DEBUGGER FUNCTIONS */
  1526. bool VisualScriptLanguage::debug_break_parse(const String& p_file, int p_node,const String& p_error) {
  1527. //break because of parse error
  1528. if (ScriptDebugger::get_singleton() && Thread::get_caller_ID()==Thread::get_main_ID()) {
  1529. _debug_parse_err_node=p_node;
  1530. _debug_parse_err_file=p_file;
  1531. _debug_error=p_error;
  1532. ScriptDebugger::get_singleton()->debug(this,false);
  1533. return true;
  1534. } else {
  1535. return false;
  1536. }
  1537. }
  1538. bool VisualScriptLanguage::debug_break(const String& p_error,bool p_allow_continue) {
  1539. if (ScriptDebugger::get_singleton() && Thread::get_caller_ID()==Thread::get_main_ID()) {
  1540. _debug_parse_err_node=-1;
  1541. _debug_parse_err_file="";
  1542. _debug_error=p_error;
  1543. ScriptDebugger::get_singleton()->debug(this,p_allow_continue);
  1544. return true;
  1545. } else {
  1546. return false;
  1547. }
  1548. }
  1549. String VisualScriptLanguage::debug_get_error() const {
  1550. return _debug_error;
  1551. }
  1552. int VisualScriptLanguage::debug_get_stack_level_count() const {
  1553. if (_debug_parse_err_node>=0)
  1554. return 1;
  1555. return _debug_call_stack_pos;
  1556. }
  1557. int VisualScriptLanguage::debug_get_stack_level_line(int p_level) const {
  1558. if (_debug_parse_err_node>=0)
  1559. return _debug_parse_err_node;
  1560. ERR_FAIL_INDEX_V(p_level,_debug_call_stack_pos,-1);
  1561. int l = _debug_call_stack_pos - p_level -1;
  1562. return *(_call_stack[l].current_id);
  1563. }
  1564. String VisualScriptLanguage::debug_get_stack_level_function(int p_level) const {
  1565. if (_debug_parse_err_node>=0)
  1566. return "";
  1567. ERR_FAIL_INDEX_V(p_level,_debug_call_stack_pos,"");
  1568. int l = _debug_call_stack_pos - p_level -1;
  1569. return *_call_stack[l].function;
  1570. }
  1571. String VisualScriptLanguage::debug_get_stack_level_source(int p_level) const {
  1572. if (_debug_parse_err_node>=0)
  1573. return _debug_parse_err_file;
  1574. ERR_FAIL_INDEX_V(p_level,_debug_call_stack_pos,"");
  1575. int l = _debug_call_stack_pos - p_level -1;
  1576. return _call_stack[l].instance->get_script_ptr()->get_path();
  1577. }
  1578. void VisualScriptLanguage::debug_get_stack_level_locals(int p_level,List<String> *p_locals, List<Variant> *p_values, int p_max_subitems,int p_max_depth) {
  1579. if (_debug_parse_err_node>=0)
  1580. return;
  1581. ERR_FAIL_INDEX(p_level,_debug_call_stack_pos);
  1582. int l = _debug_call_stack_pos - p_level -1;
  1583. const StringName *f = _call_stack[l].function;
  1584. ERR_FAIL_COND(!_call_stack[l].instance->functions.has(*f));
  1585. VisualScriptInstance::Function *func = &_call_stack[l].instance->functions[*f];
  1586. VisualScriptNodeInstance *node =_call_stack[l].instance->instances[*_call_stack[l].current_id];
  1587. ERR_FAIL_COND(!node);
  1588. p_locals->push_back("node_name");
  1589. p_values->push_back(node->get_base_node()->get_text());
  1590. for(int i=0;i<node->input_port_count;i++) {
  1591. String name = node->get_base_node()->get_input_value_port_info(i).name;
  1592. if (name==String()) {
  1593. name="in_"+itos(i);
  1594. }
  1595. p_locals->push_back("input/"+name);
  1596. //value is trickier
  1597. int in_from = node->input_ports[i];
  1598. int in_value = in_from&VisualScriptNodeInstance::INPUT_MASK;
  1599. if (in_from&VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1600. p_values->push_back(_call_stack[l].instance->default_values[in_value]);
  1601. } else if (in_from&VisualScriptNodeInstance::INPUT_UNSEQUENCED_READ_BIT) {
  1602. p_values->push_back( _call_stack[l].stack[ func->unsequenced_gets[ in_value ].to_stack ] );
  1603. } else {
  1604. p_values->push_back( _call_stack[l].stack[ in_value] );
  1605. }
  1606. }
  1607. for(int i=0;i<node->output_port_count;i++) {
  1608. String name = node->get_base_node()->get_output_value_port_info(i).name;
  1609. if (name==String()) {
  1610. name="out_"+itos(i);
  1611. }
  1612. p_locals->push_back("output/"+name);
  1613. //value is trickier
  1614. int in_from = node->output_ports[i];
  1615. p_values->push_back( _call_stack[l].stack[ in_from] );
  1616. }
  1617. for(int i=0;i<node->get_working_memory_size();i++) {
  1618. p_locals->push_back("working_mem/mem_"+itos(i));
  1619. p_values->push_back( (*_call_stack[l].work_mem)[i]);
  1620. }
  1621. /*
  1622. ERR_FAIL_INDEX(p_level,_debug_call_stack_pos);
  1623. VisualFunction *f = _call_stack[l].function;
  1624. List<Pair<StringName,int> > locals;
  1625. f->debug_get_stack_member_state(*_call_stack[l].line,&locals);
  1626. for( List<Pair<StringName,int> >::Element *E = locals.front();E;E=E->next() ) {
  1627. p_locals->push_back(E->get().first);
  1628. p_values->push_back(_call_stack[l].stack[E->get().second]);
  1629. }
  1630. */
  1631. }
  1632. void VisualScriptLanguage::debug_get_stack_level_members(int p_level,List<String> *p_members, List<Variant> *p_values, int p_max_subitems,int p_max_depth) {
  1633. if (_debug_parse_err_node>=0)
  1634. return;
  1635. ERR_FAIL_INDEX(p_level,_debug_call_stack_pos);
  1636. int l = _debug_call_stack_pos - p_level -1;
  1637. Ref<VisualScript> vs = _call_stack[l].instance->get_script();
  1638. if (vs.is_null())
  1639. return;
  1640. List<StringName> vars;
  1641. vs->get_variable_list(&vars);
  1642. for (List<StringName>::Element *E=vars.front();E;E=E->next()) {
  1643. Variant v;
  1644. if (_call_stack[l].instance->get_variable(E->get(),&v)) {
  1645. p_members->push_back("variables/"+E->get());
  1646. p_values->push_back(v);
  1647. }
  1648. }
  1649. }
  1650. void VisualScriptLanguage::debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems,int p_max_depth) {
  1651. //no globals are really reachable in gdscript
  1652. }
  1653. String VisualScriptLanguage::debug_parse_stack_level_expression(int p_level,const String& p_expression,int p_max_subitems,int p_max_depth) {
  1654. if (_debug_parse_err_node>=0)
  1655. return "";
  1656. return "";
  1657. }
  1658. void VisualScriptLanguage::reload_all_scripts() {
  1659. }
  1660. void VisualScriptLanguage::reload_tool_script(const Ref<Script>& p_script,bool p_soft_reload) {
  1661. }
  1662. /* LOADER FUNCTIONS */
  1663. void VisualScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  1664. p_extensions->push_back("vs");
  1665. }
  1666. void VisualScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  1667. }
  1668. void VisualScriptLanguage::get_public_constants(List<Pair<String,Variant> > *p_constants) const {
  1669. }
  1670. void VisualScriptLanguage::profiling_start() {
  1671. }
  1672. void VisualScriptLanguage::profiling_stop() {
  1673. }
  1674. int VisualScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr,int p_info_max) {
  1675. return 0;
  1676. }
  1677. int VisualScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr,int p_info_max) {
  1678. return 0;
  1679. }
  1680. VisualScriptLanguage* VisualScriptLanguage::singleton=NULL;
  1681. void VisualScriptLanguage::add_register_func(const String& p_name,VisualScriptNodeRegisterFunc p_func) {
  1682. ERR_FAIL_COND(register_funcs.has(p_name));
  1683. register_funcs[p_name]=p_func;
  1684. }
  1685. Ref<VisualScriptNode> VisualScriptLanguage::create_node_from_name(const String& p_name) {
  1686. ERR_FAIL_COND_V(!register_funcs.has(p_name),Ref<VisualScriptNode>());
  1687. return register_funcs[p_name](p_name);
  1688. }
  1689. void VisualScriptLanguage::get_registered_node_names(List<String> *r_names) {
  1690. for (Map<String,VisualScriptNodeRegisterFunc>::Element *E=register_funcs.front();E;E=E->next()) {
  1691. r_names->push_back(E->key());
  1692. }
  1693. }
  1694. VisualScriptLanguage::VisualScriptLanguage() {
  1695. notification="_notification";
  1696. singleton=this;
  1697. #ifndef NO_THREADS
  1698. lock = Mutex::create();
  1699. #endif
  1700. _debug_parse_err_node=-1;
  1701. _debug_parse_err_file="";
  1702. _debug_call_stack_pos=0;
  1703. int dmcs=GLOBAL_DEF("debug/script_max_call_stack",1024);
  1704. if (ScriptDebugger::get_singleton()) {
  1705. //debugging enabled!
  1706. _debug_max_call_stack = dmcs;
  1707. if (_debug_max_call_stack<1024)
  1708. _debug_max_call_stack=1024;
  1709. _call_stack = memnew_arr( CallLevel, _debug_max_call_stack+1 );
  1710. } else {
  1711. _debug_max_call_stack=0;
  1712. _call_stack=NULL;
  1713. }
  1714. }
  1715. VisualScriptLanguage::~VisualScriptLanguage() {
  1716. if (lock)
  1717. memdelete(lock);
  1718. if (_call_stack) {
  1719. memdelete_arr(_call_stack);
  1720. }
  1721. singleton=NULL;
  1722. }