xterm.c 429 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
Gerd Moellmann's avatar
Gerd Moellmann committed
2
   Copyright (C) 1989, 93, 94, 95, 96, 1997, 1998, 1999, 2000, 2001
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"
#include "gnu.h"
#include "disptab.h"
#include "buffer.h"
82
#include "window.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
83
#include "keyboard.h"
Karl Heuer's avatar
Karl Heuer committed
84
#include "intervals.h"
Andreas Schwab's avatar
Andreas Schwab committed
85
#include "process.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
86
#include "atimer.h"
Stefan Monnier's avatar
Stefan Monnier committed
87
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
88

89 90 91 92
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

93 94 95 96 97 98 99
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

100 101 102 103 104
#ifdef USE_LUCID
extern int xlwmenu_window_p (Widget w, Window window);
extern void xlwmenu_redisplay P_ ((Widget));
#endif

105
#ifdef USE_X_TOOLKIT
106

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

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

/* 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>
122 123 124
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
125 126 127 128
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
#define ARROW_SCROLLBAR
#include <X11/Xaw3d/ScrollbarP.h>
129 130 131 132 133 134 135 136
#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 */
137 138
#endif /* USE_TOOLKIT_SCROLL_BARS */

139 140
#endif /* USE_X_TOOLKIT */

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

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

153 154 155 156 157
#define abs(x)	((x) < 0 ? -(x) : (x))

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


Kim F. Storm's avatar
Kim F. Storm committed
158
/* Fringe bitmaps.  */
159

