BsScriptEditorWindow.cpp 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465
  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. {
  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. bool ScriptEditorWindow::internal_isActive(ScriptEditorWindow* thisPtr)
  147. {
  148. if (!thisPtr->isDestroyed())
  149. return thisPtr->getEditorWidget()->isActive();
  150. else
  151. return false;
  152. }
  153. void ScriptEditorWindow::internal_screenToWindowPos(ScriptEditorWindow* thisPtr, Vector2I* screenPos, Vector2I* windowPos)
  154. {
  155. if (!thisPtr->isDestroyed())
  156. *windowPos = thisPtr->getEditorWidget()->screenToWidgetPos(*screenPos);
  157. else
  158. *windowPos = *screenPos;
  159. }
  160. void ScriptEditorWindow::internal_windowToScreenPos(ScriptEditorWindow* thisPtr, Vector2I* windowPos, Vector2I* screenPos)
  161. {
  162. if (!thisPtr->isDestroyed())
  163. *screenPos = thisPtr->getEditorWidget()->widgetToScreenPos(*windowPos);
  164. else
  165. *screenPos = *windowPos;
  166. }
  167. UINT32 ScriptEditorWindow::internal_getWidth(ScriptEditorWindow* thisPtr)
  168. {
  169. if (!thisPtr->isDestroyed())
  170. return thisPtr->mEditorWidget->getWidth();
  171. else
  172. return 0;
  173. }
  174. UINT32 ScriptEditorWindow::internal_getHeight(ScriptEditorWindow* thisPtr)
  175. {
  176. if (!thisPtr->isDestroyed())
  177. return thisPtr->mEditorWidget->getHeight();
  178. else
  179. return 0;
  180. }
  181. void ScriptEditorWindow::internal_getBounds(ScriptEditorWindow* thisPtr, Rect2I* bounds)
  182. {
  183. if (!thisPtr->isDestroyed())
  184. {
  185. EditorWidgetBase* widget = thisPtr->getEditorWidget();
  186. *bounds = thisPtr->getEditorWidget()->getBounds();
  187. Vector2I widgetPos(bounds->x, bounds->y);
  188. Vector2I screenPos = widget->widgetToScreenPos(widgetPos);
  189. bounds->x = screenPos.x;
  190. bounds->y = screenPos.y;
  191. }
  192. else
  193. *bounds = Rect2I();
  194. }
  195. void ScriptEditorWindow::onWidgetResized(UINT32 width, UINT32 height)
  196. {
  197. if (isDestroyed() || !mEditorWidget->isInitialized() || mManagedInstance == nullptr)
  198. return;
  199. void* params[2] = { &width, &height };
  200. onResizedMethod->invokeVirtual(mManagedInstance, params);
  201. }
  202. void ScriptEditorWindow::onFocusChanged(bool inFocus)
  203. {
  204. if (isDestroyed() || mManagedInstance == nullptr)
  205. return;
  206. void* params[1] = { &inFocus};
  207. onFocusChangedMethod->invokeVirtual(mManagedInstance, params);
  208. }
  209. void ScriptEditorWindow::registerManagedEditorWindows()
  210. {
  211. MonoAssembly* assembly = MonoManager::instance().getAssembly(EDITOR_ASSEMBLY);
  212. if(assembly != nullptr)
  213. {
  214. MonoClass* defaultSizeAttrib = assembly->getClass("BansheeEditor", "DefaultSize");
  215. if (defaultSizeAttrib == nullptr)
  216. BS_EXCEPT(InternalErrorException, "Cannot find DefaultSize managed class.");
  217. MonoField* defaultWidthField = defaultSizeAttrib->getField("width");
  218. MonoField* defaultHeightField = defaultSizeAttrib->getField("height");
  219. MonoClass* editorWindowClass = assembly->getClass("BansheeEditor", "EditorWindow");
  220. const Vector<MonoClass*>& allClasses = assembly->getAllClasses();
  221. for(auto& curClass : allClasses)
  222. {
  223. if(curClass->isSubClassOf(editorWindowClass) && curClass != editorWindowClass)
  224. {
  225. UINT32 width = 400;
  226. UINT32 height = 400;
  227. MonoObject* defaultSize = curClass->getAttribute(defaultSizeAttrib);
  228. if (defaultSize != nullptr)
  229. {
  230. defaultWidthField->getValue(defaultSize, &width);
  231. defaultHeightField->getValue(defaultSize, &height);
  232. }
  233. const String& className = curClass->getFullName();
  234. EditorWidgetManager::instance().registerWidget(className,
  235. std::bind(&ScriptEditorWindow::openEditorWidgetCallback, curClass->getNamespace(),
  236. curClass->getTypeName(), width, height, _1));
  237. AvailableWindowTypes.push_back(className);
  238. }
  239. }
  240. }
  241. }
  242. void ScriptEditorWindow::clearRegisteredEditorWindow()
  243. {
  244. for (auto& windowType : AvailableWindowTypes)
  245. {
  246. EditorWidgetManager::instance().unregisterWidget(windowType);
  247. }
  248. AvailableWindowTypes.clear();
  249. }
  250. EditorWidgetBase* ScriptEditorWindow::openEditorWidgetCallback(String ns, String type, UINT32 width,
  251. UINT32 height, EditorWidgetContainer& parentContainer)
  252. {
  253. ScriptEditorWidget* editorWidget = bs_new<ScriptEditorWidget>(ns, type, width, height, parentContainer);
  254. ScriptEditorWindow* nativeInstance = new (bs_alloc<ScriptEditorWindow>()) ScriptEditorWindow(editorWidget);
  255. ScriptEditorWindow::registerScriptEditorWindow(nativeInstance);
  256. mono_runtime_object_init(editorWidget->getManagedInstance()); // Construct it
  257. editorWidget->setScriptOwner(nativeInstance);
  258. return editorWidget;
  259. }
  260. void ScriptEditorWindow::registerScriptEditorWindow(ScriptEditorWindow* editorWindow)
  261. {
  262. if(editorWindow == nullptr)
  263. return;
  264. auto findIter = OpenScriptEditorWindows.find(editorWindow->mName);
  265. if(findIter == OpenScriptEditorWindows.end())
  266. {
  267. EditorWindowHandle newHandle;
  268. newHandle.nativeObj = editorWindow;
  269. newHandle.gcHandle = mono_gchandle_new(editorWindow->mManagedInstance, false);
  270. OpenScriptEditorWindows[editorWindow->mName] = newHandle;
  271. }
  272. }
  273. void ScriptEditorWindow::unregisterScriptEditorWindow(const String& windowTypeName)
  274. {
  275. auto findIter = OpenScriptEditorWindows.find(windowTypeName);
  276. if(findIter != OpenScriptEditorWindows.end())
  277. {
  278. EditorWindowHandle& foundHandle = findIter->second;
  279. mono_gchandle_free(foundHandle.gcHandle);
  280. OpenScriptEditorWindows.erase(findIter);
  281. }
  282. }
  283. ScriptEditorWidget::ScriptEditorWidget(const String& ns, const String& type, UINT32 defaultWidth,
  284. UINT32 defaultHeight, EditorWidgetContainer& parentContainer)
  285. :EditorWidgetBase(HString(toWString(type)), ns + "." + type, defaultWidth, defaultHeight, parentContainer),
  286. mNamespace(ns), mTypename(type), mUpdateThunk(nullptr), mManagedInstance(nullptr), mOnInitializeThunk(nullptr),
  287. mOnDestroyThunk(nullptr), mContentsPanel(nullptr), mScriptOwner(nullptr), mGetDisplayName(nullptr), mIsInitialized(false)
  288. {
  289. if(createManagedInstance())
  290. {
  291. if (mGetDisplayName != nullptr)
  292. {
  293. MonoObject* displayNameMono = mGetDisplayName->invokeVirtual(mManagedInstance, nullptr);
  294. ScriptHString* scriptHString = ScriptHString::toNative(displayNameMono);
  295. if (scriptHString != nullptr)
  296. {
  297. mDisplayName = HString(scriptHString->getInternalValue());
  298. parentContainer.refreshWidgetNames();
  299. }
  300. }
  301. }
  302. }
  303. ScriptEditorWidget::~ScriptEditorWidget()
  304. {
  305. mScriptOwner->mIsDestroyed = true;
  306. mScriptOwner->mEditorWidget = nullptr;
  307. mContentsPanel->destroy();
  308. mContentsPanel = nullptr;
  309. triggerOnDestroy();
  310. ScriptEditorWindow::unregisterScriptEditorWindow(getName());
  311. }
  312. bool ScriptEditorWidget::createManagedInstance()
  313. {
  314. const char* assemblies[2] = { EDITOR_ASSEMBLY, SCRIPT_EDITOR_ASSEMBLY };
  315. UINT32 numAssemblies = sizeof(assemblies) / sizeof(assemblies[0]);
  316. for (UINT32 i = 0; i < numAssemblies; i++)
  317. {
  318. MonoAssembly* assembly = MonoManager::instance().getAssembly(assemblies[i]);
  319. if (assembly != nullptr)
  320. {
  321. MonoClass* editorWindowClass = assembly->getClass(mNamespace, mTypename);
  322. if (editorWindowClass != nullptr)
  323. {
  324. mManagedInstance = editorWindowClass->createInstance();
  325. MonoObject* guiPanel = ScriptGUIPanel::createFromExisting(mContent);
  326. mContentsPanel = ScriptGUILayout::toNative(guiPanel);
  327. ScriptEditorWindow::guiPanelField->setValue(mManagedInstance, guiPanel);
  328. reloadMonoTypes(editorWindowClass);
  329. return true;
  330. }
  331. }
  332. }
  333. return false;
  334. }
  335. void ScriptEditorWidget::triggerOnInitialize()
  336. {
  337. if (mOnInitializeThunk != 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(mOnInitializeThunk, mManagedInstance);
  342. }
  343. }
  344. void ScriptEditorWidget::triggerOnDestroy()
  345. {
  346. if (mOnDestroyThunk != nullptr && mManagedInstance != nullptr)
  347. {
  348. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  349. // for some extra speed.
  350. MonoUtil::invokeThunk(mOnDestroyThunk, mManagedInstance);
  351. }
  352. }
  353. void ScriptEditorWidget::update()
  354. {
  355. if (!mIsInitialized)
  356. {
  357. triggerOnInitialize();
  358. mIsInitialized = true;
  359. }
  360. if (mUpdateThunk != nullptr && mManagedInstance != nullptr)
  361. {
  362. // Note: Not calling virtual methods. Can be easily done if needed but for now doing this
  363. // for some extra speed.
  364. MonoUtil::invokeThunk(mUpdateThunk, mManagedInstance);
  365. }
  366. }
  367. void ScriptEditorWidget::reloadMonoTypes(MonoClass* windowClass)
  368. {
  369. MonoMethod* updateMethod = windowClass->getMethod("OnEditorUpdate", 0);
  370. if (updateMethod != nullptr)
  371. mUpdateThunk = (UpdateThunkDef)updateMethod->getThunk();
  372. MonoMethod* onInitializeMethod = windowClass->getMethod("OnInitialize", 0);
  373. if (onInitializeMethod != nullptr)
  374. mOnInitializeThunk = (OnInitializeThunkDef)onInitializeMethod->getThunk();
  375. MonoMethod* onDestroyMethod = windowClass->getMethod("OnDestroy", 0);
  376. if (onDestroyMethod != nullptr)
  377. mOnDestroyThunk = (OnDestroyThunkDef)onDestroyMethod->getThunk();
  378. mGetDisplayName = windowClass->getMethod("GetDisplayName", 0);
  379. }
  380. }