[bpt/emacs.git] / src / font.h

/* font.h -- Interface definition for font handling.
   Copyright (C) 2006 Free Software Foundation, Inc.
   Copyright (C) 2006
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009

This file is part of GNU Emacs.

GNU Emacs 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, or (at your option)
any later version.

GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */

#ifndef EMACS_FONT_H
#define EMACS_FONT_H

#include "ccl.h"

/* We have three types of Lisp objects related to font.

   FONT-SPEC

	Vector (length FONT_SPEC_MAX) of font properties.  Some
	properties can be left unspecified (i.e. nil).  Emacs asks
	font-drivers to find a font by FONT-SPEC.  A fontset entry
	specifies requisite properties whereas a face specifies just
	preferable properties.  This object is fully modifiable by
	Lisp.

   FONT-ENTITY

	Vector (length FONT_ENTITY_MAX) of fully specified font
	properties that a font-driver returns upon a request of
	FONT-SPEC.

	Note: Only the method `list' of a font-driver can create this
	object, and should never be modified by Lisp.  In that sense,
	it may be cleaner to implement it as a Lisp object of a new
	type (e.g. struct Lisp_Font).

   FONT-OBJECT

	Lisp object of type Lisp_Misc_Save_Value encapsulating a
	pointer to "struct font".  This corresponds to an opened font.

	Note: The note for FONT-ENTITY also applies to this.
*/


struct font_driver;
struct font;

/* An enumerator for each font property.  This is used as an index to
   the vector of FONT-SPEC and FONT-ENTITY.

   Note: The order is important and should not be changed.  */

enum font_property_index
  {
    /* FONT-TYPE is a symbol indicating a font backend; currently `x',
       `xft', `ftx', `freetype' are available.  For windows, we need
       `bdf' and `windows'.  For Mac OS X, we need `atm'.  */
    FONT_TYPE_INDEX,

    /* FONT-FOUNDRY is a foundry name (symbol).  */
    FONT_FOUNDRY_INDEX,

    /* FONT-FAMILY is a family name (symbol).  */
    FONT_FAMILY_INDEX,

    /* FONT-ADSTYLE is an additional style name (symbol).  */
    FONT_ADSTYLE_INDEX,

    /* FONT-REGISTRY is a combination of a charset-registry and
       charset0encoding name (symbol).  */
    FONT_REGISTRY_INDEX,

    /* FONT-WEIGHT is a numeric value of weight (e.g. medium, bold) of
       the font.  The value is what defined by FC_WEIGHT_* in
       fontconfig. */
    FONT_WEIGHT_INDEX,

    /* FONT-SLANT is a numeric value of slant (e.g. r, i, o) of the
       font.  The value is what defined by FC_SLANT_* in
       fontconfig plus 100. */
    FONT_SLANT_INDEX,

    /* FONT-WIDTH is a numeric value of setwidth (e.g. normal,
       condensed) of the font.  The value is what defined by
       FC_WIDTH_* in fontconfig. */
    FONT_WIDTH_INDEX,

    /* FONT-SIZE is a size of the font.  If integer, it is a pixel
       size.  For a font-spec, the value can be float specifying a
       point size.  For a font-entity, the value can be zero meaning
       that the font is scalable.  */
    FONT_SIZE_INDEX,

    /* In a font-spec, the value is an alist of extra information of a
       font such as name, OpenType features, and language coverage.
       In a font-entity, the value is an extra infomation for
       identifying a font (font-driver dependent).  */
    FONT_EXTRA_INDEX,		/* alist		alist */

    /* This value is the length of font-spec vector.  */
    FONT_SPEC_MAX,

    /* The followings are used only for a font-entity.  */

    /* Frame on which the font is found.  The value is nil if the font
       can be opend on any frame.  */
    FONT_FRAME_INDEX = FONT_SPEC_MAX,

    /* List of font-objects opened from the font-entity.  */
    FONT_OBJLIST_INDEX,

    /* This value is the length of font-entity vector.  */
    FONT_ENTITY_MAX
  };

extern Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClanguage, QCscript;

/* Important character set symbols.  */
extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp;

extern Lisp_Object null_string;
extern Lisp_Object null_vector;

/* Structure for an opened font.  We can safely cast this structure to
   "struft font_info".  */

struct font
{
  struct font_info font;

  /* From which font-entity the font is opened.  */
  Lisp_Object entity;

  /* By which pixel size the font is opened.  */
  int pixel_size;

  /* Font-driver for the font.  */
  struct font_driver *driver;

  /* File name of the font, or NULL if the font is not associated with
     a file.  */
  char *file_name;

  /* Charset to encode a character code into a glyph code of the
     font.  */
  int encoding_charset;

  /* Charset to check if a character code is supported by the font.
     -1 means that the contents of the font must be looked up to
     determine it.
   */
  int repertory_charset;

  /* Minimum glyph width (in pixels).  */
  int min_width;

  /* Ascent and descent of the font (in pixels).  */
  int ascent, descent;

  /* There will be more to this structure, but they are private to a
     font-driver.  */
};

enum font_spacing
  {
    FONT_SPACING_PROPORTIONAL = 0,
    FONT_SPACING_DUAL = 90,
    FONT_SPACING_MONO = 100,
    FONT_SPACING_CHARCELL = 110
  };

struct font_metrics
{
  short lbearing, rbearing, width, ascent, descent;
};

struct font_bitmap
{
  int rows;
  int width;
  int pitch;
  unsigned char *buffer;
  int left;
  int top;
  int advance;
  void *extra;
};

/* Predicates to check various font-related objects.  */

