BsScriptEditorWindow.cpp 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462
  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_GetBounds", &ScriptEditorWindow::internal_getBounds);
  46. metaData.scriptClass->addInternalCall("Internal_HasFocus", &ScriptEditorWindow::internal_hasFocus);
  47. metaData.scriptClass->addInternalCall("Internal_IsActive", &ScriptEditorWindow::internal_isActive);
  48. metaData.scriptClass->addInternalCall("Internal_ScreenToWindowPos", &ScriptEditorWindow::internal_screenToWindowPos);
  49. metaData.scriptClass->addInternalCall("Internal_WindowToScreenPos", &ScriptEditorWindow::internal_windowToScreenPos);
  50. onResizedMethod = metaData.scriptClass->getMethod("WindowResized", 2);
  51. onFocusChangedMethod = metaData.scriptClass->getMethod("FocusChanged", 1);
  52. guiPanelField = metaData.scriptClass->getField("GUI");
  53. }
  54. MonoObject* ScriptEditorWindow::internal_createOrGetInstance(MonoString* ns, MonoString* typeName)
  55. {
  56. String strTypeName = toString(MonoUtil::monoToWString(typeName));
  57. String strNamespace = toString(MonoUtil::monoToWString(ns));
  58. String fullName = strNamespace + "." + strTypeName;
  59. auto findIter = OpenScriptEditorWindows.find(fullName);
  60. if(findIter != OpenScriptEditorWindows.end())
  61. return findIter->second.nativeObj->mManagedInstance;
  62. EditorWidgetManager::instance().open(fullName); // This will trigger openEditorWidgetCallback and update OpenScriptEditorWindows
  63. auto findIter2 = OpenScriptEditorWindows.find(fullName);
  64. if(findIter2 != OpenScriptEditorWindows.end())
  65. return findIter2->second.nativeObj->mManagedInstance;
  66. return nullptr;
  67. }
  68. MonoObject* ScriptEditorWindow::internal_getInstance(MonoString* ns, MonoString* typeName)
  69. {
  70. String strTypeName = toString(MonoUtil::monoToWString(typeName));
  71. String strNamespace = toString(MonoUtil::monoToWString(ns));
  72. String fullName = strNamespace + "." + strTypeName;
  73. auto findIter = OpenScriptEditorWindows.find(fullName);
  74. if (findIter != OpenScriptEditorWindows.end())
  75. return findIter->second.nativeObj->mManagedInstance;
  76. return nullptr;
  77. }
  78. EditorWidgetBase* ScriptEditorWindow::getEditorWidget() const
  79. {
  80. return mEditorWidget;
  81. }
  82. void ScriptEditorWindow::_onManagedInstanceDeleted()
  83. {
  84. if (!mRefreshInProgress)
  85. ScriptObject::_onManagedInstanceDeleted();
  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. iterFind->second.gcHandle = mono_gchandle_new(mManagedInstance, false);
  113. }
  114. else
  115. {
  116. // We couldn't restore managed instance because window class cannot be found
  117. _onManagedInstanceDeleted();
  118. }
  119. PersistentScriptObjectBase::endRefresh(backupData);
  120. }
  121. void ScriptEditorWindow::onAssemblyRefreshStarted()
  122. {
  123. if (!isDestroyed())
  124. mEditorWidget->triggerOnDestroy();
  125. }
  126. MonoObject* ScriptEditorWindow::_createManagedInstance(bool construct)
  127. {
  128. if (!isDestroyed())
  129. {
  130. mEditorWidget->createManagedInstance();
  131. return mEditorWidget->getManagedInstance();
  132. }
  133. else
  134. return nullptr;
  135. }
  136. bool ScriptEditorWindow::internal_hasFocus(ScriptEditorWindow* thisPtr)
  137. {
  138. if (!thisPtr->isDestroyed())
  139. return thisPtr->getEditorWidget()->hasFocus();
  140. else
  141. return false;
  142. }
  143. bool ScriptEditorWindow::internal_isActive(ScriptEditorWindow* thisPtr)
  144. {
  145. if (!thisPtr->isDestroyed())
  146. return thisPtr->getEditorWidget()->isActive();
  147. else
  148. return false;
  149. }
  150. void ScriptEditorWindow::internal_screenToWindowPos(ScriptEditorWindow* thisPtr, Vector2I* screenPos, Vector2I* windowPos)
  151. {
  152. if (!thisPtr->isDestroyed())
  153. *windowPos = thisPtr->getEditorWidget()->screenToWidgetPos(*screenPos);
  154. else
  155. *windowPos = *screenPos;
  156. }
  157. void ScriptEditorWindow::internal_windowToScreenPos(ScriptEditorWindow* thisPtr, Vector2I* windowPos, Vector2I* screenPos)
  158. {
  159. if (!thisPtr->isDestroyed())
  160. *screenPos = thisPtr->getEditorWidget()->widgetToScreenPos(*windowPos);
  161. else
  162. *screenPos = *windowPos;
  163. }
  164. UINT32 ScriptEditorWindow::internal_getWidth(ScriptEditorWindow* thisPtr)
  165. {
  166. if (!thisPtr->isDestroyed())
  167. return thisPtr->mEditorWidget->getWidth();
  168. else
  169. return 0;
  170. }
  171. UINT32 ScriptEditorWindow::internal_getHeight(ScriptEditorWindow* thisPtr)
  172. {
  173. if (!thisPtr->isDestroyed())
  174. return thisPtr->mEditorWidget->getHeight();
  175. else
  176. return 0;
  177. }
  178. void ScriptEditorWindow::internal_getBounds(ScriptEditorWindow* thisPtr, Rect2I* bounds)
  179. {
  180. if (!thisPtr->isDestroyed())
  181. {
  182. EditorWidgetBase* widget = thisPtr->getEditorWidget();
  183. *bounds = thisPtr->getEditorWidget()->getBounds();
  184. Vector2I widgetPos(bounds->x, bounds->y);
  185. Vector2I screenPos = widget->widgetToScreenPos(widgetPos);
  186. bounds->x = screenPos.x;
  187. bounds->y = screenPos.y;
  188. }
  189. else
  190. *bounds = Rect2I();
  191. }
  192. void ScriptEditorWindow::onWidgetResized(UINT32 width, UINT32 height)
  193. {
  194. if (isDestroyed() || !mEditorWidget->isInitialized() || mManagedInstance == nullptr)
  195. return;
  196. void* params[2] = { &width, &height };
  197. onResizedMethod->invokeVirtual(mManagedInstance, params);
  198. }
  199. void ScriptEditorWindow::onFocusChanged(bool inFocus)
  200. {
  201. if (isDestroyed() || mManagedInstance == nullptr)
  202. return;
  203. void* params[1] = { &inFocus};
  204. onFocusChangedMethod->invokeVirtual(mManagedInstance, params);
  205. }
  206. void ScriptEditorWindow::registerManagedEditorWindows()
  207. {
  208. MonoAssembly* assembly = MonoManager::instance().getAssembly(EDITOR_ASSEMBLY);
  209. if(assembly != nullptr)
  210. {
  211. MonoClass* defaultSizeAttrib = assembly->getClass("BansheeEditor", "DefaultSize");
  212. if (defaultSizeAttrib == nullptr)
  213. BS_EXCEPT(InternalErrorException, "Cannot find DefaultSize managed class.");
  214. MonoField* defaultWidthField = defaultSizeAttrib->getField("width");
  215. MonoField* defaultHeightField = defaultSizeAttrib->getField("height");
  216. MonoClass* editorWindowClass = assembly->getClass("BansheeEditor", "EditorWindow");
  217. const Vector<MonoClass*>& allClasses = assembly->getAllClasses();
  218. for(auto& curClass : allClasses)
  219. {
  220. if(curClass->isSubClassOf(editorWindowClass) && curClass != editorWindowClass)
  221. {
  222. UINT32 width = 400;
  223. UINT32 height = 400;
  224. MonoObject* defaultSize = curClass->getAttribute(defaultSizeAttrib);
  225. if (defaultSize != nullptr)
  226. {
  227. defaultWidthField->getValue(defaultSize, &width);
  228. defaultHeightField->getValue(defaultSize, &height);
  229. }
  230. const String& className = curClass->getFullName();
  231. EditorWidgetManager::instance().registerWidget(className,
  232. std::bind(&ScriptEditorWindow::openEditorWidgetCallback, curClass->getNamespace(),
  233. curClass->getTypeName(), width, height, _1));
  234. AvailableWindowTypes.push_back(className);
  235. }
  236. }
  237. }
  238. }
  239. void ScriptEditorWindow::clearRegisteredEditorWindow()
  240. {
  241. for (auto& windowType : AvailableWindowTypes)
  242. {
  243. EditorWidgetManager::instance().unregisterWidget(windowType);
  244. }
  245. AvailableWindowTypes.clear();
  246. }
  247. EditorWidgetBase* ScriptEditorWindow::openEditorWidgetCallback(String ns, String type, UINT32 width,
  248. UINT32 height, EditorWidgetContainer& parentContainer)
  249. {
  250. ScriptEditorWidget* editorWidget = bs_new<ScriptEditorWidget>(ns, type, width, height, parentContainer);
  251. ScriptEditorWindow* nativeInstance = new (bs_alloc<ScriptEditorWindow>()) ScriptEditorWindow(editorWidget);
  252. ScriptEditorWindow::registerScriptEditorWindow(nativeInstance);
  253. mono_runtime_object_init(editorWidget->getManagedInstance()); // Construct it
  254. editorWidget->setScriptOwner(nativeInstance);
  255. return editorWidget;
  256. }
  257. void ScriptEditorWindow::registerScriptEditorWindow(ScriptEditorWindow* editorWindow)
  258. {
  259. if(editorWindow == nullptr)
  260. return;
  261. auto findIter = OpenScriptEditorWindows.find(editorWindow->mName);
  262. if(findIter == OpenScriptEditorWindows.end())
  263. {
  264. EditorWindowHandle newHandle;
  265. newHandle.nativeObj = editorWindow;
  266. newHandle.gcHandle = mono_gchandle_new(editorWindow->mManagedInstance, false);
  267. OpenScriptEditorWindows[editorWindow->mName] = newHandle;
  268. }
  269. }
  270. void ScriptEditorWindow::unregisterScriptEditorWindow(const String& windowTypeName)
  271. {
  272. auto findIter = OpenScriptEditorWindows.find(windowTypeName);
  273. if(findIter != OpenScriptEditorWindows.end())
  274. {
  275. EditorWindowHandle& foundHandle = findIter->second;
  276. mono_gchandle_free(foundHandle.gcHandle);
  277. OpenScriptEditorWindows.erase(findIter);
  278. }
  279. }
  280. ScriptEditorWidget::ScriptEditorWidget(const String& ns, const String& type, UINT32 defaultWidth,
  281. UINT32 defaultHeight, EditorWidgetContainer& parentContainer)
  282. :EditorWidgetBase(HString(toWString(type)), ns + "." + type, defaultWidth, defaultHeight, parentContainer),
  283. mNamespace(ns), mTypename(type), mUpdateThunk(nullptr), mManagedInstance(nullptr), mOnInitializeThunk(nullptr),
  284. mOnDestroyThunk(nullptr), mContentsPanel(nullptr), mScriptOwner(nullptr), mGetDisplayName(nullptr), mIsInitialized(false)
  285. {
  286. if(createManagedInstance())
  287. {
  288. if (mGetDisplayName != nullptr)
  289. {
  290. MonoObject* displayNameMono = mGetDisplayName->invokeVirtual(mManagedInstance, nullptr);
  291. ScriptHString* scriptHString = ScriptHString::toNative(displayNameMono);
  292. if (scriptHString != nullptr)
  293. {
  294. mDisplayName = HString(scriptHString->getInternalValue());
  295. parentContainer.refreshWidgetNames();
  296. }
  297. }
  298. }
  299. }
  300. ScriptEditorWidget::~ScriptEditorWidget()
  301. {
  302. mScriptOwner->mIsDestroyed = true;
  303. mScriptOwner->mEditorWidget = nullptr;
  304. mContentsPanel->destroy();
  305. mContentsPanel = nullptr;
  306. triggerOnDestroy();
  307. ScriptEditorWindow::unregisterScriptEditorWindow(getName());
  308. }
  309. bool ScriptEditorWidget::createManagedInstance()
  310. {
  311. const char* assemblies[2] = { EDITOR_ASSEMBLY, SCRIPT_EDITOR_ASSEMBLY };
  312. UINT32 numAssemblies = sizeof(assemblies) / sizeof(assemblies[0]);
  313. for (UINT32 i = 0; i < numAssemblies; i++)
  314. {
  315. MonoAssembly* assembly = MonoManager::instance().getAssembly(assemblies[i]);
  316. if (assembly != nullptr)
  317. {
  318. MonoClass* editorWindowClass = assembly->getClass(mNamespace, mTypename);
  319. if (editorWindowClass != nullptr)
  320. {
  321. mManagedInstance = editorWindowClass->createInstance();
  322. MonoObject* guiPanel = ScriptGUIPanel::createFromExisting(mContent);
  323. mContentsPanel = ScriptGUILayout::toNative(guiPanel);
  324. ScriptEditorWindow::guiPanelField->setValue(mManagedInstance, guiPanel);
  325. reloadMonoTypes(editorWindowClass);
  326. return true;
  327. }
  328. }
  329. }
  330. return false;
  331. }
  332. void ScriptEditorWidget::triggerOnInitialize()
  333. {
  334. if (mOnInitializeThunk != nullptr && mManagedInstance != nullptr)
  335. {
  336. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  337. // for some extra speed.
  338. MonoUtil::invokeThunk(mOnInitializeThunk, mManagedInstance);
  339. }
  340. mIsInitialized = true;
  341. }
  342. void ScriptEditorWidget::triggerOnDestroy()
  343. {
  344. if (mOnDestroyThunk != nullptr && mManagedInstance != nullptr)
  345. {
  346. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  347. // for some extra speed.
  348. MonoUtil::invokeThunk(mOnDestroyThunk, mManagedInstance);
  349. }
  350. mIsInitialized = false;
  351. }
  352. void ScriptEditorWidget::update()
  353. {
  354. if (!mIsInitialized)
  355. triggerOnInitialize();
  356. if (mUpdateThunk != nullptr && mManagedInstance != nullptr)
  357. {
  358. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  359. // for some extra speed.
  360. MonoUtil::invokeThunk(mUpdateThunk, mManagedInstance);
  361. }
  362. }
  363. void ScriptEditorWidget::reloadMonoTypes(MonoClass* windowClass)
  364. {
  365. MonoMethod* updateMethod = windowClass->getMethod("OnEditorUpdate", 0);
  366. if (updateMethod != nullptr)
  367. mUpdateThunk = (UpdateThunkDef)updateMethod->getThunk();
  368. MonoMethod* onInitializeMethod = windowClass->getMethod("OnInitialize", 0);
  369. if (onInitializeMethod != nullptr)
  370. mOnInitializeThunk = (OnInitializeThunkDef)onInitializeMethod->getThunk();
  371. MonoMethod* onDestroyMethod = windowClass->getMethod("OnDestroy", 0);
  372. if (onDestroyMethod != nullptr)
  373. mOnDestroyThunk = (OnDestroyThunkDef)onDestroyMethod->getThunk();
  374. mGetDisplayName = windowClass->getMethod("GetDisplayName", 0);
  375. }
  376. }