Add test for redisplays posted in the event loop

2 files changed, 134 insertions, 1 deletions

diff --git a/test/test_redisplay.c b/test/test_redisplay.c
new file mode 100644
index 0000000..f5f0707
--- /dev/null
+++ b/test/test_redisplay.c
@@ -0,0 +1,133 @@
+/*
+  Copyright 2020 David Robillard <http://drobilla.net>
+
+  Permission to use, copy, modify, and/or distribute this software for any
+  purpose with or without fee is hereby granted, provided that the above
+  copyright notice and this permission notice appear in all copies.
+
+  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+
+/*
+  Tests that redisplays posted in the event handler are dispatched at the end
+  of the same event loop iteration.
+*/
+
+#undef NDEBUG
+
+#include "test_utils.h"
+
+#include "pugl/pugl.h"
+#include "pugl/pugl_stub.h"
+
+#include <assert.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+
+typedef enum {
+	START,
+	EXPOSED,
+	SHOULD_REDISPLAY,
+	POSTED_REDISPLAY,
+	REDISPLAYED,
+} State;
+
+typedef struct
+{
+	PuglTestOptions opts;
+	PuglWorld*      world;
+	PuglView*       view;
+	State           state;
+} PuglTest;
+
+static const PuglRect  redisplayRect   = {1, 2, 3, 4};
+static const uintptr_t postRedisplayId = 42;
+
+static PuglStatus
+onEvent(PuglView* view, const PuglEvent* event)
+{
+	PuglTest* test = (PuglTest*)puglGetHandle(view);
+
+	if (test->opts.verbose) {
+		printEvent(event, "Event: ", true);
+	}
+
+	switch (event->type) {
+	case PUGL_EXPOSE:
+		if (test->state == START) {
+			test->state = EXPOSED;
+		} else if (test->state == POSTED_REDISPLAY &&
+		           event->expose.x == redisplayRect.x &&
+		           event->expose.y == redisplayRect.y &&
+		           event->expose.width == redisplayRect.width &&
+		           event->expose.height == redisplayRect.height) {
+			test->state = REDISPLAYED;
+		}
+		break;
+
+	case PUGL_CLIENT:
+		if (event->client.data1 == postRedisplayId) {
+			puglPostRedisplayRect(view, redisplayRect);
+			test->state = POSTED_REDISPLAY;
+		}
+		break;
+
+	default: break;
+	}
+
+	return PUGL_SUCCESS;
+}
+
+static void
+tick(PuglWorld* world)
+{
+	assert(!puglPollEvents(world, -1));
+	assert(!puglDispatchEvents(world));
+}
+
+int
+main(int argc, char** argv)
+{
+	PuglTest app = {puglParseTestOptions(&argc, &argv),
+	                puglNewWorld(),
+	                NULL,
+	                START};
+
+	// Set up view
+	app.view = puglNewView(app.world);
+	puglSetClassName(app.world, "Pugl Test");
+	puglSetBackend(app.view, puglStubBackend());
+	puglSetHandle(app.view, &app);
+	puglSetEventFunc(app.view, onEvent);
+
+	// Create and show window
+	assert(!puglCreateWindow(app.view, "Pugl Test"));
+	assert(!puglShowWindow(app.view));
+	while (app.state != EXPOSED) {
+		tick(app.world);
+	}
+
+	// Send a custom event to trigger a redisplay in the event loop
+	const PuglEventClient client = { PUGL_CLIENT, 0, postRedisplayId, 0 };
+	assert(!puglSendEvent(app.view, (const PuglEvent*)&client));
+
+	// Loop until an expose happens in the same iteration as the redisplay
+	app.state = SHOULD_REDISPLAY;
+	while (app.state != REDISPLAYED) {
+		tick(app.world);
+		assert(app.state != POSTED_REDISPLAY);
+	}
+
+	// Tear down
+	puglFreeView(app.view);
+	puglFreeWorld(app.world);
+
+	return 0;
+}
diff --git a/wscript b/wscript
index 109ae3e..510b260 100644
--- a/wscript
+++ b/wscript
@@ -177,7 +177,7 @@ def _build_pc_file(bld, name, desc, target, libname, deps={}, requires=[]):
         LIBS=' '.join(link_flags))
 
 
-tests = ['show_hide']
+tests = ['redisplay', 'show_hide']
 
 
 def build(bld):