src/GCCache.cc

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // GCCache.cc for Blackbox - an X11 Window manager
   3 // Copyright (c) 2001 - 2002 Sean 'Shaleh' Perry <shaleh at debian.org>
   4 // Copyright (c) 1997 - 2000, 2002 Bradley T Hughes <bhughes at trolltech.com>
   5 //
   6 // Permission is hereby granted, free of charge, to any person obtaining a
   7 // copy of this software and associated documentation files (the "Software"),
   8 // to deal in the Software without restriction, including without limitation
   9 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10 // and/or sell copies of the Software, and to permit persons to whom the
  11 // Software is furnished to do so, subject to the following conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be included in
  14 // all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22 // DEALINGS IN THE SOFTWARE.
  23
  24 #ifdef HAVE_CONFIG_H
  25 #  include "../config.h"
  26 #endif // HAVE_CONFIG_H
  27
  28 extern "C" {
  29 #include <stdio.h>
  30 }
  31
  32 #include "GCCache.hh"
  33 #include "BaseDisplay.hh"
  34 #include "Color.hh"
  35 #include "Util.hh"
  36
  37
  38 void BGCCacheContext::set(const BColor &_color,
  39                           const XFontStruct * const _font,
  40                           const int _function, const int _subwindow) {
  41   XGCValues gcv;
  42   pixel = gcv.foreground = _color.pixel();
  43   function = gcv.function = _function;
  44   subwindow = gcv.subwindow_mode = _subwindow;
  45   unsigned long mask = GCForeground | GCFunction | GCSubwindowMode;
  46
  47   if (_font) {
  48     fontid = gcv.font = _font->fid;
  49     mask |= GCFont;
  50   } else {
  51     fontid = 0;
  52   }
  53
  54   XChangeGC(display->getXDisplay(), gc, mask, &gcv);
  55 }
  56
  57
  58 void BGCCacheContext::set(const XFontStruct * const _font) {
  59   if (! _font) {
  60     fontid = 0;
  61     return;
  62   }
  63
  64   XGCValues gcv;
  65   fontid = gcv.font = _font->fid;
  66   XChangeGC(display->getXDisplay(), gc, GCFont, &gcv);
  67 }
  68
  69
  70 BGCCache::BGCCache(const BaseDisplay * const _display)
  71   : display(_display),  context_count(128u),
  72     cache_size(16u), cache_buckets(8u),
  73     cache_total_size(cache_size * cache_buckets) {
  74
  75   contexts = new BGCCacheContext*[context_count];
  76   unsigned int i;
  77   for (i = 0; i < context_count; i++) {
  78     contexts[i] = new BGCCacheContext(display);
  79   }
  80
  81   cache = new BGCCacheItem*[cache_total_size];
  82   for (i = 0; i < cache_total_size; ++i) {
  83     cache[i] = new BGCCacheItem;
  84   }
  85 }
  86
  87
  88 BGCCache::~BGCCache(void) {
  89   std::for_each(contexts, contexts + context_count, PointerAssassin());
  90   std::for_each(cache, cache + cache_total_size, PointerAssassin());
  91   delete [] cache;
  92   delete [] contexts;
  93   cache = 0;
  94   contexts = 0;
  95 }
  96
  97
  98 BGCCacheContext *BGCCache::nextContext(unsigned int scr) {
  99   Window hd = display->getScreenInfo(scr)->getRootWindow();
 100
 101   BGCCacheContext *c;
 102
 103   for (unsigned int i = 0; i < context_count; ++i) {
 104     c = contexts[i];
 105
 106     if (! c->gc) {
 107       c->gc = XCreateGC(display->getXDisplay(), hd, 0, 0);
 108       c->used = false;
 109       c->screen = scr;
 110     }
 111     if (! c->used && c->screen == scr) {
 112       c->used = true;
 113       return c;
 114     }
 115   }
 116
 117   fprintf(stderr, "BGCCache: context fault!\n");
 118   abort();
 119 }
 120
 121
 122 void BGCCache::release(BGCCacheContext *ctx) {
 123   ctx->used = false;
 124 }
 125
 126
 127 BGCCacheItem *BGCCache::find(const BColor &_color,
 128                              const XFontStruct * const _font,
 129                              int _function, int _subwindow) {
 130   const unsigned long pixel = _color.pixel();
 131   const unsigned int screen = _color.screen();
 132   const int key = _color.red() ^ _color.green() ^ _color.blue();
 133   int k = (key % cache_size) * cache_buckets;
 134   int i = 0; // loop variable
 135   BGCCacheItem *c = cache[ k ], *prev = 0;
 136
 137   // this will either loop 8 times then return/abort or it will stop matching
 138   while (c->ctx &&
 139          (c->ctx->pixel != pixel || c->ctx->function != _function ||
 140           c->ctx->subwindow != _subwindow || c->ctx->screen != screen)) {
 141     if (i < 7) {
 142       prev = c;
 143       c = cache[ ++k ];
 144       ++i;
 145       continue;
 146     }
 147     if (c->count == 0 && c->ctx->screen == screen) {
 148       // use this cache item
 149       c->ctx->set(_color, _font, _function, _subwindow);
 150       c->ctx->used = true;
 151       c->count = 1;
 152       c->hits = 1;
 153       return c;
 154     }
 155     // cache fault!
 156     fprintf(stderr, "BGCCache: cache fault\n");
 157     abort();
 158   }
 159
 160   const unsigned long fontid = _font ? _font->fid : 0;
 161   if (c->ctx) {
 162     // reuse existing context
 163     if (fontid && fontid != c->ctx->fontid)
 164       c->ctx->set(_font);
 165     c->count++;
 166     c->hits++;
 167     if (prev && c->hits > prev->hits) {
 168       cache[ k     ] = prev;
 169       cache[ k - 1 ] = c;
 170     }
 171   } else {
 172     c->ctx = nextContext(screen);
 173     c->ctx->set(_color, _font, _function, _subwindow);
 174     c->ctx->used = true;
 175     c->count = 1;
 176     c->hits = 1;
 177   }
 178
 179   return c;
 180 }
 181
 182
 183 void BGCCache::release(BGCCacheItem *_item) {
 184   _item->count--;
 185 }
 186
 187
 188 void BGCCache::purge(void) {
 189   for (unsigned int i = 0; i < cache_total_size; ++i) {
 190     BGCCacheItem *d = cache[ i ];
 191
 192     if (d->ctx && d->count == 0) {
 193       release(d->ctx);
 194       d->ctx = 0;
 195     }
 196   }
 197 }