/* Dia -- an diagram creation/manipulation program
 * Copyright (C) 1998 Alexander Larsson
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */
#ifndef FONT_H
#define FONT_H

#include "diatypes.h"
#include <glib.h>
#include <glib-object.h>
#include <pango/pango.h>
#include "dia-enums.h"
#include "geometry.h"

/*!
 \file font.h -- services based on font definitions 
 */
/*!
 \defgroup ObjectFonts Dia's font definiton
 \brief Dia's font system based on http://www.pango.org
 \ingroup ObjectParts
 */

G_BEGIN_DECLS

/* Do NOT put these strings through the .po mechanism. If you need to add
   non-Roman alternatives, please insert them in the list */
#define BASIC_SANS_FONT "arial, helvetica, helv, sans"
#define BASIC_SERIF_FONT "times new roman, times, serif"
#define BASIC_MONOSPACE_FONT "courier new, courier, monospace, fixed"


/*
 * In a goodly selection of fonts, 500 is very common, yet Pango doesn't name it.
 * I am calling 500 'medium' and 600 'demibold'.
 * We should really have a more flexible system where 300 or 400 is normal, 
 * the next one up bold, or something.  But this will do for now.
 * We should probably store the actual weight...
 */

/* We are having DIA_FONT_WEIGHT_NORMAL be 0 to avoid having to do
 * DIA_FONT_MONOSPACE | DIA_FONT_WEIGHT_NORMAL all over the place.
 * This introduces a few hacks in font.c and widgets.c, but not too
 * many.
 */

/* storing different style info like 
 * (DIA_FONT_SANS | DIA_FONT_ITALIC | DIA_FONT_BOLD)
 */
typedef guint DiaFontStyle;

typedef enum
{
  DIA_FONT_FAMILY_ANY = 0,
  DIA_FONT_SANS       = 1,
  DIA_FONT_SERIF      = 2,
  DIA_FONT_MONOSPACE  = 3
} DiaFontFamily;

typedef enum
{
  DIA_FONT_NORMAL  = (0<<2),
  DIA_FONT_OBLIQUE = (1<<2),
  DIA_FONT_ITALIC  = (2<<2)
} DiaFontSlant;

typedef enum
{
  DIA_FONT_ULTRALIGHT    = (1<<4),
  DIA_FONT_LIGHT         = (2<<4),
  DIA_FONT_WEIGHT_NORMAL = (0<<4), /* Deliberately 0 for DIA_FONT_NORMAL */
  DIA_FONT_MEDIUM        = (3<<4),
  DIA_FONT_DEMIBOLD      = (4<<4),
  DIA_FONT_BOLD          = (5<<4),
  DIA_FONT_ULTRABOLD     = (6<<4),
  DIA_FONT_HEAVY         = (7<<4)
} DiaFontWeight;

/* macros to get a specific style info */
#define DIA_FONT_STYLE_GET_FAMILY(st)    ((st) & (0x3))
#define DIA_FONT_STYLE_GET_SLANT(st)     ((st) & (0x3<<2))
#define DIA_FONT_STYLE_GET_WEIGHT(st)    ((st) & (0x7<<4))

GType dia_font_get_type(void) G_GNUC_CONST;

#define DIA_TYPE_FONT (dia_font_get_type())

#define DIA_FONT(object)    (G_TYPE_CHECK_INSTANCE_CAST ((object), \
                                                         DIA_TYPE_FONT, \
                                                         DiaFont))
#define DIA_FONT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), \
                                                        DIA_TYPE_FONT, \
                                                        DiaFontClass))

struct _DiaFontClass {
    GObjectClass parent_class;
};

/*! Set the PangoContext used to render text.
 * \ingroup ObjectFonts
 */
void dia_font_init(PangoContext* pcontext);
/* Start using a new context (for AA rendering) */
void dia_font_push_context(PangoContext *pcontext);
/* Go back to using the old context */
void dia_font_pop_context(void);
/* Retrieve the current context (used for the font widget) */
PangoContext *dia_font_get_context(void);

/*!
 * \brief Font creation for object implementation
 * \ingroup ObjectFonts
 * Get a font matching family,style,height. MUST be freed with dia_font_unref().
 */