Kim F. Storm's avatar
Kim F. Storm committed
160
enum fringe_bitmap_type
161
{
Kim F. Storm's avatar
Kim F. Storm committed
162
  NO_FRINGE_BITMAP,
163 164 165 166 167 168 169 170 171 172 173 174
  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
175 176
#define zv_height 72
#define zv_period 3
177
static unsigned char zv_bits[] = {
178 179 180 181 182 183 184 185
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00,
  0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00, 0x00, 0x3c, 0x00};
186 187 188 189 190 191 192 193

/* 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
194 195 196 197 198 199 200
/* 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};

201 202 203 204 205
/* Marker for continued lines.  */

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

/* Marker for continuation lines.  */
209 210 211 212

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

Gerd Moellmann's avatar
Gerd Moellmann committed
215
/* Overlay arrow bitmap.  */
216

Gerd Moellmann's avatar
Gerd Moellmann committed
217 218
#if 0
/* A bomb.  */
219 220 221 222 223
#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
224
/* A triangular arrow.  */
225 226 227
#define ov_width 8
#define ov_height 8
static unsigned char ov_bits[] = {
Gerd Moellmann's avatar
Gerd Moellmann committed
228 229
   0x03, 0x0f, 0x1f, 0x3f, 0x3f, 0x1f, 0x0f, 0x03};

230
#endif
231 232 233

extern Lisp_Object Qhelp_echo;

234

235
/* Non-nil means Emacs uses toolkit scroll bars.  */
236

237
Lisp_Object Vx_toolkit_scroll_bars;
238 239 240 241 242

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

/* 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;

262 263 264 265
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */

int x_use_underline_position_properties;

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

269
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
270

271 272 273 274 275
/* 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.  */

276
Lisp_Object x_display_name_list;
277

278
/* Frame being updated by update_frame.  This is declared in term.c.
279 280 281 282
   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.  */

283
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
284

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

287 288
struct frame *pending_autoraise_frame;

289 290 291
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
292 293
static String Xt_default_resources[] = {0};
#endif /* USE_X_TOOLKIT */
294

295 296 297
/* 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
298

299
struct cursor_pos output_cursor;
Jim Blandy's avatar
Jim Blandy committed
300

Gerd Moellmann's avatar
Gerd Moellmann committed
301 302 303
/* Non-zero means user is interacting with a toolkit scroll bar.  */

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

305 306
/* Mouse movement.

307
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
308 309 310 311 312 313
   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.

314 315 316 317 318 319 320 321 322
   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
323
   is off.  */
324 325 326

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

327 328
FRAME_PTR last_mouse_frame;
static XRectangle last_mouse_glyph;
329 330
static Lisp_Object last_mouse_press_frame;

331 332
/* The scroll bar in which the last X motion event occurred.

333 334
   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
335 336
   an ordinary motion.

337 338 339 340
   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.  */

341 342 343 344
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
345
   doesn't seem to be any way to wrest the time-stamp from the server
346 347 348
   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.  */
349

350 351
static Time last_mouse_movement_time;

352 353 354
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

355 356 357 358 359 360
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

361
/* Used locally within XTread_socket.  */
362

363
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
364

365
/* Initial values of argv and argc.  */
366

367 368
extern char **initial_argv;
extern int initial_argc;
Jim Blandy's avatar
Jim Blandy committed
369

370
extern Lisp_Object Vcommand_line_args, Vsystem_name;
Jim Blandy's avatar
Jim Blandy committed
371

372
/* Tells if a window manager is present or not.  */
373 374

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

376
extern Lisp_Object Qface, Qmouse_face;
377

Jim Blandy's avatar
Jim Blandy committed
378 379
extern int errno;

380
/* A mask of extra modifier bits to put into every keyboard char.  */
381

382 383
extern int extra_keyboard_modifiers;

384 385
static Lisp_Object Qvendor_specific_keysyms;

Gerd Moellmann's avatar
Gerd Moellmann committed
386 387
extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
extern Lisp_Object x_icon_type P_ ((struct frame *));
388

389

390 391 392 393 394 395 396 397 398 399 400 401 402
/* 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
};

403
static int cursor_in_mouse_face_p P_ ((struct window *));
404
static int clear_mouse_face P_ ((struct x_display_info *));
405
static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
406
static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
407
static const XColor *x_color_cells P_ ((Display *, int *));
408
static void x_update_window_end P_ ((struct window *, int, int));
409 410 411 412 413
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 *,
414
				   int *, int *, Lisp_Object));
415 416
static int fast_find_string_pos P_ ((struct window *, int, Lisp_Object,
				     int *, int *, int *, int *, int));
417 418
static void set_output_cursor P_ ((struct cursor_pos *));
static struct glyph *x_y_to_hpos_vpos P_ ((struct window *, int, int,
419
					   int *, int *, int *, int));
420 421
static void note_mode_line_highlight P_ ((struct window *, int, int));
static void note_mouse_highlight P_ ((struct frame *, int, int));
422 423
static void note_tool_bar_highlight P_ ((struct frame *f, int, int));
static void x_handle_tool_bar_click P_ ((struct frame *, XButtonEvent *));
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 449 450 451 452 453 454 455 456 457
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 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 *));
458
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int));
459 460 461
static int x_intersect_rectangles P_ ((XRectangle *, XRectangle *,
				       XRectangle *));
static void expose_frame P_ ((struct frame *, int, int, int, int));
462
static int expose_window_tree P_ ((struct window *, XRectangle *));
463
static int expose_window P_ ((struct window *, XRectangle *));
464 465
static void expose_area P_ ((struct window *, struct glyph_row *,
			     XRectangle *, enum glyph_row_area));
466
static int expose_line P_ ((struct window *, struct glyph_row *,
467 468 469 470 471
			     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));
Kim F. Storm's avatar
Kim F. Storm committed
472
static void x_draw_fringe_bitmap P_ ((struct window *, struct glyph_row *, 
473
				      enum fringe_bitmap_type, int left_p));
474 475 476 477

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 *));
Kim F. Storm's avatar
Kim F. Storm committed
478
static void x_draw_row_fringe_bitmaps P_ ((struct window *, struct glyph_row *));
479 480
static void notice_overwritten_cursor P_ ((struct window *, enum glyph_row_area,
					   int, int, int, int));
481
static void x_flush P_ ((struct frame *f));
Gerd Moellmann's avatar
Gerd Moellmann committed
482 483 484 485 486 487
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 *));
Gerd Moellmann's avatar
Gerd Moellmann committed
488 489 490 491 492
static struct scroll_bar *x_window_to_scroll_bar P_ ((Window));
static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
					    enum scroll_bar_part *,
					    Lisp_Object *, Lisp_Object *,
					    unsigned long *));
493 494
static void x_check_fullscreen P_ ((struct frame *));
static void x_check_fullscreen_move P_ ((struct frame *));
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513

/* 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
514

515 516 517 518 519 520 521 522
/* 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 
523

524

525 526 527 528
/***********************************************************************
			      Debugging
 ***********************************************************************/

529
#if 0
530 531 532

/* This is a function useful for recording debugging information about
   the sequence of occurrences in this file.  */
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556

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 */
557 558


559

560 561 562 563 564 565 566 567 568 569 570
/* 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;
571

572 573
  return 0;
}
574

575 576 577 578 579 580 581 582 583 584 585


/***********************************************************************
		    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
586

Andreas Schwab's avatar
Andreas Schwab committed
587
static void
588
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
589
     struct frame *f;
590
{
591 592
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
593 594


595 596 597
/* 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
598

599 600 601 602 603 604 605 606 607
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);
608

609
  BLOCK_INPUT;
610

611
  if (f == display_info->mouse_face_mouse_frame)
612
    {
613
      /* Don't do highlighting for mouse motion during the update.  */
614
      display_info->mouse_face_defer = 1;
615

616 617
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
618
      if (FRAME_GARBAGED_P (f))
619 620
	display_info->mouse_face_window = Qnil;

621 622 623 624 625 626 627
#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.  */
      
628 629 630 631 632 633 634
      /* 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))
635
	{
636
	  int i;
637

638 639
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
640 641
	      break;

642 643
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
644
	}
645
#endif /* 0 */
646
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
647

Jim Blandy's avatar
Jim Blandy committed
648 649 650
  UNBLOCK_INPUT;
}

