own patch [#27752] Python Callback (Scriptlink functionality)

Python:
 * adds bpy.app.handlers which contains lists, each for an event type:
   render_pre, render_post, load_pre, load_post, save_pre, save_post
 * each list item needs to be a callable object which takes 1 argument (the ID).
 * callbacks are cleared on file load.

Example:
 def MyFunc(scene): print("Callback:", data)
 bpy.app.handlers.render_post.append(MyFunc)

C:
 * This patch adds a generic C callback api which is currently only used by python.
 * Unlike python callbacks these are not cleared on file load.

3 files changed, 104 insertions, 5 deletions

diff --git a/source/blender/blenlib/BLI_callbacks.h b/source/blender/blenlib/BLI_callbacks.h
index 9f6ac0c391f..89e4230825d 100644
--- a/source/blender/blenlib/BLI_callbacks.h
+++ b/source/blender/blenlib/BLI_callbacks.h
@@ -1,8 +1,6 @@
 /*
  * $Id:
  *
- * These callbacks are needed in the lib
- *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
@@ -29,7 +27,7 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file blender/blenlib/intern/BLI_callbacks.h
+/** \file blender/blenlib/BLI_callbacks.h
  *  \ingroup bli
  */
 
@@ -37,8 +35,38 @@
 #ifndef BLI_CALLBACKS_H
 #define BLI_CALLBACKS_H
 
-// This is blenlib internal only
-void callLocalErrorCallBack(const char* msg);
+struct bContext;
+struct Main;
+struct ID;
+
+typedef enum {
+	BLI_CB_EVT_RENDER_PRE,
+	BLI_CB_EVT_RENDER_POST,
+	BLI_CB_EVT_LOAD_PRE,
+	BLI_CB_EVT_LOAD_POST,
+	BLI_CB_EVT_SAVE_PRE,
+	BLI_CB_EVT_SAVE_POST,
+	BLI_CB_EVT_TOT
+} eCbEvent;
+
+
+typedef struct {
+	struct bCallbackFuncStore *next, *prev;
+	void (* func)(struct Main *, struct ID *, void *arg);
+	void *arg;
+	short alloc;
+} bCallbackFuncStore;
+
+
+void BLI_exec_cb(struct Main *main, struct ID *self, eCbEvent evt);
+void BLI_add_cb(bCallbackFuncStore *funcstore, eCbEvent evt);
 
 #endif
 
+
+void BLI_cb_init(void);
+void BLI_cb_finalize(void);
+
+
+/* This is blenlib internal only, unrelated to above */
+void callLocalErrorCallBack(const char* msg);
diff --git a/source/blender/blenlib/CMakeLists.txt b/source/blender/blenlib/CMakeLists.txt
index 8964d02199f..2e05ac7892b 100644
--- a/source/blender/blenlib/CMakeLists.txt
+++ b/source/blender/blenlib/CMakeLists.txt
@@ -52,6 +52,7 @@ set(SRC
 	intern/DLRB_tree.c
 	intern/boxpack2d.c
 	intern/bpath.c
+	intern/callbacks.c
 	intern/cpu.c
 	intern/dynlib.c
 	intern/edgehash.c
diff --git a/source/blender/blenlib/intern/callbacks.c b/source/blender/blenlib/intern/callbacks.c
new file mode 100644
index 00000000000..0c778dcd3fa
--- /dev/null
+++ b/source/blender/blenlib/intern/callbacks.c
@@ -0,0 +1,70 @@
+/*
+ * $Id:
+ *
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * 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, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * Contributor(s): Blender Foundation (2011)
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+#include "BLI_utildefines.h"
+#include "BLI_listbase.h"
+#include "BLI_callbacks.h"
+
+#include "MEM_guardedalloc.h"
+
+static ListBase callback_slots[BLI_CB_EVT_TOT]= {{0}};
+
+void BLI_exec_cb(struct Main *main, struct ID *self, eCbEvent evt)
+{
+	ListBase *lb= &callback_slots[evt];
+	bCallbackFuncStore *funcstore;
+
+	for(funcstore= (bCallbackFuncStore *)lb->first; funcstore; funcstore= (bCallbackFuncStore *)funcstore->next) {
+		funcstore->func(main, self, funcstore->arg);
+	}
+}
+
+void BLI_add_cb(bCallbackFuncStore *funcstore, eCbEvent evt)
+{
+	ListBase *lb= &callback_slots[evt];
+	BLI_addtail(lb, funcstore);
+}
+
+void BLI_cb_init(void)
+{
+	/* do nothing */
+}
+
+/* call on application exit */
+void BLI_cb_finalize(void)
+{
+	eCbEvent evt;
+	for(evt= 0; evt < BLI_CB_EVT_TOT; evt++) {
+		ListBase *lb= &callback_slots[evt];
+		bCallbackFuncStore *funcstore;
+		bCallbackFuncStore *funcstore_next;
+		for(funcstore= (bCallbackFuncStore *)lb->first; funcstore; funcstore= funcstore_next) {
+			funcstore_next= (bCallbackFuncStore *)funcstore->next;
+			BLI_remlink(lb, funcstore);
+			if(funcstore->alloc) {
+				MEM_freeN(funcstore);
+			}
+		}
+	}
+}