logging cleanup: remove filter in streambuf; use key_trace (#288)

Author: eagleoflqj

.github/workflows/ci.yml

@@ -74,7 +74,7 @@ jobs:
           # Don't log key on any CI artifact.
           cmake -B build/${{ matrix.arch }} -G Ninja \
             -DCMAKE_Swift_COMPILER=`which swiftc` \
-            -DVERBOSE_LOGGING=OFF \
+            -DKEY_LOGGING=OFF \
             -DCMAKE_OSX_ARCHITECTURES=${{ matrix.arch }} \
             -DCMAKE_BUILD_TYPE=${{ matrix.type }}
           cmake --build build/${{ matrix.arch }}

src/CMakeLists.txt

@@ -25,9 +25,10 @@ target_include_directories(Fcitx5Objs PRIVATE
     "${PROJECT_SOURCE_DIR}/fcitx5/src/im/keyboard"
 )
 
-option(VERBOSE_LOGGING "Enable verbose logging" ON)
-if(VERBOSE_LOGGING)
-    target_compile_definitions(Fcitx5Objs PRIVATE VERBOSE_LOGGING)
+# This should be disabled in CI even for debug build.
+option(KEY_LOGGING "Enable key logging" ON)
+if(KEY_LOGGING)
+    target_compile_definitions(Fcitx5Objs PRIVATE KEY_LOGGING)
 endif()
 
 target_link_libraries(Fcitx5Objs

src/fcitx.cpp

@@ -112,11 +112,15 @@ void Fcitx::setupLog() {
     static native_streambuf log_streambuf;
     static std::ostream stream(&log_streambuf);
     fcitx::Log::setLogStream(stream);
-#ifdef VERBOSE_LOGGING
-    fcitx::Log::setLogRule("*=5,notimedate");
+#ifdef NDEBUG
+    std::string logRule = "*=4";
 #else
-    fcitx::Log::setLogRule("*=4,notimedate");
+    std::string logRule = "*=5";
 #endif
+#ifndef KEY_LOGGING
+    logRule += ",key_trace=0";
+#endif
+    fcitx::Log::setLogRule(logRule + ",notimedate");
 }
 
 void Fcitx::setupEnv() {

src/nativestreambuf.h

@@ -5,8 +5,7 @@
  * SPDX-License-Identifier: GPL-3.0-only
  * SPDX-FileCopyrightText: Copyright 2023 Qijia Liu
  */
-#ifndef FCITX5_MACOS_NATIVESTREAMBUF_H
-#define FCITX5_MACOS_NATIVESTREAMBUF_H
+#pragma once
 
 #include <array>
 #include <iostream>
@@ -104,16 +103,10 @@ class native_streambuf : public std::streambuf {
     }
 
     void write_log(const char_type *text) const {
-#ifdef NDEBUG
-        if (prio != OS_LOG_TYPE_DEBUG) {
-            std::cerr << text;
-        }
-#else
+#ifndef NDEBUG
         os_log_with_type(logger, prio, "%{public}s",
                          text + (should_offset ? 1 : 0));
-        std::cerr << text;
 #endif
+        std::cerr << text;
     }
 };
-
-#endif // FCITX5_MACOS_NATIVESTREAMBUF_H