summaryrefslogtreecommitdiff
path: root/src/cache/ftcbasic.c
blob: 4e7209af81246ba8f0a66e473dc8b2a5c32d571e (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
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/***************************************************************************/
/*                                                                         */
/*  ftcbasic.c                                                             */
/*                                                                         */
/*    The FreeType basic cache interface (body).                           */
/*                                                                         */
/*  Copyright 2003, 2004, 2005 by                                          */
/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */
/*                                                                         */
/*  This file is part of the FreeType project, and may only be used,       */
/*  modified, and distributed under the terms of the FreeType project      */
/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */
/*  this file you indicate that you have read the license and              */
/*  understand and accept it fully.                                        */
/*                                                                         */
/***************************************************************************/


#include <ft2build.h>
#include FT_CACHE_H
#include FT_CACHE_INTERNAL_GLYPH_H
#include FT_CACHE_INTERNAL_IMAGE_H
#include FT_CACHE_INTERNAL_SBITS_H
#include FT_INTERNAL_MEMORY_H

#include "ftcerror.h"


  /*
   *  Basic Families
   *
   */
  typedef struct  FTC_BasicFamilyRec_
  {
    FTC_FamilyRec   family;
    FTC_ScalerRec   scaler;
    FT_UInt         load_flags;

  } FTC_BasicFamilyRec, *FTC_BasicFamily;


#define  FTC_BASIC_FAMILY_HASH(f)  \
     ( FTC_SCALER_HASH( &(f)->scaler ) + 31*(f)->load_flags )


  FT_CALLBACK_DEF( FT_Bool )
  ftc_basic_family_equal( FTC_BasicFamily  family,
                          FTC_BasicFamily  query )
  {
    return ( FTC_SCALER_COMPARE( &(family)->scaler, &(query)->scaler ) &&
             family->load_flags == query->load_flags                   );
  }


  FT_CALLBACK_DEF( FT_Bool )
  ftc_basic_family_equal_faceid( FTC_BasicFamily  family,
                                 FTC_FaceID       face_id )
  {
    return FT_BOOL( family->scaler.face_id == face_id );
  }


  FT_CALLBACK_DEF( FT_UInt )
  ftc_basic_family_get_count( FTC_BasicFamily  family,
                              FTC_Manager      manager )
  {
    FT_Error  error;
    FT_Face   face;
    FT_UInt   result = 0;


    error = FTC_Manager_LookupFace( manager, family->scaler.face_id, &face );
    if ( !error )
      result = face->num_glyphs;

    return result;
  }


  FT_CALLBACK_DEF( FT_Error )
  ftc_basic_family_load_bitmap( FTC_BasicFamily  family,
                                FT_UInt          gindex,
                                FTC_Manager      manager,
                                FT_Face         *aface )
  {
    FT_Error         error;
    FT_Size          size;


    error = FTC_Manager_LookupSize( manager, &family->scaler, &size );
    if ( !error )
    {
      FT_Face  face = size->face;


      error = FT_Load_Glyph( face, gindex,
                             family->load_flags | FT_LOAD_RENDER );
      if ( !error )
        *aface = face;
    }

    return error;
  }


  FT_CALLBACK_DEF( FT_Error )
  ftc_basic_family_load_glyph( FTC_BasicFamily  family,
                               FT_UInt          gindex,
                               FTC_Manager      manager,
                               FT_Glyph        *aglyph )
  {
    FT_Error    error;
    FTC_Scaler  scaler = &family->scaler;
    FT_Face     face;
    FT_Size     size;


    /* we will now load the glyph image */
    error = FTC_Manager_LookupSize( manager, scaler, &size );
    if ( !error )
    {
      face = size->face;

      error = FT_Load_Glyph( face, gindex, family->load_flags );
      if ( !error )
      {
        if ( face->glyph->format == FT_GLYPH_FORMAT_BITMAP  ||
             face->glyph->format == FT_GLYPH_FORMAT_OUTLINE )
        {
          /* ok, copy it */
          FT_Glyph  glyph;


          error = FT_Get_Glyph( face->glyph, &glyph );
          if ( !error )
          {
            *aglyph = glyph;
            goto Exit;
          }
        }
        else
          error = FTC_Err_Invalid_Argument;
      }
    }

  Exit:
    return error;
  }


 /*
  *
  * basic image cache
  *
  */

  FT_CALLBACK_TABLE_DEF
  const FTC_ICacheClassRec  ftc_basic_image_cache_class =
  FTC_DEFINE_ICACHE_CLASS(
      FTC_DEFINE_GCACHE_CLASS(
          FTC_DEFINE_CACHE_CLASS(
              FTC_INode_New,
              FTC_INode_Weight,
              FTC_GNode_Equal,
              FTC_GNode_EqualFaceID,
              FTC_INode_Free,
              FTC_GCacheRec,
              FTC_GCache_Init,
              FTC_GCache_Done 
           ),
           FTC_DEFINE_FAMILY_CLASS(
              FTC_BasicFamilyRec,
              0 /* init */,
              0 /* done */,
              ftc_basic_family_equal,
              ftc_basic_family_equal_faceid
           )
      ),
      ftc_basic_family_load_glyph
  );

  /* documentation is in ftcache.h */

  FT_EXPORT_DEF( FT_Error )
  FTC_ImageCache_New( FTC_Manager      manager,
                      FTC_ImageCache  *acache )
  {
    return FTC_Manager_RegisterCache( manager,
                          (FTC_CacheClass) &ftc_basic_image_cache_class,
                          (FTC_Cache*)acache );
  }


  /* documentation is in ftcache.h */

  FT_EXPORT_DEF( FT_Error )
  FTC_ImageCache_Lookup( FTC_ImageCache  cache,
                         FTC_ImageType   type,
                         FT_UInt         gindex,
                         FT_Glyph       *aglyph,
                         FTC_Node       *anode )
  {
    FTC_BasicFamilyRec  key_family;
    FTC_GNodeRec        key;
    FTC_Node            node = 0;  /* make compiler happy */
    FT_Error            error;
    FT_UInt32           hash;


    /* some argument checks are delayed to FTC_Cache_Lookup */
    if ( !aglyph )
    {
      error = FTC_Err_Invalid_Argument;
      goto Exit;
    }

    *aglyph = NULL;
    if ( anode )
      *anode  = NULL;

    key_family.scaler.face_id = type->face_id;
    key_family.scaler.width   = type->width;
    key_family.scaler.height  = type->height;
    key_family.scaler.pixel   = 1;
    key_family.scaler.x_res   = 0;  /* make compilers happy */
    key_family.scaler.y_res   = 0;
    key_family.load_flags     = type->flags;

    hash = FTC_BASIC_FAMILY_HASH( &key_family );

    FTC_GCACHE_GET_FAMILY( cache, ftc_basic_family_equal,
                           hash, &key_family, &key.family, error );
    if ( !error )
    {
      hash      += gindex;
      key.gindex = gindex;

      FTC_CACHE_LOOKUP_CMP( cache, FTC_GNODE_EQUAL, hash,
                            &key, node, error );
      if ( !error )
      {
        *aglyph = FTC_INODE( node )->glyph;

        if ( anode )
          *anode = FTC_NODE_REF( node );
      }

      FTC_Family_Unref( FTC_FAMILY(key.family) );
    }

  Exit:
    return error;
  }


 /*
  *
  * basic small bitmap cache
  *
  */
  FT_CALLBACK_TABLE_DEF
  const FTC_SCacheClassRec  ftc_basic_sbit_cache_class =
  FTC_DEFINE_SCACHE_CLASS(
      FTC_DEFINE_GCACHE_CLASS(
          FTC_DEFINE_CACHE_CLASS(
              FTC_SNode_New,
              FTC_SNode_Weight,
              FTC_SNode_Equal,
              FTC_GNode_EqualFaceID,
              FTC_SNode_Free,
              FTC_GCacheRec,
              FTC_GCache_Init,
              FTC_GCache_Done
          ),
          FTC_DEFINE_FAMILY_CLASS(
              FTC_BasicFamilyRec,
              0 /* init */,
              0 /* done */,
              ftc_basic_family_equal,
              ftc_basic_family_equal_faceid
          )
      ),
      ftc_basic_family_get_count,
      ftc_basic_family_load_bitmap
  );

  /* documentation is in ftcache.h */

  FT_EXPORT_DEF( FT_Error )
  FTC_SBitCache_New( FTC_Manager     manager,
                     FTC_SBitCache  *acache )
  {
    return FTC_Manager_RegisterCache( manager,
                          (FTC_CacheClass) &ftc_basic_sbit_cache_class,
                          (FTC_Cache*)acache );
  }


  /* documentation is in ftcache.h */

  FT_EXPORT_DEF( FT_Error )
  FTC_SBitCache_Lookup( FTC_SBitCache  cache,
                        FTC_ImageType  type,
                        FT_UInt        gindex,
                        FTC_SBit      *ansbit,
                        FTC_Node      *anode )
  {
    FTC_BasicFamilyRec  key_family;
    FTC_GNodeRec        key;
    FT_Error            error;
    FTC_Node            node = 0; /* make compiler happy */
    FT_UInt32           hash;


    if ( anode )
      *anode = NULL;

    /* other argument checks delayed to FTC_Cache_Lookup */
    if ( !ansbit )
      return FTC_Err_Invalid_Argument;

    *ansbit = NULL;

    key_family.scaler.face_id = type->face_id;
    key_family.scaler.width   = type->width;
    key_family.scaler.height  = type->height;
    key_family.scaler.pixel   = 1;
    key_family.scaler.x_res   = 0;  /* make compilers happy */
    key_family.scaler.y_res   = 0;
    key_family.load_flags     = type->flags;

    hash = FTC_BASIC_FAMILY_HASH( &key_family );

    FTC_GCACHE_GET_FAMILY( cache, ftc_basic_family_equal,
                           hash, &key_family, &key.family, error );
    if ( !error )
    {
      /* beware, the hash must be the same for all glyph ranges */
      hash += gindex/FTC_SBIT_ITEMS_PER_NODE;

      key.gindex = gindex;

      FTC_CACHE_LOOKUP_CMP( cache, FTC_SNODE_EQUAL, hash,
                            &key, node, error );
      if ( !error )
      {
        *ansbit = FTC_SNODE(node)->sbits + ( gindex - FTC_GNODE(node)->gindex );

        if ( anode )
          *anode = FTC_NODE_REF(node);
      }

      FTC_Family_Unref( FTC_FAMILY(key.family) );
    }

    return error;
  }

/* END */