651 652 653 654

/* 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
655
static void
656 657
x_draw_vertical_border (w)
     struct window *w;
658
{
659 660 661 662 663 664 665 666 667 668
  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
669

670
      window_box_edges (w, -1, &x0, &y0, &x1, &y1);
Kim F. Storm's avatar
Kim F. Storm committed
671
      x1 += FRAME_X_RIGHT_FRINGE_WIDTH (f);
672 673 674 675 676 677 678 679
      y1 -= 1;
      
      XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 
		 f->output_data.x->normal_gc, x1, y0, x1, y1);
    }
}
   
   
680 681 682 683 684 685 686 687 688 689 690 691
/* 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.  */
692 693

static void
694
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
695
     struct window *w;
696
     int cursor_on_p, mouse_face_overwritten_p;
697
{
698 699
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
      
700 701 702
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
703

704 705 706 707
      if (cursor_on_p)
	x_display_and_set_cursor (w, 1, output_cursor.hpos,
				  output_cursor.vpos,
				  output_cursor.x, output_cursor.y);
708
      
709 710 711 712
      x_draw_vertical_border (w);
      UNBLOCK_INPUT;
    }
  
713 714 715 716 717 718 719 720 721
  /* 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;
    }
      
722 723
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
724 725


726 727 728 729 730 731 732 733
/* 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.  */
734
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
735

736
  BLOCK_INPUT;
737
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
738 739
  UNBLOCK_INPUT;
}
740

741 742 743 744

/* 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.  */
745

Andreas Schwab's avatar
Andreas Schwab committed
746
static void
747
XTframe_up_to_date (f)
748
     struct frame *f;
749
{
750
  if (FRAME_X_P (f))
751
    {
752
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
753

754 755 756 757 758 759 760 761 762 763 764
      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;
	}
765
    }
766
}
767 768 769


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
770
   arrow bitmaps, or clear the fringes if no bitmaps are required
771 772 773 774 775 776 777 778 779 780
   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;
781
  struct frame *f;
782
  int width, height;
783 784 785 786 787 788
  
  xassert (w);
  
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
    {
      BLOCK_INPUT;
Kim F. Storm's avatar
Kim F. Storm committed
789
      x_draw_row_fringe_bitmaps (w, desired_row);
790 791 792 793 794 795 796 797 798 799 800 801 802
      UNBLOCK_INPUT;
    }
      
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
     check here if updated_window is the leftmost/rightmost window,
     but I guess it's not worth doing since vertically split windows
     are almost never used, internal border is rarely set, and the
     overhead is very small.  */
  if (windows_or_buffers_changed
      && desired_row->full_width_p
      && (f = XFRAME (w->frame),
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
803 804 805
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
806 807
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
808

809 810 811 812
      /* Internal border is drawn below the tool bar.  */
      if (WINDOWP (f->tool_bar_window)
	  && w == XWINDOW (f->tool_bar_window))
	y -= width;
813
      
814 815 816 817 818 819
      BLOCK_INPUT;
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		    0, y, width, height, False);
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		    f->output_data.x->pixel_width - width,
		    y, width, height, False);
820 821 822 823 824
      UNBLOCK_INPUT;
    }
}


