xterm.c 392 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
2
   Copyright (C) 1989, 93, 94, 95, 96, 1997, 1998, 1999, 2000
3
   Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

22
/* New display code by Gerd Moellmann <gerd@gnu.org>.  */
23 24
/* Xt features made by Fred Pierresteguy.  */

25 26
#include <config.h>

27 28 29 30
/* On 4.3 these lose if they come after xterm.h.  */
/* Putting these at the beginning seems to be standard for other .c files.  */
#include <signal.h>

31 32
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
33 34 35
#ifdef HAVE_X_WINDOWS

#include "lisp.h"
36
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
37

38 39 40 41
/* Need syssignal.h for various externs and definitions that may be required
   by some configurations for calls to signal later in this source file.  */
#include "syssignal.h"

Jim Blandy's avatar
Jim Blandy committed
42 43 44
/* This may include sys/types.h, and that somehow loses
   if this is not done before the other system files.  */
#include "xterm.h"
45
#include <X11/cursorfont.h>
Jim Blandy's avatar
Jim Blandy committed
46 47 48 49 50

/* Load sys/types.h if not already loaded.
   In some systems loading it twice is suicidal.  */
#ifndef makedev
#include <sys/types.h>
51
#endif /* makedev */
Jim Blandy's avatar
Jim Blandy committed
52

53
#ifdef BSD_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
54
#include <sys/ioctl.h>
55
#endif /* ! defined (BSD_SYSTEM) */
Jim Blandy's avatar
Jim Blandy committed
56

57
#include "systty.h"
Jim Blandy's avatar
Jim Blandy committed
58
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
59

60
#ifndef INCLUDED_FCNTL
Jim Blandy's avatar
Jim Blandy committed
61
#include <fcntl.h>
62
#endif
Jim Blandy's avatar
Jim Blandy committed
63 64 65 66
#include <ctype.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68
/* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed.  */
/* #include <sys/param.h>  */
Jim Blandy's avatar
Jim Blandy committed
69

70
#include "charset.h"
Kenichi Handa's avatar
Kenichi Handa committed
71
#include "coding.h"
72
#include "ccl.h"
73
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
74
#include "dispextern.h"
75
#include "fontset.h"
Jim Blandy's avatar
Jim Blandy committed
76 77 78 79 80 81
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
#if 0
#include "sink.h"
#include "sinkmask.h"
82
#endif /* ! 0 */
Jim Blandy's avatar
Jim Blandy committed
83 84 85
#include "gnu.h"
#include "disptab.h"
#include "buffer.h"
86
#include "window.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
87
#include "keyboard.h"
Karl Heuer's avatar
Karl Heuer committed
88
#include "intervals.h"
Andreas Schwab's avatar
Andreas Schwab committed
89
#include "process.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
90
#include "atimer.h"
Jim Blandy's avatar
Jim Blandy committed
91

92 93 94 95
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

96 97 98 99 100 101 102
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

103
#ifdef USE_X_TOOLKIT
104

Gerd Moellmann's avatar
Gerd Moellmann committed
105 106 107
extern void free_frame_menubar P_ ((struct frame *));
extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
						    int));
108

109 110 111 112
#if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
#define HACK_EDITRES
extern void _XEditResCheckMessages ();
#endif /* not NO_EDITRES */
113 114 115 116 117 118 119 120

/* Include toolkit specific headers for the scroll bar widget.  */

#ifdef USE_TOOLKIT_SCROLL_BARS
#if defined USE_MOTIF
#include <Xm/Xm.h>		/* for LESSTIF_VERSION */
#include <Xm/ScrollBar.h>
#include <Xm/ScrollBarP.h>
121 122 123
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
124 125 126 127
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
#define ARROW_SCROLLBAR
#include <X11/Xaw3d/ScrollbarP.h>
128 129 130 131 132 133 134 135
#else /* !HAVE_XAW3D */
#include <X11/Xaw/Simple.h>
#include <X11/Xaw/Scrollbar.h>
#endif /* !HAVE_XAW3D */
#ifndef XtNpickTop
#define XtNpickTop "pickTop"
#endif /* !XtNpickTop */
#endif /* !USE_MOTIF */
136 137
#endif /* USE_TOOLKIT_SCROLL_BARS */

138 139
#endif /* USE_X_TOOLKIT */

140 141
#ifndef USE_X_TOOLKIT
#define x_any_window_to_frame x_window_to_frame
142
#define x_top_window_to_frame x_window_to_frame
143 144
#endif

145
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
146
#include "widget.h"
147 148 149 150 151
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

152
#ifndef min
153
#define min(a,b) ((a) < (b) ? (a) : (b))
154 155
#endif
#ifndef max
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
#define max(a,b) ((a) > (b) ? (a) : (b))
#endif

#define abs(x)	((x) < 0 ? -(x) : (x))

#define BETWEEN(X, LOWER, UPPER)  ((X) >= (LOWER) && (X) < (UPPER))


/* Bitmaps for truncated lines.  */

enum bitmap_type
{
  NO_BITMAP,
  LEFT_TRUNCATION_BITMAP,
  RIGHT_TRUNCATION_BITMAP,
  OVERLAY_ARROW_BITMAP,
  CONTINUED_LINE_BITMAP,
  CONTINUATION_LINE_BITMAP,
  ZV_LINE_BITMAP
};

/* Bitmap drawn to indicate lines not displaying text if
   `indicate-empty-lines' is non-nil.  */

#define zv_width 8
#define zv_height 8
static unsigned char zv_bits[] = {
   0x00, 0x00, 0x1e, 0x1e, 0x1e, 0x1e, 0x00, 0x00};

/* An arrow like this: `<-'.  */

#define left_width 8
#define left_height 8
static unsigned char left_bits[] = {
   0x18, 0x0c, 0x06, 0x3f, 0x3f, 0x06, 0x0c, 0x18};

Gerd Moellmann's avatar
Gerd Moellmann committed
192 193 194 195 196 197 198
/* Right truncation arrow bitmap `->'.  */

#define right_width 8
#define right_height 8
static unsigned char right_bits[] = {
   0x18, 0x30, 0x60, 0xfc, 0xfc, 0x60, 0x30, 0x18};

199 200 201 202 203
/* Marker for continued lines.  */

