[Bf-blender-cvs] [c1adf938e6c] blender2.8: Timer: Generic BLI_timer with Python wrapper
Jacques Lucke
noreply at git.blender.org
Mon Nov 26 20:31:14 CET 2018
Commit: c1adf938e6c8ecaec805f4cf95c73480de1bf980
Author: Jacques Lucke
Date: Mon Nov 26 20:25:15 2018 +0100
Branches: blender2.8
https://developer.blender.org/rBc1adf938e6c8ecaec805f4cf95c73480de1bf980
Timer: Generic BLI_timer with Python wrapper
There is a new `bpy.app.timers` api.
For more details, look in the Python API documentation.
Reviewers: campbellbarton
Differential Revision: https://developer.blender.org/D3994
===================================================================
M doc/python_api/sphinx_doc_gen.py
A source/blender/blenlib/BLI_timer.h
M source/blender/blenlib/CMakeLists.txt
A source/blender/blenlib/intern/BLI_timer.c
M source/blender/python/intern/CMakeLists.txt
M source/blender/python/intern/bpy_app.c
A source/blender/python/intern/bpy_app_timers.c
A source/blender/python/intern/bpy_app_timers.h
M source/blender/windowmanager/intern/wm_event_system.c
M source/blender/windowmanager/intern/wm_init_exit.c
===================================================================
diff --git a/doc/python_api/sphinx_doc_gen.py b/doc/python_api/sphinx_doc_gen.py
index 299eebfe295..ac96ddd8635 100644
--- a/doc/python_api/sphinx_doc_gen.py
+++ b/doc/python_api/sphinx_doc_gen.py
@@ -1842,6 +1842,7 @@ def write_rst_importable_modules(basepath):
"bpy.app.handlers": "Application Handlers",
"bpy.app.translations": "Application Translations",
"bpy.app.icons": "Application Icons",
+ "bpy.app.timers": "Application Timers",
"bpy.props": "Property Definitions",
"idprop.types": "ID Property Access",
"mathutils": "Math Types & Utilities",
diff --git a/source/blender/blenlib/BLI_timer.h b/source/blender/blenlib/BLI_timer.h
new file mode 100644
index 00000000000..6dfb13fd738
--- /dev/null
+++ b/source/blender/blenlib/BLI_timer.h
@@ -0,0 +1,58 @@
+/*
+ * ***** 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.
+ *
+ * The Original Code is Copyright (C) 2008 Blender Foundation.
+ * All rights reserved.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+#ifndef __BLI_TIMER_H__
+#define __BLI_TIMER_H__
+
+#include "BLI_utildefines.h"
+
+/** \file BLI_timer.h
+ * \ingroup BLI
+ */
+
+/* ret < 0: the timer will be removed.
+ * ret >= 0: the timer will be called again in ret seconds */
+typedef double (*BLI_timer_func)(uintptr_t uuid, void *user_data);
+typedef void (*BLI_timer_data_free)(uintptr_t uuid, void *user_data);
+
+/* `func(...) < 0`: The timer will be removed.
+ * `func(...) >= 0`: The function will be called again in that many seconds. */
+void BLI_timer_register(
+ uintptr_t uuid,
+ BLI_timer_func func,
+ void *user_data,
+ BLI_timer_data_free user_data_free,
+ double first_interval,
+ bool persistent);
+
+bool BLI_timer_is_registered(uintptr_t uuid);
+
+/* Returns False when the timer does not exist (anymore). */
+bool BLI_timer_unregister(uintptr_t uuid);
+
+/* Execute all registered functions that are due. */
+void BLI_timer_execute(void);
+
+void BLI_timer_free(void);
+
+#endif /* __BLI_TIMER_H__ */
diff --git a/source/blender/blenlib/CMakeLists.txt b/source/blender/blenlib/CMakeLists.txt
index 5e6764a5c0e..91887c1ef5e 100644
--- a/source/blender/blenlib/CMakeLists.txt
+++ b/source/blender/blenlib/CMakeLists.txt
@@ -55,6 +55,7 @@ set(SRC
intern/BLI_memarena.c
intern/BLI_memiter.c
intern/BLI_mempool.c
+ intern/BLI_timer.c
intern/DLRB_tree.c
intern/array_store.c
intern/array_store_utils.c
@@ -214,6 +215,7 @@ set(SRC
BLI_task.h
BLI_threads.h
BLI_timecode.h
+ BLI_timer.h
BLI_utildefines.h
BLI_utildefines_iter.h
BLI_utildefines_stack.h
diff --git a/source/blender/blenlib/intern/BLI_timer.c b/source/blender/blenlib/intern/BLI_timer.c
new file mode 100644
index 00000000000..875b667de46
--- /dev/null
+++ b/source/blender/blenlib/intern/BLI_timer.c
@@ -0,0 +1,186 @@
+/*
+ * ***** 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.
+ *
+ * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
+ * All rights reserved.
+ *
+ * The Original Code is: all of this file, with exception of below:
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/blenlib/intern/BLI_timer.c
+ * \ingroup bli
+ */
+
+#include "BLI_timer.h"
+#include "BLI_listbase.h"
+#include "BLI_callbacks.h"
+
+#include "MEM_guardedalloc.h"
+#include "PIL_time.h"
+
+#define GET_TIME() PIL_check_seconds_timer()
+
+typedef struct TimedFunction {
+ struct TimedFunction *next, *prev;
+ BLI_timer_func func;
+ BLI_timer_data_free user_data_free;
+ void *user_data;
+ double next_time;
+ uintptr_t uuid;
+ bool tag_removal;
+ bool persistent;
+} TimedFunction;
+
+typedef struct TimerContainer {
+ ListBase funcs;
+ bool file_load_cb_registered;
+} TimerContainer;
+
+static TimerContainer GlobalTimer = { 0 };
+
+static void ensure_callback_is_registered(void);
+
+void BLI_timer_register(
+ uintptr_t uuid,
+ BLI_timer_func func,
+ void *user_data,
+ BLI_timer_data_free user_data_free,
+ double first_interval,
+ bool persistent)
+{
+ ensure_callback_is_registered();
+
+ TimedFunction *timed_func = MEM_callocN(sizeof(TimedFunction), __func__);
+ timed_func->func = func;
+ timed_func->user_data_free = user_data_free;
+ timed_func->user_data = user_data;
+ timed_func->next_time = GET_TIME() + first_interval;
+ timed_func->tag_removal = false;
+ timed_func->persistent = persistent;
+ timed_func->uuid = uuid;
+
+ BLI_addtail(&GlobalTimer.funcs, timed_func);
+}
+
+static void clear_user_data(TimedFunction *timed_func)
+{
+ if (timed_func->user_data_free) {
+ timed_func->user_data_free(timed_func->uuid, timed_func->user_data);
+ timed_func->user_data_free = NULL;
+ }
+}
+
+bool BLI_timer_unregister(uintptr_t uuid)
+{
+ LISTBASE_FOREACH(TimedFunction *, timed_func, &GlobalTimer.funcs) {
+ if (timed_func->uuid == uuid) {
+ if (timed_func->tag_removal) {
+ return false;
+ }
+ else {
+ timed_func->tag_removal = true;
+ clear_user_data(timed_func);
+ return true;
+ }
+ }
+ }
+ return false;
+}
+
+bool BLI_timer_is_registered(uintptr_t uuid)
+{
+ LISTBASE_FOREACH(TimedFunction *, timed_func, &GlobalTimer.funcs) {
+ if (timed_func->uuid == uuid && !timed_func->tag_removal) {
+ return true;
+ }
+ }
+ return false;
+}
+
+static void execute_functions_if_necessary(void)
+{
+ double current_time = GET_TIME();
+
+ LISTBASE_FOREACH(TimedFunction *, timed_func, &GlobalTimer.funcs) {
+ if (timed_func->tag_removal) continue;
+ if (timed_func->next_time > current_time) continue;
+
+ double ret = timed_func->func(timed_func->uuid, timed_func->user_data);
+
+ if (ret < 0) {
+ timed_func->tag_removal = true;
+ }
+ else {
+ timed_func->next_time = current_time + ret;
+ }
+ }
+}
+
+static void remove_tagged_functions(void)
+{
+ for (TimedFunction *timed_func = GlobalTimer.funcs.first; timed_func; ) {
+ TimedFunction *next = timed_func->next;
+ if (timed_func->tag_removal) {
+ clear_user_data(timed_func);
+ BLI_freelinkN(&GlobalTimer.funcs, timed_func);
+ }
+ timed_func = next;
+ }
+}
+
+void BLI_timer_execute()
+{
+ execute_functions_if_necessary();
+ remove_tagged_functions();
+}
+
+void BLI_timer_free()
+{
+ LISTBASE_FOREACH(TimedFunction *, timed_func, &GlobalTimer.funcs) {
+ timed_func->tag_removal = true;
+ }
+
+ remove_tagged_functions();
+}
+
+struct Main;
+struct ID;
+static void remove_non_persistent_functions(struct Main *UNUSED(_1), struct ID *UNUSED(_2), void *UNUSED(_3))
+{
+ LISTBASE_FOREACH(TimedFunction *, timed_func, &GlobalTimer.funcs) {
+ if (!timed_func->persistent) {
+ timed_func->tag_removal = true;
+ }
+ }
+}
+
+static bCallbackFuncStore load_post_callback = {
+ NULL, NULL, /* next, prev */
+ remove_non_persistent_functions, /* func */
+ NULL, /* arg */
+ 0 /* alloc */
+};
+
+static void ensure_callback_is_registered()
+{
+ if (!GlobalTimer.file_load_cb_registered) {
+ BLI_callback_add(&load_post_callback, BLI_CB_EVT_LOAD_POST);
+ GlobalTimer.file_load_cb_registered = true;
+ }
+}
diff --git a/source/blender/python/intern/CMakeLists.txt b/source/blender/python/intern/CMakeLists.txt
index b561504505b..bd7306cddf2 100644
--- a/source/blender/python/intern/CMakeLists.txt
+++ b/source/blender/python/intern/CMakeLists.txt
@@ -58,6 +58,7 @@ set(SRC
bpy_app_opensubdiv.c
bpy_app_openvdb.c
bpy_app_sdl.c
+ bpy_app_timers.c
bpy_app_translations.c
bpy_capi_utils.c
bpy_driver.c
@@ -96,6 +97,7 @@ set(SRC
bpy_app_opensubdiv.h
bpy_app_openvdb.h
bpy_app_sdl.h
+ bpy_app_timers.h
bpy_app_translations.h
bpy_capi_utils.h
bpy_driver.h
diff --git a/source/blender/python/intern/bpy_app.c b/source/blender/python/intern/bpy_app.c
index d8c74bdf565..bba9eee0316 100644
--- a/source/blender/python/intern/bpy_app.c
+++ b/source/blender/python/intern/bpy_app.c
@@ -49,6 +49,7 @@
/* modules */
#include "bpy_app_icons.h"
+#include "bpy_app_timers.h"
#include "BLI_utildefines.h"
@@ -124,6 +125,7 @@ static PyStructSequence_Field app_info_fields[] = {
/* Modules (not struct sequence). */
{(char *)"icons", (char *)"Manage custom icons"},
+ {(char *)"timers", (char *)"Manage timers"},
{NULL},
};
@@ -137,6 +139,7 @@ PyDoc_STRVAR(bpy_app_doc,
"\n"
" bpy.app.handlers.rst\n"
" bpy.app.icons.rst\n"
+" bpy.app.timers.rst\n"
" bpy.app.translations.rst\n"
);
@@ -220,6 +223,7 @@ static PyObject *make_app_info(void)
/* modules */
SetObjItem(BPY_app_icons_module());
+ SetObjItem(BPY_app_timers_module());
#undef SetIntItem
#undef SetStrItem
diff --git a/source/blender/python/intern/bpy_app_timers.c b/source/blender/python/intern/bpy_app_timers.c
new file mode 100644
index 00000000000..cd0e57200ec
--- /dev/null
+++ b/source/blender/python/intern/bpy_app_timers.c
@@ -0,0 +1,199 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * This
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list