BsScriptEditorWindow.cpp 14 KB

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