#define continued_width 8
#define continued_height 8
static unsigned char continued_bits[] = {
Gerd Moellmann's avatar
Gerd Moellmann committed
204 205 206
   0x3c, 0x7c, 0xc0, 0xe4, 0xfc, 0x7c, 0x3c, 0x7c};

/* Marker for continuation lines.  */
207 208 209 210

#define continuation_width 8
#define continuation_height 8
static unsigned char continuation_bits[] = {
Gerd Moellmann's avatar
Gerd Moellmann committed
211
   0x3c, 0x3e, 0x03, 0x27, 0x3f, 0x3e, 0x3c, 0x3e};
212

Gerd Moellmann's avatar
Gerd Moellmann committed
213
/* Overlay arrow bitmap.  */
214

Gerd Moellmann's avatar
Gerd Moellmann committed
215 216
#if 0
/* A bomb.  */
217 218 219 220 221
#define ov_width 8
#define ov_height 8
static unsigned char ov_bits[] = {
   0x30, 0x08, 0x3c, 0x7e, 0x7a, 0x7a, 0x62, 0x3c};
#else
Gerd Moellmann's avatar
Gerd Moellmann committed
222
/* A triangular arrow.  */
223 224 225
#define ov_width 8
#define ov_height 8
static unsigned char ov_bits[] = {
Gerd Moellmann's avatar
Gerd Moellmann committed
226 227
   0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};

228
#endif
229 230 231

extern Lisp_Object Qhelp_echo;

232

233 234 235 236 237 238 239 240
/* Non-zero means Emacs uses toolkit scroll bars.  */

int x_toolkit_scroll_bars_p;

/* If a string, XTread_socket generates an event to display that string.
   (The display is done in read_char.)  */
   
static Lisp_Object help_echo;
241
static Lisp_Object help_echo_window;
242 243
static Lisp_Object help_echo_object;
static int help_echo_pos;
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262

/* Temporary variable for XTread_socket.  */

static Lisp_Object previous_help_echo;

/* Non-zero means that a HELP_EVENT has been generated since Emacs
   start.  */

static int any_help_event_p;

/* Non-zero means draw block and hollow cursor as wide as the glyph
   under it.  For example, if a block cursor is over a tab, it will be
   drawn as wide as that tab on the display.  */

int x_stretch_cursor_p;

/* This is a chain of structures for all the X displays currently in
   use.  */

263
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
264

265 266 267 268 269
/* This is a list of cons cells, each of the form (NAME
   . FONT-LIST-CACHE), one for each element of x_display_list and in
   the same order.  NAME is the name of the frame.  FONT-LIST-CACHE
   records previous values returned by x-list-fonts.  */

270
Lisp_Object x_display_name_list;
271

272
/* Frame being updated by update_frame.  This is declared in term.c.
273 274 275 276
   This is set by update_begin and looked at by all the XT functions.
   It is zero while not inside an update.  In that case, the XT
   functions assume that `selected_frame' is the frame to apply to.  */

277
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
278

Andreas Schwab's avatar
Andreas Schwab committed
279
extern int waiting_for_input;
280

281 282
/* This is a frame waiting to be auto-raised, within XTread_socket.  */

283 284
struct frame *pending_autoraise_frame;

285 286 287
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
288 289
static String Xt_default_resources[] = {0};
#endif /* USE_X_TOOLKIT */
290

291 292 293
/* Nominal cursor position -- where to draw output.  
   HPOS and VPOS are window relative glyph matrix coordinates.
   X and Y are window relative pixel coordinates.  */
Jim Blandy's avatar
Jim Blandy committed
294

295
struct cursor_pos output_cursor;
Jim Blandy's avatar
Jim Blandy committed
296

Gerd Moellmann's avatar
Gerd Moellmann committed
297 298 299
/* Non-zero means user is interacting with a toolkit scroll bar.  */

static int toolkit_scroll_bar_interaction;
Jim Blandy's avatar
Jim Blandy committed
300

301 302
/* Mouse movement.

303
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
304 305 306 307 308 309
   so that we would have to call XQueryPointer after each MotionNotify
   event to ask for another such event.  However, this made mouse tracking
   slow, and there was a bug that made it eventually stop.

   Simply asking for MotionNotify all the time seems to work better.

310 311 312 313 314 315 316 317 318
   In order to avoid asking for motion events and then throwing most
   of them away or busy-polling the server for mouse positions, we ask
   the server for pointer motion hints.  This means that we get only
   one event per group of mouse movements.  "Groups" are delimited by
   other kinds of events (focus changes and button clicks, for
   example), or by XQueryPointer calls; when one of these happens, we
   get another MotionNotify event the next time the mouse moves.  This
   is at least as efficient as getting motion events when mouse
   tracking is on, and I suspect only negligibly worse when tracking
319
   is off.  */
320 321 322

/* Where the mouse was last time we reported a mouse event.  */

323 324
FRAME_PTR last_mouse_frame;
static XRectangle last_mouse_glyph;
325 326
static Lisp_Object last_mouse_press_frame;

327 328
/* The scroll bar in which the last X motion event occurred.

329 330
   If the last X motion event occurred in a scroll bar, we set this so
   XTmouse_position can know whether to report a scroll bar motion or
331 332
   an ordinary motion.

333 334 335 336
   If the last X motion event didn't occur in a scroll bar, we set
   this to Qnil, to tell XTmouse_position to return an ordinary motion
   event.  */

337 338 339 340
static Lisp_Object last_mouse_scroll_bar;

/* This is a hack.  We would really prefer that XTmouse_position would
   return the time associated with the position it returns, but there
341
   doesn't seem to be any way to wrest the time-stamp from the server
342 343 344
   along with the position query.  So, we just keep track of the time
   of the last movement we received, and return that in hopes that
   it's somewhat accurate.  */
345

346 347
static Time last_mouse_movement_time;

348 349 350
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

351 352 353 354 355 356
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

357
/* Used locally within XTread_socket.  */
358

359
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
360

361
/* Initial values of argv and argc.  */
362

363 364
extern char **initial_argv;
extern int initial_argc;
Jim Blandy's avatar
Jim Blandy committed
365

366
extern Lisp_Object Vcommand_line_args, Vsystem_name;
Jim Blandy's avatar
Jim Blandy committed
367

