src/macgui.h

   1 /* Definitions and headers for communication on the Mac OS.
   2    Copyright (C) 2000, 2001, 2002, 2003, 2004,
   3                  2005 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 int Display;  /* fix later */
  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 typedef WindowPtr Window;
  83 typedef GWorldPtr Pixmap;
  84
  85 #define Cursor ThemeCursor
  86 #define No_Cursor (-1)
  87
  88 #define FACE_DEFAULT (~0)
  89
  90 #if !TARGET_API_MAC_CARBON
  91 #define GetPixDepth(pmh) ((*(pmh))->pixelSize)
  92 #endif
  93
  94
  95 #ifndef USE_CG_TEXT_DRAWING
  96 #if USE_ATSUI && MAC_OS_X_VERSION_MAX_ALLOWED >= 1030
  97 #define USE_CG_TEXT_DRAWING 1
  98 #endif
  99 #endif
 100
 101 /* Emulate XCharStruct.  */
 102 typedef struct _XCharStruct
 103 {
 104   short lbearing;               /* origin to left edge of raster */
 105   short rbearing;               /* origin to right edge of raster */
 106   short width;                  /* advance to next char's origin */
 107   short ascent;                 /* baseline to top edge of raster */
 108   short descent;                /* baseline to bottom edge of raster */
 109 #if 0
 110   unsigned short attributes;    /* per char flags (not predefined) */
 111 #endif
 112   unsigned valid_p : 1;
 113 } XCharStruct;
 114
 115 #define STORE_XCHARSTRUCT(xcs, w, bds)                  \
 116   ((xcs).width = (w),                                   \
 117    (xcs).lbearing = (bds).left,                         \
 118    (xcs).rbearing = (bds).right,                        \
 119    (xcs).ascent = -(bds).top,                           \
 120    (xcs).descent = (bds).bottom,                        \
 121    (xcs).valid_p = 1)
 122
 123 struct MacFontStruct {
 124   char *full_name;
 125
 126   short mac_fontnum;  /* font number of font used in this window */
 127   int mac_fontsize;  /* size of font */
 128   short mac_fontface;  /* plain, bold, italics, etc. */
 129 #if TARGET_API_MAC_CARBON
 130   int mac_scriptcode;  /* Mac OS script code for font used */
 131 #else
 132   short mac_scriptcode;  /* Mac OS script code for font used */
 133 #endif
 134 #if USE_ATSUI
 135   ATSUStyle mac_style;          /* NULL if QuickDraw Text is used */
 136 #if USE_CG_TEXT_DRAWING
 137   CGFontRef cg_font;            /* NULL if ATSUI text drawing is used */
 138   CGGlyph *cg_glyphs;           /* Likewise  */
 139 #endif
 140 #endif
 141
 142 /* from Xlib.h */
 143 #if 0
 144   XExtData *ext_data;      /* hook for extension to hang data */
 145   Font fid;                /* Font id for this font */
 146   unsigned direction;      /* hint about the direction font is painted */
 147 #endif /* 0 */
 148   unsigned min_char_or_byte2;/* first character */
 149   unsigned max_char_or_byte2;/* last character */
 150   unsigned min_byte1;      /* first row that exists */
 151   unsigned max_byte1;      /* last row that exists */
 152 #if 0
 153   Bool all_chars_exist;    /* flag if all characters have nonzero size */
 154   unsigned default_char;   /* char to print for undefined character */
 155   int n_properties;        /* how many properties there are */
 156   XFontProp *properties;   /* pointer to array of additional properties */
 157 #endif /* 0 */
 158   XCharStruct min_bounds;  /* minimum bounds over all existing char */
 159   XCharStruct max_bounds;  /* maximum bounds over all existing char */
 160   XCharStruct *per_char;   /* first_char to last_char information */
 161   int ascent;              /* logical extent above baseline for spacing */
 162   int descent;             /* logical decent below baseline for spacing */
 163 };
 164
 165 typedef struct MacFontStruct MacFontStruct;
 166 typedef struct MacFontStruct XFontStruct;
 167
 168 /* Structure borrowed from Xlib.h to represent two-byte characters.  */
 169
 170 typedef struct {
 171   unsigned char byte1;
 172   unsigned char byte2;
 173 } XChar2b;
 174
 175 #define STORE_XCHAR2B(chp, b1, b2) \
 176   ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
 177
 178 #define XCHAR2B_BYTE1(chp) \
 179   ((chp)->byte1)
 180
 181 #define XCHAR2B_BYTE2(chp) \
 182   ((chp)->byte2)
 183
 184
 185 /* Emulate X GC's by keeping color and font info in a structure.  */
 186 typedef struct _XGCValues
 187 {
 188   unsigned long foreground;
 189   unsigned long background;
 190   XFontStruct *font;
 191 } XGCValues;
 192
 193 typedef struct _XGC
 194 {
 195   /* Original value.  */
 196   XGCValues xgcv;
 197
 198   /* Cached data members follow.  */
 199
 200   /* QuickDraw foreground color.  */
 201   RGBColor fore_color;
 202
 203   /* QuickDraw background color.  */
 204   RGBColor back_color;
 205
 206 #define MAX_CLIP_RECTS 2
 207   /* QuickDraw clipping region.  */
 208   RgnHandle clip_region;
 209
 210 #if defined (MAC_OSX) && USE_ATSUI
 211   /* Number of clipping rectangles used in Quartz 2D drawing.  */
 212   int n_clip_rects;
 213
 214   /* Clipping rectangles used in Quartz 2D drawing.  The y-coordinate
 215      is in QuickDraw's.  */
 216   CGRect clip_rects[MAX_CLIP_RECTS];
 217 #endif
 218 } *GC;
 219
 220 #define GCForeground            (1L<<2)
 221 #define GCBackground            (1L<<3)
 222 #define GCFont                  (1L<<14)
 223 #define GCGraphicsExposures     0
 224
 225 /* Bit Gravity */
 226
 227 #define ForgetGravity           0
 228 #define NorthWestGravity        1
 229 #define NorthGravity            2
 230 #define NorthEastGravity        3
 231 #define WestGravity             4
 232 #define CenterGravity           5
 233 #define EastGravity             6
 234 #define SouthWestGravity        7
 235 #define SouthGravity            8
 236 #define SouthEastGravity        9
 237 #define StaticGravity           10
 238
 239 #define NoValue         0x0000
 240 #define XValue          0x0001
 241 #define YValue          0x0002
 242 #define WidthValue      0x0004
 243 #define HeightValue     0x0008
 244 #define AllValues       0x000F
 245 #define XNegative       0x0010
 246 #define YNegative       0x0020
 247
 248 typedef struct {
 249         long flags;     /* marks which fields in this structure are defined */
 250 #if 0
 251         int x, y;               /* obsolete for new window mgrs, but clients */
 252         int width, height;      /* should set so old wm's don't mess up */
 253 #endif
 254         int min_width, min_height;
 255 #if 0
 256         int max_width, max_height;
 257 #endif
 258         int width_inc, height_inc;
 259 #if 0
 260         struct {
 261                 int x;  /* numerator */
 262                 int y;  /* denominator */
 263         } min_aspect, max_aspect;
 264 #endif
 265         int base_width, base_height;            /* added by ICCCM version 1 */
 266 #if 0
 267         int win_gravity;                        /* added by ICCCM version 1 */
 268 #endif
 269 } XSizeHints;
 270
 271 #define USPosition      (1L << 0) /* user specified x, y */
 272 #define USSize          (1L << 1) /* user specified width, height */
 273
 274 #define PPosition       (1L << 2) /* program specified position */
 275 #define PSize           (1L << 3) /* program specified size */
 276 #define PMinSize        (1L << 4) /* program specified minimum size */
 277 #define PMaxSize        (1L << 5) /* program specified maximum size */
 278 #define PResizeInc      (1L << 6) /* program specified resize increments */
 279 #define PAspect         (1L << 7) /* program specified min and max aspect ratios */
 280 #define PBaseSize       (1L << 8) /* program specified base for incrementing */
 281 #define PWinGravity     (1L << 9) /* program specified window gravity */
 282
 283 typedef struct {
 284     int x, y;
 285     unsigned width, height;
 286 } XRectangle;
 287
 288 #define NativeRectangle Rect
 289
 290 #define CONVERT_TO_XRECT(xr,nr)                 \
 291   ((xr).x = (nr).left,                          \
 292    (xr).y = (nr).top,                           \
 293    (xr).width = ((nr).right - (nr).left),       \
 294    (xr).height = ((nr).bottom - (nr).top))
 295
 296 #define CONVERT_FROM_XRECT(xr,nr)               \
 297   ((nr).left = (xr).x,                          \
 298    (nr).top = (xr).y,                           \
 299    (nr).right = ((xr).x + (xr).width),          \
 300    (nr).bottom = ((xr).y + (xr).height))
 301
 302 #define STORE_NATIVE_RECT(nr,x,y,width,height)  \
 303   ((nr).left = (x),                             \
 304    (nr).top = (y),                              \
 305    (nr).right = ((nr).left + (width)),          \
 306    (nr).bottom = ((nr).top + (height)))
 307
 308 #endif /* EMACS_MACGUI_H */
 309
 310 /* arch-tag: 5a0da49a-35e2-418b-a58c-8a55778ae849
 311    (do not change this comment) */