#define FONTP(x)	\
  (VECTORP (x) && (ASIZE (x) == FONT_SPEC_MAX || ASIZE (x) == FONT_ENTITY_MAX))
#define FONT_SPEC_P(x)	\
  (VECTORP (x) && ASIZE (x) == FONT_SPEC_MAX)
#define FONT_ENTITY_P(x)	\
  (VECTORP (x) && ASIZE (x) == FONT_ENTITY_MAX)
#define FONT_OBJECT_P(x)	\
  (XTYPE (x) == Lisp_Misc && XMISCTYPE (x) == Lisp_Misc_Save_Value)


/* Check macros for various font-related objects.  */

#define CHECK_FONT(x)	\
  do { if (! FONTP (x)) x = wrong_type_argument (Qfont, x); } while (0)
#define CHECK_FONT_SPEC(x)	\
  do { if (! FONT_SPEC_P (x)) x = wrong_type_argument (Qfont, x); } while (0)
#define CHECK_FONT_ENTITY(x)	\
  do { if (! FONT_ENTITY_P (x)) x = wrong_type_argument (Qfont, x); } while (0)
#define CHECK_FONT_OBJECT(x)	\
  do { if (! FONT_OBJECT_P (x)) x = wrong_type_argument (Qfont, x); } while (0)

#define CHECK_FONT_GET_OBJECT(x, font)					\
  do {									\
    if (! FONT_OBJECT_P (x)) x = wrong_type_argument (Qfont, x);	\
    if (! XSAVE_VALUE (x)->pointer) error ("Font already closed");	\
    font = XSAVE_VALUE (x)->pointer;					\
  } while (0)

/* Ignore the difference of font pixel sizes less than or equal to
   this value.  */
#define FONT_PIXEL_SIZE_QUANTUM 1

struct face;
struct composition;

/* Macros for lispy glyph-string.  */
#define LGSTRING_FONT(lgs) AREF (AREF ((lgs), 0), 0)
#define LGSTRING_LBEARING(lgs) AREF (AREF ((lgs), 0), 1)
#define LGSTRING_RBEARING(lgs) AREF (AREF ((lgs), 0), 2)
#define LGSTRING_WIDTH(lgs) AREF (AREF ((lgs), 0), 3)
#define LGSTRING_ASCENT(lgs) AREF (AREF ((lgs), 0), 4)
#define LGSTRING_DESCENT(lgs) AREF (AREF ((lgs), 0), 5)
#define LGSTRING_SET_FONT(lgs, val) ASET (AREF ((lgs), 0), 0, (val))
#define LGSTRING_SET_LBEARING(lgs, val) ASET (AREF ((lgs), 0), 1, (val))
#define LGSTRING_SET_RBEARING(lgs, val)	ASET (AREF ((lgs), 0), 2, (val))
#define LGSTRING_SET_WIDTH(lgs, val) ASET (AREF ((lgs), 0), 3, (val))
#define LGSTRING_SET_ASCENT(lgs, val) ASET (AREF ((lgs), 0), 4, (val))
#define LGSTRING_SET_DESCENT(lgs, val) ASET (AREF ((lgs), 0), 5, (val))

#define LGSTRING_LENGTH(lgs) (ASIZE ((lgs)) - 1)
#define LGSTRING_GLYPH(lgs, idx) AREF ((lgs), (idx) + 1)

#define LGLYPH_CHAR(g) AREF ((g), 2)
#define LGLYPH_CODE(g) AREF ((g), 3)
#define LGLYPH_XOFF(g) AREF ((g), 4)
#define LGLYPH_YOFF(g) AREF ((g), 5)
#define LGLYPH_WIDTH(g) AREF ((g), 6)
#define LGLYPH_WADJUST(g) AREF ((g), 7)
#define LGLYPH_SET_CHAR(g, val) ASET ((g), 2, (val))
#define LGLYPH_SET_CODE(g, val) ASET ((g), 3, (val))
#define LGLYPH_SET_XOFF(g, val) ASET ((g), 4, (val))
#define LGLYPH_SET_YOFF(g, val) ASET ((g), 5, (val))
#define LGLYPH_SET_WIDTH(g, val) ASET ((g), 6, (val))
#define LGLYPH_SET_WADJUST(g, val) ASET ((g), 7, (val))

#define FONT_INVALID_CODE 0xFFFFFFFF

/* Font driver.  Members specified as "optional" can be NULL.  */

struct font_driver
{
  /* Symbol indicating the type of the font-driver.  */
  Lisp_Object type;

  /* Return a cache of font-entities on FRAME.  The cache must be a
     cons whose cdr part is the actual cache area.  */
  Lisp_Object (*get_cache) P_ ((Lisp_Object frame));

  /* List fonts matching with FONT_SPEC on FRAME.  The value is a
     vector of font-entities.  This is the sole API that allocates
     font-entities.  */
  Lisp_Object (*list) P_ ((Lisp_Object frame, Lisp_Object font_spec));

  /* Optional.
     List available families.  The value is a list of family names
     (symbols).  */
  Lisp_Object (*list_family) P_ ((Lisp_Object frame));

  /* Optional (if FONT_EXTRA_INDEX is not Lisp_Save_Value).
     Free FONT_EXTRA_INDEX field of FONT_ENTITY.  */
  void (*free_entity) P_ ((Lisp_Object font_entity));

  /* Open a font specified by FONT_ENTITY on frame F.  If the font is
     scalable, open it with PIXEL_SIZE.  */
  struct font *(*open) P_ ((FRAME_PTR f, Lisp_Object font_entity,
			    int pixel_size));

  /* Close FONT on frame F.  */
  void (*close) P_ ((FRAME_PTR f, struct font *font));

