BsScriptEditorWindow.cpp 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411
  1. #include "BsScriptEditorWindow.h"
  2. #include "BsScriptMeta.h"
  3. #include "BsMonoField.h"
  4. #include "BsMonoClass.h"
  5. #include "BsMonoMethod.h"
  6. #include "BsMonoManager.h"
  7. #include "BsMonoUtil.h"
  8. #include "BsEditorWidget.h"
  9. #include "BsEditorWidgetManager.h"
  10. #include "BsEditorWidgetContainer.h"
  11. #include "BsMonoAssembly.h"
  12. #include "BsScriptObjectManager.h"
  13. #include "BsScriptGUILayout.h"
  14. #include "BsScriptHString.h"
  15. using namespace std::placeholders;
  16. namespace BansheeEngine
  17. {
  18. UnorderedMap<String, ScriptEditorWindow::EditorWindowHandle> ScriptEditorWindow::OpenScriptEditorWindows;
  19. Vector<String> ScriptEditorWindow::AvailableWindowTypes;
  20. MonoMethod* ScriptEditorWindow::onResizedMethod = nullptr;
  21. MonoMethod* ScriptEditorWindow::onFocusChangedMethod = nullptr;
  22. MonoField* ScriptEditorWindow::guiPanelField = nullptr;
  23. ScriptEditorWindow::ScriptEditorWindow(ScriptEditorWidget* editorWidget)
  24. :ScriptObject(editorWidget->getManagedInstance()), mName(editorWidget->getName()), mEditorWidget(editorWidget),
  25. mRefreshInProgress(false), mIsDestroyed(false)
  26. {
  27. mOnWidgetResizedConn = editorWidget->onResized.connect(std::bind(&ScriptEditorWindow::onWidgetResized, this, _1, _2));
  28. mOnFocusChangedConn = editorWidget->onFocusChanged.connect(std::bind(&ScriptEditorWindow::onFocusChanged, this, _1));
  29. mOnAssemblyRefreshStartedConn = ScriptObjectManager::instance().onRefreshStarted.connect(std::bind(&ScriptEditorWindow::onAssemblyRefreshStarted, this));
  30. }
  31. ScriptEditorWindow::~ScriptEditorWindow()
  32. {
  33. // TODO - This probably need to be called whenever we close a window, and not when script class is destructed
  34. mOnWidgetResizedConn.disconnect();
  35. mOnFocusChangedConn.disconnect();
  36. mOnAssemblyRefreshStartedConn.disconnect();
  37. }
  38. void ScriptEditorWindow::initRuntimeData()
  39. {
  40. metaData.scriptClass->addInternalCall("Internal_CreateOrGetInstance", &ScriptEditorWindow::internal_createOrGetInstance);
  41. metaData.scriptClass->addInternalCall("Internal_GetInstance", &ScriptEditorWindow::internal_getInstance);
  42. metaData.scriptClass->addInternalCall("Internal_GetWidth", &ScriptEditorWindow::internal_getWidth);
  43. metaData.scriptClass->addInternalCall("Internal_GetHeight", &ScriptEditorWindow::internal_getHeight);
  44. metaData.scriptClass->addInternalCall("Internal_HasFocus", &ScriptEditorWindow::internal_hasFocus);
  45. metaData.scriptClass->addInternalCall("Internal_ScreenToWindowPos", &ScriptEditorWindow::internal_screenToWindowPos);
  46. metaData.scriptClass->addInternalCall("Internal_WindowToScreenPos", &ScriptEditorWindow::internal_windowToScreenPos);
  47. onResizedMethod = metaData.scriptClass->getMethod("WindowResized", 2);
  48. onFocusChangedMethod = metaData.scriptClass->getMethod("FocusChanged", 1);
  49. guiPanelField = metaData.scriptClass->getField("GUI");
  50. }
  51. MonoObject* ScriptEditorWindow::internal_createOrGetInstance(MonoString* ns, MonoString* typeName)
  52. {
  53. String strTypeName = toString(MonoUtil::monoToWString(typeName));
  54. String strNamespace = toString(MonoUtil::monoToWString(ns));
  55. String fullName = strNamespace + "." + strTypeName;
  56. auto findIter = OpenScriptEditorWindows.find(fullName);
  57. if(findIter != OpenScriptEditorWindows.end())
  58. return findIter->second.nativeObj->mManagedInstance;
  59. EditorWidgetManager::instance().open(fullName); // This will trigger openEditorWidgetCallback and update OpenScriptEditorWindows
  60. auto findIter2 = OpenScriptEditorWindows.find(fullName);
  61. if(findIter2 != OpenScriptEditorWindows.end())
  62. return findIter2->second.nativeObj->mManagedInstance;
  63. return nullptr;
  64. }
  65. MonoObject* ScriptEditorWindow::internal_getInstance(MonoString* ns, MonoString* typeName)
  66. {
  67. String strTypeName = toString(MonoUtil::monoToWString(typeName));
  68. String strNamespace = toString(MonoUtil::monoToWString(ns));
  69. String fullName = strNamespace + "." + strTypeName;
  70. auto findIter = OpenScriptEditorWindows.find(fullName);
  71. if (findIter != OpenScriptEditorWindows.end())
  72. return findIter->second.nativeObj->mManagedInstance;
  73. return nullptr;
  74. }
  75. EditorWidgetBase* ScriptEditorWindow::getEditorWidget() const
  76. {
  77. return mEditorWidget;
  78. }
  79. void ScriptEditorWindow::_onManagedInstanceDeleted()
  80. {
  81. if (!mRefreshInProgress)
  82. {
  83. unregisterScriptEditorWindow(mName);
  84. ScriptObject::_onManagedInstanceDeleted();
  85. }
  86. else
  87. mManagedInstance = nullptr;
  88. }
  89. ScriptObjectBackup ScriptEditorWindow::beginRefresh()
  90. {
  91. mRefreshInProgress = true;
  92. auto iterFind = OpenScriptEditorWindows.find(mName);
  93. if (iterFind != OpenScriptEditorWindows.end())
  94. {
  95. EditorWindowHandle handle = iterFind->second;
  96. mono_gchandle_free(handle.gcHandle);
  97. iterFind->second.gcHandle = 0;
  98. }
  99. return PersistentScriptObjectBase::beginRefresh();
  100. }
  101. void ScriptEditorWindow::endRefresh(const ScriptObjectBackup& backupData)
  102. {
  103. mRefreshInProgress = false;
  104. if (!isDestroyed())
  105. mManagedInstance = mEditorWidget->getManagedInstance();
  106. else
  107. mManagedInstance = nullptr;
  108. if (mManagedInstance != nullptr)
  109. {
  110. auto iterFind = OpenScriptEditorWindows.find(mName);
  111. if (iterFind != OpenScriptEditorWindows.end())
  112. {
  113. iterFind->second.gcHandle = mono_gchandle_new(mManagedInstance, false);
  114. }
  115. mEditorWidget->triggerOnInitialize();
  116. }
  117. else
  118. {
  119. // We couldn't restore managed instance because window class cannot be found
  120. _onManagedInstanceDeleted();
  121. }
  122. PersistentScriptObjectBase::endRefresh(backupData);
  123. }
  124. void ScriptEditorWindow::onAssemblyRefreshStarted()
  125. {
  126. if (!isDestroyed())
  127. mEditorWidget->triggerOnDestroy();
  128. }
  129. MonoObject* ScriptEditorWindow::_createManagedInstance(bool construct)
  130. {
  131. if (!isDestroyed())
  132. {
  133. mEditorWidget->createManagedInstance();
  134. return mEditorWidget->getManagedInstance();
  135. }
  136. else
  137. return nullptr;
  138. }
  139. bool ScriptEditorWindow::internal_hasFocus(ScriptEditorWindow* thisPtr)
  140. {
  141. if (!thisPtr->isDestroyed())
  142. return thisPtr->getEditorWidget()->hasFocus();
  143. else
  144. return false;
  145. }
  146. void ScriptEditorWindow::internal_screenToWindowPos(ScriptEditorWindow* thisPtr, Vector2I screenPos, Vector2I* windowPos)
  147. {
  148. if (!thisPtr->isDestroyed())
  149. *windowPos = thisPtr->getEditorWidget()->screenToWidgetPos(screenPos);
  150. else
  151. *windowPos = screenPos;
  152. }
  153. void ScriptEditorWindow::internal_windowToScreenPos(ScriptEditorWindow* thisPtr, Vector2I windowPos, Vector2I* screenPos)
  154. {
  155. if (!thisPtr->isDestroyed())
  156. *screenPos = thisPtr->getEditorWidget()->widgetToScreenPos(windowPos);
  157. else
  158. *screenPos = windowPos;
  159. }
  160. UINT32 ScriptEditorWindow::internal_getWidth(ScriptEditorWindow* thisPtr)
  161. {
  162. if (!thisPtr->isDestroyed())
  163. return thisPtr->mEditorWidget->getWidth();
  164. else
  165. return 0;
  166. }
  167. UINT32 ScriptEditorWindow::internal_getHeight(ScriptEditorWindow* thisPtr)
  168. {
  169. if (!thisPtr->isDestroyed())
  170. return thisPtr->mEditorWidget->getHeight();
  171. else
  172. return 0;
  173. }
  174. void ScriptEditorWindow::onWidgetResized(UINT32 width, UINT32 height)
  175. {
  176. if (isDestroyed() || mManagedInstance == nullptr)
  177. return;
  178. void* params[2] = { &width, &height };
  179. onResizedMethod->invokeVirtual(mManagedInstance, params);
  180. }
  181. void ScriptEditorWindow::onFocusChanged(bool inFocus)
  182. {
  183. if (isDestroyed() || mManagedInstance == nullptr)
  184. return;
  185. void* params[1] = { &inFocus};
  186. onFocusChangedMethod->invokeVirtual(mManagedInstance, params);
  187. }
  188. void ScriptEditorWindow::registerManagedEditorWindows()
  189. {
  190. MonoAssembly* assembly = MonoManager::instance().getAssembly(EDITOR_ASSEMBLY);
  191. if(assembly != nullptr)
  192. {
  193. MonoClass* editorWindowClass = assembly->getClass("BansheeEditor", "EditorWindow");
  194. const Vector<MonoClass*>& allClasses = assembly->getAllClasses();
  195. for(auto& curClass : allClasses)
  196. {
  197. if(curClass->isSubClassOf(editorWindowClass) && curClass != editorWindowClass)
  198. {
  199. const String& className = curClass->getFullName();
  200. EditorWidgetManager::instance().registerWidget(className,
  201. std::bind(&ScriptEditorWindow::openEditorWidgetCallback, curClass->getNamespace(), curClass->getTypeName(), std::placeholders::_1));
  202. AvailableWindowTypes.push_back(className);
  203. }
  204. }
  205. }
  206. }
  207. void ScriptEditorWindow::clearRegisteredEditorWindow()
  208. {
  209. for (auto& windowType : AvailableWindowTypes)
  210. {
  211. EditorWidgetManager::instance().unregisterWidget(windowType);
  212. }
  213. AvailableWindowTypes.clear();
  214. }
  215. EditorWidgetBase* ScriptEditorWindow::openEditorWidgetCallback(String ns, String type, EditorWidgetContainer& parentContainer)
  216. {
  217. ScriptEditorWidget* editorWidget = bs_new<ScriptEditorWidget>(ns, type, parentContainer);
  218. ScriptEditorWindow* nativeInstance = new (bs_alloc<ScriptEditorWindow>()) ScriptEditorWindow(editorWidget);
  219. ScriptEditorWindow::registerScriptEditorWindow(nativeInstance);
  220. mono_runtime_object_init(editorWidget->getManagedInstance()); // Construct it
  221. editorWidget->setScriptOwner(nativeInstance);
  222. editorWidget->triggerOnInitialize();
  223. return editorWidget;
  224. }
  225. void ScriptEditorWindow::registerScriptEditorWindow(ScriptEditorWindow* editorWindow)
  226. {
  227. if(editorWindow == nullptr)
  228. return;
  229. auto findIter = OpenScriptEditorWindows.find(editorWindow->mName);
  230. if(findIter == OpenScriptEditorWindows.end())
  231. {
  232. EditorWindowHandle newHandle;
  233. newHandle.nativeObj = editorWindow;
  234. newHandle.gcHandle = mono_gchandle_new(editorWindow->mManagedInstance, false);
  235. OpenScriptEditorWindows[editorWindow->mName] = newHandle;
  236. }
  237. }
  238. void ScriptEditorWindow::unregisterScriptEditorWindow(const String& windowTypeName)
  239. {
  240. auto findIter = OpenScriptEditorWindows.find(windowTypeName);
  241. if(findIter != OpenScriptEditorWindows.end())
  242. {
  243. EditorWindowHandle& foundHandle = findIter->second;
  244. mono_gchandle_free(foundHandle.gcHandle);
  245. OpenScriptEditorWindows.erase(findIter);
  246. }
  247. }
  248. ScriptEditorWidget::ScriptEditorWidget(const String& ns, const String& type, EditorWidgetContainer& parentContainer)
  249. :EditorWidgetBase(HString(toWString(type)), ns + "." + type, parentContainer), mNamespace(ns), mTypename(type),
  250. mUpdateThunk(nullptr), mManagedInstance(nullptr), mOnInitializeThunk(nullptr), mOnDestroyThunk(nullptr),
  251. mContentsPanel(nullptr), mScriptOwner(nullptr), mGetDisplayName(nullptr)
  252. {
  253. if(createManagedInstance())
  254. {
  255. if (mGetDisplayName != nullptr)
  256. {
  257. MonoObject* displayNameMono = mGetDisplayName->invokeVirtual(mManagedInstance, nullptr);
  258. ScriptHString* scriptHString = ScriptHString::toNative(displayNameMono);
  259. if (scriptHString != nullptr)
  260. {
  261. mDisplayName = HString(scriptHString->getInternalValue());
  262. parentContainer.refreshWidgetNames();
  263. }
  264. }
  265. }
  266. }
  267. ScriptEditorWidget::~ScriptEditorWidget()
  268. {
  269. mScriptOwner->mIsDestroyed = true;
  270. mScriptOwner->mEditorWidget = nullptr;
  271. mContentsPanel->destroyChildren();
  272. mContentsPanel->markAsDestroyed();
  273. mContentsPanel = nullptr;
  274. triggerOnDestroy();
  275. ScriptEditorWindow::unregisterScriptEditorWindow(getName());
  276. }
  277. bool ScriptEditorWidget::createManagedInstance()
  278. {
  279. MonoAssembly* assembly = MonoManager::instance().getAssembly(EDITOR_ASSEMBLY);
  280. if (assembly != nullptr)
  281. {
  282. MonoClass* editorWindowClass = assembly->getClass(mNamespace, mTypename);
  283. if (editorWindowClass != nullptr)
  284. {
  285. mManagedInstance = editorWindowClass->createInstance();
  286. MonoObject* guiPanel = ScriptGUIPanel::createFromExisting(mContent);
  287. mContentsPanel = ScriptGUILayout::toNative(guiPanel);
  288. ScriptEditorWindow::guiPanelField->setValue(mManagedInstance, guiPanel);
  289. reloadMonoTypes(editorWindowClass);
  290. return true;
  291. }
  292. }
  293. return false;
  294. }
  295. void ScriptEditorWidget::triggerOnInitialize()
  296. {
  297. if (mOnInitializeThunk != nullptr && mManagedInstance != nullptr)
  298. {
  299. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  300. // for some extra speed.
  301. MonoUtil::invokeThunk(mOnInitializeThunk, mManagedInstance);
  302. }
  303. }
  304. void ScriptEditorWidget::triggerOnDestroy()
  305. {
  306. if (mOnDestroyThunk != nullptr && mManagedInstance != nullptr)
  307. {
  308. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  309. // for some extra speed.
  310. MonoUtil::invokeThunk(mOnDestroyThunk, mManagedInstance);
  311. }
  312. }
  313. void ScriptEditorWidget::update()
  314. {
  315. if (mUpdateThunk != nullptr && mManagedInstance != nullptr)
  316. {
  317. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  318. // for some extra speed.
  319. MonoUtil::invokeThunk(mUpdateThunk, mManagedInstance);
  320. }
  321. }
  322. void ScriptEditorWidget::reloadMonoTypes(MonoClass* windowClass)
  323. {
  324. MonoMethod* updateMethod = windowClass->getMethod("OnEditorUpdate", 0);
  325. if (updateMethod != nullptr)
  326. mUpdateThunk = (UpdateThunkDef)updateMethod->getThunk();
  327. MonoMethod* onInitializeMethod = windowClass->getMethod("OnInitialize", 0);
  328. if (onInitializeMethod != nullptr)
  329. mOnInitializeThunk = (OnInitializeThunkDef)onInitializeMethod->getThunk();
  330. MonoMethod* onDestroyMethod = windowClass->getMethod("OnDestroy", 0);
  331. if (onDestroyMethod != nullptr)
  332. mOnDestroyThunk = (OnDestroyThunkDef)onDestroyMethod->getThunk();
  333. mGetDisplayName = windowClass->getMethod("GetDisplayName", 0);
  334. }
  335. }