BsRuntimeScriptObjects.cpp 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478
  1. #include "BsRuntimeScriptObjects.h"
  2. #include "BsScriptResourceManager.h"
  3. #include "BsScriptGameObjectManager.h"
  4. #include "BsManagedSerializableObjectInfo.h"
  5. #include "BsMonoManager.h"
  6. #include "BsMonoAssembly.h"
  7. #include "BsMonoClass.h"
  8. #include "BsMonoField.h"
  9. #include "BsMonoMethod.h"
  10. #include "BsMonoProperty.h"
  11. #include "BsMonoUtil.h"
  12. #include "BsRTTIType.h"
  13. namespace BansheeEngine
  14. {
  15. RuntimeScriptObjects::RuntimeScriptObjects()
  16. :mBaseTypesInitialized(false), mSerializeObjectAttribute(nullptr), mDontSerializeFieldAttribute(nullptr),
  17. mComponentClass(nullptr), mSceneObjectClass(nullptr), mTextureClass(nullptr), mSpriteTextureClass(nullptr),
  18. mSerializeFieldAttribute(nullptr), mHideInInspectorAttribute(nullptr), mSystemArrayClass(nullptr), mSystemGenericListClass(nullptr),
  19. mSystemGenericDictionaryClass(nullptr), mManagedResourceClass(nullptr)
  20. {
  21. }
  22. RuntimeScriptObjects::~RuntimeScriptObjects()
  23. {
  24. }
  25. Vector<String> RuntimeScriptObjects::getInitializedAssemblies() const
  26. {
  27. Vector<String> initializedAssemblies;
  28. for (auto& assemblyPair : mAssemblyInfos)
  29. initializedAssemblies.push_back(assemblyPair.first);
  30. return initializedAssemblies;
  31. }
  32. void RuntimeScriptObjects::refreshScriptObjects(const String& assemblyName)
  33. {
  34. clearScriptObjects(assemblyName);
  35. if(!mBaseTypesInitialized)
  36. initializeBaseTypes();
  37. // Process all classes and fields
  38. UINT32 mUniqueTypeId = 1;
  39. MonoAssembly* curAssembly = MonoManager::instance().getAssembly(assemblyName);
  40. if(curAssembly == nullptr)
  41. return;
  42. std::shared_ptr<ManagedSerializableAssemblyInfo> assemblyInfo = bs_shared_ptr<ManagedSerializableAssemblyInfo>();
  43. assemblyInfo->mName = assemblyName;
  44. mAssemblyInfos[assemblyName] = assemblyInfo;
  45. // Populate class data
  46. const Vector<MonoClass*>& allClasses = curAssembly->getAllClasses();
  47. for(auto& curClass : allClasses)
  48. {
  49. if((curClass->isSubClassOf(mComponentClass) || curClass->isSubClassOf(mManagedResourceClass) ||
  50. curClass->hasAttribute(mSerializeObjectAttribute)) && curClass != mComponentClass && curClass != mManagedResourceClass)
  51. {
  52. std::shared_ptr<ManagedSerializableTypeInfoObject> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoObject>();
  53. typeInfo->mTypeNamespace = curClass->getNamespace();
  54. typeInfo->mTypeName = curClass->getTypeName();
  55. MonoType* monoType = mono_class_get_type(curClass->_getInternalClass());
  56. int monoPrimitiveType = mono_type_get_type(monoType);
  57. if(monoPrimitiveType == MONO_TYPE_VALUETYPE)
  58. typeInfo->mValueType = true;
  59. else
  60. typeInfo->mValueType = false;
  61. std::shared_ptr<ManagedSerializableObjectInfo> objInfo = bs_shared_ptr<ManagedSerializableObjectInfo>();
  62. objInfo->mTypeId = mUniqueTypeId++;
  63. objInfo->mTypeInfo = typeInfo;
  64. objInfo->mMonoClass = curClass;
  65. assemblyInfo->mTypeNameToId[objInfo->getFullTypeName()] = objInfo->mTypeId;
  66. assemblyInfo->mObjectInfos[objInfo->mTypeId] = objInfo;
  67. }
  68. }
  69. // Populate field data
  70. for(auto& curClassInfo : assemblyInfo->mObjectInfos)
  71. {
  72. std::shared_ptr<ManagedSerializableObjectInfo> objInfo = curClassInfo.second;
  73. String fullTypeName = objInfo->getFullTypeName();
  74. assemblyInfo->mTypeNameToId[fullTypeName] = objInfo->mTypeId;
  75. assemblyInfo->mObjectInfos[objInfo->mTypeId] = objInfo;
  76. UINT32 mUniqueFieldId = 1;
  77. const Vector<MonoField*>& fields = objInfo->mMonoClass->getAllFields();
  78. for(auto& field : fields)
  79. {
  80. if(field->isStatic())
  81. continue;
  82. ManagedSerializableTypeInfoPtr typeInfo = determineType(field->getType());
  83. if (typeInfo == nullptr)
  84. continue;
  85. std::shared_ptr<ManagedSerializableFieldInfo> fieldInfo = bs_shared_ptr<ManagedSerializableFieldInfo>();
  86. fieldInfo->mFieldId = mUniqueFieldId++;
  87. fieldInfo->mName = field->getName();
  88. fieldInfo->mMonoField = field;
  89. fieldInfo->mTypeInfo = typeInfo;
  90. MonoFieldVisibility visibility = field->getVisibility();
  91. if (visibility == MonoFieldVisibility::Public)
  92. {
  93. if (!field->hasAttribute(mDontSerializeFieldAttribute))
  94. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Serializable);
  95. if (!field->hasAttribute(mHideInInspectorAttribute))
  96. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Inspectable);
  97. }
  98. else
  99. {
  100. if (field->hasAttribute(mSerializeFieldAttribute))
  101. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Serializable);
  102. }
  103. objInfo->mFieldNameToId[fieldInfo->mName] = fieldInfo->mFieldId;
  104. objInfo->mFields[fieldInfo->mFieldId] = fieldInfo;
  105. }
  106. }
  107. // Form parent/child connections
  108. for(auto& curClass : assemblyInfo->mObjectInfos)
  109. {
  110. MonoClass* base = curClass.second->mMonoClass->getBaseClass();
  111. while(base != nullptr)
  112. {
  113. std::shared_ptr<ManagedSerializableObjectInfo> baseObjInfo;
  114. if(getSerializableObjectInfo(base->getNamespace(), base->getTypeName(), baseObjInfo))
  115. {
  116. curClass.second->mBaseClass = baseObjInfo;
  117. baseObjInfo->mDerivedClasses.push_back(curClass.second);
  118. break;
  119. }
  120. base = base->getBaseClass();
  121. }
  122. }
  123. onAssemblyRefreshed(curAssembly);
  124. }
  125. ManagedSerializableTypeInfoPtr RuntimeScriptObjects::determineType(MonoClass* monoClass)
  126. {
  127. if(!mBaseTypesInitialized)
  128. BS_EXCEPT(InvalidStateException, "Calling determineType without previously initializing base types.");
  129. MonoType* monoType = mono_class_get_type(monoClass->_getInternalClass());
  130. int monoPrimitiveType = mono_type_get_type(monoType);
  131. // Determine field type
  132. switch(monoPrimitiveType)
  133. {
  134. case MONO_TYPE_BOOLEAN:
  135. {
  136. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  137. typeInfo->mType = ScriptPrimitiveType::Bool;
  138. return typeInfo;
  139. }
  140. case MONO_TYPE_CHAR:
  141. {
  142. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  143. typeInfo->mType = ScriptPrimitiveType::Char;
  144. return typeInfo;
  145. }
  146. case MONO_TYPE_I1:
  147. {
  148. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  149. typeInfo->mType = ScriptPrimitiveType::I8;
  150. return typeInfo;
  151. }
  152. case MONO_TYPE_U1:
  153. {
  154. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  155. typeInfo->mType = ScriptPrimitiveType::U8;
  156. return typeInfo;
  157. }
  158. case MONO_TYPE_I2:
  159. {
  160. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  161. typeInfo->mType = ScriptPrimitiveType::I16;
  162. return typeInfo;
  163. }
  164. case MONO_TYPE_U2:
  165. {
  166. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  167. typeInfo->mType = ScriptPrimitiveType::U16;
  168. return typeInfo;
  169. }
  170. case MONO_TYPE_I4:
  171. {
  172. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  173. typeInfo->mType = ScriptPrimitiveType::I32;
  174. return typeInfo;
  175. }
  176. case MONO_TYPE_U4:
  177. {
  178. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  179. typeInfo->mType = ScriptPrimitiveType::U32;
  180. return typeInfo;
  181. }
  182. case MONO_TYPE_I8:
  183. {
  184. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  185. typeInfo->mType = ScriptPrimitiveType::I64;
  186. return typeInfo;
  187. }
  188. case MONO_TYPE_U8:
  189. {
  190. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  191. typeInfo->mType = ScriptPrimitiveType::U64;
  192. return typeInfo;
  193. }
  194. case MONO_TYPE_STRING:
  195. {
  196. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  197. typeInfo->mType = ScriptPrimitiveType::String;
  198. return typeInfo;
  199. }
  200. case MONO_TYPE_R4:
  201. {
  202. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  203. typeInfo->mType = ScriptPrimitiveType::Float;
  204. return typeInfo;
  205. }
  206. case MONO_TYPE_R8:
  207. {
  208. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  209. typeInfo->mType = ScriptPrimitiveType::Double;
  210. return typeInfo;
  211. }
  212. case MONO_TYPE_CLASS:
  213. if(monoClass->isSubClassOf(mTextureClass))
  214. {
  215. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  216. typeInfo->mType = ScriptPrimitiveType::TextureRef;
  217. return typeInfo;
  218. }
  219. else if(monoClass->isSubClassOf(mSpriteTextureClass))
  220. {
  221. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  222. typeInfo->mType = ScriptPrimitiveType::SpriteTextureRef;
  223. return typeInfo;
  224. }
  225. else if (monoClass->isSubClassOf(mManagedResourceClass))
  226. {
  227. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  228. typeInfo->mType = ScriptPrimitiveType::ManagedResourceRef;
  229. return typeInfo;
  230. }
  231. else if(monoClass->isSubClassOf(mSceneObjectClass))
  232. {
  233. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  234. typeInfo->mType = ScriptPrimitiveType::SceneObjectRef;
  235. return typeInfo;
  236. }
  237. else if(monoClass->isSubClassOf(mComponentClass))
  238. {
  239. std::shared_ptr<ManagedSerializableTypeInfoPrimitive> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoPrimitive>();
  240. typeInfo->mType = ScriptPrimitiveType::ComponentRef;
  241. return typeInfo;
  242. }
  243. else
  244. {
  245. if(hasSerializableObjectInfo(monoClass->getNamespace(), monoClass->getTypeName()))
  246. {
  247. std::shared_ptr<ManagedSerializableTypeInfoObject> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoObject>();
  248. typeInfo->mTypeNamespace = monoClass->getNamespace();
  249. typeInfo->mTypeName = monoClass->getTypeName();
  250. typeInfo->mValueType = false;
  251. return typeInfo;
  252. }
  253. }
  254. break;
  255. case MONO_TYPE_VALUETYPE:
  256. if(hasSerializableObjectInfo(monoClass->getNamespace(), monoClass->getTypeName()))
  257. {
  258. std::shared_ptr<ManagedSerializableTypeInfoObject> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoObject>();
  259. typeInfo->mTypeNamespace = monoClass->getNamespace();
  260. typeInfo->mTypeName = monoClass->getTypeName();
  261. typeInfo->mValueType = true;
  262. return typeInfo;
  263. }
  264. break;
  265. case MONO_TYPE_GENERICINST:
  266. if(monoClass->getFullName() == mSystemGenericListClass->getFullName()) // Full name is part of CIL spec, so it is just fine to compare like this
  267. {
  268. std::shared_ptr<ManagedSerializableTypeInfoList> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoList>();
  269. MonoProperty& itemProperty = monoClass->getProperty("Item");
  270. MonoClass* itemClass = itemProperty.getReturnType();
  271. if(itemClass != nullptr)
  272. typeInfo->mElementType = determineType(itemClass);
  273. return typeInfo;
  274. }
  275. else if(monoClass->getFullName() == mSystemGenericDictionaryClass->getFullName())
  276. {
  277. std::shared_ptr<ManagedSerializableTypeInfoDictionary> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoDictionary>();
  278. MonoMethod* getEnumerator = monoClass->getMethod("GetEnumerator");
  279. MonoClass* enumClass = getEnumerator->getReturnType();
  280. MonoProperty& currentProp = enumClass->getProperty("Current");
  281. MonoClass* keyValuePair = currentProp.getReturnType();
  282. MonoProperty& keyProperty = keyValuePair->getProperty("Key");
  283. MonoProperty& valueProperty = keyValuePair->getProperty("Value");
  284. MonoClass* keyClass = keyProperty.getReturnType();
  285. if(keyClass != nullptr)
  286. typeInfo->mKeyType = determineType(keyClass);
  287. MonoClass* valueClass = valueProperty.getReturnType();
  288. if(valueClass != nullptr)
  289. typeInfo->mValueType = determineType(valueClass);
  290. return typeInfo;
  291. }
  292. break;
  293. case MONO_TYPE_SZARRAY:
  294. case MONO_TYPE_ARRAY:
  295. {
  296. std::shared_ptr<ManagedSerializableTypeInfoArray> typeInfo = bs_shared_ptr<ManagedSerializableTypeInfoArray>();
  297. ::MonoClass* elementClass = mono_class_get_element_class(monoClass->_getInternalClass());
  298. if(elementClass != nullptr)
  299. {
  300. MonoClass* monoElementClass = MonoManager::instance().findClass(elementClass);
  301. if(monoElementClass != nullptr)
  302. typeInfo->mElementType = determineType(monoElementClass);
  303. }
  304. typeInfo->mRank = (UINT32)mono_class_get_rank(monoClass->_getInternalClass());
  305. return typeInfo;
  306. }
  307. }
  308. return nullptr;
  309. }
  310. void RuntimeScriptObjects::clearScriptObjects(const String& assemblyName)
  311. {
  312. mAssemblyInfos.erase(assemblyName);
  313. mBaseTypesInitialized = false;
  314. mSystemArrayClass = nullptr;
  315. mSystemGenericListClass = nullptr;
  316. mSystemGenericDictionaryClass = nullptr;
  317. mSerializeObjectAttribute = nullptr;
  318. mDontSerializeFieldAttribute = nullptr;
  319. mComponentClass = nullptr;
  320. mSceneObjectClass = nullptr;
  321. mManagedResourceClass = nullptr;
  322. mTextureClass = nullptr;
  323. mSpriteTextureClass = nullptr;
  324. mSerializeFieldAttribute = nullptr;
  325. mHideInInspectorAttribute = nullptr;
  326. }
  327. void RuntimeScriptObjects::initializeBaseTypes()
  328. {
  329. // Get necessary classes for detecting needed class & field information
  330. MonoAssembly* corlib = MonoManager::instance().getAssembly("corlib");
  331. if(corlib == nullptr)
  332. BS_EXCEPT(InvalidStateException, "corlib assembly is not loaded.");
  333. MonoAssembly* bansheeEngineAssembly = MonoManager::instance().getAssembly(BansheeEngineAssemblyName);
  334. if(bansheeEngineAssembly == nullptr)
  335. BS_EXCEPT(InvalidStateException, String(BansheeEngineAssemblyName) + " assembly is not loaded.");
  336. mSystemArrayClass = corlib->getClass("System", "Array");
  337. if(mSystemArrayClass == nullptr)
  338. BS_EXCEPT(InvalidStateException, "Cannot find System.Array managed class.");
  339. mSystemGenericListClass = corlib->getClass("System.Collections.Generic", "List`1");
  340. if(mSystemGenericListClass == nullptr)
  341. BS_EXCEPT(InvalidStateException, "Cannot find List<T> managed class.");
  342. mSystemGenericDictionaryClass = corlib->getClass("System.Collections.Generic", "Dictionary`2");
  343. if(mSystemGenericDictionaryClass == nullptr)
  344. BS_EXCEPT(InvalidStateException, "Cannot find Dictionary<TKey, TValue> managed class.");
  345. mSerializeObjectAttribute = bansheeEngineAssembly->getClass("BansheeEngine", "SerializeObject");
  346. if(mSerializeObjectAttribute == nullptr)
  347. BS_EXCEPT(InvalidStateException, "Cannot find SerializableObject managed class.");
  348. mDontSerializeFieldAttribute = bansheeEngineAssembly->getClass("BansheeEngine", "DontSerializeField");
  349. if(mDontSerializeFieldAttribute == nullptr)
  350. BS_EXCEPT(InvalidStateException, "Cannot find DontSerializeField managed class.");
  351. mComponentClass = bansheeEngineAssembly->getClass("BansheeEngine", "Component");
  352. if(mComponentClass == nullptr)
  353. BS_EXCEPT(InvalidStateException, "Cannot find Component managed class.");
  354. mSceneObjectClass = bansheeEngineAssembly->getClass("BansheeEngine", "SceneObject");
  355. if(mSceneObjectClass == nullptr)
  356. BS_EXCEPT(InvalidStateException, "Cannot find SceneObject managed class.");
  357. mManagedResourceClass = bansheeEngineAssembly->getClass("BansheeEngine", "ManagedResource");
  358. if (mManagedResourceClass == nullptr)
  359. BS_EXCEPT(InvalidStateException, "Cannot find ManagedResource managed class.");
  360. mTextureClass = bansheeEngineAssembly->getClass("BansheeEngine", "Texture2D");
  361. if(mTextureClass == nullptr)
  362. BS_EXCEPT(InvalidStateException, "Cannot find Texture2D managed class.");
  363. mSpriteTextureClass = bansheeEngineAssembly->getClass("BansheeEngine", "SpriteTexture");
  364. if(mSpriteTextureClass == nullptr)
  365. BS_EXCEPT(InvalidStateException, "Cannot find SpriteTexture managed class.");
  366. mSerializeFieldAttribute = bansheeEngineAssembly->getClass("BansheeEngine", "SerializeField");
  367. if(mSerializeFieldAttribute == nullptr)
  368. BS_EXCEPT(InvalidStateException, "Cannot find SerializeField managed class.");
  369. mHideInInspectorAttribute = bansheeEngineAssembly->getClass("BansheeEngine", "HideInInspector");
  370. if(mHideInInspectorAttribute == nullptr)
  371. BS_EXCEPT(InvalidStateException, "Cannot find HideInInspector managed class.");
  372. mBaseTypesInitialized = true;
  373. }
  374. bool RuntimeScriptObjects::getSerializableObjectInfo(const String& ns, const String& typeName, std::shared_ptr<ManagedSerializableObjectInfo>& outInfo)
  375. {
  376. String fullName = ns + "." + typeName;
  377. for(auto& curAssembly : mAssemblyInfos)
  378. {
  379. auto iterFind = curAssembly.second->mTypeNameToId.find(fullName);
  380. if(iterFind != curAssembly.second->mTypeNameToId.end())
  381. {
  382. outInfo = curAssembly.second->mObjectInfos[iterFind->second];
  383. return true;
  384. }
  385. }
  386. return false;
  387. }
  388. bool RuntimeScriptObjects::hasSerializableObjectInfo(const String& ns, const String& typeName)
  389. {
  390. String fullName = ns + "." + typeName;
  391. for(auto& curAssembly : mAssemblyInfos)
  392. {
  393. auto iterFind = curAssembly.second->mTypeNameToId.find(fullName);
  394. if(iterFind != curAssembly.second->mTypeNameToId.end())
  395. return true;
  396. }
  397. return false;
  398. }
  399. }