  /* Optional (if FACE->extra is not used).
     Prepare FACE for displaying characters by FONT on frame F by
     storing some data in FACE->extra.  If successful, return 0.
     Otherwise, return -1.  */
  int (*prepare_face) P_ ((FRAME_PTR f, struct face *face));

  /* Optional.
     Done FACE for displaying characters by FACE->font on frame F.  */
  void (*done_face) P_ ((FRAME_PTR f, struct face *face));

  /* Optional.
     If FONT_ENTITY has a glyph for character C (Unicode code point),
     return 1.  If not, return 0.  If a font must be opened to check
     it, return -1.  */
  int (*has_char) P_ ((Lisp_Object entity, int c));

  /* Return a glyph code of FONT for characer C (Unicode code point).
     If FONT doesn't have such a glyph, return FONT_INVALID_CODE.  */
  unsigned (*encode_char) P_ ((struct font *font, int c));

  /* Perform the size computation of glyphs of FONT and fillin members
     of METRICS.  The glyphs are specified by their glyph codes in
     CODE (length NGLYPHS).  */
  int (*text_extents) P_ ((struct font *font,
			   unsigned *code, int nglyphs,
			   struct font_metrics *metrics));

  /* Optional.
     Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
     position of frame F with S->FACE and S->GC.  If WITH_BACKGROUND
     is nonzero, fill the background in advance.  It is assured that
     WITH_BACKGROUND is zero when (FROM > 0 || TO < S->nchars).  */
  int (*draw) P_ ((struct glyph_string *s, int from, int to,
		   int x, int y, int with_background));

  /* Optional.
     Store bitmap data for glyph-code CODE of FONT in BITMAP.  It is
     intended that this method is callled from the other font-driver
     for actual drawing.  */
  int (*get_bitmap) P_ ((struct font *font, unsigned code,
			 struct font_bitmap *bitmap,
			 int bits_per_pixel));

  /* Optional.
     Free bitmap data in BITMAP.  */
  void (*free_bitmap) P_ ((struct font *font, struct font_bitmap *bitmap));

  /* Optional.
     Return an outline data for glyph-code CODE of FONT.  The format
     of the outline data depends on the font-driver.  */
  void *(*get_outline) P_ ((struct font *font, unsigned code));

  /* Optional.
     Free OUTLINE (that is obtained by the above method).  */
  void (*free_outline) P_ ((struct font *font, void *outline));

  /* Optional.
     Get coordinates of the INDEXth anchor point of the glyph whose
     code is CODE.  Store the coordinates in *X and *Y.  Return 0 if
     the operations was successfull.  Otherwise return -1.  */
  int (*anchor_point) P_ ((struct font *font, unsigned code, int index,
			   int *x, int *y));

  /* Optional.
     Return a list describing which scripts/languages FONT
     supports by which GSUB/GPOS features of OpenType tables.  */
  Lisp_Object (*otf_capability) P_ ((struct font *font));

  /* Optional.
     Drive FONT's OTF GSUB features according to GSUB_SPEC.

     GSUB_SPEC is in this format (all elements are symbols):
	(SCRIPT LANGSYS GSUB-FEATURE ...)
     If one of GSUB-FEATURE is nil, apply all gsub features except for
     already applied and listed later.  For instance, if the font has
     GSUB features nukt, haln, rphf, blwf, and half,
	(deva nil nukt haln nil rphf)
     applies nukt and haln in this order, then applies blwf and half
     in the order apearing in the font.  The features are of the
     default langsys of `deva' script.

     This method applies the specified features to the codes in the
     elements of GSTRING-IN (between FROMth and TOth).  The output
     codes are stored in GSTRING-OUT at the IDXth element and the
     following elements.

     Return the number of output codes.  If none of the features are
     applicable to the input data, return 0.  If GSTRING-OUT is too
     short, return -1.  */
  int (*otf_gsub) P_ ((struct font *font, Lisp_Object gsub_spec,
		       Lisp_Object gstring_in, int from, int to,
		       Lisp_Object gstring_out, int idx));

  /* Optional.
     Drive FONT's OTF GPOS features according to GPOS_SPEC.

     GPOS_SPEC is in this format (all elements are symbols):
	(SCRIPT LANGSYS GPOS-FEATURE ...)
     The meaning is the same as GSUB_SPEC above. 

     This method applies the specified features to the codes in the
     elements of GSTRING (between FROMth and TOth).  The resulting
     positioning information (x-offset and y-offset) is stored in the
     slots of the elements.

     Return 1 if at least one glyph has nonzero x-offset or y-offset.
     Otherwise return 0.  */
  int (*otf_gpos) P_ ((struct font *font, Lisp_Object gpos_spec,
		       Lisp_Object gstring, int from, int to));
};


struct font_driver_list
{
  struct font_driver *driver;
  struct font_driver_list *next;
};

extern int enable_font_backend;

EXFUN (Ffont_spec, MANY);
EXFUN (Flist_fonts, 4);

extern Lisp_Object font_symbolic_weight P_ ((Lisp_Object font));
extern Lisp_Object font_symbolic_slant P_ ((Lisp_Object font));
extern Lisp_Object font_symbolic_width P_ ((Lisp_Object font));

extern int font_match_p P_ ((Lisp_Object spec, Lisp_Object entity));

extern Lisp_Object font_find_object P_ ((struct font *font));
extern Lisp_Object font_get_name P_ ((Lisp_Object font_object));
extern Lisp_Object font_get_spec P_ ((Lisp_Object font_object));
extern Lisp_Object font_get_frame P_ ((Lisp_Object font_object));
extern int font_has_char P_ ((FRAME_PTR, Lisp_Object, int));
extern unsigned font_encode_char P_ ((Lisp_Object, int));

