BsScriptObject.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. #pragma once
  2. #include "BsScriptEnginePrerequisites.h"
  3. #include "BsScriptMeta.h"
  4. #include "BsException.h"
  5. #include "BsMonoManager.h"
  6. #include "BsMonoField.h"
  7. #include "BsMonoClass.h"
  8. #include <mono/jit/jit.h>
  9. namespace BansheeEngine
  10. {
  11. struct ScriptObjectBackup;
  12. template <class Type, class Base>
  13. struct InitScriptObjectOnStart
  14. {
  15. public:
  16. InitScriptObjectOnStart()
  17. {
  18. ScriptObject<Type, Base>::_initMetaData();
  19. }
  20. void makeSureIAmInstantiated() { }
  21. };
  22. class BS_SCR_BE_EXPORT ScriptObjectBase
  23. {
  24. public:
  25. ScriptObjectBase(MonoObject* instance);
  26. virtual ~ScriptObjectBase();
  27. MonoObject* getManagedInstance() const { return mManagedInstance; }
  28. virtual bool isPersistent() const { return false; }
  29. virtual void _clearManagedInstance() { }
  30. virtual void _restoreManagedInstance() { }
  31. virtual void _onManagedInstanceDeleted();
  32. virtual ScriptObjectBackup beginRefresh();
  33. virtual void endRefresh(const ScriptObjectBackup& data);
  34. protected:
  35. MonoObject* mManagedInstance;
  36. };
  37. class BS_SCR_BE_EXPORT PersistentScriptObjectBase : public ScriptObjectBase
  38. {
  39. public:
  40. PersistentScriptObjectBase(MonoObject* instance);
  41. virtual ~PersistentScriptObjectBase();
  42. virtual bool isPersistent() const override { return true; }
  43. };
  44. /**
  45. * @brief Base class for objects that can be extended using Mono scripting
  46. */
  47. template <class Type, class Base = ScriptObjectBase>
  48. class ScriptObject : public Base
  49. {
  50. public:
  51. ScriptObject(MonoObject* instance)
  52. :Base(instance)
  53. {
  54. // Compiler will only generate code for stuff that is directly used, including static data members,
  55. // so we fool it here like we're using the class directly. Otherwise compiler won't generate the code for the member
  56. // and our type won't get initialized on start (Actual behavior is a bit more random)
  57. // TODO - Use volatile instead?
  58. initOnStart.makeSureIAmInstantiated();
  59. Type* param = (Type*)(Base*)this; // Needed due to multiple inheritance. Safe since Type must point to an class derived from this one.
  60. if(metaData.thisPtrField != nullptr)
  61. metaData.thisPtrField->setValue(instance, &param);
  62. }
  63. virtual ~ScriptObject()
  64. { }
  65. void _clearManagedInstance()
  66. {
  67. if (metaData.thisPtrField != nullptr && mManagedInstance != nullptr)
  68. metaData.thisPtrField->setValue(mManagedInstance, nullptr);
  69. mManagedInstance = nullptr;
  70. }
  71. void _restoreManagedInstance()
  72. {
  73. mManagedInstance = _createManagedInstance(true);
  74. Type* param = (Type*)(Base*)this; // Needed due to multiple inheritance. Safe since Type must point to an class derived from this one.
  75. if (metaData.thisPtrField != nullptr && mManagedInstance != nullptr)
  76. metaData.thisPtrField->setValue(mManagedInstance, &param);
  77. }
  78. virtual MonoObject* _createManagedInstance(bool construct)
  79. {
  80. return metaData.scriptClass->createInstance(construct);
  81. }
  82. static Type* toNative(MonoObject* managedInstance)
  83. {
  84. Type* nativeInstance = nullptr;
  85. if (metaData.thisPtrField != nullptr && managedInstance != nullptr)
  86. metaData.thisPtrField->getValue(managedInstance, &nativeInstance);
  87. return nativeInstance;
  88. }
  89. static const ScriptMeta* getMetaData() { return &metaData; }
  90. static void _initMetaData()
  91. {
  92. metaData = ScriptMeta(Type::getAssemblyName(), Type::getNamespace(), Type::getTypeName(), &Type::initRuntimeData);
  93. MonoManager::registerScriptType(&metaData);
  94. }
  95. protected:
  96. static ScriptMeta metaData;
  97. private:
  98. static InitScriptObjectOnStart<Type, Base> initOnStart;
  99. };
  100. template <typename Type, typename Base>
  101. InitScriptObjectOnStart<Type, Base> ScriptObject<Type, Base>::initOnStart;
  102. template <typename Type, typename Base>
  103. ScriptMeta ScriptObject<Type, Base>::metaData;
  104. struct ScriptObjectBackup
  105. {
  106. Any data;
  107. };
  108. #define SCRIPT_OBJ(assembly, namespace, name) \
  109. static String getAssemblyName() { return assembly; } \
  110. static String getNamespace() { return namespace; } \
  111. static String getTypeName() { return name; } \
  112. static void initRuntimeData();
  113. }