Unify logging

Author: dwrobel

CMakeLists.txt

@@ -33,12 +33,14 @@ set(SOURCES
     src/keys.cc
     src/egl_utils.cc
     src/utils.cc
+    src/debug.cc
     src/wayland_display.cc
     src/elf.h
     src/macros.h
     src/keys.h
     src/utils.h
     src/egl_utils.h
+    src/debug.h
     src/wayland_display.h
 )
 

src/debug.cc

@@ -0,0 +1,123 @@
+// Copyright (c) 2021 Damian Wrobel <[email protected]>
+//
+// This software is provided 'as-is', without any express or implied
+// warranty. In no event will the authors be held liable for any damages
+// arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it
+// freely, subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented; you must not
+//    claim that you wrote the original software. If you use this software
+//    in a product, an acknowledgment in the product documentation would
+//    be appreciated but is not required.
+//.
+// 2. Altered source versions must be plainly marked as such, and must not
+//    be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source
+//    distribution.
+//
+
+#include <array>
+#include <cstdarg>
+#include <cstdio>
+#include <cstring>
+#include <vector>
+#include <mutex>
+
+#ifndef SYSLOG_NAMES
+#define SYSLOG_NAMES
+#endif
+#include <syslog.h>
+
+#include "utils.h"
+#include "debug.h"
+
+namespace flutter {
+
+static int debug_level;
+
+int syslog2level(const std::string &priority) {
+  const char *c_name = priority.c_str();
+  for (size_t i = 0; prioritynames[i].c_name != NULL; i++) {
+    if (strstr(prioritynames[i].c_name, c_name)) {
+      return prioritynames[i].c_val;
+    }
+  }
+
+  return LOG_INFO;
+}
+
+void dbg_init() {
+  debug_level = syslog2level(getEnv("FLUTTER_LAUNCHER_WAYLAND_DEBUG", std::string("info")));
+}
+
+static const char *priority2prefix(const int priority) {
+  static const struct {
+    const int priority;
+    const char *const prefix;
+  } map[] = {
+      {LOG_ERR, "ERROR: "},
+      {LOG_WARNING, "WARNING: "},
+      {LOG_INFO, "INFO: "},
+      {LOG_DEBUG, "TRACE: "},
+  };
+
+  for (size_t i = 0; i < std::size(map); i++) {
+    if (priority == map[i].priority) {
+      return map[i].prefix;
+    }
+  }
+
+  return "UNKNOWN: ";
+}
+
+static void vdbg(const int priority, const char *format, va_list args1) {
+  va_list args2;
+  va_copy(args2, args1);
+
+  char buf[256];
+  int rv = std::vsnprintf(buf, std::size(buf), format, args1);
+
+  if (rv < 0) {
+    va_end(args2);
+    return;
+  }
+
+  if (static_cast<std::size_t>(rv) < std::size(buf)) {
+    va_end(args2);
+
+    printf("%s%s", priority2prefix(priority), buf);
+    fflush(stdout);
+  } else {
+    const size_t len = rv + 1;
+    std::vector<char> str(len);
+    std::vsnprintf(str.data(), len, format, args2);
+    va_end(args2);
+
+    printf("%s%s", priority2prefix(priority), str.data());
+    fflush(stdout);
+  }
+}
+
+// clang-format off
+#define dbg(type, priority)               \
+void dbg##type(const char *format, ...) { \
+  if (debug_level < (priority))           \
+    return;                               \
+                                          \
+  va_list args;                           \
+  va_start(args, format);                 \
+  vdbg((priority), format, args);         \
+  va_end(args);                           \
+}
+
+dbg(E, LOG_ERR)
+dbg(W, LOG_WARNING)
+dbg(I, LOG_INFO)
+dbg(T, LOG_DEBUG)
+// clang-format once
+
+} // namespace flutter

src/debug.h

