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, 2008 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 3, 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 WindowRef */
  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 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 /* Whether to use HIToolbar.  */
 123 #ifndef USE_MAC_TOOLBAR
 124 #if USE_CG_DRAWING && MAC_OS_X_VERSION_MAX_ALLOWED >= 1030 && MAC_OS_X_VERSION_MIN_REQUIRED != 1020
 125 #define USE_MAC_TOOLBAR 1
 126 #endif
 127 #endif
 128
 129 typedef WindowRef Window;
 130 #if TARGET_API_MAC_CARBON
 131 typedef ScrapRef Selection;
 132 #else
 133 typedef int Selection;
 134 #endif
 135 #define mac_set_window_title    SetWindowTitleWithCFString
 136 #define mac_set_window_modified SetWindowModified
 137 #define mac_is_window_visible   IsWindowVisible
 138 #define mac_is_window_collapsed IsWindowCollapsed
 139 #define mac_bring_window_to_front       BringToFront
 140 #define mac_send_window_behind  SendBehind
 141 #define mac_hide_window         HideWindow
 142 #define mac_show_window         ShowWindow
 143 #define mac_collapse_window     CollapseWindow
 144 #define mac_front_non_floating_window   FrontNonFloatingWindow
 145 #define mac_active_non_floating_window  ActiveNonFloatingWindow
 146 #define mac_activate_window     ActivateWindow
 147 #define mac_move_window_structure       MoveWindowStructure
 148 #define mac_move_window         MoveWindow
 149 #define mac_size_window         SizeWindow
 150 #define mac_get_global_mouse    GetGlobalMouse
 151 #define mac_is_window_toolbar_visible   IsWindowToolbarVisible
 152 typedef GWorldPtr Pixmap;
 153
 154 #define Cursor ThemeCursor
 155 #define No_Cursor (-1)
 156
 157 #define FACE_DEFAULT (~0)
 158
 159 #if !TARGET_API_MAC_CARBON
 160 #define GetPixDepth(pmh) ((*(pmh))->pixelSize)
 161 #endif
 162
 163
 164 /* Emulate XCharStruct.  */
 165 /* If the sum of ascent and descent is negative, that means some
 166    special status specified by enum pcm_status.  */
 167 typedef struct _XCharStruct
 168 {
 169   short lbearing;               /* origin to left edge of raster */
 170   short rbearing;               /* origin to right edge of raster */
 171   short width;                  /* advance to next char's origin */
 172   short ascent;                 /* baseline to top edge of raster */
 173   short descent;                /* baseline to bottom edge of raster */
 174 #if 0
 175   unsigned short attributes;    /* per char flags (not predefined) */
 176 #endif
 177 } XCharStruct;
 178
 179 enum pcm_status
 180   {
 181     PCM_VALID = 0,              /* pcm data is valid */
 182     PCM_INVALID = -1,           /* pcm data is invalid */
 183   };
 184
 185 #define STORE_XCHARSTRUCT(xcs, w, bds)                  \
 186   ((xcs).width = (w),                                   \
 187    (xcs).lbearing = (bds).left,                         \
 188    (xcs).rbearing = (bds).right,                        \
 189    (xcs).ascent = -(bds).top,                           \
 190    (xcs).descent = (bds).bottom)
 191
 192 struct MacFontStruct {
 193   char *full_name;
 194
 195   short mac_fontnum;  /* font number of font used in this window */
 196   int mac_fontsize;  /* size of font */
 197   short mac_fontface;  /* plain, bold, italics, etc. */
 198 #if TARGET_API_MAC_CARBON
 199   int mac_scriptcode;  /* Mac OS script code for font used */
 200 #else
 201   short mac_scriptcode;  /* Mac OS script code for font used */
 202 #endif
 203 #if USE_ATSUI
 204   ATSUStyle mac_style;          /* NULL if QuickDraw Text is used */
 205 #if USE_CG_TEXT_DRAWING
 206   CGFontRef cg_font;            /* NULL if ATSUI text drawing is used */
 207   CGGlyph *cg_glyphs;           /* Likewise  */
 208 #endif
 209 #endif
 210
 211 /* from Xlib.h */
 212 #if 0
 213   XExtData *ext_data;      /* hook for extension to hang data */
 214   Font fid;                /* Font id for this font */
 215   unsigned direction;      /* hint about the direction font is painted */
 216 #endif /* 0 */
 217   unsigned min_char_or_byte2;/* first character */
 218   unsigned max_char_or_byte2;/* last character */
 219   unsigned min_byte1;      /* first row that exists */
 220   unsigned max_byte1;      /* last row that exists */
 221 #if 0
 222   Bool all_chars_exist;    /* flag if all characters have nonzero size */
 223   unsigned default_char;   /* char to print for undefined character */
 224   int n_properties;        /* how many properties there are */
 225   XFontProp *properties;   /* pointer to array of additional properties */
 226 #endif /* 0 */
 227   XCharStruct min_bounds;  /* minimum bounds over all existing char */
 228   XCharStruct max_bounds;  /* maximum bounds over all existing char */
 229   union {
 230     XCharStruct *per_char; /* first_char to last_char information */
 231     XCharStruct **rows;    /* first row to last row information */
 232   } bounds;
 233   int ascent;              /* logical extent above baseline for spacing */
 234   int descent;             /* logical decent below baseline for spacing */
 235 };
 236
 237 typedef struct MacFontStruct MacFontStruct;
 238 typedef struct MacFontStruct XFontStruct;
 239
 240 /* Structure borrowed from Xlib.h to represent two-byte characters.  */
 241
 242 typedef struct {
 243   unsigned char byte1;
 244   unsigned char byte2;
 245 } XChar2b;
 246
 247 #define STORE_XCHAR2B(chp, b1, b2) \
 248   ((chp)->byte1 = (b1), (chp)->byte2 = (b2))
 249
 250 #define XCHAR2B_BYTE1(chp) \
 251   ((chp)->byte1)
 252
 253 #define XCHAR2B_BYTE2(chp) \
 254   ((chp)->byte2)
 255
 256
 257 /* Emulate X GC's by keeping color and font info in a structure.  */
 258 typedef struct _XGCValues
 259 {
 260   unsigned long foreground;
 261   unsigned long background;
 262   XFontStruct *font;
 263 } XGCValues;
 264
 265 typedef struct _XGC
 266 {
 267   /* Original value.  */
 268   XGCValues xgcv;
 269
 270   /* Cached data members follow.  */
 271
 272   /* QuickDraw foreground color.  */
 273   RGBColor fore_color;
 274
 275   /* QuickDraw background color.  */
 276   RGBColor back_color;
 277
 278 #if USE_CG_DRAWING && MAC_OS_X_VERSION_MAX_ALLOWED >= 1030
 279   /* Quartz 2D foreground color.  */
 280   CGColorRef cg_fore_color;
 281
 282   /* Quartz 2D background color.  */
 283   CGColorRef cg_back_color;
 284 #endif
 285
 286 #define MAX_CLIP_RECTS 2
 287   /* Number of clipping rectangles.  */
 288   int n_clip_rects;
 289
 290   /* QuickDraw clipping region.  Ignored if n_clip_rects == 0.  */
 291   RgnHandle clip_region;
 292
 293 #if defined (MAC_OSX) && (USE_ATSUI || USE_CG_DRAWING)
 294   /* Clipping rectangles used in Quartz 2D drawing.  The y-coordinate
 295      is in QuickDraw's.  */
 296   CGRect clip_rects[MAX_CLIP_RECTS];
 297 #endif
 298 } *GC;
 299
 300 #define GCForeground            (1L<<2)
 301 #define GCBackground            (1L<<3)
 302 #define GCFont                  (1L<<14)
 303 #define GCGraphicsExposures     0
 304
 305 /* Bit Gravity */
 306
 307 #define ForgetGravity           0
 308 #define NorthWestGravity        1
 309 #define NorthGravity            2
 310 #define NorthEastGravity        3
 311 #define WestGravity             4
 312 #define CenterGravity           5
 313 #define EastGravity             6
 314 #define SouthWestGravity        7
 315 #define SouthGravity            8
 316 #define SouthEastGravity        9
 317 #define StaticGravity           10
 318
 319 #define NoValue         0x0000
 320 #define XValue          0x0001
 321 #define YValue          0x0002
 322 #define WidthValue      0x0004
 323 #define HeightValue     0x0008
 324 #define AllValues       0x000F
 325 #define XNegative       0x0010
 326 #define YNegative       0x0020
 327
 328 typedef struct {
 329         long flags;     /* marks which fields in this structure are defined */
 330 #if 0
 331         int x, y;               /* obsolete for new window mgrs, but clients */
 332         int width, height;      /* should set so old wm's don't mess up */
 333 #endif
 334         int min_width, min_height;
 335 #if 0
 336         int max_width, max_height;
 337 #endif
 338         int width_inc, height_inc;
 339 #if 0
 340         struct {
 341                 int x;  /* numerator */
 342                 int y;  /* denominator */
 343         } min_aspect, max_aspect;
 344 #endif
 345         int base_width, base_height;            /* added by ICCCM version 1 */
 346 #if 0
 347         int win_gravity;                        /* added by ICCCM version 1 */
 348 #endif
 349 } XSizeHints;
 350
 351 #define USPosition      (1L << 0) /* user specified x, y */
 352 #define USSize          (1L << 1) /* user specified width, height */
 353
 354 #define PPosition       (1L << 2) /* program specified position */
 355 #define PSize           (1L << 3) /* program specified size */
 356 #define PMinSize        (1L << 4) /* program specified minimum size */
 357 #define PMaxSize        (1L << 5) /* program specified maximum size */
 358 #define PResizeInc      (1L << 6) /* program specified resize increments */
 359 #define PAspect         (1L << 7) /* program specified min and max aspect ratios */
 360 #define PBaseSize       (1L << 8) /* program specified base for incrementing */
 361 #define PWinGravity     (1L << 9) /* program specified window gravity */
 362
 363 typedef struct {
 364     int x, y;
 365     unsigned width, height;
 366 } XRectangle;
 367
 368 #define NativeRectangle Rect
 369
 370 #define CONVERT_TO_XRECT(xr,nr)                 \
 371   ((xr).x = (nr).left,                          \
 372    (xr).y = (nr).top,                           \
 373    (xr).width = ((nr).right - (nr).left),       \
 374    (xr).height = ((nr).bottom - (nr).top))
 375
 376 #define CONVERT_FROM_XRECT(xr,nr)               \
 377   ((nr).left = (xr).x,                          \
 378    (nr).top = (xr).y,                           \
 379    (nr).right = ((xr).x + (xr).width),          \
 380    (nr).bottom = ((xr).y + (xr).height))
 381
 382 #define STORE_NATIVE_RECT(nr,x,y,width,height)  \
 383   ((nr).left = (x),                             \
 384    (nr).top = (y),                              \
 385    (nr).right = ((nr).left + (width)),          \
 386    (nr).bottom = ((nr).top + (height)))
 387
 388 /* Definitions copied from lwlib.h */
 389
 390 typedef void * XtPointer;
 391
 392 enum button_type
 393 {
 394   BUTTON_TYPE_NONE,
 395   BUTTON_TYPE_TOGGLE,
 396   BUTTON_TYPE_RADIO
 397 };
 398
 399 /* This structure is based on the one in ../lwlib/lwlib.h, modified
 400    for Mac OS.  */
 401 typedef struct _widget_value
 402 {
 403   /* name of widget */
 404   Lisp_Object   lname;
 405   char*         name;
 406   /* value (meaning depend on widget type) */
 407   char*         value;
 408   /* keyboard equivalent. no implications for XtTranslations */
 409   Lisp_Object   lkey;
 410   char*         key;
 411   /* Help string or nil if none.
 412      GC finds this string through the frame's menu_bar_vector
 413      or through menu_items.  */
 414   Lisp_Object   help;
 415   /* true if enabled */
 416   Boolean       enabled;
 417   /* true if selected */
 418   Boolean       selected;
 419   /* The type of a button.  */
 420   enum button_type button_type;
 421   /* true if menu title */
 422   Boolean       title;
 423 #if 0
 424   /* true if was edited (maintained by get_value) */
 425   Boolean       edited;
 426   /* true if has changed (maintained by lw library) */
 427   change_type   change;
 428   /* true if this widget itself has changed,
 429      but not counting the other widgets found in the `next' field.  */
 430   change_type   this_one_change;
 431 #endif
 432   /* Contents of the sub-widgets, also selected slot for checkbox */
 433   struct _widget_value* contents;
 434   /* data passed to callback */
 435   XtPointer     call_data;
 436   /* next one in the list */
 437   struct _widget_value* next;
 438 #if 0
 439   /* slot for the toolkit dependent part.  Always initialize to NULL. */
 440   void* toolkit_data;
 441   /* tell us if we should free the toolkit data slot when freeing the
 442      widget_value itself. */
 443   Boolean free_toolkit_data;
 444
 445   /* we resource the widget_value structures; this points to the next
 446      one on the free list if this one has been deallocated.
 447    */
 448   struct _widget_value *free_list;
 449 #endif
 450 } widget_value;
 451
 452 #if MAC_OS8
 453 #define M_APPLE 234
 454 #define I_ABOUT 1
 455
 456 #define EXTRA_STACK_ALLOC (256 * 1024)
 457
 458 #define ARGV_STRING_LIST_ID 129
 459 #define RAM_TOO_LARGE_ALERT_ID 129
 460 #define ABOUT_ALERT_ID  128
 461 #endif
 462
 463 #define DIALOG_LEFT_MARGIN (112)
 464 #define DIALOG_TOP_MARGIN (24)
 465 #define DIALOG_RIGHT_MARGIN (24)
 466 #define DIALOG_BOTTOM_MARGIN (20)
 467 #define DIALOG_MIN_INNER_WIDTH (338)
 468 #define DIALOG_MAX_INNER_WIDTH (564)
 469 #define DIALOG_BUTTON_BUTTON_HORIZONTAL_SPACE (12)
 470 #define DIALOG_BUTTON_BUTTON_VERTICAL_SPACE (12)
 471 #define DIALOG_BUTTON_MIN_WIDTH (68)
 472 #define DIALOG_TEXT_MIN_HEIGHT (50)
 473 #define DIALOG_TEXT_BUTTONS_VERTICAL_SPACE (10)
 474 #define DIALOG_ICON_WIDTH (64)
 475 #define DIALOG_ICON_HEIGHT (64)
 476 #define DIALOG_ICON_LEFT_MARGIN (24)
 477 #define DIALOG_ICON_TOP_MARGIN (15)
 478
 479 #endif /* EMACS_MACGUI_H */
 480
 481 /* arch-tag: 5a0da49a-35e2-418b-a58c-8a55778ae849
 482    (do not change this comment) */