Merge lp:~ghugesss/xpad/debug_support into lp:xpad

[Sagar Ghuge]

[Arthur Borsboom (arthurborsboom)]

Hi Sagar,

When I asked for the merge request I was actually referring to the bug
report of the improved headers.
Although it shouldn't matter to much in which order I merge the branches,
is the debugging branch already finished?

If so, I will merge this one first and then the header one.

Cheers,

On 25 November 2014 at 10:09, Sagar Ghuge <email address hidden> wrote:

> Sagar Ghuge has proposed merging lp:~ghugesss/xpad/debug_support into
> lp:xpad.
>
> Requested reviews:
> Arthur Borsboom (arthurborsboom)
> Related bugs:
> Bug #1389334 in Xpad: "Allowing Debug option in Xpad"
> https://bugs.launchpad.net/xpad/+bug/1389334
>
> For more details, see:
> https://code.launchpad.net/~ghugesss/xpad/debug_support/+merge/242746
> --
> You are requested to review the proposed merge of
> lp:~ghugesss/xpad/debug_support into lp:xpad.
>
> === modified file 'src/Makefile.am'
> --- src/Makefile.am 2014-10-02 22:14:44 +0000
> +++ src/Makefile.am 2014-11-25 09:08:40 +0000
> @@ -17,7 +17,8 @@
> xpad-text-view.c xpad-text-view.h \
> xpad-toolbar.c xpad-toolbar.h \
> xpad-tray.c xpad-tray.h \
> - xpad-undo.c xpad-undo.h
> + xpad-undo.c xpad-undo.h \
> + xpad-debug.c xpad-debug.h
>
> AM_CFLAGS = @GTK_CFLAGS@ @X_CFLAGS@ @DEBUG_CFLAGS@
> @GTK_SOURCE_VIEW_CFLAGS@ -DDATADIR=\"$(datadir)\"
> xpad_LDADD = @X_PRE_LIBS@ @X_LIBS@ @X_EXTRA_LIBS@ @GTK_LIBS@ @INTLLIBS@
> @BINRELOC_LIBS@ @GTK_SOURCE_VIEW_LIBS@
>
> === modified file 'src/xpad-app.c'
> --- src/xpad-app.c 2014-11-22 12:14:17 +0000
> +++ src/xpad-app.c 2014-11-25 09:08:40 +0000
> @@ -40,6 +40,7 @@
> #include "xpad-periodic.h"
> #include "xpad-session-manager.h"
> #include "xpad-tray.h"
> +#include "xpad-debug.h"
>
> /* Seems that some systems (sun-sparc-solaris2.8 at least), need the
> following three #defines.
> These were provided by Alan Mizrahi <email address hidden>.
> @@ -94,6 +95,9 @@
> gboolean first_time;
> gboolean have_gtk;
>
> + xpad_debug_init();
> + xpad_debug_message (DEBUG_APP, "Startup");
> +
> /* Set up support different languages */
> #ifdef ENABLE_NLS
> bindtextdomain (GETTEXT_PACKAGE, LOCALE_DIR);
>
> === added file 'src/xpad-debug.c'
> --- src/xpad-debug.c 1970-01-01 00:00:00 +0000
> +++ src/xpad-debug.c 2014-11-25 09:08:40 +0000
> @@ -0,0 +1,171 @@
> +/*
> + * xpad-debug.c
> + * This file is part of xpad
> + *
> + * Copyright (C) 2014 - 2015 Sagar Ghuge
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, see <http://www.gnu.org/licenses/>.
> + */
> +
> +#ifdef HAVE_CONFIG_H
> +#i...

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2014-10-02 22:14:44 +0000
+++ src/Makefile.am	2014-11-25 09:08:40 +0000
@@ -17,7 +17,8 @@
 	xpad-text-view.c xpad-text-view.h \
 	xpad-toolbar.c xpad-toolbar.h \
 	xpad-tray.c xpad-tray.h \
-	xpad-undo.c xpad-undo.h
+	xpad-undo.c xpad-undo.h \
+	xpad-debug.c xpad-debug.h
 
 AM_CFLAGS = @GTK_CFLAGS@ @X_CFLAGS@ @DEBUG_CFLAGS@ @GTK_SOURCE_VIEW_CFLAGS@ -DDATADIR=\"$(datadir)\"
 xpad_LDADD = @X_PRE_LIBS@ @X_LIBS@ @X_EXTRA_LIBS@ @GTK_LIBS@ @INTLLIBS@ @BINRELOC_LIBS@ @GTK_SOURCE_VIEW_LIBS@