@@ -0,0 +1,33 @@
+// Copyright (c) 2021 Damian Wrobel <[email protected]>
+//
+// This software is provided 'as-is', without any express or implied
+// warranty. In no event will the authors be held liable for any damages
+// arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it
+// freely, subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented; you must not
+//    claim that you wrote the original software. If you use this software
+//    in a product, an acknowledgment in the product documentation would
+//    be appreciated but is not required.
+//.
+// 2. Altered source versions must be plainly marked as such, and must not
+//    be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source
+//    distribution.
+//
+#pragma once
+
+namespace flutter {
+
+void dbg_init();
+
+void dbgE(const char *format, ...) __attribute__((format(printf, 1, 2)));
+void dbgW(const char *format, ...) __attribute__((format(printf, 1, 2)));
+void dbgI(const char *format, ...) __attribute__((format(printf, 1, 2)));
+void dbgT(const char *format, ...) __attribute__((format(printf, 1, 2)));
+
+} // namespace flutter

src/egl_utils.cc

@@ -7,6 +7,7 @@
 #include <EGL/egl.h>
 #include "egl_utils.h"
 #include "utils.h"
+#include "debug.h"
 
 namespace flutter {
 
@@ -33,12 +34,12 @@ void LogLastEGLError() {
 
   for (size_t i = 0; i < count; i++) {
     if (last_error == pairs[i].code) {
-      FLWAY_ERROR << "EGL Error: " << pairs[i].name << " (" << pairs[i].code << ")" << std::endl;
+      dbgE("EGL Error: %s (code: %d)\n", pairs[i].name, pairs[i].code);
       return;
     }
   }
 
-  FLWAY_ERROR << "Unknown EGL Error" << std::endl;
+  dbgE("Unknown EGL Error (%d)\n", last_error);
 }
 
 } // namespace flutter

src/macros.h

@@ -13,10 +13,3 @@
 #define FLWAY_DISALLOW_COPY_AND_ASSIGN(TypeName)                                                                                                                                                                                               \
   FLWAY_DISALLOW_COPY(TypeName)                                                                                                                                                                                                                \
   FLWAY_DISALLOW_ASSIGN(TypeName)
-
-#define __FLWAY_LINE_PREFIX << __FILE__ << ":" << std::to_string(__LINE__) << ": "
-#define FLWAY_LOG std::cout << "LOG: " __FLWAY_LINE_PREFIX
-#define FLWAY_ERROR std::cerr << "ERROR: " __FLWAY_LINE_PREFIX
-#define FLWAY_WIP                                                                                                                                                                                                                              \
-  std::cerr << "Work In Progress. Aborting." << std::endl;                                                                                                                                                                                     \
-  abort();

src/main.cc

@@ -8,6 +8,7 @@
 #include <vector>
 
 #include "utils.h"
+#include "debug.h"
 #include "wayland_display.h"
 
 static_assert(FLUTTER_ENGINE_VERSION == 1, "");
@@ -36,20 +37,46 @@ asset_bundle_path: The Flutter application code needs to be snapshotted using
                    Flutter engine. To see all supported flags, run
                    `flutter_tester --help` using the test binary included in the
                    Flutter tools.
