|
2586
|
1 /* Efficient caching of GCs (graphics contexts) -- shared code, X and GTK.
|
|
|
2 Copyright (C) 1993 Free Software Foundation, Inc.
|
|
|
3 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois.
|
|
|
4 Copyright (C) 2003, 2005 Ben Wing.
|
|
|
5
|
|
|
6 This file is part of XEmacs.
|
|
|
7
|
|
|
8 XEmacs is free software; you can redistribute it and/or modify it
|
|
|
9 under the terms of the GNU General Public License as published by the
|
|
|
10 Free Software Foundation; either version 2, or (at your option) any
|
|
|
11 later version.
|
|
|
12
|
|
|
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
|
16 for more details.
|
|
|
17
|
|
|
18 You should have received a copy of the GNU General Public License
|
|
|
19 along with XEmacs; see the file COPYING. If not, write to
|
|
|
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
21 Boston, MA 02111-1307, USA. */
|
|
|
22
|
|
|
23 /* Synched up with: Not in FSF. */
|
|
|
24
|
|
|
25 /* Emacs uses a lot of different display attributes; for example, assume
|
|
|
26 that only four fonts are in use (normal, bold, italic, and bold-italic).
|
|
|
27 Then assume that one stipple or background is used for text selections,
|
|
|
28 and another is used for highlighting mousable regions. That makes 16
|
|
|
29 GCs already. Add in the fact that another GC may be needed to display
|
|
|
30 the text cursor in any of those regions, and you've got 32. Add in
|
|
|
31 more fonts, and it keeps increasing exponentially.
|
|
|
32
|
|
|
33 We used to keep these GCs in a cache of merged (fully qualified) faces.
|
|
|
34 However, a lot of other code in xterm.c used XChangeGC of existing GCs,
|
|
|
35 which is kind of slow and kind of random. Also, managing the face cache
|
|
|
36 was tricky because it was hard to know when a face was no longer visible
|
|
|
37 on the frame -- we had to mark all frames as garbaged whenever a face
|
|
|
38 was changed, which caused an unpleasant amount of flicker (since faces are
|
|
|
39 created/destroyed (= changed) whenever a frame is created/destroyed.
|
|
|
40
|
|
|
41 So this code maintains a cache at the GC level instead of at the face
|
|
|
42 level. There is an upper limit on the size of the cache, after which we
|
|
|
43 will stop creating GCs and start reusing them (reusing the least-recently-
|
|
|
44 used ones first). So if faces get changed, their GCs will eventually be
|
|
|
45 recycled. Also more sharing of GCs is possible.
|
|
|
46
|
|
|
47 This code uses hash tables. It could be that, if the cache size is small
|
|
|
48 enough, a linear search might be faster; but I doubt it, since we need
|
|
|
49 `equal' comparisons, not `eq', and I expect that the optimal cache size
|
|
|
50 will be ~100.
|
|
|
51
|
|
|
52 Written by jwz, 14 jun 93
|
|
|
53 Hacked by William Perry, apr 2000 for GTK and introduced code
|
|
|
54 duplication (a no-no)
|
|
|
55 Undid code duplication, Ben Wing, Jan 28, 2003.
|
|
|
56 */
|
|
|
57
|
|
|
58 #include <config.h>
|
|
|
59 #include "lisp.h"
|
|
|
60 #include "hash.h"
|
|
|
61
|
|
|
62 #ifndef THIS_IS_GTK
|
|
|
63 #include <X11/Xlib.h>
|
|
|
64 #else /* THIS_IS_GTK */
|
|
|
65 #include <gtk/gtk.h>
|
|
|
66 #endif /* THIS_IS_GTK */
|
|
|
67
|
|
|
68 #define GC_CACHE_SIZE 100
|
|
|
69
|
|
|
70 #define GCCACHE_HASH
|
|
|
71
|
|
|
72 #ifndef THIS_IS_GTK
|
|
|
73 #define ZZGCVALUES XGCValues
|
|
|
74 #define ZZGC GC
|
|
|
75 #define ZZ(z) x_##z
|
|
|
76 #else
|
|
|
77 #define ZZGCVALUES GdkGCValues
|
|
|
78 #define ZZGC GdkGC *
|
|
|
79 #define ZZ(z) gtk_##z
|
|
|
80 #endif
|
|
|
81
|
|
|
82 struct gcv_and_mask {
|
|
|
83 ZZGCVALUES gcv;
|
|
|
84 unsigned long mask;
|
|
|
85 };
|
|
|
86
|
|
|
87 struct gc_cache_cell {
|
|
|
88 ZZGC gc;
|
|
|
89 struct gcv_and_mask gcvm;
|
|
|
90 struct gc_cache_cell *prev, *next;
|
|
|
91 };
|
|
|
92
|
|
|
93 struct gc_cache {
|
|
|
94 #ifndef THIS_IS_GTK
|
|
|
95 Display *dpy; /* used only as arg to XCreateGC/XFreeGC */
|
|
|
96 Window window; /* used only as arg to XCreateGC */
|
|
|
97 #else /* THIS_IS_GTK */
|
|
|
98 GdkWindow *window; /* used only as arg to XCreateGC */
|
|
|
99 #endif /* THIS_IS_GTK */
|
|
|
100 int size;
|
|
|
101 struct gc_cache_cell *head;
|
|
|
102 struct gc_cache_cell *tail;
|
|
|
103 #ifdef GCCACHE_HASH
|
|
|
104 struct hash_table *table;
|
|
|
105 #endif
|
|
|
106
|
|
|
107 int create_count;
|
|
|
108 int delete_count;
|
|
|
109 };
|
|
|
110
|
|
|
111 #ifdef GCCACHE_HASH
|
|
|
112 static Hashcode
|
|
|
113 gc_cache_hash (const void *arg)
|
|
|
114 {
|
|
|
115 const struct gcv_and_mask *gcvm = (const struct gcv_and_mask *) arg;
|
|
|
116 unsigned long *longs = (unsigned long *) &gcvm->gcv;
|
|
|
117 Hashcode hash = gcvm->mask;
|
|
|
118 int i;
|
|
|
119 /* This could look at the mask and only use the used slots in the
|
|
|
120 hash code. That would win in that we wouldn't have to initialize
|
|
|
121 every slot of the gcv when calling gc_cache_lookup. But we need
|
|
|
122 the hash function to be as fast as possible; some timings should
|
|
|
123 be done. */
|
|
|
124 for (i = 0; i < (int) (sizeof (ZZGCVALUES) /
|
|
|
125 sizeof (unsigned long)); i++)
|
|
|
126 hash = (hash << 1) ^ *longs++;
|
|
|
127 return hash;
|
|
|
128 }
|
|
|
129
|
|
|
130 #endif /* GCCACHE_HASH */
|
|
|
131
|
|
|
132 static int
|
|
|
133 gc_cache_eql (const void *arg1, const void *arg2)
|
|
|
134 {
|
|
|
135 /* See comment in gc_cache_hash */
|
|
|
136 #ifndef THIS_IS_GTK
|
|
|
137 return !memcmp (arg1, arg2, sizeof (struct gcv_and_mask));
|
|
|
138 #else /* THIS_IS_GTK */
|
|
|
139 const struct gcv_and_mask *gcvm1 = (const struct gcv_and_mask *) arg1;
|
|
|
140 const struct gcv_and_mask *gcvm2 = (const struct gcv_and_mask *) arg2;
|
|
|
141
|
|
|
142 return !memcmp (&gcvm1->gcv, &gcvm2->gcv, sizeof (gcvm1->gcv))
|
|
|
143 && gcvm1->mask == gcvm2->mask;
|
|
|
144 #endif /* THIS_IS_GTK */
|
|
|
145 }
|
|
|
146
|
|
|
147 struct gc_cache *
|
|
|
148 #ifndef THIS_IS_GTK
|
|
|
149 ZZ (make_gc_cache) (Display *dpy, Window window)
|
|
|
150 #else /* THIS_IS_GTK */
|
|
|
151 ZZ (make_gc_cache) (GtkWidget *widget)
|
|
|
152 #endif /* THIS_IS_GTK */
|
|
|
153 {
|
|
|
154 struct gc_cache *cache = xnew (struct gc_cache);
|
|
|
155 #ifndef THIS_IS_GTK
|
|
|
156 cache->dpy = dpy;
|
|
|
157 cache->window = window;
|
|
|
158 #else /* THIS_IS_GTK */
|
|
|
159 cache->window = widget->window;
|
|
|
160 #endif /* THIS_IS_GTK */
|
|
|
161 cache->size = 0;
|
|
|
162 cache->head = cache->tail = 0;
|
|
|
163 cache->create_count = cache->delete_count = 0;
|
|
|
164 #ifdef GCCACHE_HASH
|
|
|
165 cache->table =
|
|
|
166 make_general_hash_table (GC_CACHE_SIZE, gc_cache_hash, gc_cache_eql);
|
|
|
167 #endif
|
|
|
168 return cache;
|
|
|
169 }
|
|
|
170
|
|
|
171 void
|
|
|
172 ZZ (free_gc_cache) (struct gc_cache *cache)
|
|
|
173 {
|
|
|
174 struct gc_cache_cell *rest, *next;
|
|
|
175 rest = cache->head;
|
|
|
176 while (rest)
|
|
|
177 {
|
|
|
178 #ifndef THIS_IS_GTK
|
|
|
179 XFreeGC (cache->dpy, rest->gc);
|
|
|
180 #else /* THIS_IS_GTK */
|
|
|
181 gdk_gc_destroy (rest->gc);
|
|
|
182 #endif /* THIS_IS_GTK */
|
|
|
183 next = rest->next;
|
|
|
184 xfree (rest, struct gc_cache_cell *);
|
|
|
185 rest = next;
|
|
|
186 }
|
|
|
187 #ifdef GCCACHE_HASH
|
|
|
188 free_hash_table (cache->table);
|
|
|
189 #endif
|
|
|
190 xfree (cache, struct gc_cache *);
|
|
|
191 }
|
|
|
192
|
|
|
193 ZZGC
|
|
|
194 ZZ (gc_cache_lookup) (struct gc_cache *cache, ZZGCVALUES *gcv, unsigned long mask)
|
|
|
195 {
|
|
|
196 struct gc_cache_cell *cell, *next, *prev;
|
|
|
197 struct gcv_and_mask gcvm;
|
|
|
198
|
|
|
199 if ((!!cache->head) != (!!cache->tail)) ABORT ();
|
|
|
200 if (cache->head && (cache->head->prev || cache->tail->next)) ABORT ();
|
|
|
201
|
|
|
202 #ifdef THIS_IS_GTK
|
|
|
203 /* Gdk does not have the equivalent of 'None' for the clip_mask, so
|
|
|
204 we need to check it carefully, or gdk_gc_new_with_values will
|
|
|
205 coredump */
|
|
|
206 if ((mask & GDK_GC_CLIP_MASK) && !gcv->clip_mask)
|
|
|
207 mask = (GdkGCValuesMask) (mask & ~GDK_GC_CLIP_MASK);
|
|
|
208 #endif /* THIS_IS_GTK */
|
|
|
209
|
|
|
210 gcvm.mask = mask;
|
|
|
211 gcvm.gcv = *gcv; /* this copies... */
|
|
|
212
|
|
|
213 #ifdef GCCACHE_HASH
|
|
|
214
|
|
|
215 if (gethash (&gcvm, cache->table, (const void **) &cell))
|
|
|
216
|
|
|
217 #else /* !GCCACHE_HASH */
|
|
|
218
|
|
|
219 cell = cache->tail; /* start at the end (most recently used) */
|
|
|
220 while (cell)
|
|
|
221 {
|
|
|
222 if (gc_cache_eql (&gcvm, &cell->gcvm))
|
|
|
223 break;
|
|
|
224 else
|
|
|
225 cell = cell->prev;
|
|
|
226 }
|
|
|
227
|
|
|
228 /* #### This whole file needs some serious overhauling. */
|
|
|
229 #ifndef THIS_IS_GTK
|
|
|
230 if (!(mask | GCTile) && cell->gc->values.tile)
|
|
|
231 #else /* THIS_IS_GTK */
|
|
|
232 if (!(mask | GDK_GC_TILE) && cell->gcvm.gcv.tile)
|
|
|
233 #endif /* THIS_IS_GTK */
|
|
|
234 cell = 0;
|
|
|
235 #ifndef THIS_IS_GTK
|
|
|
236 else if (!(mask | GCStipple) && cell->gc->values.stipple)
|
|
|
237 #else /* THIS_IS_GTK */
|
|
|
238 else if (!(mask | GDK_GC_STIPPLE) && cell->gcvm.gcv.stipple)
|
|
|
239 #endif /* THIS_IS_GTK */
|
|
|
240 cell = 0;
|
|
|
241
|
|
|
242 if (cell)
|
|
|
243
|
|
|
244 #endif /* !GCCACHE_HASH */
|
|
|
245
|
|
|
246 {
|
|
|
247 /* Found a cell. Move this cell to the end of the list, so that it
|
|
|
248 will be less likely to be collected than a cell that was accessed
|
|
|
249 less recently.
|
|
|
250 */
|
|
|
251 if (cell == cache->tail)
|
|
|
252 return cell->gc;
|
|
|
253
|
|
|
254 next = cell->next;
|
|
|
255 prev = cell->prev;
|
|
|
256 if (prev) prev->next = next;
|
|
|
257 if (next) next->prev = prev;
|
|
|
258 if (cache->head == cell) cache->head = next;
|
|
|
259 cell->next = 0;
|
|
|
260 cell->prev = cache->tail;
|
|
|
261 cache->tail->next = cell;
|
|
|
262 cache->tail = cell;
|
|
|
263 if (cache->head == cell) ABORT ();
|
|
|
264 if (cell->next) ABORT ();
|
|
|
265 if (cache->head->prev) ABORT ();
|
|
|
266 if (cache->tail->next) ABORT ();
|
|
|
267 return cell->gc;
|
|
|
268 }
|
|
|
269
|
|
|
270 /* else, cache miss. */
|
|
|
271
|
|
|
272 if (cache->size == GC_CACHE_SIZE)
|
|
|
273 /* Reuse the first cell on the list (least-recently-used).
|
|
|
274 Remove it from the list, and unhash it from the table.
|
|
|
275 */
|
|
|
276 {
|
|
|
277 cell = cache->head;
|
|
|
278 cache->head = cell->next;
|
|
|
279 cache->head->prev = 0;
|
|
|
280 if (cache->tail == cell) cache->tail = 0; /* only one */
|
|
|
281 #ifndef THIS_IS_GTK
|
|
|
282 XFreeGC (cache->dpy, cell->gc);
|
|
|
283 #else /* THIS_IS_GTK */
|
|
|
284 gdk_gc_destroy (cell->gc);
|
|
|
285 #endif /* THIS_IS_GTK */
|
|
|
286 cache->delete_count++;
|
|
|
287 #ifdef GCCACHE_HASH
|
|
|
288 remhash (&cell->gcvm, cache->table);
|
|
|
289 #endif
|
|
|
290 }
|
|
|
291 else if (cache->size > GC_CACHE_SIZE)
|
|
|
292 ABORT ();
|
|
|
293 else
|
|
|
294 {
|
|
|
295 /* Allocate a new cell (don't put it in the list or table yet). */
|
|
|
296 cell = xnew (struct gc_cache_cell);
|
|
|
297 cache->size++;
|
|
|
298 }
|
|
|
299
|
|
|
300 /* Now we've got a cell (new or reused). Fill it in. */
|
|
|
301 memcpy (&cell->gcvm.gcv, gcv, sizeof (ZZGCVALUES));
|
|
|
302 cell->gcvm.mask = mask;
|
|
|
303
|
|
|
304 /* Put the cell on the end of the list. */
|
|
|
305 cell->next = 0;
|
|
|
306 cell->prev = cache->tail;
|
|
|
307 if (cache->tail) cache->tail->next = cell;
|
|
|
308 cache->tail = cell;
|
|
|
309 if (! cache->head) cache->head = cell;
|
|
|
310
|
|
|
311 cache->create_count++;
|
|
|
312 #ifdef GCCACHE_HASH
|
|
|
313 /* Hash it in the table */
|
|
|
314 puthash (&cell->gcvm, cell, cache->table);
|
|
|
315 #endif
|
|
|
316
|
|
|
317 /* Now make and return the GC. */
|
|
|
318 #ifndef THIS_IS_GTK
|
|
|
319 cell->gc = XCreateGC (cache->dpy, cache->window, mask, gcv);
|
|
|
320 #else /* THIS_IS_GTK */
|
|
|
321 cell->gc = gdk_gc_new_with_values (cache->window, gcv, (GdkGCValuesMask) mask);
|
|
|
322 #endif /* THIS_IS_GTK */
|
|
|
323
|
|
|
324 /* debug */
|
|
|
325 assert (cell->gc == ZZ (gc_cache_lookup) (cache, gcv, mask));
|
|
|
326
|
|
|
327 return cell->gc;
|
|
|
328 }
|
|
|
329 #ifndef THIS_IS_GTK
|
|
|
330
|
|
|
331
|
|
|
332 #ifdef DEBUG_XEMACS
|
|
|
333
|
|
|
334 void x_describe_gc_cache (struct gc_cache *cache);
|
|
|
335 void
|
|
|
336 x_describe_gc_cache (struct gc_cache *cache)
|
|
|
337 {
|
|
|
338 int count = 0;
|
|
|
339 struct gc_cache_cell *cell = cache->head;
|
|
|
340 stderr_out ("\nsize: %d", cache->size);
|
|
|
341 stderr_out ("\ncreated: %d", cache->create_count);
|
|
|
342 stderr_out ("\ndeleted: %d", cache->delete_count);
|
|
|
343 while (cell)
|
|
|
344 {
|
|
|
345 struct gc_cache_cell *cell2;
|
|
|
346 int i = 0;
|
|
|
347 stderr_out ("\n%d:\t0x%lx GC: 0x%08lx hash: 0x%08lx\n",
|
|
|
348 count, (long) cell, (long) cell->gc, gc_cache_hash (&cell->gcvm));
|
|
|
349 for (cell2 = cache->head; cell2; cell2 = cell2->next, i++)
|
|
|
350 if (count != i &&
|
|
|
351 gc_cache_hash (&cell->gcvm) == gc_cache_hash (&cell2->gcvm))
|
|
|
352 stderr_out ("\tHASH COLLISION with cell %d\n", i);
|
|
|
353 stderr_out ("\tmask: %8lx\n", cell->gcvm.mask);
|
|
|
354
|
|
|
355 #define FROB(field) do { \
|
|
|
356 if ((int)cell->gcvm.gcv.field != (~0)) \
|
|
|
357 stderr_out ("\t%-12s%8x\n", #field ":", (int)cell->gcvm.gcv.field); \
|
|
|
358 } while (0)
|
|
|
359 FROB (function);
|
|
|
360 FROB (plane_mask);
|
|
|
361 FROB (foreground);
|
|
|
362 FROB (background);
|
|
|
363 FROB (line_width);
|
|
|
364 FROB (line_style);
|
|
|
365 FROB (cap_style);
|
|
|
366 FROB (join_style);
|
|
|
367 FROB (fill_style);
|
|
|
368 FROB (fill_rule);
|
|
|
369 FROB (arc_mode);
|
|
|
370 FROB (tile);
|
|
|
371 FROB (stipple);
|
|
|
372 FROB (ts_x_origin);
|
|
|
373 FROB (ts_y_origin);
|
|
|
374 FROB (font);
|
|
|
375 FROB (subwindow_mode);
|
|
|
376 FROB (graphics_exposures);
|
|
|
377 FROB (clip_x_origin);
|
|
|
378 FROB (clip_y_origin);
|
|
|
379 FROB (clip_mask);
|
|
|
380 FROB (dash_offset);
|
|
|
381 #undef FROB
|
|
|
382
|
|
|
383 count++;
|
|
|
384 if (cell->next && cell == cache->tail)
|
|
|
385 stderr_out ("\nERROR! tail is here!\n\n");
|
|
|
386 else if (!cell->next && cell != cache->tail)
|
|
|
387 stderr_out ("\nERROR! tail is not at the end\n\n");
|
|
|
388 cell = cell->next;
|
|
|
389 }
|
|
|
390 if (count != cache->size)
|
|
|
391 stderr_out ("\nERROR! count should be %d\n\n", cache->size);
|
|
|
392 }
|
|
|
393
|
|
|
394 #endif /* DEBUG_XEMACS */
|
|
|
395 #endif /* ! THIS_IS_GTK */
|
