pcf.h File Reference

#include <ft2build.h>

Include dependency graph for pcf.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	PCF_TableRec_
struct	PCF_TocRec_
struct	PCF_ParsePropertyRec_
struct	PCF_PropertyRec_
struct	PCF_Compressed_MetricRec_
struct	PCF_MetricRec_
struct	PCF_EncRec_
struct	PCF_AccelRec_
struct	PCF_FaceRec_
struct	PCF_DriverRec_

Macros
#define	LSBFirst   0
#define	MSBFirst   1
#define	PCF_FILE_VERSION
#define	PCF_FORMAT_MASK   0xFFFFFF00UL
#define	PCF_DEFAULT_FORMAT   0x00000000UL
#define	PCF_INKBOUNDS   0x00000200UL
#define	PCF_ACCEL_W_INKBOUNDS   0x00000100UL
#define	PCF_COMPRESSED_METRICS   0x00000100UL
#define	PCF_FORMAT_MATCH(a, b)    ( ( (a) & PCF_FORMAT_MASK ) == ( (b) & PCF_FORMAT_MASK ) )
#define	PCF_GLYPH_PAD_MASK   ( 3 << 0 )
#define	PCF_BYTE_MASK   ( 1 << 2 )
#define	PCF_BIT_MASK   ( 1 << 3 )
#define	PCF_SCAN_UNIT_MASK   ( 3 << 4 )
#define	PCF_BYTE_ORDER(f)    ( ( (f) & PCF_BYTE_MASK ) ? MSBFirst : LSBFirst )
#define	PCF_BIT_ORDER(f)    ( ( (f) & PCF_BIT_MASK ) ? MSBFirst : LSBFirst )
#define	PCF_GLYPH_PAD_INDEX(f)    ( (f) & PCF_GLYPH_PAD_MASK )
#define	PCF_GLYPH_PAD(f)    ( 1 << PCF_GLYPH_PAD_INDEX( f ) )
#define	PCF_SCAN_UNIT_INDEX(f)    ( ( (f) & PCF_SCAN_UNIT_MASK ) >> 4 )
#define	PCF_SCAN_UNIT(f)    ( 1 << PCF_SCAN_UNIT_INDEX( f ) )
#define	PCF_FORMAT_BITS(f)
#define	PCF_SIZE_TO_INDEX(s)   ( (s) == 4 ? 2 : (s) == 2 ? 1 : 0 )
#define	PCF_INDEX_TO_SIZE(b)   ( 1 << b )
#define	PCF_FORMAT(bit, byte, glyph, scan)
#define	PCF_PROPERTIES   ( 1 << 0 )
#define	PCF_ACCELERATORS   ( 1 << 1 )
#define	PCF_METRICS   ( 1 << 2 )
#define	PCF_BITMAPS   ( 1 << 3 )
#define	PCF_INK_METRICS   ( 1 << 4 )
#define	PCF_BDF_ENCODINGS   ( 1 << 5 )
#define	PCF_SWIDTHS   ( 1 << 6 )
#define	PCF_GLYPH_NAMES   ( 1 << 7 )
#define	PCF_BDF_ACCELERATORS   ( 1 << 8 )
#define	GLYPHPADOPTIONS   4 /* I'm not sure about this */

Typedefs
typedef FT_BEGIN_HEADER struct PCF_TableRec_	PCF_TableRec
typedef FT_BEGIN_HEADER struct PCF_TableRec_ *	PCF_Table
typedef struct PCF_TocRec_	PCF_TocRec
typedef struct PCF_TocRec_ *	PCF_Toc
typedef struct PCF_ParsePropertyRec_	PCF_ParsePropertyRec
typedef struct PCF_ParsePropertyRec_ *	PCF_ParseProperty
typedef struct PCF_PropertyRec_	PCF_PropertyRec
typedef struct PCF_PropertyRec_ *	PCF_Property
typedef struct PCF_Compressed_MetricRec_	PCF_Compressed_MetricRec
typedef struct PCF_Compressed_MetricRec_ *	PCF_Compressed_Metric
typedef struct PCF_MetricRec_	PCF_MetricRec
typedef struct PCF_MetricRec_ *	PCF_Metric
typedef struct PCF_EncRec_	PCF_EncRec
typedef struct PCF_EncRec_ *	PCF_Enc
typedef struct PCF_AccelRec_	PCF_AccelRec
typedef struct PCF_AccelRec_ *	PCF_Accel
typedef struct PCF_FaceRec_	PCF_FaceRec
typedef struct PCF_FaceRec_ *	PCF_Face
typedef struct PCF_DriverRec_	PCF_DriverRec
typedef struct PCF_DriverRec_ *	PCF_Driver

