Merged in feature/make-qmllint-ready (pull request #3)

Feature/make qmllint ready

Approved-by: Helmuth Ploner-Bernard
Approved-by: Johann Anhofer

Author: andibacher

.github/workflows/cmake-ubuntu.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-22.04]
-        qt_version: [6.2.4, 6.5.3, 6.6.3, 6.7.2, 6.8.0]
+        qt_version: [6.2.4, 6.5.3, 6.6.3, 6.7.2, 6.8.1]
 
     steps:
     - name: Install ninja

CMakeLists.txt

@@ -25,10 +25,13 @@ if(BUILD_STATIC_LOG4CXX_LIB)
 endif()
 
 # With Database logging support or without
-option(BUILD_WITH_DB_LOGGING "Build with database logging support, link against Qt sql lib (default: on)" OFF)
+option(BUILD_WITH_DB_LOGGING "Build with database logging support, link against Qt sql lib (default: off)" OFF)
 
 # With Telnet logging support or without
-option(BUILD_WITH_TELNET_LOGGING "Build with telnet logging support, link against Qt network lib (default: on)" OFF)
+option(BUILD_WITH_TELNET_LOGGING "Build with telnet logging support, link against Qt network lib (default: off)" OFF)
+
+# With qml logging support or without
+option(BUILD_WITH_QML_LOGGING "Build with qml logging support, link against Qt qml lib (default: off)" OFF)
 
 # Enable documentation generation with doxygen
 OPTION(BUILD_WITH_DOCS "Enable documentation generation (default: off)" OFF)
@@ -81,6 +84,9 @@ endif()
 if(BUILD_WITH_TELNET_LOGGING)
     find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Network REQUIRED)
 endif()
+if(BUILD_WITH_QML_LOGGING)
+    find_package(Qt${QT_VERSION_MAJOR} COMPONENTS Qml REQUIRED)
+endif()
 
 add_definitions(-DQT_USE_QSTRINGBUILDER)
 add_definitions(-DQT_NO_CAST_TO_ASCII)

appveyor.yml

@@ -21,9 +21,9 @@ environment:
       CMD_VCVARSALL: '"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" x64'
       APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019 
     # Qt 6.6
-    - QTDIR: C:\Qt\6.6\msvc2019_64
-      CMD_VCVARSALL: '"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" x64'
-      APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019            
+    #- QTDIR: C:\Qt\6.6\msvc2019_64
+    #  CMD_VCVARSALL: '"C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvarsall.bat" x64'
+    #  APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
 branches:
   only:
     - master

src/log4qt/CMakeLists.txt