extern int font_set_lface_from_name P_ ((FRAME_PTR f,
					 Lisp_Object lface,
					 Lisp_Object fontname,
					 int force_p, int may_fail_p));
extern Lisp_Object font_find_for_lface P_ ((FRAME_PTR f, Lisp_Object *lface,
					    Lisp_Object spec));
extern Lisp_Object font_open_for_lface P_ ((FRAME_PTR f, Lisp_Object *lface,
					    Lisp_Object entity));
extern void font_load_for_face P_ ((FRAME_PTR f, struct face *face));
extern void font_prepare_for_face P_ ((FRAME_PTR f, struct face *face));
extern Lisp_Object font_open_by_name P_ ((FRAME_PTR f, char *name));

extern Lisp_Object intern_downcase P_ ((char *str, int len));
extern void font_update_sort_order P_ ((int *order));

extern void font_parse_old_font_spec P_ ((Lisp_Object, Lisp_Object,
					  Lisp_Object, Lisp_Object));


extern int font_parse_xlfd P_ ((char *name, Lisp_Object font));
extern int font_unparse_xlfd P_ ((Lisp_Object font, int pixel_size,
				  char *name, int bytes));
extern int font_parse_fcname P_ ((char *name, Lisp_Object font));
extern int font_unparse_fcname P_ ((Lisp_Object font, int pixel_size,
				  char *name, int bytes));
extern void register_font_driver P_ ((struct font_driver *driver, FRAME_PTR f));
extern void free_font_driver_list P_ ((FRAME_PTR f));

extern struct font *font_prepare_composition P_ ((struct composition *cmp));


#ifdef HAVE_LIBOTF
/* This can be used as `otf_capability' method of a font-driver.  */
extern Lisp_Object font_otf_capability P_ ((struct font *font));
/* This can be used as `otf_gsub' method of a font-driver.  */
extern int font_otf_gsub P_ ((struct font *font, Lisp_Object gsub_spec,
			      Lisp_Object gstring_in, int from, int to,
			      Lisp_Object gstring_out, int idx));
/* This can be used as `otf_gpos' method of a font-driver.  */
extern int font_otf_gpos P_ ((struct font *font, Lisp_Object gpos_spec,
			      Lisp_Object gstring, int from, int to));
#endif	/* HAVE_LIBOTF */

#ifdef HAVE_FREETYPE
extern struct font_driver ftfont_driver;
#endif	/* HAVE_FREETYPE */
#ifdef HAVE_X_WINDOWS
extern struct font_driver xfont_driver;
extern struct font_driver ftxfont_driver;
#ifdef HAVE_XFT
extern struct font_driver xftfont_driver;
#endif	/* HAVE_XFT */
#endif	/* HAVE_X_WINDOWS */
#ifdef WINDOWSNT
extern struct font_driver w32font_driver;
#endif	/* WINDOWSNT */
#ifdef MAC_OS
extern struct font_driver atmfont_driver;
#endif	/* MAC_OS */

#endif	/* not EMACS_FONT_H */

/* arch-tag: 3b7260c3-5bec-4d6b-a0db-95c1b431b1a2
   (do not change this comment) */
