Mercurial > hg > xemacs-beta
annotate src/gccache-gtk.c @ 5090:0ca81354c4c7
Further frame-geometry cleanups
-------------------- ChangeLog entries follow: --------------------
man/ChangeLog addition:
2010-03-03 Ben Wing <ben@xemacs.org>
* internals/internals.texi (Intro to Window and Frame Geometry):
* internals/internals.texi (The Paned Area):
* internals/internals.texi (The Displayable Area):
Update to make note of e.g. the fact that the bottom gutter is
actually above the minibuffer.
src/ChangeLog addition:
2010-03-03 Ben Wing <ben@xemacs.org>
* emacs.c:
* emacs.c (assert_equal_failed):
* lisp.h:
* lisp.h (assert_equal):
New fun assert_equal, asserting that two values == each other, and
printing out both values upon failure.
* frame-gtk.c (gtk_initialize_frame_size):
* frame-impl.h:
* frame-impl.h (FRAME_TOP_INTERNAL_BORDER_START):
* frame-impl.h (FRAME_BOTTOM_INTERNAL_BORDER_START):
* frame-impl.h (FRAME_LEFT_INTERNAL_BORDER_START):
* frame-impl.h (FRAME_PANED_TOP_EDGE):
* frame-impl.h (FRAME_NONPANED_SIZE):
* frame-x.c (x_initialize_frame_size):
* frame.c:
* gutter.c (get_gutter_coords):
* gutter.c (calculate_gutter_size):
* gutter.h:
* gutter.h (WINDOW_REAL_TOP_GUTTER_BOUNDS):
* gutter.h (FRAME_TOP_GUTTER_BOUNDS):
* input-method-xlib.c:
* input-method-xlib.c (XIM_SetGeometry):
* redisplay-output.c (clear_left_border):
* redisplay-output.c (clear_right_border):
* redisplay-output.c (redisplay_output_pixmap):
* redisplay-output.c (redisplay_clear_region):
* redisplay-output.c (redisplay_clear_top_of_window):
* redisplay-output.c (redisplay_clear_to_window_end):
* redisplay-xlike-inc.c (XLIKE_clear_frame):
* redisplay.c:
* redisplay.c (UPDATE_CACHE_RETURN):
* redisplay.c (pixel_to_glyph_translation):
* toolbar.c (update_frame_toolbars_geometry):
* window.c (Fwindow_pixel_edges):
Get rid of some redundant macros. Consistently use the
FRAME_TOP_*_START, FRAME_RIGHT_*_END, etc. format. Rename
FRAME_*_BORDER_* to FRAME_*_INTERNAL_BORDER_*. Comment out
FRAME_BOTTOM_* for gutters and the paned area due to the
uncertainty over where the paned area actually begins. (Eventually
we should probably move the gutters outside the minibuffer so that
the paned area is contiguous.) Use FRAME_PANED_* more often in the
code to make things clearer.
Update the diagram to show that the bottom gutter is inside the
minibuffer (!) and that there are "junk boxes" when you have left
and/or right gutters (dead boxes that are mistakenly left uncleared,
unlike the corresponding scrollbar dead boxes). Update the text
appropriately to cover the bottom gutter position, etc.
Rewrite gutter-geometry code to use the FRAME_*_GUTTER_* in place of
equivalent expressions referencing other frame elements, to make the
code more portable in case we move around the gutter location.
Cleanup FRAME_*_GUTTER_BOUNDS() in gutter.h.
Add some #### GEOM! comments where I think code is incorrect --
typically, it wasn't fixed up properly when the gutter was added.
Some cosmetic changes.
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Wed, 03 Mar 2010 05:07:47 -0600 |
| parents | 6f2158fa75ed |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 462 | 1 /* Efficient caching of Gtk GCs (graphics contexts). |
| 2 Copyright (C) 1993 Free Software Foundation, Inc. | |
| 3 Copyright (C) 1994, 1995 Board of Trustees, University of Illinois. | |
| 4 | |
| 5 This file is part of XEmacs. | |
| 6 | |
| 7 XEmacs is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 9 Free Software Foundation; either version 2, or (at your option) any | |
| 10 later version. | |
| 11 | |
| 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 18 along with XEmacs; see the file COPYING. If not, write to | |
| 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 20 Boston, MA 02111-1307, USA. */ | |
| 21 | |
| 22 /* Synched up with: Not in FSF. */ | |
| 23 | |
|
4908
b3ce27ca7647
various fixes related to gtk, redisplay-xlike-inc.c
Ben Wing <ben@xemacs.org>
parents:
2515
diff
changeset
|
24 /* XEmacs uses a lot of different display attributes; for example, assume |
| 462 | 25 that only four fonts are in use (normal, bold, italic, and bold-italic). |
| 26 Then assume that one stipple or background is used for text selections, | |
| 27 and another is used for highlighting mousable regions. That makes 16 | |
| 28 GCs already. Add in the fact that another GC may be needed to display | |
| 29 the text cursor in any of those regions, and you've got 32. Add in | |
| 30 more fonts, and it keeps increasing exponentially. | |
| 31 | |
| 32 We used to keep these GCs in a cache of merged (fully qualified) faces. | |
| 33 However, a lot of other code in xterm.c used XChangeGC of existing GCs, | |
| 34 which is kind of slow and kind of random. Also, managing the face cache | |
| 35 was tricky because it was hard to know when a face was no longer visible | |
| 36 on the frame -- we had to mark all frames as garbaged whenever a face | |
| 37 was changed, which caused an unpleasant amount of flicker (since faces are | |
| 38 created/destroyed (= changed) whenever a frame is created/destroyed. | |
| 39 | |
| 40 So this code maintains a cache at the GC level instead of at the face | |
| 41 level. There is an upper limit on the size of the cache, after which we | |
| 42 will stop creating GCs and start reusing them (reusing the least-recently- | |
| 43 used ones first). So if faces get changed, their GCs will eventually be | |
| 44 recycled. Also more sharing of GCs is possible. | |
| 45 | |
| 46 This code uses hashtables. It could be that, if the cache size is small | |
| 47 enough, a linear search might be faster; but I doubt it, since we need | |
| 48 `equal' comparisons, not `eq', and I expect that the optimal cache size | |
| 49 will be ~100. | |
| 50 | |
| 51 Written by jwz, 14 jun 93 | |
| 52 Hacked by William Perry, apr 2000 | |
| 53 */ | |
| 54 | |
| 55 #include <config.h> | |
| 56 #include "lisp.h" | |
|
4908
b3ce27ca7647
various fixes related to gtk, redisplay-xlike-inc.c
Ben Wing <ben@xemacs.org>
parents:
2515
diff
changeset
|
57 #include "hash.h" |
|
b3ce27ca7647
various fixes related to gtk, redisplay-xlike-inc.c
Ben Wing <ben@xemacs.org>
parents:
2515
diff
changeset
|
58 |
| 462 | 59 #include "gccache-gtk.h" |
| 60 | |
| 61 #define GC_CACHE_SIZE 100 | |
| 62 | |
| 63 #define GCCACHE_HASH | |
| 64 | |
| 65 struct gcv_and_mask { | |
| 66 GdkGCValues gcv; | |
| 2054 | 67 unsigned long mask; /* contains a GdkGCValuesMask bitmask. */ |
| 462 | 68 }; |
| 69 | |
| 70 struct gc_cache_cell { | |
| 71 GdkGC *gc; | |
| 72 struct gcv_and_mask gcvm; | |
| 73 struct gc_cache_cell *prev, *next; | |
| 74 }; | |
| 75 | |
| 76 struct gc_cache { | |
| 77 GdkWindow *window; /* used only as arg to XCreateGC */ | |
| 78 int size; | |
| 79 struct gc_cache_cell *head; | |
| 80 struct gc_cache_cell *tail; | |
| 81 #ifdef GCCACHE_HASH | |
| 82 struct hash_table * table; | |
| 83 #endif | |
| 84 | |
| 85 int create_count; | |
| 86 int delete_count; | |
| 87 }; | |
| 88 | |
| 89 #ifdef GCCACHE_HASH | |
| 2515 | 90 static Hashcode |
| 462 | 91 gc_cache_hash (const void *arg) |
| 92 { | |
| 93 const struct gcv_and_mask *gcvm = (const struct gcv_and_mask *) arg; | |
| 94 unsigned long *longs = (unsigned long *) &gcvm->gcv; | |
| 2515 | 95 Hashcode hash = gcvm->mask; |
| 778 | 96 unsigned int i; |
| 462 | 97 /* This could look at the mask and only use the used slots in the |
| 98 hash code. That would win in that we wouldn't have to initialize | |
| 99 every slot of the gcv when calling gc_cache_lookup. But we need | |
| 100 the hash function to be as fast as possible; some timings should | |
| 101 be done. */ | |
| 102 for (i = 0; i < (sizeof (GdkGCValues) / sizeof (unsigned long)); i++) | |
| 2515 | 103 hash = (hash << 1) ^ *longs++; |
| 462 | 104 return hash; |
| 105 } | |
| 106 | |
| 107 #endif /* GCCACHE_HASH */ | |
| 108 | |
| 109 static int | |
| 110 gc_cache_eql (const void *arg1, const void *arg2) | |
| 111 { | |
| 112 /* See comment in gc_cache_hash */ | |
| 113 const struct gcv_and_mask *gcvm1 = (const struct gcv_and_mask *) arg1; | |
| 114 const struct gcv_and_mask *gcvm2 = (const struct gcv_and_mask *) arg2; | |
| 115 | |
| 116 return !memcmp(&gcvm1->gcv, &gcvm2->gcv, sizeof(gcvm1->gcv)) | |
| 117 && gcvm1->mask == gcvm2->mask; | |
| 118 } | |
| 119 | |
| 120 struct gc_cache * | |
| 121 make_gc_cache (GtkWidget *widget) | |
| 122 { | |
| 123 struct gc_cache *cache = xnew (struct gc_cache); | |
| 124 cache->window = widget->window; | |
| 125 cache->size = 0; | |
| 126 cache->head = cache->tail = 0; | |
| 127 cache->create_count = cache->delete_count = 0; | |
| 128 #ifdef GCCACHE_HASH | |
| 129 cache->table = | |
| 130 make_general_hash_table (GC_CACHE_SIZE, gc_cache_hash, gc_cache_eql); | |
| 131 #endif | |
| 132 return cache; | |
| 133 } | |
| 134 | |
| 135 void | |
| 136 free_gc_cache (struct gc_cache *cache) | |
| 137 { | |
| 138 struct gc_cache_cell *rest, *next; | |
| 139 rest = cache->head; | |
| 140 while (rest) | |
| 141 { | |
| 142 gdk_gc_destroy(rest->gc); | |
| 143 next = rest->next; | |
|
4976
16112448d484
Rename xfree(FOO, TYPE) -> xfree(FOO)
Ben Wing <ben@xemacs.org>
parents:
4908
diff
changeset
|
144 xfree (rest); |
| 462 | 145 rest = next; |
| 146 } | |
| 147 #ifdef GCCACHE_HASH | |
| 148 free_hash_table (cache->table); | |
| 149 #endif | |
|
4976
16112448d484
Rename xfree(FOO, TYPE) -> xfree(FOO)
Ben Wing <ben@xemacs.org>
parents:
4908
diff
changeset
|
150 xfree (cache); |
| 462 | 151 } |
| 152 | |
| 153 GdkGC * | |
| 2054 | 154 gc_cache_lookup (struct gc_cache *cache, GdkGCValues *gcv, unsigned long mask) |
| 462 | 155 { |
| 156 struct gc_cache_cell *cell, *next, *prev; | |
| 157 struct gcv_and_mask gcvm; | |
| 158 | |
|
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4976
diff
changeset
|
159 assert ((!!cache->head) == (!!cache->tail)); |
|
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4976
diff
changeset
|
160 assert (!(cache->head && (cache->head->prev || cache->tail->next))); |
| 462 | 161 |
| 162 /* Gdk does not have the equivalent of 'None' for the clip_mask, so | |
| 163 we need to check it carefully, or gdk_gc_new_with_values will | |
| 164 coredump */ | |
| 165 if ((mask & GDK_GC_CLIP_MASK) && !gcv->clip_mask) | |
| 166 { | |
| 167 mask &= ~GDK_GC_CLIP_MASK; | |
| 168 } | |
| 169 | |
| 170 gcvm.mask = mask; | |
| 171 gcvm.gcv = *gcv; /* this copies... */ | |
| 172 | |
| 173 #ifdef GCCACHE_HASH | |
| 174 | |
| 175 if (gethash (&gcvm, cache->table, (const void **) &cell)) | |
| 176 | |
| 177 #else /* !GCCACHE_HASH */ | |
| 178 | |
| 179 cell = cache->tail; /* start at the end (most recently used) */ | |
| 180 while (cell) | |
| 181 { | |
| 182 if (gc_cache_eql (&gcvm, &cell->gcvm)) | |
| 183 break; | |
| 184 else | |
| 185 cell = cell->prev; | |
| 186 } | |
| 187 | |
| 188 /* #### This whole file needs some serious overhauling. */ | |
| 189 if (!(mask | GDK_GC_TILE) && cell->gcvm.gcv.tile) | |
| 190 cell = 0; | |
| 191 else if (!(mask | GDK_GC_STIPPLE) && cell->gcvm.gcv.stipple) | |
| 192 cell = 0; | |
| 193 | |
| 194 if (cell) | |
| 195 | |
| 196 #endif /* !GCCACHE_HASH */ | |
| 197 | |
| 198 { | |
| 199 /* Found a cell. Move this cell to the end of the list, so that it | |
| 200 will be less likely to be collected than a cell that was accessed | |
| 201 less recently. | |
| 202 */ | |
| 203 if (cell == cache->tail) | |
| 204 return cell->gc; | |
| 205 | |
| 206 next = cell->next; | |
| 207 prev = cell->prev; | |
| 208 if (prev) prev->next = next; | |
| 209 if (next) next->prev = prev; | |
| 210 if (cache->head == cell) cache->head = next; | |
| 211 cell->next = 0; | |
| 212 cell->prev = cache->tail; | |
| 213 cache->tail->next = cell; | |
| 214 cache->tail = cell; | |
|
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4976
diff
changeset
|
215 assert (cache->head != cell); |
|
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4976
diff
changeset
|
216 assert (!cell->next); |
|
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4976
diff
changeset
|
217 assert (!cache->head->prev); |
|
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4976
diff
changeset
|
218 assert (!cache->tail->next); |
| 462 | 219 return cell->gc; |
| 220 } | |
| 221 | |
| 222 /* else, cache miss. */ | |
| 223 | |
| 224 if (cache->size == GC_CACHE_SIZE) | |
| 225 /* Reuse the first cell on the list (least-recently-used). | |
| 226 Remove it from the list, and unhash it from the table. | |
| 227 */ | |
| 228 { | |
| 229 cell = cache->head; | |
| 230 cache->head = cell->next; | |
| 231 cache->head->prev = 0; | |
| 232 if (cache->tail == cell) cache->tail = 0; /* only one */ | |
| 233 gdk_gc_destroy (cell->gc); | |
| 234 cache->delete_count++; | |
| 235 #ifdef GCCACHE_HASH | |
| 236 remhash (&cell->gcvm, cache->table); | |
| 237 #endif | |
| 238 } | |
| 239 else if (cache->size > GC_CACHE_SIZE) | |
| 2500 | 240 ABORT (); |
| 462 | 241 else |
| 242 { | |
| 243 /* Allocate a new cell (don't put it in the list or table yet). */ | |
| 244 cell = xnew (struct gc_cache_cell); | |
| 245 cache->size++; | |
| 246 } | |
| 247 | |
| 248 /* Now we've got a cell (new or reused). Fill it in. */ | |
| 249 memcpy (&cell->gcvm.gcv, gcv, sizeof (GdkGCValues)); | |
| 250 cell->gcvm.mask = mask; | |
| 251 | |
| 252 /* Put the cell on the end of the list. */ | |
| 253 cell->next = 0; | |
| 254 cell->prev = cache->tail; | |
| 255 if (cache->tail) cache->tail->next = cell; | |
| 256 cache->tail = cell; | |
| 257 if (! cache->head) cache->head = cell; | |
| 258 | |
| 259 cache->create_count++; | |
| 260 #ifdef GCCACHE_HASH | |
| 261 /* Hash it in the table */ | |
| 262 puthash (&cell->gcvm, cell, cache->table); | |
| 263 #endif | |
| 264 | |
| 265 /* Now make and return the GC. */ | |
| 2054 | 266 cell->gc = gdk_gc_new_with_values (cache->window, gcv, (GdkGCValuesMask) mask); |
| 462 | 267 |
| 268 /* debug */ | |
| 269 assert (cell->gc == gc_cache_lookup (cache, gcv, mask)); | |
| 270 | |
| 271 return cell->gc; | |
| 272 } |