Kim F. Storm's avatar
Kim F. Storm committed
825
/* Draw the bitmap WHICH in one of the left or right fringes of
826 827 828 829 830
   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
831
x_draw_fringe_bitmap (w, row, which, left_p)
832 833
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
834
     enum fringe_bitmap_type which;
835
     int left_p;
836 837 838 839 840
{
  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;
841
  int b1, b2;
842 843 844 845 846 847 848 849 850
  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);

851 852 853
  /* Convert row to frame coordinates.  */
  y = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);

854 855
  switch (which)
    {
856 857 858 859 860
    case NO_FRINGE_BITMAP:
      wd = 0;
      h = 0;
      break;

861 862 863 864 865 866 867
    case LEFT_TRUNCATION_BITMAP:
      wd = left_width;
      h = left_height;
      bits = left_bits;
      break;
      
    case OVERLAY_ARROW_BITMAP:
868 869
      wd = ov_width;
      h = ov_height;
870 871 872 873 874 875 876 877 878 879
      bits = ov_bits;
      break;
      
    case RIGHT_TRUNCATION_BITMAP:
      wd = right_width;
      h = right_height;
      bits = right_bits;
      break;

    case CONTINUED_LINE_BITMAP:
880 881
      wd = continued_width;
      h = continued_height;
882 883 884 885 886 887 888 889 890 891 892
      bits = continued_bits;
      break;
      
    case CONTINUATION_LINE_BITMAP:
      wd = continuation_width;
      h = continuation_height;
      bits = continuation_bits;
      break;

    case ZV_LINE_BITMAP:
      wd = zv_width;
893 894
      h = zv_height - (y % zv_period);
      bits = zv_bits + (y % zv_period);
895 896 897 898 899 900
      break;

    default:
      abort ();
    }

901 902 903 904 905
  /* Clip bitmap if too high.  */
  if (h > row->height)
    h = row->height;

  /* Set dy to the offset in the row to start drawing the bitmap.  */
906 907
  dy = (row->height - h) / 2;

908 909 910 911 912
  face = FACE_FROM_ID (f, FRINGE_FACE_ID);
  PREPARE_FACE_FOR_DISPLAY (f, face);

  /* Clear left fringe if no bitmap to draw or if bitmap doesn't fill
     the fringe.  */