Commit	Line	Data
c2f5bfd6 KH	1	/* font.h -- Interface definition for font handling.
	2	Copyright (C) 2006 Free Software Foundation, Inc.
	3	Copyright (C) 2006
	4	National Institute of Advanced Industrial Science and Technology (AIST)
	5	Registration Number H13PRO009
	6
	7	This file is part of GNU Emacs.
	8
	9	GNU Emacs is free software; you can redistribute it and/or modify
	10	it under the terms of the GNU General Public License as published by
	11	the Free Software Foundation; either version 2, or (at your option)
	12	any later version.
	13
	14	GNU Emacs is distributed in the hope that it will be useful,
	15	but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	GNU General Public License for more details.
	18
	19	You should have received a copy of the GNU General Public License
	20	along with GNU Emacs; see the file COPYING. If not, write to
	21	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	22	Boston, MA 02110-1301, USA. */
	23
	24	#ifndef EMACS_FONT_H
	25	#define EMACS_FONT_H
	26
	27	#include "ccl.h"
	28
	29	/* We have three types of Lisp objects related to font.
	30
	31	FONT-SPEC
	32
	33	Vector (length FONT_SPEC_MAX) of font properties. Some
	34	properties can be left unspecified (i.e. nil). Emacs asks
	35	font-drivers to find a font by FONT-SPEC. A fontset entry
	36	specifies requisite properties whereas a face specifies just
	37	preferable properties. This object is fully modifiable by
	38	Lisp.
	39
	40	FONT-ENTITY
	41
	42	Vector (length FONT_ENTITY_MAX) of fully specified font
	43	properties that a font-driver returns upon a request of
	44	FONT-SPEC.
	45
	46	Note: Only the method `list' of a font-driver can create this
	47	object, and should never be modified by Lisp. In that sense,
	48	it may be cleaner to implement it as a Lisp object of a new
	49	type (e.g. struct Lisp_Font).
	50
	51	FONT-OBJECT
	52
	53	Lisp object of type Lisp_Misc_Save_Value encapsulating a
	54	pointer to "struct font". This corresponds to an opened font.
	55
	56	Note: The note for FONT-ENTITY also applies to this.
	57	*/
	58
	59
	60	struct font_driver;
	61	struct font;
	62
	63	/* An enumerator for each font property. This is used as an index to
	64	the vector of FONT-SPEC and FONT-ENTITY.
65
66	Note: The order is important and should not be changed. */
67
68	enum font_property_index
69	{
70	/* FONT-TYPE is a symbol indicating a font backend; currently `x',
71	`xft', `ftx', `freetype' are available. For windows, we need
72	`bdf' and `windows'. For Mac OS X, we need `atm'. */
73	FONT_TYPE_INDEX,
74
75	/* FONT-FOUNDRY is a foundry name (symbol). */
76	FONT_FOUNDRY_INDEX,
77
78	/* FONT-FAMILY is a family name (symbol). */
79	FONT_FAMILY_INDEX,
80
81	/* FONT-ADSTYLE is an additional style name (symbol). */
82	FONT_ADSTYLE_INDEX,
83
84	/* FONT-REGISTRY is a combination of a charset-registry and
85	charset0encoding name (symbol). */
86	FONT_REGISTRY_INDEX,
87
88	/* FONT-WEIGHT is a numeric value of weight (e.g. medium, bold) of
89	the font. The value is what defined by FC_WEIGHT_* in
90	fontconfig. */
91	FONT_WEIGHT_INDEX,
92
93	/* FONT-SLANT is a numeric value of slant (e.g. r, i, o) of the
94	font. The value is what defined by FC_SLANT_* in
95	fontconfig plus 100. */
96	FONT_SLANT_INDEX,
97
98	/* FONT-WIDTH is a numeric value of setwidth (e.g. normal,
99	condensed) of the font. The value is what defined by
100	FC_WIDTH_* in fontconfig. */
101	FONT_WIDTH_INDEX,
102
103	/* FONT-SIZE is a size of the font. If integer, it is a pixel
104	size. For a font-spec, the value can be float specifying a
105	point size. For a font-entity, the value can be zero meaning
106	that the font is scalable. */
107	FONT_SIZE_INDEX,
108
109	/* In a font-spec, the value is an alist of extra information of a
110	font such as name, OpenType features, and language coverage.
111	In a font-entity, the value is an extra infomation for
112	identifying a font (font-driver dependent). */
113	FONT_EXTRA_INDEX, /* alist alist */
114
115	/* This value is the length of font-spec vector. */
116	FONT_SPEC_MAX,
117
118	/* The followings are used only for a font-entity. */
119
120	/* Frame on which the font is found. The value is nil if the font
121	can be opend on any frame. */
122	FONT_FRAME_INDEX = FONT_SPEC_MAX,
123
124	/* List of font-objects opened from the font-entity. */
125	FONT_OBJLIST_INDEX,
126
127	/* This value is the length of font-entity vector. */
128	FONT_ENTITY_MAX
129	};
130
a46bb06e	131	extern Lisp_Object QCspacing, QCdpi, QCscalable, QCotf, QClanguage, QCscript;
c2f5bfd6	132
3223c449 KH	133	/* Important character set symbols. */
	134	extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp;
	135
c2f5bfd6 KH	136	extern Lisp_Object null_string;
	137	extern Lisp_Object null_vector;
	138
	139	/* Structure for an opened font. We can safely cast this structure to
	140	"struft font_info". */
	141
	142	struct font
	143	{
	144	struct font_info font;
	145
	146	/* From which font-entity the font is opened. */
	147	Lisp_Object entity;
	148
	149	/* By which pixel size the font is opened. */
	150	int pixel_size;
	151
	152	/* Font-driver for the font. */
	153	struct font_driver *driver;
	154
	155	/* File name of the font, or NULL if the font is not associated with
	156	a file. */
	157	char *file_name;
	158
	159	/* Charset to encode a character code into a glyph code of the
	160	font. */
	161	int encoding_charset;
	162
	163	/* Charset to check if a character code is supported by the font.
	164	-1 means that the contents of the font must be looked up to
	165	determine it.
	166	*/
e2a3f5b2	167	int repertory_charset;
c2f5bfd6 KH	168
	169	/* Minimum glyph width (in pixels). */
	170	int min_width;
	171
	172	/* Ascent and descent of the font (in pixels). */
	173	int ascent, descent;
	174
	175	/* There will be more to this structure, but they are private to a
	176	font-driver. */
	177	};
	178
f8657b39 KH	179	enum font_spacing
	180	{
	181	FONT_SPACING_PROPORTIONAL = 0,
	182	FONT_SPACING_DUAL = 90,
	183	FONT_SPACING_MONO = 100,
	184	FONT_SPACING_CHARCELL = 110
	185	};
	186
c2f5bfd6 KH	187	struct font_metrics
	188	{
	189	short lbearing, rbearing, width, ascent, descent;
	190	};
	191
	192	struct font_bitmap
	193	{
	194	int rows;
	195	int width;
	196	int pitch;
	197	unsigned char *buffer;
	198	int left;
	199	int top;
	200	int advance;
	201	void *extra;
	202	};
	203
	204	/* Predicates to check various font-related objects. */
	205
	206	#define FONTP(x) \
	207	(VECTORP (x) && (ASIZE (x) == FONT_SPEC_MAX \|\| ASIZE (x) == FONT_ENTITY_MAX))
	208	#define FONT_SPEC_P(x) \
	209	(VECTORP (x) && ASIZE (x) == FONT_SPEC_MAX)
	210	#define FONT_ENTITY_P(x) \
	211	(VECTORP (x) && ASIZE (x) == FONT_ENTITY_MAX)
	212	#define FONT_OBJECT_P(x) \
	213	(XTYPE (x) == Lisp_Misc && XMISCTYPE (x) == Lisp_Misc_Save_Value)
	214
	215
	216	/* Check macros for various font-related objects. */
	217
	218	#define CHECK_FONT(x) \
	219	do { if (! FONTP (x)) x = wrong_type_argument (Qfont, x); } while (0)
	220	#define CHECK_FONT_SPEC(x) \
	221	do { if (! FONT_SPEC_P (x)) x = wrong_type_argument (Qfont, x); } while (0)
	222	#define CHECK_FONT_ENTITY(x) \
	223	do { if (! FONT_ENTITY_P (x)) x = wrong_type_argument (Qfont, x); } while (0)
	224	#define CHECK_FONT_OBJECT(x) \
	225	do { if (! FONT_OBJECT_P (x)) x = wrong_type_argument (Qfont, x); } while (0)
	226
	227	#define CHECK_FONT_GET_OBJECT(x, font) \
	228	do { \
	229	if (! FONT_OBJECT_P (x)) x = wrong_type_argument (Qfont, x); \
	230	if (! XSAVE_VALUE (x)->pointer) error ("Font already closed"); \
	231	font = XSAVE_VALUE (x)->pointer; \
	232	} while (0)
	233
