ScriptFile.cpp 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078
  1. // Copyright (c) 2008-2022 the Urho3D project
  2. // License: MIT
  3. #include "../Precompiled.h"
  4. #include "../AngelScript/Script.h"
  5. #include "../AngelScript/ScriptFile.h"
  6. #include "../AngelScript/ScriptInstance.h"
  7. #include "../Core/Context.h"
  8. #include "../Core/CoreEvents.h"
  9. #include "../Core/Profiler.h"
  10. #include "../IO/FileSystem.h"
  11. #include "../IO/Log.h"
  12. #include "../IO/MemoryBuffer.h"
  13. #include "../Resource/ResourceCache.h"
  14. #include <AngelScript/angelscript.h>
  15. #include "../DebugNew.h"
  16. namespace Urho3D
  17. {
  18. /// Helper class for saving AngelScript bytecode.
  19. class ByteCodeSerializer : public asIBinaryStream
  20. {
  21. public:
  22. /// Construct.
  23. explicit ByteCodeSerializer(Serializer& dest) :
  24. dest_(dest)
  25. {
  26. }
  27. /// Read from stream (no-op).
  28. int Read(void* ptr, asUINT size) override
  29. {
  30. // No-op, can not read from a Serializer
  31. return 0;
  32. }
  33. /// Write to stream.
  34. int Write(const void* ptr, asUINT size) override
  35. {
  36. return dest_.Write(ptr, size);
  37. }
  38. private:
  39. /// Destination stream.
  40. Serializer& dest_;
  41. };
  42. /// Helper class for loading AngelScript bytecode.
  43. class ByteCodeDeserializer : public asIBinaryStream
  44. {
  45. public:
  46. /// Construct.
  47. explicit ByteCodeDeserializer(MemoryBuffer& source) :
  48. source_(source)
  49. {
  50. }
  51. /// Read from stream.
  52. int Read(void* ptr, asUINT size) override
  53. {
  54. return source_.Read(ptr, size);
  55. }
  56. /// Write to stream (no-op).
  57. int Write(const void* ptr, asUINT size) override
  58. {
  59. return 0;
  60. }
  61. private:
  62. /// Source stream.
  63. MemoryBuffer& source_;
  64. };
  65. ScriptFile::ScriptFile(Context* context) :
  66. Resource(context),
  67. script_(GetSubsystem<Script>())
  68. {
  69. }
  70. ScriptFile::~ScriptFile()
  71. {
  72. ReleaseModule();
  73. }
  74. void ScriptFile::RegisterObject(Context* context)
  75. {
  76. context->RegisterFactory<ScriptFile>();
  77. }
  78. bool ScriptFile::BeginLoad(Deserializer& source)
  79. {
  80. ReleaseModule();
  81. loadByteCode_.Reset();
  82. asIScriptEngine* engine = script_->GetScriptEngine();
  83. {
  84. MutexLock lock(script_->GetModuleMutex());
  85. // Create the module. Discard previous module if there was one
  86. scriptModule_ = engine->GetModule(GetName().CString(), asGM_ALWAYS_CREATE);
  87. if (!scriptModule_)
  88. {
  89. URHO3D_LOGERROR("Failed to create script module " + GetName());
  90. return false;
  91. }
  92. }
  93. // Check if this file is precompiled bytecode
  94. if (source.ReadFileID() == "ASBC")
  95. {
  96. // Perform actual parsing in EndLoad(); read data now
  97. loadByteCodeSize_ = source.GetSize() - source.GetPosition();
  98. loadByteCode_ = new unsigned char[loadByteCodeSize_];
  99. source.Read(loadByteCode_.Get(), loadByteCodeSize_);
  100. return true;
  101. }
  102. else
  103. source.Seek(0);
  104. // Not bytecode: add the initial section and check for includes.
  105. // Perform actual building during EndLoad(), as AngelScript can not multithread module compilation,
  106. // and static initializers may access arbitrary engine functionality which may not be thread-safe
  107. return AddScriptSection(engine, source);
  108. }
  109. bool ScriptFile::EndLoad()
  110. {
  111. bool success = false;
  112. // Map script module to script resource with userdata
  113. scriptModule_->SetUserData(this);
  114. // Load from bytecode if available, else compile
  115. if (loadByteCode_)
  116. {
  117. MemoryBuffer buffer(loadByteCode_.Get(), loadByteCodeSize_);
  118. ByteCodeDeserializer deserializer = ByteCodeDeserializer(buffer);
  119. if (scriptModule_->LoadByteCode(&deserializer) >= 0)
  120. {
  121. URHO3D_LOGINFO("Loaded script module " + GetName() + " from bytecode");
  122. success = true;
  123. }
  124. }
  125. else
  126. {
  127. if (onlyCompile_)
  128. scriptModule_->GetEngine()->SetEngineProperty(asEP_INIT_GLOBAL_VARS_AFTER_BUILD, 0);
  129. int result = scriptModule_->Build();
  130. if (result >= 0)
  131. {
  132. URHO3D_LOGINFO("Compiled script module " + GetName());
  133. success = true;
  134. }
  135. else
  136. URHO3D_LOGERROR("Failed to compile script module " + GetName());
  137. }
  138. if (success)
  139. compiled_ = true;
  140. loadByteCode_.Reset();
  141. return success;
  142. }
  143. void ScriptFile::AddEventHandler(StringHash eventType, const String& handlerName)
  144. {
  145. if (!compiled_)
  146. return;
  147. AddEventHandlerInternal(nullptr, eventType, handlerName);
  148. }
  149. void ScriptFile::AddEventHandler(Object* sender, StringHash eventType, const String& handlerName)
  150. {
  151. if (!compiled_)
  152. return;
  153. if (!sender)
  154. {
  155. URHO3D_LOGERROR("Null event sender for event " + String(eventType) + ", handler " + handlerName);
  156. return;
  157. }
  158. AddEventHandlerInternal(sender, eventType, handlerName);
  159. }
  160. void ScriptFile::RemoveEventHandler(StringHash eventType)
  161. {
  162. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  163. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::Iterator i = eventInvokers_.Find(receiver);
  164. if (i != eventInvokers_.End())
  165. {
  166. i->second_->UnsubscribeFromEvent(eventType);
  167. // If no longer have any subscribed events, remove the event invoker object
  168. if (!i->second_->HasEventHandlers())
  169. eventInvokers_.Erase(i);
  170. }
  171. }
  172. void ScriptFile::RemoveEventHandler(Object* sender, StringHash eventType)
  173. {
  174. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  175. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::Iterator i = eventInvokers_.Find(receiver);
  176. if (i != eventInvokers_.End())
  177. {
  178. i->second_->UnsubscribeFromEvent(sender, eventType);
  179. if (!i->second_->HasEventHandlers())
  180. eventInvokers_.Erase(i);
  181. }
  182. }
  183. void ScriptFile::RemoveEventHandlers(Object* sender)
  184. {
  185. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  186. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::Iterator i = eventInvokers_.Find(receiver);
  187. if (i != eventInvokers_.End())
  188. {
  189. i->second_->UnsubscribeFromEvents(sender);
  190. if (!i->second_->HasEventHandlers())
  191. eventInvokers_.Erase(i);
  192. }
  193. }
  194. void ScriptFile::RemoveEventHandlers()
  195. {
  196. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  197. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::Iterator i = eventInvokers_.Find(receiver);
  198. if (i != eventInvokers_.End())
  199. {
  200. i->second_->UnsubscribeFromAllEvents();
  201. if (!i->second_->HasEventHandlers())
  202. eventInvokers_.Erase(i);
  203. }
  204. }
  205. void ScriptFile::RemoveEventHandlersExcept(const PODVector<StringHash>& exceptions)
  206. {
  207. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  208. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::Iterator i = eventInvokers_.Find(receiver);
  209. if (i != eventInvokers_.End())
  210. {
  211. i->second_->UnsubscribeFromAllEventsExcept(exceptions, true);
  212. if (!i->second_->HasEventHandlers())
  213. eventInvokers_.Erase(i);
  214. }
  215. }
  216. bool ScriptFile::HasEventHandler(StringHash eventType) const
  217. {
  218. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  219. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::ConstIterator i = eventInvokers_.Find(receiver);
  220. if (i != eventInvokers_.End())
  221. return i->second_->HasSubscribedToEvent(eventType);
  222. else
  223. return false;
  224. }
  225. bool ScriptFile::HasEventHandler(Object* sender, StringHash eventType) const
  226. {
  227. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  228. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::ConstIterator i = eventInvokers_.Find(receiver);
  229. if (i != eventInvokers_.End())
  230. return i->second_->HasSubscribedToEvent(sender, eventType);
  231. else
  232. return false;
  233. }
  234. bool ScriptFile::Execute(const String& declaration, const VariantVector& parameters, Variant* functionReturn, bool unprepare)
  235. {
  236. asIScriptFunction* function = GetFunction(declaration);
  237. if (!function)
  238. {
  239. URHO3D_LOGERROR("Function " + declaration + " not found in " + GetName());
  240. return false;
  241. }
  242. return Execute(function, parameters, functionReturn, unprepare);
  243. }
  244. bool ScriptFile::Execute(asIScriptFunction* function, const VariantVector& parameters, Variant* functionReturn, bool unprepare)
  245. {
  246. URHO3D_PROFILE(ExecuteFunction);
  247. if (!compiled_ || !function)
  248. return false;
  249. // It is possible that executing the function causes us to unload. Therefore do not rely on member variables
  250. // However, we are not prepared for the whole script system getting destroyed during execution (should never happen)
  251. Script* scriptSystem = script_;
  252. asIScriptContext* context = scriptSystem->GetScriptFileContext();
  253. if (context->Prepare(function) < 0)
  254. return false;
  255. SetParameters(context, function, parameters);
  256. scriptSystem->IncScriptNestingLevel();
  257. bool success = (context->Execute() == asEXECUTION_FINISHED);
  258. if (success && (functionReturn != nullptr))
  259. {
  260. const int typeId = function->GetReturnTypeId();
  261. asIScriptEngine* engine = script_->GetScriptEngine();
  262. asITypeInfo* typeInfo = engine->GetTypeInfoById(typeId);
  263. // Built-in type
  264. if (typeInfo == nullptr)
  265. {
  266. switch (typeId)
  267. {
  268. case asTYPEID_VOID:
  269. *functionReturn = Variant::EMPTY;
  270. break;
  271. case asTYPEID_BOOL:
  272. *functionReturn = Variant(context->GetReturnByte() > 0);
  273. break;
  274. case asTYPEID_INT8:
  275. case asTYPEID_UINT8:
  276. case asTYPEID_INT16:
  277. case asTYPEID_UINT16:
  278. case asTYPEID_INT32:
  279. case asTYPEID_UINT32:
  280. *functionReturn = Variant(static_cast<int>(context->GetReturnDWord()));
  281. break;
  282. case asTYPEID_INT64:
  283. case asTYPEID_UINT64:
  284. *functionReturn = Variant(static_cast<long long>(context->GetReturnQWord()));
  285. break;
  286. case asTYPEID_FLOAT:
  287. *functionReturn = Variant(context->GetReturnFloat());
  288. break;
  289. case asTYPEID_DOUBLE:
  290. *functionReturn = Variant(context->GetReturnDouble());
  291. break;
  292. }
  293. }
  294. else if (typeInfo->GetFlags() & asOBJ_REF)
  295. {
  296. *functionReturn = Variant(static_cast<RefCounted*>(context->GetReturnObject()));
  297. }
  298. else if (typeInfo->GetFlags() & asOBJ_VALUE)
  299. {
  300. void* returnedObject = context->GetReturnObject();
  301. const VariantType variantType = Variant::GetTypeFromName(typeInfo->GetName());
  302. switch (variantType)
  303. {
  304. case VAR_STRING:
  305. *functionReturn = *static_cast<String*>(returnedObject);
  306. break;
  307. case VAR_VECTOR2:
  308. *functionReturn = *static_cast<Vector2*>(returnedObject);
  309. break;
  310. case VAR_VECTOR3:
  311. *functionReturn = *static_cast<Vector3*>(returnedObject);
  312. break;
  313. case VAR_VECTOR4:
  314. *functionReturn = *static_cast<Vector4*>(returnedObject);
  315. break;
  316. case VAR_QUATERNION:
  317. *functionReturn = *static_cast<Quaternion*>(returnedObject);
  318. break;
  319. case VAR_COLOR:
  320. *functionReturn = *static_cast<Color*>(returnedObject);
  321. break;
  322. case VAR_INTRECT:
  323. *functionReturn = *static_cast<IntRect*>(returnedObject);
  324. break;
  325. case VAR_INTVECTOR2:
  326. *functionReturn = *static_cast<IntVector2*>(returnedObject);
  327. break;
  328. case VAR_MATRIX3:
  329. *functionReturn = *static_cast<Matrix3*>(returnedObject);
  330. break;
  331. case VAR_MATRIX3X4:
  332. *functionReturn = *static_cast<Matrix3x4*>(returnedObject);
  333. break;
  334. case VAR_MATRIX4:
  335. *functionReturn = *static_cast<Matrix4*>(returnedObject);
  336. break;
  337. case VAR_RECT:
  338. *functionReturn = *static_cast<Rect*>(returnedObject);
  339. break;
  340. case VAR_INTVECTOR3:
  341. *functionReturn = *static_cast<IntVector3*>(returnedObject);
  342. break;
  343. default:
  344. URHO3D_LOGERRORF("Return type (%c) is not supported", typeInfo->GetName());
  345. break;
  346. }
  347. }
  348. else
  349. {
  350. URHO3D_LOGERRORF("Return type (%c)is not supported", typeInfo->GetName());
  351. }
  352. }
  353. if (unprepare)
  354. context->Unprepare();
  355. scriptSystem->DecScriptNestingLevel();
  356. return success;
  357. }
  358. bool ScriptFile::Execute(asIScriptObject* object, const String& declaration, const VariantVector& parameters, Variant* functionReturn,
  359. bool unprepare)
  360. {
  361. if (!object)
  362. return false;
  363. asIScriptFunction* method = GetMethod(object, declaration);
  364. if (!method)
  365. {
  366. URHO3D_LOGERROR("Method " + declaration + " not found in class " + String(object->GetObjectType()->GetName()));
  367. return false;
  368. }
  369. return Execute(object, method, parameters, functionReturn, unprepare);
  370. }
  371. bool ScriptFile::Execute(asIScriptObject* object, asIScriptFunction* method, const VariantVector& parameters, Variant* functionReturn,
  372. bool unprepare)
  373. {
  374. URHO3D_PROFILE(ExecuteMethod);
  375. if (!compiled_ || !object || !method)
  376. return false;
  377. // It is possible that executing the method causes us to unload. Therefore do not rely on member variables
  378. // However, we are not prepared for the whole script system getting destroyed during execution (should never happen)
  379. Script* scriptSystem = script_;
  380. asIScriptContext* context = scriptSystem->GetScriptFileContext();
  381. if (context->Prepare(method) < 0)
  382. return false;
  383. context->SetObject(object);
  384. SetParameters(context, method, parameters);
  385. scriptSystem->IncScriptNestingLevel();
  386. bool success = context->Execute() >= 0;
  387. if (unprepare)
  388. context->Unprepare();
  389. scriptSystem->DecScriptNestingLevel();
  390. return success;
  391. }
  392. void ScriptFile::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  393. {
  394. DelayedCall call;
  395. call.period_ = call.delay_ = Max(delay, 0.0f);
  396. call.repeat_ = repeat;
  397. call.declaration_ = declaration;
  398. call.parameters_ = parameters;
  399. delayedCalls_.Push(call);
  400. // Make sure we are registered to the application update event, because delayed calls are executed there
  401. if (!subscribed_)
  402. {
  403. SubscribeToEvent(E_UPDATE, URHO3D_HANDLER(ScriptFile, HandleUpdate));
  404. subscribed_ = true;
  405. }
  406. }
  407. void ScriptFile::ClearDelayedExecute(const String& declaration)
  408. {
  409. if (declaration.Empty())
  410. delayedCalls_.Clear();
  411. else
  412. {
  413. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End();)
  414. {
  415. if (declaration == i->declaration_)
  416. i = delayedCalls_.Erase(i);
  417. else
  418. ++i;
  419. }
  420. }
  421. }
  422. asIScriptObject* ScriptFile::CreateObject(const String& className, bool useInterface)
  423. {
  424. URHO3D_PROFILE(CreateObject);
  425. if (!compiled_)
  426. return nullptr;
  427. asIScriptContext* context = script_->GetScriptFileContext();
  428. asITypeInfo* type = nullptr;
  429. if (useInterface)
  430. {
  431. asITypeInfo* interfaceType = scriptModule_->GetTypeInfoByDecl(className.CString());
  432. if (!interfaceType)
  433. return nullptr;
  434. for (unsigned i = 0; i < scriptModule_->GetObjectTypeCount(); ++i)
  435. {
  436. asITypeInfo* t = scriptModule_->GetObjectTypeByIndex(i);
  437. if (t->Implements(interfaceType))
  438. {
  439. type = t;
  440. break;
  441. }
  442. }
  443. }
  444. else
  445. {
  446. type = scriptModule_->GetTypeInfoByDecl(className.CString());
  447. }
  448. if (!type)
  449. return nullptr;
  450. // Ensure that the type implements the "ScriptObject" interface, so it can be returned to script properly
  451. bool found;
  452. HashMap<asITypeInfo*, bool>::ConstIterator i = validClasses_.Find(type);
  453. if (i != validClasses_.End())
  454. found = i->second_;
  455. else
  456. {
  457. asITypeInfo* scriptObjectType = scriptModule_->GetTypeInfoByDecl("ScriptObject");
  458. found = type->Implements(scriptObjectType);
  459. validClasses_[type] = found;
  460. }
  461. if (!found)
  462. {
  463. URHO3D_LOGERRORF("Script class %s does not implement the ScriptObject interface", type->GetName());
  464. return nullptr;
  465. }
  466. // Get the factory function id from the object type
  467. String factoryName = String(type->GetName()) + "@ " + type->GetName() + "()";
  468. asIScriptFunction* factory = type->GetFactoryByDecl(factoryName.CString());
  469. if (!factory || context->Prepare(factory) < 0)
  470. return nullptr;
  471. Script* scriptSystem = script_;
  472. scriptSystem->IncScriptNestingLevel();
  473. bool success = context->Execute() == asEXECUTION_FINISHED;
  474. scriptSystem->DecScriptNestingLevel();
  475. if (!success)
  476. return nullptr;
  477. void* objAddress = context->GetAddressOfReturnValue();
  478. if (!objAddress)
  479. return nullptr;
  480. asIScriptObject* obj = *(static_cast<asIScriptObject**>(objAddress));
  481. if (obj)
  482. obj->AddRef();
  483. return obj;
  484. }
  485. bool ScriptFile::SaveByteCode(Serializer& dest)
  486. {
  487. if (compiled_)
  488. {
  489. dest.WriteFileID("ASBC");
  490. ByteCodeSerializer serializer = ByteCodeSerializer(dest);
  491. return scriptModule_->SaveByteCode(&serializer, true) >= 0;
  492. }
  493. else
  494. return false;
  495. }
  496. asIScriptFunction* ScriptFile::GetFunction(const String& declaration)
  497. {
  498. if (!compiled_)
  499. return nullptr;
  500. String trimDecl = declaration.Trimmed();
  501. // If not a full trimDecl, assume void with no parameters
  502. if (trimDecl.Find('(') == String::NPOS)
  503. trimDecl = "void " + trimDecl + "()";
  504. HashMap<String, asIScriptFunction*>::ConstIterator i = functions_.Find(trimDecl);
  505. if (i != functions_.End())
  506. return i->second_;
  507. asIScriptFunction* function = scriptModule_->GetFunctionByDecl(trimDecl.CString());
  508. functions_[trimDecl] = function;
  509. return function;
  510. }
  511. asIScriptFunction* ScriptFile::GetMethod(asIScriptObject* object, const String& declaration)
  512. {
  513. if (!compiled_ || !object)
  514. return nullptr;
  515. String trimDecl = declaration.Trimmed();
  516. // If not a full trimDecl, assume void with no parameters
  517. if (trimDecl.Find('(') == String::NPOS)
  518. trimDecl = "void " + trimDecl + "()";
  519. asITypeInfo* type = object->GetObjectType();
  520. if (!type)
  521. return nullptr;
  522. HashMap<asITypeInfo*, HashMap<String, asIScriptFunction*>>::ConstIterator i = methods_.Find(type);
  523. if (i != methods_.End())
  524. {
  525. HashMap<String, asIScriptFunction*>::ConstIterator j = i->second_.Find(trimDecl);
  526. if (j != i->second_.End())
  527. return j->second_;
  528. }
  529. asIScriptFunction* function = type->GetMethodByDecl(trimDecl.CString());
  530. methods_[type][trimDecl] = function;
  531. return function;
  532. }
  533. void ScriptFile::CleanupEventInvoker(asIScriptObject* object)
  534. {
  535. eventInvokers_.Erase(object);
  536. }
  537. void ScriptFile::AddEventHandlerInternal(Object* sender, StringHash eventType, const String& handlerName)
  538. {
  539. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  540. asIScriptFunction* function = nullptr;
  541. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  542. if (receiver)
  543. function = GetMethod(receiver, declaration);
  544. else
  545. function = GetFunction(declaration);
  546. if (!function)
  547. {
  548. // Retry with parameterless signature
  549. if (receiver)
  550. function = GetMethod(receiver, handlerName);
  551. else
  552. function = GetFunction(handlerName);
  553. if (!function)
  554. {
  555. URHO3D_LOGERROR("Event handler function " + handlerName + " not found in " + GetName());
  556. return;
  557. }
  558. }
  559. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker>>::Iterator i = eventInvokers_.Find(receiver);
  560. // Remove previous handler in case an object pointer gets reused
  561. if (i != eventInvokers_.End() && !i->second_->IsObjectAlive())
  562. {
  563. eventInvokers_.Erase(i);
  564. i = eventInvokers_.End();
  565. }
  566. if (i == eventInvokers_.End())
  567. i = eventInvokers_.Insert(MakePair(receiver, SharedPtr<ScriptEventInvoker>(new ScriptEventInvoker(this, receiver))));
  568. if (!sender)
  569. {
  570. i->second_->SubscribeToEvent(eventType, new EventHandlerImpl<ScriptEventInvoker>
  571. (i->second_, &ScriptEventInvoker::HandleScriptEvent, (void*)function));
  572. }
  573. else
  574. {
  575. i->second_->SubscribeToEvent(sender, eventType, new EventHandlerImpl<ScriptEventInvoker>
  576. (i->second_, &ScriptEventInvoker::HandleScriptEvent, (void*)function));
  577. }
  578. }
  579. bool ScriptFile::AddScriptSection(asIScriptEngine* engine, Deserializer& source)
  580. {
  581. auto* cache = GetSubsystem<ResourceCache>();
  582. unsigned dataSize = source.GetSize();
  583. SharedArrayPtr<char> buffer(new char[dataSize]);
  584. source.Read((void*)buffer.Get(), dataSize);
  585. // Pre-parse for includes
  586. // Adapted from Angelscript's scriptbuilder add-on
  587. Vector<String> includeFiles;
  588. unsigned pos = 0;
  589. while (pos < dataSize)
  590. {
  591. unsigned len;
  592. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  593. if (t == asTC_COMMENT || t == asTC_WHITESPACE)
  594. {
  595. pos += len;
  596. continue;
  597. }
  598. // Is this a preprocessor directive?
  599. if (buffer[pos] == '#')
  600. {
  601. int start = pos++;
  602. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  603. if (t == asTC_IDENTIFIER)
  604. {
  605. String token(&buffer[pos], (unsigned)len);
  606. if (token == "include")
  607. {
  608. pos += len;
  609. t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  610. if (t == asTC_WHITESPACE)
  611. {
  612. pos += len;
  613. t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  614. }
  615. if (t == asTC_VALUE && len > 2 && buffer[pos] == '"')
  616. {
  617. // Get the include file
  618. String includeFile(&buffer[pos + 1], (unsigned)(len - 2));
  619. pos += len;
  620. // If the file is not found as it is, add the path of current file but only if it is found there
  621. if (!cache->Exists(includeFile))
  622. {
  623. String prefixedIncludeFile = GetPath(GetName()) + includeFile;
  624. if (cache->Exists(prefixedIncludeFile))
  625. includeFile = prefixedIncludeFile;
  626. }
  627. String includeFileLower = includeFile.ToLower();
  628. // If not included yet, store it for later processing
  629. if (!includeFiles_.Contains(includeFileLower))
  630. {
  631. includeFiles_.Insert(includeFileLower);
  632. includeFiles.Push(includeFile);
  633. }
  634. // Overwrite the include directive with space characters to avoid compiler error
  635. memset(&buffer[start], ' ', pos - start);
  636. }
  637. }
  638. }
  639. }
  640. // Don't search includes within statement blocks or between tokens in statements
  641. else
  642. {
  643. unsigned len;
  644. // Skip until ; or { whichever comes first
  645. while (pos < dataSize && buffer[pos] != ';' && buffer[pos] != '{')
  646. {
  647. engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  648. pos += len;
  649. }
  650. // Skip entire statement block
  651. if (pos < dataSize && buffer[pos] == '{')
  652. {
  653. ++pos;
  654. // Find the end of the statement block
  655. int level = 1;
  656. while (level > 0 && pos < dataSize)
  657. {
  658. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  659. if (t == asTC_KEYWORD)
  660. {
  661. if (buffer[pos] == '{')
  662. ++level;
  663. else if (buffer[pos] == '}')
  664. --level;
  665. }
  666. pos += len;
  667. }
  668. }
  669. else
  670. ++pos;
  671. }
  672. }
  673. // Process includes first
  674. for (unsigned i = 0; i < includeFiles.Size(); ++i)
  675. {
  676. cache->StoreResourceDependency(this, includeFiles[i]);
  677. SharedPtr<File> file = cache->GetFile(includeFiles[i]);
  678. if (file)
  679. {
  680. if (!AddScriptSection(engine, *file))
  681. return false;
  682. }
  683. else
  684. {
  685. URHO3D_LOGERROR("Could not process all the include directives in " + GetName() + ": missing " + includeFiles[i]);
  686. return false;
  687. }
  688. }
  689. // Then add this section
  690. if (scriptModule_->AddScriptSection(source.GetName().CString(), (const char*)buffer.Get(), dataSize) < 0)
  691. {
  692. URHO3D_LOGERROR("Failed to add script section " + source.GetName());
  693. return false;
  694. }
  695. SetMemoryUse(GetMemoryUse() + dataSize);
  696. return true;
  697. }
  698. void ScriptFile::SetParameters(asIScriptContext* context, asIScriptFunction* function, const VariantVector& parameters)
  699. {
  700. unsigned paramCount = function->GetParamCount();
  701. for (unsigned i = 0; i < parameters.Size() && i < paramCount; ++i)
  702. {
  703. int paramTypeId;
  704. function->GetParam(i, &paramTypeId);
  705. switch (paramTypeId)
  706. {
  707. case asTYPEID_BOOL:
  708. context->SetArgByte(i, (unsigned char)parameters[i].GetBool());
  709. break;
  710. case asTYPEID_INT8:
  711. case asTYPEID_UINT8:
  712. context->SetArgByte(i, (asBYTE)parameters[i].GetInt());
  713. break;
  714. case asTYPEID_INT16:
  715. case asTYPEID_UINT16:
  716. context->SetArgWord(i, (asWORD)parameters[i].GetInt());
  717. break;
  718. case asTYPEID_INT32:
  719. case asTYPEID_UINT32:
  720. context->SetArgDWord(i, (asDWORD)parameters[i].GetInt());
  721. break;
  722. case asTYPEID_INT64:
  723. case asTYPEID_UINT64:
  724. context->SetArgQWord(i, (asQWORD)parameters[i].GetInt64());
  725. break;
  726. case asTYPEID_FLOAT:
  727. context->SetArgFloat(i, parameters[i].GetFloat());
  728. break;
  729. default:
  730. if (paramTypeId & asTYPEID_APPOBJECT)
  731. {
  732. switch (parameters[i].GetType())
  733. {
  734. case VAR_VECTOR2:
  735. context->SetArgObject(i, (void*)&parameters[i].GetVector2());
  736. break;
  737. case VAR_VECTOR3:
  738. context->SetArgObject(i, (void*)&parameters[i].GetVector3());
  739. break;
  740. case VAR_VECTOR4:
  741. context->SetArgObject(i, (void*)&parameters[i].GetVector4());
  742. break;
  743. case VAR_QUATERNION:
  744. context->SetArgObject(i, (void*)&parameters[i].GetQuaternion());
  745. break;
  746. case VAR_STRING:
  747. context->SetArgObject(i, (void*)&parameters[i].GetString());
  748. break;
  749. case VAR_VARIANTMAP:
  750. context->SetArgObject(i, (void*)&parameters[i].GetVariantMap());
  751. break;
  752. case VAR_INTRECT:
  753. context->SetArgObject(i, (void*)&parameters[i].GetIntRect());
  754. break;
  755. case VAR_INTVECTOR2:
  756. context->SetArgObject(i, (void*)&parameters[i].GetIntVector2());
  757. break;
  758. case VAR_INTVECTOR3:
  759. context->SetArgObject(i, (void*)&parameters[i].GetIntVector3());
  760. break;
  761. case VAR_COLOR:
  762. context->SetArgObject(i, (void*)&parameters[i].GetColor());
  763. break;
  764. case VAR_MATRIX3:
  765. context->SetArgObject(i, (void*)&parameters[i].GetMatrix3());
  766. break;
  767. case VAR_MATRIX3X4:
  768. context->SetArgObject(i, (void*)&parameters[i].GetMatrix3x4());
  769. break;
  770. case VAR_MATRIX4:
  771. context->SetArgObject(i, (void*)&parameters[i].GetMatrix4());
  772. break;
  773. case VAR_RESOURCEREF:
  774. context->SetArgObject(i, (void*)&parameters[i].GetResourceRef());
  775. break;
  776. case VAR_RESOURCEREFLIST:
  777. context->SetArgObject(i, (void*)&parameters[i].GetResourceRefList());
  778. break;
  779. case VAR_VOIDPTR:
  780. context->SetArgObject(i, parameters[i].GetVoidPtr());
  781. break;
  782. case VAR_PTR:
  783. context->SetArgObject(i, (void*)parameters[i].GetPtr());
  784. break;
  785. default:
  786. break;
  787. }
  788. }
  789. break;
  790. }
  791. }
  792. }
  793. void ScriptFile::ReleaseModule()
  794. {
  795. if (scriptModule_)
  796. {
  797. // Clear search caches and event handlers
  798. includeFiles_.Clear();
  799. validClasses_.Clear();
  800. functions_.Clear();
  801. methods_.Clear();
  802. delayedCalls_.Clear();
  803. eventInvokers_.Clear();
  804. asIScriptEngine* engine = script_->GetScriptEngine();
  805. scriptModule_->SetUserData(nullptr);
  806. // Remove the module
  807. {
  808. MutexLock lock(script_->GetModuleMutex());
  809. script_->ClearObjectTypeCache();
  810. engine->DiscardModule(GetName().CString());
  811. }
  812. scriptModule_ = nullptr;
  813. compiled_ = false;
  814. SetMemoryUse(0);
  815. auto* cache = GetSubsystem<ResourceCache>();
  816. if (cache)
  817. cache->ResetDependencies(this);
  818. }
  819. }
  820. void ScriptFile::HandleUpdate(StringHash eventType, VariantMap& eventData)
  821. {
  822. if (!compiled_)
  823. return;
  824. using namespace Update;
  825. float timeStep = eventData[P_TIMESTEP].GetFloat();
  826. // Execute delayed calls
  827. for (unsigned i = 0; i < delayedCalls_.Size();)
  828. {
  829. DelayedCall& call = delayedCalls_[i];
  830. bool remove = false;
  831. call.delay_ -= timeStep;
  832. if (call.delay_ <= 0.0f)
  833. {
  834. if (!call.repeat_)
  835. remove = true;
  836. else
  837. call.delay_ += call.period_;
  838. Execute(call.declaration_, call.parameters_);
  839. }
  840. if (remove)
  841. delayedCalls_.Erase(i);
  842. else
  843. ++i;
  844. }
  845. }
  846. ScriptEventInvoker::ScriptEventInvoker(ScriptFile* file, asIScriptObject* object) :
  847. Object(file->GetContext()),
  848. file_(file),
  849. sharedBool_(nullptr),
  850. object_(object)
  851. {
  852. if (object_)
  853. {
  854. sharedBool_ = object_->GetEngine()->GetWeakRefFlagOfScriptObject(object_, object_->GetObjectType());
  855. if (sharedBool_)
  856. sharedBool_->AddRef();
  857. }
  858. }
  859. ScriptEventInvoker::~ScriptEventInvoker()
  860. {
  861. if (sharedBool_)
  862. sharedBool_->Release();
  863. sharedBool_ = nullptr;
  864. object_ = nullptr;
  865. }
  866. bool ScriptEventInvoker::IsObjectAlive() const
  867. {
  868. if (sharedBool_)
  869. {
  870. // Return inverse as Get returns true when an asIScriptObject is dead.
  871. return !sharedBool_->Get();
  872. }
  873. return true;
  874. }
  875. void ScriptEventInvoker::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  876. {
  877. if (!file_->IsCompiled())
  878. return;
  879. auto* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  880. if (object_ && !IsObjectAlive())
  881. {
  882. file_->CleanupEventInvoker(object_);
  883. return;
  884. }
  885. VariantVector parameters;
  886. if (method->GetParamCount() > 0)
  887. {
  888. parameters.Push(Variant((void*)&eventType));
  889. parameters.Push(Variant((void*)&eventData));
  890. }
  891. if (object_)
  892. file_->Execute(object_, method, parameters);
  893. else
  894. file_->Execute(method, parameters);
  895. }
  896. ScriptFile* GetScriptContextFile()
  897. {
  898. asIScriptContext* context = asGetActiveContext();
  899. asIScriptFunction* function = context ? context->GetFunction() : nullptr;
  900. asIScriptModule* module = function ? function->GetEngine()->GetModule(function->GetModuleName()) : nullptr;
  901. if (module)
  902. return static_cast<ScriptFile*>(module->GetUserData());
  903. else
  904. return nullptr;
  905. }
  906. }