Functions
	pcf_load_font (FT_Stream stream, PCF_Face face, FT_Long face_index)

Macro Definition Documentation

GLYPHPADOPTIONS

#define GLYPHPADOPTIONS   4 /* I'm not sure about this */

Definition at line 239 of file pcf.h.

LSBFirst

#define LSBFirst   0

Definition at line 181 of file pcf.h.

MSBFirst

#define MSBFirst   1

Definition at line 182 of file pcf.h.

PCF_ACCEL_W_INKBOUNDS

#define PCF_ACCEL_W_INKBOUNDS   0x00000100UL

Definition at line 191 of file pcf.h.

PCF_ACCELERATORS

#define PCF_ACCELERATORS   ( 1 << 1 )

Definition at line 230 of file pcf.h.

PCF_BDF_ACCELERATORS

#define PCF_BDF_ACCELERATORS   ( 1 << 8 )

Definition at line 237 of file pcf.h.

PCF_BDF_ENCODINGS

#define PCF_BDF_ENCODINGS   ( 1 << 5 )

Definition at line 234 of file pcf.h.

PCF_BIT_MASK

#define PCF_BIT_MASK   ( 1 << 3 )

Definition at line 199 of file pcf.h.

PCF_BIT_ORDER

#define PCF_BIT_ORDER

(

f

)

( ( (f) & PCF_BIT_MASK ) ? MSBFirst : LSBFirst )

Definition at line 204 of file pcf.h.

PCF_BITMAPS

#define PCF_BITMAPS   ( 1 << 3 )

Definition at line 232 of file pcf.h.

PCF_BYTE_MASK

#define PCF_BYTE_MASK   ( 1 << 2 )

Definition at line 198 of file pcf.h.

PCF_BYTE_ORDER

#define PCF_BYTE_ORDER

(

f

)

( ( (f) & PCF_BYTE_MASK ) ? MSBFirst : LSBFirst )

Definition at line 202 of file pcf.h.

PCF_COMPRESSED_METRICS

#define PCF_COMPRESSED_METRICS   0x00000100UL

Definition at line 192 of file pcf.h.

PCF_DEFAULT_FORMAT

#define PCF_DEFAULT_FORMAT   0x00000000UL

Definition at line 189 of file pcf.h.

PCF_FILE_VERSION

#define PCF_FILE_VERSION

Value:

                                  ( ( 'p' << 24 ) | \
                                  ( 'c' << 16 ) | \
                                  ( 'f' <<  8 ) | 1 )

Definition at line 184 of file pcf.h.

PCF_FORMAT

#define PCF_FORMAT	(		bit,
			byte,
			glyph,
			scan
	)

Value:

          ( ( PCF_SIZE_TO_INDEX( scan )      << 4 ) | \
            ( ( (bit)  == MSBFirst ? 1 : 0 ) << 3 ) | \
            ( ( (byte) == MSBFirst ? 1 : 0 ) << 2 ) | \
            ( PCF_SIZE_TO_INDEX( glyph )     << 0 ) )

Definition at line 223 of file pcf.h.

PCF_FORMAT_BITS

#define PCF_FORMAT_BITS

(

f

)

Value:

          ( (f) & ( PCF_GLYPH_PAD_MASK | \
                    PCF_BYTE_MASK      | \
                    PCF_BIT_MASK       | \
                    PCF_SCAN_UNIT_MASK ) )