f8657b39 KH	234	/* Ignore the difference of font pixel sizes less than or equal to
	235	this value. */
	236	#define FONT_PIXEL_SIZE_QUANTUM 1
	237
c2f5bfd6 KH	238	struct face;
	239	struct composition;
	240
	241	/* Macros for lispy glyph-string. */
	242	#define LGSTRING_FONT(lgs) AREF (AREF ((lgs), 0), 0)
	243	#define LGSTRING_LBEARING(lgs) AREF (AREF ((lgs), 0), 1)
	244	#define LGSTRING_RBEARING(lgs) AREF (AREF ((lgs), 0), 2)
	245	#define LGSTRING_WIDTH(lgs) AREF (AREF ((lgs), 0), 3)
	246	#define LGSTRING_ASCENT(lgs) AREF (AREF ((lgs), 0), 4)
	247	#define LGSTRING_DESCENT(lgs) AREF (AREF ((lgs), 0), 5)
	248	#define LGSTRING_SET_FONT(lgs, val) ASET (AREF ((lgs), 0), 0, (val))
	249	#define LGSTRING_SET_LBEARING(lgs, val) ASET (AREF ((lgs), 0), 1, (val))
	250	#define LGSTRING_SET_RBEARING(lgs, val) ASET (AREF ((lgs), 0), 2, (val))
	251	#define LGSTRING_SET_WIDTH(lgs, val) ASET (AREF ((lgs), 0), 3, (val))
	252	#define LGSTRING_SET_ASCENT(lgs, val) ASET (AREF ((lgs), 0), 4, (val))
	253	#define LGSTRING_SET_DESCENT(lgs, val) ASET (AREF ((lgs), 0), 5, (val))
	254
	255	#define LGSTRING_LENGTH(lgs) (ASIZE ((lgs)) - 1)
	256	#define LGSTRING_GLYPH(lgs, idx) AREF ((lgs), (idx) + 1)
	257
	258	#define LGLYPH_CHAR(g) AREF ((g), 2)
	259	#define LGLYPH_CODE(g) AREF ((g), 3)
	260	#define LGLYPH_XOFF(g) AREF ((g), 4)
	261	#define LGLYPH_YOFF(g) AREF ((g), 5)
	262	#define LGLYPH_WIDTH(g) AREF ((g), 6)
	263	#define LGLYPH_WADJUST(g) AREF ((g), 7)
	264	#define LGLYPH_SET_CHAR(g, val) ASET ((g), 2, (val))
	265	#define LGLYPH_SET_CODE(g, val) ASET ((g), 3, (val))
	266	#define LGLYPH_SET_XOFF(g, val) ASET ((g), 4, (val))
	267	#define LGLYPH_SET_YOFF(g, val) ASET ((g), 5, (val))
	268	#define LGLYPH_SET_WIDTH(g, val) ASET ((g), 6, (val))
	269	#define LGLYPH_SET_WADJUST(g, val) ASET ((g), 7, (val))
	270
	271	#define FONT_INVALID_CODE 0xFFFFFFFF
	272
