refactor: replace logging wrapper with glib functions

Author: kanru

README.md

@@ -50,7 +50,7 @@ ln -s ../../pre-commit .git/hooks/pre-commit
 
 Run ibus-chewing in command line with verbose debug logging:
 
-    G_MESSAGES_DEBUG=ibus-chewing /usr/libexec/ibus-engine-chewing -v 4
+    G_MESSAGES_DEBUG=ibus-chewing /usr/libexec/ibus-engine-chewing
 
 This will temporarily replace the current ibus-chewing engine with
 the one launched from the command line.

src/CMakeLists.txt

@@ -59,7 +59,9 @@ add_executable(ibus-engine-chewing
     main.c
 )
 target_compile_definitions(ibus-engine-chewing
-    PRIVATE VERBOSE_LEVEL=$<IF:$<CONFIG:Debug>,DEBUG,WARN>)
+    PRIVATE
+        G_LOG_DOMAIN="ibus-chewing"
+)
 target_include_directories(ibus-engine-chewing
     PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
 target_include_directories(ibus-engine-chewing

src/ibus-chewing-engine.c

@@ -52,10 +52,9 @@ guint ibus_chewing_lookup_table_update(IBusLookupTable *iTable, ChewingContext *
     gint totalChoice = chewing_cand_TotalChoice(context);
     gint currentPage = chewing_cand_CurrentPage(context);
 
-    IBUS_CHEWING_LOG(INFO,
-                     "***** ibus_chewing_lookup_table_update(): "
-                     "choicePerPage=%d, totalChoice=%d, currentPage=%d",
-                     choicePerPage, totalChoice, currentPage);
+    g_info("***** ibus_chewing_lookup_table_update(): "
+           "choicePerPage=%d, totalChoice=%d, currentPage=%d",
+           choicePerPage, totalChoice, currentPage);
 
     ibus_lookup_table_clear(iTable);
     chewing_cand_Enumerate(context);

src/ibus-chewing-lookup-table.c

@@ -74,10 +74,6 @@
 #define event_is_released(unmaskedMod) ((unmaskedMod & IBUS_RELEASE_MASK) != 0)
 #define event_process_or_ignore(cond) (cond) ? EVENT_RESPONSE_PROCESS : EVENT_RESPONSE_IGNORE
 
-#define handle_log(funcName)                                                                       \
-    IBUS_CHEWING_LOG(INFO, "* self_handle_%s(-,%x(%s),%x(%s))", funcName, kSym,                    \
-                     ibus_keyval_name(kSym), unmaskedMod, modifiers_to_string(unmaskedMod));
-
 KSym self_key_sym_fix(IBusChewingPreEdit *self, KSym kSym, KeyModifiers unmaskedMod);
 
 EventResponse self_handle_key_sym_default(IBusChewingPreEdit *self, KSym kSym,

src/ibus-chewing-preedit-private.h

@@ -8,6 +8,10 @@
 #include <ctype.h>
 #include <glib.h>
 
+#define handle_log(funcName)                                                                       \
+    g_info("* self_handle_%s(-,%x(%s),%x(%s))", funcName, kSym, ibus_keyval_name(kSym),            \
+           unmaskedMod, modifiers_to_string(unmaskedMod));
+
 /**************************************
  * Methods
  */
@@ -54,19 +58,18 @@ void ibus_chewing_pre_edit_update_outgoing(IBusChewingPreEdit *self) {
         /* commit_Check=1 means new commit available */
         gchar *commitStr = chewing_commit_String(self->context);
 
-        IBUS_CHEWING_LOG(INFO, "commitStr=|%s|\n", commitStr);
+        g_info("commitStr=|%s|\n", commitStr);
         g_string_append(self->outgoing, commitStr);
 
         chewing_free(commitStr);
         chewing_ack(self->context);
     }
-    IBUS_CHEWING_LOG(INFO, "outgoing=|%s|\n", self->outgoing->str);
-    IBUS_CHEWING_LOG(DEBUG, "ibus_chewing_pre_edit_update_outgoing(-): return: outgoing=|%s|",
-                     self->outgoing->str);
+    g_info("outgoing=|%s|\n", self->outgoing->str);
+    g_debug("ibus_chewing_pre_edit_update_outgoing(-): return: outgoing=|%s|", self->outgoing->str);
 }
 
 void ibus_chewing_pre_edit_update(IBusChewingPreEdit *self) {
-    IBUS_CHEWING_LOG(DEBUG, "* ibus_chewing_pre_edit_update(-)");
+    g_debug("* ibus_chewing_pre_edit_update(-)");
 
     /* Make preEdit */
     gchar *bufferStr = chewing_buffer_String(self->context);
@@ -79,10 +82,9 @@ void ibus_chewing_pre_edit_update(IBusChewingPreEdit *self) {
     gchar *cP = bufferStr;
     gunichar uniCh;
 
-    IBUS_CHEWING_LOG(INFO,
-                     "* ibus_chewing_pre_edit_update(-)  bufferStr=|%s|, "
-                     "bpmfStr=|%s| bpmfLen=%d cursor=%d",
-                     bufferStr, bpmfStr, self->bpmfLen, cursor_current);
+    g_info("* ibus_chewing_pre_edit_update(-)  bufferStr=|%s|, "
+           "bpmfStr=|%s| bpmfLen=%d cursor=%d",
+           bufferStr, bpmfStr, self->bpmfLen, cursor_current);
 
     for (i = 0; i < chewing_buffer_Len(self->context) && cP != NULL; i++) {
         if (i == cursor_current) {
@@ -107,21 +109,15 @@ void ibus_chewing_pre_edit_update(IBusChewingPreEdit *self) {
 
 guint ibus_chewing_pre_edit_length(IBusChewingPreEdit *self) { return self->preEdit->len; }
 
-guint ibus_chewing_pre_edit_word_length(IBusChewingPreEdit *self) { return self->wordLen; }
-
-guint ibus_chewing_pre_edit_word_limit(IBusChewingPreEdit *self) {
-    return chewing_get_maxChiSymbolLen(self->context);
-}
-
 gchar *ibus_chewing_pre_edit_get_pre_edit(IBusChewingPreEdit *self) { return self->preEdit->str; }
 
 gchar *ibus_chewing_pre_edit_get_outgoing(IBusChewingPreEdit *self) { return self->outgoing->str; }
 
 /* currently, ibus_chewing_pre_edit_force_commit() is called only by test cases.
  */
 void ibus_chewing_pre_edit_force_commit(IBusChewingPreEdit *self) {
-    IBUS_CHEWING_LOG(INFO, "ibus_chewing_pre_edit_force_commit(-) bpmf_check=%d buffer_check=%d",
-                     bpmf_check, chewing_buffer_Check(self->context));
+    g_info("ibus_chewing_pre_edit_force_commit(-) bpmf_check=%d buffer_check=%d", bpmf_check,
+           chewing_buffer_Check(self->context));
 
     /* Ignore the context and commit whatever in preedit buffer */
     g_string_append(self->outgoing, self->preEdit->str);
@@ -130,13 +126,13 @@ void ibus_chewing_pre_edit_force_commit(IBusChewingPreEdit *self) {
 }
 
 void ibus_chewing_pre_edit_clear(IBusChewingPreEdit *self) {
-    IBUS_CHEWING_LOG(INFO, "ibus_chewing_pre_edit_clear(-)");
+    g_info("ibus_chewing_pre_edit_clear(-)");
     ibus_chewing_pre_edit_clear_outgoing(self);
     ibus_chewing_pre_edit_clear_pre_edit(self);
 }
 
 void ibus_chewing_pre_edit_clear_bopomofo(IBusChewingPreEdit *self) {
-    IBUS_CHEWING_LOG(DEBUG, "ibus_chewing_pre_edit_clear_bopomofo(-)");
+    g_debug("ibus_chewing_pre_edit_clear_bopomofo(-)");
 
     /* Esc key can close candidate list, clear bopomofo, and clear
      * the whole pre-edit buffer. Make sure it acts as we expected.
@@ -151,7 +147,7 @@ void ibus_chewing_pre_edit_clear_bopomofo(IBusChewingPreEdit *self) {
 }
 
 void ibus_chewing_pre_edit_clear_pre_edit(IBusChewingPreEdit *self) {
-    IBUS_CHEWING_LOG(DEBUG, "ibus_chewing_pre_edit_clear_pre_edit(-)");
+    g_debug("ibus_chewing_pre_edit_clear_pre_edit(-)");
 
     ibus_chewing_pre_edit_clear_bopomofo(self);
 
@@ -167,7 +163,7 @@ void ibus_chewing_pre_edit_clear_pre_edit(IBusChewingPreEdit *self) {
 }
 
 void ibus_chewing_pre_edit_clear_outgoing(IBusChewingPreEdit *self) {
-    IBUS_CHEWING_LOG(DEBUG, "ibus_chewing_pre_edit_clear_outgoing(-)");
+    g_debug("ibus_chewing_pre_edit_clear_outgoing(-)");
     g_string_assign(self->outgoing, "");
 }
 
@@ -258,8 +254,8 @@ EventResponse self_handle_key_sym_default(IBusChewingPreEdit *self, KSym kSym,
     EventResponse response = EVENT_RESPONSE_UNDECIDED;
     KSym fixedKSym = self_key_sym_fix(self, kSym, unmaskedMod);
 
-    IBUS_CHEWING_LOG(DEBUG, "* self_handle_key_sym_default(): new kSym %x(%s), %x(%s)", fixedKSym,
-                     ibus_keyval_name(fixedKSym), unmaskedMod, modifiers_to_string(unmaskedMod));
+    g_debug("* self_handle_key_sym_default(): new kSym %x(%s), %x(%s)", fixedKSym,
+            ibus_keyval_name(fixedKSym), unmaskedMod, modifiers_to_string(unmaskedMod));
     gint ret = chewing_handle_Default(self->context, fixedKSym);
 
     /* Handle quick commit */
@@ -280,7 +276,7 @@ EventResponse self_handle_key_sym_default(IBusChewingPreEdit *self, KSym kSym,
         break;
     }
 
-    IBUS_CHEWING_LOG(DEBUG, "self_handle_key_sym_default() ret=%d response=%d", ret, response);
+    g_debug("self_handle_key_sym_default() ret=%d response=%d", ret, response);
     /* Restore easySymbolInput */
     chewing_set_easySymbolInput(self->context, easySymbolInput);
     return response;
@@ -655,7 +651,7 @@ EventResponse self_handle_special([[maybe_unused]] IBusChewingPreEdit *self,
                                   [[maybe_unused]] KSym kSym,
                                   [[maybe_unused]] KeyModifiers unmaskedMod) {
     /* KSym >=128 is special key, which IM ignore. */
-    IBUS_CHEWING_LOG(MSG, "ignore special key");
+    g_message("ignore special key");
     return EVENT_RESPONSE_IGNORE;
 }
 
@@ -749,12 +745,11 @@ static KeyHandlingRule *self_key_sym_find_key_handling_rule(KSym kSym) {
     (self_key_sym_find_key_handling_rule(kSym))->keyFunc(self, kSym, unmaskedMod)
 
 #define process_key_debug(prompt)                                                                  \
-    IBUS_CHEWING_LOG(DEBUG,                                                                        \
-                     "ibus_chewing_pre_edit_process_key(): %s flags=%x "                           \
-                     "buff_check=%d bpmf_check=%d cursor=%d total_choice=%d "                      \
-                     "is_chinese=%d is_full_shape=%d",                                             \
-                     prompt, self->flags, chewing_buffer_Check(self->context), bpmf_check,         \
-                     cursor_current, total_choice, is_chinese, is_full_shape)
+    g_debug("ibus_chewing_pre_edit_process_key(): %s flags=%x "                                    \
+            "buff_check=%d bpmf_check=%d cursor=%d total_choice=%d "                               \
+            "is_chinese=%d is_full_shape=%d",                                                      \
+            prompt, self->flags, chewing_buffer_Check(self->context), bpmf_check, cursor_current,  \
+            total_choice, is_chinese, is_full_shape)
 
 gboolean is_shift_key(KSym kSym) { return kSym == IBUS_KEY_Shift_L || kSym == IBUS_KEY_Shift_R; }
 
@@ -770,8 +765,8 @@ gboolean is_shift_toggle(KSym keyLast, KSym kSym, KeyModifiers unmaskedMod) {
 /* keyCode should be converted to kSym already */
 gboolean ibus_chewing_pre_edit_process_key(IBusChewingPreEdit *self, KSym kSym,
                                            KeyModifiers unmaskedMod) {
-    IBUS_CHEWING_LOG(INFO, "***** ibus_chewing_pre_edit_process_key(-,%x(%s),%x(%s))", kSym,
-                     ibus_keyval_name(kSym), unmaskedMod, modifiers_to_string(unmaskedMod));
+    g_info("***** ibus_chewing_pre_edit_process_key(-,%x(%s),%x(%s))", kSym, ibus_keyval_name(kSym),
+           unmaskedMod, modifiers_to_string(unmaskedMod));
     process_key_debug("Before response");
 
     /* Find corresponding rule */
@@ -803,7 +798,7 @@ gboolean ibus_chewing_pre_edit_process_key(IBusChewingPreEdit *self, KSym kSym,
     self->keyLast = kSym;
     self->keyLastTs = g_get_monotonic_time();
 
-    IBUS_CHEWING_LOG(DEBUG, "ibus_chewing_pre_edit_process_key() response=%x", response);
+    g_debug("ibus_chewing_pre_edit_process_key() response=%x", response);
     process_key_debug("After response");
     switch (response) {
     case EVENT_RESPONSE_ABSORB:
@@ -818,7 +813,7 @@ gboolean ibus_chewing_pre_edit_process_key(IBusChewingPreEdit *self, KSym kSym,
 
     guint candidateCount = ibus_chewing_lookup_table_update(self->iTable, self->context);
 
-    IBUS_CHEWING_LOG(INFO, "ibus_chewing_pre_edit_process_key() candidateCount=%d", candidateCount);
+    g_info("ibus_chewing_pre_edit_process_key() candidateCount=%d", candidateCount);
 
     if (candidateCount) {
         ibus_chewing_pre_edit_set_flag(self, FLAG_TABLE_SHOW);

src/ibus-chewing-preedit.c

@@ -95,10 +95,6 @@ void ibus_chewing_pre_edit_free(IBusChewingPreEdit *self);
 
 guint ibus_chewing_pre_edit_length(IBusChewingPreEdit *self);
 
-guint ibus_chewing_pre_edit_word_length(IBusChewingPreEdit *self);
-
-guint ibus_chewing_pre_edit_word_limit(IBusChewingPreEdit *self);
-
 #define ibus_chewing_pre_edit_is_empty(self) (ibus_chewing_pre_edit_length(self) == 0)
 
 #define ibus_chewing_pre_edit_is_full(self)                                                        \

src/ibus-chewing-preedit.h

@@ -108,43 +108,3 @@ const gchar *modifiers_to_string(guint modifier) {
     }
     return modifierBuf;
 }
-
-static MkdgLogLevel debugLevel = WARN;
-
-void mkdg_log_set_level(MkdgLogLevel level) { debugLevel = level; }
-
-void mkdg_logv_domain(const gchar *domain, MkdgLogLevel level, const gchar *format,
-                      va_list argList) {
-    if (level > debugLevel)
-        return;
-    GLogLevelFlags flagSet;
-
-    switch (level) {
-    case ERROR:
-        flagSet = G_LOG_FLAG_FATAL | G_LOG_LEVEL_ERROR;
-        break;
-    case WARN:
-        flagSet = G_LOG_LEVEL_WARNING;
-        break;
-    case MSG:
-        flagSet = G_LOG_LEVEL_MESSAGE;
-        break;
-    case INFO:
-        flagSet = G_LOG_LEVEL_INFO;
-        break;
-    default:
-        flagSet = G_LOG_LEVEL_DEBUG;
-        break;
-    }
-    g_logv(domain, flagSet, format, argList);
-}
-
-void mkdg_log_domain(const gchar *domain, MkdgLogLevel level, const gchar *format, ...) {
-    if (level > debugLevel)
-        return;
-    va_list argList;
-
-    va_start(argList, format);
-    mkdg_logv_domain(domain, level, format, argList);
-    va_end(argList);
-}

src/ibus-chewing-util.c

@@ -32,8 +32,6 @@
      (CHEWING_VERSION_MAJOR == (major) && CHEWING_VERSION_MINOR == (minor) &&                      \
       CHEWING_VERSION_PATCH >= (patch)))
 
-#define IBUS_CHEWING_LOG(level, msg, args...) mkdg_log_domain("ibus-chewing", level, msg, ##args)
-
 typedef guint KSym;
 
 typedef guint KeyModifiers;
@@ -63,25 +61,6 @@ KSym key_sym_KP_to_normal(KSym k);
 
 const gchar *modifiers_to_string(guint modifier);
 
-/**
- * MkdgLogLevel:
- * @ERROR: Show auses of failure, the program should stop
- * @WARN:  Show issues to be address, the program will still run.
- * @MSG:   Show normal message
- * @INFO:  Show information message
- * @DEBUG: Show debug message
- *
- * Message verbose level, from low to high. Similar to Log level of Gtk.
- *
- */
-typedef enum { ERROR, WARN, MSG, INFO, DEBUG } MkdgLogLevel;
-
-void mkdg_log_set_level(MkdgLogLevel level);
-
-void mkdg_log(MkdgLogLevel level, const char *format, ...);
-
-void mkdg_log_domain(const char *domain, MkdgLogLevel level, const char *format, ...);
-
 /**************************************
  * String Utility Macros and Functions
  */

src/ibus-chewing-util.h

@@ -35,13 +35,10 @@ static IBusFactory *factory = NULL;
 static gboolean showFlags = FALSE;
 static gboolean ibus = FALSE;
 static gboolean xml = FALSE;
-gint ibus_chewing_verbose = VERBOSE_LEVEL;
 
 static const GOptionEntry entries[] = {
     {"show_flags", 's', 0, G_OPTION_ARG_NONE, &showFlags, "Show compile flag only", NULL},
     {"ibus", 'i', 0, G_OPTION_ARG_NONE, &ibus, "component is executed by ibus", NULL},
-    {"verbose", 'v', 0, G_OPTION_ARG_INT, &ibus_chewing_verbose,
-     "Verbose level. The higher the level, the more the debug messages.", "[integer]"},
     {"xml", 'x', 0, G_OPTION_ARG_NONE, &xml, "read chewing engine desc from xml file", NULL},
     {}, // null entry
 };
@@ -53,13 +50,13 @@ static void ibus_disconnected_cb([[maybe_unused]] IBusBus *bus,
 }
 
 static void start_component(void) {
-    IBUS_CHEWING_LOG(INFO, "start_component");
+    g_info("start_component");
     ibus_init();
     bus = ibus_bus_new();
     g_signal_connect(bus, "disconnected", G_CALLBACK(ibus_disconnected_cb), NULL);
 
     if (!ibus_bus_is_connected(bus)) {
-        IBUS_CHEWING_LOG(ERROR, _("Cannot connect to IBus!"));
+        g_error(_("Cannot connect to IBus!"));
         exit(2);
     }
 
@@ -107,7 +104,7 @@ static void start_component(void) {
 
     if (ibus) {
         guint32 ret = ibus_bus_request_name(bus, QUOTE_ME(PROJECT_SCHEMA_ID), 0);
-        IBUS_CHEWING_LOG(INFO, "start_component: request_name: %u", ret);
+        g_info("start_component: request_name: %u", ret);
     } else {
         ibus_bus_register_component(bus, component);
     }
@@ -145,7 +142,7 @@ void determine_locale() {
     g_strlcat(localeStr, ".utf8", STRING_BUFFER_SIZE);
 #undef STRING_BUFFER_SIZE
     setlocale(LC_ALL, localeStr);
-    IBUS_CHEWING_LOG(INFO, "determine_locale %s", localeStr);
+    g_info("determine_locale %s", localeStr);
 }
 
 int main(gint argc, gchar *argv[]) {
@@ -170,15 +167,13 @@ int main(gint argc, gchar *argv[]) {
     }
 
     g_option_context_free(context);
-    mkdg_log_set_level(ibus_chewing_verbose);
 
     g_autoptr(GSettings) settings = g_settings_new(QUOTE_ME(PROJECT_SCHEMA_ID));
     g_autoptr(GVariant) plain_zhuyin = g_settings_get_user_value(settings, "plain-zhuyin");
     if (plain_zhuyin != NULL) {
         // migrate settings
         gboolean is_plain_zhuyin = g_variant_get_boolean(plain_zhuyin);
-        IBUS_CHEWING_LOG(MSG, "migrate plain-zhuyin(%d) setting to conversion-engine",
-                         is_plain_zhuyin);
+        g_message("migrate plain-zhuyin(%d) setting to conversion-engine", is_plain_zhuyin);
         if (is_plain_zhuyin) {
             g_settings_set_enum(settings, "conversion-engine", SIMPLE_CONVERSION_ENGINE);
         }