aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/test/test_timer.c
blob: 200ddc27eb1ea08eceefd2bd4a1ce20545494b10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/*
  Copyright 2020 David Robillard <d@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 update events are received and than redisplays they trigger happen
  immediately in the same event loop iteration.
*/

#undef NDEBUG

#include "test_utils.h"

#include "pugl/pugl.h"
#include "pugl/stub.h"

#include <assert.h>
#include <math.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>

#ifdef __APPLE__
static const double timeout = 1 / 60.0;
#else
static const double timeout = -1.0;
#endif

#ifdef _WIN32
// Windows SetTimer has a maximum resolution of 10ms
static const double tolerance = 0.012;
#else
static const double tolerance = 0.002;
#endif

static const uintptr_t timerId     = 1u;
static const double    timerPeriod = 1 / 60.0;

typedef enum {
  START,
  EXPOSED,
} State;

typedef struct {
  PuglWorld*      world;
  PuglView*       view;
  PuglTestOptions opts;
  size_t          numAlarms;
  State           state;
} PuglTest;

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:
    test->state = EXPOSED;
    break;

  case PUGL_TIMER:
    assert(event->timer.id == timerId);
    ++test->numAlarms;
    break;

  default:
    break;
  }

  return PUGL_SUCCESS;
}

static double
roundPeriod(const double period)
{
  return floor(period * 1000.0) / 1000.0; // Round down to milliseconds
}

int
main(int argc, char** argv)
{
  PuglTest app = {puglNewWorld(PUGL_PROGRAM, 0),
                  NULL,
                  puglParseTestOptions(&argc, &argv),
                  0,
                  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);
  puglSetDefaultSize(app.view, 512, 512);

  // Create and show window
  assert(!puglRealize(app.view));
  assert(!puglShow(app.view));
  while (app.state != EXPOSED) {
    assert(!puglUpdate(app.world, timeout));
  }

  // Register a timer with a longer period first
  assert(!puglStartTimer(app.view, timerId, timerPeriod * 2.0));

  // Replace it with the one we want (to ensure timers are replaced)
  assert(!puglStartTimer(app.view, timerId, timerPeriod));

  const double startTime = puglGetTime(app.world);

  puglUpdate(app.world, 1.0);

  // Calculate the actual period of the timer
  const double endTime        = puglGetTime(app.world);
  const double duration       = endTime - startTime;
  const double expectedPeriod = roundPeriod(timerPeriod);
  const double actualPeriod   = roundPeriod(duration / (double)app.numAlarms);
  const double difference     = fabs(actualPeriod - expectedPeriod);

  if (difference > tolerance) {
    fprintf(
      stderr, "error: Period not within %f of %f\n", tolerance, expectedPeriod);
    fprintf(stderr, "note: Actual period %f\n", actualPeriod);
  }

  assert(difference <= tolerance);

  // Deregister timer and tick once to synchronize
  assert(!puglStopTimer(app.view, timerId));
  puglUpdate(app.world, 0.0);

  // Update for a half second and check that we receive no more alarms
  app.numAlarms = 0;
  puglUpdate(app.world, 0.5);
  assert(app.numAlarms == 0);

  puglFreeView(app.view);
  puglFreeWorld(app.world);

  return 0;
}