=== modified file 'src/xpad-app.c'
--- src/xpad-app.c	2014-11-22 12:14:17 +0000
+++ src/xpad-app.c	2014-11-25 09:08:40 +0000
@@ -40,6 +40,7 @@
 #include "xpad-periodic.h"
 #include "xpad-session-manager.h"
 #include "xpad-tray.h"
+#include "xpad-debug.h"
 
 /* Seems that some systems (sun-sparc-solaris2.8 at least), need the following three #defines. 
    These were provided by Alan Mizrahi <[e-mail]>.
@@ -94,6 +95,9 @@
 	gboolean first_time;
 	gboolean have_gtk;
 
+	xpad_debug_init();
+	xpad_debug_message (DEBUG_APP, "Startup");
+
 	/* Set up support different languages */
 #ifdef ENABLE_NLS
 	bindtextdomain (GETTEXT_PACKAGE, LOCALE_DIR);

=== added file 'src/xpad-debug.c'
--- src/xpad-debug.c	1970-01-01 00:00:00 +0000
+++ src/xpad-debug.c	2014-11-25 09:08:40 +0000
@@ -0,0 +1,171 @@
+/*
+ * xpad-debug.c
+ * This file is part of xpad
+ *
+ * Copyright (C) 2014 - 2015 Sagar Ghuge
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <stdio.h>
+#include "xpad-debug.h"
+
+#define ENABLE_PROFILING
+
+#ifdef ENABLE_PROFILING
+static GTimer *timer = NULL;
+static gdouble last = 0.0;
+#endif
+
+static XpadDebugSection debug = XPAD_NO_DEBUG;
+
+#define DEBUG_IS_ENABLED(section_rval) (debug & (section_rval))
+
+/**
+ * xpad_debug_init:
+ *
+ * Initializes the debugging subsystem of Xpad.
+ *
+ * The function checks for the existence of certain environment variables to
+ * determine whether to enable output for a debug section. To enable output
+ * for a specific debug section, set an environment variable of the same name;
+ * e.g. to enable output for the %XPAD_DEBUG_APP section, set a
+ * <code>XPAD_DEBUG_APP</code> environment variable. To enable output
+ * for all debug sections, set the <code>XPAD_DEBUG</code> environment
+ * variable.
+ *
+ * This function must be called before any of the other debug functions are
+ * called. It must only be called once.
+ */
+void
+xpad_debug_init (void)
+{
+	if (g_getenv ("XPAD_DEBUG") != NULL)
+	{
+		/* enable all debugging */
+		debug = ~XPAD_NO_DEBUG;
+		goto out;
+	}
+
+	if (g_getenv ("XPAD_DEBUG_VIEW") != NULL)
+		debug = debug | XPAD_DEBUG_VIEW;
+	if (g_getenv ("XPAD_DEBUG_SEARCH") != NULL)
+		debug = debug | XPAD_DEBUG_SEARCH;
+	if (g_getenv ("XPAD_DEBUG_PREFS") != NULL)
+		debug = debug | XPAD_DEBUG_PREFS;
+	if (g_getenv ("XPAD_DEBUG_PAD") != NULL)
+		debug = debug | XPAD_DEBUG_PAD;
+	if (g_getenv ("XPAD_DEBUG_APP") != NULL)
+		debug = debug | XPAD_DEBUG_APP;
+	if (g_getenv ("XPAD_DEBUG_WINDOW") != NULL)
+		debug = debug | XPAD_DEBUG_WINDOW;
+out:
+
+#ifdef ENABLE_PROFILING
+	if (debug != XPAD_NO_DEBUG)
+		timer = g_timer_new ();
+#endif
+	return;
+}
+
+/**
+ * xpad_debug:
+ * @section: Debug section.
+ * @file: Name of the source file containing the call to xpad_debug().
+ * @line: Line number within the file named by @file of the call to xpad_debug().
+ * @function: Name of the function that is calling xpad_debug().
+ *
+ * If output for debug section @section is enabled, then logs the trace
+ * information @file, @line, and @function.
+ */
+void xpad_debug (XpadDebugSection  section,
+		  const gchar       *file,
+		  gint               line,
+		  const gchar       *function)
+{
+	if (G_UNLIKELY (DEBUG_IS_ENABLED (section)))
+	{
+#ifdef ENABLE_PROFILING
+		gdouble seconds;
+
+		g_return_if_fail (timer != NULL);
+
+		seconds = g_timer_elapsed (timer, NULL);
+		g_print ("[%f (%f)] %s:%d (%s)\n",
+			 seconds, seconds - last, file, line, function);
+		last = seconds;
+#else
+		g_print ("%s:%d (%s)\n", file, line, function);
+#endif
+
+		fflush (stdout);
+	}
+}
+
+/**
+ * xpad_debug_message:
+ * @section: Debug section.
+ * @file: Name of the source file containing the call to xpad_debug_message().
+ * @line: Line number within the file named by @file of the call to xpad_debug_message().
+ * @function: Name of the function that is calling xpad_debug_message().
+ * @format: A g_vprintf() format string.
+ * @...: The format string arguments.
+ *
+ * If output for debug section @section is enabled, then logs the trace
+ * information @file, @line, and @function along with the message obtained by
+ * formatting @format with the given format string arguments.
+ */
+void
+xpad_debug_message (XpadDebugSection  section,
+		     const gchar       *file,
+		     gint               line,
+		     const gchar       *function,
+		     const gchar       *format, ...)
+{
+	if (G_UNLIKELY (DEBUG_IS_ENABLED (section)))
+	{
+		va_list args;
+		gchar *msg;
+
+#ifdef ENABLE_PROFILING
+		gdouble seconds;
+
+		g_return_if_fail (timer != NULL);
+
+		seconds = g_timer_elapsed (timer, NULL);
+#endif
+
+		g_return_if_fail (format != NULL);
+
+		va_start (args, format);
+		msg = g_strdup_vprintf (format, args);
+		va_end (args);
+
+#ifdef ENABLE_PROFILING
+		g_print ("[%f (%f)] %s:%d (%s) %s\n",
+			 seconds, seconds - last, file, line, function, msg);
+		last = seconds;
+#else
+		g_print ("%s:%d (%s) %s\n", file, line, function, msg);
+#endif
+
+		fflush (stdout);
+
+		g_free (msg);
+	}
+}