368
/* Tells if a window manager is present or not.  */
369 370

extern Lisp_Object Vx_no_window_manager;
Jim Blandy's avatar
Jim Blandy committed
371

372
extern Lisp_Object Qface, Qmouse_face;
373

Jim Blandy's avatar
Jim Blandy committed
374 375
extern int errno;

376
/* A mask of extra modifier bits to put into every keyboard char.  */
377

378 379
extern int extra_keyboard_modifiers;

380 381
static Lisp_Object Qvendor_specific_keysyms;

Gerd Moellmann's avatar
Gerd Moellmann committed
382 383
extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
extern Lisp_Object x_icon_type P_ ((struct frame *));
384

385

386 387 388 389 390 391 392 393 394 395 396 397 398
/* Enumeration for overriding/changing the face to use for drawing
   glyphs in x_draw_glyphs.  */

enum draw_glyphs_face
{
  DRAW_NORMAL_TEXT,
  DRAW_INVERSE_VIDEO,
  DRAW_CURSOR,
  DRAW_MOUSE_FACE,
  DRAW_IMAGE_RAISED,
  DRAW_IMAGE_SUNKEN
};

399
static void x_update_window_end P_ ((struct window *, int, int));
400 401 402 403 404 405 406 407 408 409 410
static void frame_to_window_pixel_xy P_ ((struct window *, int *, int *));
void x_delete_display P_ ((struct x_display_info *));
static unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
						unsigned));
static int fast_find_position P_ ((struct window *, int, int *, int *,
				   int *, int *));
static void set_output_cursor P_ ((struct cursor_pos *));
static struct glyph *x_y_to_hpos_vpos P_ ((struct window *, int, int,
					   int *, int *, int *));
static void note_mode_line_highlight P_ ((struct window *, int, int));
static void note_mouse_highlight P_ ((struct frame *, int, int));
411 412
static void note_tool_bar_highlight P_ ((struct frame *f, int, int));
static void x_handle_tool_bar_click P_ ((struct frame *, XButtonEvent *));
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
static void show_mouse_face P_ ((struct x_display_info *,
				 enum draw_glyphs_face));
static int x_io_error_quitter P_ ((Display *));
int x_catch_errors P_ ((Display *));
void x_uncatch_errors P_ ((Display *, int));
void x_lower_frame P_ ((struct frame *));
void x_scroll_bar_clear P_ ((struct frame *));
int x_had_errors_p P_ ((Display *));
void x_wm_set_size_hint P_ ((struct frame *, long, int));
void x_raise_frame P_ ((struct frame *));
void x_set_window_size P_ ((struct frame *, int, int, int));
void x_wm_set_window_state P_ ((struct frame *, int));
void x_wm_set_icon_pixmap P_ ((struct frame *, int));
void x_initialize P_ ((void));
static void x_font_min_bounds P_ ((XFontStruct *, int *, int *));
static int x_compute_min_glyph_bounds P_ ((struct frame *));
static void x_draw_phys_cursor_glyph P_ ((struct window *,
					  struct glyph_row *,
					  enum draw_glyphs_face));
static void x_update_end P_ ((struct frame *));
static void XTframe_up_to_date P_ ((struct frame *));
static void XTreassert_line_highlight P_ ((int, int));
static void x_change_line_highlight P_ ((int, int, int, int));
static void XTset_terminal_modes P_ ((void));
static void XTreset_terminal_modes P_ ((void));
static void XTcursor_to P_ ((int, int, int, int));
static void x_write_glyphs P_ ((struct glyph *, int));
static void x_clear_end_of_line P_ ((int));
static void x_clear_frame P_ ((void));
static void x_clear_cursor P_ ((struct window *));
static void frame_highlight P_ ((struct frame *));
static void frame_unhighlight P_ ((struct frame *));
static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
static void XTframe_rehighlight P_ ((struct frame *));
static void x_frame_rehighlight P_ ((struct x_display_info *));
static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
449
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int));
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
static int x_intersect_rectangles P_ ((XRectangle *, XRectangle *,
				       XRectangle *));
static void expose_frame P_ ((struct frame *, int, int, int, int));
static void expose_window_tree P_ ((struct window *, XRectangle *));
static void expose_window P_ ((struct window *, XRectangle *));
static void expose_area P_ ((struct window *, struct glyph_row *,
			     XRectangle *, enum glyph_row_area));
static void expose_line P_ ((struct window *, struct glyph_row *,
			     XRectangle *));
static void x_update_cursor_in_window_tree P_ ((struct window *, int));
static void x_update_window_cursor P_ ((struct window *, int));
static void x_erase_phys_cursor P_ ((struct window *));
void x_display_and_set_cursor P_ ((struct window *, int, int, int, int, int));
static void x_draw_bitmap P_ ((struct window *, struct glyph_row *, 
			       enum bitmap_type));

static void x_clip_to_row P_ ((struct window *, struct glyph_row *,
			       GC, int));
static int x_phys_cursor_in_rect_p P_ ((struct window *, XRectangle *));
static void x_draw_row_bitmaps P_ ((struct window *, struct glyph_row *));
static void note_overwritten_text_cursor P_ ((struct window *, int, int));
static void x_flush P_ ((struct frame *f));
Gerd Moellmann's avatar
Gerd Moellmann committed
472 473 474 475 476 477 478
static void x_update_begin P_ ((struct frame *));
static void x_update_window_begin P_ ((struct window *));
static void x_draw_vertical_border P_ ((struct window *));
static void x_after_update_window_line P_ ((struct glyph_row *));
static INLINE void take_vertical_position_into_account P_ ((struct it *));
static void x_produce_stretch_glyph P_ ((struct it *));

479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

/* Flush display of frame F, or of all frames if F is null.  */

