first commit

Author: shnarda

.gitignore

@@ -0,0 +1,74 @@
+# This file is used to ignore files which are generated
+# ----------------------------------------------------------------------------
+
+*~
+*.autosave
+*.a
+*.core
+*.moc
+*.o
+*.obj
+*.orig
+*.rej
+*.so
+*.so.*
+*_pch.h.cpp
+*_resource.rc
+*.qm
+.#*
+*.*#
+core
+!core/
+tags
+.DS_Store
+.directory
+*.debug
+Makefile*
+*.prl
+*.app
+moc_*.cpp
+ui_*.h
+qrc_*.cpp
+Thumbs.db
+*.res
+*.rc
+/.qmake.cache
+/.qmake.stash
+
+# qtcreator generated files
+*.pro.user*
+CMakeLists.txt.user*
+
+# xemacs temporary files
+*.flc
+
+# Vim temporary files
+.*.swp
+
+# Visual Studio generated files
+*.ib_pdb_index
+*.idb
+*.ilk
+*.pdb
+*.sln
+*.suo
+*.vcproj
+*vcproj.*.*.user
+*.ncb
+*.sdf
+*.opensdf
+*.vcxproj
+*vcxproj.*
+
+# MinGW generated files
+*.Debug
+*.Release
+
+# Python byte code
+*.pyc
+
+# Binaries
+# --------
+*.dll
+*.exe
+

CMakeLists.txt

@@ -0,0 +1,50 @@
+cmake_minimum_required(VERSION 3.14)
+
+project(TaggedJsonObject LANGUAGES CXX)
+
+set(CMAKE_AUTOUIC ON)
+set(CMAKE_AUTOMOC ON)
+set(CMAKE_AUTORCC ON)
+
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+
+######################### Examples ############################
+find_package(QT NAMES Qt6 Qt5 REQUIRED COMPONENTS Core)
+find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Core)
+
+add_executable(Example
+  Examples/example.cpp
+  inc/taggedjsonobject.h
+  Examples/example.json
+  inc/taggedjsonobjectmacros.h
+  inc/map.h
+)
+target_include_directories(Example PRIVATE inc)
+target_link_libraries(Example Qt${QT_VERSION_MAJOR}::Core)
+
+######################## Tests ###############################
+
+# GTest package directives
+include(FetchContent)
+FetchContent_Declare(googletest
+        GIT_REPOSITORY https://github.com/google/googletest
+        GIT_TAG release-1.11.0)
+FetchContent_GetProperties(googletest)
+
+if(NOT googletest_POPULATED)
+  FetchContent_Populate(googletest)
+  add_subdirectory(${googletest_SOURCE_DIR} ${googletest_BUILD_DIR})
+endif()
+
+# Test files
+add_executable(testRunner Tests/taggedjsonobject_test.cpp
+)
+target_include_directories(testRunner PRIVATE inc)
+target_link_libraries(testRunner
+    Qt${QT_VERSION_MAJOR}::Core
+    gtest_main
+    gmock_main)
+
+

Examples/example.cpp

@@ -0,0 +1,66 @@
+#include "taggedjsonobject.h"
+#include "taggedjsonobjectmacros.h"
+
+/*
+Let's say, example.json file contains the following:
+
+{
+    "example_int": 42,
+    "example_str": "Hello world!",
+    "example_double": 35.5,
+    "example_sub_class":{
+        "example_sub_str": "Hello from an object!"
+    },
+    "example_arr": ["Hello", "World"],
+    "example_mixed_arr": [42, "is", "the", "answer", "to", "everything"]
+}
+*/
+
+DEFINE_JSON_TAGGED_OBJECT(InnerClass,
+                         (TaggedJSONString, example_sub_str))
+
+DEFINE_JSON_TAGGED_OBJECT(OuterClass,
+                          (TaggedJSONInt, example_int),
+                          (TaggedJSONString, example_str),
+                          (TaggedJSONDouble, example_double),
+                          (InnerClass, example_sub_class),
+                          (TaggedJSONStringArray, example_arr),
+                          (TaggedJSONVariantArray, example_mixed_arr))
+
+
+int main(int argc, char *argv[])
+{
+    QString jsonLocation("../../Examples/example.json");
+
+    //Create an instance of the tagged object that has been defined by the macro
+    OuterClass exampleObject(jsonLocation);
+
+    //Alternatively exampleObject.example_int.get() can be used as well
+    qDebug() << *exampleObject.example_int; //42
+
+    //Mutating stored values is allowed as long as the class isn't const
+    exampleObject.example_int = -1;
+    qDebug() << exampleObject.example_int; //-1
+
+    //Defining Tagged JSON objects inside another tagged JSON object allows chain access operations
+    qDebug() << *exampleObject.example_sub_class.example_sub_str; // "Hello from an object!"
+
+    //Arrays can be accessed by indexing
+    qDebug() << exampleObject.example_arr[0]; //"Hello"
+    exampleObject.example_arr.at(0) = "Another";
+    qDebug() << exampleObject.example_arr; //"Another World"
+
+    //Iterator access is available but it will be presented as QJsonValue
+    [[maybe_unused]] const QJsonArray::const_iterator it = exampleObject.example_arr->begin();
+    foreach(const QJsonValue& curText, *exampleObject.example_arr)
+        qDebug() << curText.toString(); //"Another<newline>World";
+
+    //JSON arrays with varied types can be integrated by TaggedJSONVariantArray
+    int answer_to_everything = exampleObject.example_mixed_arr[0].toInt();
+    QString text_everything = exampleObject.example_mixed_arr[5].toString();
+
+    qDebug() << answer_to_everything;
+    qDebug() << text_everything;
+
+    return 0;
+}

Examples/example.json

@@ -0,0 +1,10 @@
+{
+    "example_int": 42,
+    "example_str": "Hello world!",
+    "example_double": 35.5,
+    "example_sub_class":{
+        "example_sub_str": "Hello from an object!"
+    },
+    "example_arr": ["Hello", "World"],
+    "example_mixed_arr": [42, "is", "the", "answer", "to", "everything"]
+}