BsRuntimeScriptObjects.cpp 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. #include "BsRuntimeScriptObjects.h"
  2. #include "BsMonoManager.h"
  3. #include "BsMonoAssembly.h"
  4. #include "BsMonoClass.h"
  5. #include "BsMonoField.h"
  6. using namespace CamelotFramework;
  7. namespace BansheeEngine
  8. {
  9. SerializableObjectInfo::SerializableObjectInfo()
  10. :mMonoClass(nullptr), mTypeId(0)
  11. {
  12. }
  13. SerializableObjectInfo::~SerializableObjectInfo()
  14. {
  15. for(auto& field : mFields)
  16. {
  17. cm_delete(field.second);
  18. }
  19. }
  20. SerializableFieldInfo::SerializableFieldInfo()
  21. :mMonoField(nullptr), mType(ScriptFieldType::Other), mFlags((ScriptFieldFlags)0), mFieldId(0)
  22. {
  23. }
  24. SerializableFieldInfo::~SerializableFieldInfo()
  25. {
  26. }
  27. RuntimeScriptObjects::~RuntimeScriptObjects()
  28. {
  29. }
  30. void RuntimeScriptObjects::refreshScriptObjects(const String& assemblyName)
  31. {
  32. clearScriptObjects(assemblyName);
  33. // Get necessary classes for detecting needed class & field information
  34. MonoAssembly* mscorlib = MonoManager::instance().getAssembly("mscorlib");
  35. if(mscorlib == nullptr)
  36. CM_EXCEPT(InvalidStateException, "mscorlib assembly is not loaded.");
  37. MonoAssembly* bansheeEngineAssembly = MonoManager::instance().getAssembly(BansheeEngineAssemblyName);
  38. if(bansheeEngineAssembly == nullptr)
  39. CM_EXCEPT(InvalidStateException, String(BansheeEngineAssemblyName) + " assembly is not loaded.");
  40. MonoClass* serializableAttribute = mscorlib->getClass("System", "SerializableAttribute");
  41. if(serializableAttribute == nullptr)
  42. CM_EXCEPT(InvalidStateException, "Cannot find SerializableAttribute managed class.");
  43. MonoClass* nonSerializedAttribute = mscorlib->getClass("System", "NonSerializedAttribute");
  44. if(nonSerializedAttribute == nullptr)
  45. CM_EXCEPT(InvalidStateException, "Cannot find NonSerializedAttribute managed class.");
  46. MonoClass* componentClass = bansheeEngineAssembly->getClass("BansheeEngine", "Component");
  47. if(componentClass == nullptr)
  48. CM_EXCEPT(InvalidStateException, "Cannot find Component managed class.");
  49. MonoClass* serializeFieldAttribute = bansheeEngineAssembly->getClass("BansheeEngine", "SerializeField");
  50. if(serializeFieldAttribute == nullptr)
  51. CM_EXCEPT(InvalidStateException, "Cannot find SerializeField managed class.");
  52. MonoClass* hideInInspectorAttribute = bansheeEngineAssembly->getClass("BansheeEngine", "HideInInspector");
  53. if(hideInInspectorAttribute == nullptr)
  54. CM_EXCEPT(InvalidStateException, "Cannot find HideInInspector managed class.");
  55. // Process all classes and fields
  56. CM::UINT32 mUniqueTypeId = 1;
  57. MonoAssembly* curAssembly = MonoManager::instance().getAssembly(assemblyName);
  58. if(curAssembly == nullptr)
  59. return;
  60. std::shared_ptr<SerializableAssemblyInfo> assemblyInfo = cm_shared_ptr<SerializableAssemblyInfo>();
  61. mAssemblyInfos[assemblyName] = assemblyInfo;
  62. const Vector<MonoClass*>::type& allClasses = curAssembly->getAllClasses();
  63. for(auto& curClass : allClasses)
  64. {
  65. if((curClass->isSubClassOf(componentClass) || curClass->hasAttribute(serializableAttribute)) && curClass != componentClass)
  66. {
  67. std::shared_ptr<SerializableObjectInfo> objInfo = cm_shared_ptr<SerializableObjectInfo>();
  68. objInfo->mTypeId = mUniqueTypeId++;
  69. objInfo->mTypeName = curClass->getTypeName();
  70. objInfo->mNamespace = curClass->getNamespace();
  71. objInfo->mMonoClass = curClass;
  72. ::MonoClass* baseClass = mono_class_get_parent(curClass->_getInternalClass());
  73. if(baseClass != nullptr)
  74. {
  75. String dbgName = mono_class_get_name(baseClass);
  76. }
  77. String fullTypeName = objInfo->mNamespace + "." + objInfo->mTypeName;
  78. assemblyInfo->mTypeNameToId[fullTypeName] = objInfo->mTypeId;
  79. assemblyInfo->mObjectInfos[objInfo->mTypeId] = objInfo;
  80. CM::UINT32 mUniqueFieldId = 1;
  81. const CM::Vector<MonoField*>::type& fields = curClass->getAllFields();
  82. for(auto& field : fields)
  83. {
  84. if(field->isStatic())
  85. continue;
  86. SerializableFieldInfo* fieldInfo = cm_new<SerializableFieldInfo>();
  87. fieldInfo->mFieldId = mUniqueFieldId++;
  88. fieldInfo->mMonoField = field;
  89. fieldInfo->mName = field->getName();
  90. MonoClass* fieldType = field->getType();
  91. fieldInfo->mTypeNamespace = fieldType->getNamespace();
  92. fieldInfo->mTypeName = fieldType->getTypeName();
  93. MonoType* monoType = mono_class_get_type(fieldType->_getInternalClass());
  94. int monoPrimitiveType = mono_type_get_type(monoType);
  95. // TODO - We don't support nested arrays or multi-dimensional arrays
  96. bool isSupportedType = true;
  97. if(monoPrimitiveType == MONO_TYPE_ARRAY)
  98. {
  99. ::MonoClass* elementClass = mono_class_get_element_class(fieldType->_getInternalClass());
  100. if(elementClass != nullptr)
  101. {
  102. monoType = mono_class_get_type(elementClass);
  103. monoPrimitiveType = mono_type_get_type(monoType);
  104. }
  105. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Array);
  106. }
  107. // TODO - Also check for List and get its generic primitive
  108. // Determine field type
  109. switch(monoPrimitiveType) // TODO - If array I need to get underlying type
  110. {
  111. case MONO_TYPE_BOOLEAN:
  112. fieldInfo->mType = ScriptFieldType::Bool;
  113. break;
  114. case MONO_TYPE_CHAR:
  115. fieldInfo->mType = ScriptFieldType::Char;
  116. break;
  117. case MONO_TYPE_I1:
  118. fieldInfo->mType = ScriptFieldType::I8;
  119. break;
  120. case MONO_TYPE_U1:
  121. fieldInfo->mType = ScriptFieldType::U8;
  122. break;
  123. case MONO_TYPE_I2:
  124. fieldInfo->mType = ScriptFieldType::I16;
  125. break;
  126. case MONO_TYPE_U2:
  127. fieldInfo->mType = ScriptFieldType::U16;
  128. break;
  129. case MONO_TYPE_I4:
  130. fieldInfo->mType = ScriptFieldType::I32;
  131. break;
  132. case MONO_TYPE_U4:
  133. fieldInfo->mType = ScriptFieldType::U32;
  134. break;
  135. case MONO_TYPE_I8:
  136. fieldInfo->mType = ScriptFieldType::U64;
  137. break;
  138. case MONO_TYPE_U8:
  139. fieldInfo->mType = ScriptFieldType::U64;
  140. break;
  141. case MONO_TYPE_STRING:
  142. fieldInfo->mType = ScriptFieldType::String;
  143. break;
  144. case MONO_TYPE_R4:
  145. fieldInfo->mType = ScriptFieldType::Float;
  146. break;
  147. case MONO_TYPE_R8:
  148. fieldInfo->mType = ScriptFieldType::Double;
  149. break;
  150. case MONO_TYPE_CLASS:
  151. // TODO - Check for Resource or GameObject ref, or SerializableObject
  152. break;
  153. case MONO_TYPE_VALUETYPE:
  154. // TODO - Check for SerializableObject
  155. break;
  156. }
  157. if(fieldInfo->mType != ScriptFieldType::Other)
  158. {
  159. MonoFieldVisibility visibility = field->getVisibility();
  160. if(visibility == MonoFieldVisibility::Public)
  161. {
  162. if(!field->hasAttribute(nonSerializedAttribute))
  163. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Serializable);
  164. if(!field->hasAttribute(hideInInspectorAttribute))
  165. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Inspectable);
  166. }
  167. else
  168. {
  169. if(field->hasAttribute(serializeFieldAttribute))
  170. fieldInfo->mFlags = (ScriptFieldFlags)((UINT32)fieldInfo->mFlags | (UINT32)ScriptFieldFlags::Serializable);
  171. }
  172. }
  173. objInfo->mFieldNameToId[fieldInfo->mName] = fieldInfo->mFieldId;
  174. objInfo->mFields[fieldInfo->mFieldId] = fieldInfo;
  175. }
  176. }
  177. }
  178. // Form parent/child connections
  179. for(auto& curClass : assemblyInfo->mObjectInfos)
  180. {
  181. MonoClass* base = curClass.second->mMonoClass->getBaseClass();
  182. while(base != nullptr)
  183. {
  184. std::shared_ptr<SerializableObjectInfo> baseObjInfo;
  185. if(getSerializableObjectInfo(base->getNamespace(), base->getTypeName(), baseObjInfo))
  186. {
  187. curClass.second->mBaseClass = baseObjInfo;
  188. baseObjInfo->mDerivedClasses.push_back(curClass.second);
  189. break;
  190. }
  191. base = base->getBaseClass();
  192. }
  193. }
  194. // TODO - How to handle arrays and/or Lists (or collections in general?)
  195. // TODO - In BsScriptEnginePlugin.cpp I create RuntimeScriptObjects class but never destroy it, for debug purposes. Remember to remove that.
  196. // TODO - Figure our field type (primitive, gameobject ref, etc.) - Should I do this here or while serializing? Probably here.
  197. // - Add easy way to modify those fields (depending on their type) - Maybe make them virtual
  198. // Detect field type:
  199. // - Primitive - straightforward just check for primitive types
  200. // - GameObjectHandle - check if object is SceneObject or derives from Component
  201. // - SerializableObject - check if object is SerializableObject
  202. // - ResourceHandle - derives from Resource
  203. // TOOD - Make SerializableObjectInfo IReflectable and create its RTTI
  204. }
  205. void RuntimeScriptObjects::clearScriptObjects(const CM::String& assemblyName)
  206. {
  207. mAssemblyInfos.erase(assemblyName);
  208. }
  209. bool RuntimeScriptObjects::getSerializableObjectInfo(const CM::String& ns, const CM::String& typeName, std::shared_ptr<SerializableObjectInfo>& outInfo)
  210. {
  211. String fullName = ns + "." + typeName;
  212. for(auto& curAssembly : mAssemblyInfos)
  213. {
  214. auto iterFind = curAssembly.second->mTypeNameToId.find(fullName);
  215. if(iterFind != curAssembly.second->mTypeNameToId.end())
  216. {
  217. outInfo = curAssembly.second->mObjectInfos[iterFind->first];
  218. return true;
  219. }
  220. }
  221. return false;
  222. }
  223. }