Merged new version

Librum-Reader · Jul 27, 2023 · 6c43982 · 6c43982
2 parents d279a48 + c1c8dd4
commit 6c43982
Show file tree

Hide file tree

Showing 93 changed files with 668 additions and 274 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,21 @@
 *.dll
 *.dylib
 
+# Windows
+/.vs/
+/.qtc_clangd/
+/.cmake/
+CMakeFiles/
+/Testing/
+/.qtc/
+/.qt/
+
+# Cmake
+CMakeCache.txt
+qtcsettings.cmake
+cmake_install.cmake
+build.ninja
+
 # Qt-es
 object_script.*.Release
 object_script.*.Debug

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,27 +3,41 @@ project(Librum VERSION 0.1
                LANGUAGES CXX)
 
 
+# Set output directory
+SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG "${PROJECT_BINARY_DIR}")
+SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE "${PROJECT_BINARY_DIR}")
+SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG "${PROJECT_BINARY_DIR}")
+SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE "${PROJECT_BINARY_DIR}")
+SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_DEBUG "${PROJECT_BINARY_DIR}")
+SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY_RELEASE "${PROJECT_BINARY_DIR}")
+
+
 # Configuration
-set (CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake)
 option(BUILD_TESTS ON)
 option(ENABLE_COVERAGE OFF)
 option(USE_SANITIZERS OFF) # Slows down program startup significantly
 
+if(WIN32)
+    add_compile_options(-Zc:rvalueCast -Zc:inline -Zc:strictStrings -Zc:throwingNew -permissive- -Zc:__cplusplus -Zc:externConstexpr -utf-8 -w34100 -w34189 -w44996 -w44456 -w44457 -w44458)
+    set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
+endif()
 
-# Create a set of warnings
-string(CONCAT LIBRUM_WARNINGS "-Wall;-Wextra;-Wshadow;-Wnon-virtual-dtor;-Wold-style-cast;-Wcast-align;"
-                              "-Wunused;-Woverloaded-virtual;-Wpedantic;-Wmissing-include-dirs;"
-                              "-Wnull-dereference;-Wdouble-promotion;-Wformat=2;-Wcast-qual;-Winit-self;"
-                              "-Wswitch-enum;-Wunreachable-code;-Wredundant-decls;")
-
-# GCC specific warnings
-if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") # If compiler is GCC
-    list(APPEND LIBRUM_WARNINGS "-Wduplicated-cond")
-    list(APPEND LIBRUM_WARNINGS "-Wduplicated-branches")
-    list(APPEND LIBRUM_WARNINGS "-Wunsafe-loop-optimizations")
-    list(APPEND LIBRUM_WARNINGS "-Wlogical-op")
-    list(APPEND LIBRUM_WARNINGS "-Wunsafe-loop-optimizations")
+# Create a set of warnings for unix systems
+if(UNIX)
+    string(CONCAT LIBRUM_WARNINGS "-Wall;-Wextra;-Wshadow;-Wnon-virtual-dtor;-Wold-style-cast;-Wcast-align;"
+                                  "-Wunused;-Woverloaded-virtual;-Wpedantic;-Wmissing-include-dirs;"
+                                  "-Wnull-dereference;-Wdouble-promotion;-Wformat=2;-Wcast-qual;-Winit-self;"
+                                  "-Wswitch-enum;-Wunreachable-code;-Wredundant-decls;")
+
+    # GCC specific warnings
+    if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") # If compiler is GCC
+        list(APPEND LIBRUM_WARNINGS "-Wduplicated-cond")
+        list(APPEND LIBRUM_WARNINGS "-Wduplicated-branches")
+        list(APPEND LIBRUM_WARNINGS "-Wunsafe-loop-optimizations")
+        list(APPEND LIBRUM_WARNINGS "-Wlogical-op")
+        list(APPEND LIBRUM_WARNINGS "-Wunsafe-loop-optimizations")
+    endif()
 endif()
 
 

diff --git a/README.md b/README.md
@@ -68,6 +68,8 @@ If you are interested in contributing, feel free to contact us on either:<br>
 <br>
 We are following a pull request workflow where every contribution is sent as a pull request and merged into the dev/develop branch for testing. <br>
 Please make sure to run clang format, keep to the conventions used throughout the application and ensure that all tests pass, before submitting any pull request.
+
+<br>
 <br>
 
 # Contact
@@ -126,22 +128,21 @@ Want a new feature? Feel free to leave a feature request ticket!
 
 <br><br>
 
-# Getting started
+# Build Guide
 
 Here's how to get Librum up and running in your environment.
 <br>
 