DiaFont* dia_font_new(const char *family, DiaFontStyle style,
                      real height);

/*!
 * \brief Font creation for object implementation
 * Get a font matching style. This is the preferred method to
 * create default fonts within objects.
 * \ingroup ObjectFonts
 */
DiaFont* dia_font_new_from_style(DiaFontStyle style, real height);

/*!
 * \brief Font creation for object implementation
 * Get a font from a legacy font name 
 * \ingroup ObjectFonts
 */ 
DiaFont* dia_font_new_from_legacy_name(const char *name);

/*!
 * \brief Font creation for object implementation
 * Get a simple font name from a font.
 * Name will be valid for the duration of the DiaFont* lifetime. 
 * \ingroup ObjectFonts
 */ 
const char* dia_font_get_legacy_name(const DiaFont* font);

    /* Same attributes */
DiaFont *dia_font_copy(const DiaFont* font);

DiaFont* dia_font_ref(DiaFont* font);
void dia_font_unref(DiaFont* font);

    /* Retrieves the style of the font */
DiaFontStyle dia_font_get_style(const DiaFont* font);

    /* Retrieves the family of the font. Caller must NOT free. */
const char* dia_font_get_family(const DiaFont* font);
/* Acessor for the PangoFontDescription */
const PangoFontDescription *dia_font_get_description (const DiaFont* font);

/*! 
 * \brief Retrieves the height of the font
 * \memberof DiaFont
 */
real dia_font_get_height(const DiaFont* font);
/*! 
 * \brief Change the height inside a font record.
 * \memberof DiaFont
 */
void dia_font_set_height(DiaFont* font, real height);
/*! 
 * \brief Delivers the size of the font
 * \memberof DiaFont
 */
real dia_font_get_size(const DiaFont* font);
/*! 
 * \brief Changes the slant of an existing font
 * \memberof DiaFont
 */
void dia_font_set_slant(DiaFont* font, DiaFontSlant slant);
/*! 
 * \brief Changes the weight of an existing font
 * \memberof DiaFont
 */
void dia_font_set_weight(DiaFont* font, DiaFontWeight weight);
/*! 
 * \brief Changes the family of an existing font to one of the three standard families
 * \memberof DiaFont
 */
void dia_font_set_family(DiaFont* font, DiaFontFamily family);
/*! 
 * \brief Changes the family of an existing font to any family
 * The name is system configuration dependent, but font files are portable nowadays.
 * \memberof DiaFont
 */
void dia_font_set_any_family(DiaFont* font, const char* family);

    /* FIXME: what do we do with this, actually ?
       Name lives for as long as the DiaFont lives. */
const char *dia_font_get_psfontname(const DiaFont *font);

    /* returns a static string suitable for SVG */
const char *dia_font_get_weight_string(const DiaFont* font);

    /* returns a static string suitable for SVG */
const char *dia_font_get_slant_string(const DiaFont* font);

    /* uses an SVG style string */
void dia_font_set_weight_from_string(DiaFont* font, const char* weight);

    /* uses an SVG style string */
void dia_font_set_slant_from_string(DiaFont* font, const char* slant);

/* -------- Font and string functions - unscaled versions.
   Use these version in Objects, primarily. */

    /* Get the width of the string with the given font in cm */
real dia_font_string_width(const char* string, DiaFont* font,
                          real height);
    /* Get the ascent of this string in cm (a positive number). */
real dia_font_ascent(const char* string, DiaFont* font, real height);
    /* Get the descent of the font in cm (a positive number) */
real dia_font_descent(const char* string, DiaFont* font, real height);

    /* prepares a layout of the text, in font 'font'. */
PangoLayout* dia_font_build_layout(const char* string, DiaFont* font,
                                   real height);

real* dia_font_get_sizes(const char* string, DiaFont *font, real height,
			 real* width, real* ascent, real* descent, 
			 int *n_offsets, PangoLayoutLine **layout_offsets);

/* -------- Font and string functions - scaled versions.
   Use these version in Renderers, exclusively. */

G_END_DECLS

#endif /* FONT_H */