static void
x_flush (f)
     struct frame *f;
{
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
	x_flush (XFRAME (frame));
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
498

499 500 501 502 503 504 505 506
/* Remove calls to XFlush by defining XFlush to an empty replacement.
   Calls to XFlush should be unnecessary because the X output buffer
   is flushed automatically as needed by calls to XPending,
   XNextEvent, or XWindowEvent according to the XFlush man page.
   XTread_socket calls XPending.  Removing XFlush improves
   performance.  */

#define XFlush(DISPLAY)	(void) 0 
507

508

509 510 511 512
/***********************************************************************
			      Debugging
 ***********************************************************************/

513
#if 0
514 515 516

/* This is a function useful for recording debugging information about
   the sequence of occurrences in this file.  */
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

struct record 
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

record_event (locus, type)
     char *locus;
     int type;
{
  if (event_record_index == sizeof (event_record) / sizeof (struct record))
    event_record_index = 0;

  event_record[event_record_index].locus = locus;
  event_record[event_record_index].type = type;
  event_record_index++;
}

#endif /* 0 */
541 542


543

544 545 546 547 548 549 550 551 552 553 554
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
x_display_info_for_display (dpy)
     Display *dpy;
{
  struct x_display_info *dpyinfo;

  for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
    if (dpyinfo->display == dpy)
      return dpyinfo;
555

556 557
  return 0;
}
558

559 560 561 562 563 564 565 566 567 568 569


/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
									
/* Start an update of frame F.  This function is installed as a hook
   for update_begin, i.e. it is called when update_begin is called.
   This function is called prior to calls to x_update_window_begin for
   each window being updated.  Currently, there is nothing to do here
   because all interesting stuff is done on a window basis.  */
Jim Blandy's avatar
Jim Blandy committed
570

Andreas Schwab's avatar
Andreas Schwab committed
571
static void
572
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
573
     struct frame *f;
574
{
575 576
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
577 578


579 580 581
/* Start update of window W.  Set the global variable updated_window
   to the window being updated and set output_cursor to the cursor
   position of W.  */
Jim Blandy's avatar
Jim Blandy committed
582

583 584 585 586 587 588 589 590 591
static void
x_update_window_begin (w)
     struct window *w;
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
  
  updated_window = w;
  set_output_cursor (&w->cursor);
592

593
  BLOCK_INPUT;
594

595
  if (f == display_info->mouse_face_mouse_frame)
596
    {
597
      /* Don't do highlighting for mouse motion during the update.  */
598
      display_info->mouse_face_defer = 1;
599

600 601
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
602
      if (FRAME_GARBAGED_P (f))
603 604
	display_info->mouse_face_window = Qnil;

605 606 607 608 609 610 611
#if 0 /* Rows in a current matrix containing glyphs in mouse-face have
	 their mouse_face_p flag set, which means that they are always
	 unequal to rows in a desired matrix which never have that
	 flag set.  So, rows containing mouse-face glyphs are never
	 scrolled, and we don't have to switch the mouse highlight off
	 here to prevent it from being scrolled.  */
      
612 613 614 615 616 617 618
      /* Can we tell that this update does not affect the window
	 where the mouse highlight is?  If so, no need to turn off.
	 Likewise, don't do anything if the frame is garbaged;
	 in that case, the frame's current matrix that we would use
	 is all wrong, and we will redisplay that line anyway.  */
      if (!NILP (display_info->mouse_face_window)
	  && w == XWINDOW (display_info->mouse_face_window))
619
	{
620
	  int i;
621

622 623
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
624 625
	      break;

626 627
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
628
	}
629
#endif /* 0 */
630
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
631

Jim Blandy's avatar
Jim Blandy committed
632 633 634
  UNBLOCK_INPUT;
}

635 636 637 638

/* Draw a vertical window border to the right of window W if W doesn't
   have vertical scroll bars.  */

Andreas Schwab's avatar
Andreas Schwab committed
639
static void
640 641
x_draw_vertical_border (w)
     struct window *w;
642
{
643 644 645 646 647 648 649 650 651 652
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  
  /* Redraw borders between horizontally adjacent windows.  Don't
     do it for frames with vertical scroll bars because either the
     right scroll bar of a window, or the left scroll bar of its
     neighbor will suffice as a border.  */
  if (!WINDOW_RIGHTMOST_P (w)
      && !FRAME_HAS_VERTICAL_SCROLL_BARS (f))
    {
      int x0, x1, y0, y1;
Jim Blandy's avatar
Jim Blandy committed
653

654
      window_box_edges (w, -1, &x0, &y0, &x1, &y1);
Gerd Moellmann's avatar
Gerd Moellmann committed
655
      x1 += FRAME_X_RIGHT_FLAGS_AREA_WIDTH (f);
656 657 658 659 660 661 662 663
      y1 -= 1;
      
      XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 
		 f->output_data.x->normal_gc, x1, y0, x1, y1);
    }
}
   
   
664 665 666 667 668 669 670 671 672 673 674 675
/* End update of window W (which is equal to updated_window).

   Draw vertical borders between horizontally adjacent windows, and
   display W's cursor if CURSOR_ON_P is non-zero.

   MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
   glyphs in mouse-face were overwritten.  In that case we have to
   make sure that the mouse-highlight is properly redrawn.

   W may be a menu bar pseudo-window in case we don't have X toolkit
   support.  Such windows don't have a cursor, so don't display it
   here.  */
676 677

static void
678
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
679
     struct window *w;
680
     int cursor_on_p, mouse_face_overwritten_p;
681 682 683
{
  if (!w->pseudo_window_p)
    {
684 685 686
      struct x_display_info *dpyinfo
	= FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
      
687
      BLOCK_INPUT;
688 689 690 691 692 693 694 695 696 697

      /* If a row with mouse-face was overwritten, arrange for
	 XTframe_up_to_date to redisplay the mouse highlight.  */
      if (mouse_face_overwritten_p)
	{
	  dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
	  dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
	  dpyinfo->mouse_face_window = Qnil;
	}
      
698 699 700 701
      if (cursor_on_p)
	x_display_and_set_cursor (w, 1, output_cursor.hpos,
				  output_cursor.vpos,
				  output_cursor.x, output_cursor.y);
702
      
703 704 705 706 707 708
      x_draw_vertical_border (w);
      UNBLOCK_INPUT;
    }
  
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
709 710


711 712 713 714 715 716 717 718
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
x_update_end (f)
     struct frame *f;
{
  /* Mouse highlight may be displayed again.  */
719
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
720

721
  BLOCK_INPUT;
722
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
723 724
  UNBLOCK_INPUT;
}
725

726 727 728 729

/* This function is called from various places in xdisp.c whenever a
   complete update has been performed.  The global variable
   updated_window is not available here.  */
730

Andreas Schwab's avatar
Andreas Schwab committed
731
static void
732
XTframe_up_to_date (f)
733
     struct frame *f;
734
{
735
  if (FRAME_X_P (f))
736
    {
737
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
738

739 740 741 742 743 744 745 746 747 748 749
      if (dpyinfo->mouse_face_deferred_gc
	  || f == dpyinfo->mouse_face_mouse_frame)
	{
	  BLOCK_INPUT;
	  if (dpyinfo->mouse_face_mouse_frame)
	    note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
				  dpyinfo->mouse_face_mouse_x,
				  dpyinfo->mouse_face_mouse_y);
	  dpyinfo->mouse_face_deferred_gc = 0;
	  UNBLOCK_INPUT;
	}
750
    }
751
}
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
   arrow bitmaps, or clear the areas where they would be displayed
   before DESIRED_ROW is made current.  The window being updated is
   found in updated_window.  This function It is called from
   update_window_line only if it is known that there are differences
   between bitmaps to be drawn between current row and DESIRED_ROW.  */

static void
x_after_update_window_line (desired_row)
     struct glyph_row *desired_row;
{
  struct window *w = updated_window;
  
