-
Notifications
You must be signed in to change notification settings - Fork 68
/
SurfacePlugin.c
246 lines (220 loc) · 8.03 KB
/
SurfacePlugin.c
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/*
This file contains the low-level support code for OS
surfaces. Since FXBlt may operate on any of these
some functions must be provided by the client. It is
crucial that every client creating surfaces for use
by Squeak registers the surfaces using the functions
provided here. Other concrete primitives (such as
creation or destroy) of surfaces can be handled by
additional support code, querying the surface handle
from ioFindSurface but the functions provided below
are critical for any BitBlt operations.
Change History:
eem 3/15/2017 Allow functions registered with ioGetSurfaceFormat,
ioUnlockSurface and ioShowSurface to be omitted (defaulted to
0) and have ioGetSurfaceFormat, ioUnlockSurface & ioShowSurface
return -1 in this case (the BitBlt primitives expect 0 for
failure). This allows e.g. Pharo's AthensCairoSurface to
avoid installing two null callbacks for unlock & show.
*/
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
/* Default EXPORT macro that does nothing (see comment in sq.h): */
#define EXPORT(returnType) returnType
#include "sqVirtualMachine.h"
#include "sqConfig.h"
#include "sqPlatformSpecific.h"
#include "SurfacePlugin.h"
/* internal plugin support */
#ifdef SQUEAK_BUILTIN_PLUGIN
#undef EXPORT
#define EXPORT(returnType) static returnType
#endif
typedef struct SqueakSurface {
usqIntptr_t handle; /* client supplied handle */
sqSurfaceDispatch *dispatch;
} SqueakSurface;
static SqueakSurface *surfaceArray = NULL;
static int numSurfaces = 0;
static int maxSurfaces = 0;
#ifdef SQUEAK_BUILTIN_PLUGIN
static const char *moduleName = "SurfacePlugin "__DATE__" (i)";
#else
static const char *moduleName = "SurfacePlugin "__DATE__" (e)";
#endif
static VirtualMachine *interpreterProxy;
#define FAIL { interpreterProxy->primitiveFail(); return 0; }
#pragma export on
/* module initialization/shutdown */
EXPORT(long) setInterpreter(struct VirtualMachine *interpreterProxy);
EXPORT(const char*) getModuleName(void);
EXPORT(long) initialiseModule(void);
EXPORT(long) shutdownModule(void);
/* critical FXBlt entry points */
EXPORT(int) ioGetSurfaceFormat (int surfaceID, int* width, int* height, int* depth, int* isMSB);
EXPORT(sqIntptr_t) ioLockSurface (int surfaceID, int *pitch, int x, int y, int w, int h);
EXPORT(int) ioUnlockSurface(int surfaceID, int x, int y, int w, int h);
/* interpreter entry point */
EXPORT(int) ioShowSurface(int surfaceID, int x, int y, int w, int h);
/* client entry points */
EXPORT(int) ioRegisterSurface(sqIntptr_t surfaceHandle, sqSurfaceDispatch *fn, int *surfaceID);
EXPORT(int) ioUnregisterSurface(int surfaceID);
EXPORT(int) ioFindSurface(int surfaceID, sqSurfaceDispatch *fn, sqIntptr_t *surfaceHandle);
#pragma export off
/* ioGetSurfaceFormat:
Return information describing the given surface.
Return true if successful, false otherwise. */
EXPORT(int) ioGetSurfaceFormat (int surfaceID, int* width, int* height, int* depth, int* isMSB)
{
SqueakSurface *surface;
if(surfaceID < 0 || surfaceID >= maxSurfaces) FAIL;
surface = surfaceArray + surfaceID;
if(surface->dispatch == NULL) FAIL;
/* Allow getSurfaceFormat to be defaulted to 0 */
if(!surface->dispatch->getSurfaceFormat)
return -1;
return surface->dispatch->getSurfaceFormat(surface->handle, width, height, depth, isMSB);
}
/* ioLockSurface:
Lock the bits of the surface.
Return a pointer to the actual surface bits,
or NULL on failure. */
EXPORT(sqIntptr_t) ioLockSurface (int surfaceID, int *pitch, int x, int y, int w, int h)
{
SqueakSurface *surface;
if(surfaceID < 0 || surfaceID >= maxSurfaces) FAIL;
surface = surfaceArray + surfaceID;
if(surface->dispatch == NULL) FAIL;
if(!surface->dispatch->lockSurface) FAIL;
return surface->dispatch->lockSurface(surface->handle, pitch, x, y, w, h);
}
/* ioUnlockSurface:
Unlock the bits of the surface.
The return value is ignored. */
EXPORT(int) ioUnlockSurface(int surfaceID, int x, int y, int w, int h)
{
SqueakSurface *surface;
if(surfaceID < 0 || surfaceID >= maxSurfaces) FAIL;
surface = surfaceArray + surfaceID;
if(surface->dispatch == NULL) FAIL;
/* Allow unlockSurface to be defaulted to 0 */
if(!surface->dispatch->unlockSurface)
return -1;
return surface->dispatch->unlockSurface(surface->handle, x, y, w, h);
}
/* ioShowSurface:
Transfer the bits of a surface to the screen. */
EXPORT(int) ioShowSurface(int surfaceID, int x, int y, int w, int h)
{
SqueakSurface *surface;
if(surfaceID < 0 || surfaceID >= maxSurfaces) FAIL;
surface = surfaceArray + surfaceID;
if(surface->dispatch == NULL) FAIL;
/* Allow showSurface to be defaulted to 0 */
if(!surface->dispatch->showSurface)
-1;
return surface->dispatch->showSurface(surface->handle, x, y, w, h);
}
/* ioRegisterSurface:
Register a new surface with the given handle and
the set of surface functions. The new ID is returned
in surfaceID. Returns true if successful, false
otherwise. */
EXPORT(int) ioRegisterSurface(sqIntptr_t surfaceHandle, sqSurfaceDispatch *fn, int *surfaceID)
{
int index;
if(!fn) return 0;
if(fn->majorVersion != 1 && fn->minorVersion != 0) return 0;
if(numSurfaces == maxSurfaces) {
maxSurfaces = maxSurfaces * 2 + 10;
surfaceArray = realloc(surfaceArray, sizeof(SqueakSurface) * maxSurfaces);
for(index = numSurfaces; index < maxSurfaces; index++){
surfaceArray[index].handle = 0;
surfaceArray[index].dispatch = NULL;
}
index = numSurfaces;
} else {
for(index = 0; index < maxSurfaces; index++)
if(surfaceArray[index].dispatch == NULL)
break;
}
if(index >= maxSurfaces) return 0; /* should not happen */
surfaceArray[index].handle = surfaceHandle;
surfaceArray[index].dispatch = fn;
*surfaceID = index;
numSurfaces++;
return 1;
}
/* ioUnregisterSurface:
Unregister the surface with the given ID.
Returns true if successful, false otherwise. */
EXPORT(int) ioUnregisterSurface(int surfaceID)
{
SqueakSurface *surface;
if(surfaceID < 0 || surfaceID >= maxSurfaces) return 0;
surface = surfaceArray + surfaceID;
if(surface->dispatch == NULL) return 0;
surface->handle = 0;
surface->dispatch = NULL;
numSurfaces--;
return 1;
}
/* ioFindSurface:
Find the surface with the given ID, and, optionally,
the given set of surface functions. The registered handle
is returned in surfaceHandle. Return true if successful
(e.g., the surface has been found), false otherwise. */
EXPORT(int) ioFindSurface(int surfaceID, sqSurfaceDispatch *fn, sqIntptr_t *surfaceHandle)
{
SqueakSurface *surface;
if(surfaceID < 0 || surfaceID >= maxSurfaces) return 0;
surface = surfaceArray + surfaceID;
if(surface->dispatch == NULL) return 0;
if(fn && fn != surface->dispatch) return 0;
*surfaceHandle = surface->handle;
return 1;
}
EXPORT(long) setInterpreter(struct VirtualMachine* anInterpreter) {
long ok;
interpreterProxy = anInterpreter;
ok = interpreterProxy->majorVersion() == VM_PROXY_MAJOR;
if (ok == 0) {
return 0;
}
ok = interpreterProxy->minorVersion() >= VM_PROXY_MINOR;
return ok;
}
EXPORT(const char*) getModuleName(void) {
return moduleName;
}
EXPORT(long) initialiseModule() {
surfaceArray = NULL;
numSurfaces = 0;
maxSurfaces = 0;
return 1;
}
EXPORT(long) shutdownModule() {
/* This module can only be shut down if no surfaces are registered */
if(numSurfaces != 0) return 0;
free(surfaceArray);
return 1;
}
#ifdef SQUEAK_BUILTIN_PLUGIN
void* SurfacePlugin_exports[][3] = {
{"SurfacePlugin", "setInterpreter", (void*)setInterpreter},
{"SurfacePlugin", "getModuleName", (void*)getModuleName},
{"SurfacePlugin", "initialiseModule", (void*)initialiseModule},
{"SurfacePlugin", "shutdownModule", (void*)shutdownModule},
{"SurfacePlugin", "ioGetSurfaceFormat", (void*)ioGetSurfaceFormat},
{"SurfacePlugin", "ioLockSurface", (void*)ioLockSurface},
{"SurfacePlugin", "ioUnlockSurface", (void*)ioUnlockSurface},
{"SurfacePlugin", "ioShowSurface", (void*)ioShowSurface},
{"SurfacePlugin", "ioRegisterSurface", (void*)ioRegisterSurface},
{"SurfacePlugin", "ioUnregisterSurface", (void*)ioUnregisterSurface},
{"SurfacePlugin", "ioFindSurface", (void*)ioFindSurface},
{NULL, NULL, NULL}
};
#endif /* ifdef SQ_BUILTIN_PLUGIN */