Definition at line 214 of file pcf.h.

PCF_FORMAT_MASK

#define PCF_FORMAT_MASK   0xFFFFFF00UL

Definition at line 187 of file pcf.h.

PCF_FORMAT_MATCH

#define PCF_FORMAT_MATCH	(		a,
			b
	)		( ( (a) & PCF_FORMAT_MASK ) == ( (b) & PCF_FORMAT_MASK ) )

Definition at line 194 of file pcf.h.

PCF_GLYPH_NAMES

#define PCF_GLYPH_NAMES   ( 1 << 7 )

Definition at line 236 of file pcf.h.

PCF_GLYPH_PAD

#define PCF_GLYPH_PAD

(

f

)

( 1 << PCF_GLYPH_PAD_INDEX( f ) )

Definition at line 208 of file pcf.h.

PCF_GLYPH_PAD_INDEX

#define PCF_GLYPH_PAD_INDEX

(

f

)

( (f) & PCF_GLYPH_PAD_MASK )

Definition at line 206 of file pcf.h.

PCF_GLYPH_PAD_MASK

#define PCF_GLYPH_PAD_MASK   ( 3 << 0 )

Definition at line 197 of file pcf.h.

PCF_INDEX_TO_SIZE

#define PCF_INDEX_TO_SIZE

(

b

)

( 1 << b )

Definition at line 221 of file pcf.h.

PCF_INK_METRICS

#define PCF_INK_METRICS   ( 1 << 4 )

Definition at line 233 of file pcf.h.

PCF_INKBOUNDS

#define PCF_INKBOUNDS   0x00000200UL

Definition at line 190 of file pcf.h.

PCF_METRICS

#define PCF_METRICS   ( 1 << 2 )

Definition at line 231 of file pcf.h.

PCF_PROPERTIES

#define PCF_PROPERTIES   ( 1 << 0 )

Definition at line 229 of file pcf.h.

PCF_SCAN_UNIT

#define PCF_SCAN_UNIT

(

f

)

( 1 << PCF_SCAN_UNIT_INDEX( f ) )

Definition at line 212 of file pcf.h.

PCF_SCAN_UNIT_INDEX

#define PCF_SCAN_UNIT_INDEX

(

f

)

( ( (f) & PCF_SCAN_UNIT_MASK ) >> 4 )

Definition at line 210 of file pcf.h.

PCF_SCAN_UNIT_MASK

#define PCF_SCAN_UNIT_MASK   ( 3 << 4 )

Definition at line 200 of file pcf.h.

PCF_SIZE_TO_INDEX

#define PCF_SIZE_TO_INDEX

(

s

)

( (s) == 4 ? 2 : (s) == 2 ? 1 : 0 )

Definition at line 220 of file pcf.h.

PCF_SWIDTHS

#define PCF_SWIDTHS   ( 1 << 6 )

Definition at line 235 of file pcf.h.

Typedef Documentation

PCF_Accel

typedef struct PCF_AccelRec_ * PCF_Accel

PCF_AccelRec

typedef struct PCF_AccelRec_ PCF_AccelRec

PCF_Compressed_Metric

typedef struct PCF_Compressed_MetricRec_ * PCF_Compressed_Metric

PCF_Compressed_MetricRec

typedef struct PCF_Compressed_MetricRec_ PCF_Compressed_MetricRec

PCF_Driver

typedef struct PCF_DriverRec_ * PCF_Driver

PCF_DriverRec

typedef struct PCF_DriverRec_ PCF_DriverRec

PCF_Enc

typedef struct PCF_EncRec_ * PCF_Enc

PCF_EncRec

typedef struct PCF_EncRec_ PCF_EncRec

PCF_Face

typedef struct PCF_FaceRec_ * PCF_Face

PCF_FaceRec

typedef struct PCF_FaceRec_ PCF_FaceRec

PCF_Metric

