From 6accd9a09abd3c708e582413c6b0d19d8883fc93 Mon Sep 17 00:00:00 2001
From: Christian Stimming <stimming@tuhh.de>
Date: Fri, 17 Dec 2010 21:31:11 +0000
Subject: [PATCH] Add debug helper function qofeventid_to_string.

git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@19957 57a11ea4-9604-0410-9ed3-97b8803252fd
---
 src/engine/CMakeLists.txt |  1 +
 src/engine/Makefile.am    |  1 +
 src/engine/gnc-event.c    | 31 +++++++++++++++++++++++++++++++
 src/engine/gnc-event.h    | 14 +++++++++++++-
 4 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 src/engine/gnc-event.c

diff --git a/src/engine/CMakeLists.txt b/src/engine/CMakeLists.txt
index 4a673c1614..30efd15567 100644
--- a/src/engine/CMakeLists.txt
+++ b/src/engine/CMakeLists.txt
@@ -120,6 +120,7 @@ SET (libgncmod_engine_SOURCES
   gnc-budget.c
   gnc-commodity.c
   gnc-engine.c
+  gnc-event.c
   gnc-hooks.c
   gnc-lot.c
   gnc-pricedb.c
diff --git a/src/engine/Makefile.am b/src/engine/Makefile.am
index 45a08759a7..e3608daa59 100644
--- a/src/engine/Makefile.am
+++ b/src/engine/Makefile.am
@@ -32,6 +32,7 @@ libgncmod_engine_la_SOURCES = \
   gnc-budget.c \
   gnc-commodity.c \
   gnc-engine.c \
+  gnc-event.c \
   gnc-hooks.c \
   gnc-lot.c \
   gnc-pricedb.c \
diff --git a/src/engine/gnc-event.c b/src/engine/gnc-event.c
new file mode 100644
index 0000000000..a2313dbd70
--- /dev/null
+++ b/src/engine/gnc-event.c
@@ -0,0 +1,31 @@
+#include "config.h"
+#include "gnc-event.h"
+
+const char* qofeventid_to_string(QofEventId id)
+{
+    switch (id)
+    {
+    case 0:
+        return "NONE";
+    case QOF_EVENT_CREATE:
+        return "CREATE";
+    case QOF_EVENT_MODIFY:
+        return "MODIFY";
+    case QOF_EVENT_DESTROY:
+        return "DESTROY";
+    case QOF_EVENT_ADD:
+        return "ADD";
+    case QOF_EVENT_REMOVE:
+        return "REMOVE";
+
+    case GNC_EVENT_ITEM_ADDED:
+        return "ITEM_ADDED";
+    case GNC_EVENT_ITEM_REMOVED:
+        return "ITEM_REMOVED";
+    case GNC_EVENT_ITEM_CHANGED:
+        return "ITEM_CHANGED";
+
+    default:
+        return "<unknown, maybe multiple>";
+    }
+}
diff --git a/src/engine/gnc-event.h b/src/engine/gnc-event.h
index 188e2db762..1c0fdf6a71 100644
--- a/src/engine/gnc-event.h
+++ b/src/engine/gnc-event.h
@@ -20,6 +20,13 @@
  *                                                                  *
  ********************************************************************/
 
+/** @addtogroup Event
+@{
+*/
+/** @file
+    @brief Additional event handling code
+*/
+
 #ifndef GNC_EVENT_H
 #define GNC_EVENT_H
 
@@ -32,11 +39,16 @@ typedef struct
     gint idx;
 } GncEventData;
 
-/* These events are used when a split is added to an account.
+/** These events are used when a split is added to an account.
  * The event subject is the Account, the Object is the Split.
  */
 #define GNC_EVENT_ITEM_ADDED	QOF_MAKE_EVENT(QOF_EVENT_BASE+0)
 #define GNC_EVENT_ITEM_REMOVED	QOF_MAKE_EVENT(QOF_EVENT_BASE+1)
 #define GNC_EVENT_ITEM_CHANGED	QOF_MAKE_EVENT(QOF_EVENT_BASE+2)
 
+/** Convert the given QofEventId (an integer number) to a string that
+ * is usable in debugging output. */
+const char* qofeventid_to_string(QofEventId id);
+
 #endif
+/** @} */