fontutils.h revision f2e35a3a 
1/* $XTermId: fontutils.h,v 1.136 2020/10/30 00:09:09 tom Exp $ */
2
3/*
4 * Copyright 1998-2019,2020 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 xtermDerivedFont (const char * /* name */);
64extern void xtermFreeFontInfo (XTermFonts * /* target */);
65extern void xtermSetCursorBox (TScreen * /* screen */);
66extern void xtermUpdateFontGCs (XtermWidget /* xw */, MyGetFont /* myfunc */);
67extern void xtermUpdateFontInfo (XtermWidget /* xw */, Bool /* doresize */);
68
69#define getIconicFont(screen) (&((screen)->fnt_icon))
70
71/* use these when "which" is constant, or known in-limits */
72#define GetNormalFont(screen, which) (&((screen)->fnts[which]))
73#define GetDoubleFont(screen, which) (&((screen)->double_fonts[which]))
74#if OPT_WIDE_ATTRS
75#define GetItalicFont(screen, which) (&((screen)->ifnts[which]))
76#else
77#define GetItalicFont(screen, which) 0
78#endif
79
80#define FirstItemOf(vector) ((vector) ? (vector)[0] : 0)
81#define CurrentXftFont(xw)  ((xw)->work.fonts.xft.list_n[0])
82#define DefaultFontN(xw)    ((xw)->work.fonts.x11.list_n[0])
83#define DefaultFontB(xw)    ((xw)->work.fonts.x11.list_b[0])
84#define DefaultFontW(xw)    ((xw)->work.fonts.x11.list_w[0])
85#define DefaultFontWB(xw)   ((xw)->work.fonts.x11.list_wb[0])
86
87#if OPT_DEC_CHRSET
88extern char *xtermSpecialFont (XTermDraw * /* params */);
89#endif
90
91#define FontLacksMetrics(font) \
92	((font)->fs != 0 \
93	 && ((font)->fs->per_char == 0))
94
95#define FontIsIncomplete(font) \
96	((font)->fs != 0 \
97	 && (font)->fs->per_char != 0 \
98	 && !(font)->fs->all_chars_exist)
99
100#if OPT_BOX_CHARS
101
102#define ForceBoxChars(screen,ch) \
103	(xtermIsDecGraphic(ch) \
104	 && (screen)->force_box_chars)
105
106	 /*
107	  * Keep track of (some) characters to make the check for missing
108	  * characters faster.  If the character is known to be missing,
109	  * the cache value is '2'.  If we have checked the character, the
110	  * cached value is '1'.
111	  */
112#if OPT_WIDE_CHARS
113#define CheckedKnownMissing(font, ch) \
114	 (((ch) < KNOWN_MISSING) && ((font)->known_missing[(Char)(ch)] > 0))
115#else
116#define CheckedKnownMissing(font, ch) \
117	 ((font)->known_missing[(Char)(ch)] > 0)
118#endif
119
120#define IsXtermMissingChar(screen, ch, font) \
121	 (CheckedKnownMissing(font, ch) \
122	  ? ((font)->known_missing[(Char)(ch)] > 1) \
123	  : ((FontIsIncomplete(font) && xtermMissingChar(ch, font)) \
124	   || ForceBoxChars(screen, ch)))
125
126extern void xtermDrawBoxChar (XTermDraw * /* params */, unsigned /* ch */, GC /* gc */, int /* x */, int /* y */, int /* cols */, Bool /* xftords */);
127#else
128#define IsXtermMissingChar(screen, ch, font) False
129#endif
130
131#if OPT_BOX_CHARS || OPT_REPORT_FONTS
132extern Bool xtermMissingChar (unsigned /* ch */, XTermFonts */* font */);
133#endif
134
135#if OPT_LOAD_VTFONTS
136extern void HandleLoadVTFonts PROTO_XT_ACTIONS_ARGS;
137#endif
138
139#if OPT_LOAD_VTFONTS || OPT_WIDE_CHARS
140extern Bool xtermLoadWideFonts (XtermWidget /* w */, Bool /* nullOk */);
141extern void xtermSaveVTFonts (XtermWidget /* xw */);
142#endif
143
144#define xtermIsDecGraphic(ch)	((ch) > 0 && (ch) < 32)
145
146#if OPT_RENDERFONT
147extern Boolean maybeXftCache(XtermWidget /* xw */, XftFont * /* font */);
148extern Bool xtermXftMissing (XtermWidget /* xw */, XftFont * /* font */, unsigned /* wc */);
149extern XTermXftFonts *getMyXftFont (XtermWidget /* xw */, int /* which */, int /* fontnum */);
150extern XftFont *findXftGlyph (XtermWidget /* xw */, XftFont * /* given */, unsigned /* wc */);
151extern XftFont *getXftFont (XtermWidget /* xw */, VTFontEnum /* which */, int /* fontnum */);
152extern void closeCachedXft (TScreen * /* screen */, XftFont * /* font */);
153extern void xtermCloseXft (TScreen * /* screen */, XTermXftFonts * /* pub */);
154#if OPT_DEC_CHRSET
155extern XftFont * getDoubleXftFont(XTermDraw * /* params */, unsigned /* chrset */, unsigned /* attr_flags */);
156#endif
157#endif
158
159#if OPT_SHIFT_FONTS
160extern String getFaceName (XtermWidget /* xw */, Bool /* wideName */);
161extern void HandleLargerFont PROTO_XT_ACTIONS_ARGS;
162extern void HandleSmallerFont PROTO_XT_ACTIONS_ARGS;
163extern void setFaceName (XtermWidget /* xw */, const char * /*value */);
164#endif
165
166#if OPT_WIDE_ATTRS
167extern unsigned xtermUpdateItalics (XtermWidget /* xw */, unsigned /* new_attrs */, unsigned /* old_attrs */);
168extern void xtermLoadItalics (XtermWidget /* xw */);
169#endif
170
171#if OPT_WIDE_CHARS
172extern unsigned ucs2dec (TScreen * /* screen */, unsigned /* ch */);
173extern unsigned dec2ucs (TScreen * /* screen */, unsigned /* ch */);
174#endif
175
176/* *INDENT-ON* */
177
178#endif /* included_fontutils_h */
179