217caa37 KH	273	/* Font driver. Members specified as "optional" can be NULL. */
217caa37 KH	274
c2f5bfd6 KH	275	struct font_driver
	276	{
	277	/* Symbol indicating the type of the font-driver. */
	278	Lisp_Object type;
	279
	280	/* Return a cache of font-entities on FRAME. The cache must be a
	281	cons whose cdr part is the actual cache area. */
	282	Lisp_Object (*get_cache) P_ ((Lisp_Object frame));
	283
c2f5bfd6 KH	284	/* List fonts matching with FONT_SPEC on FRAME. The value is a
	285	vector of font-entities. This is the sole API that allocates
	286	font-entities. */
	287	Lisp_Object (*list) P_ ((Lisp_Object frame, Lisp_Object font_spec));
	288
217caa37 KH	289	/* Optional.
	290	List available families. The value is a list of family names
	291	(symbols). */
c2f5bfd6 KH	292	Lisp_Object (*list_family) P_ ((Lisp_Object frame));
c2f5bfd6 KH	293
217caa37 KH	294	/* Optional (if FONT_EXTRA_INDEX is not Lisp_Save_Value).
217caa37 KH	295	Free FONT_EXTRA_INDEX field of FONT_ENTITY. */
c2f5bfd6 KH	296	void (*free_entity) P_ ((Lisp_Object font_entity));
	297
	298	/* Open a font specified by FONT_ENTITY on frame F. If the font is
	299	scalable, open it with PIXEL_SIZE. */
	300	struct font (open) P_ ((FRAME_PTR f, Lisp_Object font_entity,
	301	int pixel_size));
	302
	303	/* Close FONT on frame F. */
	304	void (close) P_ ((FRAME_PTR f, struct font font));
	305
217caa37 KH	306	/* Optional (if FACE->extra is not used).
	307	Prepare FACE for displaying characters by FONT on frame F by
	308	storing some data in FACE->extra. If successful, return 0.
	309	Otherwise, return -1. */
c2f5bfd6 KH	310	int (prepare_face) P_ ((FRAME_PTR f, struct face face));
c2f5bfd6 KH	311
217caa37 KH	312	/* Optional.
217caa37 KH	313	Done FACE for displaying characters by FACE->font on frame F. */
c2f5bfd6 KH	314	void (done_face) P_ ((FRAME_PTR f, struct face face));
c2f5bfd6 KH	315
217caa37 KH	316	/* Optional.
	317	If FONT_ENTITY has a glyph for character C (Unicode code point),
	318	return 1. If not, return 0. If a font must be opened to check
	319	it, return -1. */
c2f5bfd6 KH	320	int (*has_char) P_ ((Lisp_Object entity, int c));
c2f5bfd6 KH	321
217caa37 KH	322	/* Return a glyph code of FONT for characer C (Unicode code point).
217caa37 KH	323	If FONT doesn't have such a glyph, return FONT_INVALID_CODE. */
c2f5bfd6 KH	324	unsigned (encode_char) P_ ((struct font font, int c));
	325
	326	/* Perform the size computation of glyphs of FONT and fillin members
	327	of METRICS. The glyphs are specified by their glyph codes in
	328	CODE (length NGLYPHS). */
	329	int (text_extents) P_ ((struct font font,
	330	unsigned *code, int nglyphs,
	331	struct font_metrics *metrics));
	332
217caa37 KH	333	/* Optional.
217caa37 KH	334	Draw glyphs between FROM and TO of S->char2b at (X Y) pixel
c2f5bfd6 KH	335	position of frame F with S->FACE and S->GC. If WITH_BACKGROUND
	336	is nonzero, fill the background in advance. It is assured that
	337	WITH_BACKGROUND is zero when (FROM > 0 \|\| TO < S->nchars). */
	338	int (draw) P_ ((struct glyph_string s, int from, int to,
	339	int x, int y, int with_background));
	340
217caa37 KH	341	/* Optional.
	342	Store bitmap data for glyph-code CODE of FONT in BITMAP. It is
	343	intended that this method is callled from the other font-driver
	344	for actual drawing. */
c2f5bfd6 KH	345	int (get_bitmap) P_ ((struct font font, unsigned code,
	346	struct font_bitmap *bitmap,
	347	int bits_per_pixel));
	348
217caa37 KH	349	/* Optional.
217caa37 KH	350	Free bitmap data in BITMAP. */
c2f5bfd6 KH	351	void (free_bitmap) P_ ((struct font font, struct font_bitmap *bitmap));
c2f5bfd6 KH	352
217caa37 KH	353	/* Optional.
	354	Return an outline data for glyph-code CODE of FONT. The format
	355	of the outline data depends on the font-driver. */
c2f5bfd6 KH	356	void (get_outline) P_ ((struct font *font, unsigned code));
c2f5bfd6 KH	357
217caa37 KH	358	/* Optional.
217caa37 KH	359	Free OUTLINE (that is obtained by the above method). */
c2f5bfd6 KH	360	void (free_outline) P_ ((struct font font, void *outline));
c2f5bfd6 KH	361
217caa37 KH	362	/* Optional.
217caa37 KH	363	Get coordinates of the INDEXth anchor point of the glyph whose
c2f5bfd6	364	code is CODE. Store the coordinates in X and Y. Return 0 if
217caa37	365	the operations was successfull. Otherwise return -1. */
c2f5bfd6 KH	366	int (anchor_point) P_ ((struct font font, unsigned code, int index,
	367	int x, int y));
	368
217caa37 KH	369	/* Optional.
217caa37 KH	370	Return a list describing which scripts/languages FONT
c2f5bfd6 KH	371	supports by which GSUB/GPOS features of OpenType tables. */
	372	Lisp_Object (otf_capability) P_ ((struct font font));
	373
217caa37 KH	374	/* Optional.
217caa37 KH	375	Drive FONT's OTF GSUB features according to GSUB_SPEC.
c2f5bfd6 KH	376
	377	GSUB_SPEC is in this format (all elements are symbols):
	378	(SCRIPT LANGSYS GSUB-FEATURE ...)
	379	If one of GSUB-FEATURE is nil, apply all gsub features except for
	380	already applied and listed later. For instance, if the font has
	381	GSUB features nukt, haln, rphf, blwf, and half,
	382	(deva nil nukt haln nil rphf)
	383	applies nukt and haln in this order, then applies blwf and half
	384	in the order apearing in the font. The features are of the
	385	default langsys of `deva' script.
	386
	387	This method applies the specified features to the codes in the
	388	elements of GSTRING-IN (between FROMth and TOth). The output
	389	codes are stored in GSTRING-OUT at the IDXth element and the
	390	following elements.
	391
	392	Return the number of output codes. If none of the features are
	393	applicable to the input data, return 0. If GSTRING-OUT is too
	394	short, return -1. */
	395	int (otf_gsub) P_ ((struct font font, Lisp_Object gsub_spec,
	396	Lisp_Object gstring_in, int from, int to,
	397	Lisp_Object gstring_out, int idx));
	398
217caa37 KH	399	/* Optional.
217caa37 KH	400	Drive FONT's OTF GPOS features according to GPOS_SPEC.
c2f5bfd6 KH	401
	402	GPOS_SPEC is in this format (all elements are symbols):
	403	(SCRIPT LANGSYS GPOS-FEATURE ...)
	404	The meaning is the same as GSUB_SPEC above.
	405
	406	This method applies the specified features to the codes in the
	407	elements of GSTRING (between FROMth and TOth). The resulting
	408	positioning information (x-offset and y-offset) is stored in the
	409	slots of the elements.
	410
	411	Return 1 if at least one glyph has nonzero x-offset or y-offset.
	412	Otherwise return 0. */
	413	int (otf_gpos) P_ ((struct font font, Lisp_Object gpos_spec,
	414	Lisp_Object gstring, int from, int to));
	415	};
	416
	417
	418	struct font_driver_list
	419	{
	420	struct font_driver *driver;
	421	struct font_driver_list *next;
	422	};
	423
	424	extern int enable_font_backend;
	425
	426	EXFUN (Ffont_spec, MANY);
