]> code.delx.au - gnu-emacs/blob - src/xfns.c
(x_create_tip_frame): Initialize frame's colors like
[gnu-emacs] / src / xfns.c
1 /* Functions for the X window system.
2 Copyright (C) 1989, 92, 93, 94, 95, 96, 1997, 1998, 1999
3 Free Software Foundation.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <math.h>
26
27 /* This makes the fields of a Display accessible, in Xlib header files. */
28
29 #define XLIB_ILLEGAL_ACCESS
30
31 #include "lisp.h"
32 #include "xterm.h"
33 #include "frame.h"
34 #include "window.h"
35 #include "buffer.h"
36 #include "intervals.h"
37 #include "dispextern.h"
38 #include "keyboard.h"
39 #include "blockinput.h"
40 #include <epaths.h>
41 #include "charset.h"
42 #include "fontset.h"
43 #include "systime.h"
44 #include "termhooks.h"
45 #include "atimer.h"
46
47 #ifdef HAVE_X_WINDOWS
48
49 #include <ctype.h>
50 #include <sys/types.h>
51 #include <sys/stat.h>
52
53 #ifndef VMS
54 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
55 #include "bitmaps/gray.xbm"
56 #else
57 #include <X11/bitmaps/gray>
58 #endif
59 #else
60 #include "[.bitmaps]gray.xbm"
61 #endif
62
63 #ifdef USE_X_TOOLKIT
64 #include <X11/Shell.h>
65
66 #ifndef USE_MOTIF
67 #include <X11/Xaw/Paned.h>
68 #include <X11/Xaw/Label.h>
69 #endif /* USE_MOTIF */
70
71 #ifdef USG
72 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
73 #include <X11/Xos.h>
74 #define USG
75 #else
76 #include <X11/Xos.h>
77 #endif
78
79 #include "widget.h"
80
81 #include "../lwlib/lwlib.h"
82
83 #ifdef USE_MOTIF
84 #include <Xm/Xm.h>
85 #include <Xm/DialogS.h>
86 #include <Xm/FileSB.h>
87 #endif
88
89 /* Do the EDITRES protocol if running X11R5
90 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
91
92 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
93 #define HACK_EDITRES
94 extern void _XEditResCheckMessages ();
95 #endif /* R5 + Athena */
96
97 /* Unique id counter for widgets created by the Lucid Widget Library. */
98
99 extern LWLIB_ID widget_id_tick;
100
101 #ifdef USE_LUCID
102 /* This is part of a kludge--see lwlib/xlwmenu.c. */
103 extern XFontStruct *xlwmenu_default_font;
104 #endif
105
106 extern void free_frame_menubar ();
107 extern double atof ();
108
109 #endif /* USE_X_TOOLKIT */
110
111 #define min(a,b) ((a) < (b) ? (a) : (b))
112 #define max(a,b) ((a) > (b) ? (a) : (b))
113
114 #ifdef HAVE_X11R4
115 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
116 #else
117 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
118 #endif
119
120 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
121 it, and including `bitmaps/gray' more than once is a problem when
122 config.h defines `static' as an empty replacement string. */
123
124 int gray_bitmap_width = gray_width;
125 int gray_bitmap_height = gray_height;
126 unsigned char *gray_bitmap_bits = gray_bits;
127
128 /* The name we're using in resource queries. Most often "emacs". */
129
130 Lisp_Object Vx_resource_name;
131
132 /* The application class we're using in resource queries.
133 Normally "Emacs". */
134
135 Lisp_Object Vx_resource_class;
136
137 /* Non-zero means we're allowed to display a busy cursor. */
138
139 int display_busy_cursor_p;
140
141 /* The background and shape of the mouse pointer, and shape when not
142 over text or in the modeline. */
143
144 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
145 Lisp_Object Vx_busy_pointer_shape;
146
147 /* The shape when over mouse-sensitive text. */
148
149 Lisp_Object Vx_sensitive_text_pointer_shape;
150
151 /* Color of chars displayed in cursor box. */
152
153 Lisp_Object Vx_cursor_fore_pixel;
154
155 /* Nonzero if using X. */
156
157 static int x_in_use;
158
159 /* Non nil if no window manager is in use. */
160
161 Lisp_Object Vx_no_window_manager;
162
163 /* Search path for bitmap files. */
164
165 Lisp_Object Vx_bitmap_file_path;
166
167 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
168
169 Lisp_Object Vx_pixel_size_width_font_regexp;
170
171 /* Evaluate this expression to rebuild the section of syms_of_xfns
172 that initializes and staticpros the symbols declared below. Note
173 that Emacs 18 has a bug that keeps C-x C-e from being able to
174 evaluate this expression.
175
176 (progn
177 ;; Accumulate a list of the symbols we want to initialize from the
178 ;; declarations at the top of the file.
179 (goto-char (point-min))
180 (search-forward "/\*&&& symbols declared here &&&*\/\n")
181 (let (symbol-list)
182 (while (looking-at "Lisp_Object \\(Q[a-z_]+\\)")
183 (setq symbol-list
184 (cons (buffer-substring (match-beginning 1) (match-end 1))
185 symbol-list))
186 (forward-line 1))
187 (setq symbol-list (nreverse symbol-list))
188 ;; Delete the section of syms_of_... where we initialize the symbols.
189 (search-forward "\n /\*&&& init symbols here &&&*\/\n")
190 (let ((start (point)))
191 (while (looking-at "^ Q")
192 (forward-line 2))
193 (kill-region start (point)))
194 ;; Write a new symbol initialization section.
195 (while symbol-list
196 (insert (format " %s = intern (\"" (car symbol-list)))
197 (let ((start (point)))
198 (insert (substring (car symbol-list) 1))
199 (subst-char-in-region start (point) ?_ ?-))
200 (insert (format "\");\n staticpro (&%s);\n" (car symbol-list)))
201 (setq symbol-list (cdr symbol-list)))))
202
203 */
204
205 /*&&& symbols declared here &&&*/
206 Lisp_Object Qauto_raise;
207 Lisp_Object Qauto_lower;
208 Lisp_Object Qbar;
209 Lisp_Object Qborder_color;
210 Lisp_Object Qborder_width;
211 Lisp_Object Qbox;
212 Lisp_Object Qcursor_color;
213 Lisp_Object Qcursor_type;
214 Lisp_Object Qgeometry;
215 Lisp_Object Qicon_left;
216 Lisp_Object Qicon_top;
217 Lisp_Object Qicon_type;
218 Lisp_Object Qicon_name;
219 Lisp_Object Qinternal_border_width;
220 Lisp_Object Qleft;
221 Lisp_Object Qright;
222 Lisp_Object Qmouse_color;
223 Lisp_Object Qnone;
224 Lisp_Object Qouter_window_id;
225 Lisp_Object Qparent_id;
226 Lisp_Object Qscroll_bar_width;
227 Lisp_Object Qsuppress_icon;
228 extern Lisp_Object Qtop;
229 Lisp_Object Qundefined_color;
230 Lisp_Object Qvertical_scroll_bars;
231 Lisp_Object Qvisibility;
232 Lisp_Object Qwindow_id;
233 Lisp_Object Qx_frame_parameter;
234 Lisp_Object Qx_resource_name;
235 Lisp_Object Quser_position;
236 Lisp_Object Quser_size;
237 extern Lisp_Object Qdisplay;
238 Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
239 Lisp_Object Qscreen_gamma, Qline_spacing, Qcenter;
240
241 /* The below are defined in frame.c. */
242
243 extern Lisp_Object Qheight, Qminibuffer, Qname, Qonly, Qwidth;
244 extern Lisp_Object Qunsplittable, Qmenu_bar_lines, Qbuffer_predicate, Qtitle;
245 extern Lisp_Object Qtool_bar_lines;
246
247 extern Lisp_Object Vwindow_system_version;
248
249 Lisp_Object Qface_set_after_frame_default;
250
251 \f
252 /* Error if we are not connected to X. */
253
254 void
255 check_x ()
256 {
257 if (! x_in_use)
258 error ("X windows are not in use or not initialized");
259 }
260
261 /* Nonzero if we can use mouse menus.
262 You should not call this unless HAVE_MENUS is defined. */
263
264 int
265 have_menus_p ()
266 {
267 return x_in_use;
268 }
269
270 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
271 and checking validity for X. */
272
273 FRAME_PTR
274 check_x_frame (frame)
275 Lisp_Object frame;
276 {
277 FRAME_PTR f;
278
279 if (NILP (frame))
280 frame = selected_frame;
281 CHECK_LIVE_FRAME (frame, 0);
282 f = XFRAME (frame);
283 if (! FRAME_X_P (f))
284 error ("Non-X frame used");
285 return f;
286 }
287
288 /* Let the user specify an X display with a frame.
289 nil stands for the selected frame--or, if that is not an X frame,
290 the first X display on the list. */
291
292 static struct x_display_info *
293 check_x_display_info (frame)
294 Lisp_Object frame;
295 {
296 if (NILP (frame))
297 {
298 struct frame *sf = XFRAME (selected_frame);
299
300 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
301 return FRAME_X_DISPLAY_INFO (sf);
302 else if (x_display_list != 0)
303 return x_display_list;
304 else
305 error ("X windows are not in use or not initialized");
306 }
307 else if (STRINGP (frame))
308 return x_display_info_for_name (frame);
309 else
310 {
311 FRAME_PTR f;
312
313 CHECK_LIVE_FRAME (frame, 0);
314 f = XFRAME (frame);
315 if (! FRAME_X_P (f))
316 error ("Non-X frame used");
317 return FRAME_X_DISPLAY_INFO (f);
318 }
319 }
320
321 \f
322 /* Return the Emacs frame-object corresponding to an X window.
323 It could be the frame's main window or an icon window. */
324
325 /* This function can be called during GC, so use GC_xxx type test macros. */
326
327 struct frame *
328 x_window_to_frame (dpyinfo, wdesc)
329 struct x_display_info *dpyinfo;
330 int wdesc;
331 {
332 Lisp_Object tail, frame;
333 struct frame *f;
334
335 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
336 {
337 frame = XCAR (tail);
338 if (!GC_FRAMEP (frame))
339 continue;
340 f = XFRAME (frame);
341 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
342 continue;
343 if (f->output_data.x->busy_window == wdesc)
344 return f;
345 #ifdef USE_X_TOOLKIT
346 if ((f->output_data.x->edit_widget
347 && XtWindow (f->output_data.x->edit_widget) == wdesc)
348 /* A tooltip frame? */
349 || (!f->output_data.x->edit_widget
350 && FRAME_X_WINDOW (f) == wdesc)
351 || f->output_data.x->icon_desc == wdesc)
352 return f;
353 #else /* not USE_X_TOOLKIT */
354 if (FRAME_X_WINDOW (f) == wdesc
355 || f->output_data.x->icon_desc == wdesc)
356 return f;
357 #endif /* not USE_X_TOOLKIT */
358 }
359 return 0;
360 }
361
362 #ifdef USE_X_TOOLKIT
363 /* Like x_window_to_frame but also compares the window with the widget's
364 windows. */
365
366 struct frame *
367 x_any_window_to_frame (dpyinfo, wdesc)
368 struct x_display_info *dpyinfo;
369 int wdesc;
370 {
371 Lisp_Object tail, frame;
372 struct frame *f, *found;
373 struct x_output *x;
374
375 found = NULL;
376 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
377 {
378 frame = XCAR (tail);
379 if (!GC_FRAMEP (frame))
380 continue;
381
382 f = XFRAME (frame);
383 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
384 {
385 /* This frame matches if the window is any of its widgets. */
386 x = f->output_data.x;
387 if (x->busy_window == wdesc)
388 found = f;
389 else if (x->widget)
390 {
391 if (wdesc == XtWindow (x->widget)
392 || wdesc == XtWindow (x->column_widget)
393 || wdesc == XtWindow (x->edit_widget))
394 found = f;
395 /* Match if the window is this frame's menubar. */
396 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
397 found = f;
398 }
399 else if (FRAME_X_WINDOW (f) == wdesc)
400 /* A tooltip frame. */
401 found = f;
402 }
403 }
404
405 return found;
406 }
407
408 /* Likewise, but exclude the menu bar widget. */
409
410 struct frame *
411 x_non_menubar_window_to_frame (dpyinfo, wdesc)
412 struct x_display_info *dpyinfo;
413 int wdesc;
414 {
415 Lisp_Object tail, frame;
416 struct frame *f;
417 struct x_output *x;
418
419 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
420 {
421 frame = XCAR (tail);
422 if (!GC_FRAMEP (frame))
423 continue;
424 f = XFRAME (frame);
425 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
426 continue;
427 x = f->output_data.x;
428 /* This frame matches if the window is any of its widgets. */
429 if (x->busy_window == wdesc)
430 return f;
431 else if (x->widget)
432 {
433 if (wdesc == XtWindow (x->widget)
434 || wdesc == XtWindow (x->column_widget)
435 || wdesc == XtWindow (x->edit_widget))
436 return f;
437 }
438 else if (FRAME_X_WINDOW (f) == wdesc)
439 /* A tooltip frame. */
440 return f;
441 }
442 return 0;
443 }
444
445 /* Likewise, but consider only the menu bar widget. */
446
447 struct frame *
448 x_menubar_window_to_frame (dpyinfo, wdesc)
449 struct x_display_info *dpyinfo;
450 int wdesc;
451 {
452 Lisp_Object tail, frame;
453 struct frame *f;
454 struct x_output *x;
455
456 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
457 {
458 frame = XCAR (tail);
459 if (!GC_FRAMEP (frame))
460 continue;
461 f = XFRAME (frame);
462 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
463 continue;
464 x = f->output_data.x;
465 /* Match if the window is this frame's menubar. */
466 if (x->menubar_widget
467 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
468 return f;
469 }
470 return 0;
471 }
472
473 /* Return the frame whose principal (outermost) window is WDESC.
474 If WDESC is some other (smaller) window, we return 0. */
475
476 struct frame *
477 x_top_window_to_frame (dpyinfo, wdesc)
478 struct x_display_info *dpyinfo;
479 int wdesc;
480 {
481 Lisp_Object tail, frame;
482 struct frame *f;
483 struct x_output *x;
484
485 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
486 {
487 frame = XCAR (tail);
488 if (!GC_FRAMEP (frame))
489 continue;
490 f = XFRAME (frame);
491 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
492 continue;
493 x = f->output_data.x;
494
495 if (x->widget)
496 {
497 /* This frame matches if the window is its topmost widget. */
498 if (wdesc == XtWindow (x->widget))
499 return f;
500 #if 0 /* I don't know why it did this,
501 but it seems logically wrong,
502 and it causes trouble for MapNotify events. */
503 /* Match if the window is this frame's menubar. */
504 if (x->menubar_widget
505 && wdesc == XtWindow (x->menubar_widget))
506 return f;
507 #endif
508 }
509 else if (FRAME_X_WINDOW (f) == wdesc)
510 /* Tooltip frame. */
511 return f;
512 }
513 return 0;
514 }
515 #endif /* USE_X_TOOLKIT */
516
517 \f
518
519 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
520 id, which is just an int that this section returns. Bitmaps are
521 reference counted so they can be shared among frames.
522
523 Bitmap indices are guaranteed to be > 0, so a negative number can
524 be used to indicate no bitmap.
525
526 If you use x_create_bitmap_from_data, then you must keep track of
527 the bitmaps yourself. That is, creating a bitmap from the same
528 data more than once will not be caught. */
529
530
531 /* Functions to access the contents of a bitmap, given an id. */
532
533 int
534 x_bitmap_height (f, id)
535 FRAME_PTR f;
536 int id;
537 {
538 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
539 }
540
541 int
542 x_bitmap_width (f, id)
543 FRAME_PTR f;
544 int id;
545 {
546 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
547 }
548
549 int
550 x_bitmap_pixmap (f, id)
551 FRAME_PTR f;
552 int id;
553 {
554 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
555 }
556
557
558 /* Allocate a new bitmap record. Returns index of new record. */
559
560 static int
561 x_allocate_bitmap_record (f)
562 FRAME_PTR f;
563 {
564 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
565 int i;
566
567 if (dpyinfo->bitmaps == NULL)
568 {
569 dpyinfo->bitmaps_size = 10;
570 dpyinfo->bitmaps
571 = (struct x_bitmap_record *) xmalloc (dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
572 dpyinfo->bitmaps_last = 1;
573 return 1;
574 }
575
576 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
577 return ++dpyinfo->bitmaps_last;
578
579 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
580 if (dpyinfo->bitmaps[i].refcount == 0)
581 return i + 1;
582
583 dpyinfo->bitmaps_size *= 2;
584 dpyinfo->bitmaps
585 = (struct x_bitmap_record *) xrealloc (dpyinfo->bitmaps,
586 dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
587 return ++dpyinfo->bitmaps_last;
588 }
589
590 /* Add one reference to the reference count of the bitmap with id ID. */
591
592 void
593 x_reference_bitmap (f, id)
594 FRAME_PTR f;
595 int id;
596 {
597 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
598 }
599
600 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
601
602 int
603 x_create_bitmap_from_data (f, bits, width, height)
604 struct frame *f;
605 char *bits;
606 unsigned int width, height;
607 {
608 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
609 Pixmap bitmap;
610 int id;
611
612 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
613 bits, width, height);
614
615 if (! bitmap)
616 return -1;
617
618 id = x_allocate_bitmap_record (f);
619 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
620 dpyinfo->bitmaps[id - 1].file = NULL;
621 dpyinfo->bitmaps[id - 1].refcount = 1;
622 dpyinfo->bitmaps[id - 1].depth = 1;
623 dpyinfo->bitmaps[id - 1].height = height;
624 dpyinfo->bitmaps[id - 1].width = width;
625
626 return id;
627 }
628
629 /* Create bitmap from file FILE for frame F. */
630
631 int
632 x_create_bitmap_from_file (f, file)
633 struct frame *f;
634 Lisp_Object file;
635 {
636 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
637 unsigned int width, height;
638 Pixmap bitmap;
639 int xhot, yhot, result, id;
640 Lisp_Object found;
641 int fd;
642 char *filename;
643
644 /* Look for an existing bitmap with the same name. */
645 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
646 {
647 if (dpyinfo->bitmaps[id].refcount
648 && dpyinfo->bitmaps[id].file
649 && !strcmp (dpyinfo->bitmaps[id].file, (char *) XSTRING (file)->data))
650 {
651 ++dpyinfo->bitmaps[id].refcount;
652 return id + 1;
653 }
654 }
655
656 /* Search bitmap-file-path for the file, if appropriate. */
657 fd = openp (Vx_bitmap_file_path, file, "", &found, 0);
658 if (fd < 0)
659 return -1;
660 /* XReadBitmapFile won't handle magic file names. */
661 if (fd == 0)
662 return -1;
663 emacs_close (fd);
664
665 filename = (char *) XSTRING (found)->data;
666
667 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
668 filename, &width, &height, &bitmap, &xhot, &yhot);
669 if (result != BitmapSuccess)
670 return -1;
671
672 id = x_allocate_bitmap_record (f);
673 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
674 dpyinfo->bitmaps[id - 1].refcount = 1;
675 dpyinfo->bitmaps[id - 1].file
676 = (char *) xmalloc (STRING_BYTES (XSTRING (file)) + 1);
677 dpyinfo->bitmaps[id - 1].depth = 1;
678 dpyinfo->bitmaps[id - 1].height = height;
679 dpyinfo->bitmaps[id - 1].width = width;
680 strcpy (dpyinfo->bitmaps[id - 1].file, XSTRING (file)->data);
681
682 return id;
683 }
684
685 /* Remove reference to bitmap with id number ID. */
686
687 void
688 x_destroy_bitmap (f, id)
689 FRAME_PTR f;
690 int id;
691 {
692 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
693
694 if (id > 0)
695 {
696 --dpyinfo->bitmaps[id - 1].refcount;
697 if (dpyinfo->bitmaps[id - 1].refcount == 0)
698 {
699 BLOCK_INPUT;
700 XFreePixmap (FRAME_X_DISPLAY (f), dpyinfo->bitmaps[id - 1].pixmap);
701 if (dpyinfo->bitmaps[id - 1].file)
702 {
703 xfree (dpyinfo->bitmaps[id - 1].file);
704 dpyinfo->bitmaps[id - 1].file = NULL;
705 }
706 UNBLOCK_INPUT;
707 }
708 }
709 }
710
711 /* Free all the bitmaps for the display specified by DPYINFO. */
712
713 static void
714 x_destroy_all_bitmaps (dpyinfo)
715 struct x_display_info *dpyinfo;
716 {
717 int i;
718 for (i = 0; i < dpyinfo->bitmaps_last; i++)
719 if (dpyinfo->bitmaps[i].refcount > 0)
720 {
721 XFreePixmap (dpyinfo->display, dpyinfo->bitmaps[i].pixmap);
722 if (dpyinfo->bitmaps[i].file)
723 xfree (dpyinfo->bitmaps[i].file);
724 }
725 dpyinfo->bitmaps_last = 0;
726 }
727 \f
728 /* Connect the frame-parameter names for X frames
729 to the ways of passing the parameter values to the window system.
730
731 The name of a parameter, as a Lisp symbol,
732 has an `x-frame-parameter' property which is an integer in Lisp
733 that is an index in this table. */
734
735 struct x_frame_parm_table
736 {
737 char *name;
738 void (*setter) P_ ((struct frame *, Lisp_Object, Lisp_Object));
739 };
740
741 static void x_create_im P_ ((struct frame *));
742 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
743 static void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
744 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
745 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
746 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
747 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
748 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
749 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
750 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
751 void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
752 void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
753 void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
754 Lisp_Object));
755 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
756 void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
757 void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
758 void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
759 Lisp_Object));
760 void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
761 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
762 void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
763 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
764 void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
765 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
766 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
767 Lisp_Object));
768 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
769 Lisp_Object));
770 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
771 Lisp_Object,
772 Lisp_Object,
773 char *, char *,
774 int));
775 static void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
776
777 static struct x_frame_parm_table x_frame_parms[] =
778 {
779 "auto-raise", x_set_autoraise,
780 "auto-lower", x_set_autolower,
781 "background-color", x_set_background_color,
782 "border-color", x_set_border_color,
783 "border-width", x_set_border_width,
784 "cursor-color", x_set_cursor_color,
785 "cursor-type", x_set_cursor_type,
786 "font", x_set_font,
787 "foreground-color", x_set_foreground_color,
788 "icon-name", x_set_icon_name,
789 "icon-type", x_set_icon_type,
790 "internal-border-width", x_set_internal_border_width,
791 "menu-bar-lines", x_set_menu_bar_lines,
792 "mouse-color", x_set_mouse_color,
793 "name", x_explicitly_set_name,
794 "scroll-bar-width", x_set_scroll_bar_width,
795 "title", x_set_title,
796 "unsplittable", x_set_unsplittable,
797 "vertical-scroll-bars", x_set_vertical_scroll_bars,
798 "visibility", x_set_visibility,
799 "tool-bar-lines", x_set_tool_bar_lines,
800 "scroll-bar-foreground", x_set_scroll_bar_foreground,
801 "scroll-bar-background", x_set_scroll_bar_background,
802 "screen-gamma", x_set_screen_gamma,
803 "line-spacing", x_set_line_spacing
804 };
805
806 /* Attach the `x-frame-parameter' properties to
807 the Lisp symbol names of parameters relevant to X. */
808
809 void
810 init_x_parm_symbols ()
811 {
812 int i;
813
814 for (i = 0; i < sizeof (x_frame_parms) / sizeof (x_frame_parms[0]); i++)
815 Fput (intern (x_frame_parms[i].name), Qx_frame_parameter,
816 make_number (i));
817 }
818 \f
819 /* Change the parameters of frame F as specified by ALIST.
820 If a parameter is not specially recognized, do nothing special;
821 otherwise call the `x_set_...' function for that parameter.
822 Except for certain geometry properties, always call store_frame_param
823 to store the new value in the parameter alist. */
824
825 void
826 x_set_frame_parameters (f, alist)
827 FRAME_PTR f;
828 Lisp_Object alist;
829 {
830 Lisp_Object tail;
831
832 /* If both of these parameters are present, it's more efficient to
833 set them both at once. So we wait until we've looked at the
834 entire list before we set them. */
835 int width, height;
836
837 /* Same here. */
838 Lisp_Object left, top;
839
840 /* Same with these. */
841 Lisp_Object icon_left, icon_top;
842
843 /* Record in these vectors all the parms specified. */
844 Lisp_Object *parms;
845 Lisp_Object *values;
846 int i, p;
847 int left_no_change = 0, top_no_change = 0;
848 int icon_left_no_change = 0, icon_top_no_change = 0;
849
850 struct gcpro gcpro1, gcpro2;
851
852 i = 0;
853 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
854 i++;
855
856 parms = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
857 values = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
858
859 /* Extract parm names and values into those vectors. */
860
861 i = 0;
862 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
863 {
864 Lisp_Object elt;
865
866 elt = Fcar (tail);
867 parms[i] = Fcar (elt);
868 values[i] = Fcdr (elt);
869 i++;
870 }
871 /* TAIL and ALIST are not used again below here. */
872 alist = tail = Qnil;
873
874 GCPRO2 (*parms, *values);
875 gcpro1.nvars = i;
876 gcpro2.nvars = i;
877
878 /* There is no need to gcpro LEFT, TOP, ICON_LEFT, or ICON_TOP,
879 because their values appear in VALUES and strings are not valid. */
880 top = left = Qunbound;
881 icon_left = icon_top = Qunbound;
882
883 /* Provide default values for HEIGHT and WIDTH. */
884 if (FRAME_NEW_WIDTH (f))
885 width = FRAME_NEW_WIDTH (f);
886 else
887 width = FRAME_WIDTH (f);
888
889 if (FRAME_NEW_HEIGHT (f))
890 height = FRAME_NEW_HEIGHT (f);
891 else
892 height = FRAME_HEIGHT (f);
893
894 /* Process foreground_color and background_color before anything else.
895 They are independent of other properties, but other properties (e.g.,
896 cursor_color) are dependent upon them. */
897 for (p = 0; p < i; p++)
898 {
899 Lisp_Object prop, val;
900
901 prop = parms[p];
902 val = values[p];
903 if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
904 {
905 register Lisp_Object param_index, old_value;
906
907 param_index = Fget (prop, Qx_frame_parameter);
908 old_value = get_frame_param (f, prop);
909 store_frame_param (f, prop, val);
910 if (NATNUMP (param_index)
911 && (XFASTINT (param_index)
912 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
913 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
914 }
915 }
916
917 /* Now process them in reverse of specified order. */
918 for (i--; i >= 0; i--)
919 {
920 Lisp_Object prop, val;
921
922 prop = parms[i];
923 val = values[i];
924
925 if (EQ (prop, Qwidth) && NUMBERP (val))
926 width = XFASTINT (val);
927 else if (EQ (prop, Qheight) && NUMBERP (val))
928 height = XFASTINT (val);
929 else if (EQ (prop, Qtop))
930 top = val;
931 else if (EQ (prop, Qleft))
932 left = val;
933 else if (EQ (prop, Qicon_top))
934 icon_top = val;
935 else if (EQ (prop, Qicon_left))
936 icon_left = val;
937 else if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
938 /* Processed above. */
939 continue;
940 else
941 {
942 register Lisp_Object param_index, old_value;
943
944 param_index = Fget (prop, Qx_frame_parameter);
945 old_value = get_frame_param (f, prop);
946 store_frame_param (f, prop, val);
947 if (NATNUMP (param_index)
948 && (XFASTINT (param_index)
949 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
950 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
951 }
952 }
953
954 /* Don't die if just one of these was set. */
955 if (EQ (left, Qunbound))
956 {
957 left_no_change = 1;
958 if (f->output_data.x->left_pos < 0)
959 left = Fcons (Qplus, Fcons (make_number (f->output_data.x->left_pos), Qnil));
960 else
961 XSETINT (left, f->output_data.x->left_pos);
962 }
963 if (EQ (top, Qunbound))
964 {
965 top_no_change = 1;
966 if (f->output_data.x->top_pos < 0)
967 top = Fcons (Qplus, Fcons (make_number (f->output_data.x->top_pos), Qnil));
968 else
969 XSETINT (top, f->output_data.x->top_pos);
970 }
971
972 /* If one of the icon positions was not set, preserve or default it. */
973 if (EQ (icon_left, Qunbound) || ! INTEGERP (icon_left))
974 {
975 icon_left_no_change = 1;
976 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
977 if (NILP (icon_left))
978 XSETINT (icon_left, 0);
979 }
980 if (EQ (icon_top, Qunbound) || ! INTEGERP (icon_top))
981 {
982 icon_top_no_change = 1;
983 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
984 if (NILP (icon_top))
985 XSETINT (icon_top, 0);
986 }
987
988 /* Don't set these parameters unless they've been explicitly
989 specified. The window might be mapped or resized while we're in
990 this function, and we don't want to override that unless the lisp
991 code has asked for it.
992
993 Don't set these parameters unless they actually differ from the
994 window's current parameters; the window may not actually exist
995 yet. */
996 {
997 Lisp_Object frame;
998
999 check_frame_size (f, &height, &width);
1000
1001 XSETFRAME (frame, f);
1002
1003 if (width != FRAME_WIDTH (f)
1004 || height != FRAME_HEIGHT (f)
1005 || FRAME_NEW_HEIGHT (f) || FRAME_NEW_WIDTH (f))
1006 Fset_frame_size (frame, make_number (width), make_number (height));
1007
1008 if ((!NILP (left) || !NILP (top))
1009 && ! (left_no_change && top_no_change)
1010 && ! (NUMBERP (left) && XINT (left) == f->output_data.x->left_pos
1011 && NUMBERP (top) && XINT (top) == f->output_data.x->top_pos))
1012 {
1013 int leftpos = 0;
1014 int toppos = 0;
1015
1016 /* Record the signs. */
1017 f->output_data.x->size_hint_flags &= ~ (XNegative | YNegative);
1018 if (EQ (left, Qminus))
1019 f->output_data.x->size_hint_flags |= XNegative;
1020 else if (INTEGERP (left))
1021 {
1022 leftpos = XINT (left);
1023 if (leftpos < 0)
1024 f->output_data.x->size_hint_flags |= XNegative;
1025 }
1026 else if (CONSP (left) && EQ (XCAR (left), Qminus)
1027 && CONSP (XCDR (left))
1028 && INTEGERP (XCAR (XCDR (left))))
1029 {
1030 leftpos = - XINT (XCAR (XCDR (left)));
1031 f->output_data.x->size_hint_flags |= XNegative;
1032 }
1033 else if (CONSP (left) && EQ (XCAR (left), Qplus)
1034 && CONSP (XCDR (left))
1035 && INTEGERP (XCAR (XCDR (left))))
1036 {
1037 leftpos = XINT (XCAR (XCDR (left)));
1038 }
1039
1040 if (EQ (top, Qminus))
1041 f->output_data.x->size_hint_flags |= YNegative;
1042 else if (INTEGERP (top))
1043 {
1044 toppos = XINT (top);
1045 if (toppos < 0)
1046 f->output_data.x->size_hint_flags |= YNegative;
1047 }
1048 else if (CONSP (top) && EQ (XCAR (top), Qminus)
1049 && CONSP (XCDR (top))
1050 && INTEGERP (XCAR (XCDR (top))))
1051 {
1052 toppos = - XINT (XCAR (XCDR (top)));
1053 f->output_data.x->size_hint_flags |= YNegative;
1054 }
1055 else if (CONSP (top) && EQ (XCAR (top), Qplus)
1056 && CONSP (XCDR (top))
1057 && INTEGERP (XCAR (XCDR (top))))
1058 {
1059 toppos = XINT (XCAR (XCDR (top)));
1060 }
1061
1062
1063 /* Store the numeric value of the position. */
1064 f->output_data.x->top_pos = toppos;
1065 f->output_data.x->left_pos = leftpos;
1066
1067 f->output_data.x->win_gravity = NorthWestGravity;
1068
1069 /* Actually set that position, and convert to absolute. */
1070 x_set_offset (f, leftpos, toppos, -1);
1071 }
1072
1073 if ((!NILP (icon_left) || !NILP (icon_top))
1074 && ! (icon_left_no_change && icon_top_no_change))
1075 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
1076 }
1077
1078 UNGCPRO;
1079 }
1080
1081 /* Store the screen positions of frame F into XPTR and YPTR.
1082 These are the positions of the containing window manager window,
1083 not Emacs's own window. */
1084
1085 void
1086 x_real_positions (f, xptr, yptr)
1087 FRAME_PTR f;
1088 int *xptr, *yptr;
1089 {
1090 int win_x, win_y;
1091 Window child;
1092
1093 /* This is pretty gross, but seems to be the easiest way out of
1094 the problem that arises when restarting window-managers. */
1095
1096 #ifdef USE_X_TOOLKIT
1097 Window outer = (f->output_data.x->widget
1098 ? XtWindow (f->output_data.x->widget)
1099 : FRAME_X_WINDOW (f));
1100 #else
1101 Window outer = f->output_data.x->window_desc;
1102 #endif
1103 Window tmp_root_window;
1104 Window *tmp_children;
1105 unsigned int tmp_nchildren;
1106
1107 while (1)
1108 {
1109 int count = x_catch_errors (FRAME_X_DISPLAY (f));
1110 Window outer_window;
1111
1112 XQueryTree (FRAME_X_DISPLAY (f), outer, &tmp_root_window,
1113 &f->output_data.x->parent_desc,
1114 &tmp_children, &tmp_nchildren);
1115 XFree ((char *) tmp_children);
1116
1117 win_x = win_y = 0;
1118
1119 /* Find the position of the outside upper-left corner of
1120 the inner window, with respect to the outer window. */
1121 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
1122 outer_window = f->output_data.x->parent_desc;
1123 else
1124 outer_window = outer;
1125
1126 XTranslateCoordinates (FRAME_X_DISPLAY (f),
1127
1128 /* From-window, to-window. */
1129 outer_window,
1130 FRAME_X_DISPLAY_INFO (f)->root_window,
1131
1132 /* From-position, to-position. */
1133 0, 0, &win_x, &win_y,
1134
1135 /* Child of win. */
1136 &child);
1137
1138 /* It is possible for the window returned by the XQueryNotify
1139 to become invalid by the time we call XTranslateCoordinates.
1140 That can happen when you restart some window managers.
1141 If so, we get an error in XTranslateCoordinates.
1142 Detect that and try the whole thing over. */
1143 if (! x_had_errors_p (FRAME_X_DISPLAY (f)))
1144 {
1145 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1146 break;
1147 }
1148
1149 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1150 }
1151
1152 *xptr = win_x;
1153 *yptr = win_y;
1154 }
1155
1156 /* Insert a description of internally-recorded parameters of frame X
1157 into the parameter alist *ALISTPTR that is to be given to the user.
1158 Only parameters that are specific to the X window system
1159 and whose values are not correctly recorded in the frame's
1160 param_alist need to be considered here. */
1161
1162 void
1163 x_report_frame_params (f, alistptr)
1164 struct frame *f;
1165 Lisp_Object *alistptr;
1166 {
1167 char buf[16];
1168 Lisp_Object tem;
1169
1170 /* Represent negative positions (off the top or left screen edge)
1171 in a way that Fmodify_frame_parameters will understand correctly. */
1172 XSETINT (tem, f->output_data.x->left_pos);
1173 if (f->output_data.x->left_pos >= 0)
1174 store_in_alist (alistptr, Qleft, tem);
1175 else
1176 store_in_alist (alistptr, Qleft, Fcons (Qplus, Fcons (tem, Qnil)));
1177
1178 XSETINT (tem, f->output_data.x->top_pos);
1179 if (f->output_data.x->top_pos >= 0)
1180 store_in_alist (alistptr, Qtop, tem);
1181 else
1182 store_in_alist (alistptr, Qtop, Fcons (Qplus, Fcons (tem, Qnil)));
1183
1184 store_in_alist (alistptr, Qborder_width,
1185 make_number (f->output_data.x->border_width));
1186 store_in_alist (alistptr, Qinternal_border_width,
1187 make_number (f->output_data.x->internal_border_width));
1188 sprintf (buf, "%ld", (long) FRAME_X_WINDOW (f));
1189 store_in_alist (alistptr, Qwindow_id,
1190 build_string (buf));
1191 #ifdef USE_X_TOOLKIT
1192 /* Tooltip frame may not have this widget. */
1193 if (f->output_data.x->widget)
1194 #endif
1195 sprintf (buf, "%ld", (long) FRAME_OUTER_WINDOW (f));
1196 store_in_alist (alistptr, Qouter_window_id,
1197 build_string (buf));
1198 store_in_alist (alistptr, Qicon_name, f->icon_name);
1199 FRAME_SAMPLE_VISIBILITY (f);
1200 store_in_alist (alistptr, Qvisibility,
1201 (FRAME_VISIBLE_P (f) ? Qt
1202 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
1203 store_in_alist (alistptr, Qdisplay,
1204 XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element));
1205
1206 if (f->output_data.x->parent_desc == FRAME_X_DISPLAY_INFO (f)->root_window)
1207 tem = Qnil;
1208 else
1209 XSETFASTINT (tem, f->output_data.x->parent_desc);
1210 store_in_alist (alistptr, Qparent_id, tem);
1211 }
1212 \f
1213
1214
1215 /* Gamma-correct COLOR on frame F. */
1216
1217 void
1218 gamma_correct (f, color)
1219 struct frame *f;
1220 XColor *color;
1221 {
1222 if (f->gamma)
1223 {
1224 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
1225 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
1226 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
1227 }
1228 }
1229
1230
1231 /* Decide if color named COLOR_NAME is valid for use on frame F. If
1232 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
1233 allocate the color. Value is zero if COLOR_NAME is invalid, or
1234 no color could be allocated. */
1235
1236 int
1237 x_defined_color (f, color_name, color, alloc_p)
1238 struct frame *f;
1239 char *color_name;
1240 XColor *color;
1241 int alloc_p;
1242 {
1243 int success_p;
1244 Display *dpy = FRAME_X_DISPLAY (f);
1245 Colormap cmap = FRAME_X_COLORMAP (f);
1246
1247 BLOCK_INPUT;
1248 success_p = XParseColor (dpy, cmap, color_name, color);
1249 if (success_p && alloc_p)
1250 success_p = x_alloc_nearest_color (f, cmap, color);
1251 UNBLOCK_INPUT;
1252
1253 return success_p;
1254 }
1255
1256
1257 /* Return the pixel color value for color COLOR_NAME on frame F. If F
1258 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
1259 Signal an error if color can't be allocated. */
1260
1261 int
1262 x_decode_color (f, color_name, mono_color)
1263 FRAME_PTR f;
1264 Lisp_Object color_name;
1265 int mono_color;
1266 {
1267 XColor cdef;
1268
1269 CHECK_STRING (color_name, 0);
1270
1271 #if 0 /* Don't do this. It's wrong when we're not using the default
1272 colormap, it makes freeing difficult, and it's probably not
1273 an important optimization. */
1274 if (strcmp (XSTRING (color_name)->data, "black") == 0)
1275 return BLACK_PIX_DEFAULT (f);
1276 else if (strcmp (XSTRING (color_name)->data, "white") == 0)
1277 return WHITE_PIX_DEFAULT (f);
1278 #endif
1279
1280 /* Return MONO_COLOR for monochrome frames. */
1281 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
1282 return mono_color;
1283
1284 /* x_defined_color is responsible for coping with failures
1285 by looking for a near-miss. */
1286 if (x_defined_color (f, XSTRING (color_name)->data, &cdef, 1))
1287 return cdef.pixel;
1288
1289 Fsignal (Qerror, Fcons (build_string ("undefined color"),
1290 Fcons (color_name, Qnil)));
1291 }
1292
1293
1294 \f
1295 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
1296 the previous value of that parameter, NEW_VALUE is the new value. */
1297
1298 static void
1299 x_set_line_spacing (f, new_value, old_value)
1300 struct frame *f;
1301 Lisp_Object new_value, old_value;
1302 {
1303 if (NILP (new_value))
1304 f->extra_line_spacing = 0;
1305 else if (NATNUMP (new_value))
1306 f->extra_line_spacing = XFASTINT (new_value);
1307 else
1308 Fsignal (Qerror, Fcons (build_string ("Illegal line-spacing"),
1309 Fcons (new_value, Qnil)));
1310 if (FRAME_VISIBLE_P (f))
1311 redraw_frame (f);
1312 }
1313
1314
1315 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
1316 the previous value of that parameter, NEW_VALUE is the new value. */
1317
1318 static void
1319 x_set_screen_gamma (f, new_value, old_value)
1320 struct frame *f;
1321 Lisp_Object new_value, old_value;
1322 {
1323 if (NILP (new_value))
1324 f->gamma = 0;
1325 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
1326 /* The value 0.4545 is the normal viewing gamma. */
1327 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
1328 else
1329 Fsignal (Qerror, Fcons (build_string ("Illegal screen-gamma"),
1330 Fcons (new_value, Qnil)));
1331
1332 clear_face_cache (0);
1333 }
1334
1335
1336 /* Functions called only from `x_set_frame_param'
1337 to set individual parameters.
1338
1339 If FRAME_X_WINDOW (f) is 0,
1340 the frame is being created and its X-window does not exist yet.
1341 In that case, just record the parameter's new value
1342 in the standard place; do not attempt to change the window. */
1343
1344 void
1345 x_set_foreground_color (f, arg, oldval)
1346 struct frame *f;
1347 Lisp_Object arg, oldval;
1348 {
1349 unsigned long pixel
1350 = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1351
1352 unload_color (f, f->output_data.x->foreground_pixel);
1353 f->output_data.x->foreground_pixel = pixel;
1354
1355 if (FRAME_X_WINDOW (f) != 0)
1356 {
1357 BLOCK_INPUT;
1358 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1359 f->output_data.x->foreground_pixel);
1360 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
1361 f->output_data.x->foreground_pixel);
1362 UNBLOCK_INPUT;
1363 update_face_from_frame_parameter (f, Qforeground_color, arg);
1364 if (FRAME_VISIBLE_P (f))
1365 redraw_frame (f);
1366 }
1367 }
1368
1369 void
1370 x_set_background_color (f, arg, oldval)
1371 struct frame *f;
1372 Lisp_Object arg, oldval;
1373 {
1374 unsigned long pixel
1375 = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1376
1377 unload_color (f, f->output_data.x->background_pixel);
1378 f->output_data.x->background_pixel = pixel;
1379
1380 if (FRAME_X_WINDOW (f) != 0)
1381 {
1382 BLOCK_INPUT;
1383 /* The main frame area. */
1384 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1385 f->output_data.x->background_pixel);
1386 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
1387 f->output_data.x->background_pixel);
1388 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1389 f->output_data.x->background_pixel);
1390 XSetWindowBackground (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1391 f->output_data.x->background_pixel);
1392 {
1393 Lisp_Object bar;
1394 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar);
1395 bar = XSCROLL_BAR (bar)->next)
1396 XSetWindowBackground (FRAME_X_DISPLAY (f),
1397 SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar)),
1398 f->output_data.x->background_pixel);
1399 }
1400 UNBLOCK_INPUT;
1401
1402 update_face_from_frame_parameter (f, Qbackground_color, arg);
1403
1404 if (FRAME_VISIBLE_P (f))
1405 redraw_frame (f);
1406 }
1407 }
1408
1409 void
1410 x_set_mouse_color (f, arg, oldval)
1411 struct frame *f;
1412 Lisp_Object arg, oldval;
1413 {
1414 Cursor cursor, nontext_cursor, mode_cursor, cross_cursor;
1415 Cursor busy_cursor;
1416 int count;
1417 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1418 unsigned long mask_color = f->output_data.x->background_pixel;
1419
1420 /* Don't let pointers be invisible. */
1421 if (mask_color == pixel
1422 && mask_color == f->output_data.x->background_pixel)
1423 pixel = f->output_data.x->foreground_pixel;
1424
1425 unload_color (f, f->output_data.x->mouse_pixel);
1426 f->output_data.x->mouse_pixel = pixel;
1427
1428 BLOCK_INPUT;
1429
1430 /* It's not okay to crash if the user selects a screwy cursor. */
1431 count = x_catch_errors (FRAME_X_DISPLAY (f));
1432
1433 if (!EQ (Qnil, Vx_pointer_shape))
1434 {
1435 CHECK_NUMBER (Vx_pointer_shape, 0);
1436 cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XINT (Vx_pointer_shape));
1437 }
1438 else
1439 cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_xterm);
1440 x_check_errors (FRAME_X_DISPLAY (f), "bad text pointer cursor: %s");
1441
1442 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1443 {
1444 CHECK_NUMBER (Vx_nontext_pointer_shape, 0);
1445 nontext_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1446 XINT (Vx_nontext_pointer_shape));
1447 }
1448 else
1449 nontext_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_left_ptr);
1450 x_check_errors (FRAME_X_DISPLAY (f), "bad nontext pointer cursor: %s");
1451
1452 if (!EQ (Qnil, Vx_busy_pointer_shape))
1453 {
1454 CHECK_NUMBER (Vx_busy_pointer_shape, 0);
1455 busy_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1456 XINT (Vx_busy_pointer_shape));
1457 }
1458 else
1459 busy_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_watch);
1460 x_check_errors (FRAME_X_DISPLAY (f), "bad busy pointer cursor: %s");
1461
1462 x_check_errors (FRAME_X_DISPLAY (f), "bad nontext pointer cursor: %s");
1463 if (!EQ (Qnil, Vx_mode_pointer_shape))
1464 {
1465 CHECK_NUMBER (Vx_mode_pointer_shape, 0);
1466 mode_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1467 XINT (Vx_mode_pointer_shape));
1468 }
1469 else
1470 mode_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_xterm);
1471 x_check_errors (FRAME_X_DISPLAY (f), "bad modeline pointer cursor: %s");
1472
1473 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1474 {
1475 CHECK_NUMBER (Vx_sensitive_text_pointer_shape, 0);
1476 cross_cursor
1477 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1478 XINT (Vx_sensitive_text_pointer_shape));
1479 }
1480 else
1481 cross_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_crosshair);
1482
1483 /* Check and report errors with the above calls. */
1484 x_check_errors (FRAME_X_DISPLAY (f), "can't set cursor shape: %s");
1485 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1486
1487 {
1488 XColor fore_color, back_color;
1489
1490 fore_color.pixel = f->output_data.x->mouse_pixel;
1491 back_color.pixel = mask_color;
1492 XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
1493 &fore_color);
1494 XQueryColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
1495 &back_color);
1496 XRecolorCursor (FRAME_X_DISPLAY (f), cursor,
1497 &fore_color, &back_color);
1498 XRecolorCursor (FRAME_X_DISPLAY (f), nontext_cursor,
1499 &fore_color, &back_color);
1500 XRecolorCursor (FRAME_X_DISPLAY (f), mode_cursor,
1501 &fore_color, &back_color);
1502 XRecolorCursor (FRAME_X_DISPLAY (f), cross_cursor,
1503 &fore_color, &back_color);
1504 XRecolorCursor (FRAME_X_DISPLAY (f), busy_cursor,
1505 &fore_color, &back_color);
1506 }
1507
1508 if (FRAME_X_WINDOW (f) != 0)
1509 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
1510
1511 if (cursor != f->output_data.x->text_cursor && f->output_data.x->text_cursor != 0)
1512 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->text_cursor);
1513 f->output_data.x->text_cursor = cursor;
1514
1515 if (nontext_cursor != f->output_data.x->nontext_cursor
1516 && f->output_data.x->nontext_cursor != 0)
1517 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->nontext_cursor);
1518 f->output_data.x->nontext_cursor = nontext_cursor;
1519
1520 if (busy_cursor != f->output_data.x->busy_cursor
1521 && f->output_data.x->busy_cursor != 0)
1522 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->busy_cursor);
1523 f->output_data.x->busy_cursor = busy_cursor;
1524
1525 if (mode_cursor != f->output_data.x->modeline_cursor
1526 && f->output_data.x->modeline_cursor != 0)
1527 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->modeline_cursor);
1528 f->output_data.x->modeline_cursor = mode_cursor;
1529
1530 if (cross_cursor != f->output_data.x->cross_cursor
1531 && f->output_data.x->cross_cursor != 0)
1532 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->cross_cursor);
1533 f->output_data.x->cross_cursor = cross_cursor;
1534
1535 XFlush (FRAME_X_DISPLAY (f));
1536 UNBLOCK_INPUT;
1537
1538 update_face_from_frame_parameter (f, Qmouse_color, arg);
1539 }
1540
1541 void
1542 x_set_cursor_color (f, arg, oldval)
1543 struct frame *f;
1544 Lisp_Object arg, oldval;
1545 {
1546 unsigned long fore_pixel, pixel;
1547 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1548
1549 if (!NILP (Vx_cursor_fore_pixel))
1550 {
1551 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1552 WHITE_PIX_DEFAULT (f));
1553 fore_pixel_allocated_p = 1;
1554 }
1555 else
1556 fore_pixel = f->output_data.x->background_pixel;
1557
1558 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1559 pixel_allocated_p = 1;
1560
1561 /* Make sure that the cursor color differs from the background color. */
1562 if (pixel == f->output_data.x->background_pixel)
1563 {
1564 if (pixel_allocated_p)
1565 {
1566 x_free_colors (f, &pixel, 1);
1567 pixel_allocated_p = 0;
1568 }
1569
1570 pixel = f->output_data.x->mouse_pixel;
1571 if (pixel == fore_pixel)
1572 {
1573 if (fore_pixel_allocated_p)
1574 {
1575 x_free_colors (f, &fore_pixel, 1);
1576 fore_pixel_allocated_p = 0;
1577 }
1578 fore_pixel = f->output_data.x->background_pixel;
1579 }
1580 }
1581
1582 unload_color (f, f->output_data.x->cursor_foreground_pixel);
1583 if (!fore_pixel_allocated_p)
1584 fore_pixel = x_copy_color (f, fore_pixel);
1585 f->output_data.x->cursor_foreground_pixel = fore_pixel;
1586
1587 unload_color (f, f->output_data.x->cursor_pixel);
1588 if (!pixel_allocated_p)
1589 pixel = x_copy_color (f, pixel);
1590 f->output_data.x->cursor_pixel = pixel;
1591
1592 if (FRAME_X_WINDOW (f) != 0)
1593 {
1594 BLOCK_INPUT;
1595 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1596 f->output_data.x->cursor_pixel);
1597 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1598 fore_pixel);
1599 UNBLOCK_INPUT;
1600
1601 if (FRAME_VISIBLE_P (f))
1602 {
1603 x_update_cursor (f, 0);
1604 x_update_cursor (f, 1);
1605 }
1606 }
1607
1608 update_face_from_frame_parameter (f, Qcursor_color, arg);
1609 }
1610 \f
1611 /* Set the border-color of frame F to value described by ARG.
1612 ARG can be a string naming a color.
1613 The border-color is used for the border that is drawn by the X server.
1614 Note that this does not fully take effect if done before
1615 F has an x-window; it must be redone when the window is created.
1616
1617 Note: this is done in two routines because of the way X10 works.
1618
1619 Note: under X11, this is normally the province of the window manager,
1620 and so emacs' border colors may be overridden. */
1621
1622 void
1623 x_set_border_color (f, arg, oldval)
1624 struct frame *f;
1625 Lisp_Object arg, oldval;
1626 {
1627 int pix;
1628
1629 CHECK_STRING (arg, 0);
1630 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1631 x_set_border_pixel (f, pix);
1632 update_face_from_frame_parameter (f, Qborder_color, arg);
1633 }
1634
1635 /* Set the border-color of frame F to pixel value PIX.
1636 Note that this does not fully take effect if done before
1637 F has an x-window. */
1638
1639 void
1640 x_set_border_pixel (f, pix)
1641 struct frame *f;
1642 int pix;
1643 {
1644 unload_color (f, f->output_data.x->border_pixel);
1645 f->output_data.x->border_pixel = pix;
1646
1647 if (FRAME_X_WINDOW (f) != 0 && f->output_data.x->border_width > 0)
1648 {
1649 BLOCK_INPUT;
1650 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1651 (unsigned long)pix);
1652 UNBLOCK_INPUT;
1653
1654 if (FRAME_VISIBLE_P (f))
1655 redraw_frame (f);
1656 }
1657 }
1658
1659
1660 /* Value is the internal representation of the specified cursor type
1661 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
1662 of the bar cursor. */
1663
1664 enum text_cursor_kinds
1665 x_specified_cursor_type (arg, width)
1666 Lisp_Object arg;
1667 int *width;
1668 {
1669 enum text_cursor_kinds type;
1670
1671 if (EQ (arg, Qbar))
1672 {
1673 type = BAR_CURSOR;
1674 *width = 2;
1675 }
1676 else if (CONSP (arg)
1677 && EQ (XCAR (arg), Qbar)
1678 && INTEGERP (XCDR (arg))
1679 && XINT (XCDR (arg)) >= 0)
1680 {
1681 type = BAR_CURSOR;
1682 *width = XINT (XCDR (arg));
1683 }
1684 else if (NILP (arg))
1685 type = NO_CURSOR;
1686 else
1687 /* Treat anything unknown as "box cursor".
1688 It was bad to signal an error; people have trouble fixing
1689 .Xdefaults with Emacs, when it has something bad in it. */
1690 type = FILLED_BOX_CURSOR;
1691
1692 return type;
1693 }
1694
1695 void
1696 x_set_cursor_type (f, arg, oldval)
1697 FRAME_PTR f;
1698 Lisp_Object arg, oldval;
1699 {
1700 int width;
1701
1702 FRAME_DESIRED_CURSOR (f) = x_specified_cursor_type (arg, &width);
1703 f->output_data.x->cursor_width = width;
1704
1705 /* Make sure the cursor gets redrawn. This is overkill, but how
1706 often do people change cursor types? */
1707 update_mode_lines++;
1708 }
1709 \f
1710 void
1711 x_set_icon_type (f, arg, oldval)
1712 struct frame *f;
1713 Lisp_Object arg, oldval;
1714 {
1715 int result;
1716
1717 if (STRINGP (arg))
1718 {
1719 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1720 return;
1721 }
1722 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1723 return;
1724
1725 BLOCK_INPUT;
1726 if (NILP (arg))
1727 result = x_text_icon (f,
1728 (char *) XSTRING ((!NILP (f->icon_name)
1729 ? f->icon_name
1730 : f->name))->data);
1731 else
1732 result = x_bitmap_icon (f, arg);
1733
1734 if (result)
1735 {
1736 UNBLOCK_INPUT;
1737 error ("No icon window available");
1738 }
1739
1740 XFlush (FRAME_X_DISPLAY (f));
1741 UNBLOCK_INPUT;
1742 }
1743
1744 /* Return non-nil if frame F wants a bitmap icon. */
1745
1746 Lisp_Object
1747 x_icon_type (f)
1748 FRAME_PTR f;
1749 {
1750 Lisp_Object tem;
1751
1752 tem = assq_no_quit (Qicon_type, f->param_alist);
1753 if (CONSP (tem))
1754 return XCDR (tem);
1755 else
1756 return Qnil;
1757 }
1758
1759 void
1760 x_set_icon_name (f, arg, oldval)
1761 struct frame *f;
1762 Lisp_Object arg, oldval;
1763 {
1764 int result;
1765
1766 if (STRINGP (arg))
1767 {
1768 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1769 return;
1770 }
1771 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1772 return;
1773
1774 f->icon_name = arg;
1775
1776 if (f->output_data.x->icon_bitmap != 0)
1777 return;
1778
1779 BLOCK_INPUT;
1780
1781 result = x_text_icon (f,
1782 (char *) XSTRING ((!NILP (f->icon_name)
1783 ? f->icon_name
1784 : !NILP (f->title)
1785 ? f->title
1786 : f->name))->data);
1787
1788 if (result)
1789 {
1790 UNBLOCK_INPUT;
1791 error ("No icon window available");
1792 }
1793
1794 XFlush (FRAME_X_DISPLAY (f));
1795 UNBLOCK_INPUT;
1796 }
1797 \f
1798 void
1799 x_set_font (f, arg, oldval)
1800 struct frame *f;
1801 Lisp_Object arg, oldval;
1802 {
1803 Lisp_Object result;
1804 Lisp_Object fontset_name;
1805 Lisp_Object frame;
1806
1807 CHECK_STRING (arg, 1);
1808
1809 fontset_name = Fquery_fontset (arg, Qnil);
1810
1811 BLOCK_INPUT;
1812 result = (STRINGP (fontset_name)
1813 ? x_new_fontset (f, XSTRING (fontset_name)->data)
1814 : x_new_font (f, XSTRING (arg)->data));
1815 UNBLOCK_INPUT;
1816
1817 if (EQ (result, Qnil))
1818 error ("Font `%s' is not defined", XSTRING (arg)->data);
1819 else if (EQ (result, Qt))
1820 error ("The characters of the given font have varying widths");
1821 else if (STRINGP (result))
1822 {
1823 store_frame_param (f, Qfont, result);
1824 recompute_basic_faces (f);
1825 }
1826 else
1827 abort ();
1828
1829 do_pending_window_change (0);
1830
1831 /* Don't call `face-set-after-frame-default' when faces haven't been
1832 initialized yet. This is the case when called from
1833 Fx_create_frame. In that case, the X widget or window doesn't
1834 exist either, and we can end up in x_report_frame_params with a
1835 null widget which gives a segfault. */
1836 if (FRAME_FACE_CACHE (f))
1837 {
1838 XSETFRAME (frame, f);
1839 call1 (Qface_set_after_frame_default, frame);
1840 }
1841 }
1842
1843 void
1844 x_set_border_width (f, arg, oldval)
1845 struct frame *f;
1846 Lisp_Object arg, oldval;
1847 {
1848 CHECK_NUMBER (arg, 0);
1849
1850 if (XINT (arg) == f->output_data.x->border_width)
1851 return;
1852
1853 if (FRAME_X_WINDOW (f) != 0)
1854 error ("Cannot change the border width of a window");
1855
1856 f->output_data.x->border_width = XINT (arg);
1857 }
1858
1859 void
1860 x_set_internal_border_width (f, arg, oldval)
1861 struct frame *f;
1862 Lisp_Object arg, oldval;
1863 {
1864 int old = f->output_data.x->internal_border_width;
1865
1866 CHECK_NUMBER (arg, 0);
1867 f->output_data.x->internal_border_width = XINT (arg);
1868 if (f->output_data.x->internal_border_width < 0)
1869 f->output_data.x->internal_border_width = 0;
1870
1871 #ifdef USE_X_TOOLKIT
1872 if (f->output_data.x->edit_widget)
1873 widget_store_internal_border (f->output_data.x->edit_widget);
1874 #endif
1875
1876 if (f->output_data.x->internal_border_width == old)
1877 return;
1878
1879 if (FRAME_X_WINDOW (f) != 0)
1880 {
1881 x_set_window_size (f, 0, f->width, f->height);
1882 SET_FRAME_GARBAGED (f);
1883 do_pending_window_change (0);
1884 }
1885 }
1886
1887 void
1888 x_set_visibility (f, value, oldval)
1889 struct frame *f;
1890 Lisp_Object value, oldval;
1891 {
1892 Lisp_Object frame;
1893 XSETFRAME (frame, f);
1894
1895 if (NILP (value))
1896 Fmake_frame_invisible (frame, Qt);
1897 else if (EQ (value, Qicon))
1898 Ficonify_frame (frame);
1899 else
1900 Fmake_frame_visible (frame);
1901 }
1902 \f
1903 static void
1904 x_set_menu_bar_lines_1 (window, n)
1905 Lisp_Object window;
1906 int n;
1907 {
1908 struct window *w = XWINDOW (window);
1909
1910 XSETFASTINT (w->top, XFASTINT (w->top) + n);
1911 XSETFASTINT (w->height, XFASTINT (w->height) - n);
1912
1913 if (INTEGERP (w->orig_top))
1914 XSETFASTINT (w->orig_top, XFASTINT (w->orig_top) + n);
1915 if (INTEGERP (w->orig_height))
1916 XSETFASTINT (w->orig_height, XFASTINT (w->orig_height) - n);
1917
1918 /* Handle just the top child in a vertical split. */
1919 if (!NILP (w->vchild))
1920 x_set_menu_bar_lines_1 (w->vchild, n);
1921
1922 /* Adjust all children in a horizontal split. */
1923 for (window = w->hchild; !NILP (window); window = w->next)
1924 {
1925 w = XWINDOW (window);
1926 x_set_menu_bar_lines_1 (window, n);
1927 }
1928 }
1929
1930 void
1931 x_set_menu_bar_lines (f, value, oldval)
1932 struct frame *f;
1933 Lisp_Object value, oldval;
1934 {
1935 int nlines;
1936 #ifndef USE_X_TOOLKIT
1937 int olines = FRAME_MENU_BAR_LINES (f);
1938 #endif
1939
1940 /* Right now, menu bars don't work properly in minibuf-only frames;
1941 most of the commands try to apply themselves to the minibuffer
1942 frame itself, and get an error because you can't switch buffers
1943 in or split the minibuffer window. */
1944 if (FRAME_MINIBUF_ONLY_P (f))
1945 return;
1946
1947 if (INTEGERP (value))
1948 nlines = XINT (value);
1949 else
1950 nlines = 0;
1951
1952 /* Make sure we redisplay all windows in this frame. */
1953 windows_or_buffers_changed++;
1954
1955 #ifdef USE_X_TOOLKIT
1956 FRAME_MENU_BAR_LINES (f) = 0;
1957 if (nlines)
1958 {
1959 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1960 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1961 /* Make sure next redisplay shows the menu bar. */
1962 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1963 }
1964 else
1965 {
1966 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1967 free_frame_menubar (f);
1968 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1969 if (FRAME_X_P (f))
1970 f->output_data.x->menubar_widget = 0;
1971 }
1972 #else /* not USE_X_TOOLKIT */
1973 FRAME_MENU_BAR_LINES (f) = nlines;
1974 x_set_menu_bar_lines_1 (f->root_window, nlines - olines);
1975 #endif /* not USE_X_TOOLKIT */
1976 adjust_glyphs (f);
1977 }
1978
1979
1980 /* Set the number of lines used for the tool bar of frame F to VALUE.
1981 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1982 is the old number of tool bar lines. This function changes the
1983 height of all windows on frame F to match the new tool bar height.
1984 The frame's height doesn't change. */
1985
1986 void
1987 x_set_tool_bar_lines (f, value, oldval)
1988 struct frame *f;
1989 Lisp_Object value, oldval;
1990 {
1991 int delta, nlines;
1992
1993 /* Use VALUE only if an integer >= 0. */
1994 if (INTEGERP (value) && XINT (value) >= 0)
1995 nlines = XFASTINT (value);
1996 else
1997 nlines = 0;
1998
1999 /* Make sure we redisplay all windows in this frame. */
2000 ++windows_or_buffers_changed;
2001
2002 delta = nlines - FRAME_TOOL_BAR_LINES (f);
2003 FRAME_TOOL_BAR_LINES (f) = nlines;
2004 x_set_menu_bar_lines_1 (FRAME_ROOT_WINDOW (f), delta);
2005 adjust_glyphs (f);
2006 }
2007
2008
2009 /* Set the foreground color for scroll bars on frame F to VALUE.
2010 VALUE should be a string, a color name. If it isn't a string or
2011 isn't a valid color name, do nothing. OLDVAL is the old value of
2012 the frame parameter. */
2013
2014 void
2015 x_set_scroll_bar_foreground (f, value, oldval)
2016 struct frame *f;
2017 Lisp_Object value, oldval;
2018 {
2019 unsigned long pixel;
2020
2021 if (STRINGP (value))
2022 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
2023 else
2024 pixel = -1;
2025
2026 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
2027 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
2028
2029 f->output_data.x->scroll_bar_foreground_pixel = pixel;
2030 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2031 {
2032 /* Remove all scroll bars because they have wrong colors. */
2033 if (condemn_scroll_bars_hook)
2034 (*condemn_scroll_bars_hook) (f);
2035 if (judge_scroll_bars_hook)
2036 (*judge_scroll_bars_hook) (f);
2037
2038 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
2039 redraw_frame (f);
2040 }
2041 }
2042
2043
2044 /* Set the background color for scroll bars on frame F to VALUE VALUE
2045 should be a string, a color name. If it isn't a string or isn't a
2046 valid color name, do nothing. OLDVAL is the old value of the frame
2047 parameter. */
2048
2049 void
2050 x_set_scroll_bar_background (f, value, oldval)
2051 struct frame *f;
2052 Lisp_Object value, oldval;
2053 {
2054 unsigned long pixel;
2055
2056 if (STRINGP (value))
2057 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
2058 else
2059 pixel = -1;
2060
2061 if (f->output_data.x->scroll_bar_background_pixel != -1)
2062 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
2063
2064 f->output_data.x->scroll_bar_background_pixel = pixel;
2065 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2066 {
2067 /* Remove all scroll bars because they have wrong colors. */
2068 if (condemn_scroll_bars_hook)
2069 (*condemn_scroll_bars_hook) (f);
2070 if (judge_scroll_bars_hook)
2071 (*judge_scroll_bars_hook) (f);
2072
2073 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
2074 redraw_frame (f);
2075 }
2076 }
2077
2078 \f
2079 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
2080 x_id_name.
2081
2082 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2083 name; if NAME is a string, set F's name to NAME and set
2084 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2085
2086 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2087 suggesting a new name, which lisp code should override; if
2088 F->explicit_name is set, ignore the new name; otherwise, set it. */
2089
2090 void
2091 x_set_name (f, name, explicit)
2092 struct frame *f;
2093 Lisp_Object name;
2094 int explicit;
2095 {
2096 /* Make sure that requests from lisp code override requests from
2097 Emacs redisplay code. */
2098 if (explicit)
2099 {
2100 /* If we're switching from explicit to implicit, we had better
2101 update the mode lines and thereby update the title. */
2102 if (f->explicit_name && NILP (name))
2103 update_mode_lines = 1;
2104
2105 f->explicit_name = ! NILP (name);
2106 }
2107 else if (f->explicit_name)
2108 return;
2109
2110 /* If NAME is nil, set the name to the x_id_name. */
2111 if (NILP (name))
2112 {
2113 /* Check for no change needed in this very common case
2114 before we do any consing. */
2115 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
2116 XSTRING (f->name)->data))
2117 return;
2118 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
2119 }
2120 else
2121 CHECK_STRING (name, 0);
2122
2123 /* Don't change the name if it's already NAME. */
2124 if (! NILP (Fstring_equal (name, f->name)))
2125 return;
2126
2127 f->name = name;
2128
2129 /* For setting the frame title, the title parameter should override
2130 the name parameter. */
2131 if (! NILP (f->title))
2132 name = f->title;
2133
2134 if (FRAME_X_WINDOW (f))
2135 {
2136 BLOCK_INPUT;
2137 #ifdef HAVE_X11R4
2138 {
2139 XTextProperty text, icon;
2140 Lisp_Object icon_name;
2141
2142 text.value = XSTRING (name)->data;
2143 text.encoding = XA_STRING;
2144 text.format = 8;
2145 text.nitems = STRING_BYTES (XSTRING (name));
2146
2147 icon_name = (!NILP (f->icon_name) ? f->icon_name : name);
2148
2149 icon.value = XSTRING (icon_name)->data;
2150 icon.encoding = XA_STRING;
2151 icon.format = 8;
2152 icon.nitems = STRING_BYTES (XSTRING (icon_name));
2153 #ifdef USE_X_TOOLKIT
2154 XSetWMName (FRAME_X_DISPLAY (f),
2155 XtWindow (f->output_data.x->widget), &text);
2156 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2157 &icon);
2158 #else /* not USE_X_TOOLKIT */
2159 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2160 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2161 #endif /* not USE_X_TOOLKIT */
2162 }
2163 #else /* not HAVE_X11R4 */
2164 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2165 XSTRING (name)->data);
2166 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2167 XSTRING (name)->data);
2168 #endif /* not HAVE_X11R4 */
2169 UNBLOCK_INPUT;
2170 }
2171 }
2172
2173 /* This function should be called when the user's lisp code has
2174 specified a name for the frame; the name will override any set by the
2175 redisplay code. */
2176 void
2177 x_explicitly_set_name (f, arg, oldval)
2178 FRAME_PTR f;
2179 Lisp_Object arg, oldval;
2180 {
2181 x_set_name (f, arg, 1);
2182 }
2183
2184 /* This function should be called by Emacs redisplay code to set the
2185 name; names set this way will never override names set by the user's
2186 lisp code. */
2187 void
2188 x_implicitly_set_name (f, arg, oldval)
2189 FRAME_PTR f;
2190 Lisp_Object arg, oldval;
2191 {
2192 x_set_name (f, arg, 0);
2193 }
2194 \f
2195 /* Change the title of frame F to NAME.
2196 If NAME is nil, use the frame name as the title.
2197
2198 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2199 name; if NAME is a string, set F's name to NAME and set
2200 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2201
2202 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2203 suggesting a new name, which lisp code should override; if
2204 F->explicit_name is set, ignore the new name; otherwise, set it. */
2205
2206 void
2207 x_set_title (f, name, old_name)
2208 struct frame *f;
2209 Lisp_Object name, old_name;
2210 {
2211 /* Don't change the title if it's already NAME. */
2212 if (EQ (name, f->title))
2213 return;
2214
2215 update_mode_lines = 1;
2216
2217 f->title = name;
2218
2219 if (NILP (name))
2220 name = f->name;
2221 else
2222 CHECK_STRING (name, 0);
2223
2224 if (FRAME_X_WINDOW (f))
2225 {
2226 BLOCK_INPUT;
2227 #ifdef HAVE_X11R4
2228 {
2229 XTextProperty text, icon;
2230 Lisp_Object icon_name;
2231
2232 text.value = XSTRING (name)->data;
2233 text.encoding = XA_STRING;
2234 text.format = 8;
2235 text.nitems = STRING_BYTES (XSTRING (name));
2236
2237 icon_name = (!NILP (f->icon_name) ? f->icon_name : name);
2238
2239 icon.value = XSTRING (icon_name)->data;
2240 icon.encoding = XA_STRING;
2241 icon.format = 8;
2242 icon.nitems = STRING_BYTES (XSTRING (icon_name));
2243 #ifdef USE_X_TOOLKIT
2244 XSetWMName (FRAME_X_DISPLAY (f),
2245 XtWindow (f->output_data.x->widget), &text);
2246 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2247 &icon);
2248 #else /* not USE_X_TOOLKIT */
2249 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2250 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2251 #endif /* not USE_X_TOOLKIT */
2252 }
2253 #else /* not HAVE_X11R4 */
2254 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2255 XSTRING (name)->data);
2256 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2257 XSTRING (name)->data);
2258 #endif /* not HAVE_X11R4 */
2259 UNBLOCK_INPUT;
2260 }
2261 }
2262 \f
2263 void
2264 x_set_autoraise (f, arg, oldval)
2265 struct frame *f;
2266 Lisp_Object arg, oldval;
2267 {
2268 f->auto_raise = !EQ (Qnil, arg);
2269 }
2270
2271 void
2272 x_set_autolower (f, arg, oldval)
2273 struct frame *f;
2274 Lisp_Object arg, oldval;
2275 {
2276 f->auto_lower = !EQ (Qnil, arg);
2277 }
2278
2279 void
2280 x_set_unsplittable (f, arg, oldval)
2281 struct frame *f;
2282 Lisp_Object arg, oldval;
2283 {
2284 f->no_split = !NILP (arg);
2285 }
2286
2287 void
2288 x_set_vertical_scroll_bars (f, arg, oldval)
2289 struct frame *f;
2290 Lisp_Object arg, oldval;
2291 {
2292 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
2293 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
2294 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
2295 || (!NILP (arg) && ! FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
2296 {
2297 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
2298 = (NILP (arg)
2299 ? vertical_scroll_bar_none
2300 : EQ (Qright, arg)
2301 ? vertical_scroll_bar_right
2302 : vertical_scroll_bar_left);
2303
2304 /* We set this parameter before creating the X window for the
2305 frame, so we can get the geometry right from the start.
2306 However, if the window hasn't been created yet, we shouldn't
2307 call x_set_window_size. */
2308 if (FRAME_X_WINDOW (f))
2309 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2310 do_pending_window_change (0);
2311 }
2312 }
2313
2314 void
2315 x_set_scroll_bar_width (f, arg, oldval)
2316 struct frame *f;
2317 Lisp_Object arg, oldval;
2318 {
2319 int wid = FONT_WIDTH (f->output_data.x->font);
2320
2321 if (NILP (arg))
2322 {
2323 #ifdef USE_TOOLKIT_SCROLL_BARS
2324 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2325 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2326 FRAME_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
2327 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = width;
2328 #else
2329 /* Make the actual width at least 14 pixels and a multiple of a
2330 character width. */
2331 FRAME_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
2332
2333 /* Use all of that space (aside from required margins) for the
2334 scroll bar. */
2335 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = 0;
2336 #endif
2337
2338 if (FRAME_X_WINDOW (f))
2339 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2340 do_pending_window_change (0);
2341 }
2342 else if (INTEGERP (arg) && XINT (arg) > 0
2343 && XFASTINT (arg) != FRAME_SCROLL_BAR_PIXEL_WIDTH (f))
2344 {
2345 if (XFASTINT (arg) <= 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM)
2346 XSETINT (arg, 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM + 1);
2347
2348 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = XFASTINT (arg);
2349 FRAME_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + wid-1) / wid;
2350 if (FRAME_X_WINDOW (f))
2351 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2352 }
2353
2354 change_frame_size (f, 0, FRAME_WIDTH (f), 0, 0, 0);
2355 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
2356 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
2357 }
2358
2359
2360 \f
2361 /* Subroutines of creating an X frame. */
2362
2363 /* Make sure that Vx_resource_name is set to a reasonable value.
2364 Fix it up, or set it to `emacs' if it is too hopeless. */
2365
2366 static void
2367 validate_x_resource_name ()
2368 {
2369 int len = 0;
2370 /* Number of valid characters in the resource name. */
2371 int good_count = 0;
2372 /* Number of invalid characters in the resource name. */
2373 int bad_count = 0;
2374 Lisp_Object new;
2375 int i;
2376
2377 if (!STRINGP (Vx_resource_class))
2378 Vx_resource_class = build_string (EMACS_CLASS);
2379
2380 if (STRINGP (Vx_resource_name))
2381 {
2382 unsigned char *p = XSTRING (Vx_resource_name)->data;
2383 int i;
2384
2385 len = STRING_BYTES (XSTRING (Vx_resource_name));
2386
2387 /* Only letters, digits, - and _ are valid in resource names.
2388 Count the valid characters and count the invalid ones. */
2389 for (i = 0; i < len; i++)
2390 {
2391 int c = p[i];
2392 if (! ((c >= 'a' && c <= 'z')
2393 || (c >= 'A' && c <= 'Z')
2394 || (c >= '0' && c <= '9')
2395 || c == '-' || c == '_'))
2396 bad_count++;
2397 else
2398 good_count++;
2399 }
2400 }
2401 else
2402 /* Not a string => completely invalid. */
2403 bad_count = 5, good_count = 0;
2404
2405 /* If name is valid already, return. */
2406 if (bad_count == 0)
2407 return;
2408
2409 /* If name is entirely invalid, or nearly so, use `emacs'. */
2410 if (good_count == 0
2411 || (good_count == 1 && bad_count > 0))
2412 {
2413 Vx_resource_name = build_string ("emacs");
2414 return;
2415 }
2416
2417 /* Name is partly valid. Copy it and replace the invalid characters
2418 with underscores. */
2419
2420 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
2421
2422 for (i = 0; i < len; i++)
2423 {
2424 int c = XSTRING (new)->data[i];
2425 if (! ((c >= 'a' && c <= 'z')
2426 || (c >= 'A' && c <= 'Z')
2427 || (c >= '0' && c <= '9')
2428 || c == '-' || c == '_'))
2429 XSTRING (new)->data[i] = '_';
2430 }
2431 }
2432
2433
2434 extern char *x_get_string_resource ();
2435
2436 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
2437 "Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.\n\
2438 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the\n\
2439 class, where INSTANCE is the name under which Emacs was invoked, or\n\
2440 the name specified by the `-name' or `-rn' command-line arguments.\n\
2441 \n\
2442 The optional arguments COMPONENT and SUBCLASS add to the key and the\n\
2443 class, respectively. You must specify both of them or neither.\n\
2444 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'\n\
2445 and the class is `Emacs.CLASS.SUBCLASS'.")
2446 (attribute, class, component, subclass)
2447 Lisp_Object attribute, class, component, subclass;
2448 {
2449 register char *value;
2450 char *name_key;
2451 char *class_key;
2452
2453 check_x ();
2454
2455 CHECK_STRING (attribute, 0);
2456 CHECK_STRING (class, 0);
2457
2458 if (!NILP (component))
2459 CHECK_STRING (component, 1);
2460 if (!NILP (subclass))
2461 CHECK_STRING (subclass, 2);
2462 if (NILP (component) != NILP (subclass))
2463 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2464
2465 validate_x_resource_name ();
2466
2467 /* Allocate space for the components, the dots which separate them,
2468 and the final '\0'. Make them big enough for the worst case. */
2469 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2470 + (STRINGP (component)
2471 ? STRING_BYTES (XSTRING (component)) : 0)
2472 + STRING_BYTES (XSTRING (attribute))
2473 + 3);
2474
2475 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2476 + STRING_BYTES (XSTRING (class))
2477 + (STRINGP (subclass)
2478 ? STRING_BYTES (XSTRING (subclass)) : 0)
2479 + 3);
2480
2481 /* Start with emacs.FRAMENAME for the name (the specific one)
2482 and with `Emacs' for the class key (the general one). */
2483 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2484 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2485
2486 strcat (class_key, ".");
2487 strcat (class_key, XSTRING (class)->data);
2488
2489 if (!NILP (component))
2490 {
2491 strcat (class_key, ".");
2492 strcat (class_key, XSTRING (subclass)->data);
2493
2494 strcat (name_key, ".");
2495 strcat (name_key, XSTRING (component)->data);
2496 }
2497
2498 strcat (name_key, ".");
2499 strcat (name_key, XSTRING (attribute)->data);
2500
2501 value = x_get_string_resource (check_x_display_info (Qnil)->xrdb,
2502 name_key, class_key);
2503
2504 if (value != (char *) 0)
2505 return build_string (value);
2506 else
2507 return Qnil;
2508 }
2509
2510 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
2511
2512 Lisp_Object
2513 display_x_get_resource (dpyinfo, attribute, class, component, subclass)
2514 struct x_display_info *dpyinfo;
2515 Lisp_Object attribute, class, component, subclass;
2516 {
2517 register char *value;
2518 char *name_key;
2519 char *class_key;
2520
2521 CHECK_STRING (attribute, 0);
2522 CHECK_STRING (class, 0);
2523
2524 if (!NILP (component))
2525 CHECK_STRING (component, 1);
2526 if (!NILP (subclass))
2527 CHECK_STRING (subclass, 2);
2528 if (NILP (component) != NILP (subclass))
2529 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2530
2531 validate_x_resource_name ();
2532
2533 /* Allocate space for the components, the dots which separate them,
2534 and the final '\0'. Make them big enough for the worst case. */
2535 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2536 + (STRINGP (component)
2537 ? STRING_BYTES (XSTRING (component)) : 0)
2538 + STRING_BYTES (XSTRING (attribute))
2539 + 3);
2540
2541 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2542 + STRING_BYTES (XSTRING (class))
2543 + (STRINGP (subclass)
2544 ? STRING_BYTES (XSTRING (subclass)) : 0)
2545 + 3);
2546
2547 /* Start with emacs.FRAMENAME for the name (the specific one)
2548 and with `Emacs' for the class key (the general one). */
2549 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2550 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2551
2552 strcat (class_key, ".");
2553 strcat (class_key, XSTRING (class)->data);
2554
2555 if (!NILP (component))
2556 {
2557 strcat (class_key, ".");
2558 strcat (class_key, XSTRING (subclass)->data);
2559
2560 strcat (name_key, ".");
2561 strcat (name_key, XSTRING (component)->data);
2562 }
2563
2564 strcat (name_key, ".");
2565 strcat (name_key, XSTRING (attribute)->data);
2566
2567 value = x_get_string_resource (dpyinfo->xrdb, name_key, class_key);
2568
2569 if (value != (char *) 0)
2570 return build_string (value);
2571 else
2572 return Qnil;
2573 }
2574
2575 /* Used when C code wants a resource value. */
2576
2577 char *
2578 x_get_resource_string (attribute, class)
2579 char *attribute, *class;
2580 {
2581 char *name_key;
2582 char *class_key;
2583 struct frame *sf = SELECTED_FRAME ();
2584
2585 /* Allocate space for the components, the dots which separate them,
2586 and the final '\0'. */
2587 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vinvocation_name))
2588 + strlen (attribute) + 2);
2589 class_key = (char *) alloca ((sizeof (EMACS_CLASS) - 1)
2590 + strlen (class) + 2);
2591
2592 sprintf (name_key, "%s.%s",
2593 XSTRING (Vinvocation_name)->data,
2594 attribute);
2595 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
2596
2597 return x_get_string_resource (FRAME_X_DISPLAY_INFO (sf)->xrdb,
2598 name_key, class_key);
2599 }
2600
2601 /* Types we might convert a resource string into. */
2602 enum resource_types
2603 {
2604 RES_TYPE_NUMBER,
2605 RES_TYPE_FLOAT,
2606 RES_TYPE_BOOLEAN,
2607 RES_TYPE_STRING,
2608 RES_TYPE_SYMBOL
2609 };
2610
2611 /* Return the value of parameter PARAM.
2612
2613 First search ALIST, then Vdefault_frame_alist, then the X defaults
2614 database, using ATTRIBUTE as the attribute name and CLASS as its class.
2615
2616 Convert the resource to the type specified by desired_type.
2617
2618 If no default is specified, return Qunbound. If you call
2619 x_get_arg, make sure you deal with Qunbound in a reasonable way,
2620 and don't let it get stored in any Lisp-visible variables! */
2621
2622 static Lisp_Object
2623 x_get_arg (dpyinfo, alist, param, attribute, class, type)
2624 struct x_display_info *dpyinfo;
2625 Lisp_Object alist, param;
2626 char *attribute;
2627 char *class;
2628 enum resource_types type;
2629 {
2630 register Lisp_Object tem;
2631
2632 tem = Fassq (param, alist);
2633 if (EQ (tem, Qnil))
2634 tem = Fassq (param, Vdefault_frame_alist);
2635 if (EQ (tem, Qnil))
2636 {
2637
2638 if (attribute)
2639 {
2640 tem = display_x_get_resource (dpyinfo,
2641 build_string (attribute),
2642 build_string (class),
2643 Qnil, Qnil);
2644
2645 if (NILP (tem))
2646 return Qunbound;
2647
2648 switch (type)
2649 {
2650 case RES_TYPE_NUMBER:
2651 return make_number (atoi (XSTRING (tem)->data));
2652
2653 case RES_TYPE_FLOAT:
2654 return make_float (atof (XSTRING (tem)->data));
2655
2656 case RES_TYPE_BOOLEAN:
2657 tem = Fdowncase (tem);
2658 if (!strcmp (XSTRING (tem)->data, "on")
2659 || !strcmp (XSTRING (tem)->data, "true"))
2660 return Qt;
2661 else
2662 return Qnil;
2663
2664 case RES_TYPE_STRING:
2665 return tem;
2666
2667 case RES_TYPE_SYMBOL:
2668 /* As a special case, we map the values `true' and `on'
2669 to Qt, and `false' and `off' to Qnil. */
2670 {
2671 Lisp_Object lower;
2672 lower = Fdowncase (tem);
2673 if (!strcmp (XSTRING (lower)->data, "on")
2674 || !strcmp (XSTRING (lower)->data, "true"))
2675 return Qt;
2676 else if (!strcmp (XSTRING (lower)->data, "off")
2677 || !strcmp (XSTRING (lower)->data, "false"))
2678 return Qnil;
2679 else
2680 return Fintern (tem, Qnil);
2681 }
2682
2683 default:
2684 abort ();
2685 }
2686 }
2687 else
2688 return Qunbound;
2689 }
2690 return Fcdr (tem);
2691 }
2692
2693 /* Like x_get_arg, but also record the value in f->param_alist. */
2694
2695 static Lisp_Object
2696 x_get_and_record_arg (f, alist, param, attribute, class, type)
2697 struct frame *f;
2698 Lisp_Object alist, param;
2699 char *attribute;
2700 char *class;
2701 enum resource_types type;
2702 {
2703 Lisp_Object value;
2704
2705 value = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, param,
2706 attribute, class, type);
2707 if (! NILP (value))
2708 store_frame_param (f, param, value);
2709
2710 return value;
2711 }
2712
2713 /* Record in frame F the specified or default value according to ALIST
2714 of the parameter named PROP (a Lisp symbol).
2715 If no value is specified for PROP, look for an X default for XPROP
2716 on the frame named NAME.
2717 If that is not found either, use the value DEFLT. */
2718
2719 static Lisp_Object
2720 x_default_parameter (f, alist, prop, deflt, xprop, xclass, type)
2721 struct frame *f;
2722 Lisp_Object alist;
2723 Lisp_Object prop;
2724 Lisp_Object deflt;
2725 char *xprop;
2726 char *xclass;
2727 enum resource_types type;
2728 {
2729 Lisp_Object tem;
2730
2731 tem = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, prop, xprop, xclass, type);
2732 if (EQ (tem, Qunbound))
2733 tem = deflt;
2734 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2735 return tem;
2736 }
2737
2738
2739 /* Record in frame F the specified or default value according to ALIST
2740 of the parameter named PROP (a Lisp symbol). If no value is
2741 specified for PROP, look for an X default for XPROP on the frame
2742 named NAME. If that is not found either, use the value DEFLT. */
2743
2744 static Lisp_Object
2745 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
2746 foreground_p)
2747 struct frame *f;
2748 Lisp_Object alist;
2749 Lisp_Object prop;
2750 char *xprop;
2751 char *xclass;
2752 int foreground_p;
2753 {
2754 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2755 Lisp_Object tem;
2756
2757 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
2758 if (EQ (tem, Qunbound))
2759 {
2760 #ifdef USE_TOOLKIT_SCROLL_BARS
2761
2762 /* See if an X resource for the scroll bar color has been
2763 specified. */
2764 tem = display_x_get_resource (dpyinfo,
2765 build_string (foreground_p
2766 ? "foreground"
2767 : "background"),
2768 build_string (""),
2769 build_string ("verticalScrollBar"),
2770 build_string (""));
2771 if (!STRINGP (tem))
2772 {
2773 /* If nothing has been specified, scroll bars will use a
2774 toolkit-dependent default. Because these defaults are
2775 difficult to get at without actually creating a scroll
2776 bar, use nil to indicate that no color has been
2777 specified. */
2778 tem = Qnil;
2779 }
2780
2781 #else /* not USE_TOOLKIT_SCROLL_BARS */
2782
2783 tem = Qnil;
2784
2785 #endif /* not USE_TOOLKIT_SCROLL_BARS */
2786 }
2787
2788 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2789 return tem;
2790 }
2791
2792
2793 \f
2794 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
2795 "Parse an X-style geometry string STRING.\n\
2796 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).\n\
2797 The properties returned may include `top', `left', `height', and `width'.\n\
2798 The value of `left' or `top' may be an integer,\n\
2799 or a list (+ N) meaning N pixels relative to top/left corner,\n\
2800 or a list (- N) meaning -N pixels relative to bottom/right corner.")
2801 (string)
2802 Lisp_Object string;
2803 {
2804 int geometry, x, y;
2805 unsigned int width, height;
2806 Lisp_Object result;
2807
2808 CHECK_STRING (string, 0);
2809
2810 geometry = XParseGeometry ((char *) XSTRING (string)->data,
2811 &x, &y, &width, &height);
2812
2813 #if 0
2814 if (!!(geometry & XValue) != !!(geometry & YValue))
2815 error ("Must specify both x and y position, or neither");
2816 #endif
2817
2818 result = Qnil;
2819 if (geometry & XValue)
2820 {
2821 Lisp_Object element;
2822
2823 if (x >= 0 && (geometry & XNegative))
2824 element = Fcons (Qleft, Fcons (Qminus, Fcons (make_number (-x), Qnil)));
2825 else if (x < 0 && ! (geometry & XNegative))
2826 element = Fcons (Qleft, Fcons (Qplus, Fcons (make_number (x), Qnil)));
2827 else
2828 element = Fcons (Qleft, make_number (x));
2829 result = Fcons (element, result);
2830 }
2831
2832 if (geometry & YValue)
2833 {
2834 Lisp_Object element;
2835
2836 if (y >= 0 && (geometry & YNegative))
2837 element = Fcons (Qtop, Fcons (Qminus, Fcons (make_number (-y), Qnil)));
2838 else if (y < 0 && ! (geometry & YNegative))
2839 element = Fcons (Qtop, Fcons (Qplus, Fcons (make_number (y), Qnil)));
2840 else
2841 element = Fcons (Qtop, make_number (y));
2842 result = Fcons (element, result);
2843 }
2844
2845 if (geometry & WidthValue)
2846 result = Fcons (Fcons (Qwidth, make_number (width)), result);
2847 if (geometry & HeightValue)
2848 result = Fcons (Fcons (Qheight, make_number (height)), result);
2849
2850 return result;
2851 }
2852
2853 /* Calculate the desired size and position of this window,
2854 and return the flags saying which aspects were specified.
2855
2856 This function does not make the coordinates positive. */
2857
2858 #define DEFAULT_ROWS 40
2859 #define DEFAULT_COLS 80
2860
2861 static int
2862 x_figure_window_size (f, parms)
2863 struct frame *f;
2864 Lisp_Object parms;
2865 {
2866 register Lisp_Object tem0, tem1, tem2;
2867 long window_prompting = 0;
2868 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2869
2870 /* Default values if we fall through.
2871 Actually, if that happens we should get
2872 window manager prompting. */
2873 SET_FRAME_WIDTH (f, DEFAULT_COLS);
2874 f->height = DEFAULT_ROWS;
2875 /* Window managers expect that if program-specified
2876 positions are not (0,0), they're intentional, not defaults. */
2877 f->output_data.x->top_pos = 0;
2878 f->output_data.x->left_pos = 0;
2879
2880 tem0 = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
2881 tem1 = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
2882 tem2 = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
2883 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
2884 {
2885 if (!EQ (tem0, Qunbound))
2886 {
2887 CHECK_NUMBER (tem0, 0);
2888 f->height = XINT (tem0);
2889 }
2890 if (!EQ (tem1, Qunbound))
2891 {
2892 CHECK_NUMBER (tem1, 0);
2893 SET_FRAME_WIDTH (f, XINT (tem1));
2894 }
2895 if (!NILP (tem2) && !EQ (tem2, Qunbound))
2896 window_prompting |= USSize;
2897 else
2898 window_prompting |= PSize;
2899 }
2900
2901 f->output_data.x->vertical_scroll_bar_extra
2902 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
2903 ? 0
2904 : (FRAME_SCROLL_BAR_COLS (f) * FONT_WIDTH (f->output_data.x->font)));
2905 f->output_data.x->flags_areas_extra
2906 = FRAME_FLAGS_AREA_WIDTH (f);
2907 f->output_data.x->pixel_width = CHAR_TO_PIXEL_WIDTH (f, f->width);
2908 f->output_data.x->pixel_height = CHAR_TO_PIXEL_HEIGHT (f, f->height);
2909
2910 tem0 = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
2911 tem1 = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
2912 tem2 = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
2913 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
2914 {
2915 if (EQ (tem0, Qminus))
2916 {
2917 f->output_data.x->top_pos = 0;
2918 window_prompting |= YNegative;
2919 }
2920 else if (CONSP (tem0) && EQ (XCAR (tem0), Qminus)
2921 && CONSP (XCDR (tem0))
2922 && INTEGERP (XCAR (XCDR (tem0))))
2923 {
2924 f->output_data.x->top_pos = - XINT (XCAR (XCDR (tem0)));
2925 window_prompting |= YNegative;
2926 }
2927 else if (CONSP (tem0) && EQ (XCAR (tem0), Qplus)
2928 && CONSP (XCDR (tem0))
2929 && INTEGERP (XCAR (XCDR (tem0))))
2930 {
2931 f->output_data.x->top_pos = XINT (XCAR (XCDR (tem0)));
2932 }
2933 else if (EQ (tem0, Qunbound))
2934 f->output_data.x->top_pos = 0;
2935 else
2936 {
2937 CHECK_NUMBER (tem0, 0);
2938 f->output_data.x->top_pos = XINT (tem0);
2939 if (f->output_data.x->top_pos < 0)
2940 window_prompting |= YNegative;
2941 }
2942
2943 if (EQ (tem1, Qminus))
2944 {
2945 f->output_data.x->left_pos = 0;
2946 window_prompting |= XNegative;
2947 }
2948 else if (CONSP (tem1) && EQ (XCAR (tem1), Qminus)
2949 && CONSP (XCDR (tem1))
2950 && INTEGERP (XCAR (XCDR (tem1))))
2951 {
2952 f->output_data.x->left_pos = - XINT (XCAR (XCDR (tem1)));
2953 window_prompting |= XNegative;
2954 }
2955 else if (CONSP (tem1) && EQ (XCAR (tem1), Qplus)
2956 && CONSP (XCDR (tem1))
2957 && INTEGERP (XCAR (XCDR (tem1))))
2958 {
2959 f->output_data.x->left_pos = XINT (XCAR (XCDR (tem1)));
2960 }
2961 else if (EQ (tem1, Qunbound))
2962 f->output_data.x->left_pos = 0;
2963 else
2964 {
2965 CHECK_NUMBER (tem1, 0);
2966 f->output_data.x->left_pos = XINT (tem1);
2967 if (f->output_data.x->left_pos < 0)
2968 window_prompting |= XNegative;
2969 }
2970
2971 if (!NILP (tem2) && ! EQ (tem2, Qunbound))
2972 window_prompting |= USPosition;
2973 else
2974 window_prompting |= PPosition;
2975 }
2976
2977 return window_prompting;
2978 }
2979
2980 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
2981
2982 Status
2983 XSetWMProtocols (dpy, w, protocols, count)
2984 Display *dpy;
2985 Window w;
2986 Atom *protocols;
2987 int count;
2988 {
2989 Atom prop;
2990 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
2991 if (prop == None) return False;
2992 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
2993 (unsigned char *) protocols, count);
2994 return True;
2995 }
2996 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
2997 \f
2998 #ifdef USE_X_TOOLKIT
2999
3000 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
3001 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
3002 already be present because of the toolkit (Motif adds some of them,
3003 for example, but Xt doesn't). */
3004
3005 static void
3006 hack_wm_protocols (f, widget)
3007 FRAME_PTR f;
3008 Widget widget;
3009 {
3010 Display *dpy = XtDisplay (widget);
3011 Window w = XtWindow (widget);
3012 int need_delete = 1;
3013 int need_focus = 1;
3014 int need_save = 1;
3015
3016 BLOCK_INPUT;
3017 {
3018 Atom type, *atoms = 0;
3019 int format = 0;
3020 unsigned long nitems = 0;
3021 unsigned long bytes_after;
3022
3023 if ((XGetWindowProperty (dpy, w,
3024 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3025 (long)0, (long)100, False, XA_ATOM,
3026 &type, &format, &nitems, &bytes_after,
3027 (unsigned char **) &atoms)
3028 == Success)
3029 && format == 32 && type == XA_ATOM)
3030 while (nitems > 0)
3031 {
3032 nitems--;
3033 if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
3034 need_delete = 0;
3035 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
3036 need_focus = 0;
3037 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
3038 need_save = 0;
3039 }
3040 if (atoms) XFree ((char *) atoms);
3041 }
3042 {
3043 Atom props [10];
3044 int count = 0;
3045 if (need_delete)
3046 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3047 if (need_focus)
3048 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
3049 if (need_save)
3050 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3051 if (count)
3052 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3053 XA_ATOM, 32, PropModeAppend,
3054 (unsigned char *) props, count);
3055 }
3056 UNBLOCK_INPUT;
3057 }
3058 #endif
3059
3060
3061 \f
3062 /* Support routines for XIC (X Input Context). */
3063
3064 #ifdef HAVE_X_I18N
3065
3066 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
3067 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
3068
3069
3070 /* Supported XIM styles, ordered by preferenc. */
3071
3072 static XIMStyle supported_xim_styles[] =
3073 {
3074 XIMPreeditPosition | XIMStatusArea,
3075 XIMPreeditPosition | XIMStatusNothing,
3076 XIMPreeditPosition | XIMStatusNone,
3077 XIMPreeditNothing | XIMStatusArea,
3078 XIMPreeditNothing | XIMStatusNothing,
3079 XIMPreeditNothing | XIMStatusNone,
3080 XIMPreeditNone | XIMStatusArea,
3081 XIMPreeditNone | XIMStatusNothing,
3082 XIMPreeditNone | XIMStatusNone,
3083 0,
3084 };
3085
3086
3087 /* Create an X fontset on frame F with base font name
3088 BASE_FONTNAME.. */
3089
3090 static XFontSet
3091 xic_create_xfontset (f, base_fontname)
3092 struct frame *f;
3093 char *base_fontname;
3094 {
3095 XFontSet xfs;
3096 char **missing_list;
3097 int missing_count;
3098 char *def_string;
3099
3100 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
3101 base_fontname, &missing_list,
3102 &missing_count, &def_string);
3103 if (missing_list)
3104 XFreeStringList (missing_list);
3105
3106 /* No need to free def_string. */
3107 return xfs;
3108 }
3109
3110
3111 /* Value is the best input style, given user preferences USER (already
3112 checked to be supported by Emacs), and styles supported by the
3113 input method XIM. */
3114
3115 static XIMStyle
3116 best_xim_style (user, xim)
3117 XIMStyles *user;
3118 XIMStyles *xim;
3119 {
3120 int i, j;
3121
3122 for (i = 0; i < user->count_styles; ++i)
3123 for (j = 0; j < xim->count_styles; ++j)
3124 if (user->supported_styles[i] == xim->supported_styles[j])
3125 return user->supported_styles[i];
3126
3127 /* Return the default style. */
3128 return XIMPreeditNothing | XIMStatusNothing;
3129 }
3130
3131 /* Create XIC for frame F. */
3132
3133 void
3134 create_frame_xic (f)
3135 struct frame *f;
3136 {
3137 XIM xim;
3138 XIC xic = NULL;
3139 XFontSet xfs = NULL;
3140 static XIMStyle xic_style;
3141
3142 if (FRAME_XIC (f))
3143 return;
3144
3145 xim = FRAME_X_XIM (f);
3146 if (xim)
3147 {
3148 XRectangle s_area;
3149 XPoint spot;
3150 XVaNestedList preedit_attr;
3151 XVaNestedList status_attr;
3152 char *base_fontname;
3153 int fontset;
3154
3155 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
3156 spot.x = 0; spot.y = 1;
3157 /* Create X fontset. */
3158 fontset = FRAME_FONTSET (f);
3159 if (fontset < 0)
3160 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3161 else
3162 {
3163 /* Determine the base fontname from the ASCII font name of
3164 FONTSET. */
3165 char *ascii_font = (char *) XSTRING (fontset_ascii (fontset))->data;
3166 char *p = ascii_font;
3167 int i;
3168
3169 for (i = 0; *p; p++)
3170 if (*p == '-') i++;
3171 if (i != 14)
3172 /* As the font name doesn't conform to XLFD, we can't
3173 modify it to get a suitable base fontname for the
3174 frame. */
3175 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3176 else
3177 {
3178 int len = strlen (ascii_font) + 1;
3179 char *p1;
3180
3181 for (i = 0, p = ascii_font; i < 8; p++)
3182 {
3183 if (*p == '-')
3184 {
3185 i++;
3186 if (i == 3)
3187 p1 = p + 1;
3188 }
3189 }
3190 base_fontname = (char *) alloca (len);
3191 bzero (base_fontname, len);
3192 strcpy (base_fontname, "-*-*-");
3193 bcopy (p1, base_fontname + 5, p - p1);
3194 strcat (base_fontname, "*-*-*-*-*-*-*");
3195 }
3196 }
3197 xfs = xic_create_xfontset (f, base_fontname);
3198
3199 /* Determine XIC style. */
3200 if (xic_style == 0)
3201 {
3202 XIMStyles supported_list;
3203 supported_list.count_styles = (sizeof supported_xim_styles
3204 / sizeof supported_xim_styles[0]);
3205 supported_list.supported_styles = supported_xim_styles;
3206 xic_style = best_xim_style (&supported_list,
3207 FRAME_X_XIM_STYLES (f));
3208 }
3209
3210 preedit_attr = XVaCreateNestedList (0,
3211 XNFontSet, xfs,
3212 XNForeground,
3213 FRAME_FOREGROUND_PIXEL (f),
3214 XNBackground,
3215 FRAME_BACKGROUND_PIXEL (f),
3216 (xic_style & XIMPreeditPosition
3217 ? XNSpotLocation
3218 : NULL),
3219 &spot,
3220 NULL);
3221 status_attr = XVaCreateNestedList (0,
3222 XNArea,
3223 &s_area,
3224 XNFontSet,
3225 xfs,
3226 XNForeground,
3227 FRAME_FOREGROUND_PIXEL (f),
3228 XNBackground,
3229 FRAME_BACKGROUND_PIXEL (f),
3230 NULL);
3231
3232 xic = XCreateIC (xim,
3233 XNInputStyle, xic_style,
3234 XNClientWindow, FRAME_X_WINDOW(f),
3235 XNFocusWindow, FRAME_X_WINDOW(f),
3236 XNStatusAttributes, status_attr,
3237 XNPreeditAttributes, preedit_attr,
3238 NULL);
3239 XFree (preedit_attr);
3240 XFree (status_attr);
3241 }
3242
3243 FRAME_XIC (f) = xic;
3244 FRAME_XIC_STYLE (f) = xic_style;
3245 FRAME_XIC_FONTSET (f) = xfs;
3246 }
3247
3248
3249 /* Destroy XIC and free XIC fontset of frame F, if any. */
3250
3251 void
3252 free_frame_xic (f)
3253 struct frame *f;
3254 {
3255 if (FRAME_XIC (f) == NULL)
3256 return;
3257
3258 XDestroyIC (FRAME_XIC (f));
3259 if (FRAME_XIC_FONTSET (f))
3260 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3261
3262 FRAME_XIC (f) = NULL;
3263 FRAME_XIC_FONTSET (f) = NULL;
3264 }
3265
3266
3267 /* Place preedit area for XIC of window W's frame to specified
3268 pixel position X/Y. X and Y are relative to window W. */
3269
3270 void
3271 xic_set_preeditarea (w, x, y)
3272 struct window *w;
3273 int x, y;
3274 {
3275 struct frame *f = XFRAME (w->frame);
3276 XVaNestedList attr;
3277 XPoint spot;
3278
3279 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x);
3280 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
3281 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
3282 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3283 XFree (attr);
3284 }
3285
3286
3287 /* Place status area for XIC in bottom right corner of frame F.. */
3288
3289 void
3290 xic_set_statusarea (f)
3291 struct frame *f;
3292 {
3293 XIC xic = FRAME_XIC (f);
3294 XVaNestedList attr;
3295 XRectangle area;
3296 XRectangle *needed;
3297
3298 /* Negotiate geometry of status area. If input method has existing
3299 status area, use its current size. */
3300 area.x = area.y = area.width = area.height = 0;
3301 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
3302 XSetICValues (xic, XNStatusAttributes, attr, NULL);
3303 XFree (attr);
3304
3305 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
3306 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3307 XFree (attr);
3308
3309 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
3310 {
3311 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
3312 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3313 XFree (attr);
3314 }
3315
3316 area.width = needed->width;
3317 area.height = needed->height;
3318 area.x = PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
3319 area.y = (PIXEL_HEIGHT (f) - area.height
3320 - FRAME_MENUBAR_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f));
3321 XFree (needed);
3322
3323 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
3324 XSetICValues(xic, XNStatusAttributes, attr, NULL);
3325 XFree (attr);
3326 }
3327
3328
3329 /* Set X fontset for XIC of frame F, using base font name
3330 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
3331
3332 void
3333 xic_set_xfontset (f, base_fontname)
3334 struct frame *f;
3335 char *base_fontname;
3336 {
3337 XVaNestedList attr;
3338 XFontSet xfs;
3339
3340 xfs = xic_create_xfontset (f, base_fontname);
3341
3342 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
3343 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
3344 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3345 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
3346 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
3347 XFree (attr);
3348
3349 if (FRAME_XIC_FONTSET (f))
3350 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3351 FRAME_XIC_FONTSET (f) = xfs;
3352 }
3353
3354 #endif /* HAVE_X_I18N */
3355
3356
3357 \f
3358 #ifdef USE_X_TOOLKIT
3359
3360 /* Create and set up the X widget for frame F. */
3361
3362 static void
3363 x_window (f, window_prompting, minibuffer_only)
3364 struct frame *f;
3365 long window_prompting;
3366 int minibuffer_only;
3367 {
3368 XClassHint class_hints;
3369 XSetWindowAttributes attributes;
3370 unsigned long attribute_mask;
3371 Widget shell_widget;
3372 Widget pane_widget;
3373 Widget frame_widget;
3374 Arg al [25];
3375 int ac;
3376
3377 BLOCK_INPUT;
3378
3379 /* Use the resource name as the top-level widget name
3380 for looking up resources. Make a non-Lisp copy
3381 for the window manager, so GC relocation won't bother it.
3382
3383 Elsewhere we specify the window name for the window manager. */
3384
3385 {
3386 char *str = (char *) XSTRING (Vx_resource_name)->data;
3387 f->namebuf = (char *) xmalloc (strlen (str) + 1);
3388 strcpy (f->namebuf, str);
3389 }
3390
3391 ac = 0;
3392 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
3393 XtSetArg (al[ac], XtNinput, 1); ac++;
3394 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3395 XtSetArg (al[ac], XtNborderWidth, f->output_data.x->border_width); ac++;
3396 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3397 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3398 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3399 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
3400 applicationShellWidgetClass,
3401 FRAME_X_DISPLAY (f), al, ac);
3402
3403 f->output_data.x->widget = shell_widget;
3404 /* maybe_set_screen_title_format (shell_widget); */
3405
3406 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
3407 (widget_value *) NULL,
3408 shell_widget, False,
3409 (lw_callback) NULL,
3410 (lw_callback) NULL,
3411 (lw_callback) NULL,
3412 (lw_callback) NULL);
3413
3414 ac = 0;
3415 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3416 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3417 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3418 XtSetValues (pane_widget, al, ac);
3419 f->output_data.x->column_widget = pane_widget;
3420
3421 /* mappedWhenManaged to false tells to the paned window to not map/unmap
3422 the emacs screen when changing menubar. This reduces flickering. */
3423
3424 ac = 0;
3425 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3426 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
3427 XtSetArg (al[ac], XtNallowResize, 1); ac++;
3428 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
3429 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
3430 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3431 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3432 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3433 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
3434 al, ac);
3435
3436 f->output_data.x->edit_widget = frame_widget;
3437
3438 XtManageChild (frame_widget);
3439
3440 /* Do some needed geometry management. */
3441 {
3442 int len;
3443 char *tem, shell_position[32];
3444 Arg al[2];
3445 int ac = 0;
3446 int extra_borders = 0;
3447 int menubar_size
3448 = (f->output_data.x->menubar_widget
3449 ? (f->output_data.x->menubar_widget->core.height
3450 + f->output_data.x->menubar_widget->core.border_width)
3451 : 0);
3452
3453 #if 0 /* Experimentally, we now get the right results
3454 for -geometry -0-0 without this. 24 Aug 96, rms. */
3455 if (FRAME_EXTERNAL_MENU_BAR (f))
3456 {
3457 Dimension ibw = 0;
3458 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
3459 menubar_size += ibw;
3460 }
3461 #endif
3462
3463 f->output_data.x->menubar_height = menubar_size;
3464
3465 #ifndef USE_LUCID
3466 /* Motif seems to need this amount added to the sizes
3467 specified for the shell widget. The Athena/Lucid widgets don't.
3468 Both conclusions reached experimentally. -- rms. */
3469 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
3470 &extra_borders, NULL);
3471 extra_borders *= 2;
3472 #endif
3473
3474 /* Convert our geometry parameters into a geometry string
3475 and specify it.
3476 Note that we do not specify here whether the position
3477 is a user-specified or program-specified one.
3478 We pass that information later, in x_wm_set_size_hints. */
3479 {
3480 int left = f->output_data.x->left_pos;
3481 int xneg = window_prompting & XNegative;
3482 int top = f->output_data.x->top_pos;
3483 int yneg = window_prompting & YNegative;
3484 if (xneg)
3485 left = -left;
3486 if (yneg)
3487 top = -top;
3488
3489 if (window_prompting & USPosition)
3490 sprintf (shell_position, "=%dx%d%c%d%c%d",
3491 PIXEL_WIDTH (f) + extra_borders,
3492 PIXEL_HEIGHT (f) + menubar_size + extra_borders,
3493 (xneg ? '-' : '+'), left,
3494 (yneg ? '-' : '+'), top);
3495 else
3496 sprintf (shell_position, "=%dx%d",
3497 PIXEL_WIDTH (f) + extra_borders,
3498 PIXEL_HEIGHT (f) + menubar_size + extra_borders);
3499 }
3500
3501 len = strlen (shell_position) + 1;
3502 /* We don't free this because we don't know whether
3503 it is safe to free it while the frame exists.
3504 It isn't worth the trouble of arranging to free it
3505 when the frame is deleted. */
3506 tem = (char *) xmalloc (len);
3507 strncpy (tem, shell_position, len);
3508 XtSetArg (al[ac], XtNgeometry, tem); ac++;
3509 XtSetValues (shell_widget, al, ac);
3510 }
3511
3512 XtManageChild (pane_widget);
3513 XtRealizeWidget (shell_widget);
3514
3515 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
3516
3517 validate_x_resource_name ();
3518
3519 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3520 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3521 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
3522
3523 #ifdef HAVE_X_I18N
3524 FRAME_XIC (f) = NULL;
3525 create_frame_xic (f);
3526 #endif
3527
3528 f->output_data.x->wm_hints.input = True;
3529 f->output_data.x->wm_hints.flags |= InputHint;
3530 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3531 &f->output_data.x->wm_hints);
3532
3533 hack_wm_protocols (f, shell_widget);
3534
3535 #ifdef HACK_EDITRES
3536 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
3537 #endif
3538
3539 /* Do a stupid property change to force the server to generate a
3540 PropertyNotify event so that the event_stream server timestamp will
3541 be initialized to something relevant to the time we created the window.
3542 */
3543 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
3544 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3545 XA_ATOM, 32, PropModeAppend,
3546 (unsigned char*) NULL, 0);
3547
3548 /* Make all the standard events reach the Emacs frame. */
3549 attributes.event_mask = STANDARD_EVENT_SET;
3550
3551 #ifdef HAVE_X_I18N
3552 if (FRAME_XIC (f))
3553 {
3554 /* XIM server might require some X events. */
3555 unsigned long fevent = NoEventMask;
3556 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3557 attributes.event_mask |= fevent;
3558 }
3559 #endif /* HAVE_X_I18N */
3560
3561 attribute_mask = CWEventMask;
3562 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
3563 attribute_mask, &attributes);
3564
3565 XtMapWidget (frame_widget);
3566
3567 /* x_set_name normally ignores requests to set the name if the
3568 requested name is the same as the current name. This is the one
3569 place where that assumption isn't correct; f->name is set, but
3570 the X server hasn't been told. */
3571 {
3572 Lisp_Object name;
3573 int explicit = f->explicit_name;
3574
3575 f->explicit_name = 0;
3576 name = f->name;
3577 f->name = Qnil;
3578 x_set_name (f, name, explicit);
3579 }
3580
3581 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3582 f->output_data.x->text_cursor);
3583
3584 UNBLOCK_INPUT;
3585
3586 /* This is a no-op, except under Motif. Make sure main areas are
3587 set to something reasonable, in case we get an error later. */
3588 lw_set_main_areas (pane_widget, 0, frame_widget);
3589 }
3590
3591 #else /* not USE_X_TOOLKIT */
3592
3593 /* Create and set up the X window for frame F. */
3594
3595 void
3596 x_window (f)
3597 struct frame *f;
3598
3599 {
3600 XClassHint class_hints;
3601 XSetWindowAttributes attributes;
3602 unsigned long attribute_mask;
3603
3604 attributes.background_pixel = f->output_data.x->background_pixel;
3605 attributes.border_pixel = f->output_data.x->border_pixel;
3606 attributes.bit_gravity = StaticGravity;
3607 attributes.backing_store = NotUseful;
3608 attributes.save_under = True;
3609 attributes.event_mask = STANDARD_EVENT_SET;
3610 attributes.colormap = FRAME_X_COLORMAP (f);
3611 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
3612 | CWColormap);
3613
3614 BLOCK_INPUT;
3615 FRAME_X_WINDOW (f)
3616 = XCreateWindow (FRAME_X_DISPLAY (f),
3617 f->output_data.x->parent_desc,
3618 f->output_data.x->left_pos,
3619 f->output_data.x->top_pos,
3620 PIXEL_WIDTH (f), PIXEL_HEIGHT (f),
3621 f->output_data.x->border_width,
3622 CopyFromParent, /* depth */
3623 InputOutput, /* class */
3624 FRAME_X_VISUAL (f),
3625 attribute_mask, &attributes);
3626
3627 #ifdef HAVE_X_I18N
3628 create_frame_xic (f);
3629 if (FRAME_XIC (f))
3630 {
3631 /* XIM server might require some X events. */
3632 unsigned long fevent = NoEventMask;
3633 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3634 attributes.event_mask |= fevent;
3635 attribute_mask = CWEventMask;
3636 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3637 attribute_mask, &attributes);
3638 }
3639 #endif /* HAVE_X_I18N */
3640
3641 validate_x_resource_name ();
3642
3643 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3644 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3645 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
3646
3647 /* The menubar is part of the ordinary display;
3648 it does not count in addition to the height of the window. */
3649 f->output_data.x->menubar_height = 0;
3650
3651 /* This indicates that we use the "Passive Input" input model.
3652 Unless we do this, we don't get the Focus{In,Out} events that we
3653 need to draw the cursor correctly. Accursed bureaucrats.
3654 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
3655
3656 f->output_data.x->wm_hints.input = True;
3657 f->output_data.x->wm_hints.flags |= InputHint;
3658 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3659 &f->output_data.x->wm_hints);
3660 f->output_data.x->wm_hints.icon_pixmap = None;
3661
3662 /* Request "save yourself" and "delete window" commands from wm. */
3663 {
3664 Atom protocols[2];
3665 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3666 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3667 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
3668 }
3669
3670 /* x_set_name normally ignores requests to set the name if the
3671 requested name is the same as the current name. This is the one
3672 place where that assumption isn't correct; f->name is set, but
3673 the X server hasn't been told. */
3674 {
3675 Lisp_Object name;
3676 int explicit = f->explicit_name;
3677
3678 f->explicit_name = 0;
3679 name = f->name;
3680 f->name = Qnil;
3681 x_set_name (f, name, explicit);
3682 }
3683
3684 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3685 f->output_data.x->text_cursor);
3686
3687 UNBLOCK_INPUT;
3688
3689 if (FRAME_X_WINDOW (f) == 0)
3690 error ("Unable to create window");
3691 }
3692
3693 #endif /* not USE_X_TOOLKIT */
3694
3695 /* Handle the icon stuff for this window. Perhaps later we might
3696 want an x_set_icon_position which can be called interactively as
3697 well. */
3698
3699 static void
3700 x_icon (f, parms)
3701 struct frame *f;
3702 Lisp_Object parms;
3703 {
3704 Lisp_Object icon_x, icon_y;
3705 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3706
3707 /* Set the position of the icon. Note that twm groups all
3708 icons in an icon window. */
3709 icon_x = x_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
3710 icon_y = x_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
3711 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
3712 {
3713 CHECK_NUMBER (icon_x, 0);
3714 CHECK_NUMBER (icon_y, 0);
3715 }
3716 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
3717 error ("Both left and top icon corners of icon must be specified");
3718
3719 BLOCK_INPUT;
3720
3721 if (! EQ (icon_x, Qunbound))
3722 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
3723
3724 /* Start up iconic or window? */
3725 x_wm_set_window_state
3726 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
3727 Qicon)
3728 ? IconicState
3729 : NormalState));
3730
3731 x_text_icon (f, (char *) XSTRING ((!NILP (f->icon_name)
3732 ? f->icon_name
3733 : f->name))->data);
3734
3735 UNBLOCK_INPUT;
3736 }
3737
3738 /* Make the GC's needed for this window, setting the
3739 background, border and mouse colors; also create the
3740 mouse cursor and the gray border tile. */
3741
3742 static char cursor_bits[] =
3743 {
3744 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3745 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3746 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3747 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
3748 };
3749
3750 static void
3751 x_make_gc (f)
3752 struct frame *f;
3753 {
3754 XGCValues gc_values;
3755
3756 BLOCK_INPUT;
3757
3758 /* Create the GC's of this frame.
3759 Note that many default values are used. */
3760
3761 /* Normal video */
3762 gc_values.font = f->output_data.x->font->fid;
3763 gc_values.foreground = f->output_data.x->foreground_pixel;
3764 gc_values.background = f->output_data.x->background_pixel;
3765 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
3766 f->output_data.x->normal_gc = XCreateGC (FRAME_X_DISPLAY (f),
3767 FRAME_X_WINDOW (f),
3768 GCLineWidth | GCFont
3769 | GCForeground | GCBackground,
3770 &gc_values);
3771
3772 /* Reverse video style. */
3773 gc_values.foreground = f->output_data.x->background_pixel;
3774 gc_values.background = f->output_data.x->foreground_pixel;
3775 f->output_data.x->reverse_gc = XCreateGC (FRAME_X_DISPLAY (f),
3776 FRAME_X_WINDOW (f),
3777 GCFont | GCForeground | GCBackground
3778 | GCLineWidth,
3779 &gc_values);
3780
3781 /* Cursor has cursor-color background, background-color foreground. */
3782 gc_values.foreground = f->output_data.x->background_pixel;
3783 gc_values.background = f->output_data.x->cursor_pixel;
3784 gc_values.fill_style = FillOpaqueStippled;
3785 gc_values.stipple
3786 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
3787 FRAME_X_DISPLAY_INFO (f)->root_window,
3788 cursor_bits, 16, 16);
3789 f->output_data.x->cursor_gc
3790 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3791 (GCFont | GCForeground | GCBackground
3792 | GCFillStyle /* | GCStipple */ | GCLineWidth),
3793 &gc_values);
3794
3795 /* Reliefs. */
3796 f->output_data.x->white_relief.gc = 0;
3797 f->output_data.x->black_relief.gc = 0;
3798
3799 /* Create the gray border tile used when the pointer is not in
3800 the frame. Since this depends on the frame's pixel values,
3801 this must be done on a per-frame basis. */
3802 f->output_data.x->border_tile
3803 = (XCreatePixmapFromBitmapData
3804 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
3805 gray_bits, gray_width, gray_height,
3806 f->output_data.x->foreground_pixel,
3807 f->output_data.x->background_pixel,
3808 DefaultDepth (FRAME_X_DISPLAY (f),
3809 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))));
3810
3811 UNBLOCK_INPUT;
3812 }
3813
3814 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
3815 1, 1, 0,
3816 "Make a new X window, which is called a \"frame\" in Emacs terms.\n\
3817 Returns an Emacs frame object.\n\
3818 ALIST is an alist of frame parameters.\n\
3819 If the parameters specify that the frame should not have a minibuffer,\n\
3820 and do not specify a specific minibuffer window to use,\n\
3821 then `default-minibuffer-frame' must be a frame whose minibuffer can\n\
3822 be shared by the new frame.\n\
3823 \n\
3824 This function is an internal primitive--use `make-frame' instead.")
3825 (parms)
3826 Lisp_Object parms;
3827 {
3828 struct frame *f;
3829 Lisp_Object frame, tem;
3830 Lisp_Object name;
3831 int minibuffer_only = 0;
3832 long window_prompting = 0;
3833 int width, height;
3834 int count = specpdl_ptr - specpdl;
3835 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3836 Lisp_Object display;
3837 struct x_display_info *dpyinfo = NULL;
3838 Lisp_Object parent;
3839 struct kboard *kb;
3840
3841 check_x ();
3842
3843 /* Use this general default value to start with
3844 until we know if this frame has a specified name. */
3845 Vx_resource_name = Vinvocation_name;
3846
3847 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
3848 if (EQ (display, Qunbound))
3849 display = Qnil;
3850 dpyinfo = check_x_display_info (display);
3851 #ifdef MULTI_KBOARD
3852 kb = dpyinfo->kboard;
3853 #else
3854 kb = &the_only_kboard;
3855 #endif
3856
3857 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
3858 if (!STRINGP (name)
3859 && ! EQ (name, Qunbound)
3860 && ! NILP (name))
3861 error ("Invalid frame name--not a string or nil");
3862
3863 if (STRINGP (name))
3864 Vx_resource_name = name;
3865
3866 /* See if parent window is specified. */
3867 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
3868 if (EQ (parent, Qunbound))
3869 parent = Qnil;
3870 if (! NILP (parent))
3871 CHECK_NUMBER (parent, 0);
3872
3873 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3874 /* No need to protect DISPLAY because that's not used after passing
3875 it to make_frame_without_minibuffer. */
3876 frame = Qnil;
3877 GCPRO4 (parms, parent, name, frame);
3878 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
3879 RES_TYPE_SYMBOL);
3880 if (EQ (tem, Qnone) || NILP (tem))
3881 f = make_frame_without_minibuffer (Qnil, kb, display);
3882 else if (EQ (tem, Qonly))
3883 {
3884 f = make_minibuffer_frame ();
3885 minibuffer_only = 1;
3886 }
3887 else if (WINDOWP (tem))
3888 f = make_frame_without_minibuffer (tem, kb, display);
3889 else
3890 f = make_frame (1);
3891
3892 XSETFRAME (frame, f);
3893
3894 /* Note that X Windows does support scroll bars. */
3895 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
3896
3897 f->output_method = output_x_window;
3898 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
3899 bzero (f->output_data.x, sizeof (struct x_output));
3900 f->output_data.x->icon_bitmap = -1;
3901 f->output_data.x->fontset = -1;
3902 f->output_data.x->scroll_bar_foreground_pixel = -1;
3903 f->output_data.x->scroll_bar_background_pixel = -1;
3904
3905 f->icon_name
3906 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
3907 RES_TYPE_STRING);
3908 if (! STRINGP (f->icon_name))
3909 f->icon_name = Qnil;
3910
3911 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
3912 #ifdef MULTI_KBOARD
3913 FRAME_KBOARD (f) = kb;
3914 #endif
3915
3916 /* These colors will be set anyway later, but it's important
3917 to get the color reference counts right, so initialize them! */
3918 {
3919 Lisp_Object black;
3920 struct gcpro gcpro1;
3921
3922 black = build_string ("black");
3923 GCPRO1 (black);
3924 f->output_data.x->foreground_pixel
3925 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3926 f->output_data.x->background_pixel
3927 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3928 f->output_data.x->cursor_pixel
3929 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3930 f->output_data.x->cursor_foreground_pixel
3931 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3932 f->output_data.x->border_pixel
3933 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3934 f->output_data.x->mouse_pixel
3935 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
3936 UNGCPRO;
3937 }
3938
3939 /* Specify the parent under which to make this X window. */
3940
3941 if (!NILP (parent))
3942 {
3943 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
3944 f->output_data.x->explicit_parent = 1;
3945 }
3946 else
3947 {
3948 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
3949 f->output_data.x->explicit_parent = 0;
3950 }
3951
3952 /* Set the name; the functions to which we pass f expect the name to
3953 be set. */
3954 if (EQ (name, Qunbound) || NILP (name))
3955 {
3956 f->name = build_string (dpyinfo->x_id_name);
3957 f->explicit_name = 0;
3958 }
3959 else
3960 {
3961 f->name = name;
3962 f->explicit_name = 1;
3963 /* use the frame's title when getting resources for this frame. */
3964 specbind (Qx_resource_name, name);
3965 }
3966
3967 /* Extract the window parameters from the supplied values
3968 that are needed to determine window geometry. */
3969 {
3970 Lisp_Object font;
3971
3972 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
3973
3974 BLOCK_INPUT;
3975 /* First, try whatever font the caller has specified. */
3976 if (STRINGP (font))
3977 {
3978 tem = Fquery_fontset (font, Qnil);
3979 if (STRINGP (tem))
3980 font = x_new_fontset (f, XSTRING (tem)->data);
3981 else
3982 font = x_new_font (f, XSTRING (font)->data);
3983 }
3984
3985 /* Try out a font which we hope has bold and italic variations. */
3986 if (!STRINGP (font))
3987 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
3988 if (!STRINGP (font))
3989 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3990 if (! STRINGP (font))
3991 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3992 if (! STRINGP (font))
3993 /* This was formerly the first thing tried, but it finds too many fonts
3994 and takes too long. */
3995 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
3996 /* If those didn't work, look for something which will at least work. */
3997 if (! STRINGP (font))
3998 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
3999 UNBLOCK_INPUT;
4000 if (! STRINGP (font))
4001 font = build_string ("fixed");
4002
4003 x_default_parameter (f, parms, Qfont, font,
4004 "font", "Font", RES_TYPE_STRING);
4005 }
4006
4007 #ifdef USE_LUCID
4008 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
4009 whereby it fails to get any font. */
4010 xlwmenu_default_font = f->output_data.x->font;
4011 #endif
4012
4013 x_default_parameter (f, parms, Qborder_width, make_number (2),
4014 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4015
4016 /* This defaults to 2 in order to match xterm. We recognize either
4017 internalBorderWidth or internalBorder (which is what xterm calls
4018 it). */
4019 if (NILP (Fassq (Qinternal_border_width, parms)))
4020 {
4021 Lisp_Object value;
4022
4023 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4024 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4025 if (! EQ (value, Qunbound))
4026 parms = Fcons (Fcons (Qinternal_border_width, value),
4027 parms);
4028 }
4029 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4030 "internalBorderWidth", "internalBorderWidth",
4031 RES_TYPE_NUMBER);
4032 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
4033 "verticalScrollBars", "ScrollBars",
4034 RES_TYPE_SYMBOL);
4035
4036 /* Also do the stuff which must be set before the window exists. */
4037 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4038 "foreground", "Foreground", RES_TYPE_STRING);
4039 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4040 "background", "Background", RES_TYPE_STRING);
4041 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4042 "pointerColor", "Foreground", RES_TYPE_STRING);
4043 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4044 "cursorColor", "Foreground", RES_TYPE_STRING);
4045 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4046 "borderColor", "BorderColor", RES_TYPE_STRING);
4047 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
4048 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4049 x_default_parameter (f, parms, Qline_spacing, Qnil,
4050 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4051
4052 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
4053 "scrollBarForeground",
4054 "ScrollBarForeground", 1);
4055 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
4056 "scrollBarBackground",
4057 "ScrollBarBackground", 0);
4058
4059 /* Init faces before x_default_parameter is called for scroll-bar
4060 parameters because that function calls x_set_scroll_bar_width,
4061 which calls change_frame_size, which calls Fset_window_buffer,
4062 which runs hooks, which call Fvertical_motion. At the end, we
4063 end up in init_iterator with a null face cache, which should not
4064 happen. */
4065 init_frame_faces (f);
4066
4067 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
4068 "menuBar", "MenuBar", RES_TYPE_NUMBER);
4069 x_default_parameter (f, parms, Qtool_bar_lines, make_number (0),
4070 "toolBar", "ToolBar", RES_TYPE_NUMBER);
4071 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
4072 "bufferPredicate", "BufferPredicate",
4073 RES_TYPE_SYMBOL);
4074 x_default_parameter (f, parms, Qtitle, Qnil,
4075 "title", "Title", RES_TYPE_STRING);
4076
4077 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4078 window_prompting = x_figure_window_size (f, parms);
4079
4080 if (window_prompting & XNegative)
4081 {
4082 if (window_prompting & YNegative)
4083 f->output_data.x->win_gravity = SouthEastGravity;
4084 else
4085 f->output_data.x->win_gravity = NorthEastGravity;
4086 }
4087 else
4088 {
4089 if (window_prompting & YNegative)
4090 f->output_data.x->win_gravity = SouthWestGravity;
4091 else
4092 f->output_data.x->win_gravity = NorthWestGravity;
4093 }
4094
4095 f->output_data.x->size_hint_flags = window_prompting;
4096
4097 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4098 f->no_split = minibuffer_only || EQ (tem, Qt);
4099
4100 /* Create the X widget or window. Add the tool-bar height to the
4101 initial frame height so that the user gets a text display area of
4102 the size he specified with -g or via .Xdefaults. Later changes
4103 of the tool-bar height don't change the frame size. This is done
4104 so that users can create tall Emacs frames without having to
4105 guess how tall the tool-bar will get. */
4106 f->height += FRAME_TOOL_BAR_LINES (f);
4107
4108 #ifdef USE_X_TOOLKIT
4109 x_window (f, window_prompting, minibuffer_only);
4110 #else
4111 x_window (f);
4112 #endif
4113
4114 x_icon (f, parms);
4115 x_make_gc (f);
4116
4117 /* Now consider the frame official. */
4118 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4119 Vframe_list = Fcons (frame, Vframe_list);
4120
4121 /* We need to do this after creating the X window, so that the
4122 icon-creation functions can say whose icon they're describing. */
4123 x_default_parameter (f, parms, Qicon_type, Qnil,
4124 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4125
4126 x_default_parameter (f, parms, Qauto_raise, Qnil,
4127 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4128 x_default_parameter (f, parms, Qauto_lower, Qnil,
4129 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4130 x_default_parameter (f, parms, Qcursor_type, Qbox,
4131 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4132 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
4133 "scrollBarWidth", "ScrollBarWidth",
4134 RES_TYPE_NUMBER);
4135
4136 /* Dimensions, especially f->height, must be done via change_frame_size.
4137 Change will not be effected unless different from the current
4138 f->height. */
4139 width = f->width;
4140 height = f->height;
4141 f->height = 0;
4142 SET_FRAME_WIDTH (f, 0);
4143 change_frame_size (f, height, width, 1, 0, 0);
4144
4145 /* Set up faces after all frame parameters are known. */
4146 call1 (Qface_set_after_frame_default, frame);
4147
4148 #ifdef USE_X_TOOLKIT
4149 /* Create the menu bar. */
4150 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4151 {
4152 /* If this signals an error, we haven't set size hints for the
4153 frame and we didn't make it visible. */
4154 initialize_frame_menubar (f);
4155
4156 /* This is a no-op, except under Motif where it arranges the
4157 main window for the widgets on it. */
4158 lw_set_main_areas (f->output_data.x->column_widget,
4159 f->output_data.x->menubar_widget,
4160 f->output_data.x->edit_widget);
4161 }
4162 #endif /* USE_X_TOOLKIT */
4163
4164 /* Tell the server what size and position, etc, we want, and how
4165 badly we want them. This should be done after we have the menu
4166 bar so that its size can be taken into account. */
4167 BLOCK_INPUT;
4168 x_wm_set_size_hint (f, window_prompting, 0);
4169 UNBLOCK_INPUT;
4170
4171 /* Make the window appear on the frame and enable display, unless
4172 the caller says not to. However, with explicit parent, Emacs
4173 cannot control visibility, so don't try. */
4174 if (! f->output_data.x->explicit_parent)
4175 {
4176 Lisp_Object visibility;
4177
4178 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
4179 RES_TYPE_SYMBOL);
4180 if (EQ (visibility, Qunbound))
4181 visibility = Qt;
4182
4183 if (EQ (visibility, Qicon))
4184 x_iconify_frame (f);
4185 else if (! NILP (visibility))
4186 x_make_frame_visible (f);
4187 else
4188 /* Must have been Qnil. */
4189 ;
4190 }
4191
4192 UNGCPRO;
4193 return unbind_to (count, frame);
4194 }
4195
4196 /* FRAME is used only to get a handle on the X display. We don't pass the
4197 display info directly because we're called from frame.c, which doesn't
4198 know about that structure. */
4199
4200 Lisp_Object
4201 x_get_focus_frame (frame)
4202 struct frame *frame;
4203 {
4204 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
4205 Lisp_Object xfocus;
4206 if (! dpyinfo->x_focus_frame)
4207 return Qnil;
4208
4209 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
4210 return xfocus;
4211 }
4212
4213
4214 /* In certain situations, when the window manager follows a
4215 click-to-focus policy, there seems to be no way around calling
4216 XSetInputFocus to give another frame the input focus .
4217
4218 In an ideal world, XSetInputFocus should generally be avoided so
4219 that applications don't interfere with the window manager's focus
4220 policy. But I think it's okay to use when it's clearly done
4221 following a user-command. */
4222
4223 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4224 "Set the input focus to FRAME.\n\
4225 FRAME nil means use the selected frame.")
4226 (frame)
4227 Lisp_Object frame;
4228 {
4229 struct frame *f = check_x_frame (frame);
4230 Display *dpy = FRAME_X_DISPLAY (f);
4231 int count;
4232
4233 BLOCK_INPUT;
4234 count = x_catch_errors (dpy);
4235 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4236 RevertToParent, CurrentTime);
4237 x_uncatch_errors (dpy, count);
4238 UNBLOCK_INPUT;
4239
4240 return Qnil;
4241 }
4242
4243 \f
4244 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4245 "Internal function called by `color-defined-p', which see.")
4246 (color, frame)
4247 Lisp_Object color, frame;
4248 {
4249 XColor foo;
4250 FRAME_PTR f = check_x_frame (frame);
4251
4252 CHECK_STRING (color, 1);
4253
4254 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4255 return Qt;
4256 else
4257 return Qnil;
4258 }
4259
4260 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4261 "Internal function called by `color-values', which see.")
4262 (color, frame)
4263 Lisp_Object color, frame;
4264 {
4265 XColor foo;
4266 FRAME_PTR f = check_x_frame (frame);
4267
4268 CHECK_STRING (color, 1);
4269
4270 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4271 {
4272 Lisp_Object rgb[3];
4273
4274 rgb[0] = make_number (foo.red);
4275 rgb[1] = make_number (foo.green);
4276 rgb[2] = make_number (foo.blue);
4277 return Flist (3, rgb);
4278 }
4279 else
4280 return Qnil;
4281 }
4282
4283 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4284 "Internal function called by `display-color-p', which see.")
4285 (display)
4286 Lisp_Object display;
4287 {
4288 struct x_display_info *dpyinfo = check_x_display_info (display);
4289
4290 if (dpyinfo->n_planes <= 2)
4291 return Qnil;
4292
4293 switch (dpyinfo->visual->class)
4294 {
4295 case StaticColor:
4296 case PseudoColor:
4297 case TrueColor:
4298 case DirectColor:
4299 return Qt;
4300
4301 default:
4302 return Qnil;
4303 }
4304 }
4305
4306 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
4307 0, 1, 0,
4308 "Return t if the X display supports shades of gray.\n\
4309 Note that color displays do support shades of gray.\n\
4310 The optional argument DISPLAY specifies which display to ask about.\n\
4311 DISPLAY should be either a frame or a display name (a string).\n\
4312 If omitted or nil, that stands for the selected frame's display.")
4313 (display)
4314 Lisp_Object display;
4315 {
4316 struct x_display_info *dpyinfo = check_x_display_info (display);
4317
4318 if (dpyinfo->n_planes <= 1)
4319 return Qnil;
4320
4321 switch (dpyinfo->visual->class)
4322 {
4323 case StaticColor:
4324 case PseudoColor:
4325 case TrueColor:
4326 case DirectColor:
4327 case StaticGray:
4328 case GrayScale:
4329 return Qt;
4330
4331 default:
4332 return Qnil;
4333 }
4334 }
4335
4336 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
4337 0, 1, 0,
4338 "Returns the width in pixels of the X display DISPLAY.\n\
4339 The optional argument DISPLAY specifies which display to ask about.\n\
4340 DISPLAY should be either a frame or a display name (a string).\n\
4341 If omitted or nil, that stands for the selected frame's display.")
4342 (display)
4343 Lisp_Object display;
4344 {
4345 struct x_display_info *dpyinfo = check_x_display_info (display);
4346
4347 return make_number (dpyinfo->width);
4348 }
4349
4350 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4351 Sx_display_pixel_height, 0, 1, 0,
4352 "Returns the height in pixels of the X display DISPLAY.\n\
4353 The optional argument DISPLAY specifies which display to ask about.\n\
4354 DISPLAY should be either a frame or a display name (a string).\n\
4355 If omitted or nil, that stands for the selected frame's display.")
4356 (display)
4357 Lisp_Object display;
4358 {
4359 struct x_display_info *dpyinfo = check_x_display_info (display);
4360
4361 return make_number (dpyinfo->height);
4362 }
4363
4364 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4365 0, 1, 0,
4366 "Returns the number of bitplanes of the X display DISPLAY.\n\
4367 The optional argument DISPLAY specifies which display to ask about.\n\
4368 DISPLAY should be either a frame or a display name (a string).\n\
4369 If omitted or nil, that stands for the selected frame's display.")
4370 (display)
4371 Lisp_Object display;
4372 {
4373 struct x_display_info *dpyinfo = check_x_display_info (display);
4374
4375 return make_number (dpyinfo->n_planes);
4376 }
4377
4378 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4379 0, 1, 0,
4380 "Returns the number of color cells of the X display DISPLAY.\n\
4381 The optional argument DISPLAY specifies which display to ask about.\n\
4382 DISPLAY should be either a frame or a display name (a string).\n\
4383 If omitted or nil, that stands for the selected frame's display.")
4384 (display)
4385 Lisp_Object display;
4386 {
4387 struct x_display_info *dpyinfo = check_x_display_info (display);
4388
4389 return make_number (DisplayCells (dpyinfo->display,
4390 XScreenNumberOfScreen (dpyinfo->screen)));
4391 }
4392
4393 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4394 Sx_server_max_request_size,
4395 0, 1, 0,
4396 "Returns the maximum request size of the X server of display DISPLAY.\n\
4397 The optional argument DISPLAY specifies which display to ask about.\n\
4398 DISPLAY should be either a frame or a display name (a string).\n\
4399 If omitted or nil, that stands for the selected frame's display.")
4400 (display)
4401 Lisp_Object display;
4402 {
4403 struct x_display_info *dpyinfo = check_x_display_info (display);
4404
4405 return make_number (MAXREQUEST (dpyinfo->display));
4406 }
4407
4408 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4409 "Returns the vendor ID string of the X server of display DISPLAY.\n\
4410 The optional argument DISPLAY specifies which display to ask about.\n\
4411 DISPLAY should be either a frame or a display name (a string).\n\
4412 If omitted or nil, that stands for the selected frame's display.")
4413 (display)
4414 Lisp_Object display;
4415 {
4416 struct x_display_info *dpyinfo = check_x_display_info (display);
4417 char *vendor = ServerVendor (dpyinfo->display);
4418
4419 if (! vendor) vendor = "";
4420 return build_string (vendor);
4421 }
4422
4423 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4424 "Returns the version numbers of the X server of display DISPLAY.\n\
4425 The value is a list of three integers: the major and minor\n\
4426 version numbers of the X Protocol in use, and the vendor-specific release\n\
4427 number. See also the function `x-server-vendor'.\n\n\
4428 The optional argument DISPLAY specifies which display to ask about.\n\
4429 DISPLAY should be either a frame or a display name (a string).\n\
4430 If omitted or nil, that stands for the selected frame's display.")
4431 (display)
4432 Lisp_Object display;
4433 {
4434 struct x_display_info *dpyinfo = check_x_display_info (display);
4435 Display *dpy = dpyinfo->display;
4436
4437 return Fcons (make_number (ProtocolVersion (dpy)),
4438 Fcons (make_number (ProtocolRevision (dpy)),
4439 Fcons (make_number (VendorRelease (dpy)), Qnil)));
4440 }
4441
4442 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4443 "Returns the number of screens on the X server of display DISPLAY.\n\
4444 The optional argument DISPLAY specifies which display to ask about.\n\
4445 DISPLAY should be either a frame or a display name (a string).\n\
4446 If omitted or nil, that stands for the selected frame's display.")
4447 (display)
4448 Lisp_Object display;
4449 {
4450 struct x_display_info *dpyinfo = check_x_display_info (display);
4451
4452 return make_number (ScreenCount (dpyinfo->display));
4453 }
4454
4455 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
4456 "Returns the height in millimeters of the X display DISPLAY.\n\
4457 The optional argument DISPLAY specifies which display to ask about.\n\
4458 DISPLAY should be either a frame or a display name (a string).\n\
4459 If omitted or nil, that stands for the selected frame's display.")
4460 (display)
4461 Lisp_Object display;
4462 {
4463 struct x_display_info *dpyinfo = check_x_display_info (display);
4464
4465 return make_number (HeightMMOfScreen (dpyinfo->screen));
4466 }
4467
4468 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4469 "Returns the width in millimeters of the X display DISPLAY.\n\
4470 The optional argument DISPLAY specifies which display to ask about.\n\
4471 DISPLAY should be either a frame or a display name (a string).\n\
4472 If omitted or nil, that stands for the selected frame's display.")
4473 (display)
4474 Lisp_Object display;
4475 {
4476 struct x_display_info *dpyinfo = check_x_display_info (display);
4477
4478 return make_number (WidthMMOfScreen (dpyinfo->screen));
4479 }
4480
4481 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4482 Sx_display_backing_store, 0, 1, 0,
4483 "Returns an indication of whether X display DISPLAY does backing store.\n\
4484 The value may be `always', `when-mapped', or `not-useful'.\n\
4485 The optional argument DISPLAY specifies which display to ask about.\n\
4486 DISPLAY should be either a frame or a display name (a string).\n\
4487 If omitted or nil, that stands for the selected frame's display.")
4488 (display)
4489 Lisp_Object display;
4490 {
4491 struct x_display_info *dpyinfo = check_x_display_info (display);
4492
4493 switch (DoesBackingStore (dpyinfo->screen))
4494 {
4495 case Always:
4496 return intern ("always");
4497
4498 case WhenMapped:
4499 return intern ("when-mapped");
4500
4501 case NotUseful:
4502 return intern ("not-useful");
4503
4504 default:
4505 error ("Strange value for BackingStore parameter of screen");
4506 }
4507 }
4508
4509 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4510 Sx_display_visual_class, 0, 1, 0,
4511 "Returns the visual class of the X display DISPLAY.\n\
4512 The value is one of the symbols `static-gray', `gray-scale',\n\
4513 `static-color', `pseudo-color', `true-color', or `direct-color'.\n\n\
4514 The optional argument DISPLAY specifies which display to ask about.\n\
4515 DISPLAY should be either a frame or a display name (a string).\n\
4516 If omitted or nil, that stands for the selected frame's display.")
4517 (display)
4518 Lisp_Object display;
4519 {
4520 struct x_display_info *dpyinfo = check_x_display_info (display);
4521
4522 switch (dpyinfo->visual->class)
4523 {
4524 case StaticGray: return (intern ("static-gray"));
4525 case GrayScale: return (intern ("gray-scale"));
4526 case StaticColor: return (intern ("static-color"));
4527 case PseudoColor: return (intern ("pseudo-color"));
4528 case TrueColor: return (intern ("true-color"));
4529 case DirectColor: return (intern ("direct-color"));
4530 default:
4531 error ("Display has an unknown visual class");
4532 }
4533 }
4534
4535 DEFUN ("x-display-save-under", Fx_display_save_under,
4536 Sx_display_save_under, 0, 1, 0,
4537 "Returns t if the X display DISPLAY supports the save-under feature.\n\
4538 The optional argument DISPLAY specifies which display to ask about.\n\
4539 DISPLAY should be either a frame or a display name (a string).\n\
4540 If omitted or nil, that stands for the selected frame's display.")
4541 (display)
4542 Lisp_Object display;
4543 {
4544 struct x_display_info *dpyinfo = check_x_display_info (display);
4545
4546 if (DoesSaveUnders (dpyinfo->screen) == True)
4547 return Qt;
4548 else
4549 return Qnil;
4550 }
4551 \f
4552 int
4553 x_pixel_width (f)
4554 register struct frame *f;
4555 {
4556 return PIXEL_WIDTH (f);
4557 }
4558
4559 int
4560 x_pixel_height (f)
4561 register struct frame *f;
4562 {
4563 return PIXEL_HEIGHT (f);
4564 }
4565
4566 int
4567 x_char_width (f)
4568 register struct frame *f;
4569 {
4570 return FONT_WIDTH (f->output_data.x->font);
4571 }
4572
4573 int
4574 x_char_height (f)
4575 register struct frame *f;
4576 {
4577 return f->output_data.x->line_height;
4578 }
4579
4580 int
4581 x_screen_planes (f)
4582 register struct frame *f;
4583 {
4584 return FRAME_X_DISPLAY_INFO (f)->n_planes;
4585 }
4586
4587
4588 \f
4589 /************************************************************************
4590 X Displays
4591 ************************************************************************/
4592
4593 \f
4594 /* Mapping visual names to visuals. */
4595
4596 static struct visual_class
4597 {
4598 char *name;
4599 int class;
4600 }
4601 visual_classes[] =
4602 {
4603 {"StaticGray", StaticGray},
4604 {"GrayScale", GrayScale},
4605 {"StaticColor", StaticColor},
4606 {"PseudoColor", PseudoColor},
4607 {"TrueColor", TrueColor},
4608 {"DirectColor", DirectColor},
4609 NULL
4610 };
4611
4612
4613 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4614
4615 /* Value is the screen number of screen SCR. This is a substitute for
4616 the X function with the same name when that doesn't exist. */
4617
4618 int
4619 XScreenNumberOfScreen (scr)
4620 register Screen *scr;
4621 {
4622 Display *dpy = scr->display;
4623 int i;
4624
4625 for (i = 0; i < dpy->nscreens; ++i)
4626 if (scr == dpy->screens[i])
4627 break;
4628
4629 return i;
4630 }
4631
4632 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4633
4634
4635 /* Select the visual that should be used on display DPYINFO. Set
4636 members of DPYINFO appropriately. Called from x_term_init. */
4637
4638 void
4639 select_visual (dpyinfo)
4640 struct x_display_info *dpyinfo;
4641 {
4642 Display *dpy = dpyinfo->display;
4643 Screen *screen = dpyinfo->screen;
4644 Lisp_Object value;
4645
4646 /* See if a visual is specified. */
4647 value = display_x_get_resource (dpyinfo,
4648 build_string ("visualClass"),
4649 build_string ("VisualClass"),
4650 Qnil, Qnil);
4651 if (STRINGP (value))
4652 {
4653 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4654 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4655 depth, a decimal number. NAME is compared with case ignored. */
4656 char *s = (char *) alloca (STRING_BYTES (XSTRING (value)) + 1);
4657 char *dash;
4658 int i, class = -1;
4659 XVisualInfo vinfo;
4660
4661 strcpy (s, XSTRING (value)->data);
4662 dash = index (s, '-');
4663 if (dash)
4664 {
4665 dpyinfo->n_planes = atoi (dash + 1);
4666 *dash = '\0';
4667 }
4668 else
4669 /* We won't find a matching visual with depth 0, so that
4670 an error will be printed below. */
4671 dpyinfo->n_planes = 0;
4672
4673 /* Determine the visual class. */
4674 for (i = 0; visual_classes[i].name; ++i)
4675 if (xstricmp (s, visual_classes[i].name) == 0)
4676 {
4677 class = visual_classes[i].class;
4678 break;
4679 }
4680
4681 /* Look up a matching visual for the specified class. */
4682 if (class == -1
4683 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4684 dpyinfo->n_planes, class, &vinfo))
4685 fatal ("Invalid visual specification `%s'", XSTRING (value)->data);
4686
4687 dpyinfo->visual = vinfo.visual;
4688 }
4689 else
4690 {
4691 int n_visuals;
4692 XVisualInfo *vinfo, vinfo_template;
4693
4694 dpyinfo->visual = DefaultVisualOfScreen (screen);
4695
4696 #ifdef HAVE_X11R4
4697 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4698 #else
4699 vinfo_template.visualid = dpyinfo->visual->visualid;
4700 #endif
4701 vinfo_template.screen = XScreenNumberOfScreen (screen);
4702 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4703 &vinfo_template, &n_visuals);
4704 if (n_visuals != 1)
4705 fatal ("Can't get proper X visual info");
4706
4707 dpyinfo->n_planes = vinfo->depth;
4708 XFree ((char *) vinfo);
4709 }
4710 }
4711
4712
4713 /* Return the X display structure for the display named NAME.
4714 Open a new connection if necessary. */
4715
4716 struct x_display_info *
4717 x_display_info_for_name (name)
4718 Lisp_Object name;
4719 {
4720 Lisp_Object names;
4721 struct x_display_info *dpyinfo;
4722
4723 CHECK_STRING (name, 0);
4724
4725 if (! EQ (Vwindow_system, intern ("x")))
4726 error ("Not using X Windows");
4727
4728 for (dpyinfo = x_display_list, names = x_display_name_list;
4729 dpyinfo;
4730 dpyinfo = dpyinfo->next, names = XCDR (names))
4731 {
4732 Lisp_Object tem;
4733 tem = Fstring_equal (XCAR (XCAR (names)), name);
4734 if (!NILP (tem))
4735 return dpyinfo;
4736 }
4737
4738 /* Use this general default value to start with. */
4739 Vx_resource_name = Vinvocation_name;
4740
4741 validate_x_resource_name ();
4742
4743 dpyinfo = x_term_init (name, (unsigned char *)0,
4744 (char *) XSTRING (Vx_resource_name)->data);
4745
4746 if (dpyinfo == 0)
4747 error ("Cannot connect to X server %s", XSTRING (name)->data);
4748
4749 x_in_use = 1;
4750 XSETFASTINT (Vwindow_system_version, 11);
4751
4752 return dpyinfo;
4753 }
4754
4755
4756 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4757 1, 3, 0, "Open a connection to an X server.\n\
4758 DISPLAY is the name of the display to connect to.\n\
4759 Optional second arg XRM-STRING is a string of resources in xrdb format.\n\
4760 If the optional third arg MUST-SUCCEED is non-nil,\n\
4761 terminate Emacs if we can't open the connection.")
4762 (display, xrm_string, must_succeed)
4763 Lisp_Object display, xrm_string, must_succeed;
4764 {
4765 unsigned char *xrm_option;
4766 struct x_display_info *dpyinfo;
4767
4768 CHECK_STRING (display, 0);
4769 if (! NILP (xrm_string))
4770 CHECK_STRING (xrm_string, 1);
4771
4772 if (! EQ (Vwindow_system, intern ("x")))
4773 error ("Not using X Windows");
4774
4775 if (! NILP (xrm_string))
4776 xrm_option = (unsigned char *) XSTRING (xrm_string)->data;
4777 else
4778 xrm_option = (unsigned char *) 0;
4779
4780 validate_x_resource_name ();
4781
4782 /* This is what opens the connection and sets x_current_display.
4783 This also initializes many symbols, such as those used for input. */
4784 dpyinfo = x_term_init (display, xrm_option,
4785 (char *) XSTRING (Vx_resource_name)->data);
4786
4787 if (dpyinfo == 0)
4788 {
4789 if (!NILP (must_succeed))
4790 fatal ("Cannot connect to X server %s.\n\
4791 Check the DISPLAY environment variable or use `-d'.\n\
4792 Also use the `xhost' program to verify that it is set to permit\n\
4793 connections from your machine.\n",
4794 XSTRING (display)->data);
4795 else
4796 error ("Cannot connect to X server %s", XSTRING (display)->data);
4797 }
4798
4799 x_in_use = 1;
4800
4801 XSETFASTINT (Vwindow_system_version, 11);
4802 return Qnil;
4803 }
4804
4805 DEFUN ("x-close-connection", Fx_close_connection,
4806 Sx_close_connection, 1, 1, 0,
4807 "Close the connection to DISPLAY's X server.\n\
4808 For DISPLAY, specify either a frame or a display name (a string).\n\
4809 If DISPLAY is nil, that stands for the selected frame's display.")
4810 (display)
4811 Lisp_Object display;
4812 {
4813 struct x_display_info *dpyinfo = check_x_display_info (display);
4814 int i;
4815
4816 if (dpyinfo->reference_count > 0)
4817 error ("Display still has frames on it");
4818
4819 BLOCK_INPUT;
4820 /* Free the fonts in the font table. */
4821 for (i = 0; i < dpyinfo->n_fonts; i++)
4822 if (dpyinfo->font_table[i].name)
4823 {
4824 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
4825 xfree (dpyinfo->font_table[i].full_name);
4826 xfree (dpyinfo->font_table[i].name);
4827 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
4828 }
4829
4830 x_destroy_all_bitmaps (dpyinfo);
4831 XSetCloseDownMode (dpyinfo->display, DestroyAll);
4832
4833 #ifdef USE_X_TOOLKIT
4834 XtCloseDisplay (dpyinfo->display);
4835 #else
4836 XCloseDisplay (dpyinfo->display);
4837 #endif
4838
4839 x_delete_display (dpyinfo);
4840 UNBLOCK_INPUT;
4841
4842 return Qnil;
4843 }
4844
4845 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4846 "Return the list of display names that Emacs has connections to.")
4847 ()
4848 {
4849 Lisp_Object tail, result;
4850
4851 result = Qnil;
4852 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
4853 result = Fcons (XCAR (XCAR (tail)), result);
4854
4855 return result;
4856 }
4857
4858 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4859 "If ON is non-nil, report X errors as soon as the erring request is made.\n\
4860 If ON is nil, allow buffering of requests.\n\
4861 Turning on synchronization prohibits the Xlib routines from buffering\n\
4862 requests and seriously degrades performance, but makes debugging much\n\
4863 easier.\n\
4864 The optional second argument DISPLAY specifies which display to act on.\n\
4865 DISPLAY should be either a frame or a display name (a string).\n\
4866 If DISPLAY is omitted or nil, that stands for the selected frame's display.")
4867 (on, display)
4868 Lisp_Object display, on;
4869 {
4870 struct x_display_info *dpyinfo = check_x_display_info (display);
4871
4872 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
4873
4874 return Qnil;
4875 }
4876
4877 /* Wait for responses to all X commands issued so far for frame F. */
4878
4879 void
4880 x_sync (f)
4881 FRAME_PTR f;
4882 {
4883 BLOCK_INPUT;
4884 XSync (FRAME_X_DISPLAY (f), False);
4885 UNBLOCK_INPUT;
4886 }
4887
4888 \f
4889 /***********************************************************************
4890 Image types
4891 ***********************************************************************/
4892
4893 /* Value is the number of elements of vector VECTOR. */
4894
4895 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
4896
4897 /* List of supported image types. Use define_image_type to add new
4898 types. Use lookup_image_type to find a type for a given symbol. */
4899
4900 static struct image_type *image_types;
4901
4902 /* The symbol `image' which is the car of the lists used to represent
4903 images in Lisp. */
4904
4905 extern Lisp_Object Qimage;
4906
4907 /* The symbol `xbm' which is used as the type symbol for XBM images. */
4908
4909 Lisp_Object Qxbm;
4910
4911 /* Keywords. */
4912
4913 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
4914 extern Lisp_Object QCdata;
4915 Lisp_Object QCtype, QCascent, QCmargin, QCrelief;
4916 Lisp_Object QCalgorithm, QCcolor_symbols, QCheuristic_mask;
4917 Lisp_Object QCindex;
4918
4919 /* Other symbols. */
4920
4921 Lisp_Object Qlaplace;
4922
4923 /* Time in seconds after which images should be removed from the cache
4924 if not displayed. */
4925
4926 Lisp_Object Vimage_cache_eviction_delay;
4927
4928 /* Function prototypes. */
4929
4930 static void define_image_type P_ ((struct image_type *type));
4931 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
4932 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
4933 static void x_laplace P_ ((struct frame *, struct image *));
4934 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
4935 Lisp_Object));
4936
4937
4938 /* Define a new image type from TYPE. This adds a copy of TYPE to
4939 image_types and adds the symbol *TYPE->type to Vimage_types. */
4940
4941 static void
4942 define_image_type (type)
4943 struct image_type *type;
4944 {
4945 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
4946 The initialized data segment is read-only. */
4947 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
4948 bcopy (type, p, sizeof *p);
4949 p->next = image_types;
4950 image_types = p;
4951 Vimage_types = Fcons (*p->type, Vimage_types);
4952 }
4953
4954
4955 /* Look up image type SYMBOL, and return a pointer to its image_type
4956 structure. Value is null if SYMBOL is not a known image type. */
4957
4958 static INLINE struct image_type *
4959 lookup_image_type (symbol)
4960 Lisp_Object symbol;
4961 {
4962 struct image_type *type;
4963
4964 for (type = image_types; type; type = type->next)
4965 if (EQ (symbol, *type->type))
4966 break;
4967
4968 return type;
4969 }
4970
4971
4972 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
4973 valid image specification is a list whose car is the symbol
4974 `image', and whose rest is a property list. The property list must
4975 contain a value for key `:type'. That value must be the name of a
4976 supported image type. The rest of the property list depends on the
4977 image type. */
4978
4979 int
4980 valid_image_p (object)
4981 Lisp_Object object;
4982 {
4983 int valid_p = 0;
4984
4985 if (CONSP (object) && EQ (XCAR (object), Qimage))
4986 {
4987 Lisp_Object symbol = Fplist_get (XCDR (object), QCtype);
4988 struct image_type *type = lookup_image_type (symbol);
4989
4990 if (type)
4991 valid_p = type->valid_p (object);
4992 }
4993
4994 return valid_p;
4995 }
4996
4997
4998 /* Log error message with format string FORMAT and argument ARG.
4999 Signaling an error, e.g. when an image cannot be loaded, is not a
5000 good idea because this would interrupt redisplay, and the error
5001 message display would lead to another redisplay. This function
5002 therefore simply displays a message. */
5003
5004 static void
5005 image_error (format, arg1, arg2)
5006 char *format;
5007 Lisp_Object arg1, arg2;
5008 {
5009 add_to_log (format, arg1, arg2);
5010 }
5011
5012
5013 \f
5014 /***********************************************************************
5015 Image specifications
5016 ***********************************************************************/
5017
5018 enum image_value_type
5019 {
5020 IMAGE_DONT_CHECK_VALUE_TYPE,
5021 IMAGE_STRING_VALUE,
5022 IMAGE_SYMBOL_VALUE,
5023 IMAGE_POSITIVE_INTEGER_VALUE,
5024 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
5025 IMAGE_ASCENT_VALUE,
5026 IMAGE_INTEGER_VALUE,
5027 IMAGE_FUNCTION_VALUE,
5028 IMAGE_NUMBER_VALUE,
5029 IMAGE_BOOL_VALUE
5030 };
5031
5032 /* Structure used when parsing image specifications. */
5033
5034 struct image_keyword
5035 {
5036 /* Name of keyword. */
5037 char *name;
5038
5039 /* The type of value allowed. */
5040 enum image_value_type type;
5041
5042 /* Non-zero means key must be present. */
5043 int mandatory_p;
5044
5045 /* Used to recognize duplicate keywords in a property list. */
5046 int count;
5047
5048 /* The value that was found. */
5049 Lisp_Object value;
5050 };
5051
5052
5053 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
5054 int, Lisp_Object));
5055 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
5056
5057
5058 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
5059 has the format (image KEYWORD VALUE ...). One of the keyword/
5060 value pairs must be `:type TYPE'. KEYWORDS is a vector of
5061 image_keywords structures of size NKEYWORDS describing other
5062 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
5063
5064 static int
5065 parse_image_spec (spec, keywords, nkeywords, type)
5066 Lisp_Object spec;
5067 struct image_keyword *keywords;
5068 int nkeywords;
5069 Lisp_Object type;
5070 {
5071 int i;
5072 Lisp_Object plist;
5073
5074 if (!CONSP (spec) || !EQ (XCAR (spec), Qimage))
5075 return 0;
5076
5077 plist = XCDR (spec);
5078 while (CONSP (plist))
5079 {
5080 Lisp_Object key, value;
5081
5082 /* First element of a pair must be a symbol. */
5083 key = XCAR (plist);
5084 plist = XCDR (plist);
5085 if (!SYMBOLP (key))
5086 return 0;
5087
5088 /* There must follow a value. */
5089 if (!CONSP (plist))
5090 return 0;
5091 value = XCAR (plist);
5092 plist = XCDR (plist);
5093
5094 /* Find key in KEYWORDS. Error if not found. */
5095 for (i = 0; i < nkeywords; ++i)
5096 if (strcmp (keywords[i].name, XSYMBOL (key)->name->data) == 0)
5097 break;
5098
5099 if (i == nkeywords)
5100 continue;
5101
5102 /* Record that we recognized the keyword. If a keywords
5103 was found more than once, it's an error. */
5104 keywords[i].value = value;
5105 ++keywords[i].count;
5106
5107 if (keywords[i].count > 1)
5108 return 0;
5109
5110 /* Check type of value against allowed type. */
5111 switch (keywords[i].type)
5112 {
5113 case IMAGE_STRING_VALUE:
5114 if (!STRINGP (value))
5115 return 0;
5116 break;
5117
5118 case IMAGE_SYMBOL_VALUE:
5119 if (!SYMBOLP (value))
5120 return 0;
5121 break;
5122
5123 case IMAGE_POSITIVE_INTEGER_VALUE:
5124 if (!INTEGERP (value) || XINT (value) <= 0)
5125 return 0;
5126 break;
5127
5128 case IMAGE_ASCENT_VALUE:
5129 if (SYMBOLP (value) && EQ (value, Qcenter))
5130 break;
5131 else if (INTEGERP (value)
5132 && XINT (value) >= 0
5133 && XINT (value) <= 100)
5134 break;
5135 return 0;
5136
5137 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
5138 if (!INTEGERP (value) || XINT (value) < 0)
5139 return 0;
5140 break;
5141
5142 case IMAGE_DONT_CHECK_VALUE_TYPE:
5143 break;
5144
5145 case IMAGE_FUNCTION_VALUE:
5146 value = indirect_function (value);
5147 if (SUBRP (value)
5148 || COMPILEDP (value)
5149 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
5150 break;
5151 return 0;
5152
5153 case IMAGE_NUMBER_VALUE:
5154 if (!INTEGERP (value) && !FLOATP (value))
5155 return 0;
5156 break;
5157
5158 case IMAGE_INTEGER_VALUE:
5159 if (!INTEGERP (value))
5160 return 0;
5161 break;
5162
5163 case IMAGE_BOOL_VALUE:
5164 if (!NILP (value) && !EQ (value, Qt))
5165 return 0;
5166 break;
5167
5168 default:
5169 abort ();
5170 break;
5171 }
5172
5173 if (EQ (key, QCtype) && !EQ (type, value))
5174 return 0;
5175 }
5176
5177 /* Check that all mandatory fields are present. */
5178 for (i = 0; i < nkeywords; ++i)
5179 if (keywords[i].mandatory_p && keywords[i].count == 0)
5180 return 0;
5181
5182 return NILP (plist);
5183 }
5184
5185
5186 /* Return the value of KEY in image specification SPEC. Value is nil
5187 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
5188 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
5189
5190 static Lisp_Object
5191 image_spec_value (spec, key, found)
5192 Lisp_Object spec, key;
5193 int *found;
5194 {
5195 Lisp_Object tail;
5196
5197 xassert (valid_image_p (spec));
5198
5199 for (tail = XCDR (spec);
5200 CONSP (tail) && CONSP (XCDR (tail));
5201 tail = XCDR (XCDR (tail)))
5202 {
5203 if (EQ (XCAR (tail), key))
5204 {
5205 if (found)
5206 *found = 1;
5207 return XCAR (XCDR (tail));
5208 }
5209 }
5210
5211 if (found)
5212 *found = 0;
5213 return Qnil;
5214 }
5215
5216
5217
5218 \f
5219 /***********************************************************************
5220 Image type independent image structures
5221 ***********************************************************************/
5222
5223 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
5224 static void free_image P_ ((struct frame *f, struct image *img));
5225
5226
5227 /* Allocate and return a new image structure for image specification
5228 SPEC. SPEC has a hash value of HASH. */
5229
5230 static struct image *
5231 make_image (spec, hash)
5232 Lisp_Object spec;
5233 unsigned hash;
5234 {
5235 struct image *img = (struct image *) xmalloc (sizeof *img);
5236
5237 xassert (valid_image_p (spec));
5238 bzero (img, sizeof *img);
5239 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
5240 xassert (img->type != NULL);
5241 img->spec = spec;
5242 img->data.lisp_val = Qnil;
5243 img->ascent = DEFAULT_IMAGE_ASCENT;
5244 img->hash = hash;
5245 return img;
5246 }
5247
5248
5249 /* Free image IMG which was used on frame F, including its resources. */
5250
5251 static void
5252 free_image (f, img)
5253 struct frame *f;
5254 struct image *img;
5255 {
5256 if (img)
5257 {
5258 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5259
5260 /* Remove IMG from the hash table of its cache. */
5261 if (img->prev)
5262 img->prev->next = img->next;
5263 else
5264 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
5265
5266 if (img->next)
5267 img->next->prev = img->prev;
5268
5269 c->images[img->id] = NULL;
5270
5271 /* Free resources, then free IMG. */
5272 img->type->free (f, img);
5273 xfree (img);
5274 }
5275 }
5276
5277
5278 /* Prepare image IMG for display on frame F. Must be called before
5279 drawing an image. */
5280
5281 void
5282 prepare_image_for_display (f, img)
5283 struct frame *f;
5284 struct image *img;
5285 {
5286 EMACS_TIME t;
5287
5288 /* We're about to display IMG, so set its timestamp to `now'. */
5289 EMACS_GET_TIME (t);
5290 img->timestamp = EMACS_SECS (t);
5291
5292 /* If IMG doesn't have a pixmap yet, load it now, using the image
5293 type dependent loader function. */
5294 if (img->pixmap == 0 && !img->load_failed_p)
5295 img->load_failed_p = img->type->load (f, img) == 0;
5296 }
5297
5298
5299 /* Value is the number of pixels for the ascent of image IMG when
5300 drawn in face FACE. */
5301
5302 int
5303 image_ascent (img, face)
5304 struct image *img;
5305 struct face *face;
5306 {
5307 int height = img->height + img->margin;
5308 int ascent;
5309
5310 if (img->ascent == CENTERED_IMAGE_ASCENT)
5311 {
5312 if (face->font)
5313 ascent = height / 2 - (face->font->descent - face->font->ascent) / 2;
5314 else
5315 ascent = height / 2;
5316 }
5317 else
5318 ascent = height * img->ascent / 100.0;
5319
5320 return ascent;
5321 }
5322
5323
5324 \f
5325 /***********************************************************************
5326 Helper functions for X image types
5327 ***********************************************************************/
5328
5329 static void x_clear_image P_ ((struct frame *f, struct image *img));
5330 static unsigned long x_alloc_image_color P_ ((struct frame *f,
5331 struct image *img,
5332 Lisp_Object color_name,
5333 unsigned long dflt));
5334
5335 /* Free X resources of image IMG which is used on frame F. */
5336
5337 static void
5338 x_clear_image (f, img)
5339 struct frame *f;
5340 struct image *img;
5341 {
5342 if (img->pixmap)
5343 {
5344 BLOCK_INPUT;
5345 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
5346 img->pixmap = 0;
5347 UNBLOCK_INPUT;
5348 }
5349
5350 if (img->ncolors)
5351 {
5352 BLOCK_INPUT;
5353 x_free_colors (f, img->colors, img->ncolors);
5354 UNBLOCK_INPUT;
5355
5356 xfree (img->colors);
5357 img->colors = NULL;
5358 img->ncolors = 0;
5359 }
5360 }
5361
5362
5363 /* Allocate color COLOR_NAME for image IMG on frame F. If color
5364 cannot be allocated, use DFLT. Add a newly allocated color to
5365 IMG->colors, so that it can be freed again. Value is the pixel
5366 color. */
5367
5368 static unsigned long
5369 x_alloc_image_color (f, img, color_name, dflt)
5370 struct frame *f;
5371 struct image *img;
5372 Lisp_Object color_name;
5373 unsigned long dflt;
5374 {
5375 XColor color;
5376 unsigned long result;
5377
5378 xassert (STRINGP (color_name));
5379
5380 if (x_defined_color (f, XSTRING (color_name)->data, &color, 1))
5381 {
5382 /* This isn't called frequently so we get away with simply
5383 reallocating the color vector to the needed size, here. */
5384 ++img->ncolors;
5385 img->colors =
5386 (unsigned long *) xrealloc (img->colors,
5387 img->ncolors * sizeof *img->colors);
5388 img->colors[img->ncolors - 1] = color.pixel;
5389 result = color.pixel;
5390 }
5391 else
5392 result = dflt;
5393
5394 return result;
5395 }
5396
5397
5398 \f
5399 /***********************************************************************
5400 Image Cache
5401 ***********************************************************************/
5402
5403 static void cache_image P_ ((struct frame *f, struct image *img));
5404
5405
5406 /* Return a new, initialized image cache that is allocated from the
5407 heap. Call free_image_cache to free an image cache. */
5408
5409 struct image_cache *
5410 make_image_cache ()
5411 {
5412 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
5413 int size;
5414
5415 bzero (c, sizeof *c);
5416 c->size = 50;
5417 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
5418 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5419 c->buckets = (struct image **) xmalloc (size);
5420 bzero (c->buckets, size);
5421 return c;
5422 }
5423
5424
5425 /* Free image cache of frame F. Be aware that X frames share images
5426 caches. */
5427
5428 void
5429 free_image_cache (f)
5430 struct frame *f;
5431 {
5432 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5433 if (c)
5434 {
5435 int i;
5436
5437 /* Cache should not be referenced by any frame when freed. */
5438 xassert (c->refcount == 0);
5439
5440 for (i = 0; i < c->used; ++i)
5441 free_image (f, c->images[i]);
5442 xfree (c->images);
5443 xfree (c->buckets);
5444 xfree (c);
5445 FRAME_X_IMAGE_CACHE (f) = NULL;
5446 }
5447 }
5448
5449
5450 /* Clear image cache of frame F. FORCE_P non-zero means free all
5451 images. FORCE_P zero means clear only images that haven't been
5452 displayed for some time. Should be called from time to time to
5453 reduce the number of loaded images. If image-eviction-seconds is
5454 non-nil, this frees images in the cache which weren't displayed for
5455 at least that many seconds. */
5456
5457 void
5458 clear_image_cache (f, force_p)
5459 struct frame *f;
5460 int force_p;
5461 {
5462 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5463
5464 if (c && INTEGERP (Vimage_cache_eviction_delay))
5465 {
5466 EMACS_TIME t;
5467 unsigned long old;
5468 int i, any_freed_p = 0;
5469
5470 EMACS_GET_TIME (t);
5471 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
5472
5473 for (i = 0; i < c->used; ++i)
5474 {
5475 struct image *img = c->images[i];
5476 if (img != NULL
5477 && (force_p
5478 || (img->timestamp > old)))
5479 {
5480 free_image (f, img);
5481 any_freed_p = 1;
5482 }
5483 }
5484
5485 /* We may be clearing the image cache because, for example,
5486 Emacs was iconified for a longer period of time. In that
5487 case, current matrices may still contain references to
5488 images freed above. So, clear these matrices. */
5489 if (any_freed_p)
5490 {
5491 clear_current_matrices (f);
5492 ++windows_or_buffers_changed;
5493 }
5494 }
5495 }
5496
5497
5498 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
5499 0, 1, 0,
5500 "Clear the image cache of FRAME.\n\
5501 FRAME nil or omitted means use the selected frame.\n\
5502 FRAME t means clear the image caches of all frames.")
5503 (frame)
5504 Lisp_Object frame;
5505 {
5506 if (EQ (frame, Qt))
5507 {
5508 Lisp_Object tail;
5509
5510 FOR_EACH_FRAME (tail, frame)
5511 if (FRAME_X_P (XFRAME (frame)))
5512 clear_image_cache (XFRAME (frame), 1);
5513 }
5514 else
5515 clear_image_cache (check_x_frame (frame), 1);
5516
5517 return Qnil;
5518 }
5519
5520
5521 /* Return the id of image with Lisp specification SPEC on frame F.
5522 SPEC must be a valid Lisp image specification (see valid_image_p). */
5523
5524 int
5525 lookup_image (f, spec)
5526 struct frame *f;
5527 Lisp_Object spec;
5528 {
5529 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5530 struct image *img;
5531 int i;
5532 unsigned hash;
5533 struct gcpro gcpro1;
5534 EMACS_TIME now;
5535
5536 /* F must be a window-system frame, and SPEC must be a valid image
5537 specification. */
5538 xassert (FRAME_WINDOW_P (f));
5539 xassert (valid_image_p (spec));
5540
5541 GCPRO1 (spec);
5542
5543 /* Look up SPEC in the hash table of the image cache. */
5544 hash = sxhash (spec, 0);
5545 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
5546
5547 for (img = c->buckets[i]; img; img = img->next)
5548 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
5549 break;
5550
5551 /* If not found, create a new image and cache it. */
5552 if (img == NULL)
5553 {
5554 img = make_image (spec, hash);
5555 cache_image (f, img);
5556 img->load_failed_p = img->type->load (f, img) == 0;
5557 xassert (!interrupt_input_blocked);
5558
5559 /* If we can't load the image, and we don't have a width and
5560 height, use some arbitrary width and height so that we can
5561 draw a rectangle for it. */
5562 if (img->load_failed_p)
5563 {
5564 Lisp_Object value;
5565
5566 value = image_spec_value (spec, QCwidth, NULL);
5567 img->width = (INTEGERP (value)
5568 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
5569 value = image_spec_value (spec, QCheight, NULL);
5570 img->height = (INTEGERP (value)
5571 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
5572 }
5573 else
5574 {
5575 /* Handle image type independent image attributes
5576 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF'. */
5577 Lisp_Object ascent, margin, relief, algorithm, heuristic_mask;
5578 Lisp_Object file;
5579
5580 ascent = image_spec_value (spec, QCascent, NULL);
5581 if (INTEGERP (ascent))
5582 img->ascent = XFASTINT (ascent);
5583 else if (EQ (ascent, Qcenter))
5584 img->ascent = CENTERED_IMAGE_ASCENT;
5585
5586 margin = image_spec_value (spec, QCmargin, NULL);
5587 if (INTEGERP (margin) && XINT (margin) >= 0)
5588 img->margin = XFASTINT (margin);
5589
5590 relief = image_spec_value (spec, QCrelief, NULL);
5591 if (INTEGERP (relief))
5592 {
5593 img->relief = XINT (relief);
5594 img->margin += abs (img->relief);
5595 }
5596
5597 /* Should we apply a Laplace edge-detection algorithm? */
5598 algorithm = image_spec_value (spec, QCalgorithm, NULL);
5599 if (img->pixmap && EQ (algorithm, Qlaplace))
5600 x_laplace (f, img);
5601
5602 /* Should we built a mask heuristically? */
5603 heuristic_mask = image_spec_value (spec, QCheuristic_mask, NULL);
5604 if (img->pixmap && !img->mask && !NILP (heuristic_mask))
5605 x_build_heuristic_mask (f, img, heuristic_mask);
5606 }
5607 }
5608
5609 /* We're using IMG, so set its timestamp to `now'. */
5610 EMACS_GET_TIME (now);
5611 img->timestamp = EMACS_SECS (now);
5612
5613 UNGCPRO;
5614
5615 /* Value is the image id. */
5616 return img->id;
5617 }
5618
5619
5620 /* Cache image IMG in the image cache of frame F. */
5621
5622 static void
5623 cache_image (f, img)
5624 struct frame *f;
5625 struct image *img;
5626 {
5627 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5628 int i;
5629
5630 /* Find a free slot in c->images. */
5631 for (i = 0; i < c->used; ++i)
5632 if (c->images[i] == NULL)
5633 break;
5634
5635 /* If no free slot found, maybe enlarge c->images. */
5636 if (i == c->used && c->used == c->size)
5637 {
5638 c->size *= 2;
5639 c->images = (struct image **) xrealloc (c->images,
5640 c->size * sizeof *c->images);
5641 }
5642
5643 /* Add IMG to c->images, and assign IMG an id. */
5644 c->images[i] = img;
5645 img->id = i;
5646 if (i == c->used)
5647 ++c->used;
5648
5649 /* Add IMG to the cache's hash table. */
5650 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
5651 img->next = c->buckets[i];
5652 if (img->next)
5653 img->next->prev = img;
5654 img->prev = NULL;
5655 c->buckets[i] = img;
5656 }
5657
5658
5659 /* Call FN on every image in the image cache of frame F. Used to mark
5660 Lisp Objects in the image cache. */
5661
5662 void
5663 forall_images_in_image_cache (f, fn)
5664 struct frame *f;
5665 void (*fn) P_ ((struct image *img));
5666 {
5667 if (FRAME_LIVE_P (f) && FRAME_X_P (f))
5668 {
5669 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5670 if (c)
5671 {
5672 int i;
5673 for (i = 0; i < c->used; ++i)
5674 if (c->images[i])
5675 fn (c->images[i]);
5676 }
5677 }
5678 }
5679
5680
5681 \f
5682 /***********************************************************************
5683 X support code
5684 ***********************************************************************/
5685
5686 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
5687 XImage **, Pixmap *));
5688 static void x_destroy_x_image P_ ((XImage *));
5689 static void x_put_x_image P_ ((struct frame *, XImage *, Pixmap, int, int));
5690
5691
5692 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
5693 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
5694 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
5695 via xmalloc. Print error messages via image_error if an error
5696 occurs. Value is non-zero if successful. */
5697
5698 static int
5699 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
5700 struct frame *f;
5701 int width, height, depth;
5702 XImage **ximg;
5703 Pixmap *pixmap;
5704 {
5705 Display *display = FRAME_X_DISPLAY (f);
5706 Screen *screen = FRAME_X_SCREEN (f);
5707 Window window = FRAME_X_WINDOW (f);
5708
5709 xassert (interrupt_input_blocked);
5710
5711 if (depth <= 0)
5712 depth = DefaultDepthOfScreen (screen);
5713 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
5714 depth, ZPixmap, 0, NULL, width, height,
5715 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
5716 if (*ximg == NULL)
5717 {
5718 image_error ("Unable to allocate X image", Qnil, Qnil);
5719 return 0;
5720 }
5721
5722 /* Allocate image raster. */
5723 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
5724
5725 /* Allocate a pixmap of the same size. */
5726 *pixmap = XCreatePixmap (display, window, width, height, depth);
5727 if (*pixmap == 0)
5728 {
5729 x_destroy_x_image (*ximg);
5730 *ximg = NULL;
5731 image_error ("Unable to create X pixmap", Qnil, Qnil);
5732 return 0;
5733 }
5734
5735 return 1;
5736 }
5737
5738
5739 /* Destroy XImage XIMG. Free XIMG->data. */
5740
5741 static void
5742 x_destroy_x_image (ximg)
5743 XImage *ximg;
5744 {
5745 xassert (interrupt_input_blocked);
5746 if (ximg)
5747 {
5748 xfree (ximg->data);
5749 ximg->data = NULL;
5750 XDestroyImage (ximg);
5751 }
5752 }
5753
5754
5755 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
5756 are width and height of both the image and pixmap. */
5757
5758 static void
5759 x_put_x_image (f, ximg, pixmap, width, height)
5760 struct frame *f;
5761 XImage *ximg;
5762 Pixmap pixmap;
5763 {
5764 GC gc;
5765
5766 xassert (interrupt_input_blocked);
5767 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
5768 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
5769 XFreeGC (FRAME_X_DISPLAY (f), gc);
5770 }
5771
5772
5773 \f
5774 /***********************************************************************
5775 File Handling
5776 ***********************************************************************/
5777
5778 static Lisp_Object x_find_image_file P_ ((Lisp_Object));
5779 static char *slurp_file P_ ((char *, int *));
5780
5781
5782 /* Find image file FILE. Look in data-directory, then
5783 x-bitmap-file-path. Value is the full name of the file found, or
5784 nil if not found. */
5785
5786 static Lisp_Object
5787 x_find_image_file (file)
5788 Lisp_Object file;
5789 {
5790 Lisp_Object file_found, search_path;
5791 struct gcpro gcpro1, gcpro2;
5792 int fd;
5793
5794 file_found = Qnil;
5795 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
5796 GCPRO2 (file_found, search_path);
5797
5798 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
5799 fd = openp (search_path, file, "", &file_found, 0);
5800
5801 if (fd < 0)
5802 file_found = Qnil;
5803 else
5804 close (fd);
5805
5806 UNGCPRO;
5807 return file_found;
5808 }
5809
5810
5811 /* Read FILE into memory. Value is a pointer to a buffer allocated
5812 with xmalloc holding FILE's contents. Value is null if an error
5813 occured. *SIZE is set to the size of the file. */
5814
5815 static char *
5816 slurp_file (file, size)
5817 char *file;
5818 int *size;
5819 {
5820 FILE *fp = NULL;
5821 char *buf = NULL;
5822 struct stat st;
5823
5824 if (stat (file, &st) == 0
5825 && (fp = fopen (file, "r")) != NULL
5826 && (buf = (char *) xmalloc (st.st_size),
5827 fread (buf, 1, st.st_size, fp) == st.st_size))
5828 {
5829 *size = st.st_size;
5830 fclose (fp);
5831 }
5832 else
5833 {
5834 if (fp)
5835 fclose (fp);
5836 if (buf)
5837 {
5838 xfree (buf);
5839 buf = NULL;
5840 }
5841 }
5842
5843 return buf;
5844 }
5845
5846
5847 \f
5848 /***********************************************************************
5849 XBM images
5850 ***********************************************************************/
5851
5852 static int xbm_scan P_ ((char **, char *, char *, int *));
5853 static int xbm_load P_ ((struct frame *f, struct image *img));
5854 static int xbm_load_image P_ ((struct frame *f, struct image *img,
5855 char *, char *));
5856 static int xbm_image_p P_ ((Lisp_Object object));
5857 static int xbm_read_bitmap_data P_ ((char *, char *, int *, int *,
5858 unsigned char **));
5859 static int xbm_file_p P_ ((Lisp_Object));
5860
5861
5862 /* Indices of image specification fields in xbm_format, below. */
5863
5864 enum xbm_keyword_index
5865 {
5866 XBM_TYPE,
5867 XBM_FILE,
5868 XBM_WIDTH,
5869 XBM_HEIGHT,
5870 XBM_DATA,
5871 XBM_FOREGROUND,
5872 XBM_BACKGROUND,
5873 XBM_ASCENT,
5874 XBM_MARGIN,
5875 XBM_RELIEF,
5876 XBM_ALGORITHM,
5877 XBM_HEURISTIC_MASK,
5878 XBM_LAST
5879 };
5880
5881 /* Vector of image_keyword structures describing the format
5882 of valid XBM image specifications. */
5883
5884 static struct image_keyword xbm_format[XBM_LAST] =
5885 {
5886 {":type", IMAGE_SYMBOL_VALUE, 1},
5887 {":file", IMAGE_STRING_VALUE, 0},
5888 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
5889 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
5890 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5891 {":foreground", IMAGE_STRING_VALUE, 0},
5892 {":background", IMAGE_STRING_VALUE, 0},
5893 {":ascent", IMAGE_ASCENT_VALUE, 0},
5894 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
5895 {":relief", IMAGE_INTEGER_VALUE, 0},
5896 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
5897 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
5898 };
5899
5900 /* Structure describing the image type XBM. */
5901
5902 static struct image_type xbm_type =
5903 {
5904 &Qxbm,
5905 xbm_image_p,
5906 xbm_load,
5907 x_clear_image,
5908 NULL
5909 };
5910
5911 /* Tokens returned from xbm_scan. */
5912
5913 enum xbm_token
5914 {
5915 XBM_TK_IDENT = 256,
5916 XBM_TK_NUMBER
5917 };
5918
5919
5920 /* Return non-zero if OBJECT is a valid XBM-type image specification.
5921 A valid specification is a list starting with the symbol `image'
5922 The rest of the list is a property list which must contain an
5923 entry `:type xbm..
5924
5925 If the specification specifies a file to load, it must contain
5926 an entry `:file FILENAME' where FILENAME is a string.
5927
5928 If the specification is for a bitmap loaded from memory it must
5929 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
5930 WIDTH and HEIGHT are integers > 0. DATA may be:
5931
5932 1. a string large enough to hold the bitmap data, i.e. it must
5933 have a size >= (WIDTH + 7) / 8 * HEIGHT
5934
5935 2. a bool-vector of size >= WIDTH * HEIGHT
5936
5937 3. a vector of strings or bool-vectors, one for each line of the
5938 bitmap.
5939
5940 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
5941 may not be specified in this case because they are defined in the
5942 XBM file.
5943
5944 Both the file and data forms may contain the additional entries
5945 `:background COLOR' and `:foreground COLOR'. If not present,
5946 foreground and background of the frame on which the image is
5947 displayed is used. */
5948
5949 static int
5950 xbm_image_p (object)
5951 Lisp_Object object;
5952 {
5953 struct image_keyword kw[XBM_LAST];
5954
5955 bcopy (xbm_format, kw, sizeof kw);
5956 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
5957 return 0;
5958
5959 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
5960
5961 if (kw[XBM_FILE].count)
5962 {
5963 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
5964 return 0;
5965 }
5966 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
5967 {
5968 /* In-memory XBM file. */
5969 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
5970 return 0;
5971 }
5972 else
5973 {
5974 Lisp_Object data;
5975 int width, height;
5976
5977 /* Entries for `:width', `:height' and `:data' must be present. */
5978 if (!kw[XBM_WIDTH].count
5979 || !kw[XBM_HEIGHT].count
5980 || !kw[XBM_DATA].count)
5981 return 0;
5982
5983 data = kw[XBM_DATA].value;
5984 width = XFASTINT (kw[XBM_WIDTH].value);
5985 height = XFASTINT (kw[XBM_HEIGHT].value);
5986
5987 /* Check type of data, and width and height against contents of
5988 data. */
5989 if (VECTORP (data))
5990 {
5991 int i;
5992
5993 /* Number of elements of the vector must be >= height. */
5994 if (XVECTOR (data)->size < height)
5995 return 0;
5996
5997 /* Each string or bool-vector in data must be large enough
5998 for one line of the image. */
5999 for (i = 0; i < height; ++i)
6000 {
6001 Lisp_Object elt = XVECTOR (data)->contents[i];
6002
6003 if (STRINGP (elt))
6004 {
6005 if (XSTRING (elt)->size
6006 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
6007 return 0;
6008 }
6009 else if (BOOL_VECTOR_P (elt))
6010 {
6011 if (XBOOL_VECTOR (elt)->size < width)
6012 return 0;
6013 }
6014 else
6015 return 0;
6016 }
6017 }
6018 else if (STRINGP (data))
6019 {
6020 if (XSTRING (data)->size
6021 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
6022 return 0;
6023 }
6024 else if (BOOL_VECTOR_P (data))
6025 {
6026 if (XBOOL_VECTOR (data)->size < width * height)
6027 return 0;
6028 }
6029 else
6030 return 0;
6031 }
6032
6033 return 1;
6034 }
6035
6036
6037 /* Scan a bitmap file. FP is the stream to read from. Value is
6038 either an enumerator from enum xbm_token, or a character for a
6039 single-character token, or 0 at end of file. If scanning an
6040 identifier, store the lexeme of the identifier in SVAL. If
6041 scanning a number, store its value in *IVAL. */
6042
6043 static int
6044 xbm_scan (s, end, sval, ival)
6045 char **s, *end;
6046 char *sval;
6047 int *ival;
6048 {
6049 int c;
6050
6051 /* Skip white space. */
6052 while (*s < end && (c = *(*s)++, isspace (c)))
6053 ;
6054
6055 if (*s >= end)
6056 c = 0;
6057 else if (isdigit (c))
6058 {
6059 int value = 0, digit;
6060
6061 if (c == '0' && *s < end)
6062 {
6063 c = *(*s)++;
6064 if (c == 'x' || c == 'X')
6065 {
6066 while (*s < end)
6067 {
6068 c = *(*s)++;
6069 if (isdigit (c))
6070 digit = c - '0';
6071 else if (c >= 'a' && c <= 'f')
6072 digit = c - 'a' + 10;
6073 else if (c >= 'A' && c <= 'F')
6074 digit = c - 'A' + 10;
6075 else
6076 break;
6077 value = 16 * value + digit;
6078 }
6079 }
6080 else if (isdigit (c))
6081 {
6082 value = c - '0';
6083 while (*s < end
6084 && (c = *(*s)++, isdigit (c)))
6085 value = 8 * value + c - '0';
6086 }
6087 }
6088 else
6089 {
6090 value = c - '0';
6091 while (*s < end
6092 && (c = *(*s)++, isdigit (c)))
6093 value = 10 * value + c - '0';
6094 }
6095
6096 if (*s < end)
6097 *s = *s - 1;
6098 *ival = value;
6099 c = XBM_TK_NUMBER;
6100 }
6101 else if (isalpha (c) || c == '_')
6102 {
6103 *sval++ = c;
6104 while (*s < end
6105 && (c = *(*s)++, (isalnum (c) || c == '_')))
6106 *sval++ = c;
6107 *sval = 0;
6108 if (*s < end)
6109 *s = *s - 1;
6110 c = XBM_TK_IDENT;
6111 }
6112
6113 return c;
6114 }
6115
6116
6117 /* Replacement for XReadBitmapFileData which isn't available under old
6118 X versions. CONTENTS is a pointer to a buffer to parse; END is the
6119 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
6120 the image. Return in *DATA the bitmap data allocated with xmalloc.
6121 Value is non-zero if successful. DATA null means just test if
6122 CONTENTS looks like an im-memory XBM file. */
6123
6124 static int
6125 xbm_read_bitmap_data (contents, end, width, height, data)
6126 char *contents, *end;
6127 int *width, *height;
6128 unsigned char **data;
6129 {
6130 char *s = contents;
6131 char buffer[BUFSIZ];
6132 int padding_p = 0;
6133 int v10 = 0;
6134 int bytes_per_line, i, nbytes;
6135 unsigned char *p;
6136 int value;
6137 int LA1;
6138
6139 #define match() \
6140 LA1 = xbm_scan (&s, end, buffer, &value)
6141
6142 #define expect(TOKEN) \
6143 if (LA1 != (TOKEN)) \
6144 goto failure; \
6145 else \
6146 match ()
6147
6148 #define expect_ident(IDENT) \
6149 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
6150 match (); \
6151 else \
6152 goto failure
6153
6154 *width = *height = -1;
6155 if (data)
6156 *data = NULL;
6157 LA1 = xbm_scan (&s, end, buffer, &value);
6158
6159 /* Parse defines for width, height and hot-spots. */
6160 while (LA1 == '#')
6161 {
6162 match ();
6163 expect_ident ("define");
6164 expect (XBM_TK_IDENT);
6165
6166 if (LA1 == XBM_TK_NUMBER);
6167 {
6168 char *p = strrchr (buffer, '_');
6169 p = p ? p + 1 : buffer;
6170 if (strcmp (p, "width") == 0)
6171 *width = value;
6172 else if (strcmp (p, "height") == 0)
6173 *height = value;
6174 }
6175 expect (XBM_TK_NUMBER);
6176 }
6177
6178 if (*width < 0 || *height < 0)
6179 goto failure;
6180 else if (data == NULL)
6181 goto success;
6182
6183 /* Parse bits. Must start with `static'. */
6184 expect_ident ("static");
6185 if (LA1 == XBM_TK_IDENT)
6186 {
6187 if (strcmp (buffer, "unsigned") == 0)
6188 {
6189 match ();
6190 expect_ident ("char");
6191 }
6192 else if (strcmp (buffer, "short") == 0)
6193 {
6194 match ();
6195 v10 = 1;
6196 if (*width % 16 && *width % 16 < 9)
6197 padding_p = 1;
6198 }
6199 else if (strcmp (buffer, "char") == 0)
6200 match ();
6201 else
6202 goto failure;
6203 }
6204 else
6205 goto failure;
6206
6207 expect (XBM_TK_IDENT);
6208 expect ('[');
6209 expect (']');
6210 expect ('=');
6211 expect ('{');
6212
6213 bytes_per_line = (*width + 7) / 8 + padding_p;
6214 nbytes = bytes_per_line * *height;
6215 p = *data = (char *) xmalloc (nbytes);
6216
6217 if (v10)
6218 {
6219 for (i = 0; i < nbytes; i += 2)
6220 {
6221 int val = value;
6222 expect (XBM_TK_NUMBER);
6223
6224 *p++ = val;
6225 if (!padding_p || ((i + 2) % bytes_per_line))
6226 *p++ = value >> 8;
6227
6228 if (LA1 == ',' || LA1 == '}')
6229 match ();
6230 else
6231 goto failure;
6232 }
6233 }
6234 else
6235 {
6236 for (i = 0; i < nbytes; ++i)
6237 {
6238 int val = value;
6239 expect (XBM_TK_NUMBER);
6240
6241 *p++ = val;
6242
6243 if (LA1 == ',' || LA1 == '}')
6244 match ();
6245 else
6246 goto failure;
6247 }
6248 }
6249
6250 success:
6251 return 1;
6252
6253 failure:
6254
6255 if (data && *data)
6256 {
6257 xfree (*data);
6258 *data = NULL;
6259 }
6260 return 0;
6261
6262 #undef match
6263 #undef expect
6264 #undef expect_ident
6265 }
6266
6267
6268 /* Load XBM image IMG which will be displayed on frame F from buffer
6269 CONTENTS. END is the end of the buffer. Value is non-zero if
6270 successful. */
6271
6272 static int
6273 xbm_load_image (f, img, contents, end)
6274 struct frame *f;
6275 struct image *img;
6276 char *contents, *end;
6277 {
6278 int rc;
6279 unsigned char *data;
6280 int success_p = 0;
6281
6282 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
6283 if (rc)
6284 {
6285 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6286 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6287 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6288 Lisp_Object value;
6289
6290 xassert (img->width > 0 && img->height > 0);
6291
6292 /* Get foreground and background colors, maybe allocate colors. */
6293 value = image_spec_value (img->spec, QCforeground, NULL);
6294 if (!NILP (value))
6295 foreground = x_alloc_image_color (f, img, value, foreground);
6296
6297 value = image_spec_value (img->spec, QCbackground, NULL);
6298 if (!NILP (value))
6299 background = x_alloc_image_color (f, img, value, background);
6300
6301 BLOCK_INPUT;
6302 img->pixmap
6303 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6304 FRAME_X_WINDOW (f),
6305 data,
6306 img->width, img->height,
6307 foreground, background,
6308 depth);
6309 xfree (data);
6310
6311 if (img->pixmap == 0)
6312 {
6313 x_clear_image (f, img);
6314 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
6315 }
6316 else
6317 success_p = 1;
6318
6319 UNBLOCK_INPUT;
6320 }
6321 else
6322 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6323
6324 return success_p;
6325 }
6326
6327
6328 /* Value is non-zero if DATA looks like an in-memory XBM file. */
6329
6330 static int
6331 xbm_file_p (data)
6332 Lisp_Object data;
6333 {
6334 int w, h;
6335 return (STRINGP (data)
6336 && xbm_read_bitmap_data (XSTRING (data)->data,
6337 (XSTRING (data)->data
6338 + STRING_BYTES (XSTRING (data))),
6339 &w, &h, NULL));
6340 }
6341
6342
6343 /* Fill image IMG which is used on frame F with pixmap data. Value is
6344 non-zero if successful. */
6345
6346 static int
6347 xbm_load (f, img)
6348 struct frame *f;
6349 struct image *img;
6350 {
6351 int success_p = 0;
6352 Lisp_Object file_name;
6353
6354 xassert (xbm_image_p (img->spec));
6355
6356 /* If IMG->spec specifies a file name, create a non-file spec from it. */
6357 file_name = image_spec_value (img->spec, QCfile, NULL);
6358 if (STRINGP (file_name))
6359 {
6360 Lisp_Object file;
6361 char *contents;
6362 int size;
6363 struct gcpro gcpro1;
6364
6365 file = x_find_image_file (file_name);
6366 GCPRO1 (file);
6367 if (!STRINGP (file))
6368 {
6369 image_error ("Cannot find image file `%s'", file_name, Qnil);
6370 UNGCPRO;
6371 return 0;
6372 }
6373
6374 contents = slurp_file (XSTRING (file)->data, &size);
6375 if (contents == NULL)
6376 {
6377 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6378 UNGCPRO;
6379 return 0;
6380 }
6381
6382 success_p = xbm_load_image (f, img, contents, contents + size);
6383 UNGCPRO;
6384 }
6385 else
6386 {
6387 struct image_keyword fmt[XBM_LAST];
6388 Lisp_Object data;
6389 unsigned char *bitmap_data;
6390 int depth;
6391 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6392 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6393 char *bits;
6394 int parsed_p, height, width;
6395 int in_memory_file_p = 0;
6396
6397 /* See if data looks like an in-memory XBM file. */
6398 data = image_spec_value (img->spec, QCdata, NULL);
6399 in_memory_file_p = xbm_file_p (data);
6400
6401 /* Parse the image specification. */
6402 bcopy (xbm_format, fmt, sizeof fmt);
6403 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
6404 xassert (parsed_p);
6405
6406 /* Get specified width, and height. */
6407 if (!in_memory_file_p)
6408 {
6409 img->width = XFASTINT (fmt[XBM_WIDTH].value);
6410 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
6411 xassert (img->width > 0 && img->height > 0);
6412 }
6413
6414 BLOCK_INPUT;
6415
6416 /* Get foreground and background colors, maybe allocate colors. */
6417 if (fmt[XBM_FOREGROUND].count)
6418 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
6419 foreground);
6420 if (fmt[XBM_BACKGROUND].count)
6421 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
6422 background);
6423
6424 if (in_memory_file_p)
6425 success_p = xbm_load_image (f, img, XSTRING (data)->data,
6426 (XSTRING (data)->data
6427 + STRING_BYTES (XSTRING (data))));
6428 else
6429 {
6430 if (VECTORP (data))
6431 {
6432 int i;
6433 char *p;
6434 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
6435
6436 p = bits = (char *) alloca (nbytes * img->height);
6437 for (i = 0; i < img->height; ++i, p += nbytes)
6438 {
6439 Lisp_Object line = XVECTOR (data)->contents[i];
6440 if (STRINGP (line))
6441 bcopy (XSTRING (line)->data, p, nbytes);
6442 else
6443 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
6444 }
6445 }
6446 else if (STRINGP (data))
6447 bits = XSTRING (data)->data;
6448 else
6449 bits = XBOOL_VECTOR (data)->data;
6450
6451 /* Create the pixmap. */
6452 depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6453 img->pixmap
6454 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6455 FRAME_X_WINDOW (f),
6456 bits,
6457 img->width, img->height,
6458 foreground, background,
6459 depth);
6460 if (img->pixmap)
6461 success_p = 1;
6462 else
6463 {
6464 image_error ("Unable to create pixmap for XBM image `%s'",
6465 img->spec, Qnil);
6466 x_clear_image (f, img);
6467 }
6468 }
6469
6470 UNBLOCK_INPUT;
6471 }
6472
6473 return success_p;
6474 }
6475
6476
6477 \f
6478 /***********************************************************************
6479 XPM images
6480 ***********************************************************************/
6481
6482 #if HAVE_XPM
6483
6484 static int xpm_image_p P_ ((Lisp_Object object));
6485 static int xpm_load P_ ((struct frame *f, struct image *img));
6486 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
6487
6488 #include "X11/xpm.h"
6489
6490 /* The symbol `xpm' identifying XPM-format images. */
6491
6492 Lisp_Object Qxpm;
6493
6494 /* Indices of image specification fields in xpm_format, below. */
6495
6496 enum xpm_keyword_index
6497 {
6498 XPM_TYPE,
6499 XPM_FILE,
6500 XPM_DATA,
6501 XPM_ASCENT,
6502 XPM_MARGIN,
6503 XPM_RELIEF,
6504 XPM_ALGORITHM,
6505 XPM_HEURISTIC_MASK,
6506 XPM_COLOR_SYMBOLS,
6507 XPM_LAST
6508 };
6509
6510 /* Vector of image_keyword structures describing the format
6511 of valid XPM image specifications. */
6512
6513 static struct image_keyword xpm_format[XPM_LAST] =
6514 {
6515 {":type", IMAGE_SYMBOL_VALUE, 1},
6516 {":file", IMAGE_STRING_VALUE, 0},
6517 {":data", IMAGE_STRING_VALUE, 0},
6518 {":ascent", IMAGE_ASCENT_VALUE, 0},
6519 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6520 {":relief", IMAGE_INTEGER_VALUE, 0},
6521 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6522 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6523 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
6524 };
6525
6526 /* Structure describing the image type XBM. */
6527
6528 static struct image_type xpm_type =
6529 {
6530 &Qxpm,
6531 xpm_image_p,
6532 xpm_load,
6533 x_clear_image,
6534 NULL
6535 };
6536
6537
6538 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
6539 for XPM images. Such a list must consist of conses whose car and
6540 cdr are strings. */
6541
6542 static int
6543 xpm_valid_color_symbols_p (color_symbols)
6544 Lisp_Object color_symbols;
6545 {
6546 while (CONSP (color_symbols))
6547 {
6548 Lisp_Object sym = XCAR (color_symbols);
6549 if (!CONSP (sym)
6550 || !STRINGP (XCAR (sym))
6551 || !STRINGP (XCDR (sym)))
6552 break;
6553 color_symbols = XCDR (color_symbols);
6554 }
6555
6556 return NILP (color_symbols);
6557 }
6558
6559
6560 /* Value is non-zero if OBJECT is a valid XPM image specification. */
6561
6562 static int
6563 xpm_image_p (object)
6564 Lisp_Object object;
6565 {
6566 struct image_keyword fmt[XPM_LAST];
6567 bcopy (xpm_format, fmt, sizeof fmt);
6568 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
6569 /* Either `:file' or `:data' must be present. */
6570 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
6571 /* Either no `:color-symbols' or it's a list of conses
6572 whose car and cdr are strings. */
6573 && (fmt[XPM_COLOR_SYMBOLS].count == 0
6574 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
6575 }
6576
6577
6578 /* Load image IMG which will be displayed on frame F. Value is
6579 non-zero if successful. */
6580
6581 static int
6582 xpm_load (f, img)
6583 struct frame *f;
6584 struct image *img;
6585 {
6586 int rc, i;
6587 XpmAttributes attrs;
6588 Lisp_Object specified_file, color_symbols;
6589
6590 /* Configure the XPM lib. Use the visual of frame F. Allocate
6591 close colors. Return colors allocated. */
6592 bzero (&attrs, sizeof attrs);
6593 attrs.visual = FRAME_X_VISUAL (f);
6594 attrs.colormap = FRAME_X_COLORMAP (f);
6595 attrs.valuemask |= XpmVisual;
6596 attrs.valuemask |= XpmColormap;
6597 attrs.valuemask |= XpmReturnAllocPixels;
6598 #ifdef XpmAllocCloseColors
6599 attrs.alloc_close_colors = 1;
6600 attrs.valuemask |= XpmAllocCloseColors;
6601 #else
6602 attrs.closeness = 600;
6603 attrs.valuemask |= XpmCloseness;
6604 #endif
6605
6606 /* If image specification contains symbolic color definitions, add
6607 these to `attrs'. */
6608 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
6609 if (CONSP (color_symbols))
6610 {
6611 Lisp_Object tail;
6612 XpmColorSymbol *xpm_syms;
6613 int i, size;
6614
6615 attrs.valuemask |= XpmColorSymbols;
6616
6617 /* Count number of symbols. */
6618 attrs.numsymbols = 0;
6619 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
6620 ++attrs.numsymbols;
6621
6622 /* Allocate an XpmColorSymbol array. */
6623 size = attrs.numsymbols * sizeof *xpm_syms;
6624 xpm_syms = (XpmColorSymbol *) alloca (size);
6625 bzero (xpm_syms, size);
6626 attrs.colorsymbols = xpm_syms;
6627
6628 /* Fill the color symbol array. */
6629 for (tail = color_symbols, i = 0;
6630 CONSP (tail);
6631 ++i, tail = XCDR (tail))
6632 {
6633 Lisp_Object name = XCAR (XCAR (tail));
6634 Lisp_Object color = XCDR (XCAR (tail));
6635 xpm_syms[i].name = (char *) alloca (XSTRING (name)->size + 1);
6636 strcpy (xpm_syms[i].name, XSTRING (name)->data);
6637 xpm_syms[i].value = (char *) alloca (XSTRING (color)->size + 1);
6638 strcpy (xpm_syms[i].value, XSTRING (color)->data);
6639 }
6640 }
6641
6642 /* Create a pixmap for the image, either from a file, or from a
6643 string buffer containing data in the same format as an XPM file. */
6644 BLOCK_INPUT;
6645 specified_file = image_spec_value (img->spec, QCfile, NULL);
6646 if (STRINGP (specified_file))
6647 {
6648 Lisp_Object file = x_find_image_file (specified_file);
6649 if (!STRINGP (file))
6650 {
6651 image_error ("Cannot find image file `%s'", specified_file, Qnil);
6652 UNBLOCK_INPUT;
6653 return 0;
6654 }
6655
6656 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
6657 XSTRING (file)->data, &img->pixmap, &img->mask,
6658 &attrs);
6659 }
6660 else
6661 {
6662 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
6663 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
6664 XSTRING (buffer)->data,
6665 &img->pixmap, &img->mask,
6666 &attrs);
6667 }
6668 UNBLOCK_INPUT;
6669
6670 if (rc == XpmSuccess)
6671 {
6672 /* Remember allocated colors. */
6673 img->ncolors = attrs.nalloc_pixels;
6674 img->colors = (unsigned long *) xmalloc (img->ncolors
6675 * sizeof *img->colors);
6676 for (i = 0; i < attrs.nalloc_pixels; ++i)
6677 {
6678 img->colors[i] = attrs.alloc_pixels[i];
6679 #ifdef DEBUG_X_COLORS
6680 register_color (img->colors[i]);
6681 #endif
6682 }
6683
6684 img->width = attrs.width;
6685 img->height = attrs.height;
6686 xassert (img->width > 0 && img->height > 0);
6687
6688 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
6689 BLOCK_INPUT;
6690 XpmFreeAttributes (&attrs);
6691 UNBLOCK_INPUT;
6692 }
6693 else
6694 {
6695 switch (rc)
6696 {
6697 case XpmOpenFailed:
6698 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
6699 break;
6700
6701 case XpmFileInvalid:
6702 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
6703 break;
6704
6705 case XpmNoMemory:
6706 image_error ("Out of memory (%s)", img->spec, Qnil);
6707 break;
6708
6709 case XpmColorFailed:
6710 image_error ("Color allocation error (%s)", img->spec, Qnil);
6711 break;
6712
6713 default:
6714 image_error ("Unknown error (%s)", img->spec, Qnil);
6715 break;
6716 }
6717 }
6718
6719 return rc == XpmSuccess;
6720 }
6721
6722 #endif /* HAVE_XPM != 0 */
6723
6724 \f
6725 /***********************************************************************
6726 Color table
6727 ***********************************************************************/
6728
6729 /* An entry in the color table mapping an RGB color to a pixel color. */
6730
6731 struct ct_color
6732 {
6733 int r, g, b;
6734 unsigned long pixel;
6735
6736 /* Next in color table collision list. */
6737 struct ct_color *next;
6738 };
6739
6740 /* The bucket vector size to use. Must be prime. */
6741
6742 #define CT_SIZE 101
6743
6744 /* Value is a hash of the RGB color given by R, G, and B. */
6745
6746 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
6747
6748 /* The color hash table. */
6749
6750 struct ct_color **ct_table;
6751
6752 /* Number of entries in the color table. */
6753
6754 int ct_colors_allocated;
6755
6756 /* Function prototypes. */
6757
6758 static void init_color_table P_ ((void));
6759 static void free_color_table P_ ((void));
6760 static unsigned long *colors_in_color_table P_ ((int *n));
6761 static unsigned long lookup_rgb_color P_ ((struct frame *f, int r, int g, int b));
6762 static unsigned long lookup_pixel_color P_ ((struct frame *f, unsigned long p));
6763
6764
6765 /* Initialize the color table. */
6766
6767 static void
6768 init_color_table ()
6769 {
6770 int size = CT_SIZE * sizeof (*ct_table);
6771 ct_table = (struct ct_color **) xmalloc (size);
6772 bzero (ct_table, size);
6773 ct_colors_allocated = 0;
6774 }
6775
6776
6777 /* Free memory associated with the color table. */
6778
6779 static void
6780 free_color_table ()
6781 {
6782 int i;
6783 struct ct_color *p, *next;
6784
6785 for (i = 0; i < CT_SIZE; ++i)
6786 for (p = ct_table[i]; p; p = next)
6787 {
6788 next = p->next;
6789 xfree (p);
6790 }
6791
6792 xfree (ct_table);
6793 ct_table = NULL;
6794 }
6795
6796
6797 /* Value is a pixel color for RGB color R, G, B on frame F. If an
6798 entry for that color already is in the color table, return the
6799 pixel color of that entry. Otherwise, allocate a new color for R,
6800 G, B, and make an entry in the color table. */
6801
6802 static unsigned long
6803 lookup_rgb_color (f, r, g, b)
6804 struct frame *f;
6805 int r, g, b;
6806 {
6807 unsigned hash = CT_HASH_RGB (r, g, b);
6808 int i = hash % CT_SIZE;
6809 struct ct_color *p;
6810
6811 for (p = ct_table[i]; p; p = p->next)
6812 if (p->r == r && p->g == g && p->b == b)
6813 break;
6814
6815 if (p == NULL)
6816 {
6817 XColor color;
6818 Colormap cmap;
6819 int rc;
6820
6821 color.red = r;
6822 color.green = g;
6823 color.blue = b;
6824
6825 BLOCK_INPUT;
6826 cmap = FRAME_X_COLORMAP (f);
6827 rc = x_alloc_nearest_color (f, cmap, &color);
6828 UNBLOCK_INPUT;
6829
6830 if (rc)
6831 {
6832 ++ct_colors_allocated;
6833
6834 p = (struct ct_color *) xmalloc (sizeof *p);
6835 p->r = r;
6836 p->g = g;
6837 p->b = b;
6838 p->pixel = color.pixel;
6839 p->next = ct_table[i];
6840 ct_table[i] = p;
6841 }
6842 else
6843 return FRAME_FOREGROUND_PIXEL (f);
6844 }
6845
6846 return p->pixel;
6847 }
6848
6849
6850 /* Look up pixel color PIXEL which is used on frame F in the color
6851 table. If not already present, allocate it. Value is PIXEL. */
6852
6853 static unsigned long
6854 lookup_pixel_color (f, pixel)
6855 struct frame *f;
6856 unsigned long pixel;
6857 {
6858 int i = pixel % CT_SIZE;
6859 struct ct_color *p;
6860
6861 for (p = ct_table[i]; p; p = p->next)
6862 if (p->pixel == pixel)
6863 break;
6864
6865 if (p == NULL)
6866 {
6867 XColor color;
6868 Colormap cmap;
6869 int rc;
6870
6871 BLOCK_INPUT;
6872
6873 cmap = FRAME_X_COLORMAP (f);
6874 color.pixel = pixel;
6875 XQueryColor (FRAME_X_DISPLAY (f), cmap, &color);
6876 rc = x_alloc_nearest_color (f, cmap, &color);
6877 UNBLOCK_INPUT;
6878
6879 if (rc)
6880 {
6881 ++ct_colors_allocated;
6882
6883 p = (struct ct_color *) xmalloc (sizeof *p);
6884 p->r = color.red;
6885 p->g = color.green;
6886 p->b = color.blue;
6887 p->pixel = pixel;
6888 p->next = ct_table[i];
6889 ct_table[i] = p;
6890 }
6891 else
6892 return FRAME_FOREGROUND_PIXEL (f);
6893 }
6894
6895 return p->pixel;
6896 }
6897
6898
6899 /* Value is a vector of all pixel colors contained in the color table,
6900 allocated via xmalloc. Set *N to the number of colors. */
6901
6902 static unsigned long *
6903 colors_in_color_table (n)
6904 int *n;
6905 {
6906 int i, j;
6907 struct ct_color *p;
6908 unsigned long *colors;
6909
6910 if (ct_colors_allocated == 0)
6911 {
6912 *n = 0;
6913 colors = NULL;
6914 }
6915 else
6916 {
6917 colors = (unsigned long *) xmalloc (ct_colors_allocated
6918 * sizeof *colors);
6919 *n = ct_colors_allocated;
6920
6921 for (i = j = 0; i < CT_SIZE; ++i)
6922 for (p = ct_table[i]; p; p = p->next)
6923 colors[j++] = p->pixel;
6924 }
6925
6926 return colors;
6927 }
6928
6929
6930 \f
6931 /***********************************************************************
6932 Algorithms
6933 ***********************************************************************/
6934
6935 static void x_laplace_write_row P_ ((struct frame *, long *,
6936 int, XImage *, int));
6937 static void x_laplace_read_row P_ ((struct frame *, Colormap,
6938 XColor *, int, XImage *, int));
6939
6940
6941 /* Fill COLORS with RGB colors from row Y of image XIMG. F is the
6942 frame we operate on, CMAP is the color-map in effect, and WIDTH is
6943 the width of one row in the image. */
6944
6945 static void
6946 x_laplace_read_row (f, cmap, colors, width, ximg, y)
6947 struct frame *f;
6948 Colormap cmap;
6949 XColor *colors;
6950 int width;
6951 XImage *ximg;
6952 int y;
6953 {
6954 int x;
6955
6956 for (x = 0; x < width; ++x)
6957 colors[x].pixel = XGetPixel (ximg, x, y);
6958
6959 XQueryColors (FRAME_X_DISPLAY (f), cmap, colors, width);
6960 }
6961
6962
6963 /* Write row Y of image XIMG. PIXELS is an array of WIDTH longs
6964 containing the pixel colors to write. F is the frame we are
6965 working on. */
6966
6967 static void
6968 x_laplace_write_row (f, pixels, width, ximg, y)
6969 struct frame *f;
6970 long *pixels;
6971 int width;
6972 XImage *ximg;
6973 int y;
6974 {
6975 int x;
6976
6977 for (x = 0; x < width; ++x)
6978 XPutPixel (ximg, x, y, pixels[x]);
6979 }
6980
6981
6982 /* Transform image IMG which is used on frame F with a Laplace
6983 edge-detection algorithm. The result is an image that can be used
6984 to draw disabled buttons, for example. */
6985
6986 static void
6987 x_laplace (f, img)
6988 struct frame *f;
6989 struct image *img;
6990 {
6991 Colormap cmap = FRAME_X_COLORMAP (f);
6992 XImage *ximg, *oimg;
6993 XColor *in[3];
6994 long *out;
6995 Pixmap pixmap;
6996 int x, y, i;
6997 long pixel;
6998 int in_y, out_y, rc;
6999 int mv2 = 45000;
7000
7001 BLOCK_INPUT;
7002
7003 /* Get the X image IMG->pixmap. */
7004 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
7005 0, 0, img->width, img->height, ~0, ZPixmap);
7006
7007 /* Allocate 3 input rows, and one output row of colors. */
7008 for (i = 0; i < 3; ++i)
7009 in[i] = (XColor *) alloca (img->width * sizeof (XColor));
7010 out = (long *) alloca (img->width * sizeof (long));
7011
7012 /* Create an X image for output. */
7013 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 0,
7014 &oimg, &pixmap);
7015
7016 /* Fill first two rows. */
7017 x_laplace_read_row (f, cmap, in[0], img->width, ximg, 0);
7018 x_laplace_read_row (f, cmap, in[1], img->width, ximg, 1);
7019 in_y = 2;
7020
7021 /* Write first row, all zeros. */
7022 init_color_table ();
7023 pixel = lookup_rgb_color (f, 0, 0, 0);
7024 for (x = 0; x < img->width; ++x)
7025 out[x] = pixel;
7026 x_laplace_write_row (f, out, img->width, oimg, 0);
7027 out_y = 1;
7028
7029 for (y = 2; y < img->height; ++y)
7030 {
7031 int rowa = y % 3;
7032 int rowb = (y + 2) % 3;
7033
7034 x_laplace_read_row (f, cmap, in[rowa], img->width, ximg, in_y++);
7035
7036 for (x = 0; x < img->width - 2; ++x)
7037 {
7038 int r = in[rowa][x].red + mv2 - in[rowb][x + 2].red;
7039 int g = in[rowa][x].green + mv2 - in[rowb][x + 2].green;
7040 int b = in[rowa][x].blue + mv2 - in[rowb][x + 2].blue;
7041
7042 out[x + 1] = lookup_rgb_color (f, r & 0xffff, g & 0xffff,
7043 b & 0xffff);
7044 }
7045
7046 x_laplace_write_row (f, out, img->width, oimg, out_y++);
7047 }
7048
7049 /* Write last line, all zeros. */
7050 for (x = 0; x < img->width; ++x)
7051 out[x] = pixel;
7052 x_laplace_write_row (f, out, img->width, oimg, out_y);
7053
7054 /* Free the input image, and free resources of IMG. */
7055 XDestroyImage (ximg);
7056 x_clear_image (f, img);
7057
7058 /* Put the output image into pixmap, and destroy it. */
7059 x_put_x_image (f, oimg, pixmap, img->width, img->height);
7060 x_destroy_x_image (oimg);
7061
7062 /* Remember new pixmap and colors in IMG. */
7063 img->pixmap = pixmap;
7064 img->colors = colors_in_color_table (&img->ncolors);
7065 free_color_table ();
7066
7067 UNBLOCK_INPUT;
7068 }
7069
7070
7071 /* Build a mask for image IMG which is used on frame F. FILE is the
7072 name of an image file, for error messages. HOW determines how to
7073 determine the background color of IMG. If it is a list '(R G B)',
7074 with R, G, and B being integers >= 0, take that as the color of the
7075 background. Otherwise, determine the background color of IMG
7076 heuristically. Value is non-zero if successful. */
7077
7078 static int
7079 x_build_heuristic_mask (f, img, how)
7080 struct frame *f;
7081 struct image *img;
7082 Lisp_Object how;
7083 {
7084 Display *dpy = FRAME_X_DISPLAY (f);
7085 XImage *ximg, *mask_img;
7086 int x, y, rc, look_at_corners_p;
7087 unsigned long bg;
7088
7089 BLOCK_INPUT;
7090
7091 /* Create an image and pixmap serving as mask. */
7092 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
7093 &mask_img, &img->mask);
7094 if (!rc)
7095 {
7096 UNBLOCK_INPUT;
7097 return 0;
7098 }
7099
7100 /* Get the X image of IMG->pixmap. */
7101 ximg = XGetImage (dpy, img->pixmap, 0, 0, img->width, img->height,
7102 ~0, ZPixmap);
7103
7104 /* Determine the background color of ximg. If HOW is `(R G B)'
7105 take that as color. Otherwise, try to determine the color
7106 heuristically. */
7107 look_at_corners_p = 1;
7108
7109 if (CONSP (how))
7110 {
7111 int rgb[3], i = 0;
7112
7113 while (i < 3
7114 && CONSP (how)
7115 && NATNUMP (XCAR (how)))
7116 {
7117 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
7118 how = XCDR (how);
7119 }
7120
7121 if (i == 3 && NILP (how))
7122 {
7123 char color_name[30];
7124 XColor exact, color;
7125 Colormap cmap;
7126
7127 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
7128
7129 cmap = FRAME_X_COLORMAP (f);
7130 if (XLookupColor (dpy, cmap, color_name, &exact, &color))
7131 {
7132 bg = color.pixel;
7133 look_at_corners_p = 0;
7134 }
7135 }
7136 }
7137
7138 if (look_at_corners_p)
7139 {
7140 unsigned long corners[4];
7141 int i, best_count;
7142
7143 /* Get the colors at the corners of ximg. */
7144 corners[0] = XGetPixel (ximg, 0, 0);
7145 corners[1] = XGetPixel (ximg, img->width - 1, 0);
7146 corners[2] = XGetPixel (ximg, img->width - 1, img->height - 1);
7147 corners[3] = XGetPixel (ximg, 0, img->height - 1);
7148
7149 /* Choose the most frequently found color as background. */
7150 for (i = best_count = 0; i < 4; ++i)
7151 {
7152 int j, n;
7153
7154 for (j = n = 0; j < 4; ++j)
7155 if (corners[i] == corners[j])
7156 ++n;
7157
7158 if (n > best_count)
7159 bg = corners[i], best_count = n;
7160 }
7161 }
7162
7163 /* Set all bits in mask_img to 1 whose color in ximg is different
7164 from the background color bg. */
7165 for (y = 0; y < img->height; ++y)
7166 for (x = 0; x < img->width; ++x)
7167 XPutPixel (mask_img, x, y, XGetPixel (ximg, x, y) != bg);
7168
7169 /* Put mask_img into img->mask. */
7170 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
7171 x_destroy_x_image (mask_img);
7172 XDestroyImage (ximg);
7173
7174 UNBLOCK_INPUT;
7175 return 1;
7176 }
7177
7178
7179 \f
7180 /***********************************************************************
7181 PBM (mono, gray, color)
7182 ***********************************************************************/
7183
7184 static int pbm_image_p P_ ((Lisp_Object object));
7185 static int pbm_load P_ ((struct frame *f, struct image *img));
7186 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
7187
7188 /* The symbol `pbm' identifying images of this type. */
7189
7190 Lisp_Object Qpbm;
7191
7192 /* Indices of image specification fields in gs_format, below. */
7193
7194 enum pbm_keyword_index
7195 {
7196 PBM_TYPE,
7197 PBM_FILE,
7198 PBM_DATA,
7199 PBM_ASCENT,
7200 PBM_MARGIN,
7201 PBM_RELIEF,
7202 PBM_ALGORITHM,
7203 PBM_HEURISTIC_MASK,
7204 PBM_LAST
7205 };
7206
7207 /* Vector of image_keyword structures describing the format
7208 of valid user-defined image specifications. */
7209
7210 static struct image_keyword pbm_format[PBM_LAST] =
7211 {
7212 {":type", IMAGE_SYMBOL_VALUE, 1},
7213 {":file", IMAGE_STRING_VALUE, 0},
7214 {":data", IMAGE_STRING_VALUE, 0},
7215 {":ascent", IMAGE_ASCENT_VALUE, 0},
7216 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
7217 {":relief", IMAGE_INTEGER_VALUE, 0},
7218 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7219 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
7220 };
7221
7222 /* Structure describing the image type `pbm'. */
7223
7224 static struct image_type pbm_type =
7225 {
7226 &Qpbm,
7227 pbm_image_p,
7228 pbm_load,
7229 x_clear_image,
7230 NULL
7231 };
7232
7233
7234 /* Return non-zero if OBJECT is a valid PBM image specification. */
7235
7236 static int
7237 pbm_image_p (object)
7238 Lisp_Object object;
7239 {
7240 struct image_keyword fmt[PBM_LAST];
7241
7242 bcopy (pbm_format, fmt, sizeof fmt);
7243
7244 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
7245 return 0;
7246
7247 /* Must specify either :data or :file. */
7248 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
7249 }
7250
7251
7252 /* Scan a decimal number from *S and return it. Advance *S while
7253 reading the number. END is the end of the string. Value is -1 at
7254 end of input. */
7255
7256 static int
7257 pbm_scan_number (s, end)
7258 unsigned char **s, *end;
7259 {
7260 int c, val = -1;
7261
7262 while (*s < end)
7263 {
7264 /* Skip white-space. */
7265 while (*s < end && (c = *(*s)++, isspace (c)))
7266 ;
7267
7268 if (c == '#')
7269 {
7270 /* Skip comment to end of line. */
7271 while (*s < end && (c = *(*s)++, c != '\n'))
7272 ;
7273 }
7274 else if (isdigit (c))
7275 {
7276 /* Read decimal number. */
7277 val = c - '0';
7278 while (*s < end && (c = *(*s)++, isdigit (c)))
7279 val = 10 * val + c - '0';
7280 break;
7281 }
7282 else
7283 break;
7284 }
7285
7286 return val;
7287 }
7288
7289
7290 /* Load PBM image IMG for use on frame F. */
7291
7292 static int
7293 pbm_load (f, img)
7294 struct frame *f;
7295 struct image *img;
7296 {
7297 int raw_p, x, y;
7298 int width, height, max_color_idx = 0;
7299 XImage *ximg;
7300 Lisp_Object file, specified_file;
7301 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
7302 struct gcpro gcpro1;
7303 unsigned char *contents = NULL;
7304 unsigned char *end, *p;
7305 int size;
7306
7307 specified_file = image_spec_value (img->spec, QCfile, NULL);
7308 file = Qnil;
7309 GCPRO1 (file);
7310
7311 if (STRINGP (specified_file))
7312 {
7313 file = x_find_image_file (specified_file);
7314 if (!STRINGP (file))
7315 {
7316 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7317 UNGCPRO;
7318 return 0;
7319 }
7320
7321 contents = slurp_file (XSTRING (file)->data, &size);
7322 if (contents == NULL)
7323 {
7324 image_error ("Error reading `%s'", file, Qnil);
7325 UNGCPRO;
7326 return 0;
7327 }
7328
7329 p = contents;
7330 end = contents + size;
7331 }
7332 else
7333 {
7334 Lisp_Object data;
7335 data = image_spec_value (img->spec, QCdata, NULL);
7336 p = XSTRING (data)->data;
7337 end = p + STRING_BYTES (XSTRING (data));
7338 }
7339
7340 /* Check magic number. */
7341 if (end - p < 2 || *p++ != 'P')
7342 {
7343 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
7344 error:
7345 xfree (contents);
7346 UNGCPRO;
7347 return 0;
7348 }
7349
7350 switch (*p++)
7351 {
7352 case '1':
7353 raw_p = 0, type = PBM_MONO;
7354 break;
7355
7356 case '2':
7357 raw_p = 0, type = PBM_GRAY;
7358 break;
7359
7360 case '3':
7361 raw_p = 0, type = PBM_COLOR;
7362 break;
7363
7364 case '4':
7365 raw_p = 1, type = PBM_MONO;
7366 break;
7367
7368 case '5':
7369 raw_p = 1, type = PBM_GRAY;
7370 break;
7371
7372 case '6':
7373 raw_p = 1, type = PBM_COLOR;
7374 break;
7375
7376 default:
7377 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
7378 goto error;
7379 }
7380
7381 /* Read width, height, maximum color-component. Characters
7382 starting with `#' up to the end of a line are ignored. */
7383 width = pbm_scan_number (&p, end);
7384 height = pbm_scan_number (&p, end);
7385
7386 if (type != PBM_MONO)
7387 {
7388 max_color_idx = pbm_scan_number (&p, end);
7389 if (raw_p && max_color_idx > 255)
7390 max_color_idx = 255;
7391 }
7392
7393 if (width < 0
7394 || height < 0
7395 || (type != PBM_MONO && max_color_idx < 0))
7396 goto error;
7397
7398 BLOCK_INPUT;
7399 if (!x_create_x_image_and_pixmap (f, width, height, 0,
7400 &ximg, &img->pixmap))
7401 {
7402 UNBLOCK_INPUT;
7403 goto error;
7404 }
7405
7406 /* Initialize the color hash table. */
7407 init_color_table ();
7408
7409 if (type == PBM_MONO)
7410 {
7411 int c = 0, g;
7412
7413 for (y = 0; y < height; ++y)
7414 for (x = 0; x < width; ++x)
7415 {
7416 if (raw_p)
7417 {
7418 if ((x & 7) == 0)
7419 c = *p++;
7420 g = c & 0x80;
7421 c <<= 1;
7422 }
7423 else
7424 g = pbm_scan_number (&p, end);
7425
7426 XPutPixel (ximg, x, y, (g
7427 ? FRAME_FOREGROUND_PIXEL (f)
7428 : FRAME_BACKGROUND_PIXEL (f)));
7429 }
7430 }
7431 else
7432 {
7433 for (y = 0; y < height; ++y)
7434 for (x = 0; x < width; ++x)
7435 {
7436 int r, g, b;
7437
7438 if (type == PBM_GRAY)
7439 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
7440 else if (raw_p)
7441 {
7442 r = *p++;
7443 g = *p++;
7444 b = *p++;
7445 }
7446 else
7447 {
7448 r = pbm_scan_number (&p, end);
7449 g = pbm_scan_number (&p, end);
7450 b = pbm_scan_number (&p, end);
7451 }
7452
7453 if (r < 0 || g < 0 || b < 0)
7454 {
7455 xfree (ximg->data);
7456 ximg->data = NULL;
7457 XDestroyImage (ximg);
7458 UNBLOCK_INPUT;
7459 image_error ("Invalid pixel value in image `%s'",
7460 img->spec, Qnil);
7461 goto error;
7462 }
7463
7464 /* RGB values are now in the range 0..max_color_idx.
7465 Scale this to the range 0..0xffff supported by X. */
7466 r = (double) r * 65535 / max_color_idx;
7467 g = (double) g * 65535 / max_color_idx;
7468 b = (double) b * 65535 / max_color_idx;
7469 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
7470 }
7471 }
7472
7473 /* Store in IMG->colors the colors allocated for the image, and
7474 free the color table. */
7475 img->colors = colors_in_color_table (&img->ncolors);
7476 free_color_table ();
7477
7478 /* Put the image into a pixmap. */
7479 x_put_x_image (f, ximg, img->pixmap, width, height);
7480 x_destroy_x_image (ximg);
7481 UNBLOCK_INPUT;
7482
7483 img->width = width;
7484 img->height = height;
7485
7486 UNGCPRO;
7487 xfree (contents);
7488 return 1;
7489 }
7490
7491
7492 \f
7493 /***********************************************************************
7494 PNG
7495 ***********************************************************************/
7496
7497 #if HAVE_PNG
7498
7499 #include <png.h>
7500
7501 /* Function prototypes. */
7502
7503 static int png_image_p P_ ((Lisp_Object object));
7504 static int png_load P_ ((struct frame *f, struct image *img));
7505
7506 /* The symbol `png' identifying images of this type. */
7507
7508 Lisp_Object Qpng;
7509
7510 /* Indices of image specification fields in png_format, below. */
7511
7512 enum png_keyword_index
7513 {
7514 PNG_TYPE,
7515 PNG_DATA,
7516 PNG_FILE,
7517 PNG_ASCENT,
7518 PNG_MARGIN,
7519 PNG_RELIEF,
7520 PNG_ALGORITHM,
7521 PNG_HEURISTIC_MASK,
7522 PNG_LAST
7523 };
7524
7525 /* Vector of image_keyword structures describing the format
7526 of valid user-defined image specifications. */
7527
7528 static struct image_keyword png_format[PNG_LAST] =
7529 {
7530 {":type", IMAGE_SYMBOL_VALUE, 1},
7531 {":data", IMAGE_STRING_VALUE, 0},
7532 {":file", IMAGE_STRING_VALUE, 0},
7533 {":ascent", IMAGE_ASCENT_VALUE, 0},
7534 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
7535 {":relief", IMAGE_INTEGER_VALUE, 0},
7536 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7537 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
7538 };
7539
7540 /* Structure describing the image type `png'. */
7541
7542 static struct image_type png_type =
7543 {
7544 &Qpng,
7545 png_image_p,
7546 png_load,
7547 x_clear_image,
7548 NULL
7549 };
7550
7551
7552 /* Return non-zero if OBJECT is a valid PNG image specification. */
7553
7554 static int
7555 png_image_p (object)
7556 Lisp_Object object;
7557 {
7558 struct image_keyword fmt[PNG_LAST];
7559 bcopy (png_format, fmt, sizeof fmt);
7560
7561 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
7562 return 0;
7563
7564 /* Must specify either the :data or :file keyword. */
7565 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
7566 }
7567
7568
7569 /* Error and warning handlers installed when the PNG library
7570 is initialized. */
7571
7572 static void
7573 my_png_error (png_ptr, msg)
7574 png_struct *png_ptr;
7575 char *msg;
7576 {
7577 xassert (png_ptr != NULL);
7578 image_error ("PNG error: %s", build_string (msg), Qnil);
7579 longjmp (png_ptr->jmpbuf, 1);
7580 }
7581
7582
7583 static void
7584 my_png_warning (png_ptr, msg)
7585 png_struct *png_ptr;
7586 char *msg;
7587 {
7588 xassert (png_ptr != NULL);
7589 image_error ("PNG warning: %s", build_string (msg), Qnil);
7590 }
7591
7592 /* Memory source for PNG decoding. */
7593
7594 struct png_memory_storage
7595 {
7596 unsigned char *bytes; /* The data */
7597 size_t len; /* How big is it? */
7598 int index; /* Where are we? */
7599 };
7600
7601
7602 /* Function set as reader function when reading PNG image from memory.
7603 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
7604 bytes from the input to DATA. */
7605
7606 static void
7607 png_read_from_memory (png_ptr, data, length)
7608 png_structp png_ptr;
7609 png_bytep data;
7610 png_size_t length;
7611 {
7612 struct png_memory_storage *tbr
7613 = (struct png_memory_storage *) png_get_io_ptr (png_ptr);
7614
7615 if (length > tbr->len - tbr->index)
7616 png_error (png_ptr, "Read error");
7617
7618 bcopy (tbr->bytes + tbr->index, data, length);
7619 tbr->index = tbr->index + length;
7620 }
7621
7622 /* Load PNG image IMG for use on frame F. Value is non-zero if
7623 successful. */
7624
7625 static int
7626 png_load (f, img)
7627 struct frame *f;
7628 struct image *img;
7629 {
7630 Lisp_Object file, specified_file;
7631 Lisp_Object specified_data;
7632 int x, y, i;
7633 XImage *ximg, *mask_img = NULL;
7634 struct gcpro gcpro1;
7635 png_struct *png_ptr = NULL;
7636 png_info *info_ptr = NULL, *end_info = NULL;
7637 FILE *fp = NULL;
7638 png_byte sig[8];
7639 png_byte *pixels = NULL;
7640 png_byte **rows = NULL;
7641 png_uint_32 width, height;
7642 int bit_depth, color_type, interlace_type;
7643 png_byte channels;
7644 png_uint_32 row_bytes;
7645 int transparent_p;
7646 char *gamma_str;
7647 double screen_gamma, image_gamma;
7648 int intent;
7649 struct png_memory_storage tbr; /* Data to be read */
7650
7651 /* Find out what file to load. */
7652 specified_file = image_spec_value (img->spec, QCfile, NULL);
7653 specified_data = image_spec_value (img->spec, QCdata, NULL);
7654 file = Qnil;
7655 GCPRO1 (file);
7656
7657 if (NILP (specified_data))
7658 {
7659 file = x_find_image_file (specified_file);
7660 if (!STRINGP (file))
7661 {
7662 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7663 UNGCPRO;
7664 return 0;
7665 }
7666
7667 /* Open the image file. */
7668 fp = fopen (XSTRING (file)->data, "rb");
7669 if (!fp)
7670 {
7671 image_error ("Cannot open image file `%s'", file, Qnil);
7672 UNGCPRO;
7673 fclose (fp);
7674 return 0;
7675 }
7676
7677 /* Check PNG signature. */
7678 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
7679 || !png_check_sig (sig, sizeof sig))
7680 {
7681 image_error ("Not a PNG file: `%s'", file, Qnil);
7682 UNGCPRO;
7683 fclose (fp);
7684 return 0;
7685 }
7686 }
7687 else
7688 {
7689 /* Read from memory. */
7690 tbr.bytes = XSTRING (specified_data)->data;
7691 tbr.len = STRING_BYTES (XSTRING (specified_data));
7692 tbr.index = 0;
7693
7694 /* Check PNG signature. */
7695 if (tbr.len < sizeof sig
7696 || !png_check_sig (tbr.bytes, sizeof sig))
7697 {
7698 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
7699 UNGCPRO;
7700 return 0;
7701 }
7702
7703 /* Need to skip past the signature. */
7704 tbr.bytes += sizeof (sig);
7705 }
7706
7707 /* Initialize read and info structs for PNG lib. */
7708 png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
7709 my_png_error, my_png_warning);
7710 if (!png_ptr)
7711 {
7712 if (fp) fclose (fp);
7713 UNGCPRO;
7714 return 0;
7715 }
7716
7717 info_ptr = png_create_info_struct (png_ptr);
7718 if (!info_ptr)
7719 {
7720 png_destroy_read_struct (&png_ptr, NULL, NULL);
7721 if (fp) fclose (fp);
7722 UNGCPRO;
7723 return 0;
7724 }
7725
7726 end_info = png_create_info_struct (png_ptr);
7727 if (!end_info)
7728 {
7729 png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
7730 if (fp) fclose (fp);
7731 UNGCPRO;
7732 return 0;
7733 }
7734
7735 /* Set error jump-back. We come back here when the PNG library
7736 detects an error. */
7737 if (setjmp (png_ptr->jmpbuf))
7738 {
7739 error:
7740 if (png_ptr)
7741 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
7742 xfree (pixels);
7743 xfree (rows);
7744 if (fp) fclose (fp);
7745 UNGCPRO;
7746 return 0;
7747 }
7748
7749 /* Read image info. */
7750 if (!NILP (specified_data))
7751 png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
7752 else
7753 png_init_io (png_ptr, fp);
7754
7755 png_set_sig_bytes (png_ptr, sizeof sig);
7756 png_read_info (png_ptr, info_ptr);
7757 png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
7758 &interlace_type, NULL, NULL);
7759
7760 /* If image contains simply transparency data, we prefer to
7761 construct a clipping mask. */
7762 if (png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
7763 transparent_p = 1;
7764 else
7765 transparent_p = 0;
7766
7767 /* This function is easier to write if we only have to handle
7768 one data format: RGB or RGBA with 8 bits per channel. Let's
7769 transform other formats into that format. */
7770
7771 /* Strip more than 8 bits per channel. */
7772 if (bit_depth == 16)
7773 png_set_strip_16 (png_ptr);
7774
7775 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
7776 if available. */
7777 png_set_expand (png_ptr);
7778
7779 /* Convert grayscale images to RGB. */
7780 if (color_type == PNG_COLOR_TYPE_GRAY
7781 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
7782 png_set_gray_to_rgb (png_ptr);
7783
7784 /* The value 2.2 is a guess for PC monitors from PNG example.c. */
7785 gamma_str = getenv ("SCREEN_GAMMA");
7786 screen_gamma = gamma_str ? atof (gamma_str) : 2.2;
7787
7788 /* Tell the PNG lib to handle gamma correction for us. */
7789
7790 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
7791 if (png_get_sRGB (png_ptr, info_ptr, &intent))
7792 /* There is a special chunk in the image specifying the gamma. */
7793 png_set_sRGB (png_ptr, info_ptr, intent);
7794 else
7795 #endif
7796 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
7797 /* Image contains gamma information. */
7798 png_set_gamma (png_ptr, screen_gamma, image_gamma);
7799 else
7800 /* Use a default of 0.5 for the image gamma. */
7801 png_set_gamma (png_ptr, screen_gamma, 0.5);
7802
7803 /* Handle alpha channel by combining the image with a background
7804 color. Do this only if a real alpha channel is supplied. For
7805 simple transparency, we prefer a clipping mask. */
7806 if (!transparent_p)
7807 {
7808 png_color_16 *image_background;
7809
7810 if (png_get_bKGD (png_ptr, info_ptr, &image_background))
7811 /* Image contains a background color with which to
7812 combine the image. */
7813 png_set_background (png_ptr, image_background,
7814 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
7815 else
7816 {
7817 /* Image does not contain a background color with which
7818 to combine the image data via an alpha channel. Use
7819 the frame's background instead. */
7820 XColor color;
7821 Colormap cmap;
7822 png_color_16 frame_background;
7823
7824 BLOCK_INPUT;
7825 cmap = FRAME_X_COLORMAP (f);
7826 color.pixel = FRAME_BACKGROUND_PIXEL (f);
7827 XQueryColor (FRAME_X_DISPLAY (f), cmap, &color);
7828 UNBLOCK_INPUT;
7829
7830 bzero (&frame_background, sizeof frame_background);
7831 frame_background.red = color.red;
7832 frame_background.green = color.green;
7833 frame_background.blue = color.blue;
7834
7835 png_set_background (png_ptr, &frame_background,
7836 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
7837 }
7838 }
7839
7840 /* Update info structure. */
7841 png_read_update_info (png_ptr, info_ptr);
7842
7843 /* Get number of channels. Valid values are 1 for grayscale images
7844 and images with a palette, 2 for grayscale images with transparency
7845 information (alpha channel), 3 for RGB images, and 4 for RGB
7846 images with alpha channel, i.e. RGBA. If conversions above were
7847 sufficient we should only have 3 or 4 channels here. */
7848 channels = png_get_channels (png_ptr, info_ptr);
7849 xassert (channels == 3 || channels == 4);
7850
7851 /* Number of bytes needed for one row of the image. */
7852 row_bytes = png_get_rowbytes (png_ptr, info_ptr);
7853
7854 /* Allocate memory for the image. */
7855 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
7856 rows = (png_byte **) xmalloc (height * sizeof *rows);
7857 for (i = 0; i < height; ++i)
7858 rows[i] = pixels + i * row_bytes;
7859
7860 /* Read the entire image. */
7861 png_read_image (png_ptr, rows);
7862 png_read_end (png_ptr, info_ptr);
7863 if (fp)
7864 {
7865 fclose (fp);
7866 fp = NULL;
7867 }
7868
7869 BLOCK_INPUT;
7870
7871 /* Create the X image and pixmap. */
7872 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
7873 &img->pixmap))
7874 {
7875 UNBLOCK_INPUT;
7876 goto error;
7877 }
7878
7879 /* Create an image and pixmap serving as mask if the PNG image
7880 contains an alpha channel. */
7881 if (channels == 4
7882 && !transparent_p
7883 && !x_create_x_image_and_pixmap (f, width, height, 1,
7884 &mask_img, &img->mask))
7885 {
7886 x_destroy_x_image (ximg);
7887 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
7888 img->pixmap = 0;
7889 UNBLOCK_INPUT;
7890 goto error;
7891 }
7892
7893 /* Fill the X image and mask from PNG data. */
7894 init_color_table ();
7895
7896 for (y = 0; y < height; ++y)
7897 {
7898 png_byte *p = rows[y];
7899
7900 for (x = 0; x < width; ++x)
7901 {
7902 unsigned r, g, b;
7903
7904 r = *p++ << 8;
7905 g = *p++ << 8;
7906 b = *p++ << 8;
7907 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
7908
7909 /* An alpha channel, aka mask channel, associates variable
7910 transparency with an image. Where other image formats
7911 support binary transparency---fully transparent or fully
7912 opaque---PNG allows up to 254 levels of partial transparency.
7913 The PNG library implements partial transparency by combining
7914 the image with a specified background color.
7915
7916 I'm not sure how to handle this here nicely: because the
7917 background on which the image is displayed may change, for
7918 real alpha channel support, it would be necessary to create
7919 a new image for each possible background.
7920
7921 What I'm doing now is that a mask is created if we have
7922 boolean transparency information. Otherwise I'm using
7923 the frame's background color to combine the image with. */
7924
7925 if (channels == 4)
7926 {
7927 if (mask_img)
7928 XPutPixel (mask_img, x, y, *p > 0);
7929 ++p;
7930 }
7931 }
7932 }
7933
7934 /* Remember colors allocated for this image. */
7935 img->colors = colors_in_color_table (&img->ncolors);
7936 free_color_table ();
7937
7938 /* Clean up. */
7939 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
7940 xfree (rows);
7941 xfree (pixels);
7942
7943 img->width = width;
7944 img->height = height;
7945
7946 /* Put the image into the pixmap, then free the X image and its buffer. */
7947 x_put_x_image (f, ximg, img->pixmap, width, height);
7948 x_destroy_x_image (ximg);
7949
7950 /* Same for the mask. */
7951 if (mask_img)
7952 {
7953 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
7954 x_destroy_x_image (mask_img);
7955 }
7956
7957 UNBLOCK_INPUT;
7958 UNGCPRO;
7959 return 1;
7960 }
7961
7962 #endif /* HAVE_PNG != 0 */
7963
7964
7965 \f
7966 /***********************************************************************
7967 JPEG
7968 ***********************************************************************/
7969
7970 #if HAVE_JPEG
7971
7972 /* Work around a warning about HAVE_STDLIB_H being redefined in
7973 jconfig.h. */
7974 #ifdef HAVE_STDLIB_H
7975 #define HAVE_STDLIB_H_1
7976 #undef HAVE_STDLIB_H
7977 #endif /* HAVE_STLIB_H */
7978
7979 #include <jpeglib.h>
7980 #include <jerror.h>
7981 #include <setjmp.h>
7982
7983 #ifdef HAVE_STLIB_H_1
7984 #define HAVE_STDLIB_H 1
7985 #endif
7986
7987 static int jpeg_image_p P_ ((Lisp_Object object));
7988 static int jpeg_load P_ ((struct frame *f, struct image *img));
7989
7990 /* The symbol `jpeg' identifying images of this type. */
7991
7992 Lisp_Object Qjpeg;
7993
7994 /* Indices of image specification fields in gs_format, below. */
7995
7996 enum jpeg_keyword_index
7997 {
7998 JPEG_TYPE,
7999 JPEG_DATA,
8000 JPEG_FILE,
8001 JPEG_ASCENT,
8002 JPEG_MARGIN,
8003 JPEG_RELIEF,
8004 JPEG_ALGORITHM,
8005 JPEG_HEURISTIC_MASK,
8006 JPEG_LAST
8007 };
8008
8009 /* Vector of image_keyword structures describing the format
8010 of valid user-defined image specifications. */
8011
8012 static struct image_keyword jpeg_format[JPEG_LAST] =
8013 {
8014 {":type", IMAGE_SYMBOL_VALUE, 1},
8015 {":data", IMAGE_STRING_VALUE, 0},
8016 {":file", IMAGE_STRING_VALUE, 0},
8017 {":ascent", IMAGE_ASCENT_VALUE, 0},
8018 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
8019 {":relief", IMAGE_INTEGER_VALUE, 0},
8020 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8021 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8022 };
8023
8024 /* Structure describing the image type `jpeg'. */
8025
8026 static struct image_type jpeg_type =
8027 {
8028 &Qjpeg,
8029 jpeg_image_p,
8030 jpeg_load,
8031 x_clear_image,
8032 NULL
8033 };
8034
8035
8036 /* Return non-zero if OBJECT is a valid JPEG image specification. */
8037
8038 static int
8039 jpeg_image_p (object)
8040 Lisp_Object object;
8041 {
8042 struct image_keyword fmt[JPEG_LAST];
8043
8044 bcopy (jpeg_format, fmt, sizeof fmt);
8045
8046 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
8047 return 0;
8048
8049 /* Must specify either the :data or :file keyword. */
8050 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
8051 }
8052
8053
8054 struct my_jpeg_error_mgr
8055 {
8056 struct jpeg_error_mgr pub;
8057 jmp_buf setjmp_buffer;
8058 };
8059
8060
8061 static void
8062 my_error_exit (cinfo)
8063 j_common_ptr cinfo;
8064 {
8065 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
8066 longjmp (mgr->setjmp_buffer, 1);
8067 }
8068
8069
8070 /* Init source method for JPEG data source manager. Called by
8071 jpeg_read_header() before any data is actually read. See
8072 libjpeg.doc from the JPEG lib distribution. */
8073
8074 static void
8075 our_init_source (cinfo)
8076 j_decompress_ptr cinfo;
8077 {
8078 }
8079
8080
8081 /* Fill input buffer method for JPEG data source manager. Called
8082 whenever more data is needed. We read the whole image in one step,
8083 so this only adds a fake end of input marker at the end. */
8084
8085 static boolean
8086 our_fill_input_buffer (cinfo)
8087 j_decompress_ptr cinfo;
8088 {
8089 /* Insert a fake EOI marker. */
8090 struct jpeg_source_mgr *src = cinfo->src;
8091 static JOCTET buffer[2];
8092
8093 buffer[0] = (JOCTET) 0xFF;
8094 buffer[1] = (JOCTET) JPEG_EOI;
8095
8096 src->next_input_byte = buffer;
8097 src->bytes_in_buffer = 2;
8098 return TRUE;
8099 }
8100
8101
8102 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
8103 is the JPEG data source manager. */
8104
8105 static void
8106 our_skip_input_data (cinfo, num_bytes)
8107 j_decompress_ptr cinfo;
8108 long num_bytes;
8109 {
8110 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
8111
8112 if (src)
8113 {
8114 if (num_bytes > src->bytes_in_buffer)
8115 ERREXIT (cinfo, JERR_INPUT_EOF);
8116
8117 src->bytes_in_buffer -= num_bytes;
8118 src->next_input_byte += num_bytes;
8119 }
8120 }
8121
8122
8123 /* Method to terminate data source. Called by
8124 jpeg_finish_decompress() after all data has been processed. */
8125
8126 static void
8127 our_term_source (cinfo)
8128 j_decompress_ptr cinfo;
8129 {
8130 }
8131
8132
8133 /* Set up the JPEG lib for reading an image from DATA which contains
8134 LEN bytes. CINFO is the decompression info structure created for
8135 reading the image. */
8136
8137 static void
8138 jpeg_memory_src (cinfo, data, len)
8139 j_decompress_ptr cinfo;
8140 JOCTET *data;
8141 unsigned int len;
8142 {
8143 struct jpeg_source_mgr *src;
8144
8145 if (cinfo->src == NULL)
8146 {
8147 /* First time for this JPEG object? */
8148 cinfo->src = (struct jpeg_source_mgr *)
8149 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
8150 sizeof (struct jpeg_source_mgr));
8151 src = (struct jpeg_source_mgr *) cinfo->src;
8152 src->next_input_byte = data;
8153 }
8154
8155 src = (struct jpeg_source_mgr *) cinfo->src;
8156 src->init_source = our_init_source;
8157 src->fill_input_buffer = our_fill_input_buffer;
8158 src->skip_input_data = our_skip_input_data;
8159 src->resync_to_restart = jpeg_resync_to_restart; /* Use default method. */
8160 src->term_source = our_term_source;
8161 src->bytes_in_buffer = len;
8162 src->next_input_byte = data;
8163 }
8164
8165
8166 /* Load image IMG for use on frame F. Patterned after example.c
8167 from the JPEG lib. */
8168
8169 static int
8170 jpeg_load (f, img)
8171 struct frame *f;
8172 struct image *img;
8173 {
8174 struct jpeg_decompress_struct cinfo;
8175 struct my_jpeg_error_mgr mgr;
8176 Lisp_Object file, specified_file;
8177 Lisp_Object specified_data;
8178 FILE *fp = NULL;
8179 JSAMPARRAY buffer;
8180 int row_stride, x, y;
8181 XImage *ximg = NULL;
8182 int rc;
8183 unsigned long *colors;
8184 int width, height;
8185 struct gcpro gcpro1;
8186
8187 /* Open the JPEG file. */
8188 specified_file = image_spec_value (img->spec, QCfile, NULL);
8189 specified_data = image_spec_value (img->spec, QCdata, NULL);
8190 file = Qnil;
8191 GCPRO1 (file);
8192
8193 if (NILP (specified_data))
8194 {
8195 file = x_find_image_file (specified_file);
8196 if (!STRINGP (file))
8197 {
8198 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8199 UNGCPRO;
8200 return 0;
8201 }
8202
8203 fp = fopen (XSTRING (file)->data, "r");
8204 if (fp == NULL)
8205 {
8206 image_error ("Cannot open `%s'", file, Qnil);
8207 UNGCPRO;
8208 return 0;
8209 }
8210 }
8211
8212 /* Customize libjpeg's error handling to call my_error_exit when an
8213 error is detected. This function will perform a longjmp. */
8214 cinfo.err = jpeg_std_error (&mgr.pub);
8215 mgr.pub.error_exit = my_error_exit;
8216
8217 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
8218 {
8219 if (rc == 1)
8220 {
8221 /* Called from my_error_exit. Display a JPEG error. */
8222 char buffer[JMSG_LENGTH_MAX];
8223 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
8224 image_error ("Error reading JPEG image `%s': %s", img->spec,
8225 build_string (buffer));
8226 }
8227
8228 /* Close the input file and destroy the JPEG object. */
8229 if (fp)
8230 fclose (fp);
8231 jpeg_destroy_decompress (&cinfo);
8232
8233 BLOCK_INPUT;
8234
8235 /* If we already have an XImage, free that. */
8236 x_destroy_x_image (ximg);
8237
8238 /* Free pixmap and colors. */
8239 x_clear_image (f, img);
8240
8241 UNBLOCK_INPUT;
8242 UNGCPRO;
8243 return 0;
8244 }
8245
8246 /* Create the JPEG decompression object. Let it read from fp.
8247 Read the JPEG image header. */
8248 jpeg_create_decompress (&cinfo);
8249
8250 if (NILP (specified_data))
8251 jpeg_stdio_src (&cinfo, fp);
8252 else
8253 jpeg_memory_src (&cinfo, XSTRING (specified_data)->data,
8254 STRING_BYTES (XSTRING (specified_data)));
8255
8256 jpeg_read_header (&cinfo, TRUE);
8257
8258 /* Customize decompression so that color quantization will be used.
8259 Start decompression. */
8260 cinfo.quantize_colors = TRUE;
8261 jpeg_start_decompress (&cinfo);
8262 width = img->width = cinfo.output_width;
8263 height = img->height = cinfo.output_height;
8264
8265 BLOCK_INPUT;
8266
8267 /* Create X image and pixmap. */
8268 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
8269 {
8270 UNBLOCK_INPUT;
8271 longjmp (mgr.setjmp_buffer, 2);
8272 }
8273
8274 /* Allocate colors. When color quantization is used,
8275 cinfo.actual_number_of_colors has been set with the number of
8276 colors generated, and cinfo.colormap is a two-dimensional array
8277 of color indices in the range 0..cinfo.actual_number_of_colors.
8278 No more than 255 colors will be generated. */
8279 {
8280 int i, ir, ig, ib;
8281
8282 if (cinfo.out_color_components > 2)
8283 ir = 0, ig = 1, ib = 2;
8284 else if (cinfo.out_color_components > 1)
8285 ir = 0, ig = 1, ib = 0;
8286 else
8287 ir = 0, ig = 0, ib = 0;
8288
8289 /* Use the color table mechanism because it handles colors that
8290 cannot be allocated nicely. Such colors will be replaced with
8291 a default color, and we don't have to care about which colors
8292 can be freed safely, and which can't. */
8293 init_color_table ();
8294 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
8295 * sizeof *colors);
8296
8297 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
8298 {
8299 /* Multiply RGB values with 255 because X expects RGB values
8300 in the range 0..0xffff. */
8301 int r = cinfo.colormap[ir][i] << 8;
8302 int g = cinfo.colormap[ig][i] << 8;
8303 int b = cinfo.colormap[ib][i] << 8;
8304 colors[i] = lookup_rgb_color (f, r, g, b);
8305 }
8306
8307 /* Remember those colors actually allocated. */
8308 img->colors = colors_in_color_table (&img->ncolors);
8309 free_color_table ();
8310 }
8311
8312 /* Read pixels. */
8313 row_stride = width * cinfo.output_components;
8314 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
8315 row_stride, 1);
8316 for (y = 0; y < height; ++y)
8317 {
8318 jpeg_read_scanlines (&cinfo, buffer, 1);
8319 for (x = 0; x < cinfo.output_width; ++x)
8320 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
8321 }
8322
8323 /* Clean up. */
8324 jpeg_finish_decompress (&cinfo);
8325 jpeg_destroy_decompress (&cinfo);
8326 if (fp)
8327 fclose (fp);
8328
8329 /* Put the image into the pixmap. */
8330 x_put_x_image (f, ximg, img->pixmap, width, height);
8331 x_destroy_x_image (ximg);
8332 UNBLOCK_INPUT;
8333 UNGCPRO;
8334 return 1;
8335 }
8336
8337 #endif /* HAVE_JPEG */
8338
8339
8340 \f
8341 /***********************************************************************
8342 TIFF
8343 ***********************************************************************/
8344
8345 #if HAVE_TIFF
8346
8347 #include <tiffio.h>
8348
8349 static int tiff_image_p P_ ((Lisp_Object object));
8350 static int tiff_load P_ ((struct frame *f, struct image *img));
8351
8352 /* The symbol `tiff' identifying images of this type. */
8353
8354 Lisp_Object Qtiff;
8355
8356 /* Indices of image specification fields in tiff_format, below. */
8357
8358 enum tiff_keyword_index
8359 {
8360 TIFF_TYPE,
8361 TIFF_DATA,
8362 TIFF_FILE,
8363 TIFF_ASCENT,
8364 TIFF_MARGIN,
8365 TIFF_RELIEF,
8366 TIFF_ALGORITHM,
8367 TIFF_HEURISTIC_MASK,
8368 TIFF_LAST
8369 };
8370
8371 /* Vector of image_keyword structures describing the format
8372 of valid user-defined image specifications. */
8373
8374 static struct image_keyword tiff_format[TIFF_LAST] =
8375 {
8376 {":type", IMAGE_SYMBOL_VALUE, 1},
8377 {":data", IMAGE_STRING_VALUE, 0},
8378 {":file", IMAGE_STRING_VALUE, 0},
8379 {":ascent", IMAGE_ASCENT_VALUE, 0},
8380 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
8381 {":relief", IMAGE_INTEGER_VALUE, 0},
8382 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8383 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8384 };
8385
8386 /* Structure describing the image type `tiff'. */
8387
8388 static struct image_type tiff_type =
8389 {
8390 &Qtiff,
8391 tiff_image_p,
8392 tiff_load,
8393 x_clear_image,
8394 NULL
8395 };
8396
8397
8398 /* Return non-zero if OBJECT is a valid TIFF image specification. */
8399
8400 static int
8401 tiff_image_p (object)
8402 Lisp_Object object;
8403 {
8404 struct image_keyword fmt[TIFF_LAST];
8405 bcopy (tiff_format, fmt, sizeof fmt);
8406
8407 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
8408 return 0;
8409
8410 /* Must specify either the :data or :file keyword. */
8411 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
8412 }
8413
8414
8415 /* Reading from a memory buffer for TIFF images Based on the PNG
8416 memory source, but we have to provide a lot of extra functions.
8417 Blah.
8418
8419 We really only need to implement read and seek, but I am not
8420 convinced that the TIFF library is smart enough not to destroy
8421 itself if we only hand it the function pointers we need to
8422 override. */
8423
8424 typedef struct
8425 {
8426 unsigned char *bytes;
8427 size_t len;
8428 int index;
8429 }
8430 tiff_memory_source;
8431
8432
8433 static size_t
8434 tiff_read_from_memory (data, buf, size)
8435 thandle_t data;
8436 tdata_t buf;
8437 tsize_t size;
8438 {
8439 tiff_memory_source *src = (tiff_memory_source *) data;
8440
8441 if (size > src->len - src->index)
8442 return (size_t) -1;
8443 bcopy (src->bytes + src->index, buf, size);
8444 src->index += size;
8445 return size;
8446 }
8447
8448
8449 static size_t
8450 tiff_write_from_memory (data, buf, size)
8451 thandle_t data;
8452 tdata_t buf;
8453 tsize_t size;
8454 {
8455 return (size_t) -1;
8456 }
8457
8458
8459 static toff_t
8460 tiff_seek_in_memory (data, off, whence)
8461 thandle_t data;
8462 toff_t off;
8463 int whence;
8464 {
8465 tiff_memory_source *src = (tiff_memory_source *) data;
8466 int idx;
8467
8468 switch (whence)
8469 {
8470 case SEEK_SET: /* Go from beginning of source. */
8471 idx = off;
8472 break;
8473
8474 case SEEK_END: /* Go from end of source. */
8475 idx = src->len + off;
8476 break;
8477
8478 case SEEK_CUR: /* Go from current position. */
8479 idx = src->index + off;
8480 break;
8481
8482 default: /* Invalid `whence'. */
8483 return -1;
8484 }
8485
8486 if (idx > src->len || idx < 0)
8487 return -1;
8488
8489 src->index = idx;
8490 return src->index;
8491 }
8492
8493
8494 static int
8495 tiff_close_memory (data)
8496 thandle_t data;
8497 {
8498 /* NOOP */
8499 return 0;
8500 }
8501
8502
8503 static int
8504 tiff_mmap_memory (data, pbase, psize)
8505 thandle_t data;
8506 tdata_t *pbase;
8507 toff_t *psize;
8508 {
8509 /* It is already _IN_ memory. */
8510 return 0;
8511 }
8512
8513
8514 static void
8515 tiff_unmap_memory (data, base, size)
8516 thandle_t data;
8517 tdata_t base;
8518 toff_t size;
8519 {
8520 /* We don't need to do this. */
8521 }
8522
8523
8524 static toff_t
8525 tiff_size_of_memory (data)
8526 thandle_t data;
8527 {
8528 return ((tiff_memory_source *) data)->len;
8529 }
8530
8531
8532 /* Load TIFF image IMG for use on frame F. Value is non-zero if
8533 successful. */
8534
8535 static int
8536 tiff_load (f, img)
8537 struct frame *f;
8538 struct image *img;
8539 {
8540 Lisp_Object file, specified_file;
8541 Lisp_Object specified_data;
8542 TIFF *tiff;
8543 int width, height, x, y;
8544 uint32 *buf;
8545 int rc;
8546 XImage *ximg;
8547 struct gcpro gcpro1;
8548 tiff_memory_source memsrc;
8549
8550 specified_file = image_spec_value (img->spec, QCfile, NULL);
8551 specified_data = image_spec_value (img->spec, QCdata, NULL);
8552 file = Qnil;
8553 GCPRO1 (file);
8554
8555 if (NILP (specified_data))
8556 {
8557 /* Read from a file */
8558 file = x_find_image_file (specified_file);
8559 if (!STRINGP (file))
8560 {
8561 image_error ("Cannot find image file `%s'", file, Qnil);
8562 UNGCPRO;
8563 return 0;
8564 }
8565
8566 /* Try to open the image file. */
8567 tiff = TIFFOpen (XSTRING (file)->data, "r");
8568 if (tiff == NULL)
8569 {
8570 image_error ("Cannot open `%s'", file, Qnil);
8571 UNGCPRO;
8572 return 0;
8573 }
8574 }
8575 else
8576 {
8577 /* Memory source! */
8578 memsrc.bytes = XSTRING (specified_data)->data;
8579 memsrc.len = STRING_BYTES (XSTRING (specified_data));
8580 memsrc.index = 0;
8581
8582 tiff = TIFFClientOpen ("memory_source", "r", &memsrc,
8583 (TIFFReadWriteProc) tiff_read_from_memory,
8584 (TIFFReadWriteProc) tiff_write_from_memory,
8585 tiff_seek_in_memory,
8586 tiff_close_memory,
8587 tiff_size_of_memory,
8588 tiff_mmap_memory,
8589 tiff_unmap_memory);
8590
8591 if (!tiff)
8592 {
8593 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
8594 UNGCPRO;
8595 return 0;
8596 }
8597 }
8598
8599 /* Get width and height of the image, and allocate a raster buffer
8600 of width x height 32-bit values. */
8601 TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
8602 TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
8603 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
8604
8605 rc = TIFFReadRGBAImage (tiff, width, height, buf, 0);
8606 TIFFClose (tiff);
8607 if (!rc)
8608 {
8609 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
8610 xfree (buf);
8611 UNGCPRO;
8612 return 0;
8613 }
8614
8615 BLOCK_INPUT;
8616
8617 /* Create the X image and pixmap. */
8618 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
8619 {
8620 UNBLOCK_INPUT;
8621 xfree (buf);
8622 UNGCPRO;
8623 return 0;
8624 }
8625
8626 /* Initialize the color table. */
8627 init_color_table ();
8628
8629 /* Process the pixel raster. Origin is in the lower-left corner. */
8630 for (y = 0; y < height; ++y)
8631 {
8632 uint32 *row = buf + y * width;
8633
8634 for (x = 0; x < width; ++x)
8635 {
8636 uint32 abgr = row[x];
8637 int r = TIFFGetR (abgr) << 8;
8638 int g = TIFFGetG (abgr) << 8;
8639 int b = TIFFGetB (abgr) << 8;
8640 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
8641 }
8642 }
8643
8644 /* Remember the colors allocated for the image. Free the color table. */
8645 img->colors = colors_in_color_table (&img->ncolors);
8646 free_color_table ();
8647
8648 /* Put the image into the pixmap, then free the X image and its buffer. */
8649 x_put_x_image (f, ximg, img->pixmap, width, height);
8650 x_destroy_x_image (ximg);
8651 xfree (buf);
8652 UNBLOCK_INPUT;
8653
8654 img->width = width;
8655 img->height = height;
8656
8657 UNGCPRO;
8658 return 1;
8659 }
8660
8661 #endif /* HAVE_TIFF != 0 */
8662
8663
8664 \f
8665 /***********************************************************************
8666 GIF
8667 ***********************************************************************/
8668
8669 #if HAVE_GIF
8670
8671 #include <gif_lib.h>
8672
8673 static int gif_image_p P_ ((Lisp_Object object));
8674 static int gif_load P_ ((struct frame *f, struct image *img));
8675
8676 /* The symbol `gif' identifying images of this type. */
8677
8678 Lisp_Object Qgif;
8679
8680 /* Indices of image specification fields in gif_format, below. */
8681
8682 enum gif_keyword_index
8683 {
8684 GIF_TYPE,
8685 GIF_DATA,
8686 GIF_FILE,
8687 GIF_ASCENT,
8688 GIF_MARGIN,
8689 GIF_RELIEF,
8690 GIF_ALGORITHM,
8691 GIF_HEURISTIC_MASK,
8692 GIF_IMAGE,
8693 GIF_LAST
8694 };
8695
8696 /* Vector of image_keyword structures describing the format
8697 of valid user-defined image specifications. */
8698
8699 static struct image_keyword gif_format[GIF_LAST] =
8700 {
8701 {":type", IMAGE_SYMBOL_VALUE, 1},
8702 {":data", IMAGE_STRING_VALUE, 0},
8703 {":file", IMAGE_STRING_VALUE, 0},
8704 {":ascent", IMAGE_ASCENT_VALUE, 0},
8705 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
8706 {":relief", IMAGE_INTEGER_VALUE, 0},
8707 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8708 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8709 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0}
8710 };
8711
8712 /* Structure describing the image type `gif'. */
8713
8714 static struct image_type gif_type =
8715 {
8716 &Qgif,
8717 gif_image_p,
8718 gif_load,
8719 x_clear_image,
8720 NULL
8721 };
8722
8723
8724 /* Return non-zero if OBJECT is a valid GIF image specification. */
8725
8726 static int
8727 gif_image_p (object)
8728 Lisp_Object object;
8729 {
8730 struct image_keyword fmt[GIF_LAST];
8731 bcopy (gif_format, fmt, sizeof fmt);
8732
8733 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
8734 return 0;
8735
8736 /* Must specify either the :data or :file keyword. */
8737 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
8738 }
8739
8740
8741 /* Reading a GIF image from memory
8742 Based on the PNG memory stuff to a certain extent. */
8743
8744 typedef struct
8745 {
8746 unsigned char *bytes;
8747 size_t len;
8748 int index;
8749 }
8750 gif_memory_source;
8751
8752
8753 /* Make the current memory source available to gif_read_from_memory.
8754 It's done this way because not all versions of libungif support
8755 a UserData field in the GifFileType structure. */
8756 static gif_memory_source *current_gif_memory_src;
8757
8758 static int
8759 gif_read_from_memory (file, buf, len)
8760 GifFileType *file;
8761 GifByteType *buf;
8762 int len;
8763 {
8764 gif_memory_source *src = current_gif_memory_src;
8765
8766 if (len > src->len - src->index)
8767 return -1;
8768
8769 bcopy (src->bytes + src->index, buf, len);
8770 src->index += len;
8771 return len;
8772 }
8773
8774
8775 /* Load GIF image IMG for use on frame F. Value is non-zero if
8776 successful. */
8777
8778 static int
8779 gif_load (f, img)
8780 struct frame *f;
8781 struct image *img;
8782 {
8783 Lisp_Object file, specified_file;
8784 Lisp_Object specified_data;
8785 int rc, width, height, x, y, i;
8786 XImage *ximg;
8787 ColorMapObject *gif_color_map;
8788 unsigned long pixel_colors[256];
8789 GifFileType *gif;
8790 struct gcpro gcpro1;
8791 Lisp_Object image;
8792 int ino, image_left, image_top, image_width, image_height;
8793 gif_memory_source memsrc;
8794 unsigned char *raster;
8795
8796 specified_file = image_spec_value (img->spec, QCfile, NULL);
8797 specified_data = image_spec_value (img->spec, QCdata, NULL);
8798 file = Qnil;
8799 GCPRO1 (file);
8800
8801 if (NILP (specified_data))
8802 {
8803 file = x_find_image_file (specified_file);
8804 if (!STRINGP (file))
8805 {
8806 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8807 UNGCPRO;
8808 return 0;
8809 }
8810
8811 /* Open the GIF file. */
8812 gif = DGifOpenFileName (XSTRING (file)->data);
8813 if (gif == NULL)
8814 {
8815 image_error ("Cannot open `%s'", file, Qnil);
8816 UNGCPRO;
8817 return 0;
8818 }
8819 }
8820 else
8821 {
8822 /* Read from memory! */
8823 current_gif_memory_src = &memsrc;
8824 memsrc.bytes = XSTRING (specified_data)->data;
8825 memsrc.len = STRING_BYTES (XSTRING (specified_data));
8826 memsrc.index = 0;
8827
8828 gif = DGifOpen(&memsrc, gif_read_from_memory);
8829 if (!gif)
8830 {
8831 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
8832 UNGCPRO;
8833 return 0;
8834 }
8835 }
8836
8837 /* Read entire contents. */
8838 rc = DGifSlurp (gif);
8839 if (rc == GIF_ERROR)
8840 {
8841 image_error ("Error reading `%s'", img->spec, Qnil);
8842 DGifCloseFile (gif);
8843 UNGCPRO;
8844 return 0;
8845 }
8846
8847 image = image_spec_value (img->spec, QCindex, NULL);
8848 ino = INTEGERP (image) ? XFASTINT (image) : 0;
8849 if (ino >= gif->ImageCount)
8850 {
8851 image_error ("Invalid image number `%s' in image `%s'",
8852 image, img->spec);
8853 DGifCloseFile (gif);
8854 UNGCPRO;
8855 return 0;
8856 }
8857
8858 width = img->width = gif->SWidth;
8859 height = img->height = gif->SHeight;
8860
8861 BLOCK_INPUT;
8862
8863 /* Create the X image and pixmap. */
8864 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
8865 {
8866 UNBLOCK_INPUT;
8867 DGifCloseFile (gif);
8868 UNGCPRO;
8869 return 0;
8870 }
8871
8872 /* Allocate colors. */
8873 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
8874 if (!gif_color_map)
8875 gif_color_map = gif->SColorMap;
8876 init_color_table ();
8877 bzero (pixel_colors, sizeof pixel_colors);
8878
8879 for (i = 0; i < gif_color_map->ColorCount; ++i)
8880 {
8881 int r = gif_color_map->Colors[i].Red << 8;
8882 int g = gif_color_map->Colors[i].Green << 8;
8883 int b = gif_color_map->Colors[i].Blue << 8;
8884 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
8885 }
8886
8887 img->colors = colors_in_color_table (&img->ncolors);
8888 free_color_table ();
8889
8890 /* Clear the part of the screen image that are not covered by
8891 the image from the GIF file. Full animated GIF support
8892 requires more than can be done here (see the gif89 spec,
8893 disposal methods). Let's simply assume that the part
8894 not covered by a sub-image is in the frame's background color. */
8895 image_top = gif->SavedImages[ino].ImageDesc.Top;
8896 image_left = gif->SavedImages[ino].ImageDesc.Left;
8897 image_width = gif->SavedImages[ino].ImageDesc.Width;
8898 image_height = gif->SavedImages[ino].ImageDesc.Height;
8899
8900 for (y = 0; y < image_top; ++y)
8901 for (x = 0; x < width; ++x)
8902 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
8903
8904 for (y = image_top + image_height; y < height; ++y)
8905 for (x = 0; x < width; ++x)
8906 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
8907
8908 for (y = image_top; y < image_top + image_height; ++y)
8909 {
8910 for (x = 0; x < image_left; ++x)
8911 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
8912 for (x = image_left + image_width; x < width; ++x)
8913 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
8914 }
8915
8916 /* Read the GIF image into the X image. We use a local variable
8917 `raster' here because RasterBits below is a char *, and invites
8918 problems with bytes >= 0x80. */
8919 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
8920
8921 if (gif->SavedImages[ino].ImageDesc.Interlace)
8922 {
8923 static int interlace_start[] = {0, 4, 2, 1};
8924 static int interlace_increment[] = {8, 8, 4, 2};
8925 int pass, inc;
8926 int row = interlace_start[0];
8927
8928 pass = 0;
8929
8930 for (y = 0; y < image_height; y++)
8931 {
8932 if (row >= image_height)
8933 {
8934 row = interlace_start[++pass];
8935 while (row >= image_height)
8936 row = interlace_start[++pass];
8937 }
8938
8939 for (x = 0; x < image_width; x++)
8940 {
8941 int i = raster[(y * image_width) + x];
8942 XPutPixel (ximg, x + image_left, row + image_top,
8943 pixel_colors[i]);
8944 }
8945
8946 row += interlace_increment[pass];
8947 }
8948 }
8949 else
8950 {
8951 for (y = 0; y < image_height; ++y)
8952 for (x = 0; x < image_width; ++x)
8953 {
8954 int i = raster[y * image_width + x];
8955 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
8956 }
8957 }
8958
8959 DGifCloseFile (gif);
8960
8961 /* Put the image into the pixmap, then free the X image and its buffer. */
8962 x_put_x_image (f, ximg, img->pixmap, width, height);
8963 x_destroy_x_image (ximg);
8964 UNBLOCK_INPUT;
8965
8966 UNGCPRO;
8967 return 1;
8968 }
8969
8970 #endif /* HAVE_GIF != 0 */
8971
8972
8973 \f
8974 /***********************************************************************
8975 Ghostscript
8976 ***********************************************************************/
8977
8978 static int gs_image_p P_ ((Lisp_Object object));
8979 static int gs_load P_ ((struct frame *f, struct image *img));
8980 static void gs_clear_image P_ ((struct frame *f, struct image *img));
8981
8982 /* The symbol `postscript' identifying images of this type. */
8983
8984 Lisp_Object Qpostscript;
8985
8986 /* Keyword symbols. */
8987
8988 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
8989
8990 /* Indices of image specification fields in gs_format, below. */
8991
8992 enum gs_keyword_index
8993 {
8994 GS_TYPE,
8995 GS_PT_WIDTH,
8996 GS_PT_HEIGHT,
8997 GS_FILE,
8998 GS_LOADER,
8999 GS_BOUNDING_BOX,
9000 GS_ASCENT,
9001 GS_MARGIN,
9002 GS_RELIEF,
9003 GS_ALGORITHM,
9004 GS_HEURISTIC_MASK,
9005 GS_LAST
9006 };
9007
9008 /* Vector of image_keyword structures describing the format
9009 of valid user-defined image specifications. */
9010
9011 static struct image_keyword gs_format[GS_LAST] =
9012 {
9013 {":type", IMAGE_SYMBOL_VALUE, 1},
9014 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9015 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9016 {":file", IMAGE_STRING_VALUE, 1},
9017 {":loader", IMAGE_FUNCTION_VALUE, 0},
9018 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
9019 {":ascent", IMAGE_ASCENT_VALUE, 0},
9020 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
9021 {":relief", IMAGE_INTEGER_VALUE, 0},
9022 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9023 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9024 };
9025
9026 /* Structure describing the image type `ghostscript'. */
9027
9028 static struct image_type gs_type =
9029 {
9030 &Qpostscript,
9031 gs_image_p,
9032 gs_load,
9033 gs_clear_image,
9034 NULL
9035 };
9036
9037
9038 /* Free X resources of Ghostscript image IMG which is used on frame F. */
9039
9040 static void
9041 gs_clear_image (f, img)
9042 struct frame *f;
9043 struct image *img;
9044 {
9045 /* IMG->data.ptr_val may contain a recorded colormap. */
9046 xfree (img->data.ptr_val);
9047 x_clear_image (f, img);
9048 }
9049
9050
9051 /* Return non-zero if OBJECT is a valid Ghostscript image
9052 specification. */
9053
9054 static int
9055 gs_image_p (object)
9056 Lisp_Object object;
9057 {
9058 struct image_keyword fmt[GS_LAST];
9059 Lisp_Object tem;
9060 int i;
9061
9062 bcopy (gs_format, fmt, sizeof fmt);
9063
9064 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
9065 return 0;
9066
9067 /* Bounding box must be a list or vector containing 4 integers. */
9068 tem = fmt[GS_BOUNDING_BOX].value;
9069 if (CONSP (tem))
9070 {
9071 for (i = 0; i < 4; ++i, tem = XCDR (tem))
9072 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
9073 return 0;
9074 if (!NILP (tem))
9075 return 0;
9076 }
9077 else if (VECTORP (tem))
9078 {
9079 if (XVECTOR (tem)->size != 4)
9080 return 0;
9081 for (i = 0; i < 4; ++i)
9082 if (!INTEGERP (XVECTOR (tem)->contents[i]))
9083 return 0;
9084 }
9085 else
9086 return 0;
9087
9088 return 1;
9089 }
9090
9091
9092 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
9093 if successful. */
9094
9095 static int
9096 gs_load (f, img)
9097 struct frame *f;
9098 struct image *img;
9099 {
9100 char buffer[100];
9101 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
9102 struct gcpro gcpro1, gcpro2;
9103 Lisp_Object frame;
9104 double in_width, in_height;
9105 Lisp_Object pixel_colors = Qnil;
9106
9107 /* Compute pixel size of pixmap needed from the given size in the
9108 image specification. Sizes in the specification are in pt. 1 pt
9109 = 1/72 in, xdpi and ydpi are stored in the frame's X display
9110 info. */
9111 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
9112 in_width = XFASTINT (pt_width) / 72.0;
9113 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
9114 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
9115 in_height = XFASTINT (pt_height) / 72.0;
9116 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
9117
9118 /* Create the pixmap. */
9119 BLOCK_INPUT;
9120 xassert (img->pixmap == 0);
9121 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9122 img->width, img->height,
9123 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
9124 UNBLOCK_INPUT;
9125
9126 if (!img->pixmap)
9127 {
9128 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
9129 return 0;
9130 }
9131
9132 /* Call the loader to fill the pixmap. It returns a process object
9133 if successful. We do not record_unwind_protect here because
9134 other places in redisplay like calling window scroll functions
9135 don't either. Let the Lisp loader use `unwind-protect' instead. */
9136 GCPRO2 (window_and_pixmap_id, pixel_colors);
9137
9138 sprintf (buffer, "%lu %lu",
9139 (unsigned long) FRAME_X_WINDOW (f),
9140 (unsigned long) img->pixmap);
9141 window_and_pixmap_id = build_string (buffer);
9142
9143 sprintf (buffer, "%lu %lu",
9144 FRAME_FOREGROUND_PIXEL (f),
9145 FRAME_BACKGROUND_PIXEL (f));
9146 pixel_colors = build_string (buffer);
9147
9148 XSETFRAME (frame, f);
9149 loader = image_spec_value (img->spec, QCloader, NULL);
9150 if (NILP (loader))
9151 loader = intern ("gs-load-image");
9152
9153 img->data.lisp_val = call6 (loader, frame, img->spec,
9154 make_number (img->width),
9155 make_number (img->height),
9156 window_and_pixmap_id,
9157 pixel_colors);
9158 UNGCPRO;
9159 return PROCESSP (img->data.lisp_val);
9160 }
9161
9162
9163 /* Kill the Ghostscript process that was started to fill PIXMAP on
9164 frame F. Called from XTread_socket when receiving an event
9165 telling Emacs that Ghostscript has finished drawing. */
9166
9167 void
9168 x_kill_gs_process (pixmap, f)
9169 Pixmap pixmap;
9170 struct frame *f;
9171 {
9172 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
9173 int class, i;
9174 struct image *img;
9175
9176 /* Find the image containing PIXMAP. */
9177 for (i = 0; i < c->used; ++i)
9178 if (c->images[i]->pixmap == pixmap)
9179 break;
9180
9181 /* Kill the GS process. We should have found PIXMAP in the image
9182 cache and its image should contain a process object. */
9183 xassert (i < c->used);
9184 img = c->images[i];
9185 xassert (PROCESSP (img->data.lisp_val));
9186 Fkill_process (img->data.lisp_val, Qnil);
9187 img->data.lisp_val = Qnil;
9188
9189 /* On displays with a mutable colormap, figure out the colors
9190 allocated for the image by looking at the pixels of an XImage for
9191 img->pixmap. */
9192 class = FRAME_X_VISUAL (f)->class;
9193 if (class != StaticColor && class != StaticGray && class != TrueColor)
9194 {
9195 XImage *ximg;
9196
9197 BLOCK_INPUT;
9198
9199 /* Try to get an XImage for img->pixmep. */
9200 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
9201 0, 0, img->width, img->height, ~0, ZPixmap);
9202 if (ximg)
9203 {
9204 int x, y;
9205
9206 /* Initialize the color table. */
9207 init_color_table ();
9208
9209 /* For each pixel of the image, look its color up in the
9210 color table. After having done so, the color table will
9211 contain an entry for each color used by the image. */
9212 for (y = 0; y < img->height; ++y)
9213 for (x = 0; x < img->width; ++x)
9214 {
9215 unsigned long pixel = XGetPixel (ximg, x, y);
9216 lookup_pixel_color (f, pixel);
9217 }
9218
9219 /* Record colors in the image. Free color table and XImage. */
9220 img->colors = colors_in_color_table (&img->ncolors);
9221 free_color_table ();
9222 XDestroyImage (ximg);
9223
9224 #if 0 /* This doesn't seem to be the case. If we free the colors
9225 here, we get a BadAccess later in x_clear_image when
9226 freeing the colors. */
9227 /* We have allocated colors once, but Ghostscript has also
9228 allocated colors on behalf of us. So, to get the
9229 reference counts right, free them once. */
9230 if (img->ncolors)
9231 x_free_colors (f, img->colors, img->ncolors);
9232 #endif
9233 }
9234 else
9235 image_error ("Cannot get X image of `%s'; colors will not be freed",
9236 img->spec, Qnil);
9237
9238 UNBLOCK_INPUT;
9239 }
9240 }
9241
9242
9243 \f
9244 /***********************************************************************
9245 Window properties
9246 ***********************************************************************/
9247
9248 DEFUN ("x-change-window-property", Fx_change_window_property,
9249 Sx_change_window_property, 2, 3, 0,
9250 "Change window property PROP to VALUE on the X window of FRAME.\n\
9251 PROP and VALUE must be strings. FRAME nil or omitted means use the\n\
9252 selected frame. Value is VALUE.")
9253 (prop, value, frame)
9254 Lisp_Object frame, prop, value;
9255 {
9256 struct frame *f = check_x_frame (frame);
9257 Atom prop_atom;
9258
9259 CHECK_STRING (prop, 1);
9260 CHECK_STRING (value, 2);
9261
9262 BLOCK_INPUT;
9263 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
9264 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9265 prop_atom, XA_STRING, 8, PropModeReplace,
9266 XSTRING (value)->data, XSTRING (value)->size);
9267
9268 /* Make sure the property is set when we return. */
9269 XFlush (FRAME_X_DISPLAY (f));
9270 UNBLOCK_INPUT;
9271
9272 return value;
9273 }
9274
9275
9276 DEFUN ("x-delete-window-property", Fx_delete_window_property,
9277 Sx_delete_window_property, 1, 2, 0,
9278 "Remove window property PROP from X window of FRAME.\n\
9279 FRAME nil or omitted means use the selected frame. Value is PROP.")
9280 (prop, frame)
9281 Lisp_Object prop, frame;
9282 {
9283 struct frame *f = check_x_frame (frame);
9284 Atom prop_atom;
9285
9286 CHECK_STRING (prop, 1);
9287 BLOCK_INPUT;
9288 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
9289 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
9290
9291 /* Make sure the property is removed when we return. */
9292 XFlush (FRAME_X_DISPLAY (f));
9293 UNBLOCK_INPUT;
9294
9295 return prop;
9296 }
9297
9298
9299 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
9300 1, 2, 0,
9301 "Value is the value of window property PROP on FRAME.\n\
9302 If FRAME is nil or omitted, use the selected frame. Value is nil\n\
9303 if FRAME hasn't a property with name PROP or if PROP has no string\n\
9304 value.")
9305 (prop, frame)
9306 Lisp_Object prop, frame;
9307 {
9308 struct frame *f = check_x_frame (frame);
9309 Atom prop_atom;
9310 int rc;
9311 Lisp_Object prop_value = Qnil;
9312 char *tmp_data = NULL;
9313 Atom actual_type;
9314 int actual_format;
9315 unsigned long actual_size, bytes_remaining;
9316
9317 CHECK_STRING (prop, 1);
9318 BLOCK_INPUT;
9319 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
9320 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9321 prop_atom, 0, 0, False, XA_STRING,
9322 &actual_type, &actual_format, &actual_size,
9323 &bytes_remaining, (unsigned char **) &tmp_data);
9324 if (rc == Success)
9325 {
9326 int size = bytes_remaining;
9327
9328 XFree (tmp_data);
9329 tmp_data = NULL;
9330
9331 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9332 prop_atom, 0, bytes_remaining,
9333 False, XA_STRING,
9334 &actual_type, &actual_format,
9335 &actual_size, &bytes_remaining,
9336 (unsigned char **) &tmp_data);
9337 if (rc == Success)
9338 prop_value = make_string (tmp_data, size);
9339
9340 XFree (tmp_data);
9341 }
9342
9343 UNBLOCK_INPUT;
9344 return prop_value;
9345 }
9346
9347
9348 \f
9349 /***********************************************************************
9350 Busy cursor
9351 ***********************************************************************/
9352
9353 /* If non-null, an asynchronous timer that, when it expires, displays
9354 a busy cursor on all frames. */
9355
9356 static struct atimer *busy_cursor_atimer;
9357
9358 /* Non-zero means a busy cursor is currently shown. */
9359
9360 static int busy_cursor_shown_p;
9361
9362 /* Number of seconds to wait before displaying a busy cursor. */
9363
9364 static Lisp_Object Vbusy_cursor_delay;
9365
9366 /* Default number of seconds to wait before displaying a busy
9367 cursor. */
9368
9369 #define DEFAULT_BUSY_CURSOR_DELAY 1
9370
9371 /* Function prototypes. */
9372
9373 static void show_busy_cursor P_ ((struct atimer *));
9374 static void hide_busy_cursor P_ ((void));
9375
9376
9377 /* Cancel a currently active busy-cursor timer, and start a new one. */
9378
9379 void
9380 start_busy_cursor ()
9381 {
9382 EMACS_TIME delay;
9383 int secs, usecs = 0;
9384
9385 cancel_busy_cursor ();
9386
9387 if (INTEGERP (Vbusy_cursor_delay)
9388 && XINT (Vbusy_cursor_delay) > 0)
9389 secs = XFASTINT (Vbusy_cursor_delay);
9390 else if (FLOATP (Vbusy_cursor_delay)
9391 && XFLOAT_DATA (Vbusy_cursor_delay) > 0)
9392 {
9393 Lisp_Object tem;
9394 tem = Ftruncate (Vbusy_cursor_delay, Qnil);
9395 secs = XFASTINT (tem);
9396 usecs = (XFLOAT_DATA (Vbusy_cursor_delay) - secs) * 1000000;
9397 }
9398 else
9399 secs = DEFAULT_BUSY_CURSOR_DELAY;
9400
9401 EMACS_SET_SECS_USECS (delay, secs, usecs);
9402 busy_cursor_atimer = start_atimer (ATIMER_RELATIVE, delay,
9403 show_busy_cursor, NULL);
9404 }
9405
9406
9407 /* Cancel the busy cursor timer if active, hide a busy cursor if
9408 shown. */
9409
9410 void
9411 cancel_busy_cursor ()
9412 {
9413 if (busy_cursor_atimer)
9414 {
9415 cancel_atimer (busy_cursor_atimer);
9416 busy_cursor_atimer = NULL;
9417 }
9418
9419 if (busy_cursor_shown_p)
9420 hide_busy_cursor ();
9421 }
9422
9423
9424 /* Timer function of busy_cursor_atimer. TIMER is equal to
9425 busy_cursor_atimer.
9426
9427 Display a busy cursor on all frames by mapping the frames'
9428 busy_window. Set the busy_p flag in the frames' output_data.x
9429 structure to indicate that a busy cursor is shown on the
9430 frames. */
9431
9432 static void
9433 show_busy_cursor (timer)
9434 struct atimer *timer;
9435 {
9436 /* The timer implementation will cancel this timer automatically
9437 after this function has run. Set busy_cursor_atimer to null
9438 so that we know the timer doesn't have to be canceled. */
9439 busy_cursor_atimer = NULL;
9440
9441 if (!busy_cursor_shown_p)
9442 {
9443 Lisp_Object rest, frame;
9444
9445 BLOCK_INPUT;
9446
9447 FOR_EACH_FRAME (rest, frame)
9448 if (FRAME_X_P (XFRAME (frame)))
9449 {
9450 struct frame *f = XFRAME (frame);
9451
9452 f->output_data.x->busy_p = 1;
9453
9454 if (!f->output_data.x->busy_window)
9455 {
9456 unsigned long mask = CWCursor;
9457 XSetWindowAttributes attrs;
9458
9459 attrs.cursor = f->output_data.x->busy_cursor;
9460
9461 f->output_data.x->busy_window
9462 = XCreateWindow (FRAME_X_DISPLAY (f),
9463 FRAME_OUTER_WINDOW (f),
9464 0, 0, 32000, 32000, 0, 0,
9465 InputOnly,
9466 CopyFromParent,
9467 mask, &attrs);
9468 }
9469
9470 XMapRaised (FRAME_X_DISPLAY (f), f->output_data.x->busy_window);
9471 XFlush (FRAME_X_DISPLAY (f));
9472 }
9473
9474 busy_cursor_shown_p = 1;
9475 UNBLOCK_INPUT;
9476 }
9477 }
9478
9479
9480 /* Hide the busy cursor on all frames, if it is currently shown. */
9481
9482 static void
9483 hide_busy_cursor ()
9484 {
9485 if (busy_cursor_shown_p)
9486 {
9487 Lisp_Object rest, frame;
9488
9489 BLOCK_INPUT;
9490 FOR_EACH_FRAME (rest, frame)
9491 {
9492 struct frame *f = XFRAME (frame);
9493
9494 if (FRAME_X_P (f)
9495 /* Watch out for newly created frames. */
9496 && f->output_data.x->busy_window)
9497 {
9498 XUnmapWindow (FRAME_X_DISPLAY (f), f->output_data.x->busy_window);
9499 /* Sync here because XTread_socket looks at the busy_p flag
9500 that is reset to zero below. */
9501 XSync (FRAME_X_DISPLAY (f), False);
9502 f->output_data.x->busy_p = 0;
9503 }
9504 }
9505
9506 busy_cursor_shown_p = 0;
9507 UNBLOCK_INPUT;
9508 }
9509 }
9510
9511
9512 \f
9513 /***********************************************************************
9514 Tool tips
9515 ***********************************************************************/
9516
9517 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
9518 Lisp_Object));
9519
9520 /* The frame of a currently visible tooltip, or null. */
9521
9522 struct frame *tip_frame;
9523
9524 /* If non-nil, a timer started that hides the last tooltip when it
9525 fires. */
9526
9527 Lisp_Object tip_timer;
9528 Window tip_window;
9529
9530 /* Create a frame for a tooltip on the display described by DPYINFO.
9531 PARMS is a list of frame parameters. Value is the frame. */
9532
9533 static Lisp_Object
9534 x_create_tip_frame (dpyinfo, parms)
9535 struct x_display_info *dpyinfo;
9536 Lisp_Object parms;
9537 {
9538 struct frame *f;
9539 Lisp_Object frame, tem;
9540 Lisp_Object name;
9541 long window_prompting = 0;
9542 int width, height;
9543 int count = specpdl_ptr - specpdl;
9544 struct gcpro gcpro1, gcpro2, gcpro3;
9545 struct kboard *kb;
9546
9547 check_x ();
9548
9549 /* Use this general default value to start with until we know if
9550 this frame has a specified name. */
9551 Vx_resource_name = Vinvocation_name;
9552
9553 #ifdef MULTI_KBOARD
9554 kb = dpyinfo->kboard;
9555 #else
9556 kb = &the_only_kboard;
9557 #endif
9558
9559 /* Get the name of the frame to use for resource lookup. */
9560 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
9561 if (!STRINGP (name)
9562 && !EQ (name, Qunbound)
9563 && !NILP (name))
9564 error ("Invalid frame name--not a string or nil");
9565 Vx_resource_name = name;
9566
9567 frame = Qnil;
9568 GCPRO3 (parms, name, frame);
9569 tip_frame = f = make_frame (1);
9570 XSETFRAME (frame, f);
9571 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
9572
9573 f->output_method = output_x_window;
9574 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
9575 bzero (f->output_data.x, sizeof (struct x_output));
9576 f->output_data.x->icon_bitmap = -1;
9577 f->output_data.x->fontset = -1;
9578 f->output_data.x->scroll_bar_foreground_pixel = -1;
9579 f->output_data.x->scroll_bar_background_pixel = -1;
9580 f->icon_name = Qnil;
9581 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
9582 #ifdef MULTI_KBOARD
9583 FRAME_KBOARD (f) = kb;
9584 #endif
9585 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
9586 f->output_data.x->explicit_parent = 0;
9587
9588 /* These colors will be set anyway later, but it's important
9589 to get the color reference counts right, so initialize them! */
9590 {
9591 Lisp_Object black;
9592 struct gcpro gcpro1;
9593
9594 black = build_string ("black");
9595 GCPRO1 (black);
9596 f->output_data.x->foreground_pixel
9597 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
9598 f->output_data.x->background_pixel
9599 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
9600 f->output_data.x->cursor_pixel
9601 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
9602 f->output_data.x->cursor_foreground_pixel
9603 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
9604 f->output_data.x->border_pixel
9605 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
9606 f->output_data.x->mouse_pixel
9607 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
9608 UNGCPRO;
9609 }
9610
9611 /* Set the name; the functions to which we pass f expect the name to
9612 be set. */
9613 if (EQ (name, Qunbound) || NILP (name))
9614 {
9615 f->name = build_string (dpyinfo->x_id_name);
9616 f->explicit_name = 0;
9617 }
9618 else
9619 {
9620 f->name = name;
9621 f->explicit_name = 1;
9622 /* use the frame's title when getting resources for this frame. */
9623 specbind (Qx_resource_name, name);
9624 }
9625
9626 /* Extract the window parameters from the supplied values
9627 that are needed to determine window geometry. */
9628 {
9629 Lisp_Object font;
9630
9631 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
9632
9633 BLOCK_INPUT;
9634 /* First, try whatever font the caller has specified. */
9635 if (STRINGP (font))
9636 {
9637 tem = Fquery_fontset (font, Qnil);
9638 if (STRINGP (tem))
9639 font = x_new_fontset (f, XSTRING (tem)->data);
9640 else
9641 font = x_new_font (f, XSTRING (font)->data);
9642 }
9643
9644 /* Try out a font which we hope has bold and italic variations. */
9645 if (!STRINGP (font))
9646 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
9647 if (!STRINGP (font))
9648 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
9649 if (! STRINGP (font))
9650 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
9651 if (! STRINGP (font))
9652 /* This was formerly the first thing tried, but it finds too many fonts
9653 and takes too long. */
9654 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
9655 /* If those didn't work, look for something which will at least work. */
9656 if (! STRINGP (font))
9657 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
9658 UNBLOCK_INPUT;
9659 if (! STRINGP (font))
9660 font = build_string ("fixed");
9661
9662 x_default_parameter (f, parms, Qfont, font,
9663 "font", "Font", RES_TYPE_STRING);
9664 }
9665
9666 x_default_parameter (f, parms, Qborder_width, make_number (2),
9667 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
9668
9669 /* This defaults to 2 in order to match xterm. We recognize either
9670 internalBorderWidth or internalBorder (which is what xterm calls
9671 it). */
9672 if (NILP (Fassq (Qinternal_border_width, parms)))
9673 {
9674 Lisp_Object value;
9675
9676 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
9677 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
9678 if (! EQ (value, Qunbound))
9679 parms = Fcons (Fcons (Qinternal_border_width, value),
9680 parms);
9681 }
9682
9683 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
9684 "internalBorderWidth", "internalBorderWidth",
9685 RES_TYPE_NUMBER);
9686
9687 /* Also do the stuff which must be set before the window exists. */
9688 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
9689 "foreground", "Foreground", RES_TYPE_STRING);
9690 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
9691 "background", "Background", RES_TYPE_STRING);
9692 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
9693 "pointerColor", "Foreground", RES_TYPE_STRING);
9694 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
9695 "cursorColor", "Foreground", RES_TYPE_STRING);
9696 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
9697 "borderColor", "BorderColor", RES_TYPE_STRING);
9698
9699 /* Init faces before x_default_parameter is called for scroll-bar
9700 parameters because that function calls x_set_scroll_bar_width,
9701 which calls change_frame_size, which calls Fset_window_buffer,
9702 which runs hooks, which call Fvertical_motion. At the end, we
9703 end up in init_iterator with a null face cache, which should not
9704 happen. */
9705 init_frame_faces (f);
9706
9707 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
9708 window_prompting = x_figure_window_size (f, parms);
9709
9710 if (window_prompting & XNegative)
9711 {
9712 if (window_prompting & YNegative)
9713 f->output_data.x->win_gravity = SouthEastGravity;
9714 else
9715 f->output_data.x->win_gravity = NorthEastGravity;
9716 }
9717 else
9718 {
9719 if (window_prompting & YNegative)
9720 f->output_data.x->win_gravity = SouthWestGravity;
9721 else
9722 f->output_data.x->win_gravity = NorthWestGravity;
9723 }
9724
9725 f->output_data.x->size_hint_flags = window_prompting;
9726 {
9727 XSetWindowAttributes attrs;
9728 unsigned long mask;
9729
9730 BLOCK_INPUT;
9731 mask = CWBackPixel | CWOverrideRedirect | CWSaveUnder | CWEventMask;
9732 /* Window managers look at the override-redirect flag to determine
9733 whether or net to give windows a decoration (Xlib spec, chapter
9734 3.2.8). */
9735 attrs.override_redirect = True;
9736 attrs.save_under = True;
9737 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
9738 /* Arrange for getting MapNotify and UnmapNotify events. */
9739 attrs.event_mask = StructureNotifyMask;
9740 tip_window
9741 = FRAME_X_WINDOW (f)
9742 = XCreateWindow (FRAME_X_DISPLAY (f),
9743 FRAME_X_DISPLAY_INFO (f)->root_window,
9744 /* x, y, width, height */
9745 0, 0, 1, 1,
9746 /* Border. */
9747 1,
9748 CopyFromParent, InputOutput, CopyFromParent,
9749 mask, &attrs);
9750 UNBLOCK_INPUT;
9751 }
9752
9753 x_make_gc (f);
9754
9755 x_default_parameter (f, parms, Qauto_raise, Qnil,
9756 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
9757 x_default_parameter (f, parms, Qauto_lower, Qnil,
9758 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
9759 x_default_parameter (f, parms, Qcursor_type, Qbox,
9760 "cursorType", "CursorType", RES_TYPE_SYMBOL);
9761
9762 /* Dimensions, especially f->height, must be done via change_frame_size.
9763 Change will not be effected unless different from the current
9764 f->height. */
9765 width = f->width;
9766 height = f->height;
9767 f->height = 0;
9768 SET_FRAME_WIDTH (f, 0);
9769 change_frame_size (f, height, width, 1, 0, 0);
9770
9771 f->no_split = 1;
9772
9773 UNGCPRO;
9774
9775 /* It is now ok to make the frame official even if we get an error
9776 below. And the frame needs to be on Vframe_list or making it
9777 visible won't work. */
9778 Vframe_list = Fcons (frame, Vframe_list);
9779
9780 /* Now that the frame is official, it counts as a reference to
9781 its display. */
9782 FRAME_X_DISPLAY_INFO (f)->reference_count++;
9783
9784 return unbind_to (count, frame);
9785 }
9786
9787
9788 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 4, 0,
9789 "Show STRING in a \"tooltip\" window on frame FRAME.\n\
9790 A tooltip window is a small X window displaying STRING at\n\
9791 the current mouse position.\n\
9792 FRAME nil or omitted means use the selected frame.\n\
9793 PARMS is an optional list of frame parameters which can be\n\
9794 used to change the tooltip's appearance.\n\
9795 Automatically hide the tooltip after TIMEOUT seconds.\n\
9796 TIMEOUT nil means use the default timeout of 5 seconds.")
9797 (string, frame, parms, timeout)
9798 Lisp_Object string, frame, parms, timeout;
9799 {
9800 struct frame *f;
9801 struct window *w;
9802 Window root, child;
9803 Lisp_Object buffer;
9804 struct buffer *old_buffer;
9805 struct text_pos pos;
9806 int i, width, height;
9807 int root_x, root_y, win_x, win_y;
9808 unsigned pmask;
9809 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
9810 int old_windows_or_buffers_changed = windows_or_buffers_changed;
9811 int count = specpdl_ptr - specpdl;
9812
9813 specbind (Qinhibit_redisplay, Qt);
9814
9815 GCPRO4 (string, parms, frame, timeout);
9816
9817 CHECK_STRING (string, 0);
9818 f = check_x_frame (frame);
9819 if (NILP (timeout))
9820 timeout = make_number (5);
9821 else
9822 CHECK_NATNUM (timeout, 2);
9823
9824 /* Hide a previous tip, if any. */
9825 Fx_hide_tip ();
9826
9827 /* Add default values to frame parameters. */
9828 if (NILP (Fassq (Qname, parms)))
9829 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
9830 if (NILP (Fassq (Qinternal_border_width, parms)))
9831 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
9832 if (NILP (Fassq (Qborder_width, parms)))
9833 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
9834 if (NILP (Fassq (Qborder_color, parms)))
9835 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
9836 if (NILP (Fassq (Qbackground_color, parms)))
9837 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
9838 parms);
9839
9840 /* Create a frame for the tooltip, and record it in the global
9841 variable tip_frame. */
9842 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms);
9843 tip_frame = f = XFRAME (frame);
9844
9845 /* Set up the frame's root window. Currently we use a size of 80
9846 columns x 40 lines. If someone wants to show a larger tip, he
9847 will loose. I don't think this is a realistic case. */
9848 w = XWINDOW (FRAME_ROOT_WINDOW (f));
9849 w->left = w->top = make_number (0);
9850 w->width = make_number (80);
9851 w->height = make_number (40);
9852 adjust_glyphs (f);
9853 w->pseudo_window_p = 1;
9854
9855 /* Display the tooltip text in a temporary buffer. */
9856 buffer = Fget_buffer_create (build_string (" *tip*"));
9857 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer);
9858 old_buffer = current_buffer;
9859 set_buffer_internal_1 (XBUFFER (buffer));
9860 Ferase_buffer ();
9861 Finsert (1, &string);
9862 clear_glyph_matrix (w->desired_matrix);
9863 clear_glyph_matrix (w->current_matrix);
9864 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
9865 try_window (FRAME_ROOT_WINDOW (f), pos);
9866
9867 /* Compute width and height of the tooltip. */
9868 width = height = 0;
9869 for (i = 0; i < w->desired_matrix->nrows; ++i)
9870 {
9871 struct glyph_row *row = &w->desired_matrix->rows[i];
9872 struct glyph *last;
9873 int row_width;
9874
9875 /* Stop at the first empty row at the end. */
9876 if (!row->enabled_p || !row->displays_text_p)
9877 break;
9878
9879 /* Let the row go over the full width of the frame. */
9880 row->full_width_p = 1;
9881
9882 /* There's a glyph at the end of rows that is used to place
9883 the cursor there. Don't include the width of this glyph. */
9884 if (row->used[TEXT_AREA])
9885 {
9886 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
9887 row_width = row->pixel_width - last->pixel_width;
9888 }
9889 else
9890 row_width = row->pixel_width;
9891
9892 height += row->height;
9893 width = max (width, row_width);
9894 }
9895
9896 /* Add the frame's internal border to the width and height the X
9897 window should have. */
9898 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
9899 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
9900
9901 /* Move the tooltip window where the mouse pointer is. Resize and
9902 show it. */
9903 BLOCK_INPUT;
9904 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
9905 &root, &child, &root_x, &root_y, &win_x, &win_y, &pmask);
9906 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9907 root_x + 5, root_y - height - 5, width, height);
9908 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9909 UNBLOCK_INPUT;
9910
9911 /* Draw into the window. */
9912 w->must_be_updated_p = 1;
9913 update_single_window (w, 1);
9914
9915 /* Restore original current buffer. */
9916 set_buffer_internal_1 (old_buffer);
9917 windows_or_buffers_changed = old_windows_or_buffers_changed;
9918
9919 /* Let the tip disappear after timeout seconds. */
9920 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
9921 intern ("x-hide-tip"));
9922
9923 UNGCPRO;
9924 return unbind_to (count, Qnil);
9925 }
9926
9927
9928 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
9929 "Hide the current tooltip window, if there is any.\n\
9930 Value is t is tooltip was open, nil otherwise.")
9931 ()
9932 {
9933 int count = specpdl_ptr - specpdl;
9934 int deleted_p = 0;
9935
9936 specbind (Qinhibit_redisplay, Qt);
9937
9938 if (!NILP (tip_timer))
9939 {
9940 call1 (intern ("cancel-timer"), tip_timer);
9941 tip_timer = Qnil;
9942 }
9943
9944 if (tip_frame)
9945 {
9946 Lisp_Object frame;
9947
9948 XSETFRAME (frame, tip_frame);
9949 Fdelete_frame (frame, Qt);
9950 tip_frame = NULL;
9951 deleted_p = 1;
9952 }
9953
9954 return unbind_to (count, deleted_p ? Qt : Qnil);
9955 }
9956
9957
9958 \f
9959 /***********************************************************************
9960 File selection dialog
9961 ***********************************************************************/
9962
9963 #ifdef USE_MOTIF
9964
9965 /* Callback for "OK" and "Cancel" on file selection dialog. */
9966
9967 static void
9968 file_dialog_cb (widget, client_data, call_data)
9969 Widget widget;
9970 XtPointer call_data, client_data;
9971 {
9972 int *result = (int *) client_data;
9973 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
9974 *result = cb->reason;
9975 }
9976
9977
9978 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0,
9979 "Read file name, prompting with PROMPT in directory DIR.\n\
9980 Use a file selection dialog.\n\
9981 Select DEFAULT-FILENAME in the dialog's file selection box, if\n\
9982 specified. Don't let the user enter a file name in the file\n\
9983 selection dialog's entry field, if MUSTMATCH is non-nil.")
9984 (prompt, dir, default_filename, mustmatch)
9985 Lisp_Object prompt, dir, default_filename, mustmatch;
9986 {
9987 int result;
9988 struct frame *f = SELECTED_FRAME ();
9989 Lisp_Object file = Qnil;
9990 Widget dialog, text, list, help;
9991 Arg al[10];
9992 int ac = 0;
9993 extern XtAppContext Xt_app_con;
9994 char *title;
9995 XmString dir_xmstring, pattern_xmstring;
9996 int popup_activated_flag;
9997 int count = specpdl_ptr - specpdl;
9998 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
9999
10000 GCPRO5 (prompt, dir, default_filename, mustmatch, file);
10001 CHECK_STRING (prompt, 0);
10002 CHECK_STRING (dir, 1);
10003
10004 /* Prevent redisplay. */
10005 specbind (Qinhibit_redisplay, Qt);
10006
10007 BLOCK_INPUT;
10008
10009 /* Create the dialog with PROMPT as title, using DIR as initial
10010 directory and using "*" as pattern. */
10011 dir = Fexpand_file_name (dir, Qnil);
10012 dir_xmstring = XmStringCreateLocalized (XSTRING (dir)->data);
10013 pattern_xmstring = XmStringCreateLocalized ("*");
10014
10015 XtSetArg (al[ac], XmNtitle, XSTRING (prompt)->data); ++ac;
10016 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
10017 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
10018 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
10019 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
10020 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
10021 "fsb", al, ac);
10022 XmStringFree (dir_xmstring);
10023 XmStringFree (pattern_xmstring);
10024
10025 /* Add callbacks for OK and Cancel. */
10026 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
10027 (XtPointer) &result);
10028 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
10029 (XtPointer) &result);
10030
10031 /* Disable the help button since we can't display help. */
10032 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
10033 XtSetSensitive (help, False);
10034
10035 /* Mark OK button as default. */
10036 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
10037 XmNshowAsDefault, True, NULL);
10038
10039 /* If MUSTMATCH is non-nil, disable the file entry field of the
10040 dialog, so that the user must select a file from the files list
10041 box. We can't remove it because we wouldn't have a way to get at
10042 the result file name, then. */
10043 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
10044 if (!NILP (mustmatch))
10045 {
10046 Widget label;
10047 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
10048 XtSetSensitive (text, False);
10049 XtSetSensitive (label, False);
10050 }
10051
10052 /* Manage the dialog, so that list boxes get filled. */
10053 XtManageChild (dialog);
10054
10055 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
10056 must include the path for this to work. */
10057 list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
10058 if (STRINGP (default_filename))
10059 {
10060 XmString default_xmstring;
10061 int item_pos;
10062
10063 default_xmstring
10064 = XmStringCreateLocalized (XSTRING (default_filename)->data);
10065
10066 if (!XmListItemExists (list, default_xmstring))
10067 {
10068 /* Add a new item if DEFAULT_FILENAME is not in the list. */
10069 XmListAddItem (list, default_xmstring, 0);
10070 item_pos = 0;
10071 }
10072 else
10073 item_pos = XmListItemPos (list, default_xmstring);
10074 XmStringFree (default_xmstring);
10075
10076 /* Select the item and scroll it into view. */
10077 XmListSelectPos (list, item_pos, True);
10078 XmListSetPos (list, item_pos);
10079 }
10080
10081 #ifdef HAVE_MOTIF_2_1
10082
10083 /* Process events until the user presses Cancel or OK. */
10084 result = 0;
10085 while (result == 0 || XtAppPending (Xt_app_con))
10086 XtAppProcessEvent (Xt_app_con, XtIMAll);
10087
10088 #else /* not HAVE_MOTIF_2_1 */
10089
10090 /* Process all events until the user presses Cancel or OK. */
10091 for (result = 0; result == 0;)
10092 {
10093 XEvent event;
10094 Widget widget, parent;
10095
10096 XtAppNextEvent (Xt_app_con, &event);
10097
10098 /* See if the receiver of the event is one of the widgets of
10099 the file selection dialog. If so, dispatch it. If not,
10100 discard it. */
10101 widget = XtWindowToWidget (event.xany.display, event.xany.window);
10102 parent = widget;
10103 while (parent && parent != dialog)
10104 parent = XtParent (parent);
10105
10106 if (parent == dialog
10107 || (event.type == Expose
10108 && !process_expose_from_menu (event)))
10109 XtDispatchEvent (&event);
10110 }
10111
10112 #endif /* not HAVE_MOTIF_2_1 */
10113
10114 /* Get the result. */
10115 if (result == XmCR_OK)
10116 {
10117 XmString text;
10118 String data;
10119
10120 XtVaGetValues (dialog, XmNtextString, &text, 0);
10121 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
10122 XmStringFree (text);
10123 file = build_string (data);
10124 XtFree (data);
10125 }
10126 else
10127 file = Qnil;
10128
10129 /* Clean up. */
10130 XtUnmanageChild (dialog);
10131 XtDestroyWidget (dialog);
10132 UNBLOCK_INPUT;
10133 UNGCPRO;
10134
10135 /* Make "Cancel" equivalent to C-g. */
10136 if (NILP (file))
10137 Fsignal (Qquit, Qnil);
10138
10139 return unbind_to (count, file);
10140 }
10141
10142 #endif /* USE_MOTIF */
10143
10144
10145 \f
10146 /***********************************************************************
10147 Initialization
10148 ***********************************************************************/
10149
10150 void
10151 syms_of_xfns ()
10152 {
10153 /* This is zero if not using X windows. */
10154 x_in_use = 0;
10155
10156 /* The section below is built by the lisp expression at the top of the file,
10157 just above where these variables are declared. */
10158 /*&&& init symbols here &&&*/
10159 Qauto_raise = intern ("auto-raise");
10160 staticpro (&Qauto_raise);
10161 Qauto_lower = intern ("auto-lower");
10162 staticpro (&Qauto_lower);
10163 Qbar = intern ("bar");
10164 staticpro (&Qbar);
10165 Qborder_color = intern ("border-color");
10166 staticpro (&Qborder_color);
10167 Qborder_width = intern ("border-width");
10168 staticpro (&Qborder_width);
10169 Qbox = intern ("box");
10170 staticpro (&Qbox);
10171 Qcursor_color = intern ("cursor-color");
10172 staticpro (&Qcursor_color);
10173 Qcursor_type = intern ("cursor-type");
10174 staticpro (&Qcursor_type);
10175 Qgeometry = intern ("geometry");
10176 staticpro (&Qgeometry);
10177 Qicon_left = intern ("icon-left");
10178 staticpro (&Qicon_left);
10179 Qicon_top = intern ("icon-top");
10180 staticpro (&Qicon_top);
10181 Qicon_type = intern ("icon-type");
10182 staticpro (&Qicon_type);
10183 Qicon_name = intern ("icon-name");
10184 staticpro (&Qicon_name);
10185 Qinternal_border_width = intern ("internal-border-width");
10186 staticpro (&Qinternal_border_width);
10187 Qleft = intern ("left");
10188 staticpro (&Qleft);
10189 Qright = intern ("right");
10190 staticpro (&Qright);
10191 Qmouse_color = intern ("mouse-color");
10192 staticpro (&Qmouse_color);
10193 Qnone = intern ("none");
10194 staticpro (&Qnone);
10195 Qparent_id = intern ("parent-id");
10196 staticpro (&Qparent_id);
10197 Qscroll_bar_width = intern ("scroll-bar-width");
10198 staticpro (&Qscroll_bar_width);
10199 Qsuppress_icon = intern ("suppress-icon");
10200 staticpro (&Qsuppress_icon);
10201 Qundefined_color = intern ("undefined-color");
10202 staticpro (&Qundefined_color);
10203 Qvertical_scroll_bars = intern ("vertical-scroll-bars");
10204 staticpro (&Qvertical_scroll_bars);
10205 Qvisibility = intern ("visibility");
10206 staticpro (&Qvisibility);
10207 Qwindow_id = intern ("window-id");
10208 staticpro (&Qwindow_id);
10209 Qouter_window_id = intern ("outer-window-id");
10210 staticpro (&Qouter_window_id);
10211 Qx_frame_parameter = intern ("x-frame-parameter");
10212 staticpro (&Qx_frame_parameter);
10213 Qx_resource_name = intern ("x-resource-name");
10214 staticpro (&Qx_resource_name);
10215 Quser_position = intern ("user-position");
10216 staticpro (&Quser_position);
10217 Quser_size = intern ("user-size");
10218 staticpro (&Quser_size);
10219 Qscroll_bar_foreground = intern ("scroll-bar-foreground");
10220 staticpro (&Qscroll_bar_foreground);
10221 Qscroll_bar_background = intern ("scroll-bar-background");
10222 staticpro (&Qscroll_bar_background);
10223 Qscreen_gamma = intern ("screen-gamma");
10224 staticpro (&Qscreen_gamma);
10225 Qline_spacing = intern ("line-spacing");
10226 staticpro (&Qline_spacing);
10227 Qcenter = intern ("center");
10228 staticpro (&Qcenter);
10229 /* This is the end of symbol initialization. */
10230
10231 /* Text property `display' should be nonsticky by default. */
10232 Vtext_property_default_nonsticky
10233 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
10234
10235
10236 Qlaplace = intern ("laplace");
10237 staticpro (&Qlaplace);
10238
10239 Qface_set_after_frame_default = intern ("face-set-after-frame-default");
10240 staticpro (&Qface_set_after_frame_default);
10241
10242 Fput (Qundefined_color, Qerror_conditions,
10243 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
10244 Fput (Qundefined_color, Qerror_message,
10245 build_string ("Undefined color"));
10246
10247 init_x_parm_symbols ();
10248
10249 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
10250 "List of directories to search for bitmap files for X.");
10251 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
10252
10253 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
10254 "The shape of the pointer when over text.\n\
10255 Changing the value does not affect existing frames\n\
10256 unless you set the mouse color.");
10257 Vx_pointer_shape = Qnil;
10258
10259 DEFVAR_LISP ("x-resource-name", &Vx_resource_name,
10260 "The name Emacs uses to look up X resources.\n\
10261 `x-get-resource' uses this as the first component of the instance name\n\
10262 when requesting resource values.\n\
10263 Emacs initially sets `x-resource-name' to the name under which Emacs\n\
10264 was invoked, or to the value specified with the `-name' or `-rn'\n\
10265 switches, if present.\n\
10266 \n\
10267 It may be useful to bind this variable locally around a call\n\
10268 to `x-get-resource'. See also the variable `x-resource-class'.");
10269 Vx_resource_name = Qnil;
10270
10271 DEFVAR_LISP ("x-resource-class", &Vx_resource_class,
10272 "The class Emacs uses to look up X resources.\n\
10273 `x-get-resource' uses this as the first component of the instance class\n\
10274 when requesting resource values.\n\
10275 Emacs initially sets `x-resource-class' to \"Emacs\".\n\
10276 \n\
10277 Setting this variable permanently is not a reasonable thing to do,\n\
10278 but binding this variable locally around a call to `x-get-resource'\n\
10279 is a reasonable practice. See also the variable `x-resource-name'.");
10280 Vx_resource_class = build_string (EMACS_CLASS);
10281
10282 #if 0 /* This doesn't really do anything. */
10283 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
10284 "The shape of the pointer when not over text.\n\
10285 This variable takes effect when you create a new frame\n\
10286 or when you set the mouse color.");
10287 #endif
10288 Vx_nontext_pointer_shape = Qnil;
10289
10290 DEFVAR_LISP ("x-busy-pointer-shape", &Vx_busy_pointer_shape,
10291 "The shape of the pointer when Emacs is busy.\n\
10292 This variable takes effect when you create a new frame\n\
10293 or when you set the mouse color.");
10294 Vx_busy_pointer_shape = Qnil;
10295
10296 DEFVAR_BOOL ("display-busy-cursor", &display_busy_cursor_p,
10297 "Non-zero means Emacs displays a busy cursor on window systems.");
10298 display_busy_cursor_p = 1;
10299
10300 DEFVAR_LISP ("busy-cursor-delay", &Vbusy_cursor_delay,
10301 "*Seconds to wait before displaying a busy-cursor.\n\
10302 Value must be an integer or float.");
10303 Vbusy_cursor_delay = make_number (DEFAULT_BUSY_CURSOR_DELAY);
10304
10305 #if 0 /* This doesn't really do anything. */
10306 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
10307 "The shape of the pointer when over the mode line.\n\
10308 This variable takes effect when you create a new frame\n\
10309 or when you set the mouse color.");
10310 #endif
10311 Vx_mode_pointer_shape = Qnil;
10312
10313 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
10314 &Vx_sensitive_text_pointer_shape,
10315 "The shape of the pointer when over mouse-sensitive text.\n\
10316 This variable takes effect when you create a new frame\n\
10317 or when you set the mouse color.");
10318 Vx_sensitive_text_pointer_shape = Qnil;
10319
10320 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
10321 "A string indicating the foreground color of the cursor box.");
10322 Vx_cursor_fore_pixel = Qnil;
10323
10324 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
10325 "Non-nil if no X window manager is in use.\n\
10326 Emacs doesn't try to figure this out; this is always nil\n\
10327 unless you set it to something else.");
10328 /* We don't have any way to find this out, so set it to nil
10329 and maybe the user would like to set it to t. */
10330 Vx_no_window_manager = Qnil;
10331
10332 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
10333 &Vx_pixel_size_width_font_regexp,
10334 "Regexp matching a font name whose width is the same as `PIXEL_SIZE'.\n\
10335 \n\
10336 Since Emacs gets width of a font matching with this regexp from\n\
10337 PIXEL_SIZE field of the name, font finding mechanism gets faster for\n\
10338 such a font. This is especially effective for such large fonts as\n\
10339 Chinese, Japanese, and Korean.");
10340 Vx_pixel_size_width_font_regexp = Qnil;
10341
10342 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
10343 "Time after which cached images are removed from the cache.\n\
10344 When an image has not been displayed this many seconds, remove it\n\
10345 from the image cache. Value must be an integer or nil with nil\n\
10346 meaning don't clear the cache.");
10347 Vimage_cache_eviction_delay = make_number (30 * 60);
10348
10349 #ifdef USE_X_TOOLKIT
10350 Fprovide (intern ("x-toolkit"));
10351 #endif
10352 #ifdef USE_MOTIF
10353 Fprovide (intern ("motif"));
10354 #endif
10355
10356 defsubr (&Sx_get_resource);
10357
10358 /* X window properties. */
10359 defsubr (&Sx_change_window_property);
10360 defsubr (&Sx_delete_window_property);
10361 defsubr (&Sx_window_property);
10362
10363 defsubr (&Sxw_display_color_p);
10364 defsubr (&Sx_display_grayscale_p);
10365 defsubr (&Sxw_color_defined_p);
10366 defsubr (&Sxw_color_values);
10367 defsubr (&Sx_server_max_request_size);
10368 defsubr (&Sx_server_vendor);
10369 defsubr (&Sx_server_version);
10370 defsubr (&Sx_display_pixel_width);
10371 defsubr (&Sx_display_pixel_height);
10372 defsubr (&Sx_display_mm_width);
10373 defsubr (&Sx_display_mm_height);
10374 defsubr (&Sx_display_screens);
10375 defsubr (&Sx_display_planes);
10376 defsubr (&Sx_display_color_cells);
10377 defsubr (&Sx_display_visual_class);
10378 defsubr (&Sx_display_backing_store);
10379 defsubr (&Sx_display_save_under);
10380 defsubr (&Sx_parse_geometry);
10381 defsubr (&Sx_create_frame);
10382 defsubr (&Sx_open_connection);
10383 defsubr (&Sx_close_connection);
10384 defsubr (&Sx_display_list);
10385 defsubr (&Sx_synchronize);
10386 defsubr (&Sx_focus_frame);
10387
10388 /* Setting callback functions for fontset handler. */
10389 get_font_info_func = x_get_font_info;
10390
10391 #if 0 /* This function pointer doesn't seem to be used anywhere.
10392 And the pointer assigned has the wrong type, anyway. */
10393 list_fonts_func = x_list_fonts;
10394 #endif
10395
10396 load_font_func = x_load_font;
10397 find_ccl_program_func = x_find_ccl_program;
10398 query_font_func = x_query_font;
10399 set_frame_fontset_func = x_set_font;
10400 check_window_system_func = check_x;
10401
10402 /* Images. */
10403 Qxbm = intern ("xbm");
10404 staticpro (&Qxbm);
10405 QCtype = intern (":type");
10406 staticpro (&QCtype);
10407 QCalgorithm = intern (":algorithm");
10408 staticpro (&QCalgorithm);
10409 QCheuristic_mask = intern (":heuristic-mask");
10410 staticpro (&QCheuristic_mask);
10411 QCcolor_symbols = intern (":color-symbols");
10412 staticpro (&QCcolor_symbols);
10413 QCascent = intern (":ascent");
10414 staticpro (&QCascent);
10415 QCmargin = intern (":margin");
10416 staticpro (&QCmargin);
10417 QCrelief = intern (":relief");
10418 staticpro (&QCrelief);
10419 Qpostscript = intern ("postscript");
10420 staticpro (&Qpostscript);
10421 QCloader = intern (":loader");
10422 staticpro (&QCloader);
10423 QCbounding_box = intern (":bounding-box");
10424 staticpro (&QCbounding_box);
10425 QCpt_width = intern (":pt-width");
10426 staticpro (&QCpt_width);
10427 QCpt_height = intern (":pt-height");
10428 staticpro (&QCpt_height);
10429 QCindex = intern (":index");
10430 staticpro (&QCindex);
10431 Qpbm = intern ("pbm");
10432 staticpro (&Qpbm);
10433
10434 #if HAVE_XPM
10435 Qxpm = intern ("xpm");
10436 staticpro (&Qxpm);
10437 #endif
10438
10439 #if HAVE_JPEG
10440 Qjpeg = intern ("jpeg");
10441 staticpro (&Qjpeg);
10442 #endif
10443
10444 #if HAVE_TIFF
10445 Qtiff = intern ("tiff");
10446 staticpro (&Qtiff);
10447 #endif
10448
10449 #if HAVE_GIF
10450 Qgif = intern ("gif");
10451 staticpro (&Qgif);
10452 #endif
10453
10454 #if HAVE_PNG
10455 Qpng = intern ("png");
10456 staticpro (&Qpng);
10457 #endif
10458
10459 defsubr (&Sclear_image_cache);
10460
10461 busy_cursor_atimer = NULL;
10462 busy_cursor_shown_p = 0;
10463
10464 defsubr (&Sx_show_tip);
10465 defsubr (&Sx_hide_tip);
10466 staticpro (&tip_timer);
10467 tip_timer = Qnil;
10468
10469 #ifdef USE_MOTIF
10470 defsubr (&Sx_file_dialog);
10471 #endif
10472 }
10473
10474
10475 void
10476 init_xfns ()
10477 {
10478 image_types = NULL;
10479 Vimage_types = Qnil;
10480
10481 define_image_type (&xbm_type);
10482 define_image_type (&gs_type);
10483 define_image_type (&pbm_type);
10484
10485 #if HAVE_XPM
10486 define_image_type (&xpm_type);
10487 #endif
10488
10489 #if HAVE_JPEG
10490 define_image_type (&jpeg_type);
10491 #endif
10492
10493 #if HAVE_TIFF
10494 define_image_type (&tiff_type);
10495 #endif
10496
10497 #if HAVE_GIF
10498 define_image_type (&gif_type);
10499 #endif
10500
10501 #if HAVE_PNG
10502 define_image_type (&png_type);
10503 #endif
10504 }
10505
10506 #endif /* HAVE_X_WINDOWS */