X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=glib%2Fgmessages.c;h=7288fc4bf243c6f2d4ee2b3226ecd8158937ac02;hb=bc6ee788b4ff6590513da6ab657448885e92b20b;hp=1548f06f52becb4257ed7dd237e54a861a346f19;hpb=f2a9a6142c7187b6dd700728ecfa5ea094ad6096;p=platform%2Fupstream%2Fglib.git diff --git a/glib/gmessages.c b/glib/gmessages.c index 1548f06..7288fc4 100644 --- a/glib/gmessages.c +++ b/glib/gmessages.c @@ -12,9 +12,7 @@ * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * License along with this library; if not, see . */ /* @@ -35,15 +33,16 @@ * * These functions provide support for outputting messages. * - * The g_return family of macros (g_return_if_fail(), - * g_return_val_if_fail(), g_return_if_reached(), g_return_val_if_reached()) - * should only be used for programming errors, a typical use case is - * checking for invalid parameters at the beginning of a public function. - * They should not be used if you just mean "if (error) return", they - * should only be used if you mean "if (bug in program) return". - * The program behavior is generally considered undefined after one - * of these checks fails. They are not intended for normal control - * flow, only to give a perhaps-helpful warning before giving up. + * The g_return family of macros (g_return_if_fail(), + * g_return_val_if_fail(), g_return_if_reached(), + * g_return_val_if_reached()) should only be used for programming + * errors, a typical use case is checking for invalid parameters at + * the beginning of a public function. They should not be used if + * you just mean "if (error) return", they should only be used if + * you mean "if (bug in program) return". The program behavior is + * generally considered undefined after one of these checks fails. + * They are not intended for normal control flow, only to give a + * perhaps-helpful warning before giving up. */ #include "config.h" @@ -52,15 +51,10 @@ #include #include #include -#ifdef HAVE_UNISTD_H -#include -#endif #include #include #include -#include "gmessages-private.h" - #include "glib-init.h" #include "gbacktrace.h" #include "gcharset.h" @@ -74,6 +68,10 @@ #include "gstring.h" #include "gpattern.h" +#ifdef G_OS_UNIX +#include +#endif + #ifdef G_OS_WIN32 #include /* For getpid() */ #include @@ -127,6 +125,12 @@ * @user_data: user data, set in g_log_set_handler() * * Specifies the prototype of log handler functions. + * + * The default log handler, g_log_default_handler(), automatically appends a + * new-line character to @message when printing it. It is advised that any + * custom log handler functions behave similarly, so that logging calls in user + * code do not need modifying to add a new-line character to the message if the + * log handler is changed. */ /** @@ -140,7 +144,7 @@ * and g_return_val_if_fail(). * @G_LOG_LEVEL_WARNING: log level for warnings, see g_warning() * @G_LOG_LEVEL_MESSAGE: log level for messages, see g_message() - * @G_LOG_LEVEL_INFO: log level for informational messages + * @G_LOG_LEVEL_INFO: log level for informational messages, see g_info() * @G_LOG_LEVEL_DEBUG: log level for debug messages, see g_debug() * @G_LOG_LEVEL_MASK: a mask including all log levels * @@ -156,6 +160,10 @@ * into the format string (as with printf()) * * A convenience function/macro to log a normal message. + * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. */ /** @@ -165,9 +173,13 @@ * * A convenience function/macro to log a warning message. * - * You can make warnings fatal at runtime by setting the - * G_DEBUG environment variable (see - * Running GLib Applications). + * You can make warnings fatal at runtime by setting the `G_DEBUG` + * environment variable (see + * [Running GLib Applications](glib-running.html)). + * + * If g_log_default_handler() is used as the log handler function, + * a newline character will automatically be appended to @..., and + * need not be entered manually. */ /** @@ -183,8 +195,12 @@ * example. * * You can also make critical warnings fatal at runtime by - * setting the G_DEBUG environment variable (see - * Running GLib Applications). + * setting the `G_DEBUG` environment variable (see + * [Running GLib Applications](glib-running.html)). + * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. */ /** @@ -200,6 +216,27 @@ * Using this function indicates a bug in your program, i.e. * an assertion failure. * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. + * + */ + +/** + * g_info: + * @...: format string, followed by parameters to insert + * into the format string (as with printf()) + * + * A convenience function/macro to log an informational message. Seldom used. + * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. + * + * Such messages are suppressed by the g_log_default_handler() unless + * the G_MESSAGES_DEBUG environment variable is set appropriately. + * + * Since: 2.40 */ /** @@ -209,6 +246,13 @@ * * A convenience function/macro to log a debug message. * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. + * + * Such messages are suppressed by the g_log_default_handler() unless + * the G_MESSAGES_DEBUG environment variable is set appropriately. + * * Since: 2.6 */ @@ -238,7 +282,6 @@ static GLogDomain *g_log_domains = NULL; static GPrintFunc glib_print_func = NULL; static GPrintFunc glib_printerr_func = NULL; static GPrivate g_log_depth; -static gboolean exit_on_fatal; static GLogFunc default_log_func = g_log_default_handler; static gpointer default_log_data = NULL; static GTestLogFatalFunc fatal_log_func = NULL; @@ -246,11 +289,23 @@ static gpointer fatal_log_data; /* --- functions --- */ -void -_g_log_abort (void) +static void _g_log_abort (gboolean breakpoint); + +static void +_g_log_abort (gboolean breakpoint) { - if (exit_on_fatal) - _exit (1); + if (g_test_subprocess ()) + { + /* If this is a test case subprocess then it probably caused + * this error message on purpose, so just exit() rather than + * abort()ing, to avoid triggering any system crash-reporting + * daemon. + */ + _exit (1); + } + + if (breakpoint) + G_BREAKPOINT (); else abort (); } @@ -394,8 +449,8 @@ g_log_domain_get_handler_L (GLogDomain *domain, * %G_LOG_LEVEL_ERROR is always fatal. * * You can also make some message levels fatal at runtime by setting - * the G_DEBUG environment variable (see - * Running GLib Applications). + * the `G_DEBUG` environment variable (see + * [Running GLib Applications](glib-running.html)). * * Returns: the old fatal mask */ @@ -481,31 +536,24 @@ g_log_set_fatal_mask (const gchar *log_domain, * you want to set a handler for this log level you must combine it with * #G_LOG_FLAG_FATAL. * - * - * Adding a log handler for all warning messages in the default - * (application) domain - * + * Here is an example for adding a log handler for all warning messages + * in the default domain: + * |[ * g_log_set_handler (NULL, G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL * | G_LOG_FLAG_RECURSION, my_log_handler, NULL); - * - * + * ]| * - * - * Adding a log handler for all critical messages from GTK+ - * + * This example adds a log handler for all critical messages from GTK+: + * |[ * g_log_set_handler ("Gtk", G_LOG_LEVEL_CRITICAL | G_LOG_FLAG_FATAL * | G_LOG_FLAG_RECURSION, my_log_handler, NULL); - * - * + * ]| * - * - * Adding a log handler for <emphasis>all</emphasis> messages from - * GLib - * + * This example adds a log handler for all messages from GLib: + * |[ * g_log_set_handler ("GLib", G_LOG_LEVEL_MASK | G_LOG_FLAG_FATAL * | G_LOG_FLAG_RECURSION, my_log_handler, NULL); - * - * + * ]| * * Returns: the id of the new handler */ @@ -652,7 +700,7 @@ g_log_remove_handler (const gchar *log_domain, } } g_mutex_unlock (&g_messages_lock); - g_warning ("%s: could not find handler with id `%d' for domain \"%s\"", + g_warning ("%s: could not find handler with id '%d' for domain \"%s\"", G_STRLOC, handler_id, log_domain); } @@ -859,6 +907,10 @@ static GSList *expected_messages = NULL; * * If the log level has been set as fatal, the abort() * function is called to terminate the program. + * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. */ void g_logv (const gchar *log_domain, @@ -892,19 +944,19 @@ g_logv (const gchar *log_domain, { GTestExpectedMessage *expected = expected_messages->data; - expected_messages = g_slist_delete_link (expected_messages, - expected_messages); - if (strcmp (expected->log_domain, log_domain) == 0 && + if (g_strcmp0 (expected->log_domain, log_domain) == 0 && ((log_level & expected->log_level) == expected->log_level) && g_pattern_match_simple (expected->pattern, msg)) { + expected_messages = g_slist_delete_link (expected_messages, + expected_messages); g_free (expected->log_domain); g_free (expected->pattern); g_free (expected); g_free (msg_alloc); return; } - else + else if ((log_level & G_LOG_LEVEL_DEBUG) != G_LOG_LEVEL_DEBUG) { gchar level_prefix[STRING_BUFFER_SIZE]; gchar *expected_message; @@ -966,11 +1018,7 @@ g_logv (const gchar *log_domain, && !fatal_log_func (log_domain, test_level, msg, fatal_log_data); } - if ((test_level & G_LOG_FLAG_FATAL) && exit_on_fatal && !masquerade_fatal) - { - _g_log_abort (); - } - else if ((test_level & G_LOG_FLAG_FATAL) && !masquerade_fatal) + if ((test_level & G_LOG_FLAG_FATAL) && !masquerade_fatal) { #ifdef G_OS_WIN32 if (win32_keep_fatal_message) @@ -980,15 +1028,9 @@ g_logv (const gchar *log_domain, MessageBox (NULL, locale_msg, NULL, MB_ICONERROR|MB_SETFOREGROUND); } - if (IsDebuggerPresent () && !(test_level & G_LOG_FLAG_RECURSION)) - G_BREAKPOINT (); - else - abort (); + _g_log_abort (IsDebuggerPresent () && !(test_level & G_LOG_FLAG_RECURSION)); #else - if (!(test_level & G_LOG_FLAG_RECURSION)) - G_BREAKPOINT (); - else - abort (); + _g_log_abort (!(test_level & G_LOG_FLAG_RECURSION)); #endif /* !G_OS_WIN32 */ } @@ -1012,6 +1054,10 @@ g_logv (const gchar *log_domain, * * If the log level has been set as fatal, the abort() * function is called to terminate the program. + * + * If g_log_default_handler() is used as the log handler function, a new-line + * character will automatically be appended to @..., and need not be entered + * manually. */ void g_log (const gchar *log_domain, @@ -1033,7 +1079,7 @@ g_return_if_fail_warning (const char *log_domain, { g_log (log_domain, G_LOG_LEVEL_CRITICAL, - "%s: assertion `%s' failed", + "%s: assertion '%s' failed", pretty_function, expression); } @@ -1075,15 +1121,15 @@ g_assert_warning (const char *log_domain, line, pretty_function, expression); - _g_log_abort (); + _g_log_abort (FALSE); + abort (); } /** * g_test_expect_message: - * @log_domain: the log domain of the message + * @log_domain: (allow-none): the log domain of the message * @log_level: the log level of the message - * @pattern: a glob-style - * pattern + * @pattern: a glob-style [pattern][glib-Glob-style-pattern-matching] * * Indicates that a message with the given @log_domain and @log_level, * with text matching @pattern, is expected to be logged. When this @@ -1099,10 +1145,9 @@ g_assert_warning (const char *log_domain, * * For example: * - * |[ - * /* g_main_context_push_thread_default() should fail if the - * * context is already owned by another thread. - * */ + * |[ + * // g_main_context_push_thread_default() should fail if the + * // context is already owned by another thread. * g_test_expect_message (G_LOG_DOMAIN, * G_LOG_LEVEL_CRITICAL, * "assertion*acquired_context*failed"); @@ -1114,6 +1159,9 @@ g_assert_warning (const char *log_domain, * g_error() intentionally never returns even if the program doesn't * abort; use g_test_trap_subprocess() in this case. * + * If messages at %G_LOG_LEVEL_DEBUG are emitted, but not explicitly + * expected via g_test_expect_message() then they will be ignored. + * * Since: 2.34 */ void @@ -1123,9 +1171,9 @@ g_test_expect_message (const gchar *log_domain, { GTestExpectedMessage *expected; - g_return_if_fail (log_domain != NULL); g_return_if_fail (log_level != 0); g_return_if_fail (pattern != NULL); + g_return_if_fail (~log_level & G_LOG_LEVEL_ERROR); expected = g_new (GTestExpectedMessage, 1); expected->log_domain = g_strdup (log_domain); @@ -1163,6 +1211,9 @@ g_test_assert_expected_messages_internal (const char *domain, * Asserts that all messages previously indicated via * g_test_expect_message() have been seen and suppressed. * + * If messages at %G_LOG_LEVEL_DEBUG are emitted, but not explicitly + * expected via g_test_expect_message() then they will be ignored. + * * Since: 2.34 */ @@ -1285,27 +1336,20 @@ escape_string (GString *string) * allows to install an alternate default log handler. * This is used if no log handler has been set for the particular log * domain and log level combination. It outputs the message to stderr - * or stdout and if the log level is fatal it calls abort(). + * or stdout and if the log level is fatal it calls abort(). It automatically + * prints a new-line character after the message, so one does not need to be + * manually included in @message. * * The behavior of this log handler can be influenced by a number of * environment variables: - * - * - * G_MESSAGES_PREFIXED - * - * A :-separated list of log levels for which messages should - * be prefixed by the program name and PID of the aplication. - * - * - * - * G_MESSAGES_DEBUG - * - * A space-separated list of log domains for which debug and - * informational messages are printed. By default these - * messages are not printed. - * - * - * + * + * - `G_MESSAGES_PREFIXED`: A :-separated list of log levels for which + * messages should be prefixed by the program name and PID of the + * aplication. + * + * - `G_MESSAGES_DEBUG`: A space-separated list of log domains for + * which debug and informational messages are printed. By default + * these messages are not printed. * * stderr is used for levels %G_LOG_LEVEL_ERROR, %G_LOG_LEVEL_CRITICAL, * %G_LOG_LEVEL_WARNING and %G_LOG_LEVEL_MESSAGE. stdout is used for @@ -1427,7 +1471,9 @@ g_set_print_handler (GPrintFunc func) * @...: the parameters to insert into the format string * * Outputs a formatted message via the print handler. - * The default print handler simply outputs the message to stdout. + * The default print handler simply outputs the message to stdout, without + * appending a trailing new-line character. Typically, @format should end with + * its own new-line character. * * g_print() should not be used from within libraries for debugging * messages, since it may be redirected by applications to special @@ -1506,7 +1552,9 @@ g_set_printerr_handler (GPrintFunc func) * @...: the parameters to insert into the format string * * Outputs a formatted message via the error message handler. - * The default handler simply outputs the message to stderr. + * The default handler simply outputs the message to stderr, without appending + * a trailing new-line character. Typically, @format should end with its own + * new-line character. * * g_printerr() should not be used from within libraries. * Instead g_log() should be used, or the convenience functions @@ -1567,9 +1615,3 @@ g_printf_string_upper_bound (const gchar *format, gchar c; return _g_vsnprintf (&c, 1, format, args) + 1; } - -void -_g_log_set_exit_on_fatal (void) -{ - exit_on_fatal = TRUE; -}