/*  bdfdrivr.c

    FreeType font driver for bdf files

    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by

    Francesco Zappa Nardelli

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

*/

#include <ft2build.h>

#include FT_INTERNAL_DEBUG_H

#include FT_INTERNAL_STREAM_H

#include FT_INTERNAL_OBJECTS_H

#include FT_BDF_H

#include FT_TRUETYPE_IDS_H 

#include FT_SERVICE_BDF_H

#include FT_SERVICE_XFREE86_NAME_H

#include "bdf.h"

#include "bdfdrivr.h"

#include "bdferror.h"

  /*************************************************************************/

  /*                                                                       */

  /* The macro FT_COMPONENT is used in trace mode.  It is an implicit      */

  /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log  */

  /* messages during execution.                                            */

  /*                                                                       */

#undef  FT_COMPONENT

#define FT_COMPONENT  trace_bdfdriver

  typedef struct  BDF_CMapRec_

  {

    FT_CMapRec        cmap;

    FT_ULong          num_encodings; /* ftobjs.h: FT_CMap->clazz->size */

    BDF_encoding_el*  encodings;

  } BDF_CMapRec, *BDF_CMap;

  FT_CALLBACK_DEF( FT_Error )

  bdf_cmap_init( FT_CMap     bdfcmap,

                 FT_Pointer  init_data )

  {

    BDF_CMap  cmap = (BDF_CMap)bdfcmap;

    BDF_Face  face = (BDF_Face)FT_CMAP_FACE( cmap );

    FT_UNUSED( init_data );

    cmap->num_encodings = face->bdffont->glyphs_used;

    cmap->encodings     = face->en_table;

    return BDF_Err_Ok;

  }

  FT_CALLBACK_DEF( void )

  bdf_cmap_done( FT_CMap  bdfcmap )

  {

    BDF_CMap  cmap = (BDF_CMap)bdfcmap;

    cmap->encodings     = NULL;

    cmap->num_encodings = 0;

  }

  FT_CALLBACK_DEF( FT_UInt )

  bdf_cmap_char_index( FT_CMap    bdfcmap,

                       FT_UInt32  charcode )

  {

    BDF_CMap          cmap      = (BDF_CMap)bdfcmap;

    BDF_encoding_el*  encodings = cmap->encodings;

    FT_ULong          min, max, mid; /* num_encodings */

    FT_UShort         result    = 0; /* encodings->glyph */

    min = 0;

    max = cmap->num_encodings;

    while ( min < max )

    {

      FT_ULong  code;

      mid  = ( min + max ) >> 1;

      code = encodings[mid].enc;

      if ( charcode == code )

      {

        /* increase glyph index by 1 --              */

        /* we reserve slot 0 for the undefined glyph */

        result = encodings[mid].glyph + 1;

        break;

      }

      if ( charcode < code )

        max = mid;

      else

        min = mid + 1;

    }

    return result;

  }

  FT_CALLBACK_DEF( FT_UInt )

  bdf_cmap_char_next( FT_CMap     bdfcmap,

                      FT_UInt32  *acharcode )

  {

    BDF_CMap          cmap      = (BDF_CMap)bdfcmap;

    BDF_encoding_el*  encodings = cmap->encodings;

    FT_ULong          min, max, mid; /* num_encodings */

    FT_UShort         result   = 0;  /* encodings->glyph */

    FT_ULong          charcode = *acharcode + 1;

    min = 0;

    max = cmap->num_encodings;

    while ( min < max )

    {

      FT_ULong  code; /* same as BDF_encoding_el.enc */

      mid  = ( min + max ) >> 1;

      code = encodings[mid].enc;

      if ( charcode == code )

      {

        /* increase glyph index by 1 --              */

        /* we reserve slot 0 for the undefined glyph */

        result = encodings[mid].glyph + 1;

        goto Exit;

      }

      if ( charcode < code )

        max = mid;

      else

        min = mid + 1;

    }

    charcode = 0;

    if ( min < cmap->num_encodings )

    {

      charcode = encodings[min].enc;

      result   = encodings[min].glyph + 1;

    }

  Exit:

    if ( charcode > 0xFFFFFFFFUL )

    {

      FT_TRACE1(( "bdf_cmap_char_next: charcode 0x%x > 32bit API" ));

      *acharcode = 0;

      /* XXX: result should be changed to indicate an overflow error */

    }

    else

      *acharcode = (FT_UInt32)charcode;

    return result;

  }

  FT_CALLBACK_TABLE_DEF

  const FT_CMap_ClassRec  bdf_cmap_class =

  {

    sizeof ( BDF_CMapRec ),

    bdf_cmap_init,

    bdf_cmap_done,

    bdf_cmap_char_index,

    bdf_cmap_char_next,

    NULL, NULL, NULL, NULL, NULL

  };

  static FT_Error

  bdf_interpret_style( BDF_Face  bdf )

  {

    FT_Error         error  = BDF_Err_Ok;

    FT_Face          face   = FT_FACE( bdf );

    FT_Memory        memory = face->memory;

    bdf_font_t*      font   = bdf->bdffont;

    bdf_property_t*  prop;

    char*   strings[4] = { NULL, NULL, NULL, NULL };

    size_t  nn, len, lengths[4];

    face->style_flags = 0;

    prop = bdf_get_font_property( font, (char *)"SLANT" );

    if ( prop && prop->format == BDF_ATOM                             &&

         prop->value.atom                                             &&

         ( *(prop->value.atom) == 'O' || *(prop->value.atom) == 'o' ||

           *(prop->value.atom) == 'I' || *(prop->value.atom) == 'i' ) )

    {

      face->style_flags |= FT_STYLE_FLAG_ITALIC;

      strings[2] = ( *(prop->value.atom) == 'O' || *(prop->value.atom) == 'o' )

                   ? (char *)"Oblique"

                   : (char *)"Italic";

    }

    prop = bdf_get_font_property( font, (char *)"WEIGHT_NAME" );

    if ( prop && prop->format == BDF_ATOM                             &&

         prop->value.atom                                             &&

         ( *(prop->value.atom) == 'B' || *(prop->value.atom) == 'b' ) )

    {

      face->style_flags |= FT_STYLE_FLAG_BOLD;

      strings[1] = (char *)"Bold";

    }

    prop = bdf_get_font_property( font, (char *)"SETWIDTH_NAME" );

    if ( prop && prop->format == BDF_ATOM                              &&

         prop->value.atom && *(prop->value.atom)                       &&

         !( *(prop->value.atom) == 'N' || *(prop->value.atom) == 'n' ) )

      strings[3] = (char *)(prop->value.atom);

    prop = bdf_get_font_property( font, (char *)"ADD_STYLE_NAME" );

    if ( prop && prop->format == BDF_ATOM                              &&

         prop->value.atom && *(prop->value.atom)                       &&

         !( *(prop->value.atom) == 'N' || *(prop->value.atom) == 'n' ) )

      strings[0] = (char *)(prop->value.atom);

    len = 0;

    for ( len = 0, nn = 0; nn < 4; nn++ )

    {

      lengths[nn] = 0;

      if ( strings[nn] )

      {

        lengths[nn] = ft_strlen( strings[nn] );

        len        += lengths[nn] + 1;

      }

    }

    if ( len == 0 )

    {

      strings[0] = (char *)"Regular";

      lengths[0] = ft_strlen( strings[0] );

      len        = lengths[0] + 1;

    }

    {

      char*  s;

      if ( FT_ALLOC( face->style_name, len ) )

        return error;

      s = face->style_name;

      for ( nn = 0; nn < 4; nn++ )

      {

        char*  src = strings[nn];

        len = lengths[nn];

        if ( src == NULL )

          continue;

        /* separate elements with a space */

        if ( s != face->style_name )

          *s++ = ' ';

        ft_memcpy( s, src, len );

        /* need to convert spaces to dashes for */

        /* add_style_name and setwidth_name     */

        if ( nn == 0 || nn == 3 )

        {

          size_t  mm;

          for ( mm = 0; mm < len; mm++ )

            if ( s[mm] == ' ' )

              s[mm] = '-';

        }

        s += len;

      }

      *s = 0;

    }

    return error;

  }

  FT_CALLBACK_DEF( void )

  BDF_Face_Done( FT_Face  bdfface )         /* BDF_Face */

  {

    BDF_Face   face = (BDF_Face)bdfface;

    FT_Memory  memory;

    if ( !face )

      return;

    memory = FT_FACE_MEMORY( face );

    bdf_free_font( face->bdffont );

    FT_FREE( face->en_table );

    FT_FREE( face->charset_encoding );

    FT_FREE( face->charset_registry );

    FT_FREE( bdfface->family_name );

    FT_FREE( bdfface->style_name );

    FT_FREE( bdfface->available_sizes );

    FT_FREE( face->bdffont );

    FT_TRACE4(( "BDF_Face_Done: done face\n" ));

  }

  FT_CALLBACK_DEF( FT_Error )

  BDF_Face_Init( FT_Stream      stream,

                 FT_Face        bdfface,        /* BDF_Face */

                 FT_Int         face_index,

                 FT_Int         num_params,

                 FT_Parameter*  params )

  {

    FT_Error       error  = BDF_Err_Ok;

    BDF_Face       face   = (BDF_Face)bdfface;

    FT_Memory      memory = FT_FACE_MEMORY( face );

    bdf_font_t*    font = NULL;

    bdf_options_t  options;

    FT_UNUSED( num_params );

    FT_UNUSED( params );

    FT_UNUSED( face_index );

    if ( FT_STREAM_SEEK( 0 ) )

      goto Exit;

    options.correct_metrics = 1;   /* FZ XXX: options semantics */

    options.keep_unencoded  = 1;

    options.keep_comments   = 0;

    options.font_spacing    = BDF_PROPORTIONAL;

    error = bdf_load_font( stream, memory, &options, &font );

    if ( error == BDF_Err_Missing_Startfont_Field )

    {

      FT_TRACE2(( "[not a valid BDF file]\n" ));

      goto Fail;

    }

    else if ( error )

      goto Exit;

    /* we have a bdf font: let's construct the face object */

    face->bdffont = font;

    {

      bdf_property_t*  prop = NULL;

      FT_TRACE4(( "number of glyphs: %d (%d)\n",

                  font->glyphs_size,

                  font->glyphs_used ));

      FT_TRACE4(( "number of unencoded glyphs: %d (%d)\n",

                  font->unencoded_size,

                  font->unencoded_used ));

      bdfface->num_faces  = 1;

      bdfface->face_index = 0;

      bdfface->face_flags = FT_FACE_FLAG_FIXED_SIZES |

                            FT_FACE_FLAG_HORIZONTAL  |

                            FT_FACE_FLAG_FAST_GLYPHS;

      prop = bdf_get_font_property( font, "SPACING" );

      if ( prop && prop->format == BDF_ATOM                             &&

           prop->value.atom                                             &&

           ( *(prop->value.atom) == 'M' || *(prop->value.atom) == 'm' ||

             *(prop->value.atom) == 'C' || *(prop->value.atom) == 'c' ) )

        bdfface->face_flags |= FT_FACE_FLAG_FIXED_WIDTH;

      /* FZ XXX: TO DO: FT_FACE_FLAGS_VERTICAL   */

      /* FZ XXX: I need a font to implement this */

      prop = bdf_get_font_property( font, "FAMILY_NAME" );

      if ( prop && prop->value.atom )

      {

        if ( FT_STRDUP( bdfface->family_name, prop->value.atom ) )

          goto Exit;

      }

      else

        bdfface->family_name = 0;

      if ( ( error = bdf_interpret_style( face ) ) != 0 )

        goto Exit;

      /* the number of glyphs (with one slot for the undefined glyph */

      /* at position 0 and all unencoded glyphs)                     */

      bdfface->num_glyphs = font->glyphs_size + 1;

      bdfface->num_fixed_sizes = 1;

      if ( FT_NEW_ARRAY( bdfface->available_sizes, 1 ) )

        goto Exit;

      {

        FT_Bitmap_Size*  bsize = bdfface->available_sizes;

        FT_Short         resolution_x = 0, resolution_y = 0;

        FT_MEM_ZERO( bsize, sizeof ( FT_Bitmap_Size ) );

        bsize->height = (FT_Short)( font->font_ascent + font->font_descent );

        prop = bdf_get_font_property( font, "AVERAGE_WIDTH" );

        if ( prop )

          bsize->width = (FT_Short)( ( prop->value.l + 5 ) / 10 );

        else

          bsize->width = (FT_Short)( bsize->height * 2/3 );

        prop = bdf_get_font_property( font, "POINT_SIZE" );

        if ( prop )

          /* convert from 722.7 decipoints to 72 points per inch */

          bsize->size =

            (FT_Pos)( ( prop->value.l * 64 * 7200 + 36135L ) / 72270L );

        else

          bsize->size = bsize->width << 6;

        prop = bdf_get_font_property( font, "PIXEL_SIZE" );

        if ( prop )

          bsize->y_ppem = (FT_Short)prop->value.l << 6;

        prop = bdf_get_font_property( font, "RESOLUTION_X" );

        if ( prop )

          resolution_x = (FT_Short)prop->value.l;

        prop = bdf_get_font_property( font, "RESOLUTION_Y" );

        if ( prop )

          resolution_y = (FT_Short)prop->value.l;

        if ( bsize->y_ppem == 0 )

        {

          bsize->y_ppem = bsize->size;

          if ( resolution_y )

            bsize->y_ppem = bsize->y_ppem * resolution_y / 72;

        }

        if ( resolution_x && resolution_y )

          bsize->x_ppem = bsize->y_ppem * resolution_x / resolution_y;

        else

          bsize->x_ppem = bsize->y_ppem;

      }

      /* encoding table */

      {

        bdf_glyph_t*   cur = font->glyphs;

        unsigned long  n;

        if ( FT_NEW_ARRAY( face->en_table, font->glyphs_size ) )

          goto Exit;

        face->default_glyph = 0;

        for ( n = 0; n < font->glyphs_size; n++ )

        {

          (face->en_table[n]).enc = cur[n].encoding;

          FT_TRACE4(( "idx %d, val 0x%lX\n", n, cur[n].encoding ));

          (face->en_table[n]).glyph = (FT_Short)n;

          if ( cur[n].encoding == font->default_char )

          {

            if ( n < FT_UINT_MAX )

              face->default_glyph = (FT_UInt)n;

            else

              FT_TRACE1(( "idx %d is too large for this system\n", n ));

          }

        }

      }

      /* charmaps */

      {

        bdf_property_t  *charset_registry = 0, *charset_encoding = 0;

        FT_Bool          unicode_charmap  = 0;

        charset_registry =

          bdf_get_font_property( font, "CHARSET_REGISTRY" );

        charset_encoding =

          bdf_get_font_property( font, "CHARSET_ENCODING" );

        if ( charset_registry && charset_encoding )

        {

          if ( charset_registry->format == BDF_ATOM &&

               charset_encoding->format == BDF_ATOM &&

               charset_registry->value.atom         &&

               charset_encoding->value.atom         )

          {

            const char*  s;

            if ( FT_STRDUP( face->charset_encoding,

                            charset_encoding->value.atom ) ||

                 FT_STRDUP( face->charset_registry,

                            charset_registry->value.atom ) )

              goto Exit;

            /* Uh, oh, compare first letters manually to avoid dependency */

            /* on locales.                                                */

            s = face->charset_registry;

            if ( ( s[0] == 'i' || s[0] == 'I' ) &&

                 ( s[1] == 's' || s[1] == 'S' ) &&

                 ( s[2] == 'o' || s[2] == 'O' ) )