=== added file 'src/xpad-debug.h'
--- src/xpad-debug.h	1970-01-01 00:00:00 +0000
+++ src/xpad-debug.h	2014-11-25 09:08:40 +0000
@@ -0,0 +1,67 @@
+/*
+ * xpad-debug.h
+ * This file is part of xpad
+ *
+ * Copyright (C) 2014 - 2015 Sagar Ghuge
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __XPAD_DEBUG_H__
+#define __XPAD_DEBUG_H__
+
+#include <glib.h>
+
+/**
+ * XpadDebugSection:
+ *
+ * Enumeration of debug sections.
+ *
+ * Debugging output for a section is enabled by setting an environment variable
+ * of the same name. For example, setting the <code>XPAD_DEBUG_APP</code>
+ * environment variable enables all debugging output for the %XPAD_DEBUG_APP
+ * section. Setting the special environment variable <code>XPAD_DEBUG</code>
+ * enables output for all sections.
+ */
+typedef enum {
+	XPAD_NO_DEBUG       = 0,
+	XPAD_DEBUG_VIEW     = 1 << 0,
+	XPAD_DEBUG_SEARCH   = 1 << 1,
+	XPAD_DEBUG_PREFS    = 1 << 2,
+	XPAD_DEBUG_PAD      = 1 << 3,
+	XPAD_DEBUG_APP      = 1 << 4,
+	XPAD_DEBUG_WINDOW   = 1 << 5,
+} XpadDebugSection;
+
+#define	DEBUG_VIEW	XPAD_DEBUG_VIEW,    __FILE__, __LINE__, G_STRFUNC
+#define	DEBUG_SEARCH	XPAD_DEBUG_SEARCH,  __FILE__, __LINE__, G_STRFUNC
+#define	DEBUG_PREFS	XPAD_DEBUG_PREFS,   __FILE__, __LINE__, G_STRFUNC
+#define	DEBUG_PAD	XPAD_DEBUG_PAD,     __FILE__, __LINE__, G_STRFUNC
+#define	DEBUG_APP	XPAD_DEBUG_APP,     __FILE__, __LINE__, G_STRFUNC
+#define	DEBUG_WINDOW	XPAD_DEBUG_WINDOW,  __FILE__, __LINE__, G_STRFUNC
+
+void xpad_debug_init (void);
+
+void xpad_debug (XpadDebugSection  section,
+		  const gchar       *file,
+		  gint               line,
+		  const gchar       *function);
+
+void xpad_debug_message (XpadDebugSection  section,
+			  const gchar       *file,
+			  gint               line,
+			  const gchar       *function,
+			  const gchar       *format, ...) G_GNUC_PRINTF(5, 6);
+
+#endif /* __XPAD_DEBUG_H__ */