@@ -41,7 +41,6 @@ set(log4qt_SOURCES
     ndc.cpp                                                                                                                                                           
     patternlayout.cpp                                                                                                                                                 
     propertyconfigurator.cpp                                                                                                                                          
-    qmllogger.cpp                                                                                                                                                     
     rollingbinaryfileappender.cpp                                                                                                                                     
     rollingfileappender.cpp                                                                                                                                           
     signalappender.cpp                                                                                                                                                
@@ -94,7 +93,6 @@ set(log4qt_HEADERS
     ndc.h
     patternlayout.h
     propertyconfigurator.h
-    qmllogger.h
     rollingbinaryfileappender.h
     rollingfileappender.h
     signalappender.h
@@ -152,6 +150,43 @@ target_link_libraries(log4qt
         Qt${QT_VERSION_MAJOR}::Concurrent
 )
 
+if(BUILD_WITH_QML_LOGGING)
+    target_sources(log4qt
+        PRIVATE
+         qmllogger.cpp
+         qmllogger.h
+    )
+    # append to log4qt_HEADERS or proper install
+    list(APPEND log4qt_HEADERS
+         qmllogger.h
+    )
+
+    target_link_libraries(log4qt PRIVATE Qt${QT_VERSION_MAJOR}::Qml)
+    target_include_directories(log4qt
+          PUBLIC
+              $<TARGET_PROPERTY:Qt::Qml,INTERFACE_INCLUDE_DIRECTORIES>
+    )
+
+    if (QT_VERSION_MAJOR GREATER 6 OR (QT_VERSION_MAJOR EQUAL 6 AND QT_VERSION_MINOR GREATER 1))
+        qt_add_qml_module(
+            log4qt
+            URI org.log4qt
+            VERSION 1.0
+            OUTPUT_DIRECTORY
+            ${CMAKE_BINARY_DIR}/bin/org/log4qt
+            SOURCES
+                qmllogger.cpp qmllogger.h
+            NO_PLUGIN
+            RESOURCE_PREFIX
+                "/qt/qml"
+        )
+        message(STATUS "Log4Qt: Registered logging support as qml module (org.log4qt)")
+    endif()
+    message(STATUS "Log4Qt: Enabling qml logging support")
+else()
+    message(STATUS "Log4Qt: Disabling qml logging support - disabled by cmake option")
+endif()
+
 target_include_directories(log4qt PUBLIC
     $<BUILD_INTERFACE:${LOG4QT_BUILD_INCLUDE_DIR}>
     $<INSTALL_INTERFACE:include>)
@@ -171,7 +206,10 @@ if(BUILD_WITH_DB_LOGGING)
          databaseappender.h
          databaselayout.h
     )
-
+    target_compile_definitions(log4qt
+        PRIVATE
+            LOG4QT_DB_LOGGING_SUPPORT
+    )
     target_link_libraries(log4qt PRIVATE Qt${QT_VERSION_MAJOR}::Sql)
     target_include_directories(log4qt
           PUBLIC
@@ -195,6 +233,10 @@ if(BUILD_WITH_TELNET_LOGGING)
     list(APPEND log4qt_HEADERS
          telnetappender.h
     )
+    target_compile_definitions(log4qt
+        PRIVATE
+            LOG4QT_TELNET_LOGGING_SUPPORT
+    )
     target_link_libraries(log4qt PRIVATE Qt${QT_VERSION_MAJOR}::Network)
     target_include_directories(log4qt
           PUBLIC

src/log4qt/asyncappender.cpp

@@ -26,6 +26,10 @@
 #include <QReadLocker>
 #include <QThread>
 
+#if (__cplusplus >= 201703L) // C++17 or later
+#include <utility>
+#endif
+
 namespace Log4Qt
 {
 
@@ -85,9 +89,14 @@ void AsyncAppender::closeInternal()
 
 void AsyncAppender::callAppenders(const LoggingEvent &event) const
 {
+    Q_UNUSED(event)
     QReadLocker locker(&mAppenderGuard);
 
+#if (__cplusplus >= 201703L)
+    for (auto &&pAppender : std::as_const(mAppenders))
+#else
     for (auto &&pAppender : qAsConst(mAppenders))
+#endif
         pAppender->doAppend(event);
 }
 

src/log4qt/colorconsoleappender.cpp

@@ -25,6 +25,10 @@
 
 #include <QTextStream>
 
+#if (__cplusplus >= 201703L) // C++17 or later
+#include <utility>
+#endif
+
 #define NIX_BACK_BLACK      40
 #define NIX_BACK_RED        41
 #define NIX_BACK_GREEN      42
@@ -130,7 +134,11 @@ static void colorOutputString(HANDLE hConsole, const QString &output)
                 parsedWordString = it.mid(1, indexOfM - 1);
 
                 escParams = parsedWordString.split(';');
+#if (__cplusplus >= 201703L)
+                for (const auto &param : std::as_const(escParams))
+#else
                 for (const auto &param : qAsConst(escParams))
+#endif
                 {
                     WORD color = param.toUInt();
                     switch (color)

src/log4qt/dailyfileappender.cpp

@@ -31,6 +31,10 @@
 #include <QtConcurrentRun>
 #include <QStringBuilder>
 
+#if (__cplusplus >= 201703L) // C++17 or later
+#include <utility>
+#endif
+
 namespace Log4Qt
 {
 
@@ -125,7 +129,11 @@ void deleteObsoleteFiles(
         }
     }
 
+#if (__cplusplus >= 201703L)
+    for (const auto &fileName : std::as_const(obsoleteLogFileNames))
+#else
     for (const auto &fileName : qAsConst(obsoleteLogFileNames))
+#endif
     {
         QFile::remove(logDir.filePath(fileName));
     }

src/log4qt/databaselayout.cpp

@@ -42,7 +42,7 @@ QSqlRecord DatabaseLayout::formatRecord(const LoggingEvent &event)
     if (!mTimeStamp.isEmpty())
     {
         field.setName(mTimeStamp);
-        field.setType(QVariant::DateTime);
+        field.setMetaType(QMetaType(QMetaType::QDateTime));
         field.setGenerated(true);
         field.setValue(DateTime::fromMSecsSinceEpoch(event.timeStamp()));
         record.append(field);
@@ -51,7 +51,7 @@ QSqlRecord DatabaseLayout::formatRecord(const LoggingEvent &event)
     if (!mLoggename.isEmpty())
     {
         field.setName(mLoggename);
-        field.setType(QVariant::String);
+        field.setMetaType(QMetaType(QMetaType::QString));
         field.setGenerated(true);
         field.setValue(event.loggename());
         record.append(field);
@@ -60,7 +60,7 @@ QSqlRecord DatabaseLayout::formatRecord(const LoggingEvent &event)
     if (!mThreadName.isEmpty())
     {
         field.setName(mThreadName);
-        field.setType(QVariant::String);
+        field.setMetaType(QMetaType(QMetaType::QString));
         field.setGenerated(true);
         field.setValue(event.threadName());
         record.append(field);
@@ -69,7 +69,7 @@ QSqlRecord DatabaseLayout::formatRecord(const LoggingEvent &event)
     if (!mLevel.isEmpty())
     {
         field.setName(mLevel);
-        field.setType(QVariant::String);
+        field.setMetaType(QMetaType(QMetaType::QString));
         field.setGenerated(true);
         field.setValue(event.level().toString());
         record.append(field);
@@ -78,7 +78,7 @@ QSqlRecord DatabaseLayout::formatRecord(const LoggingEvent &event)
     if (!mMessage.isEmpty())
     {
         field.setName(mMessage);
-        field.setType(QVariant::String);
+        field.setMetaType(QMetaType(QMetaType::QString));
         field.setGenerated(true);
         field.setValue(event.message());
         record.append(field);

src/log4qt/helpers/appenderattachable.cpp

@@ -22,6 +22,10 @@
 #include "varia/listappender.h"
 #include "appender.h"
 
+#if (__cplusplus >= 201703L) // C++17 or later
+#include <utility>
+#endif
+
 namespace Log4Qt
 {
 
@@ -42,7 +46,11 @@ AppenderSharedPtr AppenderAttachable::appender(const QString &name) const
 {
     QReadLocker locker(&mAppenderGuard);
 
+#if (__cplusplus >= 201703L)
+    for (auto &&pAppender : std::as_const(mAppenders))
+#else
     for (auto &&pAppender : qAsConst(mAppenders))
+#endif
         if (pAppender->name() == name)
             return pAppender;
     return AppenderSharedPtr();

src/log4qt/helpers/datetime.h

@@ -24,6 +24,7 @@
 #include "log4qt/log4qtshared.h"
 
 #include <QDateTime>
+#include <QTimeZone>
 
 namespace Log4Qt
 {
@@ -55,6 +56,7 @@ class LOG4QT_EXPORT DateTime : public QDateTime
 
     DateTime(const DateTime &other);
 
+#if QT_VERSION < 0x060500
     /*!
      * Constructs a datetime with the given \a date and \a time, using
      * the time specification defined by \a timeSpec.
@@ -65,6 +67,18 @@ class LOG4QT_EXPORT DateTime : public QDateTime
     DateTime(QDate date,
              QTime time,
              Qt::TimeSpec timeSpec = Qt::LocalTime);
+#else
+    /*!
+     * Constructs a datetime with the given \a date and \a time, using
+     * the time zone defined by \a QTimeZone.
+     *
+     * \sa QDateTime::QDateTime(const QDate &date, const QTime &time,
+     *     QTimeZone = QTimeZone(QTimeZone::LocalTime))
+     */
+    DateTime(QDate date,
+             QTime time,
+             QTimeZone = QTimeZone(QTimeZone::LocalTime));
+#endif
 
     /*!
      * Assigns \a other to this DateTime and returns a reference to it.
@@ -112,7 +126,12 @@ class LOG4QT_EXPORT DateTime : public QDateTime
      * \sa QDateTime::currentDateTime()
      */
     static DateTime currentDateTime();
+#if QT_VERSION < 0x060500
     static DateTime fromMSecsSinceEpoch(qint64 msecs, Qt::TimeSpec spec, int offsetSeconds = 0);
+#else
+    static DateTime fromMSecsSinceEpoch(qint64 msecs, QTimeZone timeZone);
+#endif
+
     static DateTime fromMSecsSinceEpoch(qint64 msecs);
 
 private:
@@ -122,11 +141,19 @@ class LOG4QT_EXPORT DateTime : public QDateTime
 inline DateTime::DateTime(const QDateTime &other) : QDateTime(other)
 {}
 
+#if QT_VERSION < 0x060500
 inline DateTime::DateTime(QDate date,
                           QTime time,
                           Qt::TimeSpec timeSpec) :
     QDateTime(date, time, timeSpec)
 {}
+#else
+inline DateTime::DateTime(QDate date,
+                          QTime time,
+                          QTimeZone timeZone) :
+    QDateTime(date, time, timeZone)
+{}
+#endif
 
 inline DateTime &DateTime::operator=(const DateTime &other)
 {
@@ -144,10 +171,17 @@ inline DateTime DateTime::fromMSecsSinceEpoch(qint64 msecs)
     return DateTime(QDateTime::fromMSecsSinceEpoch(msecs));
 }
 
+#if QT_VERSION < 0x060500
 inline DateTime DateTime::fromMSecsSinceEpoch(qint64 msecs, Qt::TimeSpec spec, int offsetSeconds)
 {
     return DateTime(QDateTime::fromMSecsSinceEpoch(msecs, spec, offsetSeconds));
 }
+#else
+inline DateTime DateTime::fromMSecsSinceEpoch(qint64 msecs, QTimeZone timeZone)
+{
+    return DateTime(QDateTime::fromMSecsSinceEpoch(msecs, timeZone));
+}
+#endif
 
 } // namespace Log4Qt