(Fsingle_key_description): For an invalid char, retuen
[bpt/emacs.git] / src / macgui.h
CommitLineData
1a578e9b 1/* Definitions and headers for communication on the Mac OS.
0b5538bd 2 Copyright (C) 2000, 2001, 2002, 2003, 2004,
aaef169d 3 2005, 2006 Free Software Foundation, Inc.
1a578e9b
AC
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
4fc5845f
LK
19the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20Boston, MA 02110-1301, USA. */
1a578e9b 21
e0f712ba 22/* Contributed by Andrew Choi (akochoi@mac.com). */
1a578e9b
AC
23
24#ifndef EMACS_MACGUI_H
25#define EMACS_MACGUI_H
26
1a578e9b
AC
27typedef int Display; /* fix later */
28
e7474cdd 29typedef Lisp_Object XrmDatabase;
574bdd83 30
1a578e9b 31typedef unsigned long Time;
e0f712ba 32
24972bf6
YM
33#ifdef HAVE_CARBON
34#undef Z
35#ifdef MAC_OSX
7a92caf8 36#if ! HAVE_MKTIME || BROKEN_MKTIME
e3564461 37#undef mktime
7a92caf8 38#endif
e3564461 39#undef DEBUG
e3564461
ST
40#undef free
41#undef malloc
42#undef realloc
43/* Macros max and min defined in lisp.h conflict with those in
44 precompiled header Carbon.h. */
45#undef max
46#undef min
47#undef init_process
48#include <Carbon/Carbon.h>
7a92caf8 49#if ! HAVE_MKTIME || BROKEN_MKTIME
c3f4c690
ST
50#undef mktime
51#define mktime emacs_mktime
7a92caf8 52#endif
e3564461
ST
53#undef free
54#define free unexec_free
55#undef malloc
56#define malloc unexec_malloc
57#undef realloc
58#define realloc unexec_realloc
59#undef min
60#define min(a, b) ((a) < (b) ? (a) : (b))
61#undef max
62#define max(a, b) ((a) > (b) ? (a) : (b))
63#undef init_process
64#define init_process emacs_init_process
65#undef INFINITY
24972bf6
YM
66#else /* not MAC_OSX */
67#undef SIGHUP
68#define OLDP2C 1
69#include <Carbon.h>
70#endif /* not MAC_OSX */
71#undef Z
72#define Z (current_buffer->text->z)
73#else /* not HAVE_CARBON */
e3564461
ST
74#include <QuickDraw.h> /* for WindowPtr */
75#include <QDOffscreen.h> /* for GWorldPtr */
2f063626 76#include <Appearance.h> /* for ThemeCursor */
b15325b2 77#include <Windows.h>
2f063626 78#include <Controls.h>
50bf7673 79#include <Gestalt.h>
24972bf6 80#endif /* not HAVE_CARBON */
1a578e9b 81
b0635670
YM
82/* Whether to use ATSUI (Apple Type Services for Unicode Imaging) for
83 text drawing. */
84#ifndef USE_ATSUI
85#ifdef MAC_OSX
86#define USE_ATSUI 1
87#endif
88#endif
89
90/* Whether to use low-level Quartz 2D (aka Core Graphics) text drawing
91 in preference to ATSUI for ASCII and Latin-1 characters. */
58826ef7
YM
92#ifndef USE_CG_TEXT_DRAWING
93#if USE_ATSUI && MAC_OS_X_VERSION_MAX_ALLOWED >= 1030
94#define USE_CG_TEXT_DRAWING 1
95#endif
96#endif
97
b0635670
YM
98/* Whether to use Quartz 2D routines for drawing operations other than
99 texts. */
58826ef7 100#ifndef USE_CG_DRAWING
b0635670 101#if USE_ATSUI && MAC_OS_X_VERSION_MAX_ALLOWED >= 1020
58826ef7
YM
102#define USE_CG_DRAWING 1
103#endif
104#endif
105
b1b415de
YM
106/* Whether to use the standard Font Panel floating dialog. */
107#ifndef USE_MAC_FONT_PANEL
108#if USE_ATSUI && MAC_OS_X_VERSION_MAX_ALLOWED >= 1020
109#define USE_MAC_FONT_PANEL 1
110#endif
111#endif
112
a625bb4e
YM
113/* Whether to use Text Services Manager. */
114#ifndef USE_MAC_TSM
bc0e8412 115#if TARGET_API_MAC_CARBON
a625bb4e
YM
116#define USE_MAC_TSM 1
117#endif
118#endif
119
b15325b2 120typedef WindowPtr Window;
e3564461
ST
121typedef GWorldPtr Pixmap;
122
50bf7673
ST
123#define Cursor ThemeCursor
124#define No_Cursor (-1)
50bf7673 125
1a578e9b
AC
126#define FACE_DEFAULT (~0)
127
886a6e31
YM
128#if !TARGET_API_MAC_CARBON
129#define GetPixDepth(pmh) ((*(pmh))->pixelSize)
130#endif
131
1a578e9b
AC
132
133/* Emulate XCharStruct. */
b0635670
YM
134/* If the sum of ascent and descent is negative, that means some
135 special status specified by enum pcm_status. */
1a578e9b
AC
136typedef struct _XCharStruct
137{
eaf92438
YM
138 short lbearing; /* origin to left edge of raster */
139 short rbearing; /* origin to right edge of raster */
140 short width; /* advance to next char's origin */
141 short ascent; /* baseline to top edge of raster */
142 short descent; /* baseline to bottom edge of raster */
143#if 0
144 unsigned short attributes; /* per char flags (not predefined) */
145#endif
1a578e9b
AC
146} XCharStruct;
147
b0635670
YM
148enum pcm_status
149 {
150 PCM_VALID = 0, /* pcm data is valid */
151 PCM_INVALID = -1, /* pcm data is invalid */
152 };
153
8c2da0fa
ST
154#define STORE_XCHARSTRUCT(xcs, w, bds) \
155 ((xcs).width = (w), \
156 (xcs).lbearing = (bds).left, \
157 (xcs).rbearing = (bds).right, \
158 (xcs).ascent = -(bds).top, \
06505fd8
YM
159 (xcs).descent = (bds).bottom)
160
1a578e9b 161struct MacFontStruct {
a6d1cf01 162 char *full_name;
1a578e9b 163
e0f712ba 164 short mac_fontnum; /* font number of font used in this window */
1a578e9b 165 int mac_fontsize; /* size of font */
e0f712ba 166 short mac_fontface; /* plain, bold, italics, etc. */
a6d1cf01
YM
167#if TARGET_API_MAC_CARBON
168 int mac_scriptcode; /* Mac OS script code for font used */
169#else
1a578e9b 170 short mac_scriptcode; /* Mac OS script code for font used */
a6d1cf01 171#endif
04904a23
YM
172#if USE_ATSUI
173 ATSUStyle mac_style; /* NULL if QuickDraw Text is used */
26d2699b
YM
174#if USE_CG_TEXT_DRAWING
175 CGFontRef cg_font; /* NULL if ATSUI text drawing is used */
176 CGGlyph *cg_glyphs; /* Likewise */
177#endif
04904a23 178#endif
1a578e9b
AC
179
180/* from Xlib.h */
181#if 0
182 XExtData *ext_data; /* hook for extension to hang data */
183 Font fid; /* Font id for this font */
184 unsigned direction; /* hint about the direction font is painted */
e0f712ba 185#endif /* 0 */
1a578e9b
AC
186 unsigned min_char_or_byte2;/* first character */
187 unsigned max_char_or_byte2;/* last character */
188 unsigned min_byte1; /* first row that exists */
189 unsigned max_byte1; /* last row that exists */
190#if 0
191 Bool all_chars_exist; /* flag if all characters have nonzero size */
192 unsigned default_char; /* char to print for undefined character */
193 int n_properties; /* how many properties there are */
194 XFontProp *properties; /* pointer to array of additional properties */
e0f712ba 195#endif /* 0 */
1a578e9b
AC
196 XCharStruct min_bounds; /* minimum bounds over all existing char */
197 XCharStruct max_bounds; /* maximum bounds over all existing char */
06505fd8
YM
198 union {
199 XCharStruct *per_char; /* first_char to last_char information */
b0635670 200 XCharStruct **rows; /* first row to last row information */
06505fd8 201 } bounds;
1a578e9b
AC
202 int ascent; /* logical extent above baseline for spacing */
203 int descent; /* logical decent below baseline for spacing */
204};
205
206typedef struct MacFontStruct MacFontStruct;
207typedef struct MacFontStruct XFontStruct;
208
ec480ce0
KS
209/* Structure borrowed from Xlib.h to represent two-byte characters. */
210
211typedef struct {
212 unsigned char byte1;
213 unsigned char byte2;
214} XChar2b;
215
216#define STORE_XCHAR2B(chp, b1, b2) \
217 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
218
219#define XCHAR2B_BYTE1(chp) \
220 ((chp)->byte1)
221
222#define XCHAR2B_BYTE2(chp) \
223 ((chp)->byte2)
224
1a578e9b
AC
225
226/* Emulate X GC's by keeping color and font info in a structure. */
227typedef struct _XGCValues
228{
229 unsigned long foreground;
230 unsigned long background;
231 XFontStruct *font;
232} XGCValues;
233
623cc1d8
YM
234typedef struct _XGC
235{
236 /* Original value. */
237 XGCValues xgcv;
238
239 /* Cached data members follow. */
1a578e9b 240
623cc1d8
YM
241 /* QuickDraw foreground color. */
242 RGBColor fore_color;
1a578e9b 243
623cc1d8
YM
244 /* QuickDraw background color. */
245 RGBColor back_color;
2be96ef8
YM
246
247#define MAX_CLIP_RECTS 2
c6c45177
YM
248 /* Number of clipping rectangles. */
249 int n_clip_rects;
250
251 /* QuickDraw clipping region. Ignored if n_clip_rects == 0. */
2be96ef8
YM
252 RgnHandle clip_region;
253
b0635670 254#if defined (MAC_OSX) && (USE_ATSUI || USE_CG_DRAWING)
2be96ef8
YM
255 /* Clipping rectangles used in Quartz 2D drawing. The y-coordinate
256 is in QuickDraw's. */
257 CGRect clip_rects[MAX_CLIP_RECTS];
258#endif
623cc1d8
YM
259} *GC;
260
261#define GCForeground (1L<<2)
262#define GCBackground (1L<<3)
263#define GCFont (1L<<14)
264#define GCGraphicsExposures 0
1a578e9b
AC
265
266/* Bit Gravity */
267
268#define ForgetGravity 0
269#define NorthWestGravity 1
270#define NorthGravity 2
271#define NorthEastGravity 3
272#define WestGravity 4
273#define CenterGravity 5
274#define EastGravity 6
275#define SouthWestGravity 7
276#define SouthGravity 8
277#define SouthEastGravity 9
278#define StaticGravity 10
279
280#define NoValue 0x0000
281#define XValue 0x0001
282#define YValue 0x0002
283#define WidthValue 0x0004
284#define HeightValue 0x0008
285#define AllValues 0x000F
286#define XNegative 0x0010
287#define YNegative 0x0020
288
b15325b2
ST
289typedef struct {
290 long flags; /* marks which fields in this structure are defined */
291#if 0
292 int x, y; /* obsolete for new window mgrs, but clients */
293 int width, height; /* should set so old wm's don't mess up */
294#endif
295 int min_width, min_height;
296#if 0
297 int max_width, max_height;
298#endif
299 int width_inc, height_inc;
300#if 0
301 struct {
302 int x; /* numerator */
303 int y; /* denominator */
304 } min_aspect, max_aspect;
305#endif
306 int base_width, base_height; /* added by ICCCM version 1 */
307#if 0
308 int win_gravity; /* added by ICCCM version 1 */
309#endif
310} XSizeHints;
311
1a578e9b
AC
312#define USPosition (1L << 0) /* user specified x, y */
313#define USSize (1L << 1) /* user specified width, height */
314
315#define PPosition (1L << 2) /* program specified position */
316#define PSize (1L << 3) /* program specified size */
317#define PMinSize (1L << 4) /* program specified minimum size */
318#define PMaxSize (1L << 5) /* program specified maximum size */
319#define PResizeInc (1L << 6) /* program specified resize increments */
320#define PAspect (1L << 7) /* program specified min and max aspect ratios */
321#define PBaseSize (1L << 8) /* program specified base for incrementing */
322#define PWinGravity (1L << 9) /* program specified window gravity */
323
e119ad0d
KS
324typedef struct {
325 int x, y;
326 unsigned width, height;
327} XRectangle;
328
329#define NativeRectangle Rect
330
331#define CONVERT_TO_XRECT(xr,nr) \
332 ((xr).x = (nr).left, \
333 (xr).y = (nr).top, \
334 (xr).width = ((nr).right - (nr).left), \
335 (xr).height = ((nr).bottom - (nr).top))
336
337#define CONVERT_FROM_XRECT(xr,nr) \
338 ((nr).left = (xr).x, \
339 (nr).top = (xr).y, \
340 (nr).right = ((xr).x + (xr).width), \
341 (nr).bottom = ((xr).y + (xr).height))
342
343#define STORE_NATIVE_RECT(nr,x,y,width,height) \
344 ((nr).left = (x), \
345 (nr).top = (y), \
346 (nr).right = ((nr).left + (width)), \
347 (nr).bottom = ((nr).top + (height)))
348
1a578e9b
AC
349#endif /* EMACS_MACGUI_H */
350
ab5796a9
MB
351/* arch-tag: 5a0da49a-35e2-418b-a58c-8a55778ae849
352 (do not change this comment) */