/*
   (c) Copyright 2000-2002  convergence integrated media GmbH.
   (c) Copyright 2002       convergence GmbH.
   
   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de> and
              Sven Neumann <sven@convergence.de>.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#ifndef __FONTS_H__
#define __FONTS_H__

#include <pthread.h>

#include <core/fusion/lock.h>

#include <directfb.h>

#include <core/coretypes.h>

#include <core/state.h>

/*
 * glyph struct
 */
typedef struct {
     CoreSurface *surface;              /* contains bitmap of glyph         */
     int          start;                /* x offset of glyph in surface     */
     int          width;                /* width of the glyphs bitmap       */
     int          height;               /* height of the glyphs bitmap      */
     int          left;                 /* x offset of the glyph            */
     int          top;                  /* y offset of the glyph            */
     int          advance;              /* placement of next glyph          */
} CoreGlyphData;

/*
 * font struct
 */

struct _CoreFont {
     DFBSurfacePixelFormat    pixel_format;
     CardState                state;    /* the state used to blit glyphs    */

     CoreSurface    **surfaces;         /* contain bitmaps of loaded glyphs */
     Reaction       **reactions;        /* for glyph surface listener */
     int              rows;
     int              row_width;
     int              next_x;

     Tree            *glyph_infos;      /* infos about loaded glyphs        */

     int              height;           /* font height                      */

     int              ascender;         /* a positive value, the distance
                                           from the baseline to the top     */
     int              descender;        /* a negative value, the distance
                                           from the baseline to the bottom  */
     int              maxadvance;       /* width of largest character       */

     pthread_mutex_t  lock;             /* lock during access to the font   */

     void            *impl_data;        /* a pointer used by the impl.      */

     DFBResult   (* GetGlyphInfo) ( CoreFont *thiz, unichar glyph, 
                                    CoreGlyphData *info );
     DFBResult   (* RenderGlyph)  ( CoreFont *thiz, unichar glyph,
                                    CoreGlyphData *info, CoreSurface *surface );
     DFBResult   (* GetKerning)   ( CoreFont *thiz,
                                    unichar prev, unichar current,
                                    int *kern_x, int *kern_y );
};

/*
 * allocates and initializes a new font structure
 */
CoreFont *dfb_font_create();

/*
 * destroy all data in the CoreFont struct
 */
void dfb_font_destroy( CoreFont *font );

/*
 * lock the font before accessing it
 */
static inline void dfb_font_lock( CoreFont *font )
{
     pthread_mutex_lock( &font->lock );
     dfb_state_lock( &font->state );
}

/*
 * unlock the font after access
 */
static inline void dfb_font_unlock( CoreFont *font )
{
     dfb_state_unlock( &font->state );
     pthread_mutex_unlock( &font->lock );
}

/*
 * loads glyph data from font
 */
DFBResult dfb_font_get_glyph_data( CoreFont        *font,
                                   unichar          glyph,
                                   CoreGlyphData  **glyph_data );

#endif