Merge branch 'dev' into pinned

1 files changed, 125 insertions, 112 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 39b1b03a..adb5be7b 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,4 +1,6 @@
-cmake_minimum_required(VERSION 3.10)
+# Officially CMake 3.16+ is needed but LGTM.com still sits on eoan that only
+# has CMake 3.13
+cmake_minimum_required(VERSION 3.13)
 if (POLICY CMP0092)
 cmake_policy(SET CMP0092 NEW)
 endif()
@@ -37,7 +39,7 @@ if (MSVC)
         /wd4464 /wd4505 /wd4514 /wd4571 /wd4619 /wd4623 /wd4625 /wd4626 /wd4706
         /wd4710 /wd4774 /wd4820 /wd4946 /wd5026 /wd5027)
 else()
-    foreach (FLAG Wall W Wpedantic Wextra Werror=return-type Wno-unused-parameter
+    foreach (FLAG Wall Wpedantic Wextra Werror=return-type Wno-unused-parameter
             Wno-gnu-zero-variadic-macro-arguments fvisibility-inlines-hidden)
         CHECK_CXX_COMPILER_FLAG("-${FLAG}" COMPILER_${FLAG}_SUPPORTED)
         if ( COMPILER_${FLAG}_SUPPORTED AND
@@ -72,9 +74,18 @@ message(STATUS "  Header files will be installed to ${CMAKE_INSTALL_PREFIX}/${${
 # Instruct CMake to run moc automatically when needed.
 set(CMAKE_AUTOMOC ON)
 
-find_package(Qt5 5.9 REQUIRED Core Network Gui Multimedia Test)
-get_filename_component(Qt5_Prefix "${Qt5_DIR}/../../../.." ABSOLUTE)
-message(STATUS "Using Qt ${Qt5_VERSION} at ${Qt5_Prefix}")
+option(BUILD_WITH_QT6 "Build Quotient with Qt 6 (EXPERIMENTAL)" OFF)
+
+if (BUILD_WITH_QT6)
+    set(QtMinVersion "6.0")
+else()
+    set(QtMinVersion "5.12")
+    set(QtExtraModules "Multimedia") # See #483
+endif()
+string(REGEX REPLACE "^(.).*" "Qt\\1" Qt ${QtMinVersion}) # makes "Qt5" or "Qt6"
+find_package(${Qt} ${QtMinVersion} REQUIRED Core Network Gui Test ${QtExtraModules})
+get_filename_component(Qt_Prefix "${${Qt}_DIR}/../../../.." ABSOLUTE)
+message(STATUS "Using Qt ${${Qt}_VERSION} at ${Qt_Prefix}")
 
 if (${PROJECT_NAME}_ENABLE_E2EE)
     if ((NOT DEFINED USE_INTREE_LIBQOLM OR USE_INTREE_LIBQOLM)
@@ -112,50 +123,59 @@ if (${PROJECT_NAME}_ENABLE_E2EE)
 endif ()
 
 # Set up source files
-set(lib_SRCS
-    lib/networkaccessmanager.cpp
-    lib/connectiondata.cpp
-    lib/connection.cpp
-    lib/ssosession.cpp
-    lib/logging.cpp
-    lib/room.cpp
-    lib/user.cpp
-    lib/avatar.cpp
-    lib/uri.cpp
-    lib/uriresolver.cpp
-    lib/syncdata.cpp
-    lib/settings.cpp
-    lib/networksettings.cpp
-    lib/converters.cpp
-    lib/util.cpp
-    lib/encryptionmanager.cpp
-    lib/eventitem.cpp
-    lib/events/event.cpp
-    lib/events/roomevent.cpp
-    lib/events/stateevent.cpp
-    lib/events/eventcontent.cpp
-    lib/events/roomcreateevent.cpp
-    lib/events/roomtombstoneevent.cpp
-    lib/events/roommessageevent.cpp
-    lib/events/roommemberevent.cpp
-    lib/events/roompowerlevelsevent.cpp
-    lib/events/typingevent.cpp
-    lib/events/receiptevent.cpp
-    lib/events/reactionevent.cpp
-    lib/events/callanswerevent.cpp
-    lib/events/callcandidatesevent.cpp
-    lib/events/callhangupevent.cpp
-    lib/events/callinviteevent.cpp
-    lib/events/directchatevent.cpp
-    lib/events/encryptionevent.cpp
-    lib/events/encryptedevent.cpp
-    lib/events/roomkeyevent.cpp
-    lib/events/stickerevent.cpp
-    lib/jobs/requestdata.cpp
-    lib/jobs/basejob.cpp
-    lib/jobs/syncjob.cpp
-    lib/jobs/mediathumbnailjob.cpp
-    lib/jobs/downloadfilejob.cpp
+list(APPEND lib_SRCS
+    lib/quotient_common.h
+    lib/function_traits.h lib/function_traits.cpp
+    lib/networkaccessmanager.h lib/networkaccessmanager.cpp
+    lib/connectiondata.h lib/connectiondata.cpp
+    lib/connection.h lib/connection.cpp
+    lib/ssosession.h lib/ssosession.cpp
+    lib/logging.h lib/logging.cpp
+    lib/room.h lib/room.cpp
+    lib/user.h lib/user.cpp
+    lib/avatar.h lib/avatar.cpp
+    lib/uri.h lib/uri.cpp
+    lib/uriresolver.h lib/uriresolver.cpp
+    lib/eventstats.h lib/eventstats.cpp
+    lib/syncdata.h lib/syncdata.cpp
+    lib/settings.h lib/settings.cpp
+    lib/networksettings.h lib/networksettings.cpp
+    lib/converters.h lib/converters.cpp
+    lib/util.h lib/util.cpp
+    lib/encryptionmanager.h lib/encryptionmanager.cpp
+    lib/eventitem.h lib/eventitem.cpp
+    lib/accountregistry.h lib/accountregistry.cpp
+    lib/mxcreply.h lib/mxcreply.cpp
+    lib/events/event.h lib/events/event.cpp
+    lib/events/eventloader.h
+    lib/events/roomevent.h lib/events/roomevent.cpp
+    lib/events/stateevent.h lib/events/stateevent.cpp
+    lib/events/simplestateevents.h
+    lib/events/eventcontent.h lib/events/eventcontent.cpp
+    lib/events/roomcreateevent.h lib/events/roomcreateevent.cpp
+    lib/events/roomtombstoneevent.h lib/events/roomtombstoneevent.cpp
+    lib/events/roommessageevent.h lib/events/roommessageevent.cpp
+    lib/events/roommemberevent.h lib/events/roommemberevent.cpp
+    lib/events/roomavatarevent.h
+    lib/events/roompowerlevelsevent.h lib/events/roompowerlevelsevent.cpp
+    lib/events/typingevent.h lib/events/typingevent.cpp
+    lib/events/accountdataevents.h
+    lib/events/receiptevent.h lib/events/receiptevent.cpp
+    lib/events/reactionevent.h lib/events/reactionevent.cpp
+    lib/events/callinviteevent.h lib/events/callinviteevent.cpp
+    lib/events/callcandidatesevent.h
+    lib/events/callanswerevent.h lib/events/callanswerevent.cpp
+    lib/events/callhangupevent.h
+    lib/events/directchatevent.h lib/events/directchatevent.cpp
+    lib/events/encryptionevent.h lib/events/encryptionevent.cpp
+    lib/events/encryptedevent.h lib/events/encryptedevent.cpp
+    lib/events/roomkeyevent.h lib/events/roomkeyevent.cpp
+    lib/events/stickerevent.h lib/events/stickerevent.cpp
+    lib/jobs/requestdata.h lib/jobs/requestdata.cpp
+    lib/jobs/basejob.h lib/jobs/basejob.cpp
+    lib/jobs/syncjob.h lib/jobs/syncjob.cpp
+    lib/jobs/mediathumbnailjob.h lib/jobs/mediathumbnailjob.cpp
+    lib/jobs/downloadfilejob.h lib/jobs/downloadfilejob.cpp
 )
 
 # Configure API files generation
@@ -165,48 +185,50 @@ set(FULL_CSAPI_DIR lib/${CSAPI_DIR})
 set(ASAPI_DEF_DIR application-service/definitions)
 set(ISAPI_DEF_DIR identity/definitions)
 
-if (GTAD_PATH)
+set(API_GENERATION_ENABLED 0)
+if (GTAD_PATH AND MATRIX_DOC_PATH)
+    # REALPATH resolves ~ (home directory) while PROGRAM doesn't
     get_filename_component(ABS_GTAD_PATH "${GTAD_PATH}" REALPATH)
+    get_filename_component(ABS_GTAD_PATH "${ABS_GTAD_PATH}" PROGRAM PROGRAM_ARGS GTAD_ARGS)
+    if (EXISTS ${ABS_GTAD_PATH})
+        get_filename_component(ABS_API_DEF_PATH "${MATRIX_DOC_PATH}/data/api" REALPATH)
+        if (NOT IS_DIRECTORY ${ABS_API_DEF_PATH})
+            # Check the old place of API files
+            get_filename_component(ABS_API_DEF_PATH "${MATRIX_DOC_PATH}/api" REALPATH)
+        endif ()
+        if (IS_DIRECTORY ${ABS_API_DEF_PATH})
+            set(API_GENERATION_ENABLED 1)
+        else ()
+            message( WARNING "${MATRIX_DOC_PATH} doesn't seem to point to a valid matrix-doc repo; disabling API stubs generation")
+        endif ()
+    else (EXISTS ${ABS_GTAD_PATH})
+        message( WARNING "${GTAD_PATH} is not executable; disabling API stubs generation")
+    endif ()
 endif ()
-if (MATRIX_DOC_PATH)
-    get_filename_component(ABS_API_DEF_PATH "${MATRIX_DOC_PATH}/api" REALPATH)
-endif ()
-if (ABS_GTAD_PATH AND ABS_API_DEF_PATH)
+if (API_GENERATION_ENABLED)
     message( STATUS "Using GTAD at ${ABS_GTAD_PATH}" )
-    message( STATUS "Using API files at ${ABS_API_DEF_PATH}" )
-    set(API_GENERATION_ENABLED 1)
+    message( STATUS "Found API files at ${ABS_API_DEF_PATH}" )
     if (NOT CLANG_FORMAT)
         set(CLANG_FORMAT clang-format)
     endif()
-    get_filename_component(ABS_CLANG_FORMAT "${CLANG_FORMAT}" PROGRAM)
-    if (ABS_CLANG_FORMAT)
-        set(API_FORMATTING_ENABLED 1)
-        message( STATUS "clang-format is at ${ABS_CLANG_FORMAT}")
-    else ()
-        message( STATUS "${CLANG_FORMAT} is NOT FOUND; API files won't be reformatted")
+    get_filename_component(ABS_CLANG_FORMAT "${CLANG_FORMAT}" PROGRAM PROGRAM_ARGS CLANG_FORMAT_ARGS)
+    if (NOT ABS_CLANG_FORMAT)
+        message( WARNING "${CLANG_FORMAT} is NOT FOUND; API files won't be formatted")
     endif ()
 
-    if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.12.0")
-        # We use globbing with CONFIGURE_DEPENDS to produce two file lists:
-        # one of all API files for clang-format and another of just .cpp
-        # files to supply for library source files. Since we expect these
-        # file lists to only change due to GTAD invocation, we only use
-        # CONFIGURE_DEPENDS when pre-requisites to update API are met.
-        # Read comments next to each file(GLOB_RECURSE) for caveats.
-        set(add_CONFIGURE_DEPENDS "CONFIGURE_DEPENDS")
-    endif()
     set(FULL_CSAPI_SRC_DIR ${ABS_API_DEF_PATH}/client-server)
     file(GLOB_RECURSE API_DEFS RELATIVE ${PROJECT_SOURCE_DIR}
         ${FULL_CSAPI_SRC_DIR}/*.yaml
         ${ABS_API_DEF_PATH}/${ASAPI_DEF_DIR}/*.yaml
         ${ABS_API_DEF_PATH}/${ISAPI_DEF_DIR}/*.yaml
     )
-    add_custom_target(generate-unformatted-api
+    add_custom_target(update-api
         ${ABS_GTAD_PATH} --config ../gtad/gtad.yaml --out ${CSAPI_DIR}
             ${FULL_CSAPI_SRC_DIR}
             old_sync.yaml- room_initial_sync.yaml- # deprecated
             key_backup.yaml- # immature and buggy in terms of API definition
             sync.yaml- # we have a better handcrafted implementation
+            ${GTAD_ARGS}
         WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/lib
         SOURCES gtad/gtad.yaml
                 gtad/data.h.mustache
@@ -215,53 +237,33 @@ if (ABS_GTAD_PATH AND ABS_API_DEF_PATH)
                 ${API_DEFS}
         VERBATIM
     )
-    add_custom_target(update-api DEPENDS generate-unformatted-api)
-    if (ABS_CLANG_FORMAT)
-        set(CLANG_FORMAT_ARGS -i -sort-includes ${CLANG_FORMAT_ARGS})
-        # FIXME: the list of files should be produced after GTAD has run.
-        # For now it's produced at CMake invocation. If file() hasn't found
-        # any files at that moment, clang-format will be called with an empty
-        # list of files and choke. Taking outfiles.txt from GTAD could be
-        # an option but this, too, must be done during the build stage, and
-        # there's no crossplatform way to use the contents of a file as
-        # input for a build target command.
-        file(GLOB_RECURSE api_ALL_SRCS ${add_CONFIGURE_DEPENDS}
-             ${FULL_CSAPI_DIR}/*.*
-             lib/${ASAPI_DEF_DIR}/*.*
-             lib/${ISAPI_DEF_DIR}/*.*)
-        if (api_ALL_SRCS)
-            add_custom_target(format-api
-                ${ABS_CLANG_FORMAT} ${CLANG_FORMAT_ARGS} ${api_ALL_SRCS}
-                DEPENDS generate-unformatted-api
-                VERBATIM)
-            add_dependencies(update-api format-api)
-        endif()
-    endif()
 endif()
 add_feature_info(EnableApiCodeGeneration "${API_GENERATION_ENABLED}"
                  "build target update-api")
-add_feature_info(EnableApiFormatting "${API_FORMATTING_ENABLED}"
-                 "formatting of generated API files with clang-format")
-
-# Make no mistake: CMake cannot run gtad first and then populate the list of
-# resulting api_SRCS files. In other words, placing the below statement after
-# the block above will not lead to CMake magically reconfiguring the build
-# after building the update-api target. CONFIGURE_DEPENDS somewhat helps,
-# at least forcing the build system to reevaluate the glob before building
-# the next target. Otherwise, you have to watch out if gtad has created
-# new files and if it has, re-run cmake.
-file(GLOB_RECURSE api_SRCS ${add_CONFIGURE_DEPENDS} ${FULL_CSAPI_DIR}/*.cpp)
-
-add_library(${PROJECT_NAME} ${lib_SRCS} ${api_SRCS})
+
+# Produce the list of all Matrix API files for building the library. When this
+# list changes (normally after calling GTAD), CONFIGURE_DEPENDS will force
+# the build system to call CMake again. Checking for the glob change slows down
+# each build (even if the target does not involve API generation). It would be
+# ideal if GTAD could compare the initial (saved somewhere) and the generated
+# file list itself and write down to some .cmake file if those are different,
+# which would trigger the reconfiguration specifically before the next build.
+# For now CONFIGURE_DEPENDS is the best approximation of that.
+file(GLOB_RECURSE api_ALL_SRCS CONFIGURE_DEPENDS
+     ${FULL_CSAPI_DIR}/*.* lib/${ASAPI_DEF_DIR}/*.* lib/${ISAPI_DEF_DIR}/*.*)
+
+add_library(${PROJECT_NAME} ${lib_SRCS} ${api_ALL_SRCS})
 target_compile_definitions(${PROJECT_NAME} PRIVATE QT_NO_JAVA_STYLE_ITERATORS QT_NO_URL_CAST_FROM_STRING QT_NO_CAST_TO_ASCII)
-if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.16.0"
-        AND NOT CMAKE_CXX_COMPILER_ID STREQUAL GNU) # https://bugzilla.redhat.com/show_bug.cgi?id=1721553
-    target_precompile_headers(${PROJECT_NAME} PRIVATE lib/converters.h)
-endif ()
+
+target_compile_definitions(${PROJECT_NAME} PUBLIC ${PROJECT_NAME}_VERSION_MAJOR=${PROJECT_VERSION_MAJOR}
+    ${PROJECT_NAME}_VERSION_MINOR=${PROJECT_VERSION_MINOR} ${PROJECT_NAME}_VERSION_PATCH=${PROJECT_VERSION_PATCH}
+    ${PROJECT_NAME}_VERSION_STRING=\"${PROJECT_VERSION}\")
 if (${PROJECT_NAME}_ENABLE_E2EE)
     target_compile_definitions(${PROJECT_NAME} PUBLIC ${PROJECT_NAME}_E2EE_ENABLED)
 endif()
 set_target_properties(${PROJECT_NAME} PROPERTIES
+    CXX_STANDARD 20
+    CXX_EXTENSIONS OFF
     VERSION "${PROJECT_VERSION}"
     SOVERSION ${API_VERSION}
     INTERFACE_${PROJECT_NAME}_MAJOR_VERSION ${API_VERSION}
@@ -269,8 +271,16 @@ set_target_properties(${PROJECT_NAME} PROPERTIES
 set_property(TARGET ${PROJECT_NAME} APPEND PROPERTY
              COMPATIBLE_INTERFACE_STRING ${PROJECT_NAME}_MAJOR_VERSION)
 
+# C++17 required, C++20 desired (see above)
 target_compile_features(${PROJECT_NAME} PUBLIC cxx_std_17)
 
+# TODO: Bump the CMake requirement and drop the version check here once
+# LGTM upgrades
+if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.16.0"
+        AND NOT CMAKE_CXX_COMPILER_ID STREQUAL GNU) # https://bugzilla.redhat.com/show_bug.cgi?id=1721553
+    target_precompile_headers(${PROJECT_NAME} PRIVATE lib/converters.h)
+endif ()
+
 target_include_directories(${PROJECT_NAME} PUBLIC
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/lib>
     $<INSTALL_INTERFACE:${${PROJECT_NAME}_INSTALL_INCLUDEDIR}>
@@ -279,7 +289,10 @@ if (${PROJECT_NAME}_ENABLE_E2EE)
     target_link_libraries(${PROJECT_NAME} QtOlm)
     set(FIND_DEPS "find_dependency(QtOlm)") # For QuotientConfig.cmake.in
 endif()
-target_link_libraries(${PROJECT_NAME} Qt5::Core Qt5::Network Qt5::Gui Qt5::Multimedia)
+target_link_libraries(${PROJECT_NAME} ${Qt}::Core ${Qt}::Network ${Qt}::Gui)
+if (Qt STREQUAL Qt5) # See #483
+    target_link_libraries(${PROJECT_NAME} ${Qt}::Multimedia)
+endif()
 
 configure_file(${PROJECT_NAME}.pc.in ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc @ONLY NEWLINE_STYLE UNIX)