src/macterm.h

   1 /* Display module for Mac OS.
   2    Copyright (C) 2000, 2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   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.
  10
  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.
  15
  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.  */
  20
  21 /* Contributed by Andrew Choi (akochoi@mac.com).  */
  22
  23 #include "macgui.h"
  24 #include "frame.h"
  25
  26 /* Include Carbon.h to define Cursor and Rect.  */
  27 #ifdef HAVE_CARBON
  28 #undef mktime
  29 #undef DEBUG
  30 #undef Z
  31 #undef free
  32 #undef malloc
  33 #undef realloc
  34 /* Macros max and min defined in lisp.h conflict with those in
  35    precompiled header Carbon.h.  */
  36 #undef max
  37 #undef min
  38 #undef init_process
  39 #include <Carbon/Carbon.h>
  40 #undef Z
  41 #define Z (current_buffer->text->z)
  42 #undef free
  43 #define free unexec_free
  44 #undef malloc
  45 #define malloc unexec_malloc
  46 #undef realloc
  47 #define realloc unexec_realloc
  48 #undef min
  49 #define min(a, b) ((a) < (b) ? (a) : (b))
  50 #undef max
  51 #define max(a, b) ((a) > (b) ? (a) : (b))
  52 #undef init_process
  53 #define init_process emacs_init_process
  54 #endif /* MAC_OSX */
  55
  56 #define RGB_TO_ULONG(r, g, b) (((r) << 16) | ((g) << 8) | (b))
  57
  58 #define RED_FROM_ULONG(color) ((color) >> 16)
  59 #define GREEN_FROM_ULONG(color) (((color) >> 8) & 0xff)
  60 #define BLUE_FROM_ULONG(color) ((color) & 0xff)
  61
  62 #define BLACK_PIX_DEFAULT(f) RGB_TO_ULONG(0,0,0)
  63 #define WHITE_PIX_DEFAULT(f) RGB_TO_ULONG(255,255,255)
  64
  65 #define FONT_WIDTH(f)   ((f)->max_bounds.width)
  66 #define FONT_HEIGHT(f)  ((f)->ascent + (f)->descent)
  67 #define FONT_BASE(f)    ((f)->ascent)
  68 #define FONT_DESCENT(f) ((f)->descent)
  69
  70 #define FONT_MAX_WIDTH(f) FONT_WIDTH(f)  /* fix later */
  71
  72 /* Structure recording bitmaps and reference count.
  73    If REFCOUNT is 0 then this record is free to be reused.  */
  74
  75 struct mac_bitmap_record
  76 {
  77   char *bitmap_data;
  78   int refcount;
  79   int height, width;
  80 };
  81
  82
  83 /* For each display (currently only one on mac), we have a structure that
  84    records information about it.  */
  85
  86 struct mac_display_info
  87 {
  88   /* Chain of all mac_display_info structures.  */
  89   struct mac_display_info *next;
  90
  91   /* This is a cons cell of the form (NAME . FONT-LIST-CACHE).
  92      The same cons cell also appears in x_display_name_list.  */
  93   Lisp_Object name_list_element;
  94
  95   /* Number of frames that are on this display.  */
  96   int reference_count;
  97
  98   /* Dots per inch of the screen.  */
  99   double resx, resy;
 100
 101   /* Number of planes on this screen.  */
 102   int n_planes;
 103
 104   /* Number of bits per pixel on this screen.  */
 105   int n_cbits;
 106
 107   /* Dimensions of this screen.  */
 108   int height, width;
 109 #if 0
 110   int height_in,width_in;
 111 #endif
 112
 113   /* Mask of things that cause the mouse to be grabbed.  */
 114   int grabbed;
 115
 116 #if 0
 117   /* Emacs bitmap-id of the default icon bitmap for this frame.
 118      Or -1 if none has been allocated yet.  */
 119   int icon_bitmap_id;
 120
 121 #endif
 122   /* The root window of this screen.  */
 123   Window root_window;
 124
 125   /* The cursor to use for vertical scroll bars.  */
 126   Cursor vertical_scroll_bar_cursor;
 127
 128   /* Resource data base */
 129   XrmDatabase xrdb;
 130
 131 #if 0
 132   /* color palette information.  */
 133   int has_palette;
 134   struct w32_palette_entry * color_list;
 135   unsigned num_colors;
 136   HPALETTE palette;
 137
 138   /* deferred action flags checked when starting frame update.  */
 139   int regen_palette;
 140
 141   /* Keystroke that has been faked by Emacs and will be ignored when
 142      received; value is reset after key is received.  */
 143   int faked_key;
 144
 145 #endif
 146
 147   /* A table of all the fonts we have already loaded.  */
 148   struct font_info *font_table;
 149
 150   /* The current capacity of font_table.  */
 151   int font_table_size;
 152
 153   /* The number of fonts actually stored in the font table.
 154      font_table[n] is used and valid iff 0 <= n < n_fonts. 0 <=
 155      n_fonts <= font_table_size. and font_table[i].name != 0. */
 156   int n_fonts;
 157
 158   /* Minimum width over all characters in all fonts in font_table.  */
 159   int smallest_char_width;
 160
 161   /* Minimum font height over all fonts in font_table.  */
 162   int smallest_font_height;
 163
 164   /* Reusable Graphics Context for drawing a cursor in a non-default face. */
 165   XGCValues *scratch_cursor_gc;
 166
 167   /* These variables describe the range of text currently shown in its
 168      mouse-face, together with the window they apply to. As long as
 169      the mouse stays within this range, we need not redraw anything on
 170      its account.  Rows and columns are glyph matrix positions in
 171      MOUSE_FACE_WINDOW.  */
 172   int mouse_face_beg_row, mouse_face_beg_col;
 173   int mouse_face_beg_x, mouse_face_beg_y;
 174   int mouse_face_end_row, mouse_face_end_col;
 175   int mouse_face_end_x, mouse_face_end_y;
 176   int mouse_face_past_end;
 177   Lisp_Object mouse_face_window;
 178   int mouse_face_face_id;
 179   Lisp_Object mouse_face_overlay;
 180
 181   /* 1 if a mouse motion event came and we didn't handle it right away because
 182      gc was in progress.  */
 183   int mouse_face_deferred_gc;
 184
 185   /* FRAME and X, Y position of mouse when last checked for
 186      highlighting.  X and Y can be negative or out of range for the frame.  */
 187   struct frame *mouse_face_mouse_frame;
 188
 189   int mouse_face_mouse_x, mouse_face_mouse_y;
 190
 191   /* Nonzero means defer mouse-motion highlighting.  */
 192   int mouse_face_defer;
 193
 194   /* Nonzero means that the mouse highlight should not be shown.  */
 195   int mouse_face_hidden;
 196
 197   int mouse_face_image_state;
 198
 199   char *mac_id_name;
 200
 201   /* Pointer to bitmap records.  */
 202   struct mac_bitmap_record *bitmaps;
 203
 204   /* Allocated size of bitmaps field.  */
 205   int bitmaps_size;
 206
 207   /* Last used bitmap index.  */
 208   int bitmaps_last;
 209
 210   /* The frame (if any) which has the window that has keyboard focus.
 211      Zero if none.  This is examined by Ffocus_frame in w32fns.c.  Note
 212      that a mere EnterNotify event can set this; if you need to know the
 213      last frame specified in a FocusIn or FocusOut event, use
 214      w32_focus_event_frame.  */
 215   struct frame *x_focus_frame;
 216
 217   /* The last frame mentioned in a FocusIn or FocusOut event.  This is
 218      separate from w32_focus_frame, because whether or not LeaveNotify
 219      events cause us to lose focus depends on whether or not we have
 220      received a FocusIn event for it.  */
 221   struct frame *x_focus_event_frame;
 222
 223   /* The frame which currently has the visual highlight, and should get
 224      keyboard input (other sorts of input have the frame encoded in the
 225      event).  It points to the focus frame's selected window's
 226      frame.  It differs from w32_focus_frame when we're using a global
 227      minibuffer.  */
 228   struct frame *x_highlight_frame;
 229
 230   /* Cache of images.  */
 231   struct image_cache *image_cache;
 232 };
 233
 234 #define x_display_info mac_display_info
 235
 236 /* This is a chain of structures for all the X displays currently in use.  */
 237 extern struct x_display_info *x_display_list;
 238
 239 /* This is a chain of structures for all the displays currently in use.  */
 240 extern struct mac_display_info one_mac_display_info;
 241
 242 /* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
 243    one for each element of x_display_list and in the same order.
 244    NAME is the name of the frame.
 245    FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
 246 extern Lisp_Object x_display_name_list;
 247
 248 /* A flag to control how to display unibyte 8-bit character.  */
 249 extern int unibyte_display_via_language_environment;
 250
 251 extern struct x_display_info *x_display_info_for_display P_ ((Display *));
 252 extern struct x_display_info *x_display_info_for_name P_ ((Lisp_Object));
 253
 254 extern struct mac_display_info *mac_term_init ();
 255
 256 /* When Emacs uses a tty window, tty_display in frame.c points to an
 257    x_output struct .  */
 258 struct x_output
 259 {
 260   unsigned long background_pixel;
 261   unsigned long foreground_pixel;
 262 };
 263
 264 /* The collection of data describing a window on the Mac.  */
 265 struct mac_output {
 266   /* Placeholder for things accessed through output_data.x.  Must
 267      appear first.  */
 268   struct x_output x_compatible;
 269
 270   /* Menubar "widget" handle.  */
 271   int menubar_widget;
 272
 273   Window mWP;                   /* pointer to QuickDraw window */
 274   FRAME_PTR mFP;                /* points back to the frame struct */
 275
 276 #if 0
 277   int mNumCols;                 /* number of characters per column */
 278   int mNumRows;                 /* number of characters per row */
 279   int mLineHeight;              /* height of one line of text in pixels */
 280   int mCharWidth;               /* width of one character in pixels */
 281   int mHomeX;                   /* X pixel coordinate of lower left
 282                                    corner of character at (0, 0) */
 283   int mHomeY;                   /* Y pixel coordinate of lower left
 284                                    corner of character at (0, 0) */
 285   int mHighlight;               /* current highlight state (0 = off). */
 286   int mTermWinSize;             /* num of lines from top of window
 287                                    affected by ins_del_lines; set by
 288                                    set_terminal_window. */
 289 #endif /* 0 */
 290
 291 #if 0
 292   /* stuffs used by xfaces.c */
 293   struct face **param_faces;
 294   int n_param_faces;
 295   struct face **computed_faces;
 296   int n_computed_faces;
 297   int size_computed_faces;
 298 #endif
 299
 300   /* Here are the Graphics Contexts for the default font.  */
 301   GC normal_gc;                         /* Normal video */
 302   GC reverse_gc;                        /* Reverse video */
 303   GC cursor_gc;                         /* cursor drawing */
 304
 305   /* The window used for this frame.
 306      May be zero while the frame object is being created
 307      and the window has not yet been created.  */
 308   Window window_desc;
 309
 310   /* The window that is the parent of this window.
 311      Usually this is a window that was made by the window manager,
 312      but it can be the root window, and it can be explicitly specified
 313      (see the explicit_parent field, below).  */
 314   Window parent_desc;
 315
 316   /* Default ASCII font of this frame. */
 317   XFontStruct *font;
 318
 319   /* The baseline offset of the default ASCII font.  */
 320   int baseline_offset;
 321
 322   /* If a fontset is specified for this frame instead of font, this
 323      value contains an ID of the fontset, else -1.  */
 324   int fontset;
 325
 326   /* Pixel values used for various purposes.
 327      border_pixel may be -1 meaning use a gray tile.  */
 328   unsigned long cursor_pixel;
 329   unsigned long border_pixel;
 330   unsigned long mouse_pixel;
 331   unsigned long cursor_foreground_pixel;
 332
 333   /* Foreground color for scroll bars.  A value of -1 means use the
 334      default (black for non-toolkit scroll bars).  */
 335   unsigned long scroll_bar_foreground_pixel;
 336
 337   /* Background color for scroll bars.  A value of -1 means use the
 338      default (background color of the frame for non-toolkit scroll
 339      bars).  */
 340   unsigned long scroll_bar_background_pixel;
 341
 342   /* Descriptor for the cursor in use for this window.  */
 343   Cursor text_cursor;
 344   Cursor nontext_cursor;
 345   Cursor modeline_cursor;
 346   Cursor hand_cursor;
 347   Cursor hourglass_cursor;
 348   Cursor horizontal_drag_cursor;
 349 #if 0
 350   /* Window whose cursor is hourglass_cursor.  This window is temporarily
 351      mapped to display a hourglass-cursor.  */
 352   Window hourglass_window;
 353
 354   /* Non-zero means hourglass cursor is currently displayed.  */
 355   unsigned hourglass_p : 1;
 356
 357   /* Flag to set when the window needs to be completely repainted.  */
 358   int needs_exposure;
 359
 360 #endif
 361
 362 #if 0
 363   DWORD dwStyle;
 364 #endif
 365
 366   /* This is the Emacs structure for the display this frame is on.  */
 367   /* struct w32_display_info *display_info; */
 368
 369   /* Nonzero means our parent is another application's window
 370      and was explicitly specified.  */
 371   char explicit_parent;
 372
 373   /* Nonzero means tried already to make this frame visible.  */
 374   char asked_for_visible;
 375
 376   /* Nonzero means menubar is currently active.  */
 377   char menubar_active;
 378
 379   /* Nonzero means a menu command is being processed.  */
 380   char menu_command_in_progress;
 381
 382   /* Nonzero means menubar is about to become active, but should be
 383      brought up to date first.  */
 384   volatile char pending_menu_activation;
 385
 386   /* Relief GCs, colors etc.  */
 387   struct relief
 388   {
 389     XGCValues *gc;
 390     unsigned long pixel;
 391     int allocated_p;
 392   }
 393   black_relief, white_relief;
 394
 395   /* The background for which the above relief GCs were set up.
 396      They are changed only when a different background is involved.  */
 397   unsigned long relief_background;
 398 };
 399
 400 typedef struct mac_output mac_output;
 401
 402 /* Return the X output data for frame F.  */
 403 #define FRAME_X_OUTPUT(f) ((f)->output_data.mac)
 404
 405 /* Return the Mac window used for displaying data in frame F.  */
 406 #define FRAME_MAC_WINDOW(f) ((f)->output_data.mac->mWP)
 407 #define FRAME_X_WINDOW(f) ((f)->output_data.mac->mWP)
 408
 409 #define FRAME_FOREGROUND_PIXEL(f) ((f)->output_data.x->foreground_pixel)
 410 #define FRAME_BACKGROUND_PIXEL(f) ((f)->output_data.x->background_pixel)
 411
 412 #define FRAME_FONT(f) ((f)->output_data.mac->font)
 413 #define FRAME_FONTSET(f) ((f)->output_data.mac->fontset)
 414
 415 #define FRAME_BASELINE_OFFSET(f) ((f)->output_data.mac->baseline_offset)
 416
 417 /* This gives the w32_display_info structure for the display F is on.  */
 418 #define FRAME_MAC_DISPLAY_INFO(f) (&one_mac_display_info)
 419 #define FRAME_X_DISPLAY_INFO(f) (&one_mac_display_info)
 420
 421 /* This is the `Display *' which frame F is on.  */
 422 #define FRAME_MAC_DISPLAY(f) (0)
 423 #define FRAME_X_DISPLAY(f) (0)
 424
 425 /* This is the 'font_info *' which frame F has.  */
 426 #define FRAME_MAC_FONT_TABLE(f) (FRAME_MAC_DISPLAY_INFO (f)->font_table)
 427
 428 /* Value is the smallest width of any character in any font on frame F.  */
 429
 430 #define FRAME_SMALLEST_CHAR_WIDTH(F) \
 431      FRAME_MAC_DISPLAY_INFO(F)->smallest_char_width
 432
 433 /* Value is the smallest height of any font on frame F.  */
 434
 435 #define FRAME_SMALLEST_FONT_HEIGHT(F) \
 436      FRAME_MAC_DISPLAY_INFO(F)->smallest_font_height
 437
 438 /* Return a pointer to the image cache of frame F.  */
 439
 440 #define FRAME_X_IMAGE_CACHE(F) FRAME_MAC_DISPLAY_INFO ((F))->image_cache
 441
 442 \f
 443 /* Mac-specific scroll bar stuff.  */
 444
 445 /* We represent scroll bars as lisp vectors.  This allows us to place
 446    references to them in windows without worrying about whether we'll
 447    end up with windows referring to dead scroll bars; the garbage
 448    collector will free it when its time comes.
 449
 450    We use struct scroll_bar as a template for accessing fields of the
 451    vector.  */
 452
 453 struct scroll_bar {
 454
 455   /* These fields are shared by all vectors.  */
 456   EMACS_INT size_from_Lisp_Vector_struct;
 457   struct Lisp_Vector *next_from_Lisp_Vector_struct;
 458
 459   /* The window we're a scroll bar for.  */
 460   Lisp_Object window;
 461
 462   /* The next and previous in the chain of scroll bars in this frame.  */
 463   Lisp_Object next, prev;
 464
 465   /* The Mac control handle of this scroll bar.  Since this is a full
 466      32-bit quantity, we store it split into two 32-bit values.  */
 467   Lisp_Object control_handle_low, control_handle_high;
 468
 469   /* The position and size of the scroll bar in pixels, relative to the
 470      frame.  */
 471   Lisp_Object top, left, width, height;
 472
 473   /* The starting and ending positions of the handle, relative to the
 474      handle area (i.e. zero is the top position, not
 475      SCROLL_BAR_TOP_BORDER).  If they're equal, that means the handle
 476      hasn't been drawn yet.
 477
 478      These are not actually the locations where the beginning and end
 479      are drawn; in order to keep handles from becoming invisible when
 480      editing large files, we establish a minimum height by always
 481      drawing handle bottoms VERTICAL_SCROLL_BAR_MIN_HANDLE pixels below
 482      where they would be normally; the bottom and top are in a
 483      different co-ordinate system.  */
 484   Lisp_Object start, end;
 485
 486   /* If the scroll bar handle is currently being dragged by the user,
 487      this is the number of pixels from the top of the handle to the
 488      place where the user grabbed it.  If the handle isn't currently
 489      being dragged, this is Qnil.  */
 490   Lisp_Object dragging;
 491 };
 492
 493 /* The number of elements a vector holding a struct scroll_bar needs.  */
 494 #define SCROLL_BAR_VEC_SIZE                                     \
 495   ((sizeof (struct scroll_bar)                                  \
 496     - sizeof (EMACS_INT) - sizeof (struct Lisp_Vector *))       \
 497    / sizeof (Lisp_Object))
 498
 499 /* Turning a lisp vector value into a pointer to a struct scroll_bar.  */
 500 #define XSCROLL_BAR(vec) ((struct scroll_bar *) XVECTOR (vec))
 501
 502
 503 /* Building a 32-bit C integer from two 16-bit lisp integers.  */
 504 #define SCROLL_BAR_PACK(low, high) (XINT (high) << 16 | XINT (low))
 505
 506 /* Setting two lisp integers to the low and high words of a 32-bit C int.  */
 507 #define SCROLL_BAR_UNPACK(low, high, int32) \
 508   (XSETINT ((low),   (int32)        & 0xffff), \
 509    XSETINT ((high), ((int32) >> 16) & 0xffff))
 510
 511
 512 /* Extract the Mac control handle of the scroll bar from a struct
 513    scroll_bar.  */
 514 #define SCROLL_BAR_CONTROL_HANDLE(ptr) \
 515   ((ControlHandle) SCROLL_BAR_PACK ((ptr)->control_handle_low, \
 516                                     (ptr)->control_handle_high))
 517
 518 /* Store a Mac control handle in a struct scroll_bar.  */
 519 #define SET_SCROLL_BAR_CONTROL_HANDLE(ptr, id) \
 520   (SCROLL_BAR_UNPACK ((ptr)->control_handle_low, \
 521                       (ptr)->control_handle_high, (int) id))
 522
 523 /* Return the inside width of a vertical scroll bar, given the outside
 524    width.  */
 525 #define VERTICAL_SCROLL_BAR_INSIDE_WIDTH(f,width) \
 526   ((width) \
 527    - VERTICAL_SCROLL_BAR_LEFT_BORDER \
 528    - VERTICAL_SCROLL_BAR_RIGHT_BORDER \
 529    - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2)
 530
 531 /* Return the length of the rectangle within which the top of the
 532    handle must stay.  This isn't equivalent to the inside height,
 533    because the scroll bar handle has a minimum height.
 534
 535    This is the real range of motion for the scroll bar, so when we're
 536    scaling buffer positions to scroll bar positions, we use this, not
 537    VERTICAL_SCROLL_BAR_INSIDE_HEIGHT.  */
 538 #define VERTICAL_SCROLL_BAR_TOP_RANGE(f,height) \
 539   (VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, height) \
 540    - VERTICAL_SCROLL_BAR_MIN_HANDLE - UP_AND_DOWN_ARROWS)
 541
 542 /* Return the inside height of vertical scroll bar, given the outside
 543    height.  See VERTICAL_SCROLL_BAR_TOP_RANGE too.  */
 544 #define VERTICAL_SCROLL_BAR_INSIDE_HEIGHT(f,height) \
 545   ((height) - VERTICAL_SCROLL_BAR_TOP_BORDER \
 546    - VERTICAL_SCROLL_BAR_BOTTOM_BORDER)
 547
 548
 549 /* Border widths for scroll bars.
 550
 551    Scroll bar windows don't have any borders; their border width is
 552    set to zero, and we redraw borders ourselves.  This makes the code
 553    a bit cleaner, since we don't have to convert between outside width
 554    (used when relating to the rest of the screen) and inside width
 555    (used when sizing and drawing the scroll bar window itself).
 556
 557    The handle moves up and down/back and forth in a rectangle inset
 558    from the edges of the scroll bar.  These are widths by which we
 559    inset the handle boundaries from the scroll bar edges.  */
 560 #define VERTICAL_SCROLL_BAR_LEFT_BORDER (0)
 561 #define VERTICAL_SCROLL_BAR_RIGHT_BORDER (0)
 562 #define VERTICAL_SCROLL_BAR_TOP_BORDER (0)
 563 #define VERTICAL_SCROLL_BAR_BOTTOM_BORDER (0)
 564
 565 /* Minimum lengths for scroll bar handles, in pixels.  */
 566 #define VERTICAL_SCROLL_BAR_MIN_HANDLE (16)
 567
 568 /* Combined length of up and down arrow boxes in scroll bars, in pixels.  */
 569 #define UP_AND_DOWN_ARROWS (32)
 570
 571 /* Trimming off a few pixels from each side prevents
 572    text from glomming up against the scroll bar */
 573 #define VERTICAL_SCROLL_BAR_WIDTH_TRIM (0)
 574
 575
 576 struct frame * check_x_frame (Lisp_Object);
 577
 578 void activate_scroll_bars (FRAME_PTR);
 579 void deactivate_scroll_bars (FRAME_PTR);
 580
 581 #define FONT_TYPE_FOR_UNIBYTE(font, ch) 0
 582 #define FONT_TYPE_FOR_MULTIBYTE(font, ch) 0
 583