+
+Supported environment variables:
+     LANG=<string>
+                   Value encoded as per setlocale(3) (e.g. "szl_PL.utf8") is
+                   passed to the engine via UpdateLocales().
+
+                   See also: https://man7.org/linux/man-pages/man3/setlocale.3.html
+ 
+     FLUTTER_WAYLAND_PIXEL_RATIO=<double>
+                   Overwrites the pixel aspect ratio reported
+                   to the engine by FlutterEngineSendWindowMetricsEvent().
+
+                   See also: https://api.flutter.dev/flutter/dart-ui/Window/devicePixelRatio.html
+
+     FLUTTER_WAYLAND_MAIN_UI=<int>
+                   Non-zero value enables grabbing all keys (even without having
+                   a focus) using Xwayland keyboard grabbing protocol (assuming 
+                   server implement this extension).
+
+                   See also: https://github.com/wayland-project/wayland-protocols/tree/0a61d3516b10da4e65607a6dd97937ebedf6bcfa/unstable/xwayland-keyboard-grab
+
+     FLUTTER_LAUNCHER_WAYLAND_DEBUG=<string>
+                   where <string> can be any of syslog(3) prioritynames or its
+                   unique abbreviation e.g. "err", "warning", "info" or "debug".
 )~" << std::endl;
 }
 
 static bool Main(std::vector<std::string> args) {
+  dbg_init();
+
   if (args.size() == 1) {
-    std::cerr << "   <Invalid Arguments>   " << std::endl;
+    dbgE("Invalid list of arguments\n");
     PrintUsage();
     return false;
   }
 
   const auto asset_bundle_path = args[1];
 
   if (!FlutterAssetBundleIsValid(asset_bundle_path)) {
-    std::cerr << "   <Invalid Flutter Asset Bundle>   " << std::endl;
+    dbgE("Invalid Flutter Asset Bundle\n");
     PrintUsage();
     return false;
   }
@@ -60,21 +87,16 @@ static bool Main(std::vector<std::string> args) {
   const std::vector<std::string> flutter_args(args.begin() + 1, args.end());
 
   for (const auto &arg : flutter_args) {
-    FLWAY_LOG << "Flutter arg: " << arg << std::endl;
+    dbgI("Flutter arg: %s\n", arg.c_str());
   }
 
   WaylandDisplay display(kWidth, kHeight, asset_bundle_path, flutter_args);
 
   if (!display.IsValid()) {
-    FLWAY_ERROR << "Wayland display was not valid." << std::endl;
+    dbgI("Wayland display was not valid\n");
     return false;
   }
 
-  // if (!application.SetWindowSize(kWidth, kHeight)) {
-  //   FLWAY_ERROR << "Could not update Flutter application size." << std::endl;
-  //   return false;
-  // }
-
   return display.Run();
 }
 

src/utils.cc

@@ -8,6 +8,7 @@
 #include <string.h>
 #include <stdlib.h>
 
+#include "debug.h"
 #include "utils.h"
 
 namespace flutter {
@@ -47,18 +48,18 @@ std::string GetICUDataPath() {
 
   do {
     if (std::ifstream(icu_data_path)) {
-      std::cout << "Using: " << icu_data_path << std::endl;
+      dbgI("Using %s\n", icu_data_path.c_str());
       break;
     }
 
     icu_data_path = "/usr/share/flutter/icudtl.dat";
 
     if (std::ifstream(icu_data_path)) {
-      std::cout << "Using: " << icu_data_path << std::endl;
+      dbgI("Using: %s\n", icu_data_path.c_str());
       break;
     }
 
-    FLWAY_ERROR << "Unnable to locate icudtl.dat file" << std::endl;
+    dbgE("Unnable to locate icudtl.dat file\n");
     icu_data_path = "";
   } while (0);
 
@@ -101,7 +102,7 @@ bool FileExistsAtPath(const std::string &path) {
 
 bool FlutterAssetBundleIsValid(const std::string &bundle_path) {
   if (!FileExistsAtPath(bundle_path)) {
-    FLWAY_ERROR << "Bundle directory: '" << bundle_path << "' does not exist." << std::endl;
+    dbgE("Bundle directory: %s does not exist\n", bundle_path.c_str());
     return false;
   }
 
@@ -111,7 +112,7 @@ bool FlutterAssetBundleIsValid(const std::string &bundle_path) {
   auto aotelf      = FileExistsAtPath(aotelf_path);
 
   if (!(kernel || aotelf)) {
-    FLWAY_ERROR << "Could not found neither " << kernel_path << " nor " << aotelf_path << std::endl;
+    dbgE("Could not found neither %s nor %s\n", kernel_path.c_str(), aotelf_path.c_str());
     return false;
   }