regex: Add FIRSTLINE compile flag
[platform/upstream/glib.git] / glib / gbacktrace.c
index 24e9a9e..957c482 100644 (file)
  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GLib Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-/* 
- * MT safe ; except for g_on_error_stack_trace, but who wants thread safety 
+/*
+ * MT safe ; except for g_on_error_stack_trace, but who wants thread safety
  * then
  */
 
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
+#include "config.h"
+#include "glibconfig.h"
 
 #include <signal.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include "glib.h"
-#include "gprintfint.h"
 
 #ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>
@@ -47,6 +44,9 @@
 #include <sys/times.h>
 #endif
 #include <sys/types.h>
+#ifdef HAVE_SYS_WAIT_H
+#include <sys/wait.h>
+#endif
 
 #include <time.h>
 #ifdef HAVE_UNISTD_H
 #include <sys/select.h>
 #endif /* HAVE_SYS_SELECT_H */
 
-#ifdef STDC_HEADERS
 #include <string.h> /* for bzero on BSD systems */
-#endif
 
 #ifdef G_OS_WIN32
-#  define STRICT               /* Strict typing, please */
+#  define STRICT                /* Strict typing, please */
+#  define _WIN32_WINDOWS 0x0401 /* to get IsDebuggerPresent */
 #  include <windows.h>
 #  undef STRICT
 #endif
 
+#include "gbacktrace.h"
+
+#include "gtypes.h"
+#include "gmain.h"
+#include "gprintfint.h"
+#include "gutils.h"
+
+
 #ifndef NO_FD_SET
 #  define SELECT_MASK fd_set
 #else
@@ -85,38 +92,88 @@ static void stack_trace (char **args);
 extern volatile gboolean glib_on_error_halt;
 volatile gboolean glib_on_error_halt = TRUE;
 
+/**
+ * g_on_error_query:
+ * @prg_name: the program name, needed by <command>gdb</command>
+ *     for the [S]tack trace option. If @prg_name is %NULL, g_get_prgname()
+ *     is called to get the program name (which will work correctly if
+ *     gdk_init() or gtk_init() has been called)
+ *
+ * Prompts the user with
+ * <computeroutput>[E]xit, [H]alt, show [S]tack trace or [P]roceed</computeroutput>.
+ * This function is intended to be used for debugging use only.
+ * The following example shows how it can be used together with
+ * the g_log() functions.
+ *
+ * |[
+ * &num;include &lt;glib.h&gt;
+ *
+ * static void
+ * log_handler (const gchar   *log_domain,
+ *              GLogLevelFlags log_level,
+ *              const gchar   *message,
+ *              gpointer       user_data)
+ * {
+ *   g_log_default_handler (log_domain, log_level, message, user_data);
+ *
+ *   g_on_error_query (MY_PROGRAM_NAME);
+ * }
+ *
+ * int
+ * main (int argc, char *argv[])
+ * {
+ *   g_log_set_handler (MY_LOG_DOMAIN,
+ *                      G_LOG_LEVEL_WARNING |
+ *                      G_LOG_LEVEL_ERROR |
+ *                      G_LOG_LEVEL_CRITICAL,
+ *                      log_handler,
+ *                      NULL);
+ *   /&ast; ... &ast;/
+ * ]|
+ *
+ * If [E]xit is selected, the application terminates with a call
+ * to <literal>_exit(0)</literal>.
+ *
+ * If [S]tack trace is selected, g_on_error_stack_trace() is called.
+ * This invokes <command>gdb</command>, which attaches to the current
+ * process and shows a stack trace. The prompt is then shown again.
+ *
+ * If [P]roceed is selected, the function returns.
+ *
+ * This function may cause different actions on non-UNIX platforms.
+ */
 void
 g_on_error_query (const gchar *prg_name)
 {
 #ifndef G_OS_WIN32
-  static const gchar *query1 = "[E]xit, [H]alt";
-  static const gchar *query2 = ", show [S]tack trace";
-  static const gchar *query3 = " or [P]roceed";
+  static const gchar * const query1 = "[E]xit, [H]alt";
+  static const gchar * const query2 = ", show [S]tack trace";
+  static const gchar * const query3 = " or [P]roceed";
   gchar buf[16];
 
   if (!prg_name)
     prg_name = g_get_prgname ();
-  
+
  retry:
-  
+
   if (prg_name)
     _g_fprintf (stdout,
-               "%s (pid:%u): %s%s%s: ",
-               prg_name,
-               (guint) getpid (),
-               query1,
-               query2,
-               query3);
+                "%s (pid:%u): %s%s%s: ",
+                prg_name,
+                (guint) getpid (),
+                query1,
+                query2,
+                query3);
   else
     _g_fprintf (stdout,
-               "(process:%u): %s%s: ",
-               (guint) getpid (),
-               query1,
-               query3);
+                "(process:%u): %s%s: ",
+                (guint) getpid (),
+                query1,
+                query3);
   fflush (stdout);
