2
0

ScriptFile.cpp 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097
  1. //
  2. // Copyright (c) 2008-2022 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. // Map script module to script resource with userdata
  132. scriptModule_->SetUserData(this);
  133. // Load from bytecode if available, else compile
  134. if (loadByteCode_)
  135. {
  136. MemoryBuffer buffer(loadByteCode_.Get(), loadByteCodeSize_);
  137. ByteCodeDeserializer deserializer = ByteCodeDeserializer(buffer);
  138. if (scriptModule_->LoadByteCode(&deserializer) >= 0)
  139. {
  140. URHO3D_LOGINFO("Loaded script module " + GetName() + " from bytecode");
  141. success = true;
  142. }
  143. }
  144. else
  145. {
  146. if (onlyCompile_)
  147. scriptModule_->GetEngine()->SetEngineProperty(asEP_INIT_GLOBAL_VARS_AFTER_BUILD, 0);
  148. int result = scriptModule_->Build();
  149. if (result >= 0)
  150. {
  151. URHO3D_LOGINFO("Compiled script module " + GetName());
  152. success = true;
  153. }
  154. else
  155. URHO3D_LOGERROR("Failed to compile script module " + GetName());
  156. }
  157. if (success)
  158. compiled_ = true;
  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)
  489. return nullptr;
  490. Script* scriptSystem = script_;
  491. scriptSystem->IncScriptNestingLevel();
  492. bool success = context->Execute() == asEXECUTION_FINISHED;
  493. scriptSystem->DecScriptNestingLevel();
  494. if (!success)
  495. return nullptr;
  496. void* objAddress = context->GetAddressOfReturnValue();
  497. if (!objAddress)
  498. return nullptr;
  499. asIScriptObject* obj = *(static_cast<asIScriptObject**>(objAddress));
  500. if (obj)
  501. obj->AddRef();
  502. return obj;
  503. }
  504. bool ScriptFile::SaveByteCode(Serializer& dest)
  505. {
  506. if (compiled_)
  507. {
  508. dest.WriteFileID("ASBC");
  509. ByteCodeSerializer serializer = ByteCodeSerializer(dest);
  510. return scriptModule_->SaveByteCode(&serializer, true) >= 0;
  511. }
  512. else
  513. return false;
  514. }
  515. asIScriptFunction* ScriptFile::GetFunction(const String& declaration)
  516. {
  517. if (!compiled_)
  518. return nullptr;
  519. String trimDecl = declaration.Trimmed();
  520. // If not a full trimDecl, assume void with no parameters
  521. if (trimDecl.Find('(') == String::NPOS)
  522. trimDecl = "void " + trimDecl + "()";
  523. HashMap<String, asIScriptFunction*>::ConstIterator i = functions_.Find(trimDecl);
  524. if (i != functions_.End())
  525. return i->second_;
  526. asIScriptFunction* function = scriptModule_->GetFunctionByDecl(trimDecl.CString());
  527. functions_[trimDecl] = function;
  528. return function;
  529. }
  530. asIScriptFunction* ScriptFile::GetMethod(asIScriptObject* object, const String& declaration)
  531. {
  532. if (!compiled_ || !object)
  533. return nullptr;
  534. String trimDecl = declaration.Trimmed();
  535. // If not a full trimDecl, assume void with no parameters
  536. if (trimDecl.Find('(') == String::NPOS)
  537. trimDecl = "void " + trimDecl + "()";
  538. asITypeInfo* type = object->GetObjectType();
  539. if (!type)
  540. return nullptr;
  541. HashMap<asITypeInfo*, HashMap<String, asIScriptFunction*> >::ConstIterator i = methods_.Find(type);
  542. if (i != methods_.End())
  543. {
  544. HashMap<String, asIScriptFunction*>::ConstIterator j = i->second_.Find(trimDecl);
  545. if (j != i->second_.End())
  546. return j->second_;
  547. }
  548. asIScriptFunction* function = type->GetMethodByDecl(trimDecl.CString());
  549. methods_[type][trimDecl] = function;
  550. return function;
  551. }
  552. void ScriptFile::CleanupEventInvoker(asIScriptObject* object)
  553. {
  554. eventInvokers_.Erase(object);
  555. }
  556. void ScriptFile::AddEventHandlerInternal(Object* sender, StringHash eventType, const String& handlerName)
  557. {
  558. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  559. asIScriptFunction* function = nullptr;
  560. auto* receiver = static_cast<asIScriptObject*>(asGetActiveContext()->GetThisPointer());
  561. if (receiver)
  562. function = GetMethod(receiver, declaration);
  563. else
  564. function = GetFunction(declaration);
  565. if (!function)
  566. {
  567. // Retry with parameterless signature
  568. if (receiver)
  569. function = GetMethod(receiver, handlerName);
  570. else
  571. function = GetFunction(handlerName);
  572. if (!function)
  573. {
  574. URHO3D_LOGERROR("Event handler function " + handlerName + " not found in " + GetName());
  575. return;
  576. }
  577. }
  578. HashMap<asIScriptObject*, SharedPtr<ScriptEventInvoker> >::Iterator i = eventInvokers_.Find(receiver);
  579. // Remove previous handler in case an object pointer gets reused
  580. if (i != eventInvokers_.End() && !i->second_->IsObjectAlive())
  581. {
  582. eventInvokers_.Erase(i);
  583. i = eventInvokers_.End();
  584. }
  585. if (i == eventInvokers_.End())
  586. i = eventInvokers_.Insert(MakePair(receiver, SharedPtr<ScriptEventInvoker>(new ScriptEventInvoker(this, receiver))));
  587. if (!sender)
  588. {
  589. i->second_->SubscribeToEvent(eventType, new EventHandlerImpl<ScriptEventInvoker>
  590. (i->second_, &ScriptEventInvoker::HandleScriptEvent, (void*)function));
  591. }
  592. else
  593. {
  594. i->second_->SubscribeToEvent(sender, eventType, new EventHandlerImpl<ScriptEventInvoker>
  595. (i->second_, &ScriptEventInvoker::HandleScriptEvent, (void*)function));
  596. }
  597. }
  598. bool ScriptFile::AddScriptSection(asIScriptEngine* engine, Deserializer& source)
  599. {
  600. auto* cache = GetSubsystem<ResourceCache>();
  601. unsigned dataSize = source.GetSize();
  602. SharedArrayPtr<char> buffer(new char[dataSize]);
  603. source.Read((void*)buffer.Get(), dataSize);
  604. // Pre-parse for includes
  605. // Adapted from Angelscript's scriptbuilder add-on
  606. Vector<String> includeFiles;
  607. unsigned pos = 0;
  608. while (pos < dataSize)
  609. {
  610. unsigned len;
  611. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  612. if (t == asTC_COMMENT || t == asTC_WHITESPACE)
  613. {
  614. pos += len;
  615. continue;
  616. }
  617. // Is this a preprocessor directive?
  618. if (buffer[pos] == '#')
  619. {
  620. int start = pos++;
  621. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  622. if (t == asTC_IDENTIFIER)
  623. {
  624. String token(&buffer[pos], (unsigned)len);
  625. if (token == "include")
  626. {
  627. pos += len;
  628. t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  629. if (t == asTC_WHITESPACE)
  630. {
  631. pos += len;
  632. t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  633. }
  634. if (t == asTC_VALUE && len > 2 && buffer[pos] == '"')
  635. {
  636. // Get the include file
  637. String includeFile(&buffer[pos + 1], (unsigned)(len - 2));
  638. pos += len;
  639. // If the file is not found as it is, add the path of current file but only if it is found there
  640. if (!cache->Exists(includeFile))
  641. {
  642. String prefixedIncludeFile = GetPath(GetName()) + includeFile;
  643. if (cache->Exists(prefixedIncludeFile))
  644. includeFile = prefixedIncludeFile;
  645. }
  646. String includeFileLower = includeFile.ToLower();
  647. // If not included yet, store it for later processing
  648. if (!includeFiles_.Contains(includeFileLower))
  649. {
  650. includeFiles_.Insert(includeFileLower);
  651. includeFiles.Push(includeFile);
  652. }
  653. // Overwrite the include directive with space characters to avoid compiler error
  654. memset(&buffer[start], ' ', pos - start);
  655. }
  656. }
  657. }
  658. }
  659. // Don't search includes within statement blocks or between tokens in statements
  660. else
  661. {
  662. unsigned len;
  663. // Skip until ; or { whichever comes first
  664. while (pos < dataSize && buffer[pos] != ';' && buffer[pos] != '{')
  665. {
  666. engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  667. pos += len;
  668. }
  669. // Skip entire statement block
  670. if (pos < dataSize && buffer[pos] == '{')
  671. {
  672. ++pos;
  673. // Find the end of the statement block
  674. int level = 1;
  675. while (level > 0 && pos < dataSize)
  676. {
  677. asETokenClass t = engine->ParseToken(&buffer[pos], dataSize - pos, &len);
  678. if (t == asTC_KEYWORD)
  679. {
  680. if (buffer[pos] == '{')
  681. ++level;
  682. else if (buffer[pos] == '}')
  683. --level;
  684. }
  685. pos += len;
  686. }
  687. }
  688. else
  689. ++pos;
  690. }
  691. }
  692. // Process includes first
  693. for (unsigned i = 0; i < includeFiles.Size(); ++i)
  694. {
  695. cache->StoreResourceDependency(this, includeFiles[i]);
  696. SharedPtr<File> file = cache->GetFile(includeFiles[i]);
  697. if (file)
  698. {
  699. if (!AddScriptSection(engine, *file))
  700. return false;
  701. }
  702. else
  703. {
  704. URHO3D_LOGERROR("Could not process all the include directives in " + GetName() + ": missing " + includeFiles[i]);
  705. return false;
  706. }
  707. }
  708. // Then add this section
  709. if (scriptModule_->AddScriptSection(source.GetName().CString(), (const char*)buffer.Get(), dataSize) < 0)
  710. {
  711. URHO3D_LOGERROR("Failed to add script section " + source.GetName());
  712. return false;
  713. }
  714. SetMemoryUse(GetMemoryUse() + dataSize);
  715. return true;
  716. }
  717. void ScriptFile::SetParameters(asIScriptContext* context, asIScriptFunction* function, const VariantVector& parameters)
  718. {
  719. unsigned paramCount = function->GetParamCount();
  720. for (unsigned i = 0; i < parameters.Size() && i < paramCount; ++i)
  721. {
  722. int paramTypeId;
  723. function->GetParam(i, &paramTypeId);
  724. switch (paramTypeId)
  725. {
  726. case asTYPEID_BOOL:
  727. context->SetArgByte(i, (unsigned char)parameters[i].GetBool());
  728. break;
  729. case asTYPEID_INT8:
  730. case asTYPEID_UINT8:
  731. context->SetArgByte(i, (asBYTE)parameters[i].GetInt());
  732. break;
  733. case asTYPEID_INT16:
  734. case asTYPEID_UINT16:
  735. context->SetArgWord(i, (asWORD)parameters[i].GetInt());
  736. break;
  737. case asTYPEID_INT32:
  738. case asTYPEID_UINT32:
  739. context->SetArgDWord(i, (asDWORD)parameters[i].GetInt());
  740. break;
  741. case asTYPEID_INT64:
  742. case asTYPEID_UINT64:
  743. context->SetArgQWord(i, (asQWORD)parameters[i].GetInt64());
  744. break;
  745. case asTYPEID_FLOAT:
  746. context->SetArgFloat(i, parameters[i].GetFloat());
  747. break;
  748. default:
  749. if (paramTypeId & asTYPEID_APPOBJECT)
  750. {
  751. switch (parameters[i].GetType())
  752. {
  753. case VAR_VECTOR2:
  754. context->SetArgObject(i, (void*)&parameters[i].GetVector2());
  755. break;
  756. case VAR_VECTOR3:
  757. context->SetArgObject(i, (void*)&parameters[i].GetVector3());
  758. break;
  759. case VAR_VECTOR4:
  760. context->SetArgObject(i, (void*)&parameters[i].GetVector4());
  761. break;
  762. case VAR_QUATERNION:
  763. context->SetArgObject(i, (void*)&parameters[i].GetQuaternion());
  764. break;
  765. case VAR_STRING:
  766. context->SetArgObject(i, (void*)&parameters[i].GetString());
  767. break;
  768. case VAR_VARIANTMAP:
  769. context->SetArgObject(i, (void*)&parameters[i].GetVariantMap());
  770. break;
  771. case VAR_INTRECT:
  772. context->SetArgObject(i, (void*)&parameters[i].GetIntRect());
  773. break;
  774. case VAR_INTVECTOR2:
  775. context->SetArgObject(i, (void*)&parameters[i].GetIntVector2());
  776. break;
  777. case VAR_INTVECTOR3:
  778. context->SetArgObject(i, (void*)&parameters[i].GetIntVector3());
  779. break;
  780. case VAR_COLOR:
  781. context->SetArgObject(i, (void*)&parameters[i].GetColor());
  782. break;
  783. case VAR_MATRIX3:
  784. context->SetArgObject(i, (void*)&parameters[i].GetMatrix3());
  785. break;
  786. case VAR_MATRIX3X4:
  787. context->SetArgObject(i, (void*)&parameters[i].GetMatrix3x4());
  788. break;
  789. case VAR_MATRIX4:
  790. context->SetArgObject(i, (void*)&parameters[i].GetMatrix4());
  791. break;
  792. case VAR_RESOURCEREF:
  793. context->SetArgObject(i, (void*)&parameters[i].GetResourceRef());
  794. break;
  795. case VAR_RESOURCEREFLIST:
  796. context->SetArgObject(i, (void*)&parameters[i].GetResourceRefList());
  797. break;
  798. case VAR_VOIDPTR:
  799. context->SetArgObject(i, parameters[i].GetVoidPtr());
  800. break;
  801. case VAR_PTR:
  802. context->SetArgObject(i, (void*)parameters[i].GetPtr());
  803. break;
  804. default:
  805. break;
  806. }
  807. }
  808. break;
  809. }
  810. }
  811. }
  812. void ScriptFile::ReleaseModule()
  813. {
  814. if (scriptModule_)
  815. {
  816. // Clear search caches and event handlers
  817. includeFiles_.Clear();
  818. validClasses_.Clear();
  819. functions_.Clear();
  820. methods_.Clear();
  821. delayedCalls_.Clear();
  822. eventInvokers_.Clear();
  823. asIScriptEngine* engine = script_->GetScriptEngine();
  824. scriptModule_->SetUserData(nullptr);
  825. // Remove the module
  826. {
  827. MutexLock lock(script_->GetModuleMutex());
  828. script_->ClearObjectTypeCache();
  829. engine->DiscardModule(GetName().CString());
  830. }
  831. scriptModule_ = nullptr;
  832. compiled_ = false;
  833. SetMemoryUse(0);
  834. auto* cache = GetSubsystem<ResourceCache>();
  835. if (cache)
  836. cache->ResetDependencies(this);
  837. }
  838. }
  839. void ScriptFile::HandleUpdate(StringHash eventType, VariantMap& eventData)
  840. {
  841. if (!compiled_)
  842. return;
  843. using namespace Update;
  844. float timeStep = eventData[P_TIMESTEP].GetFloat();
  845. // Execute delayed calls
  846. for (unsigned i = 0; i < delayedCalls_.Size();)
  847. {
  848. DelayedCall& call = delayedCalls_[i];
  849. bool remove = false;
  850. call.delay_ -= timeStep;
  851. if (call.delay_ <= 0.0f)
  852. {
  853. if (!call.repeat_)
  854. remove = true;
  855. else
  856. call.delay_ += call.period_;
  857. Execute(call.declaration_, call.parameters_);
  858. }
  859. if (remove)
  860. delayedCalls_.Erase(i);
  861. else
  862. ++i;
  863. }
  864. }
  865. ScriptEventInvoker::ScriptEventInvoker(ScriptFile* file, asIScriptObject* object) :
  866. Object(file->GetContext()),
  867. file_(file),
  868. sharedBool_(nullptr),
  869. object_(object)
  870. {
  871. if (object_)
  872. {
  873. sharedBool_ = object_->GetEngine()->GetWeakRefFlagOfScriptObject(object_, object_->GetObjectType());
  874. if (sharedBool_)
  875. sharedBool_->AddRef();
  876. }
  877. }
  878. ScriptEventInvoker::~ScriptEventInvoker()
  879. {
  880. if (sharedBool_)
  881. sharedBool_->Release();
  882. sharedBool_ = nullptr;
  883. object_ = nullptr;
  884. }
  885. bool ScriptEventInvoker::IsObjectAlive() const
  886. {
  887. if (sharedBool_)
  888. {
  889. // Return inverse as Get returns true when an asIScriptObject is dead.
  890. return !sharedBool_->Get();
  891. }
  892. return true;
  893. }
  894. void ScriptEventInvoker::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  895. {
  896. if (!file_->IsCompiled())
  897. return;
  898. auto* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  899. if (object_ && !IsObjectAlive())
  900. {
  901. file_->CleanupEventInvoker(object_);
  902. return;
  903. }
  904. VariantVector parameters;
  905. if (method->GetParamCount() > 0)
  906. {
  907. parameters.Push(Variant((void*)&eventType));
  908. parameters.Push(Variant((void*)&eventData));
  909. }
  910. if (object_)
  911. file_->Execute(object_, method, parameters);
  912. else
  913. file_->Execute(method, parameters);
  914. }
  915. ScriptFile* GetScriptContextFile()
  916. {
  917. asIScriptContext* context = asGetActiveContext();
  918. asIScriptFunction* function = context ? context->GetFunction() : nullptr;
  919. asIScriptModule* module = function ? function->GetEngine()->GetModule(function->GetModuleName()) : nullptr;
  920. if (module)
  921. return static_cast<ScriptFile*>(module->GetUserData());
  922. else
  923. return nullptr;
  924. }
  925. }