Merge pull request #239 from Ghabry/json

Add Glaze JSON bindings for QML interop with lcf data

Author: carstene1ns

.gitignore

@@ -32,6 +32,9 @@ Makefile*
 /.flatpak-builder
 /local-repo
 
+# appimage
+AppDir/
+
 # liblcf
 lib/liblcf
 

CMakeLists.txt

@@ -16,7 +16,7 @@ if(EDITOR_FIND_ROOT_PATH_APPEND)
 	list(APPEND CMAKE_FIND_ROOT_PATH "${CMAKE_PREFIX_PATH}")
 endif()
 
-# C++17 is required
+# C++23 is required
 set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
@@ -323,21 +323,48 @@ set(EDITOR_SOURCES
 )
 
 set(EDITOR_QML_UI
+	src/ui/common/CheckBox.qml
+	src/ui/common/SpinBox.qml
+	src/ui/common/TextField.qml
 	src/ui/MainWindow.qml
+	src/ui/database/DatabaseWindow.qml
+	src/ui/database/ActorPage.qml
+	src/ui/database/DatabaseEntryListPage.qml
+	src/ui/database/DatabaseEntryPage.qml
+	src/ui/database/DatabasePage.qml
+	src/ui/database/ItemPage.qml
+	src/ui/database/SkillPage.qml
+	src/ui/database/VocabularyPage.qml
 )
 
 set(EDITOR_QML_INTERFACE
-	src/qmlbinding/empty.h
+	src/qmlbinding/json_internals/json_t_database.cpp
+	src/qmlbinding/json_internals/json_t_impl.h
+	src/qmlbinding/json_internals/json_t_map.cpp
+	src/qmlbinding/json_internals/json_t_treemap.cpp
+	src/qmlbinding/json.h
+	src/qmlbinding/json_list_view.cpp
+	src/qmlbinding/json_list_view.h
+	src/qmlbinding/json_t.h
+	src/qmlbinding/json_view.cpp
+	src/qmlbinding/json_view.h
+	src/qmlbinding/lcf_glaze.h
+	src/qmlbinding/project_data_gadget.cpp
+	src/qmlbinding/project_data_gadget.h
 )
 
 # Dependencies
 set(QT_NO_PRIVATE_MODULE_WARNING ON)
-find_package(Qt6 ${REQUIRED_QT_VERSION} CONFIG REQUIRED COMPONENTS Widgets Core Multimedia Gui GuiPrivate Svg QuickControls2)
+find_package(Qt6 ${REQUIRED_QT_VERSION} CONFIG REQUIRED COMPONENTS
+	Widgets Core Multimedia Gui Svg
+	GuiPrivate QuickPrivate QuickControls2 WidgetsPrivate)
 find_package(Qt6LinguistTools CONFIG QUIET)
 find_package(ZLIB REQUIRED)
 find_package(glaze REQUIRED)
 find_package(KF6 ${KF_DEP_VERSION} REQUIRED COMPONENTS Kirigami)
 find_package(QQC2BreezeStyle REQUIRED)
