ScriptFile.cpp 34 KB

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