visual_script.cpp 69 KB

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