Home | History | Annotate | Download | only in pcf
      1 /*  pcf.h
      2 
      3   FreeType font driver for pcf fonts
      4 
      5   Copyright (C) 2000, 2001, 2002, 2003, 2006, 2010 by
      6   Francesco Zappa Nardelli
      7 
      8 Permission is hereby granted, free of charge, to any person obtaining a copy
      9 of this software and associated documentation files (the "Software"), to deal
     10 in the Software without restriction, including without limitation the rights
     11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     12 copies of the Software, and to permit persons to whom the Software is
     13 furnished to do so, subject to the following conditions:
     14 
     15 The above copyright notice and this permission notice shall be included in
     16 all copies or substantial portions of the Software.
     17 
     18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     19 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     20 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
     21 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     22 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     23 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     24 THE SOFTWARE.
     25 */
     26 
     27 
     28 #ifndef PCF_H_
     29 #define PCF_H_
     30 
     31 
     32 #include <ft2build.h>
     33 #include FT_INTERNAL_DRIVER_H
     34 #include FT_INTERNAL_STREAM_H
     35 
     36 
     37 FT_BEGIN_HEADER
     38 
     39   typedef struct  PCF_TableRec_
     40   {
     41     FT_ULong  type;
     42     FT_ULong  format;
     43     FT_ULong  size;
     44     FT_ULong  offset;
     45 
     46   } PCF_TableRec, *PCF_Table;
     47 
     48 
     49   typedef struct  PCF_TocRec_
     50   {
     51     FT_ULong   version;
     52     FT_ULong   count;
     53     PCF_Table  tables;
     54 
     55   } PCF_TocRec, *PCF_Toc;
     56 
     57 
     58   typedef struct  PCF_ParsePropertyRec_
     59   {
     60     FT_Long  name;
     61     FT_Byte  isString;
     62     FT_Long  value;
     63 
     64   } PCF_ParsePropertyRec, *PCF_ParseProperty;
     65 
     66 
     67   typedef struct  PCF_PropertyRec_
     68   {
     69     FT_String*  name;
     70     FT_Byte     isString;
     71 
     72     union
     73     {
     74       FT_String*  atom;
     75       FT_Long     l;
     76       FT_ULong    ul;
     77 
     78     } value;
     79 
     80   } PCF_PropertyRec, *PCF_Property;
     81 
     82 
     83   typedef struct  PCF_Compressed_MetricRec_
     84   {
     85     FT_Byte  leftSideBearing;
     86     FT_Byte  rightSideBearing;
     87     FT_Byte  characterWidth;
     88     FT_Byte  ascent;
     89     FT_Byte  descent;
     90 
     91   } PCF_Compressed_MetricRec, *PCF_Compressed_Metric;
     92 
     93 
     94   typedef struct  PCF_MetricRec_
     95   {
     96     FT_Short  leftSideBearing;
     97     FT_Short  rightSideBearing;
     98     FT_Short  characterWidth;
     99     FT_Short  ascent;
    100     FT_Short  descent;
    101     FT_Short  attributes;
    102     FT_ULong  bits;
    103 
    104   } PCF_MetricRec, *PCF_Metric;
    105 
    106 
    107   typedef struct  PCF_AccelRec_
    108   {
    109     FT_Byte        noOverlap;
    110     FT_Byte        constantMetrics;
    111     FT_Byte        terminalFont;
    112     FT_Byte        constantWidth;
    113     FT_Byte        inkInside;
    114     FT_Byte        inkMetrics;
    115     FT_Byte        drawDirection;
    116     FT_Long        fontAscent;
    117     FT_Long        fontDescent;
    118     FT_Long        maxOverlap;
    119     PCF_MetricRec  minbounds;
    120     PCF_MetricRec  maxbounds;
    121     PCF_MetricRec  ink_minbounds;
    122     PCF_MetricRec  ink_maxbounds;
    123 
    124   } PCF_AccelRec, *PCF_Accel;
    125 
    126 
    127   /*
    128    * This file uses X11 terminology for PCF data; an `encoding' in X11 speak
    129    * is the same as a `character code' in FreeType speak.
    130    */
    131   typedef struct  PCF_EncodingRec_
    132   {
    133     FT_ULong   enc;
    134     FT_UShort  glyph;  /* an index into PCF_Face's `metrics' array */
    135 
    136   } PCF_EncodingRec, *PCF_Encoding;
    137 
    138 
    139   typedef struct  PCF_FaceRec_
    140   {
    141     FT_FaceRec     root;
    142 
    143     FT_StreamRec   comp_stream;
    144     FT_Stream      comp_source;
    145 
    146     char*          charset_encoding;
    147     char*          charset_registry;
    148 
    149     PCF_TocRec     toc;
    150     PCF_AccelRec   accel;
    151 
    152     int            nprops;
    153     PCF_Property   properties;
    154 
    155     FT_ULong       nmetrics;
    156     PCF_Metric     metrics;
    157     FT_ULong       nencodings;
    158     PCF_Encoding   encodings;
    159 
    160     FT_UShort      defaultChar;
    161 
    162     FT_ULong       bitmapsFormat;
    163 
    164     FT_CharMap     charmap_handle;
    165     FT_CharMapRec  charmap;  /* a single charmap per face */
    166 
    167   } PCF_FaceRec, *PCF_Face;
    168 
    169 
    170   typedef struct  PCF_DriverRec_
    171   {
    172     FT_DriverRec  root;
    173 
    174     FT_Bool  no_long_family_names;
    175 
    176   } PCF_DriverRec, *PCF_Driver;
    177 
    178 
    179   /* macros for pcf font format */
    180 
    181 #define LSBFirst  0
    182 #define MSBFirst  1
    183 
    184 #define PCF_FILE_VERSION        ( ( 'p' << 24 ) | \
    185                                   ( 'c' << 16 ) | \
    186                                   ( 'f' <<  8 ) | 1 )
    187 #define PCF_FORMAT_MASK         0xFFFFFF00UL
    188 
    189 #define PCF_DEFAULT_FORMAT      0x00000000UL
    190 #define PCF_INKBOUNDS           0x00000200UL
    191 #define PCF_ACCEL_W_INKBOUNDS   0x00000100UL
    192 #define PCF_COMPRESSED_METRICS  0x00000100UL
    193 
    194 #define PCF_FORMAT_MATCH( a, b ) \
    195           ( ( (a) & PCF_FORMAT_MASK ) == ( (b) & PCF_FORMAT_MASK ) )
    196 
    197 #define PCF_GLYPH_PAD_MASK  ( 3 << 0 )
    198 #define PCF_BYTE_MASK       ( 1 << 2 )
    199 #define PCF_BIT_MASK        ( 1 << 3 )
    200 #define PCF_SCAN_UNIT_MASK  ( 3 << 4 )
    201 
    202 #define PCF_BYTE_ORDER( f ) \
    203           ( ( (f) & PCF_BYTE_MASK ) ? MSBFirst : LSBFirst )
    204 #define PCF_BIT_ORDER( f ) \
    205           ( ( (f) & PCF_BIT_MASK ) ? MSBFirst : LSBFirst )
    206 #define PCF_GLYPH_PAD_INDEX( f ) \
    207           ( (f) & PCF_GLYPH_PAD_MASK )
    208 #define PCF_GLYPH_PAD( f ) \
    209           ( 1 << PCF_GLYPH_PAD_INDEX( f ) )
    210 #define PCF_SCAN_UNIT_INDEX( f ) \
    211           ( ( (f) & PCF_SCAN_UNIT_MASK ) >> 4 )
    212 #define PCF_SCAN_UNIT( f ) \
    213           ( 1 << PCF_SCAN_UNIT_INDEX( f ) )
    214 #define PCF_FORMAT_BITS( f )             \
    215           ( (f) & ( PCF_GLYPH_PAD_MASK | \
    216                     PCF_BYTE_MASK      | \
    217                     PCF_BIT_MASK       | \
    218                     PCF_SCAN_UNIT_MASK ) )
    219 
    220 #define PCF_SIZE_TO_INDEX( s )  ( (s) == 4 ? 2 : (s) == 2 ? 1 : 0 )
    221 #define PCF_INDEX_TO_SIZE( b )  ( 1 << b )
    222 
    223 #define PCF_FORMAT( bit, byte, glyph, scan )          \
    224           ( ( PCF_SIZE_TO_INDEX( scan )      << 4 ) | \
    225             ( ( (bit)  == MSBFirst ? 1 : 0 ) << 3 ) | \
    226             ( ( (byte) == MSBFirst ? 1 : 0 ) << 2 ) | \
    227             ( PCF_SIZE_TO_INDEX( glyph )     << 0 ) )
    228 
    229 #define PCF_PROPERTIES        ( 1 << 0 )
    230 #define PCF_ACCELERATORS      ( 1 << 1 )
    231 #define PCF_METRICS           ( 1 << 2 )
    232 #define PCF_BITMAPS           ( 1 << 3 )
    233 #define PCF_INK_METRICS       ( 1 << 4 )
    234 #define PCF_BDF_ENCODINGS     ( 1 << 5 )
    235 #define PCF_SWIDTHS           ( 1 << 6 )
    236 #define PCF_GLYPH_NAMES       ( 1 << 7 )
    237 #define PCF_BDF_ACCELERATORS  ( 1 << 8 )
    238 
    239 #define GLYPHPADOPTIONS  4 /* I'm not sure about this */
    240 
    241   FT_LOCAL( FT_Error )
    242   pcf_load_font( FT_Stream  stream,
    243                  PCF_Face   face,
    244                  FT_Long    face_index );
    245 
    246 FT_END_HEADER
    247 
    248 #endif /* PCF_H_ */
    249 
    250 
    251 /* END */
    252