  xassert (w);
  
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
    {
      BLOCK_INPUT;
      x_draw_row_bitmaps (w, desired_row);

      /* When a window has disappeared, make sure that no rest of
	 full-width rows stays visible in the internal border.  */
      if (windows_or_buffers_changed)
	{
	  struct frame *f = XFRAME (w->frame);
	  int width = FRAME_INTERNAL_BORDER_WIDTH (f);
	  int height = desired_row->visible_height;
Gerd Moellmann's avatar
Gerd Moellmann committed
781 782
	  int x = (window_box_right (w, -1)
		   + FRAME_X_RIGHT_FLAGS_AREA_WIDTH (f));
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
	  int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));

	  XClearArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		      x, y, width, height, False);
	}
      
      UNBLOCK_INPUT;
    }
}


/* Draw the bitmap WHICH in one of the areas to the left or right of
   window W.  ROW is the glyph row for which to display the bitmap; it
   determines the vertical position at which the bitmap has to be
   drawn.  */

static void
x_draw_bitmap (w, row, which)
     struct window *w;
     struct glyph_row *row;
     enum bitmap_type which;
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  Display *display = FRAME_X_DISPLAY (f);
  Window window = FRAME_X_WINDOW (f);
  int x, y, wd, h, dy;
  unsigned char *bits;
  Pixmap pixmap;
  GC gc = f->output_data.x->normal_gc;
  struct face *face;
  int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));

  /* Must clip because of partially visible lines.  */
  x_clip_to_row (w, row, gc, 1);

  switch (which)
    {
    case LEFT_TRUNCATION_BITMAP:
      wd = left_width;
      h = left_height;
      bits = left_bits;
      x = (WINDOW_TO_FRAME_PIXEL_X (w, 0)
	   - wd
Gerd Moellmann's avatar
Gerd Moellmann committed
826
	   - (FRAME_X_LEFT_FLAGS_AREA_WIDTH (f) - wd) / 2);
827 828 829 830 831 832 833 834
      break;
      
    case OVERLAY_ARROW_BITMAP:
      wd = left_width;
      h = left_height;
      bits = ov_bits;
      x = (WINDOW_TO_FRAME_PIXEL_X (w, 0)
	   - wd
Gerd Moellmann's avatar
Gerd Moellmann committed
835
	   - (FRAME_X_LEFT_FLAGS_AREA_WIDTH (f) - wd) / 2);
836 837 838 839 840 841 842
      break;
      
    case RIGHT_TRUNCATION_BITMAP:
      wd = right_width;
      h = right_height;
      bits = right_bits;
      x = window_box_right (w, -1);
Gerd Moellmann's avatar
Gerd Moellmann committed
843
      x += (FRAME_X_RIGHT_FLAGS_AREA_WIDTH (f) - wd) / 2;
844 845 846 847 848 849 850
      break;

    case CONTINUED_LINE_BITMAP:
      wd = right_width;
      h = right_height;
      bits = continued_bits;
      x = window_box_right (w, -1);
Gerd Moellmann's avatar
Gerd Moellmann committed
851
      x += (FRAME_X_RIGHT_FLAGS_AREA_WIDTH (f) - wd) / 2;
852 853 854 855 856 857 858 859
      break;
      
    case CONTINUATION_LINE_BITMAP:
      wd = continuation_width;
      h = continuation_height;
      bits = continuation_bits;
      x = (WINDOW_TO_FRAME_PIXEL_X (w, 0)
	   - wd
Gerd Moellmann's avatar
Gerd Moellmann committed
860
	   - (FRAME_X_LEFT_FLAGS_AREA_WIDTH (f) - wd) / 2);
861 862 863 864 865 866 867 868
      break;

    case ZV_LINE_BITMAP:
      wd = zv_width;
      h = zv_height;
      bits = zv_bits;
      x = (WINDOW_TO_FRAME_PIXEL_X (w, 0)
	   - wd
Gerd Moellmann's avatar
Gerd Moellmann committed
869
	   - (FRAME_X_LEFT_FLAGS_AREA_WIDTH (f) - wd) / 2);
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
      break;

    default:
      abort ();
    }

  /* Convert to frame coordinates.  Set dy to the offset in the row to
     start drawing the bitmap.  */
  y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
  dy = (row->height - h) / 2;

  /* Draw the bitmap.  I believe these small pixmaps can be cached
     by the server.  */
  face = FACE_FROM_ID (f, BITMAP_AREA_FACE_ID);
  pixmap = XCreatePixmapFromBitmapData (display, window, bits, wd, h,
					face->foreground,
					face->background, depth);
  XCopyArea (display, pixmap, window, gc, 0, 0, wd, h, x, y + dy);
  XFreePixmap (display, pixmap);
  XSetClipMask (display, gc, None);
}


/* Draw flags bitmaps for glyph row ROW on window W.  Call this
   function with input blocked.  */

static void
x_draw_row_bitmaps (w, row)
     struct window *w;
     struct glyph_row *row;
{
  struct frame *f = XFRAME (w->frame);
  enum bitmap_type bitmap;
  struct face *face;
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
904
  int header_line_height = -1;
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930

  xassert (interrupt_input_blocked);