+find_package(KDBindings QUIET) # only required by the static build
+find_package(KDDockWidgets-qt6 REQUIRED)
 
 qt_standard_project_setup(
 	REQUIRES "${REQUIRED_QT_VERSION}"
@@ -383,6 +410,11 @@ else()
 	endif()
 endif()
 
+if (CMAKE_CXX_COMPILER_ID MATCHES "Clang$")
+	# Fix template recursion limit hit by glaze
+	target_compile_options(${EXE_NAME} PRIVATE "-fbracket-depth=1024")
+endif()
+
 # Include directories
 target_include_directories(${EXE_NAME}
 	PUBLIC
@@ -462,6 +494,7 @@ endif()
 target_link_libraries(${EXE_NAME} PRIVATE
 	ZLIB::ZLIB
 	glaze::glaze
+	KDAB::kddockwidgets
 	Qt6::Widgets
 	Qt6::Gui
 	Qt6::Core
@@ -486,6 +519,7 @@ if(KIRIGAMI_TYPE STREQUAL "STATIC_LIBRARY")
 		KF6KirigamiPrivateplugin
 		KF6KirigamiPolyfillplugin
 	)
+	target_compile_definitions(${EXE_NAME} PUBLIC "-DKIRIGAMI_STATIC=1")
 endif()
 
 get_target_property(QQC2_TYPE org.kde.breeze TYPE)

CMakePresets.json

@@ -262,7 +262,7 @@
 			"name": "macos-parent",
 			"cacheVariables": {
 				"EDITOR_PREFIX_PATH_APPEND": "$env{EASYRPG_BUILDSCRIPTS}/macos/qt/6.10.1/macos",
-				"CMAKE_OSX_DEPLOYMENT_TARGET": "10.15",
+				"CMAKE_OSX_DEPLOYMENT_TARGET": "13.3",
 				"CMAKE_OSX_ARCHITECTURES": "arm64"
 			},
 			"environment": {

builds/cmake/CMakePresets.json.template

@@ -39,7 +39,7 @@
 			"displayName": "macOS",
 			"cacheVariables": {
 				"EDITOR_PREFIX_PATH_APPEND": "$env{EASYRPG_BUILDSCRIPTS}/macos/qt/6.10.1/macos",
-				"CMAKE_OSX_DEPLOYMENT_TARGET": "10.15",
+				"CMAKE_OSX_DEPLOYMENT_TARGET": "13.3",
 				"CMAKE_OSX_ARCHITECTURES": "arm64"
 			},
 			"environment": {

builds/vcpkg_overlay/kddockwidgets/portfile.cmake

@@ -45,7 +45,7 @@ vcpkg_cmake_configure(
         # https://github.com/KDAB/KDDockWidgets/blob/v2.1.0/CMakeLists.txt#L301
         -DCMAKE_DISABLE_FIND_PACKAGE_spdlog=ON
         -DCMAKE_DISABLE_FIND_PACKAGE_fmt=ON
-        -DCMAKE_REQUIRE_FIND_PACKAGE_nlohmann_json=ON
+        -DCMAKE_DISABLE_FIND_PACKAGE_nlohmann_json=ON
         "-DCMAKE_PREFIX_PATH=$ENV{Qt6_Path}"
 )
 

src/core.cpp

@@ -22,9 +22,12 @@
 #include <QGraphicsView>
 #include <QPainter>
 #include <QDebug>
+#include <QQmlApplicationEngine>
 #include "ui/map/map_scene.h"
 #include "common/dbstring.h"
 #include "common/image_loader.h"
+#include <kddockwidgets/Config.h>
+#include <kddockwidgets/qtquick/Platform.h>
 
 //define static member
 Core *Core::core_instance = nullptr;
@@ -684,6 +687,16 @@ const std::shared_ptr<Project>& Core::project() const {
 	return m_project;
 }
 
+QQmlApplicationEngine* Core::qmlEngine() {
+	if (!m_qml_engine) {
+		m_qml_engine = new QQmlApplicationEngine();
+		KDDockWidgets::initFrontend(KDDockWidgets::FrontendType::QtQuick);
+		KDDockWidgets::QtQuick::Platform::instance()->setQmlEngine(m_qml_engine);
+	}
+
+	return m_qml_engine;
+}
+
 void Core::beginPainting(QPixmap &dest)
 {
 	m_painter.begin(&dest);

src/core.h

@@ -28,6 +28,7 @@
 #include <QPixmap>
 #include <QPainter>
 #include <QListWidget>
+#include <QQmlApplicationEngine>
 #include <lcf/rpg/map.h>
 #include <lcf/rpg/chipset.h>
 #include "ui/other/run_game_dialog.h"
@@ -117,6 +118,8 @@ class Core : public QObject
 	std::shared_ptr<Project>& project();
 	const std::shared_ptr<Project>& project() const;
 
+	QQmlApplicationEngine* qmlEngine();
+
 signals:
 	void toolChanged();
 
@@ -151,6 +154,7 @@ class Core : public QObject
 	QMap<int, lcf::rpg::Event*> *m_currentMapEvents;
 	RunGameDialog *m_runGameDialog;
 	std::shared_ptr<Project> m_project;
+	QQmlApplicationEngine* m_qml_engine = nullptr;
 };
 
 Core& core();

src/main.cpp

@@ -15,6 +15,7 @@
  * along with EasyRPG Editor. If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "core.h"
 #include "ui/main_window.h"
 #include <QApplication>
 #include <QSplashScreen>
@@ -41,7 +42,7 @@ int main(int argc, char *argv[]) {
 
 	// Kirigami only loads a custom style when using a static build
 	// Lets wait for upstream to improve this
-#if defined(_WIN32) || defined(__APPLE__)
+#if defined(KIRIGAMI_STATIC)
     // Default to org.kde.breeze style (from qqc2-breeze style)
 	if (qEnvironmentVariableIsEmpty("QT_QUICK_CONTROLS_STYLE")) {
 		const char* fstyle = "KIRIGAMI_FORCE_STYLE";
@@ -67,18 +68,19 @@ int main(int argc, char *argv[]) {
 
 	s.showMessage("EasyRPG Editor");
 	//s.show();
+
 #ifdef NDEBUG
 	// close splash after 3 seconds for release
 	QTimer::singleShot(3000, &s, &QWidget::close);
 #endif
 
 	// setup qml engine
-	QQmlApplicationEngine engine;
-	engine.loadFromModule("org.easyrpg.editor", "MainWindow");
+	auto engine = core().qmlEngine();
 
-	if (engine.rootObjects().isEmpty()) {
+	/*engine->loadFromModule("org.easyrpg.editor", "MainWindow");
+	if (engine->rootObjects().isEmpty()) {
 		return -1;
-	}
+	}*/
 
 	// load translations
 	s.showMessage("Loading translations...");

src/model/project.cpp

@@ -168,7 +168,7 @@ QString Project::findFile(const QString& dir, const QString& filename, FileFinde
 	return FileFinder::Find(projectDir().absolutePath(), dir, filename, type);
 }
 
-QString Project::findFileOrDefault(const QString& filename) {
+QString Project::findFileOrDefault(const QString& filename) const {
 	QString found = findFile(filename);
 	return found.isEmpty() ? FileFinder::CombinePath(projectDir().absolutePath(), filename) : found;
 }

src/model/project.h

@@ -54,7 +54,7 @@ class Project {
 	 * @param filename File to find
 	 * @return Found file or the passed filename when not found
 	 */
-	QString findFileOrDefault(const QString& filename);
+	QString findFileOrDefault(const QString& filename) const;
 
 	QString findDirectory(const QString& dir) const;
 	QString findDirectory(const QString& baseDir, const QString& dir) const;