typedef struct PCF_MetricRec_ * PCF_Metric

PCF_MetricRec

typedef struct PCF_MetricRec_ PCF_MetricRec

PCF_ParseProperty

typedef struct PCF_ParsePropertyRec_ * PCF_ParseProperty

PCF_ParsePropertyRec

typedef struct PCF_ParsePropertyRec_ PCF_ParsePropertyRec

PCF_Property

typedef struct PCF_PropertyRec_ * PCF_Property

PCF_PropertyRec

typedef struct PCF_PropertyRec_ PCF_PropertyRec

PCF_Table

typedef FT_BEGIN_HEADER struct PCF_TableRec_ * PCF_Table

PCF_TableRec

typedef FT_BEGIN_HEADER struct PCF_TableRec_ PCF_TableRec

PCF_Toc

typedef struct PCF_TocRec_ * PCF_Toc

PCF_TocRec

typedef struct PCF_TocRec_ PCF_TocRec

Function Documentation

pcf_load_font()

pcf_load_font	(	FT_Stream	stream,
		PCF_Face	face,
		FT_Long	face_index
	)

Definition at line 1408 of file pcfread.c.

  {
    FT_Face    root   = FT_FACE( face );
    FT_Error   error;
    FT_Memory  memory = FT_FACE( face )->memory;
    FT_Bool    hasBDFAccelerators;
 
 
    error = pcf_read_TOC( stream, face );
    if ( error )
      goto Exit;
 
    root->num_faces  = 1;
    root->face_index = 0;
 
    /* If we are performing a simple font format check, exit immediately. */
    if ( face_index < 0 )
      return FT_Err_Ok;
 
    error = pcf_get_properties( stream, face );
    if ( error )
      goto Exit;
 
    /* Use the old accelerators if no BDF accelerators are in the file. */
    hasBDFAccelerators = pcf_has_table_type( face->toc.tables,
                                             face->toc.count,
                                             PCF_BDF_ACCELERATORS );
    if ( !hasBDFAccelerators )
    {
      error = pcf_get_accel( stream, face, PCF_ACCELERATORS );
      if ( error )
        goto Exit;
    }
 
    /* metrics */
    error = pcf_get_metrics( stream, face );
    if ( error )
      goto Exit;
 
    /* bitmaps */
    error = pcf_get_bitmaps( stream, face );
    if ( error )
      goto Exit;
 
    /* encodings */
    error = pcf_get_encodings( stream, face );
    if ( error )
      goto Exit;
 
    /* BDF style accelerators (i.e. bounds based on encoded glyphs) */
    if ( hasBDFAccelerators )
    {
      error = pcf_get_accel( stream, face, PCF_BDF_ACCELERATORS );
      if ( error )
        goto Exit;
    }
 
    /* XXX: TO DO: inkmetrics and glyph_names are missing */
 
    /* now construct the face object */
    {
      PCF_Property  prop;
 
 
      root->face_flags |= FT_FACE_FLAG_FIXED_SIZES |
                          FT_FACE_FLAG_HORIZONTAL;
 
      if ( face->accel.constantWidth )
        root->face_flags |= FT_FACE_FLAG_FIXED_WIDTH;
 
      if ( FT_SET_ERROR( pcf_interpret_style( face ) ) )
        goto Exit;
 
      prop = pcf_find_property( face, "FAMILY_NAME" );
      if ( prop && prop->isString )
      {
 
#ifdef PCF_CONFIG_OPTION_LONG_FAMILY_NAMES
 
        PCF_Driver  driver = (PCF_Driver)FT_FACE_DRIVER( face );
 
 
        if ( !driver->no_long_family_names )
        {
          /* Prepend the foundry name plus a space to the family name.     */
          /* There are many fonts just called `Fixed' which look           */
          /* completely different, and which have nothing to do with each  */
          /* other.  When selecting `Fixed' in KDE or Gnome one gets       */
          /* results that appear rather random, the style changes often if */
          /* one changes the size and one cannot select some fonts at all. */
          /*                                                               */
          /* We also check whether we have `wide' characters; all put      */
          /* together, we get family names like `Sony Fixed' or `Misc      */
          /* Fixed Wide'.                                                  */
 
          PCF_Property  foundry_prop, point_size_prop, average_width_prop;
 
          int  l    = ft_strlen( prop->value.atom ) + 1;
          int  wide = 0;
 
 
          foundry_prop       = pcf_find_property( face, "FOUNDRY" );
          point_size_prop    = pcf_find_property( face, "POINT_SIZE" );
          average_width_prop = pcf_find_property( face, "AVERAGE_WIDTH" );
 
          if ( point_size_prop && average_width_prop )
          {
            if ( average_width_prop->value.l >= point_size_prop->value.l )
            {
              /* This font is at least square shaped or even wider */
              wide = 1;
              l   += ft_strlen( " Wide" );
            }
          }
 
          if ( foundry_prop && foundry_prop->isString )
          {
            l += ft_strlen( foundry_prop->value.atom ) + 1;
 
            if ( FT_NEW_ARRAY( root->family_name, l ) )
              goto Exit;
 
            ft_strcpy( root->family_name, foundry_prop->value.atom );
            ft_strcat( root->family_name, " " );
            ft_strcat( root->family_name, prop->value.atom );
          }
          else
          {
            if ( FT_NEW_ARRAY( root->family_name, l ) )
              goto Exit;
 
            ft_strcpy( root->family_name, prop->value.atom );
          }
 
          if ( wide )
            ft_strcat( root->family_name, " Wide" );
        }
        else
 
#endif /* PCF_CONFIG_OPTION_LONG_FAMILY_NAMES */
 
        {
          if ( FT_STRDUP( root->family_name, prop->value.atom ) )
            goto Exit;
        }
      }
      else
        root->family_name = NULL;
 
      root->num_glyphs = (FT_Long)face->nmetrics;
 
      root->num_fixed_sizes = 1;
      if ( FT_NEW_ARRAY( root->available_sizes, 1 ) )
        goto Exit;
 
      {
        FT_Bitmap_Size*  bsize = root->available_sizes;
        FT_Short         resolution_x = 0, resolution_y = 0;
 
 
        FT_ZERO( bsize );
 
        /* for simplicity, we take absolute values of integer properties */
 
#if 0
        bsize->height = face->accel.maxbounds.ascent << 6;
#endif
 
#ifdef FT_DEBUG_LEVEL_TRACE
        if ( face->accel.fontAscent + face->accel.fontDescent < 0 )
          FT_TRACE0(( "pcf_load_font: negative height\n" ));
#endif
        if ( FT_ABS( face->accel.fontAscent +
                     face->accel.fontDescent ) > 0x7FFF )
        {
          bsize->height = 0x7FFF;
          FT_TRACE0(( "pcf_load_font: clamping height to value %d\n",
                      bsize->height ));
        }
        else
          bsize->height = FT_ABS( (FT_Short)( face->accel.fontAscent +
                                              face->accel.fontDescent ) );
 
        prop = pcf_find_property( face, "AVERAGE_WIDTH" );
        if ( prop )
        {
#ifdef FT_DEBUG_LEVEL_TRACE
          if ( prop->value.l < 0 )
            FT_TRACE0(( "pcf_load_font: negative average width\n" ));
#endif
          if ( ( FT_ABS( prop->value.l ) > 0x7FFFL * 10 - 5 ) )
          {
            bsize->width = 0x7FFF;
            FT_TRACE0(( "pcf_load_font: clamping average width to value %d\n",
                        bsize->width ));
          }
          else
            bsize->width = FT_ABS( (FT_Short)( ( prop->value.l + 5 ) / 10 ) );
        }
        else
        {
          /* this is a heuristical value */
          bsize->width = (FT_Short)FT_MulDiv( bsize->height, 2, 3 );
        }
 
        prop = pcf_find_property( face, "POINT_SIZE" );
        if ( prop )
        {
#ifdef FT_DEBUG_LEVEL_TRACE
          if ( prop->value.l < 0 )
            FT_TRACE0(( "pcf_load_font: negative point size\n" ));
#endif
          /* convert from 722.7 decipoints to 72 points per inch */
          if ( FT_ABS( prop->value.l ) > 0x504C2L ) /* 0x7FFF * 72270/7200 */
          {
            bsize->size = 0x7FFF;
            FT_TRACE0(( "pcf_load_font: clamping point size to value %d\n",
                        bsize->size ));
          }
          else
            bsize->size = FT_MulDiv( FT_ABS( prop->value.l ),
                                     64 * 7200,
                                     72270L );
        }
 
        prop = pcf_find_property( face, "PIXEL_SIZE" );
        if ( prop )
        {
#ifdef FT_DEBUG_LEVEL_TRACE
          if ( prop->value.l < 0 )
            FT_TRACE0(( "pcf_load_font: negative pixel size\n" ));
#endif
          if ( FT_ABS( prop->value.l ) > 0x7FFF )
          {
            bsize->y_ppem = 0x7FFF << 6;
            FT_TRACE0(( "pcf_load_font: clamping pixel size to value %d\n",
                        bsize->y_ppem ));
          }
          else
            bsize->y_ppem = FT_ABS( (FT_Short)prop->value.l ) << 6;
        }
 
        prop = pcf_find_property( face, "RESOLUTION_X" );
        if ( prop )
        {
#ifdef FT_DEBUG_LEVEL_TRACE
          if ( prop->value.l < 0 )
            FT_TRACE0(( "pcf_load_font: negative X resolution\n" ));
#endif
          if ( FT_ABS( prop->value.l ) > 0x7FFF )
          {
            resolution_x = 0x7FFF;
            FT_TRACE0(( "pcf_load_font: clamping X resolution to value %d\n",
                        resolution_x ));
          }
          else
            resolution_x = FT_ABS( (FT_Short)prop->value.l );
        }
 
        prop = pcf_find_property( face, "RESOLUTION_Y" );
        if ( prop )
        {
#ifdef FT_DEBUG_LEVEL_TRACE
          if ( prop->value.l < 0 )
            FT_TRACE0(( "pcf_load_font: negative Y resolution\n" ));
#endif
          if ( FT_ABS( prop->value.l ) > 0x7FFF )
          {
            resolution_y = 0x7FFF;
            FT_TRACE0(( "pcf_load_font: clamping Y resolution to value %d\n",
                        resolution_y ));
          }
          else
            resolution_y = FT_ABS( (FT_Short)prop->value.l );
        }
 
        if ( bsize->y_ppem == 0 )
        {
          bsize->y_ppem = bsize->size;
          if ( resolution_y )
            bsize->y_ppem = FT_MulDiv( bsize->y_ppem, resolution_y, 72 );
        }
        if ( resolution_x && resolution_y )
          bsize->x_ppem = FT_MulDiv( bsize->y_ppem,
                                     resolution_x,
                                     resolution_y );
        else
          bsize->x_ppem = bsize->y_ppem;
      }
 
      /* set up charset */
      {
        PCF_Property  charset_registry, charset_encoding;
 
 
        charset_registry = pcf_find_property( face, "CHARSET_REGISTRY" );
        charset_encoding = pcf_find_property( face, "CHARSET_ENCODING" );
 
        if ( charset_registry && charset_registry->isString &&
             charset_encoding && charset_encoding->isString )
        {
          if ( FT_STRDUP( face->charset_encoding,
                          charset_encoding->value.atom ) ||
               FT_STRDUP( face->charset_registry,
                          charset_registry->value.atom ) )
            goto Exit;
        }
      }
    }
 
  Exit:
    if ( error )
    {
      /* This is done to respect the behaviour of the original */
      /* PCF font driver.                                      */
      error = FT_THROW( Invalid_File_Format );
    }
 
    return error;
  }

Referenced by PCF_Face_Init().