913
  b1 = b2 = -1;
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
  if (left_p)
    {
      if (wd > FRAME_X_LEFT_FRINGE_WIDTH (f))
	wd = FRAME_X_LEFT_FRINGE_WIDTH (f);
      x = (WINDOW_TO_FRAME_PIXEL_X (w, 0)
	   - wd
	   - (FRAME_X_LEFT_FRINGE_WIDTH (f) - wd) / 2);
      if (wd < FRAME_X_LEFT_FRINGE_WIDTH (f) || row->height > h)
	{
	  /* 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);
	  b1 = (window_box_left (w, -1)
		- FRAME_X_LEFT_FRINGE_WIDTH (f)
		+ border);
	  b2 = (FRAME_X_LEFT_FRINGE_WIDTH (f) - border);
	}
    }
  else
    {
      if (wd > FRAME_X_RIGHT_FRINGE_WIDTH (f))
	wd = FRAME_X_RIGHT_FRINGE_WIDTH (f);
      x = (window_box_right (w, -1)
	   + (FRAME_X_RIGHT_FRINGE_WIDTH (f) - wd) / 2);
      /* Clear right fringe if no bitmap to draw of if bitmap doesn't fill
	 the fringe.  */
      if (wd < FRAME_X_RIGHT_FRINGE_WIDTH (f) || row->height > h)
	{
	  b1 = window_box_right (w, -1);
	  b2 = FRAME_X_RIGHT_FRINGE_WIDTH (f);
	}
    }

  if (b1 >= 0)
    {
      int header_line_height = WINDOW_DISPLAY_HEADER_LINE_HEIGHT (w);
      
      /* In case the same realized face is used for fringes 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 (display, face->gc, FillOpaqueStippled);
      else
	XSetForeground (display, face->gc, face->background);
      
      XFillRectangle (display, window, face->gc,
		      b1,
		      WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
						       row->y)),
		      b2,
		      row->visible_height);
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

971 972 973 974 975 976 977 978 979 980 981
  if (which != NO_FRINGE_BITMAP)
    {
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
      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);
    }
  
982 983 984 985
  XSetClipMask (display, gc, None);
}


Kim F. Storm's avatar
Kim F. Storm committed
986
/* Draw fringe bitmaps for glyph row ROW on window W.  Call this
987 988 989
   function with input blocked.  */

static void
Kim F. Storm's avatar
Kim F. Storm committed
990
x_draw_row_fringe_bitmaps (w, row)
991 992 993 994
     struct window *w;
     struct glyph_row *row;
{
  struct frame *f = XFRAME (w->frame);
Kim F. Storm's avatar
Kim F. Storm committed
995
  enum fringe_bitmap_type bitmap;
996 997 998 999 1000 1001 1002 1003

  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;

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  if (FRAME_X_LEFT_FRINGE_WIDTH (f) != 0)
    {
      /* Decide which bitmap to draw in the left fringe.  */
      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;
1015
      else
1016
	bitmap = NO_FRINGE_BITMAP;
1017

1018 1019
      x_draw_fringe_bitmap (w, row, bitmap, 1);
    }
1020

1021
  if (FRAME_X_RIGHT_FRINGE_WIDTH (f) != 0)
1022
    {
1023 1024 1025 1026 1027 1028 1029
      /* Decide which bitmap to draw in the right fringe.  */
      if (row->truncated_on_right_p)
	bitmap = RIGHT_TRUNCATION_BITMAP;
      else if (row->continued_p)
	bitmap = CONTINUED_LINE_BITMAP;
      else if (row->indicate_empty_line_p && FRAME_X_LEFT_FRINGE_WIDTH (f) == 0)
	bitmap = ZV_LINE_BITMAP;
1030
      else
1031
	bitmap = NO_FRINGE_BITMAP;
1032

1033 1034
      x_draw_fringe_bitmap (w, row, bitmap, 0);
    }
1035 1036
}

Jim Blandy's avatar
Jim Blandy committed
1037

1038 1039 1040 1041 1042

/* 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
1043

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

1049 1050
/* 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
1051

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


Jim Blandy's avatar
Jim Blandy committed
1058

1059 1060 1061 1062 1063 1064
/***********************************************************************
			    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
1065

Andreas Schwab's avatar
Andreas Schwab committed
1066
static void
1067 1068
set_output_cursor (cursor)
    struct cursor_pos *cursor;
Jim Blandy's avatar
Jim Blandy committed
1069
{
1070 1071 1072 1073 1074 1075 1076 1077
  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
1078

1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
   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);
1098

1099 1100 1101 1102 1103
  /* 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
1104

1105 1106 1107
  /* 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
1108 1109
    {
      BLOCK_INPUT;
1110
      x_display_cursor (w, 1, hpos, vpos, x, y);
1111
      XFlush (FRAME_X_DISPLAY (SELECTED_FRAME ()));
Jim Blandy's avatar
Jim Blandy committed
1112 1113 1114
      UNBLOCK_INPUT;
    }
}
1115

1116 1117 1118 1119 1120 1121 1122 1123 1124 1125

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

/* Function prototypes of this page.  */

static struct face *x_get_glyph_face_and_encoding P_ ((struct frame *,
						       struct glyph *,
1126 1127
						       XChar2b *,
						       int *));
1128 1129 1130 1131 1132
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 *));
1133
static void x_append_composite_glyph P_ ((struct it *));
1134 1135 1136 1137
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));
1138 1139


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

1143
static INLINE XCharStruct *
1144
x_per_char_metric (font, char2b)
1145 1146 1147 1148 1149
     XFontStruct *font;
     XChar2b *char2b;
{
  /* The result metric information.  */
  XCharStruct *pcm = NULL;
Jim Blandy's avatar
Jim Blandy committed
1150

1151
  xassert (font && char2b);
Jim Blandy's avatar
Jim Blandy committed
1152

1153
  if (font->per_char != NULL)
Jim Blandy's avatar
Jim Blandy committed
1154
    {
1155
      if (font->min_byte1 == 0 && font->max_byte1 == 0)
1156
	{
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
	  /* 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;
1167
	}
1168
      else
Jim Blandy's avatar
Jim Blandy committed
1169
	{
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
	  /* 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
1193
	}
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
    }
  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
1204

1205
  return ((pcm == NULL
1206
	   || (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0))
1207
	  ? NULL : pcm);
1208
}
1209

1210

1211 1212
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */
1213

1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
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 */
1248
	char2b->byte1 = 0, char2b->byte2 = ccl->reg[1];
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261