code.delx.au - gnu-emacs/blob - src/macgui.h

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