  /* If row is completely invisible, because of vscrolling, we
     don't have to draw anything.  */
  if (row->visible_height <= 0)
    return;

  face = FACE_FROM_ID (f, BITMAP_AREA_FACE_ID);
  PREPARE_FACE_FOR_DISPLAY (f, face);

  /* Decide which bitmap to draw at the left side.  */
  if (row->overlay_arrow_p)
    bitmap = OVERLAY_ARROW_BITMAP;
  else if (row->truncated_on_left_p)
    bitmap = LEFT_TRUNCATION_BITMAP;
  else if (MATRIX_ROW_CONTINUATION_LINE_P (row))
    bitmap = CONTINUATION_LINE_BITMAP;
  else if (row->indicate_empty_line_p)
    bitmap = ZV_LINE_BITMAP;
  else
    bitmap = NO_BITMAP;

  /* Clear flags area if no bitmap to draw or if bitmap doesn't fill
     the flags area.  */
  if (bitmap == NO_BITMAP
Gerd Moellmann's avatar
Gerd Moellmann committed
931
      || FRAME_FLAGS_BITMAP_WIDTH (f) < FRAME_X_LEFT_FLAGS_AREA_WIDTH (f)
932 933 934 935 936 937 938 939
      || row->height > FRAME_FLAGS_BITMAP_HEIGHT (f))
    {
      /* If W has a vertical border to its left, don't draw over it.  */
      int border = ((XFASTINT (w->left) > 0
		     && !FRAME_HAS_VERTICAL_SCROLL_BARS (f))
		    ? 1 : 0);
      int left = window_box_left (w, -1);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
940 941
      if (header_line_height < 0)
	header_line_height = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
942 943 944 945 946 947 948 949 950 951
      
      /* In case the same realized face is used for bitmap areas and
	 for something displayed in the text (e.g. face `region' on
	 mono-displays, the fill style may have been changed to
	 FillSolid in x_draw_glyph_string_background.  */
      if (face->stipple)
	XSetFillStyle (FRAME_X_DISPLAY (f), face->gc, FillOpaqueStippled);
      else
	XSetForeground (FRAME_X_DISPLAY (f), face->gc, face->background);
      
952 953 954
      XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		      face->gc,
		      (left
Gerd Moellmann's avatar
Gerd Moellmann committed
955
		       - FRAME_X_LEFT_FLAGS_AREA_WIDTH (f)
956
		       + border),
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
957
		      WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
958
						       row->y)),
Gerd Moellmann's avatar
Gerd Moellmann committed
959
		      FRAME_X_LEFT_FLAGS_AREA_WIDTH (f) - border,
960
		      row->visible_height);
961 962
      if (!face->stipple)
	XSetForeground (FRAME_X_DISPLAY (f), face->gc, face->foreground);
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
    }

  /* Draw the left bitmap.  */
  if (bitmap != NO_BITMAP)
    x_draw_bitmap (w, row, bitmap);

  /* Decide which bitmap to draw at the right side.  */
  if (row->truncated_on_right_p)
    bitmap = RIGHT_TRUNCATION_BITMAP;
  else if (row->continued_p)
    bitmap = CONTINUED_LINE_BITMAP;
  else
    bitmap = NO_BITMAP;

  /* Clear flags area if no bitmap to draw of if bitmap doesn't fill
     the flags area.  */
  if (bitmap == NO_BITMAP
Gerd Moellmann's avatar
Gerd Moellmann committed
980
      || FRAME_FLAGS_BITMAP_WIDTH (f) < FRAME_X_RIGHT_FLAGS_AREA_WIDTH (f)
981 982 983 984
      || row->height > FRAME_FLAGS_BITMAP_HEIGHT (f))
    {
      int right = window_box_right (w, -1);

Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
985 986
      if (header_line_height < 0)
	header_line_height = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
987 988 989 990 991 992 993 994 995

      /* In case the same realized face is used for bitmap areas and
	 for something displayed in the text (e.g. face `region' on
	 mono-displays, the fill style may have been changed to
	 FillSolid in x_draw_glyph_string_background.  */
      if (face->stipple)
	XSetFillStyle (FRAME_X_DISPLAY (f), face->gc, FillOpaqueStippled);
      else
	XSetForeground (FRAME_X_DISPLAY (f), face->gc, face->background);
996 997 998
      XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		      face->gc,
		      right,
Gerd Moellmann's avatar
Change  
Gerd Moellmann committed
999
		      WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
1000
						       row->y)),
Gerd Moellmann's avatar
Gerd Moellmann committed
1001
		      FRAME_X_RIGHT_FLAGS_AREA_WIDTH (f),
1002
		      row->visible_height);
1003 1004
      if (!face->stipple)
	XSetForeground (FRAME_X_DISPLAY (f), face->gc, face->foreground);
1005 1006 1007 1008 1009 1010 1011
    }

  /* Draw the right bitmap.  */
  if (bitmap != NO_BITMAP)
    x_draw_bitmap (w, row, bitmap);
}

Jim Blandy's avatar
Jim Blandy committed
1012

1013 1014 1015
/***********************************************************************
			  Line Highlighting
 ***********************************************************************/
Jim Blandy's avatar
Jim Blandy committed
1016

1017 1018 1019 1020
/* External interface to control of standout mode.  Not used for X
   frames.  Aborts when called.  */

static void
Jim Blandy's avatar
Jim Blandy committed
1021 1022 1023
XTreassert_line_highlight (new, vpos)
     int new, vpos;
{
1024
  abort ();
Jim Blandy's avatar
Jim Blandy committed
1025 1026
}

1027 1028 1029 1030

/* Call this when about to modify line at position VPOS and change
   whether it is highlighted.  Not used for X frames.  Aborts when
   called.  */
Jim Blandy's avatar
Jim Blandy committed
1031

Andreas Schwab's avatar
Andreas Schwab committed
1032
static void
1033 1034
x_change_line_highlight (new_highlight, vpos, y, first_unused_hpos)
     int new_highlight, vpos, y, first_unused_hpos;
Jim Blandy's avatar
Jim Blandy committed
1035
{
1036
  abort ();
Jim Blandy's avatar
Jim Blandy committed
1037 1038
}

1039 1040 1041 1042 1043

/* This is called when starting Emacs and when restarting after
   suspend.  When starting Emacs, no X window is mapped.  And nothing
   must be done to Emacs's own window if it is suspended (though that
   rarely happens).  */
Jim Blandy's avatar
Jim Blandy committed
1044

Andreas Schwab's avatar
Andreas Schwab committed
1045
static void
Jim Blandy's avatar
Jim Blandy committed
1046 1047 1048 1049
XTset_terminal_modes ()
{
}

1050 1051
/* This is called when exiting or suspending Emacs.  Exiting will make
   the X-windows go away, and suspending requires no action.  */
Jim Blandy's avatar
Jim Blandy committed
1052

Andreas Schwab's avatar
Andreas Schwab committed
1053
static void
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056
XTreset_terminal_modes ()
{
}
1057 1058


Jim Blandy's avatar
Jim Blandy committed
1059

1060 1061 1062 1063 1064 1065
/***********************************************************************
			    Output Cursor
 ***********************************************************************/

/* Set the global variable output_cursor to CURSOR.  All cursor
   positions are relative to updated_window.  */
Jim Blandy's avatar
Jim Blandy committed
1066

Andreas Schwab's avatar
Andreas Schwab committed
1067
static void
1068 1069
set_output_cursor (cursor)
    struct cursor_pos *cursor;
Jim Blandy's avatar
Jim Blandy committed
1070
{
1071 1072 1073 1074 1075 1076 1077 1078
  output_cursor.hpos = cursor->hpos;
  output_cursor.vpos = cursor->vpos;
  output_cursor.x = cursor->x;
  output_cursor.y = cursor->y;
}


/* Set a nominal cursor position.
Jim Blandy's avatar
Jim Blandy committed
1079

1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
   HPOS and VPOS are column/row positions in a window glyph matrix.  X
   and Y are window text area relative pixel positions.
   
   If this is done during an update, updated_window will contain the
   window that is being updated and the position is the future output
   cursor position for that window.  If updated_window is null, use
   selected_window and display the cursor at the given position.  */

static void
XTcursor_to (vpos, hpos, y, x)
     int vpos, hpos, y, x;
{
  struct window *w;

  /* If updated_window is not set, work on selected_window.  */
  if (updated_window)
    w = updated_window;
  else
    w = XWINDOW (selected_window);
1099

1100 1101 1102 1103 1104
  /* Set the output cursor.  */
  output_cursor.hpos = hpos;
  output_cursor.vpos = vpos;
  output_cursor.x = x;
  output_cursor.y = y;
Jim Blandy's avatar
Jim Blandy committed
1105

1106 1107 1108
  /* If not called as part of an update, really display the cursor.
     This will also set the cursor position of W.  */
  if (updated_window == NULL)
Jim Blandy's avatar
Jim Blandy committed
1109 1110
    {
      BLOCK_INPUT;
1111
      x_display_cursor (w, 1, hpos, vpos, x, y);
1112
      XFlush (FRAME_X_DISPLAY (SELECTED_FRAME ()));
Jim Blandy's avatar
Jim Blandy committed
1113 1114 1115
      UNBLOCK_INPUT;
    }
}
1116

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126


/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

static struct face *x_get_glyph_face_and_encoding P_ ((struct frame *,
						       struct glyph *,
1127 1128
						       XChar2b *,
						       int *));
1129 1130 1131 1132 1133
static struct face *x_get_char_face_and_encoding P_ ((struct frame *, int,
						      int, XChar2b *, int));
static XCharStruct *x_per_char_metric P_ ((XFontStruct *, XChar2b *));
static void x_encode_char P_ ((int, XChar2b *, struct font_info *));
static void x_append_glyph P_ ((struct it *));
1134
static void x_append_composite_glyph P_ ((struct it *));
1135 1136 1137 1138
static void x_append_stretch_glyph P_ ((struct it *it, Lisp_Object,
					int, int, double));
static void x_produce_glyphs P_ ((struct it *));
static void x_produce_image_glyph P_ ((struct it *it));
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151


/* Return a pointer to per-char metric information in FONT of a
   character pointed by B which is a pointer to an XChar2b.  */

#define PER_CHAR_METRIC(font, b)					   \
  ((font)->per_char							   \
   ? ((font)->per_char + (b)->byte2 - (font)->min_char_or_byte2		   \
      + (((font)->min_byte1 || (font)->max_byte1)			   \
	 ? (((b)->byte1 - (font)->min_byte1)				   \
	    * ((font)->max_char_or_byte2 - (font)->min_char_or_byte2 + 1)) \
	 : 0))								   \
   : &((font)->max_bounds))
1152

Jim Blandy's avatar
Jim Blandy committed
1153

Gerd Moellmann's avatar
Gerd Moellmann committed
1154 1155
/* Get metrics of character CHAR2B in FONT.  Value is null if CHAR2B
   is not contained in the font.  */
1156