-### Prerequisites
-- cmake (at least version 3.21)     https://cmake.org/download/
-- make (or any other build system)  http://ftp.gnu.org/gnu/make/
-- g++ (or any other c++ compiler)   https://gcc.gnu.org/
-- python3-venv                      (on ubuntu use `sudo apt install python3-venv`)
-- Qt 6.5                            https://www.qt.io/download-open-source
-
-<br>
 
 ## For GNU/Linux
 
+### Prerequisites
+- cmake                             (https://cmake.org/download)
+- make                              (http://ftp.gnu.org/gnu/make)
+- g++                               (https://gcc.gnu.org)
+- python3-venv                      (on ubuntu use `sudo apt install python3-venv`)
+- Qt 6.5                            (https://www.qt.io/download-open-source)
+
 ### Installation
 The installation is straight forward, just follow the steps below:
 
@@ -187,8 +188,48 @@ Here are solutions to some common errors. If your error is not listed here, plea
 
 <br>
 
+
 ## For Windows
-Support coming soon!
+### Prerequisites
+- cmake                             (https://cmake.org/download)
+- Visual Studio <b>19</b>           (https://visualstudio.microsoft.com/de/vs/older-downloads)
+- Python                            (https://www.python.org/downloads)
+- Qt 6.5                            (https://www.qt.io/download-open-source)
+
+### Installation
+To build Librum on windows, run the following commands in the Powershell:
+
+<br>
+
+1. Clone the repository.
+    ```sh
+    git clone https://github.com/Etovex/Librum.git --recursive
+    ```
+2. Step into the cloned project folder.
+    ```sh
+    cd Librum
+    ```
+3. Create the build folder and step into it.
+    ```sh
+    mkdir build
+    cd build
+    ```
+4. Run cmake.
+    ```sh
+    cmake -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=<Drive>\\Qt\\<version>\\msvc2019_64 ..
+    ```
+    `CMAKE_PREFIX_PATH` needs to be set to the Qt install path, for example:
+    ```sh
+    cmake -DBUILD_TESTS=Off -DCMAKE_PREFIX_PATH=C:\\Qt\\6.5.1\\msvc2019_64 ..
+    ```
+6. Build the project
+    ```sh
+    cmake --build . --config Release
+    ```
+7. Run the app
+    ```sh
+    ./appLibrum
+    ```
 
 ## For macOS
 Support coming soon!
diff --git a/libs/googletest b/libs/googletest
diff --git a/libs/mupdf b/libs/mupdf
diff --git a/resources.qrc b/resources.qrc
@@ -203,5 +203,7 @@
         <file>resources/images/light_mode/utility/trash_red_icon.svg</file>
         <file>resources/images/light_mode/reading_options_popup/invert_color_icon.svg</file>
         <file>resources/images/dark_mode/reading_options_popup/invert_color_icon.svg</file>
+        <file>resources/images/light_mode/utility/cloud_off_icon.svg</file>
+        <file>resources/images/dark_mode/utility/cloud_off_icon.svg</file>
     </qresource>
 </RCC>
diff --git a/resources/images/dark_mode/utility/cloud_off_icon.svg b/resources/images/dark_mode/utility/cloud_off_icon.svg
diff --git a/resources/images/light_mode/utility/cloud_off_icon.svg b/resources/images/light_mode/utility/cloud_off_icon.svg
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -58,7 +58,7 @@ target_link_libraries(appLibrum
         adapters
         application
         infrastructure
-        ${PROJECT_SOURCE_DIR}/libs/mupdf/build/$<IF:$<CONFIG:Debug>,shared-debug,shared-release>/libmupdfcpp.so
+        ${MUPDF_OUTPUT}
         Qt6::Quick
         Qt6::Widgets
         Qt6::QuickControls2
@@ -83,4 +83,4 @@ include(CopyRecursive)
 set(FONTS_OUT_DIR ${PROJECT_BINARY_DIR}/resources/fonts)
 file(MAKE_DIRECTORY ${FONTS_OUT_DIR})
 message(DEBUG "Folder created at ${FONTS_OUT_DIR}")
-copy_recursive(${PROJECT_SOURCE_DIR}/resources/fonts ${FONTS_OUT_DIR} "*.otf")
+copy_recursive(${PROJECT_SOURCE_DIR}/resources/fonts ${FONTS_OUT_DIR} "*.otf")
diff --git a/src/adapters/CMakeLists.txt b/src/adapters/CMakeLists.txt
@@ -1,6 +1,7 @@
 # Dependencies
 find_package(Qt6 6.5 REQUIRED COMPONENTS Core Quick Network)
 
+set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
 
 # Build
 add_library(adapters
@@ -48,8 +49,11 @@ add_library(adapters
                     DTOs/tag_dto.hpp
 )
 
+target_compile_definitions(adapters PRIVATE ADAPTERS_LIBRARY)
+
 target_include_directories(adapters
                 PUBLIC
+                    ${CMAKE_CURRENT_SOURCE_DIR}
                     ${CMAKE_CURRENT_SOURCE_DIR}/interfaces/persistance
                     ${CMAKE_CURRENT_SOURCE_DIR}/interfaces/controllers
                     ${CMAKE_CURRENT_SOURCE_DIR}/controllers
@@ -60,7 +64,6 @@ target_include_directories(adapters
                     ${CMAKE_CURRENT_SOURCE_DIR}/data_models/shortcuts_model
                     ${CMAKE_CURRENT_SOURCE_DIR}/data_models
                 PRIVATE
-                    ${CMAKE_CURRENT_SOURCE_DIR}
                     ${DOMAIN_INCLUDES}
                     ${APPLICATION_INCLUDES}
 )
@@ -95,4 +98,4 @@ if (ENABLE_COVERAGE AND CMAKE_CXX_COMPILER_ID STREQUAL "GNU") # Only works when
               EXECUTABLE adapters_unit_tests
               BASE_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
               EXCLUDE ${PROJECT_BINARY_DIR}/* ${PROJECT_SOURCE_DIR}/libs/*)
-endif()
+endif()
diff --git a/src/adapters/DTOs/book_dto.hpp b/src/adapters/DTOs/book_dto.hpp
@@ -7,11 +7,12 @@
 #include <QUuid>
 #include <QVariant>
 #include "tag_dto.hpp"
+#include "adapters_export.hpp"
 
 namespace adapters::dtos
 {
 
-struct BookDto
+struct ADAPTERS_LIBRARY BookDto
 {
     Q_GADGET
     Q_PROPERTY(QString uuid MEMBER uuid)
@@ -55,4 +56,4 @@ struct BookDto
 
 }  // namespace adapters::dtos
 
-Q_DECLARE_METATYPE(adapters::dtos::BookDto)
+Q_DECLARE_METATYPE(adapters::dtos::BookDto)
diff --git a/src/adapters/DTOs/login_dto.hpp b/src/adapters/DTOs/login_dto.hpp
@@ -1,13 +1,14 @@
 #pragma once
 #include <QString>
+#include "adapters_export.hpp"
 
 namespace adapters::dtos
 {
 
-struct LoginDto
+struct ADAPTERS_LIBRARY LoginDto
 {
     QString email;
     QString password;
 };
 
-}  // namespace adapters::dtos
+}  // namespace adapters::dtos
diff --git a/src/adapters/DTOs/register_dto.hpp b/src/adapters/DTOs/register_dto.hpp
@@ -1,15 +1,16 @@
 #pragma once
 #include <QString>
+#include "adapters_export.hpp"
 
 namespace adapters::dtos
 {
 
-struct RegisterDto
+struct ADAPTERS_LIBRARY RegisterDto
 {
     QString firstName;
     QString lastName;
     QString email;
     QString password;
 };
 
-}  // namespace adapters::dtos
+}  // namespace adapters::dtos
diff --git a/src/adapters/DTOs/tag_dto.hpp b/src/adapters/DTOs/tag_dto.hpp
@@ -1,11 +1,12 @@
 #pragma once
 #include <QObject>
 #include <QString>
+#include "adapters_export.hpp"
 
 namespace adapters::dtos
 {
 
-struct TagDto
+struct ADAPTERS_LIBRARY TagDto
 {
     Q_GADGET
     Q_PROPERTY(QString uuid MEMBER uuid)
@@ -18,4 +19,4 @@ struct TagDto
 
 }  // namespace adapters::dtos
 
-Q_DECLARE_METATYPE(adapters::dtos::TagDto)
+Q_DECLARE_METATYPE(adapters::dtos::TagDto)
diff --git a/src/adapters/adapters_export.hpp b/src/adapters/adapters_export.hpp
@@ -0,0 +1,8 @@
+#pragma once
+#include <QtCore/QtGlobal>
+
+#if defined(ADAPTERS_LIBRARY)
+    #  define ADAPTERS_LIBRARY Q_DECL_EXPORT
+#else
+    #  define ADAPTERS_LIBRARY Q_DECL_IMPORT
+#endif
diff --git a/src/adapters/controllers/authentication_controller.hpp b/src/adapters/controllers/authentication_controller.hpp
@@ -2,11 +2,12 @@
 #include <QObject>
 #include "i_authentication_controller.hpp"
 #include "i_authentication_service.hpp"
+#include "adapters_export.hpp"
 
 namespace adapters::controllers
 {
 
-class AuthenticationController : public IAuthenticationController
+class ADAPTERS_LIBRARY AuthenticationController : public IAuthenticationController
 {
     Q_OBJECT
 
@@ -27,4 +28,4 @@ class AuthenticationController : public IAuthenticationController
     application::IAuthenticationService* m_authenticationService;
 };
 
-}  // namespace adapters::controllers
+}  // namespace adapters::controllers