8d3251f2	427	EXFUN (Flist_fonts, 4);
c2f5bfd6 KH	428
	429	extern Lisp_Object font_symbolic_weight P_ ((Lisp_Object font));
	430	extern Lisp_Object font_symbolic_slant P_ ((Lisp_Object font));
	431	extern Lisp_Object font_symbolic_width P_ ((Lisp_Object font));
	432
217caa37 KH	433	extern int font_match_p P_ ((Lisp_Object spec, Lisp_Object entity));
217caa37 KH	434
c2f5bfd6	435	extern Lisp_Object font_find_object P_ ((struct font *font));
217caa37 KH	436	extern Lisp_Object font_get_name P_ ((Lisp_Object font_object));
	437	extern Lisp_Object font_get_spec P_ ((Lisp_Object font_object));
	438	extern Lisp_Object font_get_frame P_ ((Lisp_Object font_object));
c2f5bfd6 KH	439	extern int font_has_char P_ ((FRAME_PTR, Lisp_Object, int));
	440	extern unsigned font_encode_char P_ ((Lisp_Object, int));
	441
	442	extern int font_set_lface_from_name P_ ((FRAME_PTR f,
	443	Lisp_Object lface,
	444	Lisp_Object fontname,
	445	int force_p, int may_fail_p));
	446	extern Lisp_Object font_find_for_lface P_ ((FRAME_PTR f, Lisp_Object *lface,
	447	Lisp_Object spec));
	448	extern Lisp_Object font_open_for_lface P_ ((FRAME_PTR f, Lisp_Object *lface,
	449	Lisp_Object entity));
	450	extern void font_load_for_face P_ ((FRAME_PTR f, struct face *face));
	451	extern void font_prepare_for_face P_ ((FRAME_PTR f, struct face *face));
	452	extern Lisp_Object font_open_by_name P_ ((FRAME_PTR f, char *name));
	453
	454	extern Lisp_Object intern_downcase P_ ((char *str, int len));
	455	extern void font_update_sort_order P_ ((int *order));
	456
	457	extern void font_parse_old_font_spec P_ ((Lisp_Object, Lisp_Object,
	458	Lisp_Object, Lisp_Object));
	459
	460
a46bb06e	461	extern int font_parse_xlfd P_ ((char *name, Lisp_Object font));
c2f5bfd6 KH	462	extern int font_unparse_xlfd P_ ((Lisp_Object font, int pixel_size,
c2f5bfd6 KH	463	char *name, int bytes));
a46bb06e	464	extern int font_parse_fcname P_ ((char *name, Lisp_Object font));
217caa37 KH	465	extern int font_unparse_fcname P_ ((Lisp_Object font, int pixel_size,
217caa37 KH	466	char *name, int bytes));
c2f5bfd6 KH	467	extern void register_font_driver P_ ((struct font_driver *driver, FRAME_PTR f));
	468	extern void free_font_driver_list P_ ((FRAME_PTR f));
	469
	470	extern struct font font_prepare_composition P_ ((struct composition cmp));
	471
	472
	473	#ifdef HAVE_LIBOTF
	474	/* This can be used as `otf_capability' method of a font-driver. */
	475	extern Lisp_Object font_otf_capability P_ ((struct font *font));
	476	/* This can be used as `otf_gsub' method of a font-driver. */
	477	extern int font_otf_gsub P_ ((struct font *font, Lisp_Object gsub_spec,
	478	Lisp_Object gstring_in, int from, int to,
	479	Lisp_Object gstring_out, int idx));
	480	/* This can be used as `otf_gpos' method of a font-driver. */
	481	extern int font_otf_gpos P_ ((struct font *font, Lisp_Object gpos_spec,
	482	Lisp_Object gstring, int from, int to));
	483	#endif /* HAVE_LIBOTF */
	484
	485	#ifdef HAVE_FREETYPE
	486	extern struct font_driver ftfont_driver;
	487	#endif /* HAVE_FREETYPE */
	488	#ifdef HAVE_X_WINDOWS
	489	extern struct font_driver xfont_driver;
	490	extern struct font_driver ftxfont_driver;
	491	#ifdef HAVE_XFT
	492	extern struct font_driver xftfont_driver;
	493	#endif /* HAVE_XFT */
	494	#endif /* HAVE_X_WINDOWS */
	495	#ifdef WINDOWSNT
	496	extern struct font_driver w32font_driver;
	497	#endif /* WINDOWSNT */
	498	#ifdef MAC_OS
	499	extern struct font_driver atmfont_driver;
	500	#endif /* MAC_OS */
	501
	502	#endif /* not EMACS_FONT_H */
885b7d09 MB	503
	504	/* arch-tag: 3b7260c3-5bec-4d6b-a0db-95c1b431b1a2
	505	(do not change this comment) */