-  
+
   if (isatty(0) && isatty(1))
-    fgets (buf, 8, stdin); 
+    fgets (buf, 8, stdin);
   else
     strcpy (buf, "E\n");
 
@@ -124,20 +181,20 @@ g_on_error_query (const gchar *prg_name)
       && buf[1] == '\n')
     _exit (0);
   else if ((buf[0] == 'P' || buf[0] == 'p')
-          && buf[1] == '\n')
+           && buf[1] == '\n')
     return;
   else if (prg_name
-          && (buf[0] == 'S' || buf[0] == 's')
-          && buf[1] == '\n')
+           && (buf[0] == 'S' || buf[0] == 's')
+           && buf[1] == '\n')
     {
       g_on_error_stack_trace (prg_name);
       goto retry;
     }
   else if ((buf[0] == 'H' || buf[0] == 'h')
-          && buf[1] == '\n')
+           && buf[1] == '\n')
     {
       while (glib_on_error_halt)
-       ;
+        ;
       glib_on_error_halt = TRUE;
       return;
     }
@@ -146,21 +203,35 @@ g_on_error_query (const gchar *prg_name)
 #else
   if (!prg_name)
     prg_name = g_get_prgname ();
-  
+
   MessageBox (NULL, "g_on_error_query called, program terminating",
-             (prg_name && *prg_name) ? prg_name : NULL,
-             MB_OK|MB_ICONERROR);
+              (prg_name && *prg_name) ? prg_name : NULL,
+              MB_OK|MB_ICONERROR);
   _exit(0);
 #endif
 }
 
+/**
+ * g_on_error_stack_trace:
+ * @prg_name: the program name, needed by <command>gdb</command>
+ *     for the [S]tack trace option.
+ *
+ * Invokes <command>gdb</command>, which attaches to the current
+ * process and shows a stack trace. Called by g_on_error_query()
+ * when the [S]tack trace option is selected. You can get the current
+ * process's "program name" with g_get_prgname(), assuming that you
+ * have called gtk_init() or gdk_init().
+ *
+ * This function may cause different actions on non-UNIX platforms.
+ */
 void
 g_on_error_stack_trace (const gchar *prg_name)
 {
-#ifdef G_OS_UNIX
+#if defined(G_OS_UNIX) || defined(G_OS_BEOS)
   pid_t pid;
   gchar buf[16];
   gchar *args[4] = { "gdb", NULL, NULL, NULL };
+  int status;
 
   if (!prg_name)
     return;
@@ -181,12 +252,13 @@ g_on_error_stack_trace (const gchar *prg_name)
       perror ("unable to fork gdb");
       return;
     }
-  
-  while (glib_on_error_halt)
-    ;
-  glib_on_error_halt = TRUE;
+
+  waitpid (pid, &status, 0);
 #else
-  abort ();
+  if (IsDebuggerPresent ())
+    G_BREAKPOINT ();
+  else
+    abort ();
 #endif
 }
 
@@ -209,7 +281,7 @@ stack_trace (char **args)
   SELECT_MASK fdset;
   SELECT_MASK readset;
   struct timeval tv;
-  int sel, index, state;
+  int sel, idx, state;
   char buffer[256];
   char c;
 
@@ -246,7 +318,7 @@ stack_trace (char **args)
   write (in_fd[1], "p x = 0\n", 8);
   write (in_fd[1], "quit\n", 5);
 
-  index = 0;
+  idx = 0;
   state = 0;
 
   while (1)
@@ -269,18 +341,18 @@ stack_trace (char **args)
                   if (c == '#')
                     {
                       state = 1;
-                      index = 0;
-                      buffer[index++] = c;
+                      idx = 0;
+                      buffer[idx++] = c;
                     }
                   break;
                 case 1:
-                  buffer[index++] = c;
+                  buffer[idx++] = c;
                   if ((c == '\n') || (c == '\r'))
                     {
-                      buffer[index] = 0;
+                      buffer[idx] = 0;
                       _g_fprintf (stdout, "%s", buffer);
                       state = 0;
-                      index = 0;
+                      idx = 0;
                     }
                   break;
                 default: