(with-timeout): Improve argument/docstring consistency.
[emacs.git] / src / macgui.h
blob939496aaeefd60a10eea4776138dba6c49b1405f
1 /* Definitions and headers for communication on the Mac OS.
2 Copyright (C) 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* Contributed by Andrew Choi (akochoi@mac.com). */
23 #ifndef EMACS_MACGUI_H
24 #define EMACS_MACGUI_H
26 typedef int Display; /* fix later */
28 typedef Lisp_Object XrmDatabase;
30 typedef unsigned long Time;
32 #ifdef HAVE_CARBON
33 #undef Z
34 #ifdef MAC_OSX
35 #if ! HAVE_MKTIME || BROKEN_MKTIME
36 #undef mktime
37 #endif
38 #undef DEBUG
39 #undef free
40 #undef malloc
41 #undef realloc
42 /* Macros max and min defined in lisp.h conflict with those in
43 precompiled header Carbon.h. */
44 #undef max
45 #undef min
46 #undef init_process
47 #include <Carbon/Carbon.h>
48 #if ! HAVE_MKTIME || BROKEN_MKTIME
49 #undef mktime
50 #define mktime emacs_mktime
51 #endif
52 #undef free
53 #define free unexec_free
54 #undef malloc
55 #define malloc unexec_malloc
56 #undef realloc
57 #define realloc unexec_realloc
58 #undef min
59 #define min(a, b) ((a) < (b) ? (a) : (b))
60 #undef max
61 #define max(a, b) ((a) > (b) ? (a) : (b))
62 #undef init_process
63 #define init_process emacs_init_process
64 #undef INFINITY
65 #else /* not MAC_OSX */
66 #undef SIGHUP
67 #define OLDP2C 1
68 #include <Carbon.h>
69 #endif /* not MAC_OSX */
70 #undef Z
71 #define Z (current_buffer->text->z)
72 #else /* not HAVE_CARBON */
73 #include <QuickDraw.h> /* for WindowPtr */
74 #include <QDOffscreen.h> /* for GWorldPtr */
75 #include <Appearance.h> /* for ThemeCursor */
76 #include <Windows.h>
77 #include <Controls.h>
78 #include <Gestalt.h>
79 #endif /* not HAVE_CARBON */
81 typedef WindowPtr Window;
82 typedef GWorldPtr Pixmap;
84 #define Cursor ThemeCursor
85 #define No_Cursor (-1)
87 #define FACE_DEFAULT (~0)
90 /* Emulate XCharStruct. */
91 typedef struct _XCharStruct
93 int rbearing;
94 int lbearing;
95 int width;
96 int ascent;
97 int descent;
98 } XCharStruct;
100 #define STORE_XCHARSTRUCT(xcs, w, bds) \
101 ((xcs).width = (w), \
102 (xcs).lbearing = (bds).left, \
103 (xcs).rbearing = (bds).right, \
104 (xcs).ascent = -(bds).top, \
105 (xcs).descent = (bds).bottom)
107 struct MacFontStruct {
108 char *full_name;
110 short mac_fontnum; /* font number of font used in this window */
111 int mac_fontsize; /* size of font */
112 short mac_fontface; /* plain, bold, italics, etc. */
113 #if TARGET_API_MAC_CARBON
114 int mac_scriptcode; /* Mac OS script code for font used */
115 #else
116 short mac_scriptcode; /* Mac OS script code for font used */
117 #endif
119 #if 0
120 SInt16 mFontNum; /* font number of font used in this window */
121 short mScriptCode; /* Mac OS script code for font used */
122 int mFontSize; /* size of font */
123 Style mFontFace; /* plain, bold, italics, etc. */
124 int mHeight; /* height of one line of text in pixels */
125 int mWidth; /* width of one character in pixels */
126 int mAscent;
127 int mDescent;
128 int mLeading;
129 char mTwoByte; /* true for two-byte font */
130 #endif /* 0 */
132 /* from Xlib.h */
133 #if 0
134 XExtData *ext_data; /* hook for extension to hang data */
135 Font fid; /* Font id for this font */
136 unsigned direction; /* hint about the direction font is painted */
137 #endif /* 0 */
138 unsigned min_char_or_byte2;/* first character */
139 unsigned max_char_or_byte2;/* last character */
140 unsigned min_byte1; /* first row that exists */
141 unsigned max_byte1; /* last row that exists */
142 #if 0
143 Bool all_chars_exist; /* flag if all characters have nonzero size */
144 unsigned default_char; /* char to print for undefined character */
145 int n_properties; /* how many properties there are */
146 XFontProp *properties; /* pointer to array of additional properties */
147 #endif /* 0 */
148 XCharStruct min_bounds; /* minimum bounds over all existing char */
149 XCharStruct max_bounds; /* maximum bounds over all existing char */
150 XCharStruct *per_char; /* first_char to last_char information */
151 int ascent; /* logical extent above baseline for spacing */
152 int descent; /* logical decent below baseline for spacing */
155 typedef struct MacFontStruct MacFontStruct;
156 typedef struct MacFontStruct XFontStruct;
158 /* Structure borrowed from Xlib.h to represent two-byte characters. */
160 typedef struct {
161 unsigned char byte1;
162 unsigned char byte2;
163 } XChar2b;
165 #define STORE_XCHAR2B(chp, b1, b2) \
166 ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
168 #define XCHAR2B_BYTE1(chp) \
169 ((chp)->byte1)
171 #define XCHAR2B_BYTE2(chp) \
172 ((chp)->byte2)
175 /* Emulate X GC's by keeping color and font info in a structure. */
176 typedef struct _XGCValues
178 unsigned long foreground;
179 unsigned long background;
180 XFontStruct *font;
181 } XGCValues;
183 typedef XGCValues *GC;
185 extern XGCValues *
186 XCreateGC (void *, Window, unsigned long, XGCValues *);
188 #define GCForeground 0x01
189 #define GCBackground 0x02
190 #define GCFont 0x03
191 #define GCGraphicsExposures 0
193 /* Bit Gravity */
195 #define ForgetGravity 0
196 #define NorthWestGravity 1
197 #define NorthGravity 2
198 #define NorthEastGravity 3
199 #define WestGravity 4
200 #define CenterGravity 5
201 #define EastGravity 6
202 #define SouthWestGravity 7
203 #define SouthGravity 8
204 #define SouthEastGravity 9
205 #define StaticGravity 10
207 #define NoValue 0x0000
208 #define XValue 0x0001
209 #define YValue 0x0002
210 #define WidthValue 0x0004
211 #define HeightValue 0x0008
212 #define AllValues 0x000F
213 #define XNegative 0x0010
214 #define YNegative 0x0020
216 typedef struct {
217 long flags; /* marks which fields in this structure are defined */
218 #if 0
219 int x, y; /* obsolete for new window mgrs, but clients */
220 int width, height; /* should set so old wm's don't mess up */
221 #endif
222 int min_width, min_height;
223 #if 0
224 int max_width, max_height;
225 #endif
226 int width_inc, height_inc;
227 #if 0
228 struct {
229 int x; /* numerator */
230 int y; /* denominator */
231 } min_aspect, max_aspect;
232 #endif
233 int base_width, base_height; /* added by ICCCM version 1 */
234 #if 0
235 int win_gravity; /* added by ICCCM version 1 */
236 #endif
237 } XSizeHints;
239 #define USPosition (1L << 0) /* user specified x, y */
240 #define USSize (1L << 1) /* user specified width, height */
242 #define PPosition (1L << 2) /* program specified position */
243 #define PSize (1L << 3) /* program specified size */
244 #define PMinSize (1L << 4) /* program specified minimum size */
245 #define PMaxSize (1L << 5) /* program specified maximum size */
246 #define PResizeInc (1L << 6) /* program specified resize increments */
247 #define PAspect (1L << 7) /* program specified min and max aspect ratios */
248 #define PBaseSize (1L << 8) /* program specified base for incrementing */
249 #define PWinGravity (1L << 9) /* program specified window gravity */
251 extern int XParseGeometry ();
253 typedef struct {
254 int x, y;
255 unsigned width, height;
256 } XRectangle;
258 #define NativeRectangle Rect
260 #define CONVERT_TO_XRECT(xr,nr) \
261 ((xr).x = (nr).left, \
262 (xr).y = (nr).top, \
263 (xr).width = ((nr).right - (nr).left), \
264 (xr).height = ((nr).bottom - (nr).top))
266 #define CONVERT_FROM_XRECT(xr,nr) \
267 ((nr).left = (xr).x, \
268 (nr).top = (xr).y, \
269 (nr).right = ((xr).x + (xr).width), \
270 (nr).bottom = ((xr).y + (xr).height))
272 #define STORE_NATIVE_RECT(nr,x,y,width,height) \
273 ((nr).left = (x), \
274 (nr).top = (y), \
275 (nr).right = ((nr).left + (width)), \
276 (nr).bottom = ((nr).top + (height)))
278 #endif /* EMACS_MACGUI_H */
280 /* arch-tag: 5a0da49a-35e2-418b-a58c-8a55778ae849
281 (do not change this comment) */