Move log callback to options.

Previously, all log messages generated by tox_new (which is quite a lot)
were dropped, because client code had no chance to register a logging
callback, yet. This change allows setting the log callback from the
beginning and removes the ability to unset it.

Since the log callback is forever special, since it can't be stateless,
we don't necessarily need to treat it uniformly (with `event`).

5 files changed, 155 insertions, 131 deletions

diff --git a/toxcore/Messenger.c b/toxcore/Messenger.c
index 0a3c52ee..b147e698 100644
--- a/toxcore/Messenger.c
+++ b/toxcore/Messenger.c
@@ -1885,7 +1885,7 @@ static int friend_already_added(const uint8_t *real_pk, void *data)
 }
 
 /* Run this at startup. */
-Messenger *new_messenger(Logger *log, Messenger_Options *options, unsigned int *error)
+Messenger *new_messenger(Messenger_Options *options, unsigned int *error)
 {
     Messenger *m = (Messenger *)calloc(1, sizeof(Messenger));
 
@@ -1893,10 +1893,20 @@ Messenger *new_messenger(Logger *log, Messenger_Options *options, unsigned int *
         *error = MESSENGER_ERROR_OTHER;
     }
 
-    if (! m) {
+    if (!m) {
         return NULL;
     }
 
+    Logger *log = NULL;
+
+    if (options && options->log_callback) {
+        log = logger_new();
+
+        if (log != NULL) {
+            logger_callback_log(log, options->log_callback, m, options->log_user_data);
+        }
+    }
+
     m->log = log;
 
     unsigned int net_err = 0;
@@ -2012,6 +2022,7 @@ void kill_messenger(Messenger *m)
         clear_receipts(m, i);
     }
 
+    logger_kill(m->log);
     free(m->friendlist);
     free(m);
 }
diff --git a/toxcore/Messenger.h b/toxcore/Messenger.h
index 4bcd618f..23bd0009 100644
--- a/toxcore/Messenger.h
+++ b/toxcore/Messenger.h
@@ -76,6 +76,9 @@ typedef struct {
     TCP_Proxy_Info proxy_info;
     uint16_t port_range[2];
     uint16_t tcp_server_port;
+
+    logger_cb *log_callback;
+    void *log_user_data;
 } Messenger_Options;
 
 
@@ -727,7 +730,7 @@ enum {
  *
  *  if error is not NULL it will be set to one of the values in the enum above.
  */
-Messenger *new_messenger(Logger *log, Messenger_Options *options, unsigned int *error);
+Messenger *new_messenger(Messenger_Options *options, unsigned int *error);
 
 /* Run this before closing shop
  * Free all datastructures.
diff --git a/toxcore/tox.api.h b/toxcore/tox.api.h
index 0a651c11..fd908a49 100644
--- a/toxcore/tox.api.h
+++ b/toxcore/tox.api.h
@@ -376,6 +376,52 @@ enum class SAVEDATA_TYPE {
 }
 
 
+/**
+ * Severity level of log messages.
+ */
+enum class LOG_LEVEL {
+  /**
+   * Very detailed traces including all network activity.
+   */
+  TRACE,
+  /**
+   * Debug messages such as which port we bind to.
+   */
+  DEBUG,
+  /**
+   * Informational log messages such as video call status changes.
+   */
+  INFO,
+  /**
+   * Warnings about internal inconsistency or logic errors.
+   */
+  WARNING,
+  /**
+   * Severe unexpected errors caused by external or internal inconsistency.
+   */
+  ERROR,
+}
+
+/**
+ * This event is triggered when the toxcore library logs an internal message.
+ * This is mostly useful for debugging. This callback can be called from any
+ * function, not just $iterate. This means the user data lifetime must at
+ * least extend between registering and unregistering it or $kill.
+ *
+ * Other toxcore modules such as toxav may concurrently call this callback at
+ * any time. Thus, user code must make sure it is equipped to handle concurrent
+ * execution, e.g. by employing appropriate mutex locking.
+ *
+ * @param level The severity of the log message.
+ * @param file The source file from which the message originated.
+ * @param line The source line from which the message originated.
+ * @param func The function from which the message originated.
+ * @param message The log message.
+ * @param user_data The user data pointer passed to $new in options.
+ */
+typedef void log_cb(LOG_LEVEL level, string file, uint32_t line, string func, string message, any user_data);
+
+
 static class options {
   /**
    * This struct contains all the startup options for Tox. You can either
@@ -491,6 +537,18 @@ static class options {
        */
       size_t length;
     }
+
+    namespace log {
+      /**
+       * Logging callback for the new tox instance.
+       */
+      log_cb *callback;
+
+      /**
+       * User data pointer passed to the logging callback.
+       */
+      any user_data;
+    }
   }
 
 
