ScriptFile.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086
  1. //
  2. // Copyright (c) 2008-2019 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. /// Execute a function and return result.
  264. bool ScriptFile::Execute(asIScriptFunction* function, const VariantVector& parameters, Variant* functionReturn, bool unprepare)
  265. {
  266. URHO3D_PROFILE(ExecuteFunction);
  267. if (!compiled_ || !function)
  268. return false;
  269. // It is possible that executing the function causes us to unload. Therefore do not rely on member variables
  270. // However, we are not prepared for the whole script system getting destroyed during execution (should never happen)
  271. Script* scriptSystem = script_;
  272. asIScriptContext* context = scriptSystem->GetScriptFileContext();
  273. if (context->Prepare(function) < 0)
  274. return false;
  275. SetParameters(context, function, parameters);
  276. scriptSystem->IncScriptNestingLevel();
  277. bool success = (context->Execute() == asEXECUTION_FINISHED);
  278. if(success && (functionReturn!=nullptr))
  279. {
  280. const int typeId = function->GetReturnTypeId();
  281. asIScriptEngine* engine = script_->GetScriptEngine();
  282. asITypeInfo * typeInfo = engine->GetTypeInfoById(typeId);
  283. // Built-in type
  284. if(typeInfo == nullptr)
  285. {
  286. switch(typeId)
  287. {
  288. case asTYPEID_VOID:
  289. *functionReturn = Variant();
  290. break;
  291. case asTYPEID_BOOL:
  292. *functionReturn = Variant(context->GetReturnByte()>0);
  293. break;
  294. case asTYPEID_INT8:
  295. case asTYPEID_UINT8:
  296. case asTYPEID_INT16:
  297. case asTYPEID_UINT16:
  298. case asTYPEID_INT32:
  299. case asTYPEID_UINT32:
  300. *functionReturn = Variant(static_cast<int>(context->GetReturnDWord()));
  301. break;
  302. case asTYPEID_INT64:
  303. case asTYPEID_UINT64:
  304. *functionReturn = Variant(static_cast<long long>(context->GetReturnQWord()));
  305. break;
  306. case asTYPEID_FLOAT:
  307. *functionReturn = Variant(context->GetReturnFloat());
  308. break;
  309. case asTYPEID_DOUBLE:
  310. *functionReturn = Variant(context->GetReturnDouble());
  311. break;
  312. }
  313. }
  314. else if(typeInfo->GetFlags() & asOBJ_REF)
  315. {
  316. *functionReturn = Variant(static_cast<RefCounted*>(context->GetReturnObject()));
  317. }
  318. else if(typeInfo->GetFlags() & asOBJ_VALUE)
  319. {
  320. void * returnedObject = context->GetReturnObject();
  321. const VariantType variantType = Variant::GetTypeFromName(typeInfo->GetName());
  322. switch(variantType)
  323. {
  324. case VAR_STRING:
  325. *functionReturn = *static_cast<String*>(returnedObject);
  326. break;
  327. case VAR_VECTOR2:
  328. *functionReturn = *static_cast<Vector2*>(returnedObject);
  329. break;
  330. case VAR_VECTOR3:
  331. *functionReturn = *static_cast<Vector3*>(returnedObject);
  332. break;
  333. case VAR_VECTOR4:
  334. *functionReturn = *static_cast<Vector4*>(returnedObject);
  335. break;
  336. case VAR_QUATERNION:
  337. *functionReturn = *static_cast<Quaternion*>(returnedObject);
  338. break;
  339. case VAR_COLOR:
  340. *functionReturn = *static_cast<Color*>(returnedObject);
  341. break;
  342. case VAR_INTRECT:
  343. *functionReturn = *static_cast<IntRect*>(returnedObject);
  344. break;
  345. case VAR_INTVECTOR2:
  346. *functionReturn = *static_cast<IntVector2*>(returnedObject);
  347. break;
  348. case VAR_MATRIX3:
  349. *functionReturn = *static_cast<Matrix3*>(returnedObject);
  350. break;
  351. case VAR_MATRIX3X4:
  352. *functionReturn = *static_cast<Matrix3x4*>(returnedObject);
  353. break;
  354. case VAR_MATRIX4:
  355. *functionReturn = *static_cast<Matrix4*>(returnedObject);
  356. break;
  357. case VAR_RECT:
  358. *functionReturn = *static_cast<Rect*>(returnedObject);
  359. break;
  360. case VAR_INTVECTOR3:
  361. *functionReturn = *static_cast<IntVector3*>(returnedObject);
  362. break;
  363. default:
  364. URHO3D_LOGERROR("Return type is not supported" + String(typeInfo->GetName()));
  365. break;
  366. }
  367. }
  368. else
  369. {
  370. URHO3D_LOGERROR("Return type is not supported" + String(typeInfo->GetName()));
  371. }
  372. }
  373. if (unprepare)
  374. context->Unprepare();
  375. scriptSystem->DecScriptNestingLevel();
  376. return success;
  377. }
  378. bool ScriptFile::Execute(asIScriptObject* object, const String& declaration, const VariantVector& parameters, Variant* functionReturn, 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, bool unprepare)
  391. {
  392. URHO3D_PROFILE(ExecuteMethod);
  393. if (!compiled_ || !object || !method)
  394. return false;
  395. // It is possible that executing the method causes us to unload. Therefore do not rely on member variables
  396. // However, we are not prepared for the whole script system getting destroyed during execution (should never happen)
  397. Script* scriptSystem = script_;
  398. asIScriptContext* context = scriptSystem->GetScriptFileContext();
  399. if (context->Prepare(method) < 0)
  400. return false;
  401. context->SetObject(object);
  402. SetParameters(context, method, parameters);
  403. scriptSystem->IncScriptNestingLevel();
  404. bool success = context->Execute() >= 0;
  405. if (unprepare)
  406. context->Unprepare();
  407. scriptSystem->DecScriptNestingLevel();
  408. return success;
  409. }
  410. void ScriptFile::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  411. {
  412. DelayedCall call;
  413. call.period_ = call.delay_ = Max(delay, 0.0f);
  414. call.repeat_ = repeat;
  415. call.declaration_ = declaration;
  416. call.parameters_ = parameters;
  417. delayedCalls_.Push(call);
  418. // Make sure we are registered to the application update event, because delayed calls are executed there
  419. if (!subscribed_)
  420. {
  421. SubscribeToEvent(E_UPDATE, URHO3D_HANDLER(ScriptFile, HandleUpdate));
  422. subscribed_ = true;
  423. }
  424. }
  425. void ScriptFile::ClearDelayedExecute(const String& declaration)
  426. {
  427. if (declaration.Empty())
  428. delayedCalls_.Clear();
  429. else
  430. {
  431. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End();)
  432. {
  433. if (declaration == i->declaration_)
  434. i = delayedCalls_.Erase(i);
  435. else
  436. ++i;
  437. }
  438. }
  439. }
  440. asIScriptObject* ScriptFile::CreateObject(const String& className, bool useInterface)
  441. {
  442. URHO3D_PROFILE(CreateObject);
  443. if (!compiled_)
  444. return nullptr;
  445. asIScriptContext* context = script_->GetScriptFileContext();
  446. asITypeInfo* type = nullptr;
  447. if (useInterface)
  448. {
  449. asITypeInfo* interfaceType = scriptModule_->GetTypeInfoByDecl(className.CString());
  450. if (!interfaceType)
  451. return nullptr;
  452. for (unsigned i = 0; i < scriptModule_->GetObjectTypeCount(); ++i)
  453. {
  454. asITypeInfo* t = scriptModule_->GetObjectTypeByIndex(i);
  455. if (t->Implements(interfaceType))
  456. {
  457. type = t;
  458. break;
  459. }
  460. }
  461. }
  462. else
  463. {
  464. type = scriptModule_->GetTypeInfoByDecl(className.CString());
  465. }
  466. if (!type)
  467. return nullptr;
  468. // Ensure that the type implements the "ScriptObject" interface, so it can be returned to script properly
  469. bool found;
  470. HashMap<asITypeInfo*, bool>::ConstIterator i = validClasses_.Find(type);
  471. if (i != validClasses_.End())
  472. found = i->second_;
  473. else
  474. {
  475. asITypeInfo* scriptObjectType = scriptModule_->GetTypeInfoByDecl("ScriptObject");
  476. found = type->Implements(scriptObjectType);
  477. validClasses_[type] = found;
  478. }
  479. if (!found)
  480. {
  481. URHO3D_LOGERRORF("Script class %s does not implement the ScriptObject interface", type->GetName());
  482. return nullptr;
  483. }
  484. // Get the factory function id from the object type
  485. String factoryName = String(type->GetName()) + "@ " + type->GetName() + "()";
  486. asIScriptFunction* factory = type->GetFactoryByDecl(factoryName.CString());
  487. if (!factory || context->Prepare(factory) < 0 || context->Execute() < 0)
  488. return nullptr;
  489. void* objAddress = context->GetAddressOfReturnValue();
  490. if (!objAddress)
  491. return nullptr;
  492. asIScriptObject* obj = *(static_cast<asIScriptObject**>(objAddress));
  493. if (obj)
  494. obj->AddRef();
  495. return obj;
  496. }
  497. bool ScriptFile::SaveByteCode(Serializer& dest)
  498. {
  499. if (compiled_)
  500. {
  501. dest.WriteFileID("ASBC");
  502. ByteCodeSerializer serializer = ByteCodeSerializer(dest);
  503. return scriptModule_->SaveByteCode(&serializer, true) >= 0;
  504. }
  505. else
  506. return false;
  507. }
  508. asIScriptFunction* ScriptFile::GetFunction(const String& declaration)
  509. {
  510. if (!compiled_)
  511. return nullptr;
  512. String trimDecl = declaration.Trimmed();
  513. // If not a full trimDecl, assume void with no parameters
  514. if (trimDecl.Find('(') == String::NPOS)
  515. trimDecl = "void " + trimDecl + "()";
  516. HashMap<String, asIScriptFunction*>::ConstIterator i = functions_.Find(trimDecl);
  517. if (i != functions_.End())
  518. return i->second_;
  519. asIScriptFunction* function = scriptModule_->GetFunctionByDecl(trimDecl.CString());
  520. functions_[trimDecl] = function;
  521. return function;
  522. }
  523. asIScriptFunction* ScriptFile::GetMethod(asIScriptObject* object, const String& declaration)
  524. {
  525. if (!compiled_ || !object)
  526. return nullptr;
  527. String trimDecl = declaration.Trimmed();
  528. // If not a full trimDecl, assume void with no parameters
  529. if (trimDecl.Find('(') == String::NPOS)
  530. trimDecl = "void " + trimDecl + "()";
  531. asITypeInfo* type = object->GetObjectType();
  532. if (!type)
  533. return nullptr;
  534. HashMap<asITypeInfo*, HashMap<String, asIScriptFunction*> >::ConstIterator i = methods_.Find(type);
  535. if (i != methods_.End())
  536. {
  537. HashMap<String, asIScriptFunction*>::ConstIterator j = i->second_.Find(trimDecl);
  538. if (j != i->second_.End())
  539. return j->second_;
  540. }
  541. asIScriptFunction* function = type->GetMethodByDecl(trimDecl.CString());
  542. methods_[type][trimDecl] = function;
  543. return function;
  544. }
  545. void ScriptFile::CleanupEventInvoker(asIScriptObject* object)
  546. {
  547. eventInvokers_.Erase(object);
  548. }
  549. void ScriptFile::AddEventHandlerInternal(Object* sender, StringHash eventType, const String& handlerName)
  550. {
  551. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  552. asIScriptFunction* function = nullptr;
  553. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  554. if (receiver)
  555. function = GetMethod(receiver, declaration);
  556. else
  557. function = GetFunction(declaration);
  558. if (!function)
  559. {
  560. // Retry with parameterless signature
  561. if (receiver)
  562. function = GetMethod(receiver, handlerName);
  563. else
  564. function = GetFunction(handlerName);
  565. if (!function)
  566. {
  567. URHO3D_LOGERROR("Event handler function " + handlerName + " not found in " + GetName());
  568. return;
  569. }
  570. }
  571. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker> >::Iterator i = eventInvokers_.Find(receiver);
  572. // Remove previous handler in case an object pointer gets reused
  573. if (i != eventInvokers_.End() && !i->second_->IsObjectAlive())
  574. {
  575. eventInvokers_.Erase(i);
  576. i = eventInvokers_.End();
  577. }
  578. if (i == eventInvokers_.End())
  579. i = eventInvokers_.Insert(MakePair(receiver, SharedPtr<ScriptEventInvoker>(new ScriptEventInvoker(this, receiver))));
  580. if (!sender)
  581. {
  582. i->second_->SubscribeToEvent(eventType, new EventHandlerImpl<ScriptEventInvoker>
  583. (i->second_, &ScriptEventInvoker::HandleScriptEvent, (void*)function));
  584. }
  585. else
  586. {
  587. i->second_->SubscribeToEvent(sender, eventType, new EventHandlerImpl<ScriptEventInvoker>
  588. (i->second_, &ScriptEventInvoker::HandleScriptEvent, (void*)function));
  589. }
  590. }
  591. bool ScriptFile::AddScriptSection(asIScriptEngine* engine, Deserializer& source)
  592. {
  593. auto* cache = GetSubsystem<ResourceCache>();
  594. unsigned dataSize = source.GetSize();
  595. SharedArrayPtr<char> buffer(new char[dataSize]);
  596. source.Read((void*)buffer.Get(), dataSize);
  597. // Pre-parse for includes
  598. // Adapted from Angelscript's scriptbuilder add-on
  599. Vector<String> includeFiles;
  600. unsigned pos = 0;
  601. while (pos < dataSize)
  602. {
  603. unsigned len;
  604. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  605. if (t == asTC_COMMENT || t == asTC_WHITESPACE)
  606. {
  607. pos += len;
  608. continue;
  609. }
  610. // Is this a preprocessor directive?
  611. if (buffer[pos] == '#')
  612. {
  613. int start = pos++;
  614. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  615. if (t == asTC_IDENTIFIER)
  616. {
  617. String token(&buffer[pos], (unsigned)len);
  618. if (token == "include")
  619. {
  620. pos += len;
  621. t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  622. if (t == asTC_WHITESPACE)
  623. {
  624. pos += len;
  625. t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  626. }
  627. if (t == asTC_VALUE && len > 2 && buffer[pos] == '"')
  628. {
  629. // Get the include file
  630. String includeFile(&buffer[pos + 1], (unsigned)(len - 2));
  631. pos += len;
  632. // If the file is not found as it is, add the path of current file but only if it is found there
  633. if (!cache->Exists(includeFile))
  634. {
  635. String prefixedIncludeFile = GetPath(GetName()) + includeFile;
  636. if (cache->Exists(prefixedIncludeFile))
  637. includeFile = prefixedIncludeFile;
  638. }
  639. String includeFileLower = includeFile.ToLower();
  640. // If not included yet, store it for later processing
  641. if (!includeFiles_.Contains(includeFileLower))
  642. {
  643. includeFiles_.Insert(includeFileLower);
  644. includeFiles.Push(includeFile);
  645. }
  646. // Overwrite the include directive with space characters to avoid compiler error
  647. memset(&buffer[start], ' ', pos - start);
  648. }
  649. }
  650. }
  651. }
  652. // Don't search includes within statement blocks or between tokens in statements
  653. else
  654. {
  655. unsigned len;
  656. // Skip until ; or { whichever comes first
  657. while (pos < dataSize && buffer[pos] != ';' && buffer[pos] != '{')
  658. {
  659. engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  660. pos += len;
  661. }
  662. // Skip entire statement block
  663. if (pos < dataSize && buffer[pos] == '{')
  664. {
  665. ++pos;
  666. // Find the end of the statement block
  667. int level = 1;
  668. while (level > 0 && pos < dataSize)
  669. {
  670. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  671. if (t == asTC_KEYWORD)
  672. {
  673. if (buffer[pos] == '{')
  674. ++level;
  675. else if (buffer[pos] == '}')
  676. --level;
  677. }
  678. pos += len;
  679. }
  680. }
  681. else
  682. ++pos;
  683. }
  684. }
  685. // Process includes first
  686. for (unsigned i = 0; i < includeFiles.Size(); ++i)
  687. {
  688. cache->StoreResourceDependency(this, includeFiles[i]);
  689. SharedPtr<File> file = cache->GetFile(includeFiles[i]);
  690. if (file)
  691. {
  692. if (!AddScriptSection(engine, *file))
  693. return false;
  694. }
  695. else
  696. {
  697. URHO3D_LOGERROR("Could not process all the include directives in " + GetName() + ": missing " + includeFiles[i]);
  698. return false;
  699. }
  700. }
  701. // Then add this section
  702. if (scriptModule_->AddScriptSection(source.GetName().CString(), (const char*)buffer.Get(), dataSize) < 0)
  703. {
  704. URHO3D_LOGERROR("Failed to add script section " + source.GetName());
  705. return false;
  706. }
  707. SetMemoryUse(GetMemoryUse() + dataSize);
  708. return true;
  709. }
  710. void ScriptFile::SetParameters(asIScriptContext* context, asIScriptFunction* function, const VariantVector& parameters)
  711. {
  712. unsigned paramCount = function->GetParamCount();
  713. for (unsigned i = 0; i < parameters.Size() && i < paramCount; ++i)
  714. {
  715. int paramTypeId;
  716. function->GetParam(i, &paramTypeId);
  717. switch (paramTypeId)
  718. {
  719. case asTYPEID_BOOL:
  720. context->SetArgByte(i, (unsigned char)parameters[i].GetBool());
  721. break;
  722. case asTYPEID_INT8:
  723. case asTYPEID_UINT8:
  724. context->SetArgByte(i, (asBYTE)parameters[i].GetInt());
  725. break;
  726. case asTYPEID_INT16:
  727. case asTYPEID_UINT16:
  728. context->SetArgWord(i, (asWORD)parameters[i].GetInt());
  729. break;
  730. case asTYPEID_INT32:
  731. case asTYPEID_UINT32:
  732. context->SetArgDWord(i, (asDWORD)parameters[i].GetInt());
  733. break;
  734. case asTYPEID_FLOAT:
  735. context->SetArgFloat(i, parameters[i].GetFloat());
  736. break;
  737. default:
  738. if (paramTypeId & asTYPEID_APPOBJECT)
  739. {
  740. switch (parameters[i].GetType())
  741. {
  742. case VAR_VECTOR2:
  743. context->SetArgObject(i, (void*)&parameters[i].GetVector2());
  744. break;
  745. case VAR_VECTOR3:
  746. context->SetArgObject(i, (void*)&parameters[i].GetVector3());
  747. break;
  748. case VAR_VECTOR4:
  749. context->SetArgObject(i, (void*)&parameters[i].GetVector4());
  750. break;
  751. case VAR_QUATERNION:
  752. context->SetArgObject(i, (void*)&parameters[i].GetQuaternion());
  753. break;
  754. case VAR_STRING:
  755. context->SetArgObject(i, (void*)&parameters[i].GetString());
  756. break;
  757. case VAR_VARIANTMAP:
  758. context->SetArgObject(i, (void*)&parameters[i].GetVariantMap());
  759. break;
  760. case VAR_INTRECT:
  761. context->SetArgObject(i, (void*)&parameters[i].GetIntRect());
  762. break;
  763. case VAR_INTVECTOR2:
  764. context->SetArgObject(i, (void*)&parameters[i].GetIntVector2());
  765. break;
  766. case VAR_INTVECTOR3:
  767. context->SetArgObject(i, (void*)&parameters[i].GetIntVector3());
  768. break;
  769. case VAR_COLOR:
  770. context->SetArgObject(i, (void*)&parameters[i].GetColor());
  771. break;
  772. case VAR_MATRIX3:
  773. context->SetArgObject(i, (void*)&parameters[i].GetMatrix3());
  774. break;
  775. case VAR_MATRIX3X4:
  776. context->SetArgObject(i, (void*)&parameters[i].GetMatrix3x4());
  777. break;
  778. case VAR_MATRIX4:
  779. context->SetArgObject(i, (void*)&parameters[i].GetMatrix4());
  780. break;
  781. case VAR_RESOURCEREF:
  782. context->SetArgObject(i, (void*)&parameters[i].GetResourceRef());
  783. break;
  784. case VAR_RESOURCEREFLIST:
  785. context->SetArgObject(i, (void*)&parameters[i].GetResourceRefList());
  786. break;
  787. case VAR_VOIDPTR:
  788. context->SetArgObject(i, parameters[i].GetVoidPtr());
  789. break;
  790. case VAR_PTR:
  791. context->SetArgObject(i, (void*)parameters[i].GetPtr());
  792. break;
  793. default:
  794. break;
  795. }
  796. }
  797. break;
  798. }
  799. }
  800. }
  801. void ScriptFile::ReleaseModule()
  802. {
  803. if (scriptModule_)
  804. {
  805. // Clear search caches and event handlers
  806. includeFiles_.Clear();
  807. validClasses_.Clear();
  808. functions_.Clear();
  809. methods_.Clear();
  810. delayedCalls_.Clear();
  811. eventInvokers_.Clear();
  812. asIScriptEngine* engine = script_->GetScriptEngine();
  813. scriptModule_->SetUserData(nullptr);
  814. // Remove the module
  815. {
  816. MutexLock lock(script_->GetModuleMutex());
  817. script_->ClearObjectTypeCache();
  818. engine->DiscardModule(GetName().CString());
  819. }
  820. scriptModule_ = nullptr;
  821. compiled_ = false;
  822. SetMemoryUse(0);
  823. auto* cache = GetSubsystem<ResourceCache>();
  824. if (cache)
  825. cache->ResetDependencies(this);
  826. }
  827. }
  828. void ScriptFile::HandleUpdate(StringHash eventType, VariantMap& eventData)
  829. {
  830. if (!compiled_)
  831. return;
  832. using namespace Update;
  833. float timeStep = eventData[P_TIMESTEP].GetFloat();
  834. // Execute delayed calls
  835. for (unsigned i = 0; i < delayedCalls_.Size();)
  836. {
  837. DelayedCall& call = delayedCalls_[i];
  838. bool remove = false;
  839. call.delay_ -= timeStep;
  840. if (call.delay_ <= 0.0f)
  841. {
  842. if (!call.repeat_)
  843. remove = true;
  844. else
  845. call.delay_ += call.period_;
  846. Execute(call.declaration_, call.parameters_);
  847. }
  848. if (remove)
  849. delayedCalls_.Erase(i);
  850. else
  851. ++i;
  852. }
  853. }
  854. ScriptEventInvoker::ScriptEventInvoker(ScriptFile* file, asIScriptObject* object) :
  855. Object(file->GetContext()),
  856. file_(file),
  857. sharedBool_(nullptr),
  858. object_(object)
  859. {
  860. if (object_)
  861. {
  862. sharedBool_ = object_->GetEngine()->GetWeakRefFlagOfScriptObject(object_, object_->GetObjectType());
  863. if (sharedBool_)
  864. sharedBool_->AddRef();
  865. }
  866. }
  867. ScriptEventInvoker::~ScriptEventInvoker()
  868. {
  869. if (sharedBool_)
  870. sharedBool_->Release();
  871. sharedBool_ = nullptr;
  872. object_ = nullptr;
  873. }
  874. bool ScriptEventInvoker::IsObjectAlive() const
  875. {
  876. if (sharedBool_)
  877. {
  878. // Return inverse as Get returns true when an asIScriptObject is dead.
  879. return !sharedBool_->Get();
  880. }
  881. return true;
  882. }
  883. void ScriptEventInvoker::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  884. {
  885. if (!file_->IsCompiled())
  886. return;
  887. auto* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  888. if (object_ && !IsObjectAlive())
  889. {
  890. file_->CleanupEventInvoker(object_);
  891. return;
  892. }
  893. VariantVector parameters;
  894. if (method->GetParamCount() > 0)
  895. {
  896. parameters.Push(Variant((void*)&eventType));
  897. parameters.Push(Variant((void*)&eventData));
  898. }
  899. if (object_)
  900. file_->Execute(object_, method, parameters);
  901. else
  902. file_->Execute(method, parameters);
  903. }
  904. ScriptFile* GetScriptContextFile()
  905. {
  906. asIScriptContext* context = asGetActiveContext();
  907. asIScriptFunction* function = context ? context->GetFunction() : nullptr;
  908. asIScriptModule* module = function ? function->GetEngine()->GetModule(function->GetModuleName()) : nullptr;
  909. if (module)
  910. return static_cast<ScriptFile*>(module->GetUserData());
  911. else
  912. return nullptr;
  913. }
  914. }