(x_set_background_color, mac_window, x_create_tip_frame):
[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,
8cabe764 3 2005, 2006, 2007, 2008 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
684d6f5b 9the Free Software Foundation; either version 3, or (at your option)
1a578e9b
AC
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
b0b2caf8 27typedef struct _XDisplay Display; /* opaque */
1a578e9b 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 */
693b73c4 74#include <QuickDraw.h> /* for WindowRef */
e3564461 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
693b73c4 101#if 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
693b73c4
YM
120/* Whether to use HIToolbar. */
121#ifndef USE_MAC_TOOLBAR
122#if USE_CG_DRAWING && MAC_OS_X_VERSION_MAX_ALLOWED >= 1030 && MAC_OS_X_VERSION_MIN_REQUIRED != 1020
123#define USE_MAC_TOOLBAR 1
124#endif
125#endif
126
127typedef WindowRef Window;
e3564461
ST
128typedef GWorldPtr Pixmap;
129
50bf7673
ST
130#define Cursor ThemeCursor
131#define No_Cursor (-1)
50bf7673 132
1a578e9b
AC
133#define FACE_DEFAULT (~0)
134
886a6e31
YM
135#if !TARGET_API_MAC_CARBON
136#define GetPixDepth(pmh) ((*(pmh))->pixelSize)
137#endif
138
1a578e9b
AC
139
140/* Emulate XCharStruct. */
b0635670
YM
141/* If the sum of ascent and descent is negative, that means some
142 special status specified by enum pcm_status. */
1a578e9b
AC
143typedef struct _XCharStruct
144{
eaf92438
YM
145 short lbearing; /* origin to left edge of raster */
146 short rbearing; /* origin to right edge of raster */
147 short width; /* advance to next char's origin */
148 short ascent; /* baseline to top edge of raster */
149 short descent; /* baseline to bottom edge of raster */
150#if 0
151 unsigned short attributes; /* per char flags (not predefined) */
152#endif
1a578e9b
AC
153} XCharStruct;
154
b0635670
YM
155enum pcm_status
156 {
157 PCM_VALID = 0, /* pcm data is valid */
158 PCM_INVALID = -1, /* pcm data is invalid */
159 };
160
8c2da0fa
ST
161#define STORE_XCHARSTRUCT(xcs, w, bds) \
162 ((xcs).width = (w), \
163 (xcs).lbearing = (bds).left, \
164 (xcs).rbearing = (bds).right, \
165 (xcs).ascent = -(bds).top, \
06505fd8
YM
166 (xcs).descent = (bds).bottom)
167
1a578e9b 168struct MacFontStruct {
a6d1cf01 169 char *full_name;
1a578e9b 170
e0f712ba 171 short mac_fontnum; /* font number of font used in this window */
1a578e9b 172 int mac_fontsize; /* size of font */
e0f712ba 173 short mac_fontface; /* plain, bold, italics, etc. */
a6d1cf01
YM
174#if TARGET_API_MAC_CARBON
175 int mac_scriptcode; /* Mac OS script code for font used */
176#else
1a578e9b 177 short mac_scriptcode; /* Mac OS script code for font used */
a6d1cf01 178#endif
04904a23
YM
179#if USE_ATSUI
180 ATSUStyle mac_style; /* NULL if QuickDraw Text is used */
26d2699b
YM
181#if USE_CG_TEXT_DRAWING
182 CGFontRef cg_font; /* NULL if ATSUI text drawing is used */
183 CGGlyph *cg_glyphs; /* Likewise */
184#endif
04904a23 185#endif
1a578e9b
AC
186
187/* from Xlib.h */
188#if 0
189 XExtData *ext_data; /* hook for extension to hang data */
190 Font fid; /* Font id for this font */
191 unsigned direction; /* hint about the direction font is painted */
e0f712ba 192#endif /* 0 */
1a578e9b
AC
193 unsigned min_char_or_byte2;/* first character */
194 unsigned max_char_or_byte2;/* last character */
195 unsigned min_byte1; /* first row that exists */
196 unsigned max_byte1; /* last row that exists */
197#if 0
198 Bool all_chars_exist; /* flag if all characters have nonzero size */
199 unsigned default_char; /* char to print for undefined character */
200 int n_properties; /* how many properties there are */
201 XFontProp *properties; /* pointer to array of additional properties */
e0f712ba 202#endif /* 0 */
1a578e9b
AC
203 XCharStruct min_bounds; /* minimum bounds over all existing char */
204 XCharStruct max_bounds; /* maximum bounds over all existing char */
06505fd8
YM
205 union {
206 XCharStruct *per_char; /* first_char to last_char information */
b0635670 207 XCharStruct **rows; /* first row to last row information */
06505fd8 208 } bounds;
1a578e9b
AC
209 int ascent; /* logical extent above baseline for spacing */
210 int descent; /* logical decent below baseline for spacing */
211};
212
213typedef struct MacFontStruct MacFontStruct;
214typedef struct MacFontStruct XFontStruct;
215
ec480ce0
KS
216/* Structure borrowed from Xlib.h to represent two-byte characters. */
217
218typedef struct {
219 unsigned char byte1;
220 unsigned char byte2;
221} XChar2b;
222
223#define STORE_XCHAR2B(chp, b1, b2) \
224 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
225
226#define XCHAR2B_BYTE1(chp) \
227 ((chp)->byte1)
228
229#define XCHAR2B_BYTE2(chp) \
230 ((chp)->byte2)
231
1a578e9b
AC
232
233/* Emulate X GC's by keeping color and font info in a structure. */
234typedef struct _XGCValues
235{
236 unsigned long foreground;
237 unsigned long background;
238 XFontStruct *font;
239} XGCValues;
240
623cc1d8
YM
241typedef struct _XGC
242{
243 /* Original value. */
244 XGCValues xgcv;
245
246 /* Cached data members follow. */
1a578e9b 247
623cc1d8
YM
248 /* QuickDraw foreground color. */
249 RGBColor fore_color;
1a578e9b 250
623cc1d8
YM
251 /* QuickDraw background color. */
252 RGBColor back_color;
2be96ef8 253
3bfd2d46
YM
254#if USE_CG_DRAWING && MAC_OS_X_VERSION_MAX_ALLOWED >= 1030
255 /* Quartz 2D foreground color. */
256 CGColorRef cg_fore_color;
257
258 /* Quartz 2D background color. */
259 CGColorRef cg_back_color;
260#endif
261
2be96ef8 262#define MAX_CLIP_RECTS 2
c6c45177
YM
263 /* Number of clipping rectangles. */
264 int n_clip_rects;
265
266 /* QuickDraw clipping region. Ignored if n_clip_rects == 0. */
2be96ef8
YM
267 RgnHandle clip_region;
268
b0635670 269#if defined (MAC_OSX) && (USE_ATSUI || USE_CG_DRAWING)
2be96ef8
YM
270 /* Clipping rectangles used in Quartz 2D drawing. The y-coordinate
271 is in QuickDraw's. */
272 CGRect clip_rects[MAX_CLIP_RECTS];
273#endif
623cc1d8
YM
274} *GC;
275
276#define GCForeground (1L<<2)
277#define GCBackground (1L<<3)
278#define GCFont (1L<<14)
279#define GCGraphicsExposures 0
1a578e9b
AC
280
281/* Bit Gravity */
282
283#define ForgetGravity 0
284#define NorthWestGravity 1
285#define NorthGravity 2
286#define NorthEastGravity 3
287#define WestGravity 4
288#define CenterGravity 5
289#define EastGravity 6
290#define SouthWestGravity 7
291#define SouthGravity 8
292#define SouthEastGravity 9
293#define StaticGravity 10
294
295#define NoValue 0x0000
296#define XValue 0x0001
297#define YValue 0x0002
298#define WidthValue 0x0004
299#define HeightValue 0x0008
300#define AllValues 0x000F
301#define XNegative 0x0010
302#define YNegative 0x0020
303
b15325b2
ST
304typedef struct {
305 long flags; /* marks which fields in this structure are defined */
306#if 0
307 int x, y; /* obsolete for new window mgrs, but clients */
308 int width, height; /* should set so old wm's don't mess up */
309#endif
310 int min_width, min_height;
311#if 0
312 int max_width, max_height;
313#endif
314 int width_inc, height_inc;
315#if 0
316 struct {
317 int x; /* numerator */
318 int y; /* denominator */
319 } min_aspect, max_aspect;
320#endif
321 int base_width, base_height; /* added by ICCCM version 1 */
322#if 0
323 int win_gravity; /* added by ICCCM version 1 */
324#endif
325} XSizeHints;
326
1a578e9b
AC
327#define USPosition (1L << 0) /* user specified x, y */
328#define USSize (1L << 1) /* user specified width, height */
329
330#define PPosition (1L << 2) /* program specified position */
331#define PSize (1L << 3) /* program specified size */
332#define PMinSize (1L << 4) /* program specified minimum size */
333#define PMaxSize (1L << 5) /* program specified maximum size */
334#define PResizeInc (1L << 6) /* program specified resize increments */
335#define PAspect (1L << 7) /* program specified min and max aspect ratios */
336#define PBaseSize (1L << 8) /* program specified base for incrementing */
337#define PWinGravity (1L << 9) /* program specified window gravity */
338
e119ad0d
KS
339typedef struct {
340 int x, y;
341 unsigned width, height;
342} XRectangle;
343
344#define NativeRectangle Rect
345
346#define CONVERT_TO_XRECT(xr,nr) \
347 ((xr).x = (nr).left, \
348 (xr).y = (nr).top, \
349 (xr).width = ((nr).right - (nr).left), \
350 (xr).height = ((nr).bottom - (nr).top))
351
352#define CONVERT_FROM_XRECT(xr,nr) \
353 ((nr).left = (xr).x, \
354 (nr).top = (xr).y, \
355 (nr).right = ((xr).x + (xr).width), \
356 (nr).bottom = ((xr).y + (xr).height))
357
358#define STORE_NATIVE_RECT(nr,x,y,width,height) \
359 ((nr).left = (x), \
360 (nr).top = (y), \
361 (nr).right = ((nr).left + (width)), \
362 (nr).bottom = ((nr).top + (height)))
363
1a578e9b
AC
364#endif /* EMACS_MACGUI_H */
365
ab5796a9
MB
366/* arch-tag: 5a0da49a-35e2-418b-a58c-8a55778ae849
367 (do not change this comment) */