1157
static INLINE XCharStruct *
1158
x_per_char_metric (font, char2b)
1159 1160 1161 1162 1163
     XFontStruct *font;
     XChar2b *char2b;
{
  /* The result metric information.  */
  XCharStruct *pcm = NULL;
Jim Blandy's avatar
Jim Blandy committed
1164

1165
  xassert (font && char2b);
Jim Blandy's avatar
Jim Blandy committed
1166

1167
  if (font->per_char != NULL)
Jim Blandy's avatar
Jim Blandy committed
1168
    {
1169
      if (font->min_byte1 == 0 && font->max_byte1 == 0)
1170
	{
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180
	  /* min_char_or_byte2 specifies the linear character index
	     corresponding to the first element of the per_char array,
	     max_char_or_byte2 is the index of the last character.  A
	     character with non-zero CHAR2B->byte1 is not in the font.
	     A character with byte2 less than min_char_or_byte2 or
	     greater max_char_or_byte2 is not in the font.  */
	  if (char2b->byte1 == 0
	      && char2b->byte2 >= font->min_char_or_byte2
	      && char2b->byte2 <= font->max_char_or_byte2)
	    pcm = font->per_char + char2b->byte2 - font->min_char_or_byte2;
1181
	}
1182
      else
Jim Blandy's avatar
Jim Blandy committed
1183
	{
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
	  /* If either min_byte1 or max_byte1 are nonzero, both
	     min_char_or_byte2 and max_char_or_byte2 are less than
	     256, and the 2-byte character index values corresponding
	     to the per_char array element N (counting from 0) are:

	     byte1 = N/D + min_byte1
	     byte2 = N\D + min_char_or_byte2

	     where:

	     D = max_char_or_byte2 - min_char_or_byte2 + 1
	     / = integer division
	     \ = integer modulus  */
	  if (char2b->byte1 >= font->min_byte1
	      && char2b->byte1 <= font->max_byte1
	      && char2b->byte2 >= font->min_char_or_byte2
	      && char2b->byte2 <= font->max_char_or_byte2)
	    {
	      pcm = (font->per_char
		     + ((font->max_char_or_byte2 - font->min_char_or_byte2 + 1)
			* (char2b->byte1 - font->min_byte1))
		     + (char2b->byte2 - font->min_char_or_byte2));
	    }
Jim Blandy's avatar
Jim Blandy committed
1207
	}
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
    }
  else
    {
      /* If the per_char pointer is null, all glyphs between the first
	 and last character indexes inclusive have the same
	 information, as given by both min_bounds and max_bounds.  */
      if (char2b->byte2 >= font->min_char_or_byte2
	  && char2b->byte2 <= font->max_char_or_byte2)
	pcm = &font->max_bounds;
    }
Jim Blandy's avatar
Jim Blandy committed
1218

1219
  return ((pcm == NULL
1220
	   || (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0))
1221
	  ? NULL : pcm);
1222
}
1223

1224

1225 1226
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */
1227

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
static INLINE void
x_encode_char (c, char2b, font_info)
     int c;
     XChar2b *char2b;
     struct font_info *font_info;
{
  int charset = CHAR_CHARSET (c);
  XFontStruct *font = font_info->font;

  /* FONT_INFO may define a scheme by which to encode byte1 and byte2.
     This may be either a program in a special encoder language or a
     fixed encoding.  */
  if (font_info->font_encoder)
    {
      /* It's a program.  */
      struct ccl_program *ccl = font_info->font_encoder;

      if (CHARSET_DIMENSION (charset) == 1)
	{
	  ccl->reg[0] = charset;
	  ccl->reg[1] = char2b->byte2;
	}
      else
	{
	  ccl->reg[0] = charset;
	  ccl->reg[1] = char2b->byte1;
	  ccl->reg[2] = char2b->byte2;
	}
      
      ccl_driver (ccl, NULL, NULL, 0, 0, NULL);
      
      /* We assume that MSBs are appropriately set/reset by CCL
	 program.  */
      if (font->max_byte1 == 0)	/* 1-byte font */
1262
	char2b->byte1 = 0, char2b->byte2 = ccl->reg[1];
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
      else
	char2b->byte1 = ccl->reg[1], char2b->byte2 = ccl->reg[2];
    }
  else if (font_info->encoding[charset])
    {
      /* Fixed encoding scheme.  See fontset.h for the meaning of the
	 encoding numbers.  */
      int enc = font_info->encoding[charset];
      
      if ((enc == 1 || enc == 2)
	  && CHARSET_DIMENSION (charset) == 2)
	char2b->byte1 |= 0x80;
      
      if (enc == 1 || enc == 3)
	char2b->byte2 |= 0x80;
    }
}


/* Get face and two-byte form of character C in face FACE_ID on frame
   F.  The encoding of C is returned in *CHAR2B.  MULTIBYTE_P non-zero
   means we want to display multibyte text.  Value is a pointer to a
   realized face that is ready for display.  */

static INLINE struct face *
x_get_char_face_and_encoding (f, c, face_id, char2b, multibyte_p)
     struct frame *f;
     int c, face_id;
     XChar2b *char2b;
     int multibyte_p;
{
  struct face *face = FACE_FROM_ID (f, face_id);

  if (!multibyte_p)
    {
      /* Unibyte case.  We don't have to encode, but we have to make
	 sure to use a face suitable for unibyte.  */
      char2b->byte1 = 0;
      char2b->byte2 = c;
1302 1303
      face_id = FACE_FOR_CHAR (f, face, c);
      face = FACE_FROM_ID (f, face_id);
1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
    }
  else if (c < 128 && face_id < BASIC_FACE_ID_SENTINEL)
    {
      /* Case of ASCII in a face known to fit ASCII.  */
      char2b->byte1 = 0;
      char2b->byte2 = c;
    }
  else
    {
      int c1, c2, charset;
      
      /* Split characters into bytes.  If c2 is -1 afterwards, C is
	 really a one-byte character so that byte1 is zero.  */
      SPLIT_CHAR (c, charset, c1, c2);
      if (c2 > 0)
	char2b->byte1 = c1, char2b->byte2 = c2;
      else
	char2b->byte1 = 0, char2b->byte2 = c1;

      /* Maybe encode the character in *CHAR2B.  */
1324
      if (face->font != NULL)
1325 1326 1327 1328
	{
	  struct font_info *font_info
	    = FONT_INFO_FROM_ID (f, face->font_info_id);
	  if (font_info)
1329
	    x_encode_char (c, char2b, font_info);
1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
	}
    }

  /* Make sure X resources of the face are allocated.  */
  xassert (face != NULL);
  PREPARE_FACE_FOR_DISPLAY (f, face);
  
  return face;
}


/* Get face and two-byte form of character glyph GLYPH on frame F.
1342
   The encoding of GLYPH->u.ch is returned in *CHAR2B.  Value is
1343 1344 1345
   a pointer to a realized face that is ready for display.  */

static INLINE struct face *
1346
x_get_glyph_face_and_encoding (f, glyph, char2b, two_byte_p)
1347 1348 1349
     struct frame *f;
     struct glyph *glyph;
     XChar2b *char2b;
1350
     int *two_byte_p;
1351 1352 1353 1354
{
  struct face *face;

  xassert (glyph->type == CHAR_GLYPH);
1355
  face = FACE_FROM_ID (f, glyph->face_id);
1356

1357 1358 1359
  if (two_byte_p)
    *two_byte_p = 0;

1360 1361 1362 1363 1364
  if (!glyph->multibyte_p)
    {
      /* Unibyte case.  We don't have to encode, but we have to make
	 sure to use a face suitable for unibyte.  */
      char2b->byte1 = 0;