/* font.h -- Interface definition for font handling.
- Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc.
- Copyright (C) 2006, 2007, 2008
+ Copyright (C) 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+ Copyright (C) 2006, 2007, 2008, 2009, 2010
National Institute of Advanced Industrial Science and Technology (AIST)
Registration Number H13PRO009
enum font_property_index
{
/* FONT-TYPE is a symbol indicating a font backend; currently `x',
- `xft', `ftx' are available on X and gdi on Windows.
- For Windows, `bdf' and `uniscribe' backends are in progress.
- For Mac OS X, we need `atm'. */
+ `xft', `ftx' are available on X, `uniscribe' and `gdi' on
+ Windows, and `ns' under Cocoa / GNUstep. */
FONT_TYPE_INDEX,
/* FONT-FOUNDRY is a foundry name (symbol). */
/* In a font-spec, the value is an alist of extra information of a
font such as name, OpenType features, and language coverage.
In addition, in a font-entity, the value may contain a pair
- (font-entity . INFO) where INFO is an extra infomation to
- identify a font (font-driver dependent). */
+ (font-entity . INFO) where INFO is extra information to identify
+ a font (font-driver dependent). */
FONT_EXTRA_INDEX, /* alist alist */
/* This value is the length of font-spec vector. */
/* XLFD name of the font (string). */
FONT_NAME_INDEX = FONT_ENTITY_MAX,
-
+
/* Full name of the font (string). It is the name extracted from
the opend font, and may be different from the above. It may be
nil if the opened font doesn't give a name. */
extern Lisp_Object Qascii_0;
extern Lisp_Object Qiso8859_1, Qiso10646_1, Qunicode_bmp, Qunicode_sip;
+/* Special ADSTYLE properties to avoid fonts used for Latin characters. */
+extern Lisp_Object Qja, Qko;
+
/* Structure for a font-spec. */
struct font_spec
/* Symbol indicating the type of the font-driver. */
Lisp_Object type;
- /* 1 iff the font's foundary, family, and adstyle names are case
+ /* 1 iff the font's foundry, family, and adstyle names are case
sensitve. */
int case_sensitive;
Lisp_Object (*get_cache) P_ ((FRAME_PTR F));
/* List fonts exactly matching with FONT_SPEC on FRAME. The value
- is a list of font-entities. It is assured that the properties
- WEIGHT to AVGWIDTH are all nil (i.e. not specified) in FONT_SPEC.
+ is a list of font-entities. The font properties to be considered
+ are: :foundry, :family, :adstyle, :registry, :script, :lang, and
+ :otf. See the function `font-spec' for their meanings. Note
+ that the last three properties are stored in FONT_EXTRA_INDEX
+ slot of FONT_SPEC.
+
+ The returned value is a list of font-entities. Each font-entity
+ has :type property whose value is the same as the above `type'.
+ It also has these properties if they are available from the
+ corresponding font; :foundry, :family, :adstyle, :registry,
+ :weight, :slant, :width, :size, :dpi, :spacing, :avgwidth. If
+ the font is scalable, :size and :avgwidth must be 0.
+
+ The `open' method of the same font-backend is called with one of
+ the returned font-entities. If the backend needs additional
+ information to be used in `open' method, this method can add any
+ Lispy value by the property :font-entity to the entities.
+
This and the following `match' are the only APIs that allocate
font-entities. */
Lisp_Object (*list) P_ ((Lisp_Object frame, Lisp_Object font_spec));
- /* Return a font entity most closely maching with FONT_SPEC on
- FRAME. The closeness is detemined by the font backend, thus
- `face-font-selection-order' is ignored here. */
+ /* Return a font-entity most closely matching with FONT_SPEC on
+ FRAME. Which font property to consider, and how to calculate the
+ closeness is determined by the font backend, thus
+ `face-font-selection-order' is ignored here.
+
+ The properties that the font-entity has is the same as `list'
+ method. */
Lisp_Object (*match) P_ ((Lisp_Object frame, Lisp_Object font_spec));
/* Optional.
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));
+ If FONT (FONT-ENTITY or FONT-OBJECT) has a glyph for character C
+ (Unicode code point), return 1. If not, return 0. If FONT is
+ FONT-ENTITY and it must be opened to check it, return -1. */
+ int (*has_char) P_ ((Lisp_Object font, int c));
- /* Return a glyph code of FONT for characer C (Unicode code point).
+ /* Return a glyph code of FONT for character 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));
makes some data specific to F and stores it in F by calling
font_put_frame_data (). */
int (*start_for_frame) P_ ((FRAME_PTR f));
-
+
/* Optional.
End using the driver for frame F. Usually this function free
some data stored for F. */
/* Optional.
If FONT is usable on frame F, return 0. Otherwise return -1.
- */
+ This method is used only for debugging. If this method is NULL,
+ Emacs assumes that the font is usable on any frame. */
int (*check) P_ ((FRAME_PTR F, struct font *font));
+
+ /* Optional.
+
+ Return the number of variation glyphs of character C supported by
+ FONT. VARIATIONS is an array of 256 elements. If the variation
+ selector N (1..256) defines a glyph, that glyph code is stored in
+ the (N-1)th element of VARIATIONS. */
+ int (*get_variation_glyphs) P_ ((struct font *font,
+ int c, unsigned variations[256]));
+
+ void (*filter_properties) P_ ((Lisp_Object font, Lisp_Object properties));
+
+ /* Optional.
+
+ Return non-zero if FONT_OBJECT can be used as a (cached) font
+ for ENTITY on frame F. */
+ int (*cached_font_ok) P_ ((struct frame *f,
+ Lisp_Object font_object,
+ Lisp_Object entity));
};
extern Lisp_Object font_style_symbolic P_ ((Lisp_Object font,
enum font_property_index prop,
int for_face));
-
+
extern int font_match_p P_ ((Lisp_Object spec, Lisp_Object font));
extern Lisp_Object font_list_entities P_ ((Lisp_Object frame,
Lisp_Object spec));
extern void font_prepare_for_face P_ ((FRAME_PTR f, struct face *face));
extern void font_done_for_face P_ ((FRAME_PTR f, struct face *face));
+extern Lisp_Object font_open_by_spec P_ ((FRAME_PTR f, Lisp_Object spec));
extern Lisp_Object font_open_by_name P_ ((FRAME_PTR f, char *name));
extern void font_close_object (FRAME_PTR f, Lisp_Object font_object);
extern void *font_get_frame_data P_ ((FRAME_PTR f,
struct font_driver *driver));
+extern void font_filter_properties (Lisp_Object font,
+ Lisp_Object alist,
+ const char *boolean_properties[],
+ const char *non_boolean_properties[]);
+
#ifdef HAVE_FREETYPE
extern struct font_driver ftfont_driver;
#endif /* HAVE_FREETYPE */
#define FONT_DEBUG
#endif
+extern Lisp_Object Vfont_log;
extern void font_add_log P_ ((char *, Lisp_Object, Lisp_Object));
extern void font_deferred_log P_ ((char *, Lisp_Object, Lisp_Object));
+#define FONT_ADD_LOG(ACTION, ARG, RESULT) \
+ do { \
+ if (! EQ (Vfont_log, Qt)) \
+ font_add_log ((ACTION), (ARG), (RESULT)); \
+ } while (0)
+
+#define FONT_DEFERRED_LOG(ACTION, ARG, RESULT) \
+ do { \
+ if (! EQ (Vfont_log, Qt)) \
+ font_deferred_log ((ACTION), (ARG), (RESULT)); \
+ } while (0)
+
#ifdef FONT_DEBUG
#define font_assert(X) do {if (!(X)) abort ();} while (0)
#else /* not FONT_DEBUG */
HCoop / bpt / emacs.git / blobdiff