fontutils.h revision 913cc679 
1/* $XTermId: fontutils.h,v 1.119 2017/06/19 08:31:10 tom Exp $ */
2
3/*
4 * Copyright 1998-2016,2017 by Thomas E. Dickey
5 *
6 *                         All Rights Reserved
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
23 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 *
27 * Except as contained in this notice, the name(s) of the above copyright
28 * holders shall not be used in advertising or otherwise to promote the
29 * sale, use or other dealings in this Software without prior written
30 * authorization.
31 */
32
33#ifndef included_fontutils_h
34#define included_fontutils_h 1
35
36#include <xterm.h>
37/* *INDENT-OFF* */
38
39extern Bool xtermLoadDefaultFonts (XtermWidget /* xw */);
40extern Bool xtermOpenFont (XtermWidget /* xw */, const char */* name */, XTermFonts * /* result */, Bool /* force */);
41extern XTermFonts * getDoubleFont (TScreen * /* screen */, int /* which */);
42extern XTermFonts * getItalicFont (TScreen * /* screen */, int /* which */);
43extern XTermFonts * getNormalFont (TScreen * /* screen */, int /* which */);
44extern const VTFontNames * defaultVTFontNames(XtermWidget /* xw */);
45extern const VTFontNames * xtermFontName (const char */* normal */);
46extern const char * whichFontEnum (VTFontEnum /* value */);
47extern const char * whichFontList (XtermWidget /* xw */, VTFontList * /* value */);
48extern const char * whichFontList2(XtermWidget /* xw */, char ** /* value */);
49extern int lookupRelativeFontSize (XtermWidget /* xw */, int /* old */, int /* relative */);
50extern int xtermGetFont (const char * /* param */);
51extern int xtermLoadFont (XtermWidget /* xw */, const VTFontNames */* fonts */, Bool /* doresize */, int /* fontnum */);
52extern void HandleSetFont PROTO_XT_ACTIONS_ARGS;
53extern void SetVTFont (XtermWidget /* xw */, int /* i */, Bool /* doresize */, const VTFontNames */* fonts */);
54extern void allocFontList (XtermWidget /* xw */, const char * /* name */, XtermFontNames * /* target */, VTFontEnum /* which */, const char * /* source */, Bool /* ttf */);
55extern void copyFontList (char *** /* targetp */, char ** /* source */);
56extern void initFontLists (XtermWidget /* xw */);
57extern void freeFontList (char *** /* targetp */);
58extern void freeFontLists (VTFontList * /* lists */);
59extern void xtermCloseFont (XtermWidget /* xw */, XTermFonts * /* fnt */);
60extern void xtermCloseFonts (XtermWidget /* xw */, XTermFonts * /* fnts[fMAX] */);
61extern void xtermComputeFontInfo (XtermWidget /* xw */, VTwin */* win */, XFontStruct */* font */, int /* sbwidth */);
62extern void xtermCopyFontInfo (XTermFonts * /* target */, XTermFonts * /* source */);
63extern void xtermFreeFontInfo (XTermFonts * /* target */);
64extern void xtermSaveFontInfo (TScreen * /* screen */, XFontStruct */* font */);
65extern void xtermSetCursorBox (TScreen * /* screen */);
66extern void xtermUpdateFontGCs (XtermWidget /* xw */, Bool /* italic */);
67extern void xtermUpdateFontInfo (XtermWidget /* xw */, Bool /* doresize */);
68
69#define getIconicFont(screen) (&((screen)->fnt_icon))
70
71#define FirstItemOf(vector) ((vector) ? (vector)[0] : 0)
72#define CurrentXftFont(xw)  ((xw)->work.fonts.xft.list_n[0])
73#define DefaultFontN(xw)    ((xw)->work.fonts.x11.list_n[0])
74#define DefaultFontB(xw)    ((xw)->work.fonts.x11.list_b[0])
75#define DefaultFontW(xw)    ((xw)->work.fonts.x11.list_w[0])
76#define DefaultFontWB(xw)   ((xw)->work.fonts.x11.list_wb[0])
77
78#if OPT_DEC_CHRSET
79extern char *xtermSpecialFont (XtermWidget /* xw */, unsigned /* attr_flags */, unsigned /* draw_flags */, unsigned /* chrset */);
80#endif
81
82#define FontLacksMetrics(font) \
83	((font)->fs != 0 \
84	 && ((font)->fs->per_char == 0))
85
86#define FontIsIncomplete(font) \
87	((font)->fs != 0 \
88	 && (font)->fs->per_char != 0 \
89	 && !(font)->fs->all_chars_exist)
90
91#if OPT_BOX_CHARS
92
93#define ForceBoxChars(screen,ch) \
94	(xtermIsDecGraphic(ch) \
95	 && (screen)->force_box_chars)
96
97	 /*
98	  * Keep track of (some) characters to make the check for missing
99	  * characters faster.  If the character is known to be missing,
100	  * the cache value is '2'.  If we have checked the character, the
101	  * cached value is '1'.
102	  */
103#if OPT_WIDE_CHARS
104#define CheckedKnownMissing(font, ch) \
105	 (((ch) < KNOWN_MISSING) && ((font)->known_missing[(Char)(ch)] > 0))
106#else
107#define CheckedKnownMissing(font, ch) \
108	 ((font)->known_missing[(Char)(ch)] > 0)
109#endif
110
111#define IsXtermMissingChar(screen, ch, font) \
112	 (CheckedKnownMissing(font, ch) \
113	  ? ((font)->known_missing[(Char)(ch)] > 1) \
114	  : ((FontIsIncomplete(font) && xtermMissingChar(ch, font)) \
115	   || ForceBoxChars(screen, ch)))
116
117extern void xtermDrawBoxChar (XtermWidget /* xw */, unsigned /* ch */, unsigned /* attr_flags */, unsigned /* draw_flags */, GC /* gc */, int /* x */, int /* y */, int /* cols */);
118#else
119#define IsXtermMissingChar(screen, ch, font) False
120#endif
121
122#if OPT_BOX_CHARS || OPT_REPORT_FONTS
123extern Bool xtermMissingChar (unsigned /* ch */, XTermFonts */* font */);
124#endif
125
126#if OPT_LOAD_VTFONTS
127extern void HandleLoadVTFonts PROTO_XT_ACTIONS_ARGS;
128#endif
129
130#if OPT_LOAD_VTFONTS || OPT_WIDE_CHARS
131extern Bool xtermLoadWideFonts (XtermWidget /* w */, Bool /* nullOk */);
132extern void xtermSaveVTFonts (XtermWidget /* xw */);
133#endif
134
135#define xtermIsDecGraphic(ch)	((ch) > 0 && (ch) < 32)
136
137#if OPT_RENDERFONT
138extern Bool xtermXftMissing (XtermWidget /* xw */, XftFont * /* font */, unsigned /* wc */);
139extern XTermXftFonts *getMyXftFont (XtermWidget /* xw */, int /* which */, int /* fontnum */);
140extern XftFont *getXftFont (XtermWidget /* xw */, VTFontEnum /* which */, int /* fontnum */);
141extern void xtermCloseXft (TScreen * /* screen */, XTermXftFonts * /* pub */);
142#endif
143
144#if OPT_SHIFT_FONTS
145extern String getFaceName (XtermWidget /* xw */, Bool /* wideName */);
146extern void HandleLargerFont PROTO_XT_ACTIONS_ARGS;
147extern void HandleSmallerFont PROTO_XT_ACTIONS_ARGS;
148extern void setFaceName (XtermWidget /* xw */, const char * /*value */);
149#endif
150
151#if OPT_WIDE_ATTRS
152extern void xtermLoadItalics (XtermWidget /* xw */);
153#endif
154
155#if OPT_WIDE_CHARS
156extern unsigned ucs2dec (unsigned);
157extern unsigned dec2ucs (unsigned);
158#endif
159
160/* *INDENT-ON* */
161
162#endif /* included_fontutils_h */
163