@@ -620,57 +678,6 @@ static this new(const options_t *options) {
 void kill();
 
 
-/**
- * Severity level of log messages.
- */
-enum class LOG_LEVEL {
-  /**
-   * Very detailed traces including all network activity.
-   */
-  TRACE,
-  /**
-   * Debug messages such as which port we bind to.
-   */
-  DEBUG,
-  /**
-   * Informational log messages such as video call status changes.
-   */
-  INFO,
-  /**
-   * Warnings about internal inconsistency or logic errors.
-   */
-  WARNING,
-  /**
-   * Severe unexpected errors caused by external or internal inconsistency.
-   */
-  ERROR,
-}
-
-/**
- * This event is triggered when the toxcore library logs an internal message.
- * This is mostly useful for debugging. This callback can be called from any
- * function, not just $iterate. This means the user data lifetime must at
- * least extend between registering and unregistering it or $kill.
- *
- * Other toxcore modules such as toxav may concurrently call this callback at
- * any time. Thus, user code must make sure it is equipped to handle concurrent
- * execution, e.g. by employing appropriate mutex locking. The callback
- * registration function must not be called during execution of any other Tox
- * library function (toxcore or toxav).
- */
-event log {
-  /**
-   * @param level The severity of the log message.
-   * @param file The source file from which the message originated.
-   * @param line The source line from which the message originated.
-   * @param func The function from which the message originated.
-   * @param message The log message.
-   */
-  typedef void(LOG_LEVEL level, string file, uint32_t line, string func,
-               string message);
-}
-
-
 uint8_t[size] savedata {
   /**
    * Calculates the number of bytes required to store the tox instance with
diff --git a/toxcore/tox.c b/toxcore/tox.c
index 29bbfba0..7898868b 100644
--- a/toxcore/tox.c
+++ b/toxcore/tox.c
@@ -133,6 +133,8 @@ ACCESSORS(uint16_t, , end_port)
 ACCESSORS(uint16_t, , tcp_port)
 ACCESSORS(TOX_SAVEDATA_TYPE, savedata_, type)
 ACCESSORS(size_t, savedata_, length)
+ACCESSORS(tox_log_cb *, log_, callback)
+ACCESSORS(void *, log_, user_data)
 
 const uint8_t *tox_options_get_savedata_data(const struct Tox_Options *options)
 {
@@ -218,6 +220,9 @@ Tox *tox_new(const struct Tox_Options *options, TOX_ERR_NEW *error)
         m_options.port_range[1] = options->end_port;
         m_options.tcp_server_port = options->tcp_port;
 
+        m_options.log_callback = (logger_cb *)options->log_callback;
+        m_options.log_user_data = options->log_user_data;
+
         switch (options->proxy_type) {
             case TOX_PROXY_TYPE_HTTP:
                 m_options.proxy_info.proxy_type = TCP_PROXY_HTTP;
@@ -258,19 +263,11 @@ Tox *tox_new(const struct Tox_Options *options, TOX_ERR_NEW *error)
         }
     }
 
-    Logger *log = logger_new();
-
-    if (log == NULL) {
-        SET_ERROR_PARAMETER(error, TOX_ERR_NEW_MALLOC);
-        return NULL;
-    }
-
     unsigned int m_error;
-    Messenger *m = new_messenger(log, &m_options, &m_error);
+    Messenger *m = new_messenger(&m_options, &m_error);
 
     if (!new_groupchats(m)) {
         kill_messenger(m);
-        logger_kill(log);
 
         if (m_error == MESSENGER_ERROR_PORT) {
             SET_ERROR_PARAMETER(error, TOX_ERR_NEW_PORT_ALLOC);
@@ -302,16 +299,8 @@ void tox_kill(Tox *tox)
     }
 
     Messenger *m = tox;
-    Logger *log = m->log;
     kill_groupchats((Group_Chats *)m->conferences_object);
     kill_messenger(m);
-    logger_kill(log);
-}
-
-void tox_callback_log(Tox *tox, tox_log_cb *callback, void *user_data)
-{
-    Messenger *m = tox;
-    m_callback_log(m, (logger_cb *)callback, tox, user_data);
 }
 
 size_t tox_get_savedata_size(const Tox *tox)
diff --git a/toxcore/tox.h b/toxcore/tox.h
index d97d94c7..4c5266fa 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -419,6 +419,60 @@ typedef enum TOX_SAVEDATA_TYPE {
 
 
 /**
+ * Severity level of log messages.
+ */
+typedef enum TOX_LOG_LEVEL {
+
+    /**
+     * Very detailed traces including all network activity.
+     */
+    TOX_LOG_LEVEL_TRACE,
+
+    /**
+     * Debug messages such as which port we bind to.
+     */
+    TOX_LOG_LEVEL_DEBUG,
+
+    /**
+     * Informational log messages such as video call status changes.
+     */
+    TOX_LOG_LEVEL_INFO,
+
+    /**
+     * Warnings about internal inconsistency or logic errors.
+     */
+    TOX_LOG_LEVEL_WARNING,
+
+    /**
+     * Severe unexpected errors caused by external or internal inconsistency.
+     */
+    TOX_LOG_LEVEL_ERROR,
+
+} TOX_LOG_LEVEL;
+
+
+/**
+ * This event is triggered when the toxcore library logs an internal message.
+ * This is mostly useful for debugging. This callback can be called from any
+ * function, not just tox_iterate. This means the user data lifetime must at
+ * least extend between registering and unregistering it or tox_kill.
+ *
+ * Other toxcore modules such as toxav may concurrently call this callback at
+ * any time. Thus, user code must make sure it is equipped to handle concurrent
+ * execution, e.g. by employing appropriate mutex locking.
+ *
+ * @param level The severity of the log message.
+ * @param file The source file from which the message originated.
+ * @param line The source line from which the message originated.
+ * @param func The function from which the message originated.
+ * @param message The log message.
+ * @param user_data The user data pointer passed to tox_new in options.
+ */
+typedef void tox_log_cb(Tox *tox, TOX_LOG_LEVEL level, const char *file, uint32_t line, const char *func,
+                        const char *message, void *user_data);
+
+
+/**
  * This struct contains all the startup options for Tox. You can either
  * allocate this object yourself, and pass it to tox_options_default, or call tox_options_new to get
  * a new default options object.
@@ -540,6 +594,18 @@ struct Tox_Options {
      */
     size_t savedata_length;
 
+
+    /**
+     * Logging callback for the new tox instance.
+     */
+    tox_log_cb *log_callback;
+
+
+    /**
+     * User data pointer passed to the logging callback.
+     */
+    void *log_user_data;
+
 };
 
 
@@ -587,6 +653,14 @@ size_t tox_options_get_savedata_length(const struct Tox_Options *options);
 
 void tox_options_set_savedata_length(struct Tox_Options *options, size_t length);
 
+tox_log_cb *tox_options_get_log_callback(const struct Tox_Options *options);
+
+void tox_options_set_log_callback(struct Tox_Options *options, tox_log_cb *callback);
+
+void *tox_options_get_log_user_data(const struct Tox_Options *options);
+
+void tox_options_set_log_user_data(struct Tox_Options *options, void *user_data);
+
 /**
  * Initialises a Tox_Options object with the default options.
  *
@@ -735,66 +809,6 @@ Tox *tox_new(const struct Tox_Options *options, TOX_ERR_NEW *error);
 void tox_kill(Tox *tox);
 
 /**
- * Severity level of log messages.
- */
-typedef enum TOX_LOG_LEVEL {
-
-    /**
-     * Very detailed traces including all network activity.
-     */
-    TOX_LOG_LEVEL_TRACE,
-
-    /**
-     * Debug messages such as which port we bind to.
-     */
-    TOX_LOG_LEVEL_DEBUG,
-
-    /**
-     * Informational log messages such as video call status changes.
-     */
-    TOX_LOG_LEVEL_INFO,
-
-    /**
-     * Warnings about internal inconsistency or logic errors.
-     */
-    TOX_LOG_LEVEL_WARNING,
-
-    /**
-     * Severe unexpected errors caused by external or internal inconsistency.
-     */
-    TOX_LOG_LEVEL_ERROR,
-
-} TOX_LOG_LEVEL;
-
-
-/**
- * @param level The severity of the log message.
- * @param file The source file from which the message originated.
- * @param line The source line from which the message originated.
- * @param func The function from which the message originated.
- * @param message The log message.
- */
-typedef void tox_log_cb(Tox *tox, TOX_LOG_LEVEL level, const char *file, uint32_t line, const char *func,
-                        const char *message, void *user_data);
-
-
-/**
- * Set the callback for the `log` event. Pass NULL to unset.
- *
- * This event is triggered when the toxcore library logs an internal message.
- * This is mostly useful for debugging. This callback can be called from any
- * function, not just tox_iterate. This means the user data lifetime must at
- * least extend between registering and unregistering it or tox_kill.
- *
- * Other toxcore modules such as toxav may concurrently call this callback at
- * any time. Thus, user code must make sure it is equipped to handle concurrent
- * execution, e.g. by employing appropriate mutex locking. The callback
- * registration function must not be called during execution of any other Tox
- * library function (toxcore or toxav).
- */
-void tox_callback_log(Tox *tox, tox_log_cb *callback, void *user_data);
-
-/**
  * Calculates the number of bytes required to store the tox instance with
  * tox_get_savedata. This function cannot fail. The result is always greater than 0.
  *