(mm-inline-media-tests): Add
[emacs.git] / src / xfns.c
blob5c0d3ec5f6a3c577ab963c5de9be0283c43136b0
1 /* Functions for the X window system.
2 Copyright (C) 1989, 92, 93, 94, 95, 96, 1997, 1998, 1999, 2000
3 Free Software Foundation.
5 This file is part of GNU Emacs.
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.
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.
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. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <math.h>
27 /* This makes the fields of a Display accessible, in Xlib header files. */
29 #define XLIB_ILLEGAL_ACCESS
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 "coding.h"
43 #include "fontset.h"
44 #include "systime.h"
45 #include "termhooks.h"
46 #include "atimer.h"
48 #ifdef HAVE_X_WINDOWS
50 #include <ctype.h>
51 #include <sys/types.h>
52 #include <sys/stat.h>
54 #ifndef VMS
55 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
56 #include "bitmaps/gray.xbm"
57 #else
58 #include <X11/bitmaps/gray>
59 #endif
60 #else
61 #include "[.bitmaps]gray.xbm"
62 #endif
64 #ifdef USE_X_TOOLKIT
65 #include <X11/Shell.h>
67 #ifndef USE_MOTIF
68 #include <X11/Xaw/Paned.h>
69 #include <X11/Xaw/Label.h>
70 #endif /* USE_MOTIF */
72 #ifdef USG
73 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
74 #include <X11/Xos.h>
75 #define USG
76 #else
77 #include <X11/Xos.h>
78 #endif
80 #include "widget.h"
82 #include "../lwlib/lwlib.h"
84 #ifdef USE_MOTIF
85 #include <Xm/Xm.h>
86 #include <Xm/DialogS.h>
87 #include <Xm/FileSB.h>
88 #endif
90 /* Do the EDITRES protocol if running X11R5
91 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
93 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
94 #define HACK_EDITRES
95 extern void _XEditResCheckMessages ();
96 #endif /* R5 + Athena */
98 /* Unique id counter for widgets created by the Lucid Widget Library. */
100 extern LWLIB_ID widget_id_tick;
102 #ifdef USE_LUCID
103 /* This is part of a kludge--see lwlib/xlwmenu.c. */
104 extern XFontStruct *xlwmenu_default_font;
105 #endif
107 extern void free_frame_menubar ();
108 extern double atof ();
110 #endif /* USE_X_TOOLKIT */
112 #define min(a,b) ((a) < (b) ? (a) : (b))
113 #define max(a,b) ((a) > (b) ? (a) : (b))
115 #ifdef HAVE_X11R4
116 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
117 #else
118 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
119 #endif
121 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
122 it, and including `bitmaps/gray' more than once is a problem when
123 config.h defines `static' as an empty replacement string. */
125 int gray_bitmap_width = gray_width;
126 int gray_bitmap_height = gray_height;
127 char *gray_bitmap_bits = gray_bits;
129 /* The name we're using in resource queries. Most often "emacs". */
131 Lisp_Object Vx_resource_name;
133 /* The application class we're using in resource queries.
134 Normally "Emacs". */
136 Lisp_Object Vx_resource_class;
138 /* Non-zero means we're allowed to display a busy cursor. */
140 int display_busy_cursor_p;
142 /* The background and shape of the mouse pointer, and shape when not
143 over text or in the modeline. */
145 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
146 Lisp_Object Vx_busy_pointer_shape;
148 /* The shape when over mouse-sensitive text. */
150 Lisp_Object Vx_sensitive_text_pointer_shape;
152 /* If non-nil, the pointer shape to indicate that windows can be
153 dragged horizontally. */
155 Lisp_Object Vx_window_horizontal_drag_shape;
157 /* Color of chars displayed in cursor box. */
159 Lisp_Object Vx_cursor_fore_pixel;
161 /* Nonzero if using X. */
163 static int x_in_use;
165 /* Non nil if no window manager is in use. */
167 Lisp_Object Vx_no_window_manager;
169 /* Search path for bitmap files. */
171 Lisp_Object Vx_bitmap_file_path;
173 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
175 Lisp_Object Vx_pixel_size_width_font_regexp;
177 /* Evaluate this expression to rebuild the section of syms_of_xfns
178 that initializes and staticpros the symbols declared below. Note
179 that Emacs 18 has a bug that keeps C-x C-e from being able to
180 evaluate this expression.
182 (progn
183 ;; Accumulate a list of the symbols we want to initialize from the
184 ;; declarations at the top of the file.
185 (goto-char (point-min))
186 (search-forward "/\*&&& symbols declared here &&&*\/\n")
187 (let (symbol-list)
188 (while (looking-at "Lisp_Object \\(Q[a-z_]+\\)")
189 (setq symbol-list
190 (cons (buffer-substring (match-beginning 1) (match-end 1))
191 symbol-list))
192 (forward-line 1))
193 (setq symbol-list (nreverse symbol-list))
194 ;; Delete the section of syms_of_... where we initialize the symbols.
195 (search-forward "\n /\*&&& init symbols here &&&*\/\n")
196 (let ((start (point)))
197 (while (looking-at "^ Q")
198 (forward-line 2))
199 (kill-region start (point)))
200 ;; Write a new symbol initialization section.
201 (while symbol-list
202 (insert (format " %s = intern (\"" (car symbol-list)))
203 (let ((start (point)))
204 (insert (substring (car symbol-list) 1))
205 (subst-char-in-region start (point) ?_ ?-))
206 (insert (format "\");\n staticpro (&%s);\n" (car symbol-list)))
207 (setq symbol-list (cdr symbol-list)))))
211 /*&&& symbols declared here &&&*/
212 Lisp_Object Qauto_raise;
213 Lisp_Object Qauto_lower;
214 Lisp_Object Qbar;
215 Lisp_Object Qborder_color;
216 Lisp_Object Qborder_width;
217 Lisp_Object Qbox;
218 Lisp_Object Qcursor_color;
219 Lisp_Object Qcursor_type;
220 Lisp_Object Qgeometry;
221 Lisp_Object Qicon_left;
222 Lisp_Object Qicon_top;
223 Lisp_Object Qicon_type;
224 Lisp_Object Qicon_name;
225 Lisp_Object Qinternal_border_width;
226 Lisp_Object Qleft;
227 Lisp_Object Qright;
228 Lisp_Object Qmouse_color;
229 Lisp_Object Qnone;
230 Lisp_Object Qouter_window_id;
231 Lisp_Object Qparent_id;
232 Lisp_Object Qscroll_bar_width;
233 Lisp_Object Qsuppress_icon;
234 extern Lisp_Object Qtop;
235 Lisp_Object Qundefined_color;
236 Lisp_Object Qvertical_scroll_bars;
237 Lisp_Object Qvisibility;
238 Lisp_Object Qwindow_id;
239 Lisp_Object Qx_frame_parameter;
240 Lisp_Object Qx_resource_name;
241 Lisp_Object Quser_position;
242 Lisp_Object Quser_size;
243 extern Lisp_Object Qdisplay;
244 Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
245 Lisp_Object Qscreen_gamma, Qline_spacing, Qcenter;
246 Lisp_Object Qcompound_text;
248 /* The below are defined in frame.c. */
250 extern Lisp_Object Qheight, Qminibuffer, Qname, Qonly, Qwidth;
251 extern Lisp_Object Qunsplittable, Qmenu_bar_lines, Qbuffer_predicate, Qtitle;
252 extern Lisp_Object Qtool_bar_lines;
254 extern Lisp_Object Vwindow_system_version;
256 Lisp_Object Qface_set_after_frame_default;
258 #if GLYPH_DEBUG
259 int image_cache_refcount, dpyinfo_refcount;
260 #endif
264 /* Error if we are not connected to X. */
266 void
267 check_x ()
269 if (! x_in_use)
270 error ("X windows are not in use or not initialized");
273 /* Nonzero if we can use mouse menus.
274 You should not call this unless HAVE_MENUS is defined. */
277 have_menus_p ()
279 return x_in_use;
282 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
283 and checking validity for X. */
285 FRAME_PTR
286 check_x_frame (frame)
287 Lisp_Object frame;
289 FRAME_PTR f;
291 if (NILP (frame))
292 frame = selected_frame;
293 CHECK_LIVE_FRAME (frame, 0);
294 f = XFRAME (frame);
295 if (! FRAME_X_P (f))
296 error ("Non-X frame used");
297 return f;
300 /* Let the user specify an X display with a frame.
301 nil stands for the selected frame--or, if that is not an X frame,
302 the first X display on the list. */
304 static struct x_display_info *
305 check_x_display_info (frame)
306 Lisp_Object frame;
308 struct x_display_info *dpyinfo = NULL;
310 if (NILP (frame))
312 struct frame *sf = XFRAME (selected_frame);
314 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
315 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
316 else if (x_display_list != 0)
317 dpyinfo = x_display_list;
318 else
319 error ("X windows are not in use or not initialized");
321 else if (STRINGP (frame))
322 dpyinfo = x_display_info_for_name (frame);
323 else
325 FRAME_PTR f;
327 CHECK_LIVE_FRAME (frame, 0);
328 f = XFRAME (frame);
329 if (! FRAME_X_P (f))
330 error ("Non-X frame used");
331 dpyinfo = FRAME_X_DISPLAY_INFO (f);
334 return dpyinfo;
338 /* Return the Emacs frame-object corresponding to an X window.
339 It could be the frame's main window or an icon window. */
341 /* This function can be called during GC, so use GC_xxx type test macros. */
343 struct frame *
344 x_window_to_frame (dpyinfo, wdesc)
345 struct x_display_info *dpyinfo;
346 int wdesc;
348 Lisp_Object tail, frame;
349 struct frame *f;
351 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
353 frame = XCAR (tail);
354 if (!GC_FRAMEP (frame))
355 continue;
356 f = XFRAME (frame);
357 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
358 continue;
359 if (f->output_data.x->busy_window == wdesc)
360 return f;
361 #ifdef USE_X_TOOLKIT
362 if ((f->output_data.x->edit_widget
363 && XtWindow (f->output_data.x->edit_widget) == wdesc)
364 /* A tooltip frame? */
365 || (!f->output_data.x->edit_widget
366 && FRAME_X_WINDOW (f) == wdesc)
367 || f->output_data.x->icon_desc == wdesc)
368 return f;
369 #else /* not USE_X_TOOLKIT */
370 if (FRAME_X_WINDOW (f) == wdesc
371 || f->output_data.x->icon_desc == wdesc)
372 return f;
373 #endif /* not USE_X_TOOLKIT */
375 return 0;
378 #ifdef USE_X_TOOLKIT
379 /* Like x_window_to_frame but also compares the window with the widget's
380 windows. */
382 struct frame *
383 x_any_window_to_frame (dpyinfo, wdesc)
384 struct x_display_info *dpyinfo;
385 int wdesc;
387 Lisp_Object tail, frame;
388 struct frame *f, *found;
389 struct x_output *x;
391 found = NULL;
392 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
394 frame = XCAR (tail);
395 if (!GC_FRAMEP (frame))
396 continue;
398 f = XFRAME (frame);
399 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
401 /* This frame matches if the window is any of its widgets. */
402 x = f->output_data.x;
403 if (x->busy_window == wdesc)
404 found = f;
405 else if (x->widget)
407 if (wdesc == XtWindow (x->widget)
408 || wdesc == XtWindow (x->column_widget)
409 || wdesc == XtWindow (x->edit_widget))
410 found = f;
411 /* Match if the window is this frame's menubar. */
412 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
413 found = f;
415 else if (FRAME_X_WINDOW (f) == wdesc)
416 /* A tooltip frame. */
417 found = f;
421 return found;
424 /* Likewise, but exclude the menu bar widget. */
426 struct frame *
427 x_non_menubar_window_to_frame (dpyinfo, wdesc)
428 struct x_display_info *dpyinfo;
429 int wdesc;
431 Lisp_Object tail, frame;
432 struct frame *f;
433 struct x_output *x;
435 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
437 frame = XCAR (tail);
438 if (!GC_FRAMEP (frame))
439 continue;
440 f = XFRAME (frame);
441 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
442 continue;
443 x = f->output_data.x;
444 /* This frame matches if the window is any of its widgets. */
445 if (x->busy_window == wdesc)
446 return f;
447 else if (x->widget)
449 if (wdesc == XtWindow (x->widget)
450 || wdesc == XtWindow (x->column_widget)
451 || wdesc == XtWindow (x->edit_widget))
452 return f;
454 else if (FRAME_X_WINDOW (f) == wdesc)
455 /* A tooltip frame. */
456 return f;
458 return 0;
461 /* Likewise, but consider only the menu bar widget. */
463 struct frame *
464 x_menubar_window_to_frame (dpyinfo, wdesc)
465 struct x_display_info *dpyinfo;
466 int wdesc;
468 Lisp_Object tail, frame;
469 struct frame *f;
470 struct x_output *x;
472 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
474 frame = XCAR (tail);
475 if (!GC_FRAMEP (frame))
476 continue;
477 f = XFRAME (frame);
478 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
479 continue;
480 x = f->output_data.x;
481 /* Match if the window is this frame's menubar. */
482 if (x->menubar_widget
483 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
484 return f;
486 return 0;
489 /* Return the frame whose principal (outermost) window is WDESC.
490 If WDESC is some other (smaller) window, we return 0. */
492 struct frame *
493 x_top_window_to_frame (dpyinfo, wdesc)
494 struct x_display_info *dpyinfo;
495 int wdesc;
497 Lisp_Object tail, frame;
498 struct frame *f;
499 struct x_output *x;
501 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
503 frame = XCAR (tail);
504 if (!GC_FRAMEP (frame))
505 continue;
506 f = XFRAME (frame);
507 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
508 continue;
509 x = f->output_data.x;
511 if (x->widget)
513 /* This frame matches if the window is its topmost widget. */
514 if (wdesc == XtWindow (x->widget))
515 return f;
516 #if 0 /* I don't know why it did this,
517 but it seems logically wrong,
518 and it causes trouble for MapNotify events. */
519 /* Match if the window is this frame's menubar. */
520 if (x->menubar_widget
521 && wdesc == XtWindow (x->menubar_widget))
522 return f;
523 #endif
525 else if (FRAME_X_WINDOW (f) == wdesc)
526 /* Tooltip frame. */
527 return f;
529 return 0;
531 #endif /* USE_X_TOOLKIT */
535 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
536 id, which is just an int that this section returns. Bitmaps are
537 reference counted so they can be shared among frames.
539 Bitmap indices are guaranteed to be > 0, so a negative number can
540 be used to indicate no bitmap.
542 If you use x_create_bitmap_from_data, then you must keep track of
543 the bitmaps yourself. That is, creating a bitmap from the same
544 data more than once will not be caught. */
547 /* Functions to access the contents of a bitmap, given an id. */
550 x_bitmap_height (f, id)
551 FRAME_PTR f;
552 int id;
554 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
558 x_bitmap_width (f, id)
559 FRAME_PTR f;
560 int id;
562 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
566 x_bitmap_pixmap (f, id)
567 FRAME_PTR f;
568 int id;
570 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
574 /* Allocate a new bitmap record. Returns index of new record. */
576 static int
577 x_allocate_bitmap_record (f)
578 FRAME_PTR f;
580 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
581 int i;
583 if (dpyinfo->bitmaps == NULL)
585 dpyinfo->bitmaps_size = 10;
586 dpyinfo->bitmaps
587 = (struct x_bitmap_record *) xmalloc (dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
588 dpyinfo->bitmaps_last = 1;
589 return 1;
592 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
593 return ++dpyinfo->bitmaps_last;
595 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
596 if (dpyinfo->bitmaps[i].refcount == 0)
597 return i + 1;
599 dpyinfo->bitmaps_size *= 2;
600 dpyinfo->bitmaps
601 = (struct x_bitmap_record *) xrealloc (dpyinfo->bitmaps,
602 dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
603 return ++dpyinfo->bitmaps_last;
606 /* Add one reference to the reference count of the bitmap with id ID. */
608 void
609 x_reference_bitmap (f, id)
610 FRAME_PTR f;
611 int id;
613 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
616 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
619 x_create_bitmap_from_data (f, bits, width, height)
620 struct frame *f;
621 char *bits;
622 unsigned int width, height;
624 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
625 Pixmap bitmap;
626 int id;
628 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
629 bits, width, height);
631 if (! bitmap)
632 return -1;
634 id = x_allocate_bitmap_record (f);
635 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
636 dpyinfo->bitmaps[id - 1].file = NULL;
637 dpyinfo->bitmaps[id - 1].refcount = 1;
638 dpyinfo->bitmaps[id - 1].depth = 1;
639 dpyinfo->bitmaps[id - 1].height = height;
640 dpyinfo->bitmaps[id - 1].width = width;
642 return id;
645 /* Create bitmap from file FILE for frame F. */
648 x_create_bitmap_from_file (f, file)
649 struct frame *f;
650 Lisp_Object file;
652 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
653 unsigned int width, height;
654 Pixmap bitmap;
655 int xhot, yhot, result, id;
656 Lisp_Object found;
657 int fd;
658 char *filename;
660 /* Look for an existing bitmap with the same name. */
661 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
663 if (dpyinfo->bitmaps[id].refcount
664 && dpyinfo->bitmaps[id].file
665 && !strcmp (dpyinfo->bitmaps[id].file, (char *) XSTRING (file)->data))
667 ++dpyinfo->bitmaps[id].refcount;
668 return id + 1;
672 /* Search bitmap-file-path for the file, if appropriate. */
673 fd = openp (Vx_bitmap_file_path, file, "", &found, 0);
674 if (fd < 0)
675 return -1;
676 emacs_close (fd);
678 filename = (char *) XSTRING (found)->data;
680 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
681 filename, &width, &height, &bitmap, &xhot, &yhot);
682 if (result != BitmapSuccess)
683 return -1;
685 id = x_allocate_bitmap_record (f);
686 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
687 dpyinfo->bitmaps[id - 1].refcount = 1;
688 dpyinfo->bitmaps[id - 1].file
689 = (char *) xmalloc (STRING_BYTES (XSTRING (file)) + 1);
690 dpyinfo->bitmaps[id - 1].depth = 1;
691 dpyinfo->bitmaps[id - 1].height = height;
692 dpyinfo->bitmaps[id - 1].width = width;
693 strcpy (dpyinfo->bitmaps[id - 1].file, XSTRING (file)->data);
695 return id;
698 /* Remove reference to bitmap with id number ID. */
700 void
701 x_destroy_bitmap (f, id)
702 FRAME_PTR f;
703 int id;
705 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
707 if (id > 0)
709 --dpyinfo->bitmaps[id - 1].refcount;
710 if (dpyinfo->bitmaps[id - 1].refcount == 0)
712 BLOCK_INPUT;
713 XFreePixmap (FRAME_X_DISPLAY (f), dpyinfo->bitmaps[id - 1].pixmap);
714 if (dpyinfo->bitmaps[id - 1].file)
716 xfree (dpyinfo->bitmaps[id - 1].file);
717 dpyinfo->bitmaps[id - 1].file = NULL;
719 UNBLOCK_INPUT;
724 /* Free all the bitmaps for the display specified by DPYINFO. */
726 static void
727 x_destroy_all_bitmaps (dpyinfo)
728 struct x_display_info *dpyinfo;
730 int i;
731 for (i = 0; i < dpyinfo->bitmaps_last; i++)
732 if (dpyinfo->bitmaps[i].refcount > 0)
734 XFreePixmap (dpyinfo->display, dpyinfo->bitmaps[i].pixmap);
735 if (dpyinfo->bitmaps[i].file)
736 xfree (dpyinfo->bitmaps[i].file);
738 dpyinfo->bitmaps_last = 0;
741 /* Connect the frame-parameter names for X frames
742 to the ways of passing the parameter values to the window system.
744 The name of a parameter, as a Lisp symbol,
745 has an `x-frame-parameter' property which is an integer in Lisp
746 that is an index in this table. */
748 struct x_frame_parm_table
750 char *name;
751 void (*setter) P_ ((struct frame *, Lisp_Object, Lisp_Object));
754 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
755 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
756 static void x_change_window_heights P_ ((Lisp_Object, int));
757 static void x_disable_image P_ ((struct frame *, struct image *));
758 static void x_create_im P_ ((struct frame *));
759 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
760 static void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
761 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
762 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
763 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
764 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
765 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
766 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
767 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
768 void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
769 void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
770 void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
771 Lisp_Object));
772 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
773 void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
774 void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
775 void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
776 Lisp_Object));
777 void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
778 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
779 void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
780 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
781 void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
782 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
783 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
784 Lisp_Object));
785 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
786 Lisp_Object));
787 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
788 Lisp_Object,
789 Lisp_Object,
790 char *, char *,
791 int));
792 static void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
793 static void x_edge_detection P_ ((struct frame *, struct image *, Lisp_Object,
794 Lisp_Object));
795 static void init_color_table P_ ((void));
796 static void free_color_table P_ ((void));
797 static unsigned long *colors_in_color_table P_ ((int *n));
798 static unsigned long lookup_rgb_color P_ ((struct frame *f, int r, int g, int b));
799 static unsigned long lookup_pixel_color P_ ((struct frame *f, unsigned long p));
803 static struct x_frame_parm_table x_frame_parms[] =
805 "auto-raise", x_set_autoraise,
806 "auto-lower", x_set_autolower,
807 "background-color", x_set_background_color,
808 "border-color", x_set_border_color,
809 "border-width", x_set_border_width,
810 "cursor-color", x_set_cursor_color,
811 "cursor-type", x_set_cursor_type,
812 "font", x_set_font,
813 "foreground-color", x_set_foreground_color,
814 "icon-name", x_set_icon_name,
815 "icon-type", x_set_icon_type,
816 "internal-border-width", x_set_internal_border_width,
817 "menu-bar-lines", x_set_menu_bar_lines,
818 "mouse-color", x_set_mouse_color,
819 "name", x_explicitly_set_name,
820 "scroll-bar-width", x_set_scroll_bar_width,
821 "title", x_set_title,
822 "unsplittable", x_set_unsplittable,
823 "vertical-scroll-bars", x_set_vertical_scroll_bars,
824 "visibility", x_set_visibility,
825 "tool-bar-lines", x_set_tool_bar_lines,
826 "scroll-bar-foreground", x_set_scroll_bar_foreground,
827 "scroll-bar-background", x_set_scroll_bar_background,
828 "screen-gamma", x_set_screen_gamma,
829 "line-spacing", x_set_line_spacing
832 /* Attach the `x-frame-parameter' properties to
833 the Lisp symbol names of parameters relevant to X. */
835 void
836 init_x_parm_symbols ()
838 int i;
840 for (i = 0; i < sizeof (x_frame_parms) / sizeof (x_frame_parms[0]); i++)
841 Fput (intern (x_frame_parms[i].name), Qx_frame_parameter,
842 make_number (i));
845 /* Change the parameters of frame F as specified by ALIST.
846 If a parameter is not specially recognized, do nothing special;
847 otherwise call the `x_set_...' function for that parameter.
848 Except for certain geometry properties, always call store_frame_param
849 to store the new value in the parameter alist. */
851 void
852 x_set_frame_parameters (f, alist)
853 FRAME_PTR f;
854 Lisp_Object alist;
856 Lisp_Object tail;
858 /* If both of these parameters are present, it's more efficient to
859 set them both at once. So we wait until we've looked at the
860 entire list before we set them. */
861 int width, height;
863 /* Same here. */
864 Lisp_Object left, top;
866 /* Same with these. */
867 Lisp_Object icon_left, icon_top;
869 /* Record in these vectors all the parms specified. */
870 Lisp_Object *parms;
871 Lisp_Object *values;
872 int i, p;
873 int left_no_change = 0, top_no_change = 0;
874 int icon_left_no_change = 0, icon_top_no_change = 0;
876 struct gcpro gcpro1, gcpro2;
878 i = 0;
879 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
880 i++;
882 parms = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
883 values = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
885 /* Extract parm names and values into those vectors. */
887 i = 0;
888 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
890 Lisp_Object elt;
892 elt = Fcar (tail);
893 parms[i] = Fcar (elt);
894 values[i] = Fcdr (elt);
895 i++;
897 /* TAIL and ALIST are not used again below here. */
898 alist = tail = Qnil;
900 GCPRO2 (*parms, *values);
901 gcpro1.nvars = i;
902 gcpro2.nvars = i;
904 /* There is no need to gcpro LEFT, TOP, ICON_LEFT, or ICON_TOP,
905 because their values appear in VALUES and strings are not valid. */
906 top = left = Qunbound;
907 icon_left = icon_top = Qunbound;
909 /* Provide default values for HEIGHT and WIDTH. */
910 if (FRAME_NEW_WIDTH (f))
911 width = FRAME_NEW_WIDTH (f);
912 else
913 width = FRAME_WIDTH (f);
915 if (FRAME_NEW_HEIGHT (f))
916 height = FRAME_NEW_HEIGHT (f);
917 else
918 height = FRAME_HEIGHT (f);
920 /* Process foreground_color and background_color before anything else.
921 They are independent of other properties, but other properties (e.g.,
922 cursor_color) are dependent upon them. */
923 for (p = 0; p < i; p++)
925 Lisp_Object prop, val;
927 prop = parms[p];
928 val = values[p];
929 if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
931 register Lisp_Object param_index, old_value;
933 param_index = Fget (prop, Qx_frame_parameter);
934 old_value = get_frame_param (f, prop);
935 store_frame_param (f, prop, val);
936 if (NATNUMP (param_index)
937 && (XFASTINT (param_index)
938 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
939 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
943 /* Now process them in reverse of specified order. */
944 for (i--; i >= 0; i--)
946 Lisp_Object prop, val;
948 prop = parms[i];
949 val = values[i];
951 if (EQ (prop, Qwidth) && NUMBERP (val))
952 width = XFASTINT (val);
953 else if (EQ (prop, Qheight) && NUMBERP (val))
954 height = XFASTINT (val);
955 else if (EQ (prop, Qtop))
956 top = val;
957 else if (EQ (prop, Qleft))
958 left = val;
959 else if (EQ (prop, Qicon_top))
960 icon_top = val;
961 else if (EQ (prop, Qicon_left))
962 icon_left = val;
963 else if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
964 /* Processed above. */
965 continue;
966 else
968 register Lisp_Object param_index, old_value;
970 param_index = Fget (prop, Qx_frame_parameter);
971 old_value = get_frame_param (f, prop);
972 store_frame_param (f, prop, val);
973 if (NATNUMP (param_index)
974 && (XFASTINT (param_index)
975 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
976 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
980 /* Don't die if just one of these was set. */
981 if (EQ (left, Qunbound))
983 left_no_change = 1;
984 if (f->output_data.x->left_pos < 0)
985 left = Fcons (Qplus, Fcons (make_number (f->output_data.x->left_pos), Qnil));
986 else
987 XSETINT (left, f->output_data.x->left_pos);
989 if (EQ (top, Qunbound))
991 top_no_change = 1;
992 if (f->output_data.x->top_pos < 0)
993 top = Fcons (Qplus, Fcons (make_number (f->output_data.x->top_pos), Qnil));
994 else
995 XSETINT (top, f->output_data.x->top_pos);
998 /* If one of the icon positions was not set, preserve or default it. */
999 if (EQ (icon_left, Qunbound) || ! INTEGERP (icon_left))
1001 icon_left_no_change = 1;
1002 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
1003 if (NILP (icon_left))
1004 XSETINT (icon_left, 0);
1006 if (EQ (icon_top, Qunbound) || ! INTEGERP (icon_top))
1008 icon_top_no_change = 1;
1009 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
1010 if (NILP (icon_top))
1011 XSETINT (icon_top, 0);
1014 /* Don't set these parameters unless they've been explicitly
1015 specified. The window might be mapped or resized while we're in
1016 this function, and we don't want to override that unless the lisp
1017 code has asked for it.
1019 Don't set these parameters unless they actually differ from the
1020 window's current parameters; the window may not actually exist
1021 yet. */
1023 Lisp_Object frame;
1025 check_frame_size (f, &height, &width);
1027 XSETFRAME (frame, f);
1029 if (width != FRAME_WIDTH (f)
1030 || height != FRAME_HEIGHT (f)
1031 || FRAME_NEW_HEIGHT (f) || FRAME_NEW_WIDTH (f))
1032 Fset_frame_size (frame, make_number (width), make_number (height));
1034 if ((!NILP (left) || !NILP (top))
1035 && ! (left_no_change && top_no_change)
1036 && ! (NUMBERP (left) && XINT (left) == f->output_data.x->left_pos
1037 && NUMBERP (top) && XINT (top) == f->output_data.x->top_pos))
1039 int leftpos = 0;
1040 int toppos = 0;
1042 /* Record the signs. */
1043 f->output_data.x->size_hint_flags &= ~ (XNegative | YNegative);
1044 if (EQ (left, Qminus))
1045 f->output_data.x->size_hint_flags |= XNegative;
1046 else if (INTEGERP (left))
1048 leftpos = XINT (left);
1049 if (leftpos < 0)
1050 f->output_data.x->size_hint_flags |= XNegative;
1052 else if (CONSP (left) && EQ (XCAR (left), Qminus)
1053 && CONSP (XCDR (left))
1054 && INTEGERP (XCAR (XCDR (left))))
1056 leftpos = - XINT (XCAR (XCDR (left)));
1057 f->output_data.x->size_hint_flags |= XNegative;
1059 else if (CONSP (left) && EQ (XCAR (left), Qplus)
1060 && CONSP (XCDR (left))
1061 && INTEGERP (XCAR (XCDR (left))))
1063 leftpos = XINT (XCAR (XCDR (left)));
1066 if (EQ (top, Qminus))
1067 f->output_data.x->size_hint_flags |= YNegative;
1068 else if (INTEGERP (top))
1070 toppos = XINT (top);
1071 if (toppos < 0)
1072 f->output_data.x->size_hint_flags |= YNegative;
1074 else if (CONSP (top) && EQ (XCAR (top), Qminus)
1075 && CONSP (XCDR (top))
1076 && INTEGERP (XCAR (XCDR (top))))
1078 toppos = - XINT (XCAR (XCDR (top)));
1079 f->output_data.x->size_hint_flags |= YNegative;
1081 else if (CONSP (top) && EQ (XCAR (top), Qplus)
1082 && CONSP (XCDR (top))
1083 && INTEGERP (XCAR (XCDR (top))))
1085 toppos = XINT (XCAR (XCDR (top)));
1089 /* Store the numeric value of the position. */
1090 f->output_data.x->top_pos = toppos;
1091 f->output_data.x->left_pos = leftpos;
1093 f->output_data.x->win_gravity = NorthWestGravity;
1095 /* Actually set that position, and convert to absolute. */
1096 x_set_offset (f, leftpos, toppos, -1);
1099 if ((!NILP (icon_left) || !NILP (icon_top))
1100 && ! (icon_left_no_change && icon_top_no_change))
1101 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
1104 UNGCPRO;
1107 /* Store the screen positions of frame F into XPTR and YPTR.
1108 These are the positions of the containing window manager window,
1109 not Emacs's own window. */
1111 void
1112 x_real_positions (f, xptr, yptr)
1113 FRAME_PTR f;
1114 int *xptr, *yptr;
1116 int win_x, win_y;
1117 Window child;
1119 /* This is pretty gross, but seems to be the easiest way out of
1120 the problem that arises when restarting window-managers. */
1122 #ifdef USE_X_TOOLKIT
1123 Window outer = (f->output_data.x->widget
1124 ? XtWindow (f->output_data.x->widget)
1125 : FRAME_X_WINDOW (f));
1126 #else
1127 Window outer = f->output_data.x->window_desc;
1128 #endif
1129 Window tmp_root_window;
1130 Window *tmp_children;
1131 unsigned int tmp_nchildren;
1133 while (1)
1135 int count = x_catch_errors (FRAME_X_DISPLAY (f));
1136 Window outer_window;
1138 XQueryTree (FRAME_X_DISPLAY (f), outer, &tmp_root_window,
1139 &f->output_data.x->parent_desc,
1140 &tmp_children, &tmp_nchildren);
1141 XFree ((char *) tmp_children);
1143 win_x = win_y = 0;
1145 /* Find the position of the outside upper-left corner of
1146 the inner window, with respect to the outer window. */
1147 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
1148 outer_window = f->output_data.x->parent_desc;
1149 else
1150 outer_window = outer;
1152 XTranslateCoordinates (FRAME_X_DISPLAY (f),
1154 /* From-window, to-window. */
1155 outer_window,
1156 FRAME_X_DISPLAY_INFO (f)->root_window,
1158 /* From-position, to-position. */
1159 0, 0, &win_x, &win_y,
1161 /* Child of win. */
1162 &child);
1164 /* It is possible for the window returned by the XQueryNotify
1165 to become invalid by the time we call XTranslateCoordinates.
1166 That can happen when you restart some window managers.
1167 If so, we get an error in XTranslateCoordinates.
1168 Detect that and try the whole thing over. */
1169 if (! x_had_errors_p (FRAME_X_DISPLAY (f)))
1171 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1172 break;
1175 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1178 *xptr = win_x;
1179 *yptr = win_y;
1182 /* Insert a description of internally-recorded parameters of frame X
1183 into the parameter alist *ALISTPTR that is to be given to the user.
1184 Only parameters that are specific to the X window system
1185 and whose values are not correctly recorded in the frame's
1186 param_alist need to be considered here. */
1188 void
1189 x_report_frame_params (f, alistptr)
1190 struct frame *f;
1191 Lisp_Object *alistptr;
1193 char buf[16];
1194 Lisp_Object tem;
1196 /* Represent negative positions (off the top or left screen edge)
1197 in a way that Fmodify_frame_parameters will understand correctly. */
1198 XSETINT (tem, f->output_data.x->left_pos);
1199 if (f->output_data.x->left_pos >= 0)
1200 store_in_alist (alistptr, Qleft, tem);
1201 else
1202 store_in_alist (alistptr, Qleft, Fcons (Qplus, Fcons (tem, Qnil)));
1204 XSETINT (tem, f->output_data.x->top_pos);
1205 if (f->output_data.x->top_pos >= 0)
1206 store_in_alist (alistptr, Qtop, tem);
1207 else
1208 store_in_alist (alistptr, Qtop, Fcons (Qplus, Fcons (tem, Qnil)));
1210 store_in_alist (alistptr, Qborder_width,
1211 make_number (f->output_data.x->border_width));
1212 store_in_alist (alistptr, Qinternal_border_width,
1213 make_number (f->output_data.x->internal_border_width));
1214 sprintf (buf, "%ld", (long) FRAME_X_WINDOW (f));
1215 store_in_alist (alistptr, Qwindow_id,
1216 build_string (buf));
1217 #ifdef USE_X_TOOLKIT
1218 /* Tooltip frame may not have this widget. */
1219 if (f->output_data.x->widget)
1220 #endif
1221 sprintf (buf, "%ld", (long) FRAME_OUTER_WINDOW (f));
1222 store_in_alist (alistptr, Qouter_window_id,
1223 build_string (buf));
1224 store_in_alist (alistptr, Qicon_name, f->icon_name);
1225 FRAME_SAMPLE_VISIBILITY (f);
1226 store_in_alist (alistptr, Qvisibility,
1227 (FRAME_VISIBLE_P (f) ? Qt
1228 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
1229 store_in_alist (alistptr, Qdisplay,
1230 XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element));
1232 if (f->output_data.x->parent_desc == FRAME_X_DISPLAY_INFO (f)->root_window)
1233 tem = Qnil;
1234 else
1235 XSETFASTINT (tem, f->output_data.x->parent_desc);
1236 store_in_alist (alistptr, Qparent_id, tem);
1241 /* Gamma-correct COLOR on frame F. */
1243 void
1244 gamma_correct (f, color)
1245 struct frame *f;
1246 XColor *color;
1248 if (f->gamma)
1250 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
1251 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
1252 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
1257 /* Decide if color named COLOR_NAME is valid for use on frame F. If
1258 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
1259 allocate the color. Value is zero if COLOR_NAME is invalid, or
1260 no color could be allocated. */
1263 x_defined_color (f, color_name, color, alloc_p)
1264 struct frame *f;
1265 char *color_name;
1266 XColor *color;
1267 int alloc_p;
1269 int success_p;
1270 Display *dpy = FRAME_X_DISPLAY (f);
1271 Colormap cmap = FRAME_X_COLORMAP (f);
1273 BLOCK_INPUT;
1274 success_p = XParseColor (dpy, cmap, color_name, color);
1275 if (success_p && alloc_p)
1276 success_p = x_alloc_nearest_color (f, cmap, color);
1277 UNBLOCK_INPUT;
1279 return success_p;
1283 /* Return the pixel color value for color COLOR_NAME on frame F. If F
1284 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
1285 Signal an error if color can't be allocated. */
1288 x_decode_color (f, color_name, mono_color)
1289 FRAME_PTR f;
1290 Lisp_Object color_name;
1291 int mono_color;
1293 XColor cdef;
1295 CHECK_STRING (color_name, 0);
1297 #if 0 /* Don't do this. It's wrong when we're not using the default
1298 colormap, it makes freeing difficult, and it's probably not
1299 an important optimization. */
1300 if (strcmp (XSTRING (color_name)->data, "black") == 0)
1301 return BLACK_PIX_DEFAULT (f);
1302 else if (strcmp (XSTRING (color_name)->data, "white") == 0)
1303 return WHITE_PIX_DEFAULT (f);
1304 #endif
1306 /* Return MONO_COLOR for monochrome frames. */
1307 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
1308 return mono_color;
1310 /* x_defined_color is responsible for coping with failures
1311 by looking for a near-miss. */
1312 if (x_defined_color (f, XSTRING (color_name)->data, &cdef, 1))
1313 return cdef.pixel;
1315 Fsignal (Qerror, Fcons (build_string ("Undefined color"),
1316 Fcons (color_name, Qnil)));
1317 return 0;
1322 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
1323 the previous value of that parameter, NEW_VALUE is the new value. */
1325 static void
1326 x_set_line_spacing (f, new_value, old_value)
1327 struct frame *f;
1328 Lisp_Object new_value, old_value;
1330 if (NILP (new_value))
1331 f->extra_line_spacing = 0;
1332 else if (NATNUMP (new_value))
1333 f->extra_line_spacing = XFASTINT (new_value);
1334 else
1335 Fsignal (Qerror, Fcons (build_string ("Invalid line-spacing"),
1336 Fcons (new_value, Qnil)));
1337 if (FRAME_VISIBLE_P (f))
1338 redraw_frame (f);
1342 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
1343 the previous value of that parameter, NEW_VALUE is the new value. */
1345 static void
1346 x_set_screen_gamma (f, new_value, old_value)
1347 struct frame *f;
1348 Lisp_Object new_value, old_value;
1350 if (NILP (new_value))
1351 f->gamma = 0;
1352 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
1353 /* The value 0.4545 is the normal viewing gamma. */
1354 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
1355 else
1356 Fsignal (Qerror, Fcons (build_string ("Invalid screen-gamma"),
1357 Fcons (new_value, Qnil)));
1359 clear_face_cache (0);
1363 /* Functions called only from `x_set_frame_param'
1364 to set individual parameters.
1366 If FRAME_X_WINDOW (f) is 0,
1367 the frame is being created and its X-window does not exist yet.
1368 In that case, just record the parameter's new value
1369 in the standard place; do not attempt to change the window. */
1371 void
1372 x_set_foreground_color (f, arg, oldval)
1373 struct frame *f;
1374 Lisp_Object arg, oldval;
1376 unsigned long pixel
1377 = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1379 unload_color (f, f->output_data.x->foreground_pixel);
1380 f->output_data.x->foreground_pixel = pixel;
1382 if (FRAME_X_WINDOW (f) != 0)
1384 BLOCK_INPUT;
1385 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1386 f->output_data.x->foreground_pixel);
1387 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
1388 f->output_data.x->foreground_pixel);
1389 UNBLOCK_INPUT;
1390 update_face_from_frame_parameter (f, Qforeground_color, arg);
1391 if (FRAME_VISIBLE_P (f))
1392 redraw_frame (f);
1396 void
1397 x_set_background_color (f, arg, oldval)
1398 struct frame *f;
1399 Lisp_Object arg, oldval;
1401 unsigned long pixel
1402 = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1404 unload_color (f, f->output_data.x->background_pixel);
1405 f->output_data.x->background_pixel = pixel;
1407 if (FRAME_X_WINDOW (f) != 0)
1409 BLOCK_INPUT;
1410 /* The main frame area. */
1411 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1412 f->output_data.x->background_pixel);
1413 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
1414 f->output_data.x->background_pixel);
1415 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1416 f->output_data.x->background_pixel);
1417 XSetWindowBackground (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1418 f->output_data.x->background_pixel);
1420 Lisp_Object bar;
1421 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar);
1422 bar = XSCROLL_BAR (bar)->next)
1423 XSetWindowBackground (FRAME_X_DISPLAY (f),
1424 SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar)),
1425 f->output_data.x->background_pixel);
1427 UNBLOCK_INPUT;
1429 update_face_from_frame_parameter (f, Qbackground_color, arg);
1431 if (FRAME_VISIBLE_P (f))
1432 redraw_frame (f);
1436 void
1437 x_set_mouse_color (f, arg, oldval)
1438 struct frame *f;
1439 Lisp_Object arg, oldval;
1441 Cursor cursor, nontext_cursor, mode_cursor, cross_cursor;
1442 Cursor busy_cursor, horizontal_drag_cursor;
1443 int count;
1444 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1445 unsigned long mask_color = f->output_data.x->background_pixel;
1447 /* Don't let pointers be invisible. */
1448 if (mask_color == pixel
1449 && mask_color == f->output_data.x->background_pixel)
1450 pixel = f->output_data.x->foreground_pixel;
1452 unload_color (f, f->output_data.x->mouse_pixel);
1453 f->output_data.x->mouse_pixel = pixel;
1455 BLOCK_INPUT;
1457 /* It's not okay to crash if the user selects a screwy cursor. */
1458 count = x_catch_errors (FRAME_X_DISPLAY (f));
1460 if (!EQ (Qnil, Vx_pointer_shape))
1462 CHECK_NUMBER (Vx_pointer_shape, 0);
1463 cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XINT (Vx_pointer_shape));
1465 else
1466 cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_xterm);
1467 x_check_errors (FRAME_X_DISPLAY (f), "bad text pointer cursor: %s");
1469 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1471 CHECK_NUMBER (Vx_nontext_pointer_shape, 0);
1472 nontext_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1473 XINT (Vx_nontext_pointer_shape));
1475 else
1476 nontext_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_left_ptr);
1477 x_check_errors (FRAME_X_DISPLAY (f), "bad nontext pointer cursor: %s");
1479 if (!EQ (Qnil, Vx_busy_pointer_shape))
1481 CHECK_NUMBER (Vx_busy_pointer_shape, 0);
1482 busy_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1483 XINT (Vx_busy_pointer_shape));
1485 else
1486 busy_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_watch);
1487 x_check_errors (FRAME_X_DISPLAY (f), "bad busy pointer cursor: %s");
1489 x_check_errors (FRAME_X_DISPLAY (f), "bad nontext pointer cursor: %s");
1490 if (!EQ (Qnil, Vx_mode_pointer_shape))
1492 CHECK_NUMBER (Vx_mode_pointer_shape, 0);
1493 mode_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1494 XINT (Vx_mode_pointer_shape));
1496 else
1497 mode_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_xterm);
1498 x_check_errors (FRAME_X_DISPLAY (f), "bad modeline pointer cursor: %s");
1500 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1502 CHECK_NUMBER (Vx_sensitive_text_pointer_shape, 0);
1503 cross_cursor
1504 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1505 XINT (Vx_sensitive_text_pointer_shape));
1507 else
1508 cross_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_crosshair);
1510 if (!NILP (Vx_window_horizontal_drag_shape))
1512 CHECK_NUMBER (Vx_window_horizontal_drag_shape, 0);
1513 horizontal_drag_cursor
1514 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1515 XINT (Vx_window_horizontal_drag_shape));
1517 else
1518 horizontal_drag_cursor
1519 = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_sb_h_double_arrow);
1521 /* Check and report errors with the above calls. */
1522 x_check_errors (FRAME_X_DISPLAY (f), "can't set cursor shape: %s");
1523 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1526 XColor fore_color, back_color;
1528 fore_color.pixel = f->output_data.x->mouse_pixel;
1529 x_query_color (f, &fore_color);
1530 back_color.pixel = mask_color;
1531 x_query_color (f, &back_color);
1533 XRecolorCursor (FRAME_X_DISPLAY (f), cursor,
1534 &fore_color, &back_color);
1535 XRecolorCursor (FRAME_X_DISPLAY (f), nontext_cursor,
1536 &fore_color, &back_color);
1537 XRecolorCursor (FRAME_X_DISPLAY (f), mode_cursor,
1538 &fore_color, &back_color);
1539 XRecolorCursor (FRAME_X_DISPLAY (f), cross_cursor,
1540 &fore_color, &back_color);
1541 XRecolorCursor (FRAME_X_DISPLAY (f), busy_cursor,
1542 &fore_color, &back_color);
1543 XRecolorCursor (FRAME_X_DISPLAY (f), horizontal_drag_cursor,
1544 &fore_color, &back_color);
1547 if (FRAME_X_WINDOW (f) != 0)
1548 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
1550 if (cursor != f->output_data.x->text_cursor
1551 && f->output_data.x->text_cursor != 0)
1552 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->text_cursor);
1553 f->output_data.x->text_cursor = cursor;
1555 if (nontext_cursor != f->output_data.x->nontext_cursor
1556 && f->output_data.x->nontext_cursor != 0)
1557 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->nontext_cursor);
1558 f->output_data.x->nontext_cursor = nontext_cursor;
1560 if (busy_cursor != f->output_data.x->busy_cursor
1561 && f->output_data.x->busy_cursor != 0)
1562 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->busy_cursor);
1563 f->output_data.x->busy_cursor = busy_cursor;
1565 if (mode_cursor != f->output_data.x->modeline_cursor
1566 && f->output_data.x->modeline_cursor != 0)
1567 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->modeline_cursor);
1568 f->output_data.x->modeline_cursor = mode_cursor;
1570 if (cross_cursor != f->output_data.x->cross_cursor
1571 && f->output_data.x->cross_cursor != 0)
1572 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->cross_cursor);
1573 f->output_data.x->cross_cursor = cross_cursor;
1575 if (horizontal_drag_cursor != f->output_data.x->horizontal_drag_cursor
1576 && f->output_data.x->horizontal_drag_cursor != 0)
1577 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->horizontal_drag_cursor);
1578 f->output_data.x->horizontal_drag_cursor = horizontal_drag_cursor;
1580 XFlush (FRAME_X_DISPLAY (f));
1581 UNBLOCK_INPUT;
1583 update_face_from_frame_parameter (f, Qmouse_color, arg);
1586 void
1587 x_set_cursor_color (f, arg, oldval)
1588 struct frame *f;
1589 Lisp_Object arg, oldval;
1591 unsigned long fore_pixel, pixel;
1592 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1594 if (!NILP (Vx_cursor_fore_pixel))
1596 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1597 WHITE_PIX_DEFAULT (f));
1598 fore_pixel_allocated_p = 1;
1600 else
1601 fore_pixel = f->output_data.x->background_pixel;
1603 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1604 pixel_allocated_p = 1;
1606 /* Make sure that the cursor color differs from the background color. */
1607 if (pixel == f->output_data.x->background_pixel)
1609 if (pixel_allocated_p)
1611 x_free_colors (f, &pixel, 1);
1612 pixel_allocated_p = 0;
1615 pixel = f->output_data.x->mouse_pixel;
1616 if (pixel == fore_pixel)
1618 if (fore_pixel_allocated_p)
1620 x_free_colors (f, &fore_pixel, 1);
1621 fore_pixel_allocated_p = 0;
1623 fore_pixel = f->output_data.x->background_pixel;
1627 unload_color (f, f->output_data.x->cursor_foreground_pixel);
1628 if (!fore_pixel_allocated_p)
1629 fore_pixel = x_copy_color (f, fore_pixel);
1630 f->output_data.x->cursor_foreground_pixel = fore_pixel;
1632 unload_color (f, f->output_data.x->cursor_pixel);
1633 if (!pixel_allocated_p)
1634 pixel = x_copy_color (f, pixel);
1635 f->output_data.x->cursor_pixel = pixel;
1637 if (FRAME_X_WINDOW (f) != 0)
1639 BLOCK_INPUT;
1640 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1641 f->output_data.x->cursor_pixel);
1642 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1643 fore_pixel);
1644 UNBLOCK_INPUT;
1646 if (FRAME_VISIBLE_P (f))
1648 x_update_cursor (f, 0);
1649 x_update_cursor (f, 1);
1653 update_face_from_frame_parameter (f, Qcursor_color, arg);
1656 /* Set the border-color of frame F to value described by ARG.
1657 ARG can be a string naming a color.
1658 The border-color is used for the border that is drawn by the X server.
1659 Note that this does not fully take effect if done before
1660 F has an x-window; it must be redone when the window is created.
1662 Note: this is done in two routines because of the way X10 works.
1664 Note: under X11, this is normally the province of the window manager,
1665 and so emacs' border colors may be overridden. */
1667 void
1668 x_set_border_color (f, arg, oldval)
1669 struct frame *f;
1670 Lisp_Object arg, oldval;
1672 int pix;
1674 CHECK_STRING (arg, 0);
1675 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1676 x_set_border_pixel (f, pix);
1677 update_face_from_frame_parameter (f, Qborder_color, arg);
1680 /* Set the border-color of frame F to pixel value PIX.
1681 Note that this does not fully take effect if done before
1682 F has an x-window. */
1684 void
1685 x_set_border_pixel (f, pix)
1686 struct frame *f;
1687 int pix;
1689 unload_color (f, f->output_data.x->border_pixel);
1690 f->output_data.x->border_pixel = pix;
1692 if (FRAME_X_WINDOW (f) != 0 && f->output_data.x->border_width > 0)
1694 BLOCK_INPUT;
1695 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1696 (unsigned long)pix);
1697 UNBLOCK_INPUT;
1699 if (FRAME_VISIBLE_P (f))
1700 redraw_frame (f);
1705 /* Value is the internal representation of the specified cursor type
1706 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
1707 of the bar cursor. */
1709 enum text_cursor_kinds
1710 x_specified_cursor_type (arg, width)
1711 Lisp_Object arg;
1712 int *width;
1714 enum text_cursor_kinds type;
1716 if (EQ (arg, Qbar))
1718 type = BAR_CURSOR;
1719 *width = 2;
1721 else if (CONSP (arg)
1722 && EQ (XCAR (arg), Qbar)
1723 && INTEGERP (XCDR (arg))
1724 && XINT (XCDR (arg)) >= 0)
1726 type = BAR_CURSOR;
1727 *width = XINT (XCDR (arg));
1729 else if (NILP (arg))
1730 type = NO_CURSOR;
1731 else
1732 /* Treat anything unknown as "box cursor".
1733 It was bad to signal an error; people have trouble fixing
1734 .Xdefaults with Emacs, when it has something bad in it. */
1735 type = FILLED_BOX_CURSOR;
1737 return type;
1740 void
1741 x_set_cursor_type (f, arg, oldval)
1742 FRAME_PTR f;
1743 Lisp_Object arg, oldval;
1745 int width;
1747 FRAME_DESIRED_CURSOR (f) = x_specified_cursor_type (arg, &width);
1748 f->output_data.x->cursor_width = width;
1750 /* Make sure the cursor gets redrawn. This is overkill, but how
1751 often do people change cursor types? */
1752 update_mode_lines++;
1755 void
1756 x_set_icon_type (f, arg, oldval)
1757 struct frame *f;
1758 Lisp_Object arg, oldval;
1760 int result;
1762 if (STRINGP (arg))
1764 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1765 return;
1767 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1768 return;
1770 BLOCK_INPUT;
1771 if (NILP (arg))
1772 result = x_text_icon (f,
1773 (char *) XSTRING ((!NILP (f->icon_name)
1774 ? f->icon_name
1775 : f->name))->data);
1776 else
1777 result = x_bitmap_icon (f, arg);
1779 if (result)
1781 UNBLOCK_INPUT;
1782 error ("No icon window available");
1785 XFlush (FRAME_X_DISPLAY (f));
1786 UNBLOCK_INPUT;
1789 /* Return non-nil if frame F wants a bitmap icon. */
1791 Lisp_Object
1792 x_icon_type (f)
1793 FRAME_PTR f;
1795 Lisp_Object tem;
1797 tem = assq_no_quit (Qicon_type, f->param_alist);
1798 if (CONSP (tem))
1799 return XCDR (tem);
1800 else
1801 return Qnil;
1804 void
1805 x_set_icon_name (f, arg, oldval)
1806 struct frame *f;
1807 Lisp_Object arg, oldval;
1809 int result;
1811 if (STRINGP (arg))
1813 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1814 return;
1816 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1817 return;
1819 f->icon_name = arg;
1821 if (f->output_data.x->icon_bitmap != 0)
1822 return;
1824 BLOCK_INPUT;
1826 result = x_text_icon (f,
1827 (char *) XSTRING ((!NILP (f->icon_name)
1828 ? f->icon_name
1829 : !NILP (f->title)
1830 ? f->title
1831 : f->name))->data);
1833 if (result)
1835 UNBLOCK_INPUT;
1836 error ("No icon window available");
1839 XFlush (FRAME_X_DISPLAY (f));
1840 UNBLOCK_INPUT;
1843 void
1844 x_set_font (f, arg, oldval)
1845 struct frame *f;
1846 Lisp_Object arg, oldval;
1848 Lisp_Object result;
1849 Lisp_Object fontset_name;
1850 Lisp_Object frame;
1852 CHECK_STRING (arg, 1);
1854 fontset_name = Fquery_fontset (arg, Qnil);
1856 BLOCK_INPUT;
1857 result = (STRINGP (fontset_name)
1858 ? x_new_fontset (f, XSTRING (fontset_name)->data)
1859 : x_new_font (f, XSTRING (arg)->data));
1860 UNBLOCK_INPUT;
1862 if (EQ (result, Qnil))
1863 error ("Font `%s' is not defined", XSTRING (arg)->data);
1864 else if (EQ (result, Qt))
1865 error ("The characters of the given font have varying widths");
1866 else if (STRINGP (result))
1868 store_frame_param (f, Qfont, result);
1869 recompute_basic_faces (f);
1871 else
1872 abort ();
1874 do_pending_window_change (0);
1876 /* Don't call `face-set-after-frame-default' when faces haven't been
1877 initialized yet. This is the case when called from
1878 Fx_create_frame. In that case, the X widget or window doesn't
1879 exist either, and we can end up in x_report_frame_params with a
1880 null widget which gives a segfault. */
1881 if (FRAME_FACE_CACHE (f))
1883 XSETFRAME (frame, f);
1884 call1 (Qface_set_after_frame_default, frame);
1888 void
1889 x_set_border_width (f, arg, oldval)
1890 struct frame *f;
1891 Lisp_Object arg, oldval;
1893 CHECK_NUMBER (arg, 0);
1895 if (XINT (arg) == f->output_data.x->border_width)
1896 return;
1898 if (FRAME_X_WINDOW (f) != 0)
1899 error ("Cannot change the border width of a window");
1901 f->output_data.x->border_width = XINT (arg);
1904 void
1905 x_set_internal_border_width (f, arg, oldval)
1906 struct frame *f;
1907 Lisp_Object arg, oldval;
1909 int old = f->output_data.x->internal_border_width;
1911 CHECK_NUMBER (arg, 0);
1912 f->output_data.x->internal_border_width = XINT (arg);
1913 if (f->output_data.x->internal_border_width < 0)
1914 f->output_data.x->internal_border_width = 0;
1916 #ifdef USE_X_TOOLKIT
1917 if (f->output_data.x->edit_widget)
1918 widget_store_internal_border (f->output_data.x->edit_widget);
1919 #endif
1921 if (f->output_data.x->internal_border_width == old)
1922 return;
1924 if (FRAME_X_WINDOW (f) != 0)
1926 x_set_window_size (f, 0, f->width, f->height);
1927 SET_FRAME_GARBAGED (f);
1928 do_pending_window_change (0);
1932 void
1933 x_set_visibility (f, value, oldval)
1934 struct frame *f;
1935 Lisp_Object value, oldval;
1937 Lisp_Object frame;
1938 XSETFRAME (frame, f);
1940 if (NILP (value))
1941 Fmake_frame_invisible (frame, Qt);
1942 else if (EQ (value, Qicon))
1943 Ficonify_frame (frame);
1944 else
1945 Fmake_frame_visible (frame);
1949 /* Change window heights in windows rooted in WINDOW by N lines. */
1951 static void
1952 x_change_window_heights (window, n)
1953 Lisp_Object window;
1954 int n;
1956 struct window *w = XWINDOW (window);
1958 XSETFASTINT (w->top, XFASTINT (w->top) + n);
1959 XSETFASTINT (w->height, XFASTINT (w->height) - n);
1961 if (INTEGERP (w->orig_top))
1962 XSETFASTINT (w->orig_top, XFASTINT (w->orig_top) + n);
1963 if (INTEGERP (w->orig_height))
1964 XSETFASTINT (w->orig_height, XFASTINT (w->orig_height) - n);
1966 /* Handle just the top child in a vertical split. */
1967 if (!NILP (w->vchild))
1968 x_change_window_heights (w->vchild, n);
1970 /* Adjust all children in a horizontal split. */
1971 for (window = w->hchild; !NILP (window); window = w->next)
1973 w = XWINDOW (window);
1974 x_change_window_heights (window, n);
1978 void
1979 x_set_menu_bar_lines (f, value, oldval)
1980 struct frame *f;
1981 Lisp_Object value, oldval;
1983 int nlines;
1984 #ifndef USE_X_TOOLKIT
1985 int olines = FRAME_MENU_BAR_LINES (f);
1986 #endif
1988 /* Right now, menu bars don't work properly in minibuf-only frames;
1989 most of the commands try to apply themselves to the minibuffer
1990 frame itself, and get an error because you can't switch buffers
1991 in or split the minibuffer window. */
1992 if (FRAME_MINIBUF_ONLY_P (f))
1993 return;
1995 if (INTEGERP (value))
1996 nlines = XINT (value);
1997 else
1998 nlines = 0;
2000 /* Make sure we redisplay all windows in this frame. */
2001 windows_or_buffers_changed++;
2003 #ifdef USE_X_TOOLKIT
2004 FRAME_MENU_BAR_LINES (f) = 0;
2005 if (nlines)
2007 FRAME_EXTERNAL_MENU_BAR (f) = 1;
2008 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
2009 /* Make sure next redisplay shows the menu bar. */
2010 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
2012 else
2014 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
2015 free_frame_menubar (f);
2016 FRAME_EXTERNAL_MENU_BAR (f) = 0;
2017 if (FRAME_X_P (f))
2018 f->output_data.x->menubar_widget = 0;
2020 #else /* not USE_X_TOOLKIT */
2021 FRAME_MENU_BAR_LINES (f) = nlines;
2022 x_change_window_heights (f->root_window, nlines - olines);
2023 #endif /* not USE_X_TOOLKIT */
2024 adjust_glyphs (f);
2028 /* Set the number of lines used for the tool bar of frame F to VALUE.
2029 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
2030 is the old number of tool bar lines. This function changes the
2031 height of all windows on frame F to match the new tool bar height.
2032 The frame's height doesn't change. */
2034 void
2035 x_set_tool_bar_lines (f, value, oldval)
2036 struct frame *f;
2037 Lisp_Object value, oldval;
2039 int delta, nlines, root_height;
2040 Lisp_Object root_window;
2042 /* Use VALUE only if an integer >= 0. */
2043 if (INTEGERP (value) && XINT (value) >= 0)
2044 nlines = XFASTINT (value);
2045 else
2046 nlines = 0;
2048 /* Make sure we redisplay all windows in this frame. */
2049 ++windows_or_buffers_changed;
2051 delta = nlines - FRAME_TOOL_BAR_LINES (f);
2053 /* Don't resize the tool-bar to more than we have room for. */
2054 root_window = FRAME_ROOT_WINDOW (f);
2055 root_height = XINT (XWINDOW (root_window)->height);
2056 if (root_height - delta < 1)
2058 delta = root_height - 1;
2059 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
2062 FRAME_TOOL_BAR_LINES (f) = nlines;
2063 x_change_window_heights (root_window, delta);
2064 adjust_glyphs (f);
2066 /* We also have to make sure that the internal border at the top of
2067 the frame, below the menu bar or tool bar, is redrawn when the
2068 tool bar disappears. This is so because the internal border is
2069 below the tool bar if one is displayed, but is below the menu bar
2070 if there isn't a tool bar. The tool bar draws into the area
2071 below the menu bar. */
2072 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
2074 updating_frame = f;
2075 clear_frame ();
2076 clear_current_matrices (f);
2077 updating_frame = NULL;
2080 /* If the tool bar gets smaller, the internal border below it
2081 has to be cleared. It was formerly part of the display
2082 of the larger tool bar, and updating windows won't clear it. */
2083 if (delta < 0)
2085 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
2086 int width = PIXEL_WIDTH (f);
2087 int y = nlines * CANON_Y_UNIT (f);
2089 BLOCK_INPUT;
2090 XClearArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2091 0, y, width, height, False);
2092 UNBLOCK_INPUT;
2097 /* Set the foreground color for scroll bars on frame F to VALUE.
2098 VALUE should be a string, a color name. If it isn't a string or
2099 isn't a valid color name, do nothing. OLDVAL is the old value of
2100 the frame parameter. */
2102 void
2103 x_set_scroll_bar_foreground (f, value, oldval)
2104 struct frame *f;
2105 Lisp_Object value, oldval;
2107 unsigned long pixel;
2109 if (STRINGP (value))
2110 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
2111 else
2112 pixel = -1;
2114 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
2115 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
2117 f->output_data.x->scroll_bar_foreground_pixel = pixel;
2118 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2120 /* Remove all scroll bars because they have wrong colors. */
2121 if (condemn_scroll_bars_hook)
2122 (*condemn_scroll_bars_hook) (f);
2123 if (judge_scroll_bars_hook)
2124 (*judge_scroll_bars_hook) (f);
2126 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
2127 redraw_frame (f);
2132 /* Set the background color for scroll bars on frame F to VALUE VALUE
2133 should be a string, a color name. If it isn't a string or isn't a
2134 valid color name, do nothing. OLDVAL is the old value of the frame
2135 parameter. */
2137 void
2138 x_set_scroll_bar_background (f, value, oldval)
2139 struct frame *f;
2140 Lisp_Object value, oldval;
2142 unsigned long pixel;
2144 if (STRINGP (value))
2145 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
2146 else
2147 pixel = -1;
2149 if (f->output_data.x->scroll_bar_background_pixel != -1)
2150 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
2152 f->output_data.x->scroll_bar_background_pixel = pixel;
2153 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2155 /* Remove all scroll bars because they have wrong colors. */
2156 if (condemn_scroll_bars_hook)
2157 (*condemn_scroll_bars_hook) (f);
2158 if (judge_scroll_bars_hook)
2159 (*judge_scroll_bars_hook) (f);
2161 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
2162 redraw_frame (f);
2167 /* Encode Lisp string STRING as a text in a format appropriate for
2168 XICCC (X Inter Client Communication Conventions).
2170 If STRING contains only ASCII characters, do no conversion and
2171 return the string data of STRING. Otherwise, encode the text by
2172 CODING_SYSTEM, and return a newly allocated memory area which
2173 should be freed by `xfree' by a caller.
2175 Store the byte length of resulting text in *TEXT_BYTES.
2177 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
2178 which means that the `encoding' of the result can be `STRING'.
2179 Otherwise store 0 in *STRINGP, which means that the `encoding' of
2180 the result should be `COMPOUND_TEXT'. */
2182 unsigned char *
2183 x_encode_text (string, coding_system, text_bytes, stringp)
2184 Lisp_Object string, coding_system;
2185 int *text_bytes, *stringp;
2187 unsigned char *str = XSTRING (string)->data;
2188 int chars = XSTRING (string)->size;
2189 int bytes = STRING_BYTES (XSTRING (string));
2190 int charset_info;
2191 int bufsize;
2192 unsigned char *buf;
2193 struct coding_system coding;
2195 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
2196 if (charset_info == 0)
2198 /* No multibyte character in OBJ. We need not encode it. */
2199 *text_bytes = bytes;
2200 *stringp = 1;
2201 return str;
2204 setup_coding_system (coding_system, &coding);
2205 coding.src_multibyte = 1;
2206 coding.dst_multibyte = 0;
2207 coding.mode |= CODING_MODE_LAST_BLOCK;
2208 if (coding.type == coding_type_iso2022)
2209 coding.flags |= CODING_FLAG_ISO_SAFE;
2210 /* We suppress producing escape sequences for composition. */
2211 coding.composing = COMPOSITION_DISABLED;
2212 bufsize = encoding_buffer_size (&coding, bytes);
2213 buf = (unsigned char *) xmalloc (bufsize);
2214 encode_coding (&coding, str, buf, bytes, bufsize);
2215 *text_bytes = coding.produced;
2216 *stringp = (charset_info == 1 || !EQ (coding_system, Qcompound_text));
2217 return buf;
2221 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
2222 x_id_name.
2224 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2225 name; if NAME is a string, set F's name to NAME and set
2226 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2228 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2229 suggesting a new name, which lisp code should override; if
2230 F->explicit_name is set, ignore the new name; otherwise, set it. */
2232 void
2233 x_set_name (f, name, explicit)
2234 struct frame *f;
2235 Lisp_Object name;
2236 int explicit;
2238 /* Make sure that requests from lisp code override requests from
2239 Emacs redisplay code. */
2240 if (explicit)
2242 /* If we're switching from explicit to implicit, we had better
2243 update the mode lines and thereby update the title. */
2244 if (f->explicit_name && NILP (name))
2245 update_mode_lines = 1;
2247 f->explicit_name = ! NILP (name);
2249 else if (f->explicit_name)
2250 return;
2252 /* If NAME is nil, set the name to the x_id_name. */
2253 if (NILP (name))
2255 /* Check for no change needed in this very common case
2256 before we do any consing. */
2257 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
2258 XSTRING (f->name)->data))
2259 return;
2260 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
2262 else
2263 CHECK_STRING (name, 0);
2265 /* Don't change the name if it's already NAME. */
2266 if (! NILP (Fstring_equal (name, f->name)))
2267 return;
2269 f->name = name;
2271 /* For setting the frame title, the title parameter should override
2272 the name parameter. */
2273 if (! NILP (f->title))
2274 name = f->title;
2276 if (FRAME_X_WINDOW (f))
2278 BLOCK_INPUT;
2279 #ifdef HAVE_X11R4
2281 XTextProperty text, icon;
2282 int bytes, stringp;
2283 Lisp_Object coding_system;
2285 coding_system = Vlocale_coding_system;
2286 if (NILP (coding_system))
2287 coding_system = Qcompound_text;
2288 text.value = x_encode_text (name, coding_system, &bytes, &stringp);
2289 text.encoding = (stringp ? XA_STRING
2290 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2291 text.format = 8;
2292 text.nitems = bytes;
2294 if (NILP (f->icon_name))
2296 icon = text;
2298 else
2300 icon.value = x_encode_text (f->icon_name, coding_system,
2301 &bytes, &stringp);
2302 icon.encoding = (stringp ? XA_STRING
2303 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2304 icon.format = 8;
2305 icon.nitems = bytes;
2307 #ifdef USE_X_TOOLKIT
2308 XSetWMName (FRAME_X_DISPLAY (f),
2309 XtWindow (f->output_data.x->widget), &text);
2310 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2311 &icon);
2312 #else /* not USE_X_TOOLKIT */
2313 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2314 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2315 #endif /* not USE_X_TOOLKIT */
2316 if (!NILP (f->icon_name)
2317 && icon.value != XSTRING (f->icon_name)->data)
2318 xfree (icon.value);
2319 if (text.value != XSTRING (name)->data)
2320 xfree (text.value);
2322 #else /* not HAVE_X11R4 */
2323 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2324 XSTRING (name)->data);
2325 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2326 XSTRING (name)->data);
2327 #endif /* not HAVE_X11R4 */
2328 UNBLOCK_INPUT;
2332 /* This function should be called when the user's lisp code has
2333 specified a name for the frame; the name will override any set by the
2334 redisplay code. */
2335 void
2336 x_explicitly_set_name (f, arg, oldval)
2337 FRAME_PTR f;
2338 Lisp_Object arg, oldval;
2340 x_set_name (f, arg, 1);
2343 /* This function should be called by Emacs redisplay code to set the
2344 name; names set this way will never override names set by the user's
2345 lisp code. */
2346 void
2347 x_implicitly_set_name (f, arg, oldval)
2348 FRAME_PTR f;
2349 Lisp_Object arg, oldval;
2351 x_set_name (f, arg, 0);
2354 /* Change the title of frame F to NAME.
2355 If NAME is nil, use the frame name as the title.
2357 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2358 name; if NAME is a string, set F's name to NAME and set
2359 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2361 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2362 suggesting a new name, which lisp code should override; if
2363 F->explicit_name is set, ignore the new name; otherwise, set it. */
2365 void
2366 x_set_title (f, name, old_name)
2367 struct frame *f;
2368 Lisp_Object name, old_name;
2370 /* Don't change the title if it's already NAME. */
2371 if (EQ (name, f->title))
2372 return;
2374 update_mode_lines = 1;
2376 f->title = name;
2378 if (NILP (name))
2379 name = f->name;
2380 else
2381 CHECK_STRING (name, 0);
2383 if (FRAME_X_WINDOW (f))
2385 BLOCK_INPUT;
2386 #ifdef HAVE_X11R4
2388 XTextProperty text, icon;
2389 int bytes, stringp;
2390 Lisp_Object coding_system;
2392 coding_system = Vlocale_coding_system;
2393 if (NILP (coding_system))
2394 coding_system = Qcompound_text;
2395 text.value = x_encode_text (name, coding_system, &bytes, &stringp);
2396 text.encoding = (stringp ? XA_STRING
2397 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2398 text.format = 8;
2399 text.nitems = bytes;
2401 if (NILP (f->icon_name))
2403 icon = text;
2405 else
2407 icon.value = x_encode_text (f->icon_name, coding_system,
2408 &bytes, &stringp);
2409 icon.encoding = (stringp ? XA_STRING
2410 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2411 icon.format = 8;
2412 icon.nitems = bytes;
2414 #ifdef USE_X_TOOLKIT
2415 XSetWMName (FRAME_X_DISPLAY (f),
2416 XtWindow (f->output_data.x->widget), &text);
2417 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2418 &icon);
2419 #else /* not USE_X_TOOLKIT */
2420 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2421 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2422 #endif /* not USE_X_TOOLKIT */
2423 if (!NILP (f->icon_name)
2424 && icon.value != XSTRING (f->icon_name)->data)
2425 xfree (icon.value);
2426 if (text.value != XSTRING (name)->data)
2427 xfree (text.value);
2429 #else /* not HAVE_X11R4 */
2430 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2431 XSTRING (name)->data);
2432 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2433 XSTRING (name)->data);
2434 #endif /* not HAVE_X11R4 */
2435 UNBLOCK_INPUT;
2439 void
2440 x_set_autoraise (f, arg, oldval)
2441 struct frame *f;
2442 Lisp_Object arg, oldval;
2444 f->auto_raise = !EQ (Qnil, arg);
2447 void
2448 x_set_autolower (f, arg, oldval)
2449 struct frame *f;
2450 Lisp_Object arg, oldval;
2452 f->auto_lower = !EQ (Qnil, arg);
2455 void
2456 x_set_unsplittable (f, arg, oldval)
2457 struct frame *f;
2458 Lisp_Object arg, oldval;
2460 f->no_split = !NILP (arg);
2463 void
2464 x_set_vertical_scroll_bars (f, arg, oldval)
2465 struct frame *f;
2466 Lisp_Object arg, oldval;
2468 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
2469 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
2470 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
2471 || (!NILP (arg) && ! FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
2473 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
2474 = (NILP (arg)
2475 ? vertical_scroll_bar_none
2476 : EQ (Qright, arg)
2477 ? vertical_scroll_bar_right
2478 : vertical_scroll_bar_left);
2480 /* We set this parameter before creating the X window for the
2481 frame, so we can get the geometry right from the start.
2482 However, if the window hasn't been created yet, we shouldn't
2483 call x_set_window_size. */
2484 if (FRAME_X_WINDOW (f))
2485 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2486 do_pending_window_change (0);
2490 void
2491 x_set_scroll_bar_width (f, arg, oldval)
2492 struct frame *f;
2493 Lisp_Object arg, oldval;
2495 int wid = FONT_WIDTH (f->output_data.x->font);
2497 if (NILP (arg))
2499 #ifdef USE_TOOLKIT_SCROLL_BARS
2500 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2501 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2502 FRAME_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
2503 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = width;
2504 #else
2505 /* Make the actual width at least 14 pixels and a multiple of a
2506 character width. */
2507 FRAME_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
2509 /* Use all of that space (aside from required margins) for the
2510 scroll bar. */
2511 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = 0;
2512 #endif
2514 if (FRAME_X_WINDOW (f))
2515 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2516 do_pending_window_change (0);
2518 else if (INTEGERP (arg) && XINT (arg) > 0
2519 && XFASTINT (arg) != FRAME_SCROLL_BAR_PIXEL_WIDTH (f))
2521 if (XFASTINT (arg) <= 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM)
2522 XSETINT (arg, 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM + 1);
2524 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = XFASTINT (arg);
2525 FRAME_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + wid-1) / wid;
2526 if (FRAME_X_WINDOW (f))
2527 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2530 change_frame_size (f, 0, FRAME_WIDTH (f), 0, 0, 0);
2531 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
2532 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
2537 /* Subroutines of creating an X frame. */
2539 /* Make sure that Vx_resource_name is set to a reasonable value.
2540 Fix it up, or set it to `emacs' if it is too hopeless. */
2542 static void
2543 validate_x_resource_name ()
2545 int len = 0;
2546 /* Number of valid characters in the resource name. */
2547 int good_count = 0;
2548 /* Number of invalid characters in the resource name. */
2549 int bad_count = 0;
2550 Lisp_Object new;
2551 int i;
2553 if (!STRINGP (Vx_resource_class))
2554 Vx_resource_class = build_string (EMACS_CLASS);
2556 if (STRINGP (Vx_resource_name))
2558 unsigned char *p = XSTRING (Vx_resource_name)->data;
2559 int i;
2561 len = STRING_BYTES (XSTRING (Vx_resource_name));
2563 /* Only letters, digits, - and _ are valid in resource names.
2564 Count the valid characters and count the invalid ones. */
2565 for (i = 0; i < len; i++)
2567 int c = p[i];
2568 if (! ((c >= 'a' && c <= 'z')
2569 || (c >= 'A' && c <= 'Z')
2570 || (c >= '0' && c <= '9')
2571 || c == '-' || c == '_'))
2572 bad_count++;
2573 else
2574 good_count++;
2577 else
2578 /* Not a string => completely invalid. */
2579 bad_count = 5, good_count = 0;
2581 /* If name is valid already, return. */
2582 if (bad_count == 0)
2583 return;
2585 /* If name is entirely invalid, or nearly so, use `emacs'. */
2586 if (good_count == 0
2587 || (good_count == 1 && bad_count > 0))
2589 Vx_resource_name = build_string ("emacs");
2590 return;
2593 /* Name is partly valid. Copy it and replace the invalid characters
2594 with underscores. */
2596 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
2598 for (i = 0; i < len; i++)
2600 int c = XSTRING (new)->data[i];
2601 if (! ((c >= 'a' && c <= 'z')
2602 || (c >= 'A' && c <= 'Z')
2603 || (c >= '0' && c <= '9')
2604 || c == '-' || c == '_'))
2605 XSTRING (new)->data[i] = '_';
2610 extern char *x_get_string_resource ();
2612 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
2613 "Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.\n\
2614 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the\n\
2615 class, where INSTANCE is the name under which Emacs was invoked, or\n\
2616 the name specified by the `-name' or `-rn' command-line arguments.\n\
2618 The optional arguments COMPONENT and SUBCLASS add to the key and the\n\
2619 class, respectively. You must specify both of them or neither.\n\
2620 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'\n\
2621 and the class is `Emacs.CLASS.SUBCLASS'.")
2622 (attribute, class, component, subclass)
2623 Lisp_Object attribute, class, component, subclass;
2625 register char *value;
2626 char *name_key;
2627 char *class_key;
2629 check_x ();
2631 CHECK_STRING (attribute, 0);
2632 CHECK_STRING (class, 0);
2634 if (!NILP (component))
2635 CHECK_STRING (component, 1);
2636 if (!NILP (subclass))
2637 CHECK_STRING (subclass, 2);
2638 if (NILP (component) != NILP (subclass))
2639 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2641 validate_x_resource_name ();
2643 /* Allocate space for the components, the dots which separate them,
2644 and the final '\0'. Make them big enough for the worst case. */
2645 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2646 + (STRINGP (component)
2647 ? STRING_BYTES (XSTRING (component)) : 0)
2648 + STRING_BYTES (XSTRING (attribute))
2649 + 3);
2651 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2652 + STRING_BYTES (XSTRING (class))
2653 + (STRINGP (subclass)
2654 ? STRING_BYTES (XSTRING (subclass)) : 0)
2655 + 3);
2657 /* Start with emacs.FRAMENAME for the name (the specific one)
2658 and with `Emacs' for the class key (the general one). */
2659 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2660 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2662 strcat (class_key, ".");
2663 strcat (class_key, XSTRING (class)->data);
2665 if (!NILP (component))
2667 strcat (class_key, ".");
2668 strcat (class_key, XSTRING (subclass)->data);
2670 strcat (name_key, ".");
2671 strcat (name_key, XSTRING (component)->data);
2674 strcat (name_key, ".");
2675 strcat (name_key, XSTRING (attribute)->data);
2677 value = x_get_string_resource (check_x_display_info (Qnil)->xrdb,
2678 name_key, class_key);
2680 if (value != (char *) 0)
2681 return build_string (value);
2682 else
2683 return Qnil;
2686 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
2688 Lisp_Object
2689 display_x_get_resource (dpyinfo, attribute, class, component, subclass)
2690 struct x_display_info *dpyinfo;
2691 Lisp_Object attribute, class, component, subclass;
2693 register char *value;
2694 char *name_key;
2695 char *class_key;
2697 CHECK_STRING (attribute, 0);
2698 CHECK_STRING (class, 0);
2700 if (!NILP (component))
2701 CHECK_STRING (component, 1);
2702 if (!NILP (subclass))
2703 CHECK_STRING (subclass, 2);
2704 if (NILP (component) != NILP (subclass))
2705 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2707 validate_x_resource_name ();
2709 /* Allocate space for the components, the dots which separate them,
2710 and the final '\0'. Make them big enough for the worst case. */
2711 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2712 + (STRINGP (component)
2713 ? STRING_BYTES (XSTRING (component)) : 0)
2714 + STRING_BYTES (XSTRING (attribute))
2715 + 3);
2717 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2718 + STRING_BYTES (XSTRING (class))
2719 + (STRINGP (subclass)
2720 ? STRING_BYTES (XSTRING (subclass)) : 0)
2721 + 3);
2723 /* Start with emacs.FRAMENAME for the name (the specific one)
2724 and with `Emacs' for the class key (the general one). */
2725 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2726 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2728 strcat (class_key, ".");
2729 strcat (class_key, XSTRING (class)->data);
2731 if (!NILP (component))
2733 strcat (class_key, ".");
2734 strcat (class_key, XSTRING (subclass)->data);
2736 strcat (name_key, ".");
2737 strcat (name_key, XSTRING (component)->data);
2740 strcat (name_key, ".");
2741 strcat (name_key, XSTRING (attribute)->data);
2743 value = x_get_string_resource (dpyinfo->xrdb, name_key, class_key);
2745 if (value != (char *) 0)
2746 return build_string (value);
2747 else
2748 return Qnil;
2751 /* Used when C code wants a resource value. */
2753 char *
2754 x_get_resource_string (attribute, class)
2755 char *attribute, *class;
2757 char *name_key;
2758 char *class_key;
2759 struct frame *sf = SELECTED_FRAME ();
2761 /* Allocate space for the components, the dots which separate them,
2762 and the final '\0'. */
2763 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vinvocation_name))
2764 + strlen (attribute) + 2);
2765 class_key = (char *) alloca ((sizeof (EMACS_CLASS) - 1)
2766 + strlen (class) + 2);
2768 sprintf (name_key, "%s.%s",
2769 XSTRING (Vinvocation_name)->data,
2770 attribute);
2771 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
2773 return x_get_string_resource (FRAME_X_DISPLAY_INFO (sf)->xrdb,
2774 name_key, class_key);
2777 /* Types we might convert a resource string into. */
2778 enum resource_types
2780 RES_TYPE_NUMBER,
2781 RES_TYPE_FLOAT,
2782 RES_TYPE_BOOLEAN,
2783 RES_TYPE_STRING,
2784 RES_TYPE_SYMBOL
2787 /* Return the value of parameter PARAM.
2789 First search ALIST, then Vdefault_frame_alist, then the X defaults
2790 database, using ATTRIBUTE as the attribute name and CLASS as its class.
2792 Convert the resource to the type specified by desired_type.
2794 If no default is specified, return Qunbound. If you call
2795 x_get_arg, make sure you deal with Qunbound in a reasonable way,
2796 and don't let it get stored in any Lisp-visible variables! */
2798 static Lisp_Object
2799 x_get_arg (dpyinfo, alist, param, attribute, class, type)
2800 struct x_display_info *dpyinfo;
2801 Lisp_Object alist, param;
2802 char *attribute;
2803 char *class;
2804 enum resource_types type;
2806 register Lisp_Object tem;
2808 tem = Fassq (param, alist);
2809 if (EQ (tem, Qnil))
2810 tem = Fassq (param, Vdefault_frame_alist);
2811 if (EQ (tem, Qnil))
2814 if (attribute)
2816 tem = display_x_get_resource (dpyinfo,
2817 build_string (attribute),
2818 build_string (class),
2819 Qnil, Qnil);
2821 if (NILP (tem))
2822 return Qunbound;
2824 switch (type)
2826 case RES_TYPE_NUMBER:
2827 return make_number (atoi (XSTRING (tem)->data));
2829 case RES_TYPE_FLOAT:
2830 return make_float (atof (XSTRING (tem)->data));
2832 case RES_TYPE_BOOLEAN:
2833 tem = Fdowncase (tem);
2834 if (!strcmp (XSTRING (tem)->data, "on")
2835 || !strcmp (XSTRING (tem)->data, "true"))
2836 return Qt;
2837 else
2838 return Qnil;
2840 case RES_TYPE_STRING:
2841 return tem;
2843 case RES_TYPE_SYMBOL:
2844 /* As a special case, we map the values `true' and `on'
2845 to Qt, and `false' and `off' to Qnil. */
2847 Lisp_Object lower;
2848 lower = Fdowncase (tem);
2849 if (!strcmp (XSTRING (lower)->data, "on")
2850 || !strcmp (XSTRING (lower)->data, "true"))
2851 return Qt;
2852 else if (!strcmp (XSTRING (lower)->data, "off")
2853 || !strcmp (XSTRING (lower)->data, "false"))
2854 return Qnil;
2855 else
2856 return Fintern (tem, Qnil);
2859 default:
2860 abort ();
2863 else
2864 return Qunbound;
2866 return Fcdr (tem);
2869 /* Like x_get_arg, but also record the value in f->param_alist. */
2871 static Lisp_Object
2872 x_get_and_record_arg (f, alist, param, attribute, class, type)
2873 struct frame *f;
2874 Lisp_Object alist, param;
2875 char *attribute;
2876 char *class;
2877 enum resource_types type;
2879 Lisp_Object value;
2881 value = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, param,
2882 attribute, class, type);
2883 if (! NILP (value))
2884 store_frame_param (f, param, value);
2886 return value;
2889 /* Record in frame F the specified or default value according to ALIST
2890 of the parameter named PROP (a Lisp symbol).
2891 If no value is specified for PROP, look for an X default for XPROP
2892 on the frame named NAME.
2893 If that is not found either, use the value DEFLT. */
2895 static Lisp_Object
2896 x_default_parameter (f, alist, prop, deflt, xprop, xclass, type)
2897 struct frame *f;
2898 Lisp_Object alist;
2899 Lisp_Object prop;
2900 Lisp_Object deflt;
2901 char *xprop;
2902 char *xclass;
2903 enum resource_types type;
2905 Lisp_Object tem;
2907 tem = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, prop, xprop, xclass, type);
2908 if (EQ (tem, Qunbound))
2909 tem = deflt;
2910 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2911 return tem;
2915 /* Record in frame F the specified or default value according to ALIST
2916 of the parameter named PROP (a Lisp symbol). If no value is
2917 specified for PROP, look for an X default for XPROP on the frame
2918 named NAME. If that is not found either, use the value DEFLT. */
2920 static Lisp_Object
2921 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
2922 foreground_p)
2923 struct frame *f;
2924 Lisp_Object alist;
2925 Lisp_Object prop;
2926 char *xprop;
2927 char *xclass;
2928 int foreground_p;
2930 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2931 Lisp_Object tem;
2933 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
2934 if (EQ (tem, Qunbound))
2936 #ifdef USE_TOOLKIT_SCROLL_BARS
2938 /* See if an X resource for the scroll bar color has been
2939 specified. */
2940 tem = display_x_get_resource (dpyinfo,
2941 build_string (foreground_p
2942 ? "foreground"
2943 : "background"),
2944 build_string (""),
2945 build_string ("verticalScrollBar"),
2946 build_string (""));
2947 if (!STRINGP (tem))
2949 /* If nothing has been specified, scroll bars will use a
2950 toolkit-dependent default. Because these defaults are
2951 difficult to get at without actually creating a scroll
2952 bar, use nil to indicate that no color has been
2953 specified. */
2954 tem = Qnil;
2957 #else /* not USE_TOOLKIT_SCROLL_BARS */
2959 tem = Qnil;
2961 #endif /* not USE_TOOLKIT_SCROLL_BARS */
2964 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2965 return tem;
2970 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
2971 "Parse an X-style geometry string STRING.\n\
2972 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).\n\
2973 The properties returned may include `top', `left', `height', and `width'.\n\
2974 The value of `left' or `top' may be an integer,\n\
2975 or a list (+ N) meaning N pixels relative to top/left corner,\n\
2976 or a list (- N) meaning -N pixels relative to bottom/right corner.")
2977 (string)
2978 Lisp_Object string;
2980 int geometry, x, y;
2981 unsigned int width, height;
2982 Lisp_Object result;
2984 CHECK_STRING (string, 0);
2986 geometry = XParseGeometry ((char *) XSTRING (string)->data,
2987 &x, &y, &width, &height);
2989 #if 0
2990 if (!!(geometry & XValue) != !!(geometry & YValue))
2991 error ("Must specify both x and y position, or neither");
2992 #endif
2994 result = Qnil;
2995 if (geometry & XValue)
2997 Lisp_Object element;
2999 if (x >= 0 && (geometry & XNegative))
3000 element = Fcons (Qleft, Fcons (Qminus, Fcons (make_number (-x), Qnil)));
3001 else if (x < 0 && ! (geometry & XNegative))
3002 element = Fcons (Qleft, Fcons (Qplus, Fcons (make_number (x), Qnil)));
3003 else
3004 element = Fcons (Qleft, make_number (x));
3005 result = Fcons (element, result);
3008 if (geometry & YValue)
3010 Lisp_Object element;
3012 if (y >= 0 && (geometry & YNegative))
3013 element = Fcons (Qtop, Fcons (Qminus, Fcons (make_number (-y), Qnil)));
3014 else if (y < 0 && ! (geometry & YNegative))
3015 element = Fcons (Qtop, Fcons (Qplus, Fcons (make_number (y), Qnil)));
3016 else
3017 element = Fcons (Qtop, make_number (y));
3018 result = Fcons (element, result);
3021 if (geometry & WidthValue)
3022 result = Fcons (Fcons (Qwidth, make_number (width)), result);
3023 if (geometry & HeightValue)
3024 result = Fcons (Fcons (Qheight, make_number (height)), result);
3026 return result;
3029 /* Calculate the desired size and position of this window,
3030 and return the flags saying which aspects were specified.
3032 This function does not make the coordinates positive. */
3034 #define DEFAULT_ROWS 40
3035 #define DEFAULT_COLS 80
3037 static int
3038 x_figure_window_size (f, parms)
3039 struct frame *f;
3040 Lisp_Object parms;
3042 register Lisp_Object tem0, tem1, tem2;
3043 long window_prompting = 0;
3044 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3046 /* Default values if we fall through.
3047 Actually, if that happens we should get
3048 window manager prompting. */
3049 SET_FRAME_WIDTH (f, DEFAULT_COLS);
3050 f->height = DEFAULT_ROWS;
3051 /* Window managers expect that if program-specified
3052 positions are not (0,0), they're intentional, not defaults. */
3053 f->output_data.x->top_pos = 0;
3054 f->output_data.x->left_pos = 0;
3056 tem0 = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
3057 tem1 = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
3058 tem2 = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
3059 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3061 if (!EQ (tem0, Qunbound))
3063 CHECK_NUMBER (tem0, 0);
3064 f->height = XINT (tem0);
3066 if (!EQ (tem1, Qunbound))
3068 CHECK_NUMBER (tem1, 0);
3069 SET_FRAME_WIDTH (f, XINT (tem1));
3071 if (!NILP (tem2) && !EQ (tem2, Qunbound))
3072 window_prompting |= USSize;
3073 else
3074 window_prompting |= PSize;
3077 f->output_data.x->vertical_scroll_bar_extra
3078 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
3080 : (FRAME_SCROLL_BAR_COLS (f) * FONT_WIDTH (f->output_data.x->font)));
3081 f->output_data.x->flags_areas_extra
3082 = FRAME_FLAGS_AREA_WIDTH (f);
3083 f->output_data.x->pixel_width = CHAR_TO_PIXEL_WIDTH (f, f->width);
3084 f->output_data.x->pixel_height = CHAR_TO_PIXEL_HEIGHT (f, f->height);
3086 tem0 = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
3087 tem1 = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
3088 tem2 = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
3089 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3091 if (EQ (tem0, Qminus))
3093 f->output_data.x->top_pos = 0;
3094 window_prompting |= YNegative;
3096 else if (CONSP (tem0) && EQ (XCAR (tem0), Qminus)
3097 && CONSP (XCDR (tem0))
3098 && INTEGERP (XCAR (XCDR (tem0))))
3100 f->output_data.x->top_pos = - XINT (XCAR (XCDR (tem0)));
3101 window_prompting |= YNegative;
3103 else if (CONSP (tem0) && EQ (XCAR (tem0), Qplus)
3104 && CONSP (XCDR (tem0))
3105 && INTEGERP (XCAR (XCDR (tem0))))
3107 f->output_data.x->top_pos = XINT (XCAR (XCDR (tem0)));
3109 else if (EQ (tem0, Qunbound))
3110 f->output_data.x->top_pos = 0;
3111 else
3113 CHECK_NUMBER (tem0, 0);
3114 f->output_data.x->top_pos = XINT (tem0);
3115 if (f->output_data.x->top_pos < 0)
3116 window_prompting |= YNegative;
3119 if (EQ (tem1, Qminus))
3121 f->output_data.x->left_pos = 0;
3122 window_prompting |= XNegative;
3124 else if (CONSP (tem1) && EQ (XCAR (tem1), Qminus)
3125 && CONSP (XCDR (tem1))
3126 && INTEGERP (XCAR (XCDR (tem1))))
3128 f->output_data.x->left_pos = - XINT (XCAR (XCDR (tem1)));
3129 window_prompting |= XNegative;
3131 else if (CONSP (tem1) && EQ (XCAR (tem1), Qplus)
3132 && CONSP (XCDR (tem1))
3133 && INTEGERP (XCAR (XCDR (tem1))))
3135 f->output_data.x->left_pos = XINT (XCAR (XCDR (tem1)));
3137 else if (EQ (tem1, Qunbound))
3138 f->output_data.x->left_pos = 0;
3139 else
3141 CHECK_NUMBER (tem1, 0);
3142 f->output_data.x->left_pos = XINT (tem1);
3143 if (f->output_data.x->left_pos < 0)
3144 window_prompting |= XNegative;
3147 if (!NILP (tem2) && ! EQ (tem2, Qunbound))
3148 window_prompting |= USPosition;
3149 else
3150 window_prompting |= PPosition;
3153 return window_prompting;
3156 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
3158 Status
3159 XSetWMProtocols (dpy, w, protocols, count)
3160 Display *dpy;
3161 Window w;
3162 Atom *protocols;
3163 int count;
3165 Atom prop;
3166 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
3167 if (prop == None) return False;
3168 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
3169 (unsigned char *) protocols, count);
3170 return True;
3172 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
3174 #ifdef USE_X_TOOLKIT
3176 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
3177 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
3178 already be present because of the toolkit (Motif adds some of them,
3179 for example, but Xt doesn't). */
3181 static void
3182 hack_wm_protocols (f, widget)
3183 FRAME_PTR f;
3184 Widget widget;
3186 Display *dpy = XtDisplay (widget);
3187 Window w = XtWindow (widget);
3188 int need_delete = 1;
3189 int need_focus = 1;
3190 int need_save = 1;
3192 BLOCK_INPUT;
3194 Atom type, *atoms = 0;
3195 int format = 0;
3196 unsigned long nitems = 0;
3197 unsigned long bytes_after;
3199 if ((XGetWindowProperty (dpy, w,
3200 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3201 (long)0, (long)100, False, XA_ATOM,
3202 &type, &format, &nitems, &bytes_after,
3203 (unsigned char **) &atoms)
3204 == Success)
3205 && format == 32 && type == XA_ATOM)
3206 while (nitems > 0)
3208 nitems--;
3209 if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
3210 need_delete = 0;
3211 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
3212 need_focus = 0;
3213 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
3214 need_save = 0;
3216 if (atoms) XFree ((char *) atoms);
3219 Atom props [10];
3220 int count = 0;
3221 if (need_delete)
3222 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3223 if (need_focus)
3224 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
3225 if (need_save)
3226 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3227 if (count)
3228 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3229 XA_ATOM, 32, PropModeAppend,
3230 (unsigned char *) props, count);
3232 UNBLOCK_INPUT;
3234 #endif
3238 /* Support routines for XIC (X Input Context). */
3240 #ifdef HAVE_X_I18N
3242 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
3243 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
3246 /* Supported XIM styles, ordered by preferenc. */
3248 static XIMStyle supported_xim_styles[] =
3250 XIMPreeditPosition | XIMStatusArea,
3251 XIMPreeditPosition | XIMStatusNothing,
3252 XIMPreeditPosition | XIMStatusNone,
3253 XIMPreeditNothing | XIMStatusArea,
3254 XIMPreeditNothing | XIMStatusNothing,
3255 XIMPreeditNothing | XIMStatusNone,
3256 XIMPreeditNone | XIMStatusArea,
3257 XIMPreeditNone | XIMStatusNothing,
3258 XIMPreeditNone | XIMStatusNone,
3263 /* Create an X fontset on frame F with base font name
3264 BASE_FONTNAME.. */
3266 static XFontSet
3267 xic_create_xfontset (f, base_fontname)
3268 struct frame *f;
3269 char *base_fontname;
3271 XFontSet xfs;
3272 char **missing_list;
3273 int missing_count;
3274 char *def_string;
3276 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
3277 base_fontname, &missing_list,
3278 &missing_count, &def_string);
3279 if (missing_list)
3280 XFreeStringList (missing_list);
3282 /* No need to free def_string. */
3283 return xfs;
3287 /* Value is the best input style, given user preferences USER (already
3288 checked to be supported by Emacs), and styles supported by the
3289 input method XIM. */
3291 static XIMStyle
3292 best_xim_style (user, xim)
3293 XIMStyles *user;
3294 XIMStyles *xim;
3296 int i, j;
3298 for (i = 0; i < user->count_styles; ++i)
3299 for (j = 0; j < xim->count_styles; ++j)
3300 if (user->supported_styles[i] == xim->supported_styles[j])
3301 return user->supported_styles[i];
3303 /* Return the default style. */
3304 return XIMPreeditNothing | XIMStatusNothing;
3307 /* Create XIC for frame F. */
3309 void
3310 create_frame_xic (f)
3311 struct frame *f;
3313 XIM xim;
3314 XIC xic = NULL;
3315 XFontSet xfs = NULL;
3316 static XIMStyle xic_style;
3318 if (FRAME_XIC (f))
3319 return;
3321 xim = FRAME_X_XIM (f);
3322 if (xim)
3324 XRectangle s_area;
3325 XPoint spot;
3326 XVaNestedList preedit_attr;
3327 XVaNestedList status_attr;
3328 char *base_fontname;
3329 int fontset;
3331 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
3332 spot.x = 0; spot.y = 1;
3333 /* Create X fontset. */
3334 fontset = FRAME_FONTSET (f);
3335 if (fontset < 0)
3336 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3337 else
3339 /* Determine the base fontname from the ASCII font name of
3340 FONTSET. */
3341 char *ascii_font = (char *) XSTRING (fontset_ascii (fontset))->data;
3342 char *p = ascii_font;
3343 int i;
3345 for (i = 0; *p; p++)
3346 if (*p == '-') i++;
3347 if (i != 14)
3348 /* As the font name doesn't conform to XLFD, we can't
3349 modify it to get a suitable base fontname for the
3350 frame. */
3351 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3352 else
3354 int len = strlen (ascii_font) + 1;
3355 char *p1 = NULL;
3357 for (i = 0, p = ascii_font; i < 8; p++)
3359 if (*p == '-')
3361 i++;
3362 if (i == 3)
3363 p1 = p + 1;
3366 base_fontname = (char *) alloca (len);
3367 bzero (base_fontname, len);
3368 strcpy (base_fontname, "-*-*-");
3369 bcopy (p1, base_fontname + 5, p - p1);
3370 strcat (base_fontname, "*-*-*-*-*-*-*");
3373 xfs = xic_create_xfontset (f, base_fontname);
3375 /* Determine XIC style. */
3376 if (xic_style == 0)
3378 XIMStyles supported_list;
3379 supported_list.count_styles = (sizeof supported_xim_styles
3380 / sizeof supported_xim_styles[0]);
3381 supported_list.supported_styles = supported_xim_styles;
3382 xic_style = best_xim_style (&supported_list,
3383 FRAME_X_XIM_STYLES (f));
3386 preedit_attr = XVaCreateNestedList (0,
3387 XNFontSet, xfs,
3388 XNForeground,
3389 FRAME_FOREGROUND_PIXEL (f),
3390 XNBackground,
3391 FRAME_BACKGROUND_PIXEL (f),
3392 (xic_style & XIMPreeditPosition
3393 ? XNSpotLocation
3394 : NULL),
3395 &spot,
3396 NULL);
3397 status_attr = XVaCreateNestedList (0,
3398 XNArea,
3399 &s_area,
3400 XNFontSet,
3401 xfs,
3402 XNForeground,
3403 FRAME_FOREGROUND_PIXEL (f),
3404 XNBackground,
3405 FRAME_BACKGROUND_PIXEL (f),
3406 NULL);
3408 xic = XCreateIC (xim,
3409 XNInputStyle, xic_style,
3410 XNClientWindow, FRAME_X_WINDOW(f),
3411 XNFocusWindow, FRAME_X_WINDOW(f),
3412 XNStatusAttributes, status_attr,
3413 XNPreeditAttributes, preedit_attr,
3414 NULL);
3415 XFree (preedit_attr);
3416 XFree (status_attr);
3419 FRAME_XIC (f) = xic;
3420 FRAME_XIC_STYLE (f) = xic_style;
3421 FRAME_XIC_FONTSET (f) = xfs;
3425 /* Destroy XIC and free XIC fontset of frame F, if any. */
3427 void
3428 free_frame_xic (f)
3429 struct frame *f;
3431 if (FRAME_XIC (f) == NULL)
3432 return;
3434 XDestroyIC (FRAME_XIC (f));
3435 if (FRAME_XIC_FONTSET (f))
3436 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3438 FRAME_XIC (f) = NULL;
3439 FRAME_XIC_FONTSET (f) = NULL;
3443 /* Place preedit area for XIC of window W's frame to specified
3444 pixel position X/Y. X and Y are relative to window W. */
3446 void
3447 xic_set_preeditarea (w, x, y)
3448 struct window *w;
3449 int x, y;
3451 struct frame *f = XFRAME (w->frame);
3452 XVaNestedList attr;
3453 XPoint spot;
3455 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x);
3456 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
3457 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
3458 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3459 XFree (attr);
3463 /* Place status area for XIC in bottom right corner of frame F.. */
3465 void
3466 xic_set_statusarea (f)
3467 struct frame *f;
3469 XIC xic = FRAME_XIC (f);
3470 XVaNestedList attr;
3471 XRectangle area;
3472 XRectangle *needed;
3474 /* Negotiate geometry of status area. If input method has existing
3475 status area, use its current size. */
3476 area.x = area.y = area.width = area.height = 0;
3477 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
3478 XSetICValues (xic, XNStatusAttributes, attr, NULL);
3479 XFree (attr);
3481 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
3482 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3483 XFree (attr);
3485 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
3487 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
3488 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3489 XFree (attr);
3492 area.width = needed->width;
3493 area.height = needed->height;
3494 area.x = PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
3495 area.y = (PIXEL_HEIGHT (f) - area.height
3496 - FRAME_MENUBAR_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f));
3497 XFree (needed);
3499 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
3500 XSetICValues(xic, XNStatusAttributes, attr, NULL);
3501 XFree (attr);
3505 /* Set X fontset for XIC of frame F, using base font name
3506 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
3508 void
3509 xic_set_xfontset (f, base_fontname)
3510 struct frame *f;
3511 char *base_fontname;
3513 XVaNestedList attr;
3514 XFontSet xfs;
3516 xfs = xic_create_xfontset (f, base_fontname);
3518 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
3519 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
3520 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3521 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
3522 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
3523 XFree (attr);
3525 if (FRAME_XIC_FONTSET (f))
3526 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3527 FRAME_XIC_FONTSET (f) = xfs;
3530 #endif /* HAVE_X_I18N */
3534 #ifdef USE_X_TOOLKIT
3536 /* Create and set up the X widget for frame F. */
3538 static void
3539 x_window (f, window_prompting, minibuffer_only)
3540 struct frame *f;
3541 long window_prompting;
3542 int minibuffer_only;
3544 XClassHint class_hints;
3545 XSetWindowAttributes attributes;
3546 unsigned long attribute_mask;
3547 Widget shell_widget;
3548 Widget pane_widget;
3549 Widget frame_widget;
3550 Arg al [25];
3551 int ac;
3553 BLOCK_INPUT;
3555 /* Use the resource name as the top-level widget name
3556 for looking up resources. Make a non-Lisp copy
3557 for the window manager, so GC relocation won't bother it.
3559 Elsewhere we specify the window name for the window manager. */
3562 char *str = (char *) XSTRING (Vx_resource_name)->data;
3563 f->namebuf = (char *) xmalloc (strlen (str) + 1);
3564 strcpy (f->namebuf, str);
3567 ac = 0;
3568 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
3569 XtSetArg (al[ac], XtNinput, 1); ac++;
3570 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3571 XtSetArg (al[ac], XtNborderWidth, f->output_data.x->border_width); ac++;
3572 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3573 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3574 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3575 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
3576 applicationShellWidgetClass,
3577 FRAME_X_DISPLAY (f), al, ac);
3579 f->output_data.x->widget = shell_widget;
3580 /* maybe_set_screen_title_format (shell_widget); */
3582 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
3583 (widget_value *) NULL,
3584 shell_widget, False,
3585 (lw_callback) NULL,
3586 (lw_callback) NULL,
3587 (lw_callback) NULL,
3588 (lw_callback) NULL);
3590 ac = 0;
3591 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3592 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3593 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3594 XtSetValues (pane_widget, al, ac);
3595 f->output_data.x->column_widget = pane_widget;
3597 /* mappedWhenManaged to false tells to the paned window to not map/unmap
3598 the emacs screen when changing menubar. This reduces flickering. */
3600 ac = 0;
3601 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3602 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
3603 XtSetArg (al[ac], XtNallowResize, 1); ac++;
3604 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
3605 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
3606 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3607 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3608 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3609 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
3610 al, ac);
3612 f->output_data.x->edit_widget = frame_widget;
3614 XtManageChild (frame_widget);
3616 /* Do some needed geometry management. */
3618 int len;
3619 char *tem, shell_position[32];
3620 Arg al[2];
3621 int ac = 0;
3622 int extra_borders = 0;
3623 int menubar_size
3624 = (f->output_data.x->menubar_widget
3625 ? (f->output_data.x->menubar_widget->core.height
3626 + f->output_data.x->menubar_widget->core.border_width)
3627 : 0);
3629 #if 0 /* Experimentally, we now get the right results
3630 for -geometry -0-0 without this. 24 Aug 96, rms. */
3631 if (FRAME_EXTERNAL_MENU_BAR (f))
3633 Dimension ibw = 0;
3634 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
3635 menubar_size += ibw;
3637 #endif
3639 f->output_data.x->menubar_height = menubar_size;
3641 #ifndef USE_LUCID
3642 /* Motif seems to need this amount added to the sizes
3643 specified for the shell widget. The Athena/Lucid widgets don't.
3644 Both conclusions reached experimentally. -- rms. */
3645 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
3646 &extra_borders, NULL);
3647 extra_borders *= 2;
3648 #endif
3650 /* Convert our geometry parameters into a geometry string
3651 and specify it.
3652 Note that we do not specify here whether the position
3653 is a user-specified or program-specified one.
3654 We pass that information later, in x_wm_set_size_hints. */
3656 int left = f->output_data.x->left_pos;
3657 int xneg = window_prompting & XNegative;
3658 int top = f->output_data.x->top_pos;
3659 int yneg = window_prompting & YNegative;
3660 if (xneg)
3661 left = -left;
3662 if (yneg)
3663 top = -top;
3665 if (window_prompting & USPosition)
3666 sprintf (shell_position, "=%dx%d%c%d%c%d",
3667 PIXEL_WIDTH (f) + extra_borders,
3668 PIXEL_HEIGHT (f) + menubar_size + extra_borders,
3669 (xneg ? '-' : '+'), left,
3670 (yneg ? '-' : '+'), top);
3671 else
3672 sprintf (shell_position, "=%dx%d",
3673 PIXEL_WIDTH (f) + extra_borders,
3674 PIXEL_HEIGHT (f) + menubar_size + extra_borders);
3677 len = strlen (shell_position) + 1;
3678 /* We don't free this because we don't know whether
3679 it is safe to free it while the frame exists.
3680 It isn't worth the trouble of arranging to free it
3681 when the frame is deleted. */
3682 tem = (char *) xmalloc (len);
3683 strncpy (tem, shell_position, len);
3684 XtSetArg (al[ac], XtNgeometry, tem); ac++;
3685 XtSetValues (shell_widget, al, ac);
3688 XtManageChild (pane_widget);
3689 XtRealizeWidget (shell_widget);
3691 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
3693 validate_x_resource_name ();
3695 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3696 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3697 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
3699 #ifdef HAVE_X_I18N
3700 FRAME_XIC (f) = NULL;
3701 #ifdef USE_XIM
3702 create_frame_xic (f);
3703 #endif
3704 #endif
3706 f->output_data.x->wm_hints.input = True;
3707 f->output_data.x->wm_hints.flags |= InputHint;
3708 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3709 &f->output_data.x->wm_hints);
3711 hack_wm_protocols (f, shell_widget);
3713 #ifdef HACK_EDITRES
3714 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
3715 #endif
3717 /* Do a stupid property change to force the server to generate a
3718 PropertyNotify event so that the event_stream server timestamp will
3719 be initialized to something relevant to the time we created the window.
3721 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
3722 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3723 XA_ATOM, 32, PropModeAppend,
3724 (unsigned char*) NULL, 0);
3726 /* Make all the standard events reach the Emacs frame. */
3727 attributes.event_mask = STANDARD_EVENT_SET;
3729 #ifdef HAVE_X_I18N
3730 if (FRAME_XIC (f))
3732 /* XIM server might require some X events. */
3733 unsigned long fevent = NoEventMask;
3734 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3735 attributes.event_mask |= fevent;
3737 #endif /* HAVE_X_I18N */
3739 attribute_mask = CWEventMask;
3740 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
3741 attribute_mask, &attributes);
3743 XtMapWidget (frame_widget);
3745 /* x_set_name normally ignores requests to set the name if the
3746 requested name is the same as the current name. This is the one
3747 place where that assumption isn't correct; f->name is set, but
3748 the X server hasn't been told. */
3750 Lisp_Object name;
3751 int explicit = f->explicit_name;
3753 f->explicit_name = 0;
3754 name = f->name;
3755 f->name = Qnil;
3756 x_set_name (f, name, explicit);
3759 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3760 f->output_data.x->text_cursor);
3762 UNBLOCK_INPUT;
3764 /* This is a no-op, except under Motif. Make sure main areas are
3765 set to something reasonable, in case we get an error later. */
3766 lw_set_main_areas (pane_widget, 0, frame_widget);
3769 #else /* not USE_X_TOOLKIT */
3771 /* Create and set up the X window for frame F. */
3773 void
3774 x_window (f)
3775 struct frame *f;
3778 XClassHint class_hints;
3779 XSetWindowAttributes attributes;
3780 unsigned long attribute_mask;
3782 attributes.background_pixel = f->output_data.x->background_pixel;
3783 attributes.border_pixel = f->output_data.x->border_pixel;
3784 attributes.bit_gravity = StaticGravity;
3785 attributes.backing_store = NotUseful;
3786 attributes.save_under = True;
3787 attributes.event_mask = STANDARD_EVENT_SET;
3788 attributes.colormap = FRAME_X_COLORMAP (f);
3789 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
3790 | CWColormap);
3792 BLOCK_INPUT;
3793 FRAME_X_WINDOW (f)
3794 = XCreateWindow (FRAME_X_DISPLAY (f),
3795 f->output_data.x->parent_desc,
3796 f->output_data.x->left_pos,
3797 f->output_data.x->top_pos,
3798 PIXEL_WIDTH (f), PIXEL_HEIGHT (f),
3799 f->output_data.x->border_width,
3800 CopyFromParent, /* depth */
3801 InputOutput, /* class */
3802 FRAME_X_VISUAL (f),
3803 attribute_mask, &attributes);
3805 #ifdef HAVE_X_I18N
3806 #ifdef USE_XIM
3807 create_frame_xic (f);
3808 if (FRAME_XIC (f))
3810 /* XIM server might require some X events. */
3811 unsigned long fevent = NoEventMask;
3812 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3813 attributes.event_mask |= fevent;
3814 attribute_mask = CWEventMask;
3815 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3816 attribute_mask, &attributes);
3818 #endif
3819 #endif /* HAVE_X_I18N */
3821 validate_x_resource_name ();
3823 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3824 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3825 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
3827 /* The menubar is part of the ordinary display;
3828 it does not count in addition to the height of the window. */
3829 f->output_data.x->menubar_height = 0;
3831 /* This indicates that we use the "Passive Input" input model.
3832 Unless we do this, we don't get the Focus{In,Out} events that we
3833 need to draw the cursor correctly. Accursed bureaucrats.
3834 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
3836 f->output_data.x->wm_hints.input = True;
3837 f->output_data.x->wm_hints.flags |= InputHint;
3838 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3839 &f->output_data.x->wm_hints);
3840 f->output_data.x->wm_hints.icon_pixmap = None;
3842 /* Request "save yourself" and "delete window" commands from wm. */
3844 Atom protocols[2];
3845 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3846 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3847 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
3850 /* x_set_name normally ignores requests to set the name if the
3851 requested name is the same as the current name. This is the one
3852 place where that assumption isn't correct; f->name is set, but
3853 the X server hasn't been told. */
3855 Lisp_Object name;
3856 int explicit = f->explicit_name;
3858 f->explicit_name = 0;
3859 name = f->name;
3860 f->name = Qnil;
3861 x_set_name (f, name, explicit);
3864 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3865 f->output_data.x->text_cursor);
3867 UNBLOCK_INPUT;
3869 if (FRAME_X_WINDOW (f) == 0)
3870 error ("Unable to create window");
3873 #endif /* not USE_X_TOOLKIT */
3875 /* Handle the icon stuff for this window. Perhaps later we might
3876 want an x_set_icon_position which can be called interactively as
3877 well. */
3879 static void
3880 x_icon (f, parms)
3881 struct frame *f;
3882 Lisp_Object parms;
3884 Lisp_Object icon_x, icon_y;
3885 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3887 /* Set the position of the icon. Note that twm groups all
3888 icons in an icon window. */
3889 icon_x = x_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
3890 icon_y = x_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
3891 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
3893 CHECK_NUMBER (icon_x, 0);
3894 CHECK_NUMBER (icon_y, 0);
3896 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
3897 error ("Both left and top icon corners of icon must be specified");
3899 BLOCK_INPUT;
3901 if (! EQ (icon_x, Qunbound))
3902 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
3904 /* Start up iconic or window? */
3905 x_wm_set_window_state
3906 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
3907 Qicon)
3908 ? IconicState
3909 : NormalState));
3911 x_text_icon (f, (char *) XSTRING ((!NILP (f->icon_name)
3912 ? f->icon_name
3913 : f->name))->data);
3915 UNBLOCK_INPUT;
3918 /* Make the GCs needed for this window, setting the
3919 background, border and mouse colors; also create the
3920 mouse cursor and the gray border tile. */
3922 static char cursor_bits[] =
3924 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3925 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3926 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3927 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
3930 static void
3931 x_make_gc (f)
3932 struct frame *f;
3934 XGCValues gc_values;
3936 BLOCK_INPUT;
3938 /* Create the GCs of this frame.
3939 Note that many default values are used. */
3941 /* Normal video */
3942 gc_values.font = f->output_data.x->font->fid;
3943 gc_values.foreground = f->output_data.x->foreground_pixel;
3944 gc_values.background = f->output_data.x->background_pixel;
3945 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
3946 f->output_data.x->normal_gc
3947 = XCreateGC (FRAME_X_DISPLAY (f),
3948 FRAME_X_WINDOW (f),
3949 GCLineWidth | GCFont | GCForeground | GCBackground,
3950 &gc_values);
3952 /* Reverse video style. */
3953 gc_values.foreground = f->output_data.x->background_pixel;
3954 gc_values.background = f->output_data.x->foreground_pixel;
3955 f->output_data.x->reverse_gc
3956 = XCreateGC (FRAME_X_DISPLAY (f),
3957 FRAME_X_WINDOW (f),
3958 GCFont | GCForeground | GCBackground | GCLineWidth,
3959 &gc_values);
3961 /* Cursor has cursor-color background, background-color foreground. */
3962 gc_values.foreground = f->output_data.x->background_pixel;
3963 gc_values.background = f->output_data.x->cursor_pixel;
3964 gc_values.fill_style = FillOpaqueStippled;
3965 gc_values.stipple
3966 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
3967 FRAME_X_DISPLAY_INFO (f)->root_window,
3968 cursor_bits, 16, 16);
3969 f->output_data.x->cursor_gc
3970 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3971 (GCFont | GCForeground | GCBackground
3972 | GCFillStyle /* | GCStipple */ | GCLineWidth),
3973 &gc_values);
3975 /* Reliefs. */
3976 f->output_data.x->white_relief.gc = 0;
3977 f->output_data.x->black_relief.gc = 0;
3979 /* Create the gray border tile used when the pointer is not in
3980 the frame. Since this depends on the frame's pixel values,
3981 this must be done on a per-frame basis. */
3982 f->output_data.x->border_tile
3983 = (XCreatePixmapFromBitmapData
3984 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
3985 gray_bits, gray_width, gray_height,
3986 f->output_data.x->foreground_pixel,
3987 f->output_data.x->background_pixel,
3988 DefaultDepth (FRAME_X_DISPLAY (f),
3989 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))));
3991 UNBLOCK_INPUT;
3995 /* Free what was was allocated in x_make_gc. */
3997 void
3998 x_free_gcs (f)
3999 struct frame *f;
4001 Display *dpy = FRAME_X_DISPLAY (f);
4003 BLOCK_INPUT;
4005 if (f->output_data.x->normal_gc)
4007 XFreeGC (dpy, f->output_data.x->normal_gc);
4008 f->output_data.x->normal_gc = 0;
4011 if (f->output_data.x->reverse_gc)
4013 XFreeGC (dpy, f->output_data.x->reverse_gc);
4014 f->output_data.x->reverse_gc = 0;
4017 if (f->output_data.x->cursor_gc)
4019 XFreeGC (dpy, f->output_data.x->cursor_gc);
4020 f->output_data.x->cursor_gc = 0;
4023 if (f->output_data.x->border_tile)
4025 XFreePixmap (dpy, f->output_data.x->border_tile);
4026 f->output_data.x->border_tile = 0;
4029 UNBLOCK_INPUT;
4033 /* Handler for signals raised during x_create_frame and
4034 x_create_top_frame. FRAME is the frame which is partially
4035 constructed. */
4037 static Lisp_Object
4038 unwind_create_frame (frame)
4039 Lisp_Object frame;
4041 struct frame *f = XFRAME (frame);
4043 /* If frame is ``official'', nothing to do. */
4044 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
4046 #if GLYPH_DEBUG
4047 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4048 #endif
4050 x_free_frame_resources (f);
4052 /* Check that reference counts are indeed correct. */
4053 xassert (dpyinfo->reference_count == dpyinfo_refcount);
4054 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
4055 return Qt;
4058 return Qnil;
4062 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4063 1, 1, 0,
4064 "Make a new X window, which is called a \"frame\" in Emacs terms.\n\
4065 Returns an Emacs frame object.\n\
4066 ALIST is an alist of frame parameters.\n\
4067 If the parameters specify that the frame should not have a minibuffer,\n\
4068 and do not specify a specific minibuffer window to use,\n\
4069 then `default-minibuffer-frame' must be a frame whose minibuffer can\n\
4070 be shared by the new frame.\n\
4072 This function is an internal primitive--use `make-frame' instead.")
4073 (parms)
4074 Lisp_Object parms;
4076 struct frame *f;
4077 Lisp_Object frame, tem;
4078 Lisp_Object name;
4079 int minibuffer_only = 0;
4080 long window_prompting = 0;
4081 int width, height;
4082 int count = BINDING_STACK_SIZE ();
4083 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4084 Lisp_Object display;
4085 struct x_display_info *dpyinfo = NULL;
4086 Lisp_Object parent;
4087 struct kboard *kb;
4089 check_x ();
4091 /* Use this general default value to start with
4092 until we know if this frame has a specified name. */
4093 Vx_resource_name = Vinvocation_name;
4095 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
4096 if (EQ (display, Qunbound))
4097 display = Qnil;
4098 dpyinfo = check_x_display_info (display);
4099 #ifdef MULTI_KBOARD
4100 kb = dpyinfo->kboard;
4101 #else
4102 kb = &the_only_kboard;
4103 #endif
4105 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4106 if (!STRINGP (name)
4107 && ! EQ (name, Qunbound)
4108 && ! NILP (name))
4109 error ("Invalid frame name--not a string or nil");
4111 if (STRINGP (name))
4112 Vx_resource_name = name;
4114 /* See if parent window is specified. */
4115 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4116 if (EQ (parent, Qunbound))
4117 parent = Qnil;
4118 if (! NILP (parent))
4119 CHECK_NUMBER (parent, 0);
4121 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4122 /* No need to protect DISPLAY because that's not used after passing
4123 it to make_frame_without_minibuffer. */
4124 frame = Qnil;
4125 GCPRO4 (parms, parent, name, frame);
4126 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
4127 RES_TYPE_SYMBOL);
4128 if (EQ (tem, Qnone) || NILP (tem))
4129 f = make_frame_without_minibuffer (Qnil, kb, display);
4130 else if (EQ (tem, Qonly))
4132 f = make_minibuffer_frame ();
4133 minibuffer_only = 1;
4135 else if (WINDOWP (tem))
4136 f = make_frame_without_minibuffer (tem, kb, display);
4137 else
4138 f = make_frame (1);
4140 XSETFRAME (frame, f);
4142 /* Note that X Windows does support scroll bars. */
4143 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
4145 f->output_method = output_x_window;
4146 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4147 bzero (f->output_data.x, sizeof (struct x_output));
4148 f->output_data.x->icon_bitmap = -1;
4149 f->output_data.x->fontset = -1;
4150 f->output_data.x->scroll_bar_foreground_pixel = -1;
4151 f->output_data.x->scroll_bar_background_pixel = -1;
4152 record_unwind_protect (unwind_create_frame, frame);
4154 f->icon_name
4155 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
4156 RES_TYPE_STRING);
4157 if (! STRINGP (f->icon_name))
4158 f->icon_name = Qnil;
4160 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4161 #if GLYPH_DEBUG
4162 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4163 dpyinfo_refcount = dpyinfo->reference_count;
4164 #endif /* GLYPH_DEBUG */
4165 #ifdef MULTI_KBOARD
4166 FRAME_KBOARD (f) = kb;
4167 #endif
4169 /* These colors will be set anyway later, but it's important
4170 to get the color reference counts right, so initialize them! */
4172 Lisp_Object black;
4173 struct gcpro gcpro1;
4175 black = build_string ("black");
4176 GCPRO1 (black);
4177 f->output_data.x->foreground_pixel
4178 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4179 f->output_data.x->background_pixel
4180 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4181 f->output_data.x->cursor_pixel
4182 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4183 f->output_data.x->cursor_foreground_pixel
4184 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4185 f->output_data.x->border_pixel
4186 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4187 f->output_data.x->mouse_pixel
4188 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4189 UNGCPRO;
4192 /* Specify the parent under which to make this X window. */
4194 if (!NILP (parent))
4196 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
4197 f->output_data.x->explicit_parent = 1;
4199 else
4201 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4202 f->output_data.x->explicit_parent = 0;
4205 /* Set the name; the functions to which we pass f expect the name to
4206 be set. */
4207 if (EQ (name, Qunbound) || NILP (name))
4209 f->name = build_string (dpyinfo->x_id_name);
4210 f->explicit_name = 0;
4212 else
4214 f->name = name;
4215 f->explicit_name = 1;
4216 /* use the frame's title when getting resources for this frame. */
4217 specbind (Qx_resource_name, name);
4220 /* Extract the window parameters from the supplied values
4221 that are needed to determine window geometry. */
4223 Lisp_Object font;
4225 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4227 BLOCK_INPUT;
4228 /* First, try whatever font the caller has specified. */
4229 if (STRINGP (font))
4231 tem = Fquery_fontset (font, Qnil);
4232 if (STRINGP (tem))
4233 font = x_new_fontset (f, XSTRING (tem)->data);
4234 else
4235 font = x_new_font (f, XSTRING (font)->data);
4238 /* Try out a font which we hope has bold and italic variations. */
4239 if (!STRINGP (font))
4240 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4241 if (!STRINGP (font))
4242 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4243 if (! STRINGP (font))
4244 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4245 if (! STRINGP (font))
4246 /* This was formerly the first thing tried, but it finds too many fonts
4247 and takes too long. */
4248 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4249 /* If those didn't work, look for something which will at least work. */
4250 if (! STRINGP (font))
4251 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4252 UNBLOCK_INPUT;
4253 if (! STRINGP (font))
4254 font = build_string ("fixed");
4256 x_default_parameter (f, parms, Qfont, font,
4257 "font", "Font", RES_TYPE_STRING);
4260 #ifdef USE_LUCID
4261 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
4262 whereby it fails to get any font. */
4263 xlwmenu_default_font = f->output_data.x->font;
4264 #endif
4266 x_default_parameter (f, parms, Qborder_width, make_number (2),
4267 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4269 /* This defaults to 2 in order to match xterm. We recognize either
4270 internalBorderWidth or internalBorder (which is what xterm calls
4271 it). */
4272 if (NILP (Fassq (Qinternal_border_width, parms)))
4274 Lisp_Object value;
4276 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4277 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4278 if (! EQ (value, Qunbound))
4279 parms = Fcons (Fcons (Qinternal_border_width, value),
4280 parms);
4282 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4283 "internalBorderWidth", "internalBorderWidth",
4284 RES_TYPE_NUMBER);
4285 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
4286 "verticalScrollBars", "ScrollBars",
4287 RES_TYPE_SYMBOL);
4289 /* Also do the stuff which must be set before the window exists. */
4290 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4291 "foreground", "Foreground", RES_TYPE_STRING);
4292 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4293 "background", "Background", RES_TYPE_STRING);
4294 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4295 "pointerColor", "Foreground", RES_TYPE_STRING);
4296 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4297 "cursorColor", "Foreground", RES_TYPE_STRING);
4298 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4299 "borderColor", "BorderColor", RES_TYPE_STRING);
4300 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
4301 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4302 x_default_parameter (f, parms, Qline_spacing, Qnil,
4303 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4305 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
4306 "scrollBarForeground",
4307 "ScrollBarForeground", 1);
4308 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
4309 "scrollBarBackground",
4310 "ScrollBarBackground", 0);
4312 /* Init faces before x_default_parameter is called for scroll-bar
4313 parameters because that function calls x_set_scroll_bar_width,
4314 which calls change_frame_size, which calls Fset_window_buffer,
4315 which runs hooks, which call Fvertical_motion. At the end, we
4316 end up in init_iterator with a null face cache, which should not
4317 happen. */
4318 init_frame_faces (f);
4320 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
4321 "menuBar", "MenuBar", RES_TYPE_NUMBER);
4322 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
4323 "toolBar", "ToolBar", RES_TYPE_NUMBER);
4324 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
4325 "bufferPredicate", "BufferPredicate",
4326 RES_TYPE_SYMBOL);
4327 x_default_parameter (f, parms, Qtitle, Qnil,
4328 "title", "Title", RES_TYPE_STRING);
4330 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4331 window_prompting = x_figure_window_size (f, parms);
4333 if (window_prompting & XNegative)
4335 if (window_prompting & YNegative)
4336 f->output_data.x->win_gravity = SouthEastGravity;
4337 else
4338 f->output_data.x->win_gravity = NorthEastGravity;
4340 else
4342 if (window_prompting & YNegative)
4343 f->output_data.x->win_gravity = SouthWestGravity;
4344 else
4345 f->output_data.x->win_gravity = NorthWestGravity;
4348 f->output_data.x->size_hint_flags = window_prompting;
4350 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4351 f->no_split = minibuffer_only || EQ (tem, Qt);
4353 /* Create the X widget or window. Add the tool-bar height to the
4354 initial frame height so that the user gets a text display area of
4355 the size he specified with -g or via .Xdefaults. Later changes
4356 of the tool-bar height don't change the frame size. This is done
4357 so that users can create tall Emacs frames without having to
4358 guess how tall the tool-bar will get. */
4359 f->height += FRAME_TOOL_BAR_LINES (f);
4361 #ifdef USE_X_TOOLKIT
4362 x_window (f, window_prompting, minibuffer_only);
4363 #else
4364 x_window (f);
4365 #endif
4367 x_icon (f, parms);
4368 x_make_gc (f);
4370 /* Now consider the frame official. */
4371 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4372 Vframe_list = Fcons (frame, Vframe_list);
4374 /* We need to do this after creating the X window, so that the
4375 icon-creation functions can say whose icon they're describing. */
4376 x_default_parameter (f, parms, Qicon_type, Qnil,
4377 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4379 x_default_parameter (f, parms, Qauto_raise, Qnil,
4380 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4381 x_default_parameter (f, parms, Qauto_lower, Qnil,
4382 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4383 x_default_parameter (f, parms, Qcursor_type, Qbox,
4384 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4385 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
4386 "scrollBarWidth", "ScrollBarWidth",
4387 RES_TYPE_NUMBER);
4389 /* Dimensions, especially f->height, must be done via change_frame_size.
4390 Change will not be effected unless different from the current
4391 f->height. */
4392 width = f->width;
4393 height = f->height;
4394 f->height = 0;
4395 SET_FRAME_WIDTH (f, 0);
4396 change_frame_size (f, height, width, 1, 0, 0);
4398 /* Set up faces after all frame parameters are known. This call
4399 also merges in face attributes specified for new frames. If we
4400 don't do this, the `menu' face for instance won't have the right
4401 colors, and the menu bar won't appear in the specified colors for
4402 new frames. */
4403 call1 (Qface_set_after_frame_default, frame);
4405 #ifdef USE_X_TOOLKIT
4406 /* Create the menu bar. */
4407 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4409 /* If this signals an error, we haven't set size hints for the
4410 frame and we didn't make it visible. */
4411 initialize_frame_menubar (f);
4413 /* This is a no-op, except under Motif where it arranges the
4414 main window for the widgets on it. */
4415 lw_set_main_areas (f->output_data.x->column_widget,
4416 f->output_data.x->menubar_widget,
4417 f->output_data.x->edit_widget);
4419 #endif /* USE_X_TOOLKIT */
4421 /* Tell the server what size and position, etc, we want, and how
4422 badly we want them. This should be done after we have the menu
4423 bar so that its size can be taken into account. */
4424 BLOCK_INPUT;
4425 x_wm_set_size_hint (f, window_prompting, 0);
4426 UNBLOCK_INPUT;
4428 /* Make the window appear on the frame and enable display, unless
4429 the caller says not to. However, with explicit parent, Emacs
4430 cannot control visibility, so don't try. */
4431 if (! f->output_data.x->explicit_parent)
4433 Lisp_Object visibility;
4435 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
4436 RES_TYPE_SYMBOL);
4437 if (EQ (visibility, Qunbound))
4438 visibility = Qt;
4440 if (EQ (visibility, Qicon))
4441 x_iconify_frame (f);
4442 else if (! NILP (visibility))
4443 x_make_frame_visible (f);
4444 else
4445 /* Must have been Qnil. */
4449 UNGCPRO;
4450 return unbind_to (count, frame);
4454 /* FRAME is used only to get a handle on the X display. We don't pass the
4455 display info directly because we're called from frame.c, which doesn't
4456 know about that structure. */
4458 Lisp_Object
4459 x_get_focus_frame (frame)
4460 struct frame *frame;
4462 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
4463 Lisp_Object xfocus;
4464 if (! dpyinfo->x_focus_frame)
4465 return Qnil;
4467 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
4468 return xfocus;
4472 /* In certain situations, when the window manager follows a
4473 click-to-focus policy, there seems to be no way around calling
4474 XSetInputFocus to give another frame the input focus .
4476 In an ideal world, XSetInputFocus should generally be avoided so
4477 that applications don't interfere with the window manager's focus
4478 policy. But I think it's okay to use when it's clearly done
4479 following a user-command. */
4481 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4482 "Set the input focus to FRAME.\n\
4483 FRAME nil means use the selected frame.")
4484 (frame)
4485 Lisp_Object frame;
4487 struct frame *f = check_x_frame (frame);
4488 Display *dpy = FRAME_X_DISPLAY (f);
4489 int count;
4491 BLOCK_INPUT;
4492 count = x_catch_errors (dpy);
4493 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4494 RevertToParent, CurrentTime);
4495 x_uncatch_errors (dpy, count);
4496 UNBLOCK_INPUT;
4498 return Qnil;
4502 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4503 "Internal function called by `color-defined-p', which see.")
4504 (color, frame)
4505 Lisp_Object color, frame;
4507 XColor foo;
4508 FRAME_PTR f = check_x_frame (frame);
4510 CHECK_STRING (color, 1);
4512 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4513 return Qt;
4514 else
4515 return Qnil;
4518 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4519 "Internal function called by `color-values', which see.")
4520 (color, frame)
4521 Lisp_Object color, frame;
4523 XColor foo;
4524 FRAME_PTR f = check_x_frame (frame);
4526 CHECK_STRING (color, 1);
4528 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4530 Lisp_Object rgb[3];
4532 rgb[0] = make_number (foo.red);
4533 rgb[1] = make_number (foo.green);
4534 rgb[2] = make_number (foo.blue);
4535 return Flist (3, rgb);
4537 else
4538 return Qnil;
4541 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4542 "Internal function called by `display-color-p', which see.")
4543 (display)
4544 Lisp_Object display;
4546 struct x_display_info *dpyinfo = check_x_display_info (display);
4548 if (dpyinfo->n_planes <= 2)
4549 return Qnil;
4551 switch (dpyinfo->visual->class)
4553 case StaticColor:
4554 case PseudoColor:
4555 case TrueColor:
4556 case DirectColor:
4557 return Qt;
4559 default:
4560 return Qnil;
4564 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
4565 0, 1, 0,
4566 "Return t if the X display supports shades of gray.\n\
4567 Note that color displays do support shades of gray.\n\
4568 The optional argument DISPLAY specifies which display to ask about.\n\
4569 DISPLAY should be either a frame or a display name (a string).\n\
4570 If omitted or nil, that stands for the selected frame's display.")
4571 (display)
4572 Lisp_Object display;
4574 struct x_display_info *dpyinfo = check_x_display_info (display);
4576 if (dpyinfo->n_planes <= 1)
4577 return Qnil;
4579 switch (dpyinfo->visual->class)
4581 case StaticColor:
4582 case PseudoColor:
4583 case TrueColor:
4584 case DirectColor:
4585 case StaticGray:
4586 case GrayScale:
4587 return Qt;
4589 default:
4590 return Qnil;
4594 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
4595 0, 1, 0,
4596 "Returns the width in pixels of the X display DISPLAY.\n\
4597 The optional argument DISPLAY specifies which display to ask about.\n\
4598 DISPLAY should be either a frame or a display name (a string).\n\
4599 If omitted or nil, that stands for the selected frame's display.")
4600 (display)
4601 Lisp_Object display;
4603 struct x_display_info *dpyinfo = check_x_display_info (display);
4605 return make_number (dpyinfo->width);
4608 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4609 Sx_display_pixel_height, 0, 1, 0,
4610 "Returns the height in pixels of the X display DISPLAY.\n\
4611 The optional argument DISPLAY specifies which display to ask about.\n\
4612 DISPLAY should be either a frame or a display name (a string).\n\
4613 If omitted or nil, that stands for the selected frame's display.")
4614 (display)
4615 Lisp_Object display;
4617 struct x_display_info *dpyinfo = check_x_display_info (display);
4619 return make_number (dpyinfo->height);
4622 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4623 0, 1, 0,
4624 "Returns the number of bitplanes of the X display DISPLAY.\n\
4625 The optional argument DISPLAY specifies which display to ask about.\n\
4626 DISPLAY should be either a frame or a display name (a string).\n\
4627 If omitted or nil, that stands for the selected frame's display.")
4628 (display)
4629 Lisp_Object display;
4631 struct x_display_info *dpyinfo = check_x_display_info (display);
4633 return make_number (dpyinfo->n_planes);
4636 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4637 0, 1, 0,
4638 "Returns the number of color cells of the X display DISPLAY.\n\
4639 The optional argument DISPLAY specifies which display to ask about.\n\
4640 DISPLAY should be either a frame or a display name (a string).\n\
4641 If omitted or nil, that stands for the selected frame's display.")
4642 (display)
4643 Lisp_Object display;
4645 struct x_display_info *dpyinfo = check_x_display_info (display);
4647 return make_number (DisplayCells (dpyinfo->display,
4648 XScreenNumberOfScreen (dpyinfo->screen)));
4651 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4652 Sx_server_max_request_size,
4653 0, 1, 0,
4654 "Returns the maximum request size of the X server of display DISPLAY.\n\
4655 The optional argument DISPLAY specifies which display to ask about.\n\
4656 DISPLAY should be either a frame or a display name (a string).\n\
4657 If omitted or nil, that stands for the selected frame's display.")
4658 (display)
4659 Lisp_Object display;
4661 struct x_display_info *dpyinfo = check_x_display_info (display);
4663 return make_number (MAXREQUEST (dpyinfo->display));
4666 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4667 "Returns the vendor ID string of the X server of display DISPLAY.\n\
4668 The optional argument DISPLAY specifies which display to ask about.\n\
4669 DISPLAY should be either a frame or a display name (a string).\n\
4670 If omitted or nil, that stands for the selected frame's display.")
4671 (display)
4672 Lisp_Object display;
4674 struct x_display_info *dpyinfo = check_x_display_info (display);
4675 char *vendor = ServerVendor (dpyinfo->display);
4677 if (! vendor) vendor = "";
4678 return build_string (vendor);
4681 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4682 "Returns the version numbers of the X server of display DISPLAY.\n\
4683 The value is a list of three integers: the major and minor\n\
4684 version numbers of the X Protocol in use, and the vendor-specific release\n\
4685 number. See also the function `x-server-vendor'.\n\n\
4686 The optional argument DISPLAY specifies which display to ask about.\n\
4687 DISPLAY should be either a frame or a display name (a string).\n\
4688 If omitted or nil, that stands for the selected frame's display.")
4689 (display)
4690 Lisp_Object display;
4692 struct x_display_info *dpyinfo = check_x_display_info (display);
4693 Display *dpy = dpyinfo->display;
4695 return Fcons (make_number (ProtocolVersion (dpy)),
4696 Fcons (make_number (ProtocolRevision (dpy)),
4697 Fcons (make_number (VendorRelease (dpy)), Qnil)));
4700 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4701 "Returns the number of screens on the X server of display DISPLAY.\n\
4702 The optional argument DISPLAY specifies which display to ask about.\n\
4703 DISPLAY should be either a frame or a display name (a string).\n\
4704 If omitted or nil, that stands for the selected frame's display.")
4705 (display)
4706 Lisp_Object display;
4708 struct x_display_info *dpyinfo = check_x_display_info (display);
4710 return make_number (ScreenCount (dpyinfo->display));
4713 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
4714 "Returns the height in millimeters of the X display DISPLAY.\n\
4715 The optional argument DISPLAY specifies which display to ask about.\n\
4716 DISPLAY should be either a frame or a display name (a string).\n\
4717 If omitted or nil, that stands for the selected frame's display.")
4718 (display)
4719 Lisp_Object display;
4721 struct x_display_info *dpyinfo = check_x_display_info (display);
4723 return make_number (HeightMMOfScreen (dpyinfo->screen));
4726 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4727 "Returns the width in millimeters of the X display DISPLAY.\n\
4728 The optional argument DISPLAY specifies which display to ask about.\n\
4729 DISPLAY should be either a frame or a display name (a string).\n\
4730 If omitted or nil, that stands for the selected frame's display.")
4731 (display)
4732 Lisp_Object display;
4734 struct x_display_info *dpyinfo = check_x_display_info (display);
4736 return make_number (WidthMMOfScreen (dpyinfo->screen));
4739 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4740 Sx_display_backing_store, 0, 1, 0,
4741 "Returns an indication of whether X display DISPLAY does backing store.\n\
4742 The value may be `always', `when-mapped', or `not-useful'.\n\
4743 The optional argument DISPLAY specifies which display to ask about.\n\
4744 DISPLAY should be either a frame or a display name (a string).\n\
4745 If omitted or nil, that stands for the selected frame's display.")
4746 (display)
4747 Lisp_Object display;
4749 struct x_display_info *dpyinfo = check_x_display_info (display);
4750 Lisp_Object result;
4752 switch (DoesBackingStore (dpyinfo->screen))
4754 case Always:
4755 result = intern ("always");
4756 break;
4758 case WhenMapped:
4759 result = intern ("when-mapped");
4760 break;
4762 case NotUseful:
4763 result = intern ("not-useful");
4764 break;
4766 default:
4767 error ("Strange value for BackingStore parameter of screen");
4768 result = Qnil;
4771 return result;
4774 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4775 Sx_display_visual_class, 0, 1, 0,
4776 "Returns the visual class of the X display DISPLAY.\n\
4777 The value is one of the symbols `static-gray', `gray-scale',\n\
4778 `static-color', `pseudo-color', `true-color', or `direct-color'.\n\n\
4779 The optional argument DISPLAY specifies which display to ask about.\n\
4780 DISPLAY should be either a frame or a display name (a string).\n\
4781 If omitted or nil, that stands for the selected frame's display.")
4782 (display)
4783 Lisp_Object display;
4785 struct x_display_info *dpyinfo = check_x_display_info (display);
4786 Lisp_Object result;
4788 switch (dpyinfo->visual->class)
4790 case StaticGray:
4791 result = intern ("static-gray");
4792 break;
4793 case GrayScale:
4794 result = intern ("gray-scale");
4795 break;
4796 case StaticColor:
4797 result = intern ("static-color");
4798 break;
4799 case PseudoColor:
4800 result = intern ("pseudo-color");
4801 break;
4802 case TrueColor:
4803 result = intern ("true-color");
4804 break;
4805 case DirectColor:
4806 result = intern ("direct-color");
4807 break;
4808 default:
4809 error ("Display has an unknown visual class");
4810 result = Qnil;
4813 return result;
4816 DEFUN ("x-display-save-under", Fx_display_save_under,
4817 Sx_display_save_under, 0, 1, 0,
4818 "Returns t if the X display DISPLAY supports the save-under feature.\n\
4819 The optional argument DISPLAY specifies which display to ask about.\n\
4820 DISPLAY should be either a frame or a display name (a string).\n\
4821 If omitted or nil, that stands for the selected frame's display.")
4822 (display)
4823 Lisp_Object display;
4825 struct x_display_info *dpyinfo = check_x_display_info (display);
4827 if (DoesSaveUnders (dpyinfo->screen) == True)
4828 return Qt;
4829 else
4830 return Qnil;
4834 x_pixel_width (f)
4835 register struct frame *f;
4837 return PIXEL_WIDTH (f);
4841 x_pixel_height (f)
4842 register struct frame *f;
4844 return PIXEL_HEIGHT (f);
4848 x_char_width (f)
4849 register struct frame *f;
4851 return FONT_WIDTH (f->output_data.x->font);
4855 x_char_height (f)
4856 register struct frame *f;
4858 return f->output_data.x->line_height;
4862 x_screen_planes (f)
4863 register struct frame *f;
4865 return FRAME_X_DISPLAY_INFO (f)->n_planes;
4870 /************************************************************************
4871 X Displays
4872 ************************************************************************/
4875 /* Mapping visual names to visuals. */
4877 static struct visual_class
4879 char *name;
4880 int class;
4882 visual_classes[] =
4884 {"StaticGray", StaticGray},
4885 {"GrayScale", GrayScale},
4886 {"StaticColor", StaticColor},
4887 {"PseudoColor", PseudoColor},
4888 {"TrueColor", TrueColor},
4889 {"DirectColor", DirectColor},
4890 NULL
4894 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4896 /* Value is the screen number of screen SCR. This is a substitute for
4897 the X function with the same name when that doesn't exist. */
4900 XScreenNumberOfScreen (scr)
4901 register Screen *scr;
4903 Display *dpy = scr->display;
4904 int i;
4906 for (i = 0; i < dpy->nscreens; ++i)
4907 if (scr == dpy->screens[i])
4908 break;
4910 return i;
4913 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4916 /* Select the visual that should be used on display DPYINFO. Set
4917 members of DPYINFO appropriately. Called from x_term_init. */
4919 void
4920 select_visual (dpyinfo)
4921 struct x_display_info *dpyinfo;
4923 Display *dpy = dpyinfo->display;
4924 Screen *screen = dpyinfo->screen;
4925 Lisp_Object value;
4927 /* See if a visual is specified. */
4928 value = display_x_get_resource (dpyinfo,
4929 build_string ("visualClass"),
4930 build_string ("VisualClass"),
4931 Qnil, Qnil);
4932 if (STRINGP (value))
4934 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4935 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4936 depth, a decimal number. NAME is compared with case ignored. */
4937 char *s = (char *) alloca (STRING_BYTES (XSTRING (value)) + 1);
4938 char *dash;
4939 int i, class = -1;
4940 XVisualInfo vinfo;
4942 strcpy (s, XSTRING (value)->data);
4943 dash = index (s, '-');
4944 if (dash)
4946 dpyinfo->n_planes = atoi (dash + 1);
4947 *dash = '\0';
4949 else
4950 /* We won't find a matching visual with depth 0, so that
4951 an error will be printed below. */
4952 dpyinfo->n_planes = 0;
4954 /* Determine the visual class. */
4955 for (i = 0; visual_classes[i].name; ++i)
4956 if (xstricmp (s, visual_classes[i].name) == 0)
4958 class = visual_classes[i].class;
4959 break;
4962 /* Look up a matching visual for the specified class. */
4963 if (class == -1
4964 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4965 dpyinfo->n_planes, class, &vinfo))
4966 fatal ("Invalid visual specification `%s'", XSTRING (value)->data);
4968 dpyinfo->visual = vinfo.visual;
4970 else
4972 int n_visuals;
4973 XVisualInfo *vinfo, vinfo_template;
4975 dpyinfo->visual = DefaultVisualOfScreen (screen);
4977 #ifdef HAVE_X11R4
4978 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4979 #else
4980 vinfo_template.visualid = dpyinfo->visual->visualid;
4981 #endif
4982 vinfo_template.screen = XScreenNumberOfScreen (screen);
4983 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4984 &vinfo_template, &n_visuals);
4985 if (n_visuals != 1)
4986 fatal ("Can't get proper X visual info");
4988 dpyinfo->n_planes = vinfo->depth;
4989 XFree ((char *) vinfo);
4994 /* Return the X display structure for the display named NAME.
4995 Open a new connection if necessary. */
4997 struct x_display_info *
4998 x_display_info_for_name (name)
4999 Lisp_Object name;
5001 Lisp_Object names;
5002 struct x_display_info *dpyinfo;
5004 CHECK_STRING (name, 0);
5006 if (! EQ (Vwindow_system, intern ("x")))
5007 error ("Not using X Windows");
5009 for (dpyinfo = x_display_list, names = x_display_name_list;
5010 dpyinfo;
5011 dpyinfo = dpyinfo->next, names = XCDR (names))
5013 Lisp_Object tem;
5014 tem = Fstring_equal (XCAR (XCAR (names)), name);
5015 if (!NILP (tem))
5016 return dpyinfo;
5019 /* Use this general default value to start with. */
5020 Vx_resource_name = Vinvocation_name;
5022 validate_x_resource_name ();
5024 dpyinfo = x_term_init (name, (char *)0,
5025 (char *) XSTRING (Vx_resource_name)->data);
5027 if (dpyinfo == 0)
5028 error ("Cannot connect to X server %s", XSTRING (name)->data);
5030 x_in_use = 1;
5031 XSETFASTINT (Vwindow_system_version, 11);
5033 return dpyinfo;
5037 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5038 1, 3, 0, "Open a connection to an X server.\n\
5039 DISPLAY is the name of the display to connect to.\n\
5040 Optional second arg XRM-STRING is a string of resources in xrdb format.\n\
5041 If the optional third arg MUST-SUCCEED is non-nil,\n\
5042 terminate Emacs if we can't open the connection.")
5043 (display, xrm_string, must_succeed)
5044 Lisp_Object display, xrm_string, must_succeed;
5046 unsigned char *xrm_option;
5047 struct x_display_info *dpyinfo;
5049 CHECK_STRING (display, 0);
5050 if (! NILP (xrm_string))
5051 CHECK_STRING (xrm_string, 1);
5053 if (! EQ (Vwindow_system, intern ("x")))
5054 error ("Not using X Windows");
5056 if (! NILP (xrm_string))
5057 xrm_option = (unsigned char *) XSTRING (xrm_string)->data;
5058 else
5059 xrm_option = (unsigned char *) 0;
5061 validate_x_resource_name ();
5063 /* This is what opens the connection and sets x_current_display.
5064 This also initializes many symbols, such as those used for input. */
5065 dpyinfo = x_term_init (display, xrm_option,
5066 (char *) XSTRING (Vx_resource_name)->data);
5068 if (dpyinfo == 0)
5070 if (!NILP (must_succeed))
5071 fatal ("Cannot connect to X server %s.\n\
5072 Check the DISPLAY environment variable or use `-d'.\n\
5073 Also use the `xhost' program to verify that it is set to permit\n\
5074 connections from your machine.\n",
5075 XSTRING (display)->data);
5076 else
5077 error ("Cannot connect to X server %s", XSTRING (display)->data);
5080 x_in_use = 1;
5082 XSETFASTINT (Vwindow_system_version, 11);
5083 return Qnil;
5086 DEFUN ("x-close-connection", Fx_close_connection,
5087 Sx_close_connection, 1, 1, 0,
5088 "Close the connection to DISPLAY's X server.\n\
5089 For DISPLAY, specify either a frame or a display name (a string).\n\
5090 If DISPLAY is nil, that stands for the selected frame's display.")
5091 (display)
5092 Lisp_Object display;
5094 struct x_display_info *dpyinfo = check_x_display_info (display);
5095 int i;
5097 if (dpyinfo->reference_count > 0)
5098 error ("Display still has frames on it");
5100 BLOCK_INPUT;
5101 /* Free the fonts in the font table. */
5102 for (i = 0; i < dpyinfo->n_fonts; i++)
5103 if (dpyinfo->font_table[i].name)
5105 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
5106 xfree (dpyinfo->font_table[i].full_name);
5107 xfree (dpyinfo->font_table[i].name);
5108 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
5111 x_destroy_all_bitmaps (dpyinfo);
5112 XSetCloseDownMode (dpyinfo->display, DestroyAll);
5114 #ifdef USE_X_TOOLKIT
5115 XtCloseDisplay (dpyinfo->display);
5116 #else
5117 XCloseDisplay (dpyinfo->display);
5118 #endif
5120 x_delete_display (dpyinfo);
5121 UNBLOCK_INPUT;
5123 return Qnil;
5126 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5127 "Return the list of display names that Emacs has connections to.")
5130 Lisp_Object tail, result;
5132 result = Qnil;
5133 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
5134 result = Fcons (XCAR (XCAR (tail)), result);
5136 return result;
5139 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5140 "If ON is non-nil, report X errors as soon as the erring request is made.\n\
5141 If ON is nil, allow buffering of requests.\n\
5142 Turning on synchronization prohibits the Xlib routines from buffering\n\
5143 requests and seriously degrades performance, but makes debugging much\n\
5144 easier.\n\
5145 The optional second argument DISPLAY specifies which display to act on.\n\
5146 DISPLAY should be either a frame or a display name (a string).\n\
5147 If DISPLAY is omitted or nil, that stands for the selected frame's display.")
5148 (on, display)
5149 Lisp_Object display, on;
5151 struct x_display_info *dpyinfo = check_x_display_info (display);
5153 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
5155 return Qnil;
5158 /* Wait for responses to all X commands issued so far for frame F. */
5160 void
5161 x_sync (f)
5162 FRAME_PTR f;
5164 BLOCK_INPUT;
5165 XSync (FRAME_X_DISPLAY (f), False);
5166 UNBLOCK_INPUT;
5170 /***********************************************************************
5171 Image types
5172 ***********************************************************************/
5174 /* Value is the number of elements of vector VECTOR. */
5176 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
5178 /* List of supported image types. Use define_image_type to add new
5179 types. Use lookup_image_type to find a type for a given symbol. */
5181 static struct image_type *image_types;
5183 /* The symbol `image' which is the car of the lists used to represent
5184 images in Lisp. */
5186 extern Lisp_Object Qimage;
5188 /* The symbol `xbm' which is used as the type symbol for XBM images. */
5190 Lisp_Object Qxbm;
5192 /* Keywords. */
5194 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
5195 extern Lisp_Object QCdata;
5196 Lisp_Object QCtype, QCascent, QCmargin, QCrelief;
5197 Lisp_Object QCalgorithm, QCcolor_symbols, QCheuristic_mask;
5198 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
5200 /* Other symbols. */
5202 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
5204 /* Time in seconds after which images should be removed from the cache
5205 if not displayed. */
5207 Lisp_Object Vimage_cache_eviction_delay;
5209 /* Function prototypes. */
5211 static void define_image_type P_ ((struct image_type *type));
5212 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
5213 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
5214 static void x_laplace P_ ((struct frame *, struct image *));
5215 static void x_emboss P_ ((struct frame *, struct image *));
5216 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
5217 Lisp_Object));
5220 /* Define a new image type from TYPE. This adds a copy of TYPE to
5221 image_types and adds the symbol *TYPE->type to Vimage_types. */
5223 static void
5224 define_image_type (type)
5225 struct image_type *type;
5227 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
5228 The initialized data segment is read-only. */
5229 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
5230 bcopy (type, p, sizeof *p);
5231 p->next = image_types;
5232 image_types = p;
5233 Vimage_types = Fcons (*p->type, Vimage_types);
5237 /* Look up image type SYMBOL, and return a pointer to its image_type
5238 structure. Value is null if SYMBOL is not a known image type. */
5240 static INLINE struct image_type *
5241 lookup_image_type (symbol)
5242 Lisp_Object symbol;
5244 struct image_type *type;
5246 for (type = image_types; type; type = type->next)
5247 if (EQ (symbol, *type->type))
5248 break;
5250 return type;
5254 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
5255 valid image specification is a list whose car is the symbol
5256 `image', and whose rest is a property list. The property list must
5257 contain a value for key `:type'. That value must be the name of a
5258 supported image type. The rest of the property list depends on the
5259 image type. */
5262 valid_image_p (object)
5263 Lisp_Object object;
5265 int valid_p = 0;
5267 if (CONSP (object) && EQ (XCAR (object), Qimage))
5269 Lisp_Object symbol = Fplist_get (XCDR (object), QCtype);
5270 struct image_type *type = lookup_image_type (symbol);
5272 if (type)
5273 valid_p = type->valid_p (object);
5276 return valid_p;
5280 /* Log error message with format string FORMAT and argument ARG.
5281 Signaling an error, e.g. when an image cannot be loaded, is not a
5282 good idea because this would interrupt redisplay, and the error
5283 message display would lead to another redisplay. This function
5284 therefore simply displays a message. */
5286 static void
5287 image_error (format, arg1, arg2)
5288 char *format;
5289 Lisp_Object arg1, arg2;
5291 add_to_log (format, arg1, arg2);
5296 /***********************************************************************
5297 Image specifications
5298 ***********************************************************************/
5300 enum image_value_type
5302 IMAGE_DONT_CHECK_VALUE_TYPE,
5303 IMAGE_STRING_VALUE,
5304 IMAGE_SYMBOL_VALUE,
5305 IMAGE_POSITIVE_INTEGER_VALUE,
5306 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
5307 IMAGE_ASCENT_VALUE,
5308 IMAGE_INTEGER_VALUE,
5309 IMAGE_FUNCTION_VALUE,
5310 IMAGE_NUMBER_VALUE,
5311 IMAGE_BOOL_VALUE
5314 /* Structure used when parsing image specifications. */
5316 struct image_keyword
5318 /* Name of keyword. */
5319 char *name;
5321 /* The type of value allowed. */
5322 enum image_value_type type;
5324 /* Non-zero means key must be present. */
5325 int mandatory_p;
5327 /* Used to recognize duplicate keywords in a property list. */
5328 int count;
5330 /* The value that was found. */
5331 Lisp_Object value;
5335 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
5336 int, Lisp_Object));
5337 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
5340 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
5341 has the format (image KEYWORD VALUE ...). One of the keyword/
5342 value pairs must be `:type TYPE'. KEYWORDS is a vector of
5343 image_keywords structures of size NKEYWORDS describing other
5344 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
5346 static int
5347 parse_image_spec (spec, keywords, nkeywords, type)
5348 Lisp_Object spec;
5349 struct image_keyword *keywords;
5350 int nkeywords;
5351 Lisp_Object type;
5353 int i;
5354 Lisp_Object plist;
5356 if (!CONSP (spec) || !EQ (XCAR (spec), Qimage))
5357 return 0;
5359 plist = XCDR (spec);
5360 while (CONSP (plist))
5362 Lisp_Object key, value;
5364 /* First element of a pair must be a symbol. */
5365 key = XCAR (plist);
5366 plist = XCDR (plist);
5367 if (!SYMBOLP (key))
5368 return 0;
5370 /* There must follow a value. */
5371 if (!CONSP (plist))
5372 return 0;
5373 value = XCAR (plist);
5374 plist = XCDR (plist);
5376 /* Find key in KEYWORDS. Error if not found. */
5377 for (i = 0; i < nkeywords; ++i)
5378 if (strcmp (keywords[i].name, XSYMBOL (key)->name->data) == 0)
5379 break;
5381 if (i == nkeywords)
5382 continue;
5384 /* Record that we recognized the keyword. If a keywords
5385 was found more than once, it's an error. */
5386 keywords[i].value = value;
5387 ++keywords[i].count;
5389 if (keywords[i].count > 1)
5390 return 0;
5392 /* Check type of value against allowed type. */
5393 switch (keywords[i].type)
5395 case IMAGE_STRING_VALUE:
5396 if (!STRINGP (value))
5397 return 0;
5398 break;
5400 case IMAGE_SYMBOL_VALUE:
5401 if (!SYMBOLP (value))
5402 return 0;
5403 break;
5405 case IMAGE_POSITIVE_INTEGER_VALUE:
5406 if (!INTEGERP (value) || XINT (value) <= 0)
5407 return 0;
5408 break;
5410 case IMAGE_ASCENT_VALUE:
5411 if (SYMBOLP (value) && EQ (value, Qcenter))
5412 break;
5413 else if (INTEGERP (value)
5414 && XINT (value) >= 0
5415 && XINT (value) <= 100)
5416 break;
5417 return 0;
5419 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
5420 if (!INTEGERP (value) || XINT (value) < 0)
5421 return 0;
5422 break;
5424 case IMAGE_DONT_CHECK_VALUE_TYPE:
5425 break;
5427 case IMAGE_FUNCTION_VALUE:
5428 value = indirect_function (value);
5429 if (SUBRP (value)
5430 || COMPILEDP (value)
5431 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
5432 break;
5433 return 0;
5435 case IMAGE_NUMBER_VALUE:
5436 if (!INTEGERP (value) && !FLOATP (value))
5437 return 0;
5438 break;
5440 case IMAGE_INTEGER_VALUE:
5441 if (!INTEGERP (value))
5442 return 0;
5443 break;
5445 case IMAGE_BOOL_VALUE:
5446 if (!NILP (value) && !EQ (value, Qt))
5447 return 0;
5448 break;
5450 default:
5451 abort ();
5452 break;
5455 if (EQ (key, QCtype) && !EQ (type, value))
5456 return 0;
5459 /* Check that all mandatory fields are present. */
5460 for (i = 0; i < nkeywords; ++i)
5461 if (keywords[i].mandatory_p && keywords[i].count == 0)
5462 return 0;
5464 return NILP (plist);
5468 /* Return the value of KEY in image specification SPEC. Value is nil
5469 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
5470 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
5472 static Lisp_Object
5473 image_spec_value (spec, key, found)
5474 Lisp_Object spec, key;
5475 int *found;
5477 Lisp_Object tail;
5479 xassert (valid_image_p (spec));
5481 for (tail = XCDR (spec);
5482 CONSP (tail) && CONSP (XCDR (tail));
5483 tail = XCDR (XCDR (tail)))
5485 if (EQ (XCAR (tail), key))
5487 if (found)
5488 *found = 1;
5489 return XCAR (XCDR (tail));
5493 if (found)
5494 *found = 0;
5495 return Qnil;
5499 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
5500 "Return the size of image SPEC as pair (WIDTH . HEIGHT).\n\
5501 PIXELS non-nil means return the size in pixels, otherwise return the\n\
5502 size in canonical character units.\n\
5503 FRAME is the frame on which the image will be displayed. FRAME nil\n\
5504 or omitted means use the selected frame.")
5505 (spec, pixels, frame)
5506 Lisp_Object spec, pixels, frame;
5508 Lisp_Object size;
5510 size = Qnil;
5511 if (valid_image_p (spec))
5513 struct frame *f = check_x_frame (frame);
5514 int id = lookup_image (f, spec);
5515 struct image *img = IMAGE_FROM_ID (f, id);
5516 int width = img->width + 2 * img->margin;
5517 int height = img->height + 2 * img->margin;
5519 if (NILP (pixels))
5520 size = Fcons (make_float ((double) width / CANON_X_UNIT (f)),
5521 make_float ((double) height / CANON_Y_UNIT (f)));
5522 else
5523 size = Fcons (make_number (width), make_number (height));
5525 else
5526 error ("Invalid image specification");
5528 return size;
5532 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
5533 "Return t if image SPEC has a mask bitmap.\n\
5534 FRAME is the frame on which the image will be displayed. FRAME nil\n\
5535 or omitted means use the selected frame.")
5536 (spec, frame)
5537 Lisp_Object spec, frame;
5539 Lisp_Object mask;
5541 mask = Qnil;
5542 if (valid_image_p (spec))
5544 struct frame *f = check_x_frame (frame);
5545 int id = lookup_image (f, spec);
5546 struct image *img = IMAGE_FROM_ID (f, id);
5547 if (img->mask)
5548 mask = Qt;
5550 else
5551 error ("Invalid image specification");
5553 return mask;
5558 /***********************************************************************
5559 Image type independent image structures
5560 ***********************************************************************/
5562 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
5563 static void free_image P_ ((struct frame *f, struct image *img));
5566 /* Allocate and return a new image structure for image specification
5567 SPEC. SPEC has a hash value of HASH. */
5569 static struct image *
5570 make_image (spec, hash)
5571 Lisp_Object spec;
5572 unsigned hash;
5574 struct image *img = (struct image *) xmalloc (sizeof *img);
5576 xassert (valid_image_p (spec));
5577 bzero (img, sizeof *img);
5578 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
5579 xassert (img->type != NULL);
5580 img->spec = spec;
5581 img->data.lisp_val = Qnil;
5582 img->ascent = DEFAULT_IMAGE_ASCENT;
5583 img->hash = hash;
5584 return img;
5588 /* Free image IMG which was used on frame F, including its resources. */
5590 static void
5591 free_image (f, img)
5592 struct frame *f;
5593 struct image *img;
5595 if (img)
5597 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5599 /* Remove IMG from the hash table of its cache. */
5600 if (img->prev)
5601 img->prev->next = img->next;
5602 else
5603 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
5605 if (img->next)
5606 img->next->prev = img->prev;
5608 c->images[img->id] = NULL;
5610 /* Free resources, then free IMG. */
5611 img->type->free (f, img);
5612 xfree (img);
5617 /* Prepare image IMG for display on frame F. Must be called before
5618 drawing an image. */
5620 void
5621 prepare_image_for_display (f, img)
5622 struct frame *f;
5623 struct image *img;
5625 EMACS_TIME t;
5627 /* We're about to display IMG, so set its timestamp to `now'. */
5628 EMACS_GET_TIME (t);
5629 img->timestamp = EMACS_SECS (t);
5631 /* If IMG doesn't have a pixmap yet, load it now, using the image
5632 type dependent loader function. */
5633 if (img->pixmap == None && !img->load_failed_p)
5634 img->load_failed_p = img->type->load (f, img) == 0;
5638 /* Value is the number of pixels for the ascent of image IMG when
5639 drawn in face FACE. */
5642 image_ascent (img, face)
5643 struct image *img;
5644 struct face *face;
5646 int height = img->height + img->margin;
5647 int ascent;
5649 if (img->ascent == CENTERED_IMAGE_ASCENT)
5651 if (face->font)
5652 /* This expression is arranged so that if the image can't be
5653 exactly centered, it will be moved slightly up. This is
5654 because a typical font is `top-heavy' (due to the presence
5655 uppercase letters), so the image placement should err towards
5656 being top-heavy too. It also just generally looks better. */
5657 ascent = (height + face->font->ascent - face->font->descent + 1) / 2;
5658 else
5659 ascent = height / 2;
5661 else
5662 ascent = height * img->ascent / 100.0;
5664 return ascent;
5669 /***********************************************************************
5670 Helper functions for X image types
5671 ***********************************************************************/
5673 static void x_clear_image_1 P_ ((struct frame *, struct image *, int,
5674 int, int));
5675 static void x_clear_image P_ ((struct frame *f, struct image *img));
5676 static unsigned long x_alloc_image_color P_ ((struct frame *f,
5677 struct image *img,
5678 Lisp_Object color_name,
5679 unsigned long dflt));
5682 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
5683 free the pixmap if any. MASK_P non-zero means clear the mask
5684 pixmap if any. COLORS_P non-zero means free colors allocated for
5685 the image, if any. */
5687 static void
5688 x_clear_image_1 (f, img, pixmap_p, mask_p, colors_p)
5689 struct frame *f;
5690 struct image *img;
5691 int pixmap_p, mask_p, colors_p;
5693 if (pixmap_p && img->pixmap)
5695 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
5696 img->pixmap = None;
5699 if (mask_p && img->mask)
5701 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
5702 img->mask = None;
5705 if (colors_p && img->ncolors)
5707 x_free_colors (f, img->colors, img->ncolors);
5708 xfree (img->colors);
5709 img->colors = NULL;
5710 img->ncolors = 0;
5714 /* Free X resources of image IMG which is used on frame F. */
5716 static void
5717 x_clear_image (f, img)
5718 struct frame *f;
5719 struct image *img;
5721 BLOCK_INPUT;
5722 x_clear_image_1 (f, img, 1, 1, 1);
5723 UNBLOCK_INPUT;
5727 /* Allocate color COLOR_NAME for image IMG on frame F. If color
5728 cannot be allocated, use DFLT. Add a newly allocated color to
5729 IMG->colors, so that it can be freed again. Value is the pixel
5730 color. */
5732 static unsigned long
5733 x_alloc_image_color (f, img, color_name, dflt)
5734 struct frame *f;
5735 struct image *img;
5736 Lisp_Object color_name;
5737 unsigned long dflt;
5739 XColor color;
5740 unsigned long result;
5742 xassert (STRINGP (color_name));
5744 if (x_defined_color (f, XSTRING (color_name)->data, &color, 1))
5746 /* This isn't called frequently so we get away with simply
5747 reallocating the color vector to the needed size, here. */
5748 ++img->ncolors;
5749 img->colors =
5750 (unsigned long *) xrealloc (img->colors,
5751 img->ncolors * sizeof *img->colors);
5752 img->colors[img->ncolors - 1] = color.pixel;
5753 result = color.pixel;
5755 else
5756 result = dflt;
5758 return result;
5763 /***********************************************************************
5764 Image Cache
5765 ***********************************************************************/
5767 static void cache_image P_ ((struct frame *f, struct image *img));
5770 /* Return a new, initialized image cache that is allocated from the
5771 heap. Call free_image_cache to free an image cache. */
5773 struct image_cache *
5774 make_image_cache ()
5776 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
5777 int size;
5779 bzero (c, sizeof *c);
5780 c->size = 50;
5781 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
5782 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5783 c->buckets = (struct image **) xmalloc (size);
5784 bzero (c->buckets, size);
5785 return c;
5789 /* Free image cache of frame F. Be aware that X frames share images
5790 caches. */
5792 void
5793 free_image_cache (f)
5794 struct frame *f;
5796 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5797 if (c)
5799 int i;
5801 /* Cache should not be referenced by any frame when freed. */
5802 xassert (c->refcount == 0);
5804 for (i = 0; i < c->used; ++i)
5805 free_image (f, c->images[i]);
5806 xfree (c->images);
5807 xfree (c->buckets);
5808 xfree (c);
5809 FRAME_X_IMAGE_CACHE (f) = NULL;
5814 /* Clear image cache of frame F. FORCE_P non-zero means free all
5815 images. FORCE_P zero means clear only images that haven't been
5816 displayed for some time. Should be called from time to time to
5817 reduce the number of loaded images. If image-eviction-seconds is
5818 non-nil, this frees images in the cache which weren't displayed for
5819 at least that many seconds. */
5821 void
5822 clear_image_cache (f, force_p)
5823 struct frame *f;
5824 int force_p;
5826 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5828 if (c && INTEGERP (Vimage_cache_eviction_delay))
5830 EMACS_TIME t;
5831 unsigned long old;
5832 int i, nfreed;
5834 EMACS_GET_TIME (t);
5835 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
5837 /* Block input so that we won't be interrupted by a SIGIO
5838 while being in an inconsistent state. */
5839 BLOCK_INPUT;
5841 for (i = nfreed = 0; i < c->used; ++i)
5843 struct image *img = c->images[i];
5844 if (img != NULL
5845 && (force_p || img->timestamp < old))
5847 free_image (f, img);
5848 ++nfreed;
5852 /* We may be clearing the image cache because, for example,
5853 Emacs was iconified for a longer period of time. In that
5854 case, current matrices may still contain references to
5855 images freed above. So, clear these matrices. */
5856 if (nfreed)
5858 Lisp_Object tail, frame;
5860 FOR_EACH_FRAME (tail, frame)
5862 struct frame *f = XFRAME (frame);
5863 if (FRAME_X_P (f)
5864 && FRAME_X_IMAGE_CACHE (f) == c)
5865 clear_current_matrices (f);
5868 ++windows_or_buffers_changed;
5871 UNBLOCK_INPUT;
5876 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
5877 0, 1, 0,
5878 "Clear the image cache of FRAME.\n\
5879 FRAME nil or omitted means use the selected frame.\n\
5880 FRAME t means clear the image caches of all frames.")
5881 (frame)
5882 Lisp_Object frame;
5884 if (EQ (frame, Qt))
5886 Lisp_Object tail;
5888 FOR_EACH_FRAME (tail, frame)
5889 if (FRAME_X_P (XFRAME (frame)))
5890 clear_image_cache (XFRAME (frame), 1);
5892 else
5893 clear_image_cache (check_x_frame (frame), 1);
5895 return Qnil;
5899 /* Return the id of image with Lisp specification SPEC on frame F.
5900 SPEC must be a valid Lisp image specification (see valid_image_p). */
5903 lookup_image (f, spec)
5904 struct frame *f;
5905 Lisp_Object spec;
5907 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5908 struct image *img;
5909 int i;
5910 unsigned hash;
5911 struct gcpro gcpro1;
5912 EMACS_TIME now;
5914 /* F must be a window-system frame, and SPEC must be a valid image
5915 specification. */
5916 xassert (FRAME_WINDOW_P (f));
5917 xassert (valid_image_p (spec));
5919 GCPRO1 (spec);
5921 /* Look up SPEC in the hash table of the image cache. */
5922 hash = sxhash (spec, 0);
5923 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
5925 for (img = c->buckets[i]; img; img = img->next)
5926 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
5927 break;
5929 /* If not found, create a new image and cache it. */
5930 if (img == NULL)
5932 BLOCK_INPUT;
5933 img = make_image (spec, hash);
5934 cache_image (f, img);
5935 img->load_failed_p = img->type->load (f, img) == 0;
5937 /* If we can't load the image, and we don't have a width and
5938 height, use some arbitrary width and height so that we can
5939 draw a rectangle for it. */
5940 if (img->load_failed_p)
5942 Lisp_Object value;
5944 value = image_spec_value (spec, QCwidth, NULL);
5945 img->width = (INTEGERP (value)
5946 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
5947 value = image_spec_value (spec, QCheight, NULL);
5948 img->height = (INTEGERP (value)
5949 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
5951 else
5953 /* Handle image type independent image attributes
5954 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF'. */
5955 Lisp_Object ascent, margin, relief;
5957 ascent = image_spec_value (spec, QCascent, NULL);
5958 if (INTEGERP (ascent))
5959 img->ascent = XFASTINT (ascent);
5960 else if (EQ (ascent, Qcenter))
5961 img->ascent = CENTERED_IMAGE_ASCENT;
5963 margin = image_spec_value (spec, QCmargin, NULL);
5964 if (INTEGERP (margin) && XINT (margin) >= 0)
5965 img->margin = XFASTINT (margin);
5967 relief = image_spec_value (spec, QCrelief, NULL);
5968 if (INTEGERP (relief))
5970 img->relief = XINT (relief);
5971 img->margin += abs (img->relief);
5974 /* Manipulation of the image's mask. */
5975 if (img->pixmap)
5977 /* `:heuristic-mask t'
5978 `:mask heuristic'
5979 means build a mask heuristically.
5980 `:heuristic-mask (R G B)'
5981 `:mask (heuristic (R G B))'
5982 means build a mask from color (R G B) in the
5983 image.
5984 `:mask nil'
5985 means remove a mask, if any. */
5987 Lisp_Object mask;
5989 mask = image_spec_value (spec, QCheuristic_mask, NULL);
5990 if (!NILP (mask))
5991 x_build_heuristic_mask (f, img, mask);
5992 else
5994 int found_p;
5996 mask = image_spec_value (spec, QCmask, &found_p);
5998 if (EQ (mask, Qheuristic))
5999 x_build_heuristic_mask (f, img, Qt);
6000 else if (CONSP (mask)
6001 && EQ (XCAR (mask), Qheuristic))
6003 if (CONSP (XCDR (mask)))
6004 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
6005 else
6006 x_build_heuristic_mask (f, img, XCDR (mask));
6008 else if (NILP (mask) && found_p && img->mask)
6010 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
6011 img->mask = None;
6016 /* Should we apply an image transformation algorithm? */
6017 if (img->pixmap)
6019 Lisp_Object algorithm;
6021 algorithm = image_spec_value (spec, QCalgorithm, NULL);
6022 if (EQ (algorithm, Qdisabled))
6023 x_disable_image (f, img);
6024 else if (EQ (algorithm, Qlaplace))
6025 x_laplace (f, img);
6026 else if (EQ (algorithm, Qemboss))
6027 x_emboss (f, img);
6028 else if (CONSP (algorithm)
6029 && EQ (XCAR (algorithm), Qedge_detection))
6031 Lisp_Object tem;
6032 tem = XCDR (algorithm);
6033 if (CONSP (tem))
6034 x_edge_detection (f, img,
6035 Fplist_get (tem, QCmatrix),
6036 Fplist_get (tem, QCcolor_adjustment));
6041 UNBLOCK_INPUT;
6042 xassert (!interrupt_input_blocked);
6045 /* We're using IMG, so set its timestamp to `now'. */
6046 EMACS_GET_TIME (now);
6047 img->timestamp = EMACS_SECS (now);
6049 UNGCPRO;
6051 /* Value is the image id. */
6052 return img->id;
6056 /* Cache image IMG in the image cache of frame F. */
6058 static void
6059 cache_image (f, img)
6060 struct frame *f;
6061 struct image *img;
6063 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6064 int i;
6066 /* Find a free slot in c->images. */
6067 for (i = 0; i < c->used; ++i)
6068 if (c->images[i] == NULL)
6069 break;
6071 /* If no free slot found, maybe enlarge c->images. */
6072 if (i == c->used && c->used == c->size)
6074 c->size *= 2;
6075 c->images = (struct image **) xrealloc (c->images,
6076 c->size * sizeof *c->images);
6079 /* Add IMG to c->images, and assign IMG an id. */
6080 c->images[i] = img;
6081 img->id = i;
6082 if (i == c->used)
6083 ++c->used;
6085 /* Add IMG to the cache's hash table. */
6086 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
6087 img->next = c->buckets[i];
6088 if (img->next)
6089 img->next->prev = img;
6090 img->prev = NULL;
6091 c->buckets[i] = img;
6095 /* Call FN on every image in the image cache of frame F. Used to mark
6096 Lisp Objects in the image cache. */
6098 void
6099 forall_images_in_image_cache (f, fn)
6100 struct frame *f;
6101 void (*fn) P_ ((struct image *img));
6103 if (FRAME_LIVE_P (f) && FRAME_X_P (f))
6105 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6106 if (c)
6108 int i;
6109 for (i = 0; i < c->used; ++i)
6110 if (c->images[i])
6111 fn (c->images[i]);
6118 /***********************************************************************
6119 X support code
6120 ***********************************************************************/
6122 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
6123 XImage **, Pixmap *));
6124 static void x_destroy_x_image P_ ((XImage *));
6125 static void x_put_x_image P_ ((struct frame *, XImage *, Pixmap, int, int));
6128 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
6129 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
6130 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
6131 via xmalloc. Print error messages via image_error if an error
6132 occurs. Value is non-zero if successful. */
6134 static int
6135 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
6136 struct frame *f;
6137 int width, height, depth;
6138 XImage **ximg;
6139 Pixmap *pixmap;
6141 Display *display = FRAME_X_DISPLAY (f);
6142 Screen *screen = FRAME_X_SCREEN (f);
6143 Window window = FRAME_X_WINDOW (f);
6145 xassert (interrupt_input_blocked);
6147 if (depth <= 0)
6148 depth = DefaultDepthOfScreen (screen);
6149 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
6150 depth, ZPixmap, 0, NULL, width, height,
6151 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
6152 if (*ximg == NULL)
6154 image_error ("Unable to allocate X image", Qnil, Qnil);
6155 return 0;
6158 /* Allocate image raster. */
6159 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
6161 /* Allocate a pixmap of the same size. */
6162 *pixmap = XCreatePixmap (display, window, width, height, depth);
6163 if (*pixmap == None)
6165 x_destroy_x_image (*ximg);
6166 *ximg = NULL;
6167 image_error ("Unable to create X pixmap", Qnil, Qnil);
6168 return 0;
6171 return 1;
6175 /* Destroy XImage XIMG. Free XIMG->data. */
6177 static void
6178 x_destroy_x_image (ximg)
6179 XImage *ximg;
6181 xassert (interrupt_input_blocked);
6182 if (ximg)
6184 xfree (ximg->data);
6185 ximg->data = NULL;
6186 XDestroyImage (ximg);
6191 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
6192 are width and height of both the image and pixmap. */
6194 static void
6195 x_put_x_image (f, ximg, pixmap, width, height)
6196 struct frame *f;
6197 XImage *ximg;
6198 Pixmap pixmap;
6200 GC gc;
6202 xassert (interrupt_input_blocked);
6203 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
6204 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
6205 XFreeGC (FRAME_X_DISPLAY (f), gc);
6210 /***********************************************************************
6211 File Handling
6212 ***********************************************************************/
6214 static Lisp_Object x_find_image_file P_ ((Lisp_Object));
6215 static char *slurp_file P_ ((char *, int *));
6218 /* Find image file FILE. Look in data-directory, then
6219 x-bitmap-file-path. Value is the full name of the file found, or
6220 nil if not found. */
6222 static Lisp_Object
6223 x_find_image_file (file)
6224 Lisp_Object file;
6226 Lisp_Object file_found, search_path;
6227 struct gcpro gcpro1, gcpro2;
6228 int fd;
6230 file_found = Qnil;
6231 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
6232 GCPRO2 (file_found, search_path);
6234 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
6235 fd = openp (search_path, file, "", &file_found, 0);
6237 if (fd == -1)
6238 file_found = Qnil;
6239 else
6240 close (fd);
6242 UNGCPRO;
6243 return file_found;
6247 /* Read FILE into memory. Value is a pointer to a buffer allocated
6248 with xmalloc holding FILE's contents. Value is null if an error
6249 occurred. *SIZE is set to the size of the file. */
6251 static char *
6252 slurp_file (file, size)
6253 char *file;
6254 int *size;
6256 FILE *fp = NULL;
6257 char *buf = NULL;
6258 struct stat st;
6260 if (stat (file, &st) == 0
6261 && (fp = fopen (file, "r")) != NULL
6262 && (buf = (char *) xmalloc (st.st_size),
6263 fread (buf, 1, st.st_size, fp) == st.st_size))
6265 *size = st.st_size;
6266 fclose (fp);
6268 else
6270 if (fp)
6271 fclose (fp);
6272 if (buf)
6274 xfree (buf);
6275 buf = NULL;
6279 return buf;
6284 /***********************************************************************
6285 XBM images
6286 ***********************************************************************/
6288 static int xbm_scan P_ ((char **, char *, char *, int *));
6289 static int xbm_load P_ ((struct frame *f, struct image *img));
6290 static int xbm_load_image P_ ((struct frame *f, struct image *img,
6291 char *, char *));
6292 static int xbm_image_p P_ ((Lisp_Object object));
6293 static int xbm_read_bitmap_data P_ ((char *, char *, int *, int *,
6294 unsigned char **));
6295 static int xbm_file_p P_ ((Lisp_Object));
6298 /* Indices of image specification fields in xbm_format, below. */
6300 enum xbm_keyword_index
6302 XBM_TYPE,
6303 XBM_FILE,
6304 XBM_WIDTH,
6305 XBM_HEIGHT,
6306 XBM_DATA,
6307 XBM_FOREGROUND,
6308 XBM_BACKGROUND,
6309 XBM_ASCENT,
6310 XBM_MARGIN,
6311 XBM_RELIEF,
6312 XBM_ALGORITHM,
6313 XBM_HEURISTIC_MASK,
6314 XBM_MASK,
6315 XBM_LAST
6318 /* Vector of image_keyword structures describing the format
6319 of valid XBM image specifications. */
6321 static struct image_keyword xbm_format[XBM_LAST] =
6323 {":type", IMAGE_SYMBOL_VALUE, 1},
6324 {":file", IMAGE_STRING_VALUE, 0},
6325 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6326 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6327 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6328 {":foreground", IMAGE_STRING_VALUE, 0},
6329 {":background", IMAGE_STRING_VALUE, 0},
6330 {":ascent", IMAGE_ASCENT_VALUE, 0},
6331 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6332 {":relief", IMAGE_INTEGER_VALUE, 0},
6333 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6334 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6335 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
6338 /* Structure describing the image type XBM. */
6340 static struct image_type xbm_type =
6342 &Qxbm,
6343 xbm_image_p,
6344 xbm_load,
6345 x_clear_image,
6346 NULL
6349 /* Tokens returned from xbm_scan. */
6351 enum xbm_token
6353 XBM_TK_IDENT = 256,
6354 XBM_TK_NUMBER
6358 /* Return non-zero if OBJECT is a valid XBM-type image specification.
6359 A valid specification is a list starting with the symbol `image'
6360 The rest of the list is a property list which must contain an
6361 entry `:type xbm..
6363 If the specification specifies a file to load, it must contain
6364 an entry `:file FILENAME' where FILENAME is a string.
6366 If the specification is for a bitmap loaded from memory it must
6367 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
6368 WIDTH and HEIGHT are integers > 0. DATA may be:
6370 1. a string large enough to hold the bitmap data, i.e. it must
6371 have a size >= (WIDTH + 7) / 8 * HEIGHT
6373 2. a bool-vector of size >= WIDTH * HEIGHT
6375 3. a vector of strings or bool-vectors, one for each line of the
6376 bitmap.
6378 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
6379 may not be specified in this case because they are defined in the
6380 XBM file.
6382 Both the file and data forms may contain the additional entries
6383 `:background COLOR' and `:foreground COLOR'. If not present,
6384 foreground and background of the frame on which the image is
6385 displayed is used. */
6387 static int
6388 xbm_image_p (object)
6389 Lisp_Object object;
6391 struct image_keyword kw[XBM_LAST];
6393 bcopy (xbm_format, kw, sizeof kw);
6394 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
6395 return 0;
6397 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
6399 if (kw[XBM_FILE].count)
6401 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
6402 return 0;
6404 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
6406 /* In-memory XBM file. */
6407 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
6408 return 0;
6410 else
6412 Lisp_Object data;
6413 int width, height;
6415 /* Entries for `:width', `:height' and `:data' must be present. */
6416 if (!kw[XBM_WIDTH].count
6417 || !kw[XBM_HEIGHT].count
6418 || !kw[XBM_DATA].count)
6419 return 0;
6421 data = kw[XBM_DATA].value;
6422 width = XFASTINT (kw[XBM_WIDTH].value);
6423 height = XFASTINT (kw[XBM_HEIGHT].value);
6425 /* Check type of data, and width and height against contents of
6426 data. */
6427 if (VECTORP (data))
6429 int i;
6431 /* Number of elements of the vector must be >= height. */
6432 if (XVECTOR (data)->size < height)
6433 return 0;
6435 /* Each string or bool-vector in data must be large enough
6436 for one line of the image. */
6437 for (i = 0; i < height; ++i)
6439 Lisp_Object elt = XVECTOR (data)->contents[i];
6441 if (STRINGP (elt))
6443 if (XSTRING (elt)->size
6444 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
6445 return 0;
6447 else if (BOOL_VECTOR_P (elt))
6449 if (XBOOL_VECTOR (elt)->size < width)
6450 return 0;
6452 else
6453 return 0;
6456 else if (STRINGP (data))
6458 if (XSTRING (data)->size
6459 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
6460 return 0;
6462 else if (BOOL_VECTOR_P (data))
6464 if (XBOOL_VECTOR (data)->size < width * height)
6465 return 0;
6467 else
6468 return 0;
6471 return 1;
6475 /* Scan a bitmap file. FP is the stream to read from. Value is
6476 either an enumerator from enum xbm_token, or a character for a
6477 single-character token, or 0 at end of file. If scanning an
6478 identifier, store the lexeme of the identifier in SVAL. If
6479 scanning a number, store its value in *IVAL. */
6481 static int
6482 xbm_scan (s, end, sval, ival)
6483 char **s, *end;
6484 char *sval;
6485 int *ival;
6487 int c;
6489 loop:
6491 /* Skip white space. */
6492 while (*s < end && (c = *(*s)++, isspace (c)))
6495 if (*s >= end)
6496 c = 0;
6497 else if (isdigit (c))
6499 int value = 0, digit;
6501 if (c == '0' && *s < end)
6503 c = *(*s)++;
6504 if (c == 'x' || c == 'X')
6506 while (*s < end)
6508 c = *(*s)++;
6509 if (isdigit (c))
6510 digit = c - '0';
6511 else if (c >= 'a' && c <= 'f')
6512 digit = c - 'a' + 10;
6513 else if (c >= 'A' && c <= 'F')
6514 digit = c - 'A' + 10;
6515 else
6516 break;
6517 value = 16 * value + digit;
6520 else if (isdigit (c))
6522 value = c - '0';
6523 while (*s < end
6524 && (c = *(*s)++, isdigit (c)))
6525 value = 8 * value + c - '0';
6528 else
6530 value = c - '0';
6531 while (*s < end
6532 && (c = *(*s)++, isdigit (c)))
6533 value = 10 * value + c - '0';
6536 if (*s < end)
6537 *s = *s - 1;
6538 *ival = value;
6539 c = XBM_TK_NUMBER;
6541 else if (isalpha (c) || c == '_')
6543 *sval++ = c;
6544 while (*s < end
6545 && (c = *(*s)++, (isalnum (c) || c == '_')))
6546 *sval++ = c;
6547 *sval = 0;
6548 if (*s < end)
6549 *s = *s - 1;
6550 c = XBM_TK_IDENT;
6552 else if (c == '/' && **s == '*')
6554 /* C-style comment. */
6555 ++*s;
6556 while (**s && (**s != '*' || *(*s + 1) != '/'))
6557 ++*s;
6558 if (**s)
6560 *s += 2;
6561 goto loop;
6565 return c;
6569 /* Replacement for XReadBitmapFileData which isn't available under old
6570 X versions. CONTENTS is a pointer to a buffer to parse; END is the
6571 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
6572 the image. Return in *DATA the bitmap data allocated with xmalloc.
6573 Value is non-zero if successful. DATA null means just test if
6574 CONTENTS looks like an in-memory XBM file. */
6576 static int
6577 xbm_read_bitmap_data (contents, end, width, height, data)
6578 char *contents, *end;
6579 int *width, *height;
6580 unsigned char **data;
6582 char *s = contents;
6583 char buffer[BUFSIZ];
6584 int padding_p = 0;
6585 int v10 = 0;
6586 int bytes_per_line, i, nbytes;
6587 unsigned char *p;
6588 int value;
6589 int LA1;
6591 #define match() \
6592 LA1 = xbm_scan (&s, end, buffer, &value)
6594 #define expect(TOKEN) \
6595 if (LA1 != (TOKEN)) \
6596 goto failure; \
6597 else \
6598 match ()
6600 #define expect_ident(IDENT) \
6601 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
6602 match (); \
6603 else \
6604 goto failure
6606 *width = *height = -1;
6607 if (data)
6608 *data = NULL;
6609 LA1 = xbm_scan (&s, end, buffer, &value);
6611 /* Parse defines for width, height and hot-spots. */
6612 while (LA1 == '#')
6614 match ();
6615 expect_ident ("define");
6616 expect (XBM_TK_IDENT);
6618 if (LA1 == XBM_TK_NUMBER);
6620 char *p = strrchr (buffer, '_');
6621 p = p ? p + 1 : buffer;
6622 if (strcmp (p, "width") == 0)
6623 *width = value;
6624 else if (strcmp (p, "height") == 0)
6625 *height = value;
6627 expect (XBM_TK_NUMBER);
6630 if (*width < 0 || *height < 0)
6631 goto failure;
6632 else if (data == NULL)
6633 goto success;
6635 /* Parse bits. Must start with `static'. */
6636 expect_ident ("static");
6637 if (LA1 == XBM_TK_IDENT)
6639 if (strcmp (buffer, "unsigned") == 0)
6641 match ();
6642 expect_ident ("char");
6644 else if (strcmp (buffer, "short") == 0)
6646 match ();
6647 v10 = 1;
6648 if (*width % 16 && *width % 16 < 9)
6649 padding_p = 1;
6651 else if (strcmp (buffer, "char") == 0)
6652 match ();
6653 else
6654 goto failure;
6656 else
6657 goto failure;
6659 expect (XBM_TK_IDENT);
6660 expect ('[');
6661 expect (']');
6662 expect ('=');
6663 expect ('{');
6665 bytes_per_line = (*width + 7) / 8 + padding_p;
6666 nbytes = bytes_per_line * *height;
6667 p = *data = (char *) xmalloc (nbytes);
6669 if (v10)
6671 for (i = 0; i < nbytes; i += 2)
6673 int val = value;
6674 expect (XBM_TK_NUMBER);
6676 *p++ = val;
6677 if (!padding_p || ((i + 2) % bytes_per_line))
6678 *p++ = value >> 8;
6680 if (LA1 == ',' || LA1 == '}')
6681 match ();
6682 else
6683 goto failure;
6686 else
6688 for (i = 0; i < nbytes; ++i)
6690 int val = value;
6691 expect (XBM_TK_NUMBER);
6693 *p++ = val;
6695 if (LA1 == ',' || LA1 == '}')
6696 match ();
6697 else
6698 goto failure;
6702 success:
6703 return 1;
6705 failure:
6707 if (data && *data)
6709 xfree (*data);
6710 *data = NULL;
6712 return 0;
6714 #undef match
6715 #undef expect
6716 #undef expect_ident
6720 /* Load XBM image IMG which will be displayed on frame F from buffer
6721 CONTENTS. END is the end of the buffer. Value is non-zero if
6722 successful. */
6724 static int
6725 xbm_load_image (f, img, contents, end)
6726 struct frame *f;
6727 struct image *img;
6728 char *contents, *end;
6730 int rc;
6731 unsigned char *data;
6732 int success_p = 0;
6734 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
6735 if (rc)
6737 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6738 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6739 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6740 Lisp_Object value;
6742 xassert (img->width > 0 && img->height > 0);
6744 /* Get foreground and background colors, maybe allocate colors. */
6745 value = image_spec_value (img->spec, QCforeground, NULL);
6746 if (!NILP (value))
6747 foreground = x_alloc_image_color (f, img, value, foreground);
6749 value = image_spec_value (img->spec, QCbackground, NULL);
6750 if (!NILP (value))
6751 background = x_alloc_image_color (f, img, value, background);
6753 img->pixmap
6754 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6755 FRAME_X_WINDOW (f),
6756 data,
6757 img->width, img->height,
6758 foreground, background,
6759 depth);
6760 xfree (data);
6762 if (img->pixmap == None)
6764 x_clear_image (f, img);
6765 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
6767 else
6768 success_p = 1;
6770 else
6771 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6773 return success_p;
6777 /* Value is non-zero if DATA looks like an in-memory XBM file. */
6779 static int
6780 xbm_file_p (data)
6781 Lisp_Object data;
6783 int w, h;
6784 return (STRINGP (data)
6785 && xbm_read_bitmap_data (XSTRING (data)->data,
6786 (XSTRING (data)->data
6787 + STRING_BYTES (XSTRING (data))),
6788 &w, &h, NULL));
6792 /* Fill image IMG which is used on frame F with pixmap data. Value is
6793 non-zero if successful. */
6795 static int
6796 xbm_load (f, img)
6797 struct frame *f;
6798 struct image *img;
6800 int success_p = 0;
6801 Lisp_Object file_name;
6803 xassert (xbm_image_p (img->spec));
6805 /* If IMG->spec specifies a file name, create a non-file spec from it. */
6806 file_name = image_spec_value (img->spec, QCfile, NULL);
6807 if (STRINGP (file_name))
6809 Lisp_Object file;
6810 char *contents;
6811 int size;
6812 struct gcpro gcpro1;
6814 file = x_find_image_file (file_name);
6815 GCPRO1 (file);
6816 if (!STRINGP (file))
6818 image_error ("Cannot find image file `%s'", file_name, Qnil);
6819 UNGCPRO;
6820 return 0;
6823 contents = slurp_file (XSTRING (file)->data, &size);
6824 if (contents == NULL)
6826 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6827 UNGCPRO;
6828 return 0;
6831 success_p = xbm_load_image (f, img, contents, contents + size);
6832 UNGCPRO;
6834 else
6836 struct image_keyword fmt[XBM_LAST];
6837 Lisp_Object data;
6838 int depth;
6839 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6840 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6841 char *bits;
6842 int parsed_p;
6843 int in_memory_file_p = 0;
6845 /* See if data looks like an in-memory XBM file. */
6846 data = image_spec_value (img->spec, QCdata, NULL);
6847 in_memory_file_p = xbm_file_p (data);
6849 /* Parse the image specification. */
6850 bcopy (xbm_format, fmt, sizeof fmt);
6851 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
6852 xassert (parsed_p);
6854 /* Get specified width, and height. */
6855 if (!in_memory_file_p)
6857 img->width = XFASTINT (fmt[XBM_WIDTH].value);
6858 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
6859 xassert (img->width > 0 && img->height > 0);
6862 /* Get foreground and background colors, maybe allocate colors. */
6863 if (fmt[XBM_FOREGROUND].count)
6864 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
6865 foreground);
6866 if (fmt[XBM_BACKGROUND].count)
6867 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
6868 background);
6870 if (in_memory_file_p)
6871 success_p = xbm_load_image (f, img, XSTRING (data)->data,
6872 (XSTRING (data)->data
6873 + STRING_BYTES (XSTRING (data))));
6874 else
6876 if (VECTORP (data))
6878 int i;
6879 char *p;
6880 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
6882 p = bits = (char *) alloca (nbytes * img->height);
6883 for (i = 0; i < img->height; ++i, p += nbytes)
6885 Lisp_Object line = XVECTOR (data)->contents[i];
6886 if (STRINGP (line))
6887 bcopy (XSTRING (line)->data, p, nbytes);
6888 else
6889 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
6892 else if (STRINGP (data))
6893 bits = XSTRING (data)->data;
6894 else
6895 bits = XBOOL_VECTOR (data)->data;
6897 /* Create the pixmap. */
6898 depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6899 img->pixmap
6900 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6901 FRAME_X_WINDOW (f),
6902 bits,
6903 img->width, img->height,
6904 foreground, background,
6905 depth);
6906 if (img->pixmap)
6907 success_p = 1;
6908 else
6910 image_error ("Unable to create pixmap for XBM image `%s'",
6911 img->spec, Qnil);
6912 x_clear_image (f, img);
6917 return success_p;
6922 /***********************************************************************
6923 XPM images
6924 ***********************************************************************/
6926 #if HAVE_XPM
6928 static int xpm_image_p P_ ((Lisp_Object object));
6929 static int xpm_load P_ ((struct frame *f, struct image *img));
6930 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
6932 #include "X11/xpm.h"
6934 /* The symbol `xpm' identifying XPM-format images. */
6936 Lisp_Object Qxpm;
6938 /* Indices of image specification fields in xpm_format, below. */
6940 enum xpm_keyword_index
6942 XPM_TYPE,
6943 XPM_FILE,
6944 XPM_DATA,
6945 XPM_ASCENT,
6946 XPM_MARGIN,
6947 XPM_RELIEF,
6948 XPM_ALGORITHM,
6949 XPM_HEURISTIC_MASK,
6950 XPM_MASK,
6951 XPM_COLOR_SYMBOLS,
6952 XPM_LAST
6955 /* Vector of image_keyword structures describing the format
6956 of valid XPM image specifications. */
6958 static struct image_keyword xpm_format[XPM_LAST] =
6960 {":type", IMAGE_SYMBOL_VALUE, 1},
6961 {":file", IMAGE_STRING_VALUE, 0},
6962 {":data", IMAGE_STRING_VALUE, 0},
6963 {":ascent", IMAGE_ASCENT_VALUE, 0},
6964 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6965 {":relief", IMAGE_INTEGER_VALUE, 0},
6966 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6967 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6968 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6969 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
6972 /* Structure describing the image type XBM. */
6974 static struct image_type xpm_type =
6976 &Qxpm,
6977 xpm_image_p,
6978 xpm_load,
6979 x_clear_image,
6980 NULL
6984 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
6985 functions for allocating image colors. Our own functions handle
6986 color allocation failures more gracefully than the ones on the XPM
6987 lib. */
6989 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
6990 #define ALLOC_XPM_COLORS
6991 #endif
6993 #ifdef ALLOC_XPM_COLORS
6995 static void xpm_init_color_cache P_ ((struct frame *, XpmAttributes *));
6996 static void xpm_free_color_cache P_ ((void));
6997 static int xpm_lookup_color P_ ((struct frame *, char *, XColor *));
6998 static int xpm_color_bucket P_ ((char *));
6999 static struct xpm_cached_color *xpm_cache_color P_ ((struct frame *, char *,
7000 XColor *, int));
7002 /* An entry in a hash table used to cache color definitions of named
7003 colors. This cache is necessary to speed up XPM image loading in
7004 case we do color allocations ourselves. Without it, we would need
7005 a call to XParseColor per pixel in the image. */
7007 struct xpm_cached_color
7009 /* Next in collision chain. */
7010 struct xpm_cached_color *next;
7012 /* Color definition (RGB and pixel color). */
7013 XColor color;
7015 /* Color name. */
7016 char name[1];
7019 /* The hash table used for the color cache, and its bucket vector
7020 size. */
7022 #define XPM_COLOR_CACHE_BUCKETS 1001
7023 struct xpm_cached_color **xpm_color_cache;
7025 /* Initialize the color cache. */
7027 static void
7028 xpm_init_color_cache (f, attrs)
7029 struct frame *f;
7030 XpmAttributes *attrs;
7032 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
7033 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
7034 memset (xpm_color_cache, 0, nbytes);
7035 init_color_table ();
7037 if (attrs->valuemask & XpmColorSymbols)
7039 int i;
7040 XColor color;
7042 for (i = 0; i < attrs->numsymbols; ++i)
7043 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7044 attrs->colorsymbols[i].value, &color))
7046 color.pixel = lookup_rgb_color (f, color.red, color.green,
7047 color.blue);
7048 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
7054 /* Free the color cache. */
7056 static void
7057 xpm_free_color_cache ()
7059 struct xpm_cached_color *p, *next;
7060 int i;
7062 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
7063 for (p = xpm_color_cache[i]; p; p = next)
7065 next = p->next;
7066 xfree (p);
7069 xfree (xpm_color_cache);
7070 xpm_color_cache = NULL;
7071 free_color_table ();
7075 /* Return the bucket index for color named COLOR_NAME in the color
7076 cache. */
7078 static int
7079 xpm_color_bucket (color_name)
7080 char *color_name;
7082 unsigned h = 0;
7083 char *s;
7085 for (s = color_name; *s; ++s)
7086 h = (h << 2) ^ *s;
7087 return h %= XPM_COLOR_CACHE_BUCKETS;
7091 /* On frame F, cache values COLOR for color with name COLOR_NAME.
7092 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
7093 entry added. */
7095 static struct xpm_cached_color *
7096 xpm_cache_color (f, color_name, color, bucket)
7097 struct frame *f;
7098 char *color_name;
7099 XColor *color;
7100 int bucket;
7102 size_t nbytes;
7103 struct xpm_cached_color *p;
7105 if (bucket < 0)
7106 bucket = xpm_color_bucket (color_name);
7108 nbytes = sizeof *p + strlen (color_name);
7109 p = (struct xpm_cached_color *) xmalloc (nbytes);
7110 strcpy (p->name, color_name);
7111 p->color = *color;
7112 p->next = xpm_color_cache[bucket];
7113 xpm_color_cache[bucket] = p;
7114 return p;
7118 /* Look up color COLOR_NAME for frame F in the color cache. If found,
7119 return the cached definition in *COLOR. Otherwise, make a new
7120 entry in the cache and allocate the color. Value is zero if color
7121 allocation failed. */
7123 static int
7124 xpm_lookup_color (f, color_name, color)
7125 struct frame *f;
7126 char *color_name;
7127 XColor *color;
7129 struct xpm_cached_color *p;
7130 int h = xpm_color_bucket (color_name);
7132 for (p = xpm_color_cache[h]; p; p = p->next)
7133 if (strcmp (p->name, color_name) == 0)
7134 break;
7136 if (p != NULL)
7137 *color = p->color;
7138 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7139 color_name, color))
7141 color->pixel = lookup_rgb_color (f, color->red, color->green,
7142 color->blue);
7143 p = xpm_cache_color (f, color_name, color, h);
7146 return p != NULL;
7150 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
7151 CLOSURE is a pointer to the frame on which we allocate the
7152 color. Return in *COLOR the allocated color. Value is non-zero
7153 if successful. */
7155 static int
7156 xpm_alloc_color (dpy, cmap, color_name, color, closure)
7157 Display *dpy;
7158 Colormap cmap;
7159 char *color_name;
7160 XColor *color;
7161 void *closure;
7163 return xpm_lookup_color ((struct frame *) closure, color_name, color);
7167 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
7168 is a pointer to the frame on which we allocate the color. Value is
7169 non-zero if successful. */
7171 static int
7172 xpm_free_colors (dpy, cmap, pixels, npixels, closure)
7173 Display *dpy;
7174 Colormap cmap;
7175 Pixel *pixels;
7176 int npixels;
7177 void *closure;
7179 return 1;
7182 #endif /* ALLOC_XPM_COLORS */
7185 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
7186 for XPM images. Such a list must consist of conses whose car and
7187 cdr are strings. */
7189 static int
7190 xpm_valid_color_symbols_p (color_symbols)
7191 Lisp_Object color_symbols;
7193 while (CONSP (color_symbols))
7195 Lisp_Object sym = XCAR (color_symbols);
7196 if (!CONSP (sym)
7197 || !STRINGP (XCAR (sym))
7198 || !STRINGP (XCDR (sym)))
7199 break;
7200 color_symbols = XCDR (color_symbols);
7203 return NILP (color_symbols);
7207 /* Value is non-zero if OBJECT is a valid XPM image specification. */
7209 static int
7210 xpm_image_p (object)
7211 Lisp_Object object;
7213 struct image_keyword fmt[XPM_LAST];
7214 bcopy (xpm_format, fmt, sizeof fmt);
7215 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
7216 /* Either `:file' or `:data' must be present. */
7217 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
7218 /* Either no `:color-symbols' or it's a list of conses
7219 whose car and cdr are strings. */
7220 && (fmt[XPM_COLOR_SYMBOLS].count == 0
7221 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
7225 /* Load image IMG which will be displayed on frame F. Value is
7226 non-zero if successful. */
7228 static int
7229 xpm_load (f, img)
7230 struct frame *f;
7231 struct image *img;
7233 int rc;
7234 XpmAttributes attrs;
7235 Lisp_Object specified_file, color_symbols;
7237 /* Configure the XPM lib. Use the visual of frame F. Allocate
7238 close colors. Return colors allocated. */
7239 bzero (&attrs, sizeof attrs);
7240 attrs.visual = FRAME_X_VISUAL (f);
7241 attrs.colormap = FRAME_X_COLORMAP (f);
7242 attrs.valuemask |= XpmVisual;
7243 attrs.valuemask |= XpmColormap;
7245 #ifdef ALLOC_XPM_COLORS
7246 /* Allocate colors with our own functions which handle
7247 failing color allocation more gracefully. */
7248 attrs.color_closure = f;
7249 attrs.alloc_color = xpm_alloc_color;
7250 attrs.free_colors = xpm_free_colors;
7251 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
7252 #else /* not ALLOC_XPM_COLORS */
7253 /* Let the XPM lib allocate colors. */
7254 attrs.valuemask |= XpmReturnAllocPixels;
7255 #ifdef XpmAllocCloseColors
7256 attrs.alloc_close_colors = 1;
7257 attrs.valuemask |= XpmAllocCloseColors;
7258 #else /* not XpmAllocCloseColors */
7259 attrs.closeness = 600;
7260 attrs.valuemask |= XpmCloseness;
7261 #endif /* not XpmAllocCloseColors */
7262 #endif /* ALLOC_XPM_COLORS */
7264 /* If image specification contains symbolic color definitions, add
7265 these to `attrs'. */
7266 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
7267 if (CONSP (color_symbols))
7269 Lisp_Object tail;
7270 XpmColorSymbol *xpm_syms;
7271 int i, size;
7273 attrs.valuemask |= XpmColorSymbols;
7275 /* Count number of symbols. */
7276 attrs.numsymbols = 0;
7277 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
7278 ++attrs.numsymbols;
7280 /* Allocate an XpmColorSymbol array. */
7281 size = attrs.numsymbols * sizeof *xpm_syms;
7282 xpm_syms = (XpmColorSymbol *) alloca (size);
7283 bzero (xpm_syms, size);
7284 attrs.colorsymbols = xpm_syms;
7286 /* Fill the color symbol array. */
7287 for (tail = color_symbols, i = 0;
7288 CONSP (tail);
7289 ++i, tail = XCDR (tail))
7291 Lisp_Object name = XCAR (XCAR (tail));
7292 Lisp_Object color = XCDR (XCAR (tail));
7293 xpm_syms[i].name = (char *) alloca (XSTRING (name)->size + 1);
7294 strcpy (xpm_syms[i].name, XSTRING (name)->data);
7295 xpm_syms[i].value = (char *) alloca (XSTRING (color)->size + 1);
7296 strcpy (xpm_syms[i].value, XSTRING (color)->data);
7300 /* Create a pixmap for the image, either from a file, or from a
7301 string buffer containing data in the same format as an XPM file. */
7302 #ifdef ALLOC_XPM_COLORS
7303 xpm_init_color_cache (f, &attrs);
7304 #endif
7306 specified_file = image_spec_value (img->spec, QCfile, NULL);
7307 if (STRINGP (specified_file))
7309 Lisp_Object file = x_find_image_file (specified_file);
7310 if (!STRINGP (file))
7312 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7313 return 0;
7316 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7317 XSTRING (file)->data, &img->pixmap, &img->mask,
7318 &attrs);
7320 else
7322 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
7323 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7324 XSTRING (buffer)->data,
7325 &img->pixmap, &img->mask,
7326 &attrs);
7329 if (rc == XpmSuccess)
7331 #ifdef ALLOC_XPM_COLORS
7332 img->colors = colors_in_color_table (&img->ncolors);
7333 #else /* not ALLOC_XPM_COLORS */
7334 img->ncolors = attrs.nalloc_pixels;
7335 img->colors = (unsigned long *) xmalloc (img->ncolors
7336 * sizeof *img->colors);
7337 for (i = 0; i < attrs.nalloc_pixels; ++i)
7339 img->colors[i] = attrs.alloc_pixels[i];
7340 #ifdef DEBUG_X_COLORS
7341 register_color (img->colors[i]);
7342 #endif
7344 #endif /* not ALLOC_XPM_COLORS */
7346 img->width = attrs.width;
7347 img->height = attrs.height;
7348 xassert (img->width > 0 && img->height > 0);
7350 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
7351 XpmFreeAttributes (&attrs);
7353 else
7355 switch (rc)
7357 case XpmOpenFailed:
7358 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
7359 break;
7361 case XpmFileInvalid:
7362 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
7363 break;
7365 case XpmNoMemory:
7366 image_error ("Out of memory (%s)", img->spec, Qnil);
7367 break;
7369 case XpmColorFailed:
7370 image_error ("Color allocation error (%s)", img->spec, Qnil);
7371 break;
7373 default:
7374 image_error ("Unknown error (%s)", img->spec, Qnil);
7375 break;
7379 #ifdef ALLOC_XPM_COLORS
7380 xpm_free_color_cache ();
7381 #endif
7382 return rc == XpmSuccess;
7385 #endif /* HAVE_XPM != 0 */
7388 /***********************************************************************
7389 Color table
7390 ***********************************************************************/
7392 /* An entry in the color table mapping an RGB color to a pixel color. */
7394 struct ct_color
7396 int r, g, b;
7397 unsigned long pixel;
7399 /* Next in color table collision list. */
7400 struct ct_color *next;
7403 /* The bucket vector size to use. Must be prime. */
7405 #define CT_SIZE 101
7407 /* Value is a hash of the RGB color given by R, G, and B. */
7409 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
7411 /* The color hash table. */
7413 struct ct_color **ct_table;
7415 /* Number of entries in the color table. */
7417 int ct_colors_allocated;
7419 /* Initialize the color table. */
7421 static void
7422 init_color_table ()
7424 int size = CT_SIZE * sizeof (*ct_table);
7425 ct_table = (struct ct_color **) xmalloc (size);
7426 bzero (ct_table, size);
7427 ct_colors_allocated = 0;
7431 /* Free memory associated with the color table. */
7433 static void
7434 free_color_table ()
7436 int i;
7437 struct ct_color *p, *next;
7439 for (i = 0; i < CT_SIZE; ++i)
7440 for (p = ct_table[i]; p; p = next)
7442 next = p->next;
7443 xfree (p);
7446 xfree (ct_table);
7447 ct_table = NULL;
7451 /* Value is a pixel color for RGB color R, G, B on frame F. If an
7452 entry for that color already is in the color table, return the
7453 pixel color of that entry. Otherwise, allocate a new color for R,
7454 G, B, and make an entry in the color table. */
7456 static unsigned long
7457 lookup_rgb_color (f, r, g, b)
7458 struct frame *f;
7459 int r, g, b;
7461 unsigned hash = CT_HASH_RGB (r, g, b);
7462 int i = hash % CT_SIZE;
7463 struct ct_color *p;
7465 for (p = ct_table[i]; p; p = p->next)
7466 if (p->r == r && p->g == g && p->b == b)
7467 break;
7469 if (p == NULL)
7471 XColor color;
7472 Colormap cmap;
7473 int rc;
7475 color.red = r;
7476 color.green = g;
7477 color.blue = b;
7479 cmap = FRAME_X_COLORMAP (f);
7480 rc = x_alloc_nearest_color (f, cmap, &color);
7482 if (rc)
7484 ++ct_colors_allocated;
7486 p = (struct ct_color *) xmalloc (sizeof *p);
7487 p->r = r;
7488 p->g = g;
7489 p->b = b;
7490 p->pixel = color.pixel;
7491 p->next = ct_table[i];
7492 ct_table[i] = p;
7494 else
7495 return FRAME_FOREGROUND_PIXEL (f);
7498 return p->pixel;
7502 /* Look up pixel color PIXEL which is used on frame F in the color
7503 table. If not already present, allocate it. Value is PIXEL. */
7505 static unsigned long
7506 lookup_pixel_color (f, pixel)
7507 struct frame *f;
7508 unsigned long pixel;
7510 int i = pixel % CT_SIZE;
7511 struct ct_color *p;
7513 for (p = ct_table[i]; p; p = p->next)
7514 if (p->pixel == pixel)
7515 break;
7517 if (p == NULL)
7519 XColor color;
7520 Colormap cmap;
7521 int rc;
7523 cmap = FRAME_X_COLORMAP (f);
7524 color.pixel = pixel;
7525 x_query_color (f, &color);
7526 rc = x_alloc_nearest_color (f, cmap, &color);
7528 if (rc)
7530 ++ct_colors_allocated;
7532 p = (struct ct_color *) xmalloc (sizeof *p);
7533 p->r = color.red;
7534 p->g = color.green;
7535 p->b = color.blue;
7536 p->pixel = pixel;
7537 p->next = ct_table[i];
7538 ct_table[i] = p;
7540 else
7541 return FRAME_FOREGROUND_PIXEL (f);
7544 return p->pixel;
7548 /* Value is a vector of all pixel colors contained in the color table,
7549 allocated via xmalloc. Set *N to the number of colors. */
7551 static unsigned long *
7552 colors_in_color_table (n)
7553 int *n;
7555 int i, j;
7556 struct ct_color *p;
7557 unsigned long *colors;
7559 if (ct_colors_allocated == 0)
7561 *n = 0;
7562 colors = NULL;
7564 else
7566 colors = (unsigned long *) xmalloc (ct_colors_allocated
7567 * sizeof *colors);
7568 *n = ct_colors_allocated;
7570 for (i = j = 0; i < CT_SIZE; ++i)
7571 for (p = ct_table[i]; p; p = p->next)
7572 colors[j++] = p->pixel;
7575 return colors;
7580 /***********************************************************************
7581 Algorithms
7582 ***********************************************************************/
7584 static void x_laplace_write_row P_ ((struct frame *, long *,
7585 int, XImage *, int));
7586 static void x_laplace_read_row P_ ((struct frame *, Colormap,
7587 XColor *, int, XImage *, int));
7588 static XColor *x_to_xcolors P_ ((struct frame *, struct image *, int));
7589 static void x_from_xcolors P_ ((struct frame *, struct image *, XColor *));
7590 static void x_detect_edges P_ ((struct frame *, struct image *, int[9], int));
7592 /* Non-zero means draw a cross on images having `:algorithm
7593 disabled'. */
7595 int cross_disabled_images;
7597 /* Edge detection matrices for different edge-detection
7598 strategies. */
7600 static int emboss_matrix[9] = {
7601 /* x - 1 x x + 1 */
7602 2, -1, 0, /* y - 1 */
7603 -1, 0, 1, /* y */
7604 0, 1, -2 /* y + 1 */
7607 static int laplace_matrix[9] = {
7608 /* x - 1 x x + 1 */
7609 1, 0, 0, /* y - 1 */
7610 0, 0, 0, /* y */
7611 0, 0, -1 /* y + 1 */
7614 /* Value is the intensity of the color whose red/green/blue values
7615 are R, G, and B. */
7617 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
7620 /* On frame F, return an array of XColor structures describing image
7621 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
7622 non-zero means also fill the red/green/blue members of the XColor
7623 structures. Value is a pointer to the array of XColors structures,
7624 allocated with xmalloc; it must be freed by the caller. */
7626 static XColor *
7627 x_to_xcolors (f, img, rgb_p)
7628 struct frame *f;
7629 struct image *img;
7630 int rgb_p;
7632 int x, y;
7633 XColor *colors, *p;
7634 XImage *ximg;
7636 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
7638 /* Get the X image IMG->pixmap. */
7639 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
7640 0, 0, img->width, img->height, ~0, ZPixmap);
7642 /* Fill the `pixel' members of the XColor array. I wished there
7643 were an easy and portable way to circumvent XGetPixel. */
7644 p = colors;
7645 for (y = 0; y < img->height; ++y)
7647 XColor *row = p;
7649 for (x = 0; x < img->width; ++x, ++p)
7650 p->pixel = XGetPixel (ximg, x, y);
7652 if (rgb_p)
7653 x_query_colors (f, row, img->width);
7656 XDestroyImage (ximg);
7657 return colors;
7661 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
7662 RGB members are set. F is the frame on which this all happens.
7663 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
7665 static void
7666 x_from_xcolors (f, img, colors)
7667 struct frame *f;
7668 struct image *img;
7669 XColor *colors;
7671 int x, y;
7672 XImage *oimg;
7673 Pixmap pixmap;
7674 XColor *p;
7676 init_color_table ();
7678 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
7679 &oimg, &pixmap);
7680 p = colors;
7681 for (y = 0; y < img->height; ++y)
7682 for (x = 0; x < img->width; ++x, ++p)
7684 unsigned long pixel;
7685 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
7686 XPutPixel (oimg, x, y, pixel);
7689 xfree (colors);
7690 x_clear_image_1 (f, img, 1, 0, 1);
7692 x_put_x_image (f, oimg, pixmap, img->width, img->height);
7693 x_destroy_x_image (oimg);
7694 img->pixmap = pixmap;
7695 img->colors = colors_in_color_table (&img->ncolors);
7696 free_color_table ();
7700 /* On frame F, perform edge-detection on image IMG.
7702 MATRIX is a nine-element array specifying the transformation
7703 matrix. See emboss_matrix for an example.
7705 COLOR_ADJUST is a color adjustment added to each pixel of the
7706 outgoing image. */
7708 static void
7709 x_detect_edges (f, img, matrix, color_adjust)
7710 struct frame *f;
7711 struct image *img;
7712 int matrix[9], color_adjust;
7714 XColor *colors = x_to_xcolors (f, img, 1);
7715 XColor *new, *p;
7716 int x, y, i, sum;
7718 for (i = sum = 0; i < 9; ++i)
7719 sum += abs (matrix[i]);
7721 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
7723 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
7725 for (y = 0; y < img->height; ++y)
7727 p = COLOR (new, 0, y);
7728 p->red = p->green = p->blue = 0xffff/2;
7729 p = COLOR (new, img->width - 1, y);
7730 p->red = p->green = p->blue = 0xffff/2;
7733 for (x = 1; x < img->width - 1; ++x)
7735 p = COLOR (new, x, 0);
7736 p->red = p->green = p->blue = 0xffff/2;
7737 p = COLOR (new, x, img->height - 1);
7738 p->red = p->green = p->blue = 0xffff/2;
7741 for (y = 1; y < img->height - 1; ++y)
7743 p = COLOR (new, 1, y);
7745 for (x = 1; x < img->width - 1; ++x, ++p)
7747 int r, g, b, y1, x1;
7749 r = g = b = i = 0;
7750 for (y1 = y - 1; y1 < y + 2; ++y1)
7751 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
7752 if (matrix[i])
7754 XColor *t = COLOR (colors, x1, y1);
7755 r += matrix[i] * t->red;
7756 g += matrix[i] * t->green;
7757 b += matrix[i] * t->blue;
7760 r = (r / sum + color_adjust) & 0xffff;
7761 g = (g / sum + color_adjust) & 0xffff;
7762 b = (b / sum + color_adjust) & 0xffff;
7763 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
7767 xfree (colors);
7768 x_from_xcolors (f, img, new);
7770 #undef COLOR
7774 /* Perform the pre-defined `emboss' edge-detection on image IMG
7775 on frame F. */
7777 static void
7778 x_emboss (f, img)
7779 struct frame *f;
7780 struct image *img;
7782 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
7786 /* Perform the pre-defined `laplace' edge-detection on image IMG
7787 on frame F. */
7789 static void
7790 x_laplace (f, img)
7791 struct frame *f;
7792 struct image *img;
7794 x_detect_edges (f, img, laplace_matrix, 45000);
7798 /* Perform edge-detection on image IMG on frame F, with specified
7799 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
7801 MATRIX must be either
7803 - a list of at least 9 numbers in row-major form
7804 - a vector of at least 9 numbers
7806 COLOR_ADJUST nil means use a default; otherwise it must be a
7807 number. */
7809 static void
7810 x_edge_detection (f, img, matrix, color_adjust)
7811 struct frame *f;
7812 struct image *img;
7813 Lisp_Object matrix, color_adjust;
7815 int i = 0;
7816 int trans[9];
7818 if (CONSP (matrix))
7820 for (i = 0;
7821 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
7822 ++i, matrix = XCDR (matrix))
7823 trans[i] = XFLOATINT (XCAR (matrix));
7825 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
7827 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
7828 trans[i] = XFLOATINT (AREF (matrix, i));
7831 if (NILP (color_adjust))
7832 color_adjust = make_number (0xffff / 2);
7834 if (i == 9 && NUMBERP (color_adjust))
7835 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
7839 /* Transform image IMG on frame F so that it looks disabled. */
7841 static void
7842 x_disable_image (f, img)
7843 struct frame *f;
7844 struct image *img;
7846 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7848 if (dpyinfo->n_planes >= 2)
7850 /* Color (or grayscale). Convert to gray, and equalize. Just
7851 drawing such images with a stipple can look very odd, so
7852 we're using this method instead. */
7853 XColor *colors = x_to_xcolors (f, img, 1);
7854 XColor *p, *end;
7855 const int h = 15000;
7856 const int l = 30000;
7858 for (p = colors, end = colors + img->width * img->height;
7859 p < end;
7860 ++p)
7862 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
7863 int i2 = (0xffff - h - l) * i / 0xffff + l;
7864 p->red = p->green = p->blue = i2;
7867 x_from_xcolors (f, img, colors);
7870 /* Draw a cross over the disabled image, if we must or if we
7871 should. */
7872 if (dpyinfo->n_planes < 2 || cross_disabled_images)
7874 Display *dpy = FRAME_X_DISPLAY (f);
7875 GC gc;
7877 gc = XCreateGC (dpy, img->pixmap, 0, NULL);
7878 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
7879 XDrawLine (dpy, img->pixmap, gc, 0, 0,
7880 img->width - 1, img->height - 1);
7881 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
7882 img->width - 1, 0);
7883 XFreeGC (dpy, gc);
7885 if (img->mask)
7887 gc = XCreateGC (dpy, img->mask, 0, NULL);
7888 XSetForeground (dpy, gc, WHITE_PIX_DEFAULT (f));
7889 XDrawLine (dpy, img->mask, gc, 0, 0,
7890 img->width - 1, img->height - 1);
7891 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
7892 img->width - 1, 0);
7893 XFreeGC (dpy, gc);
7899 /* Build a mask for image IMG which is used on frame F. FILE is the
7900 name of an image file, for error messages. HOW determines how to
7901 determine the background color of IMG. If it is a list '(R G B)',
7902 with R, G, and B being integers >= 0, take that as the color of the
7903 background. Otherwise, determine the background color of IMG
7904 heuristically. Value is non-zero if successful. */
7906 static int
7907 x_build_heuristic_mask (f, img, how)
7908 struct frame *f;
7909 struct image *img;
7910 Lisp_Object how;
7912 Display *dpy = FRAME_X_DISPLAY (f);
7913 XImage *ximg, *mask_img;
7914 int x, y, rc, look_at_corners_p;
7915 unsigned long bg = 0;
7917 if (img->mask)
7919 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
7920 img->mask = None;
7923 /* Create an image and pixmap serving as mask. */
7924 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
7925 &mask_img, &img->mask);
7926 if (!rc)
7927 return 0;
7929 /* Get the X image of IMG->pixmap. */
7930 ximg = XGetImage (dpy, img->pixmap, 0, 0, img->width, img->height,
7931 ~0, ZPixmap);
7933 /* Determine the background color of ximg. If HOW is `(R G B)'
7934 take that as color. Otherwise, try to determine the color
7935 heuristically. */
7936 look_at_corners_p = 1;
7938 if (CONSP (how))
7940 int rgb[3], i = 0;
7942 while (i < 3
7943 && CONSP (how)
7944 && NATNUMP (XCAR (how)))
7946 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
7947 how = XCDR (how);
7950 if (i == 3 && NILP (how))
7952 char color_name[30];
7953 XColor exact, color;
7954 Colormap cmap;
7956 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
7958 cmap = FRAME_X_COLORMAP (f);
7959 if (XLookupColor (dpy, cmap, color_name, &exact, &color))
7961 bg = color.pixel;
7962 look_at_corners_p = 0;
7967 if (look_at_corners_p)
7969 unsigned long corners[4];
7970 int i, best_count;
7972 /* Get the colors at the corners of ximg. */
7973 corners[0] = XGetPixel (ximg, 0, 0);
7974 corners[1] = XGetPixel (ximg, img->width - 1, 0);
7975 corners[2] = XGetPixel (ximg, img->width - 1, img->height - 1);
7976 corners[3] = XGetPixel (ximg, 0, img->height - 1);
7978 /* Choose the most frequently found color as background. */
7979 for (i = best_count = 0; i < 4; ++i)
7981 int j, n;
7983 for (j = n = 0; j < 4; ++j)
7984 if (corners[i] == corners[j])
7985 ++n;
7987 if (n > best_count)
7988 bg = corners[i], best_count = n;
7992 /* Set all bits in mask_img to 1 whose color in ximg is different
7993 from the background color bg. */
7994 for (y = 0; y < img->height; ++y)
7995 for (x = 0; x < img->width; ++x)
7996 XPutPixel (mask_img, x, y, XGetPixel (ximg, x, y) != bg);
7998 /* Put mask_img into img->mask. */
7999 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8000 x_destroy_x_image (mask_img);
8001 XDestroyImage (ximg);
8003 return 1;
8008 /***********************************************************************
8009 PBM (mono, gray, color)
8010 ***********************************************************************/
8012 static int pbm_image_p P_ ((Lisp_Object object));
8013 static int pbm_load P_ ((struct frame *f, struct image *img));
8014 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
8016 /* The symbol `pbm' identifying images of this type. */
8018 Lisp_Object Qpbm;
8020 /* Indices of image specification fields in gs_format, below. */
8022 enum pbm_keyword_index
8024 PBM_TYPE,
8025 PBM_FILE,
8026 PBM_DATA,
8027 PBM_ASCENT,
8028 PBM_MARGIN,
8029 PBM_RELIEF,
8030 PBM_ALGORITHM,
8031 PBM_HEURISTIC_MASK,
8032 PBM_MASK,
8033 PBM_FOREGROUND,
8034 PBM_BACKGROUND,
8035 PBM_LAST
8038 /* Vector of image_keyword structures describing the format
8039 of valid user-defined image specifications. */
8041 static struct image_keyword pbm_format[PBM_LAST] =
8043 {":type", IMAGE_SYMBOL_VALUE, 1},
8044 {":file", IMAGE_STRING_VALUE, 0},
8045 {":data", IMAGE_STRING_VALUE, 0},
8046 {":ascent", IMAGE_ASCENT_VALUE, 0},
8047 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
8048 {":relief", IMAGE_INTEGER_VALUE, 0},
8049 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8050 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8051 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8052 {":foreground", IMAGE_STRING_VALUE, 0},
8053 {":background", IMAGE_STRING_VALUE, 0}
8056 /* Structure describing the image type `pbm'. */
8058 static struct image_type pbm_type =
8060 &Qpbm,
8061 pbm_image_p,
8062 pbm_load,
8063 x_clear_image,
8064 NULL
8068 /* Return non-zero if OBJECT is a valid PBM image specification. */
8070 static int
8071 pbm_image_p (object)
8072 Lisp_Object object;
8074 struct image_keyword fmt[PBM_LAST];
8076 bcopy (pbm_format, fmt, sizeof fmt);
8078 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
8079 return 0;
8081 /* Must specify either :data or :file. */
8082 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
8086 /* Scan a decimal number from *S and return it. Advance *S while
8087 reading the number. END is the end of the string. Value is -1 at
8088 end of input. */
8090 static int
8091 pbm_scan_number (s, end)
8092 unsigned char **s, *end;
8094 int c = 0, val = -1;
8096 while (*s < end)
8098 /* Skip white-space. */
8099 while (*s < end && (c = *(*s)++, isspace (c)))
8102 if (c == '#')
8104 /* Skip comment to end of line. */
8105 while (*s < end && (c = *(*s)++, c != '\n'))
8108 else if (isdigit (c))
8110 /* Read decimal number. */
8111 val = c - '0';
8112 while (*s < end && (c = *(*s)++, isdigit (c)))
8113 val = 10 * val + c - '0';
8114 break;
8116 else
8117 break;
8120 return val;
8124 /* Load PBM image IMG for use on frame F. */
8126 static int
8127 pbm_load (f, img)
8128 struct frame *f;
8129 struct image *img;
8131 int raw_p, x, y;
8132 int width, height, max_color_idx = 0;
8133 XImage *ximg;
8134 Lisp_Object file, specified_file;
8135 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
8136 struct gcpro gcpro1;
8137 unsigned char *contents = NULL;
8138 unsigned char *end, *p;
8139 int size;
8141 specified_file = image_spec_value (img->spec, QCfile, NULL);
8142 file = Qnil;
8143 GCPRO1 (file);
8145 if (STRINGP (specified_file))
8147 file = x_find_image_file (specified_file);
8148 if (!STRINGP (file))
8150 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8151 UNGCPRO;
8152 return 0;
8155 contents = slurp_file (XSTRING (file)->data, &size);
8156 if (contents == NULL)
8158 image_error ("Error reading `%s'", file, Qnil);
8159 UNGCPRO;
8160 return 0;
8163 p = contents;
8164 end = contents + size;
8166 else
8168 Lisp_Object data;
8169 data = image_spec_value (img->spec, QCdata, NULL);
8170 p = XSTRING (data)->data;
8171 end = p + STRING_BYTES (XSTRING (data));
8174 /* Check magic number. */
8175 if (end - p < 2 || *p++ != 'P')
8177 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8178 error:
8179 xfree (contents);
8180 UNGCPRO;
8181 return 0;
8184 switch (*p++)
8186 case '1':
8187 raw_p = 0, type = PBM_MONO;
8188 break;
8190 case '2':
8191 raw_p = 0, type = PBM_GRAY;
8192 break;
8194 case '3':
8195 raw_p = 0, type = PBM_COLOR;
8196 break;
8198 case '4':
8199 raw_p = 1, type = PBM_MONO;
8200 break;
8202 case '5':
8203 raw_p = 1, type = PBM_GRAY;
8204 break;
8206 case '6':
8207 raw_p = 1, type = PBM_COLOR;
8208 break;
8210 default:
8211 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8212 goto error;
8215 /* Read width, height, maximum color-component. Characters
8216 starting with `#' up to the end of a line are ignored. */
8217 width = pbm_scan_number (&p, end);
8218 height = pbm_scan_number (&p, end);
8220 if (type != PBM_MONO)
8222 max_color_idx = pbm_scan_number (&p, end);
8223 if (raw_p && max_color_idx > 255)
8224 max_color_idx = 255;
8227 if (width < 0
8228 || height < 0
8229 || (type != PBM_MONO && max_color_idx < 0))
8230 goto error;
8232 if (!x_create_x_image_and_pixmap (f, width, height, 0,
8233 &ximg, &img->pixmap))
8234 goto error;
8236 /* Initialize the color hash table. */
8237 init_color_table ();
8239 if (type == PBM_MONO)
8241 int c = 0, g;
8242 struct image_keyword fmt[PBM_LAST];
8243 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
8244 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
8246 /* Parse the image specification. */
8247 bcopy (pbm_format, fmt, sizeof fmt);
8248 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
8250 /* Get foreground and background colors, maybe allocate colors. */
8251 if (fmt[PBM_FOREGROUND].count)
8252 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
8253 if (fmt[PBM_BACKGROUND].count)
8254 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
8256 for (y = 0; y < height; ++y)
8257 for (x = 0; x < width; ++x)
8259 if (raw_p)
8261 if ((x & 7) == 0)
8262 c = *p++;
8263 g = c & 0x80;
8264 c <<= 1;
8266 else
8267 g = pbm_scan_number (&p, end);
8269 XPutPixel (ximg, x, y, g ? fg : bg);
8272 else
8274 for (y = 0; y < height; ++y)
8275 for (x = 0; x < width; ++x)
8277 int r, g, b;
8279 if (type == PBM_GRAY)
8280 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
8281 else if (raw_p)
8283 r = *p++;
8284 g = *p++;
8285 b = *p++;
8287 else
8289 r = pbm_scan_number (&p, end);
8290 g = pbm_scan_number (&p, end);
8291 b = pbm_scan_number (&p, end);
8294 if (r < 0 || g < 0 || b < 0)
8296 xfree (ximg->data);
8297 ximg->data = NULL;
8298 XDestroyImage (ximg);
8299 image_error ("Invalid pixel value in image `%s'",
8300 img->spec, Qnil);
8301 goto error;
8304 /* RGB values are now in the range 0..max_color_idx.
8305 Scale this to the range 0..0xffff supported by X. */
8306 r = (double) r * 65535 / max_color_idx;
8307 g = (double) g * 65535 / max_color_idx;
8308 b = (double) b * 65535 / max_color_idx;
8309 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8313 /* Store in IMG->colors the colors allocated for the image, and
8314 free the color table. */
8315 img->colors = colors_in_color_table (&img->ncolors);
8316 free_color_table ();
8318 /* Put the image into a pixmap. */
8319 x_put_x_image (f, ximg, img->pixmap, width, height);
8320 x_destroy_x_image (ximg);
8322 img->width = width;
8323 img->height = height;
8325 UNGCPRO;
8326 xfree (contents);
8327 return 1;
8332 /***********************************************************************
8334 ***********************************************************************/
8336 #if HAVE_PNG
8338 #include <png.h>
8340 /* Function prototypes. */
8342 static int png_image_p P_ ((Lisp_Object object));
8343 static int png_load P_ ((struct frame *f, struct image *img));
8345 /* The symbol `png' identifying images of this type. */
8347 Lisp_Object Qpng;
8349 /* Indices of image specification fields in png_format, below. */
8351 enum png_keyword_index
8353 PNG_TYPE,
8354 PNG_DATA,
8355 PNG_FILE,
8356 PNG_ASCENT,
8357 PNG_MARGIN,
8358 PNG_RELIEF,
8359 PNG_ALGORITHM,
8360 PNG_HEURISTIC_MASK,
8361 PNG_MASK,
8362 PNG_LAST
8365 /* Vector of image_keyword structures describing the format
8366 of valid user-defined image specifications. */
8368 static struct image_keyword png_format[PNG_LAST] =
8370 {":type", IMAGE_SYMBOL_VALUE, 1},
8371 {":data", IMAGE_STRING_VALUE, 0},
8372 {":file", IMAGE_STRING_VALUE, 0},
8373 {":ascent", IMAGE_ASCENT_VALUE, 0},
8374 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
8375 {":relief", IMAGE_INTEGER_VALUE, 0},
8376 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8377 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8378 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8381 /* Structure describing the image type `png'. */
8383 static struct image_type png_type =
8385 &Qpng,
8386 png_image_p,
8387 png_load,
8388 x_clear_image,
8389 NULL
8393 /* Return non-zero if OBJECT is a valid PNG image specification. */
8395 static int
8396 png_image_p (object)
8397 Lisp_Object object;
8399 struct image_keyword fmt[PNG_LAST];
8400 bcopy (png_format, fmt, sizeof fmt);
8402 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
8403 return 0;
8405 /* Must specify either the :data or :file keyword. */
8406 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
8410 /* Error and warning handlers installed when the PNG library
8411 is initialized. */
8413 static void
8414 my_png_error (png_ptr, msg)
8415 png_struct *png_ptr;
8416 char *msg;
8418 xassert (png_ptr != NULL);
8419 image_error ("PNG error: %s", build_string (msg), Qnil);
8420 longjmp (png_ptr->jmpbuf, 1);
8424 static void
8425 my_png_warning (png_ptr, msg)
8426 png_struct *png_ptr;
8427 char *msg;
8429 xassert (png_ptr != NULL);
8430 image_error ("PNG warning: %s", build_string (msg), Qnil);
8433 /* Memory source for PNG decoding. */
8435 struct png_memory_storage
8437 unsigned char *bytes; /* The data */
8438 size_t len; /* How big is it? */
8439 int index; /* Where are we? */
8443 /* Function set as reader function when reading PNG image from memory.
8444 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
8445 bytes from the input to DATA. */
8447 static void
8448 png_read_from_memory (png_ptr, data, length)
8449 png_structp png_ptr;
8450 png_bytep data;
8451 png_size_t length;
8453 struct png_memory_storage *tbr
8454 = (struct png_memory_storage *) png_get_io_ptr (png_ptr);
8456 if (length > tbr->len - tbr->index)
8457 png_error (png_ptr, "Read error");
8459 bcopy (tbr->bytes + tbr->index, data, length);
8460 tbr->index = tbr->index + length;
8463 /* Load PNG image IMG for use on frame F. Value is non-zero if
8464 successful. */
8466 static int
8467 png_load (f, img)
8468 struct frame *f;
8469 struct image *img;
8471 Lisp_Object file, specified_file;
8472 Lisp_Object specified_data;
8473 int x, y, i;
8474 XImage *ximg, *mask_img = NULL;
8475 struct gcpro gcpro1;
8476 png_struct *png_ptr = NULL;
8477 png_info *info_ptr = NULL, *end_info = NULL;
8478 FILE *volatile fp = NULL;
8479 png_byte sig[8];
8480 png_byte * volatile pixels = NULL;
8481 png_byte ** volatile rows = NULL;
8482 png_uint_32 width, height;
8483 int bit_depth, color_type, interlace_type;
8484 png_byte channels;
8485 png_uint_32 row_bytes;
8486 int transparent_p;
8487 char *gamma_str;
8488 double screen_gamma, image_gamma;
8489 int intent;
8490 struct png_memory_storage tbr; /* Data to be read */
8492 /* Find out what file to load. */
8493 specified_file = image_spec_value (img->spec, QCfile, NULL);
8494 specified_data = image_spec_value (img->spec, QCdata, NULL);
8495 file = Qnil;
8496 GCPRO1 (file);
8498 if (NILP (specified_data))
8500 file = x_find_image_file (specified_file);
8501 if (!STRINGP (file))
8503 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8504 UNGCPRO;
8505 return 0;
8508 /* Open the image file. */
8509 fp = fopen (XSTRING (file)->data, "rb");
8510 if (!fp)
8512 image_error ("Cannot open image file `%s'", file, Qnil);
8513 UNGCPRO;
8514 fclose (fp);
8515 return 0;
8518 /* Check PNG signature. */
8519 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
8520 || !png_check_sig (sig, sizeof sig))
8522 image_error ("Not a PNG file: `%s'", file, Qnil);
8523 UNGCPRO;
8524 fclose (fp);
8525 return 0;
8528 else
8530 /* Read from memory. */
8531 tbr.bytes = XSTRING (specified_data)->data;
8532 tbr.len = STRING_BYTES (XSTRING (specified_data));
8533 tbr.index = 0;
8535 /* Check PNG signature. */
8536 if (tbr.len < sizeof sig
8537 || !png_check_sig (tbr.bytes, sizeof sig))
8539 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
8540 UNGCPRO;
8541 return 0;
8544 /* Need to skip past the signature. */
8545 tbr.bytes += sizeof (sig);
8548 /* Initialize read and info structs for PNG lib. */
8549 png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
8550 my_png_error, my_png_warning);
8551 if (!png_ptr)
8553 if (fp) fclose (fp);
8554 UNGCPRO;
8555 return 0;
8558 info_ptr = png_create_info_struct (png_ptr);
8559 if (!info_ptr)
8561 png_destroy_read_struct (&png_ptr, NULL, NULL);
8562 if (fp) fclose (fp);
8563 UNGCPRO;
8564 return 0;
8567 end_info = png_create_info_struct (png_ptr);
8568 if (!end_info)
8570 png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
8571 if (fp) fclose (fp);
8572 UNGCPRO;
8573 return 0;
8576 /* Set error jump-back. We come back here when the PNG library
8577 detects an error. */
8578 if (setjmp (png_ptr->jmpbuf))
8580 error:
8581 if (png_ptr)
8582 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8583 xfree (pixels);
8584 xfree (rows);
8585 if (fp) fclose (fp);
8586 UNGCPRO;
8587 return 0;
8590 /* Read image info. */
8591 if (!NILP (specified_data))
8592 png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
8593 else
8594 png_init_io (png_ptr, fp);
8596 png_set_sig_bytes (png_ptr, sizeof sig);
8597 png_read_info (png_ptr, info_ptr);
8598 png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
8599 &interlace_type, NULL, NULL);
8601 /* If image contains simply transparency data, we prefer to
8602 construct a clipping mask. */
8603 if (png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
8604 transparent_p = 1;
8605 else
8606 transparent_p = 0;
8608 /* This function is easier to write if we only have to handle
8609 one data format: RGB or RGBA with 8 bits per channel. Let's
8610 transform other formats into that format. */
8612 /* Strip more than 8 bits per channel. */
8613 if (bit_depth == 16)
8614 png_set_strip_16 (png_ptr);
8616 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
8617 if available. */
8618 png_set_expand (png_ptr);
8620 /* Convert grayscale images to RGB. */
8621 if (color_type == PNG_COLOR_TYPE_GRAY
8622 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
8623 png_set_gray_to_rgb (png_ptr);
8625 /* The value 2.2 is a guess for PC monitors from PNG example.c. */
8626 gamma_str = getenv ("SCREEN_GAMMA");
8627 screen_gamma = gamma_str ? atof (gamma_str) : 2.2;
8629 /* Tell the PNG lib to handle gamma correction for us. */
8631 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
8632 if (png_get_sRGB (png_ptr, info_ptr, &intent))
8633 /* There is a special chunk in the image specifying the gamma. */
8634 png_set_sRGB (png_ptr, info_ptr, intent);
8635 else
8636 #endif
8637 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
8638 /* Image contains gamma information. */
8639 png_set_gamma (png_ptr, screen_gamma, image_gamma);
8640 else
8641 /* Use a default of 0.5 for the image gamma. */
8642 png_set_gamma (png_ptr, screen_gamma, 0.5);
8644 /* Handle alpha channel by combining the image with a background
8645 color. Do this only if a real alpha channel is supplied. For
8646 simple transparency, we prefer a clipping mask. */
8647 if (!transparent_p)
8649 png_color_16 *image_background;
8651 if (png_get_bKGD (png_ptr, info_ptr, &image_background))
8652 /* Image contains a background color with which to
8653 combine the image. */
8654 png_set_background (png_ptr, image_background,
8655 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
8656 else
8658 /* Image does not contain a background color with which
8659 to combine the image data via an alpha channel. Use
8660 the frame's background instead. */
8661 XColor color;
8662 Colormap cmap;
8663 png_color_16 frame_background;
8665 cmap = FRAME_X_COLORMAP (f);
8666 color.pixel = FRAME_BACKGROUND_PIXEL (f);
8667 x_query_color (f, &color);
8669 bzero (&frame_background, sizeof frame_background);
8670 frame_background.red = color.red;
8671 frame_background.green = color.green;
8672 frame_background.blue = color.blue;
8674 png_set_background (png_ptr, &frame_background,
8675 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
8679 /* Update info structure. */
8680 png_read_update_info (png_ptr, info_ptr);
8682 /* Get number of channels. Valid values are 1 for grayscale images
8683 and images with a palette, 2 for grayscale images with transparency
8684 information (alpha channel), 3 for RGB images, and 4 for RGB
8685 images with alpha channel, i.e. RGBA. If conversions above were
8686 sufficient we should only have 3 or 4 channels here. */
8687 channels = png_get_channels (png_ptr, info_ptr);
8688 xassert (channels == 3 || channels == 4);
8690 /* Number of bytes needed for one row of the image. */
8691 row_bytes = png_get_rowbytes (png_ptr, info_ptr);
8693 /* Allocate memory for the image. */
8694 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
8695 rows = (png_byte **) xmalloc (height * sizeof *rows);
8696 for (i = 0; i < height; ++i)
8697 rows[i] = pixels + i * row_bytes;
8699 /* Read the entire image. */
8700 png_read_image (png_ptr, rows);
8701 png_read_end (png_ptr, info_ptr);
8702 if (fp)
8704 fclose (fp);
8705 fp = NULL;
8708 /* Create the X image and pixmap. */
8709 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
8710 &img->pixmap))
8711 goto error;
8713 /* Create an image and pixmap serving as mask if the PNG image
8714 contains an alpha channel. */
8715 if (channels == 4
8716 && !transparent_p
8717 && !x_create_x_image_and_pixmap (f, width, height, 1,
8718 &mask_img, &img->mask))
8720 x_destroy_x_image (ximg);
8721 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
8722 img->pixmap = None;
8723 goto error;
8726 /* Fill the X image and mask from PNG data. */
8727 init_color_table ();
8729 for (y = 0; y < height; ++y)
8731 png_byte *p = rows[y];
8733 for (x = 0; x < width; ++x)
8735 unsigned r, g, b;
8737 r = *p++ << 8;
8738 g = *p++ << 8;
8739 b = *p++ << 8;
8740 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8742 /* An alpha channel, aka mask channel, associates variable
8743 transparency with an image. Where other image formats
8744 support binary transparency---fully transparent or fully
8745 opaque---PNG allows up to 254 levels of partial transparency.
8746 The PNG library implements partial transparency by combining
8747 the image with a specified background color.
8749 I'm not sure how to handle this here nicely: because the
8750 background on which the image is displayed may change, for
8751 real alpha channel support, it would be necessary to create
8752 a new image for each possible background.
8754 What I'm doing now is that a mask is created if we have
8755 boolean transparency information. Otherwise I'm using
8756 the frame's background color to combine the image with. */
8758 if (channels == 4)
8760 if (mask_img)
8761 XPutPixel (mask_img, x, y, *p > 0);
8762 ++p;
8767 /* Remember colors allocated for this image. */
8768 img->colors = colors_in_color_table (&img->ncolors);
8769 free_color_table ();
8771 /* Clean up. */
8772 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8773 xfree (rows);
8774 xfree (pixels);
8776 img->width = width;
8777 img->height = height;
8779 /* Put the image into the pixmap, then free the X image and its buffer. */
8780 x_put_x_image (f, ximg, img->pixmap, width, height);
8781 x_destroy_x_image (ximg);
8783 /* Same for the mask. */
8784 if (mask_img)
8786 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8787 x_destroy_x_image (mask_img);
8790 UNGCPRO;
8791 return 1;
8794 #endif /* HAVE_PNG != 0 */
8798 /***********************************************************************
8799 JPEG
8800 ***********************************************************************/
8802 #if HAVE_JPEG
8804 /* Work around a warning about HAVE_STDLIB_H being redefined in
8805 jconfig.h. */
8806 #ifdef HAVE_STDLIB_H
8807 #define HAVE_STDLIB_H_1
8808 #undef HAVE_STDLIB_H
8809 #endif /* HAVE_STLIB_H */
8811 #include <jpeglib.h>
8812 #include <jerror.h>
8813 #include <setjmp.h>
8815 #ifdef HAVE_STLIB_H_1
8816 #define HAVE_STDLIB_H 1
8817 #endif
8819 static int jpeg_image_p P_ ((Lisp_Object object));
8820 static int jpeg_load P_ ((struct frame *f, struct image *img));
8822 /* The symbol `jpeg' identifying images of this type. */
8824 Lisp_Object Qjpeg;
8826 /* Indices of image specification fields in gs_format, below. */
8828 enum jpeg_keyword_index
8830 JPEG_TYPE,
8831 JPEG_DATA,
8832 JPEG_FILE,
8833 JPEG_ASCENT,
8834 JPEG_MARGIN,
8835 JPEG_RELIEF,
8836 JPEG_ALGORITHM,
8837 JPEG_HEURISTIC_MASK,
8838 JPEG_MASK,
8839 JPEG_LAST
8842 /* Vector of image_keyword structures describing the format
8843 of valid user-defined image specifications. */
8845 static struct image_keyword jpeg_format[JPEG_LAST] =
8847 {":type", IMAGE_SYMBOL_VALUE, 1},
8848 {":data", IMAGE_STRING_VALUE, 0},
8849 {":file", IMAGE_STRING_VALUE, 0},
8850 {":ascent", IMAGE_ASCENT_VALUE, 0},
8851 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
8852 {":relief", IMAGE_INTEGER_VALUE, 0},
8853 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8854 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8855 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8858 /* Structure describing the image type `jpeg'. */
8860 static struct image_type jpeg_type =
8862 &Qjpeg,
8863 jpeg_image_p,
8864 jpeg_load,
8865 x_clear_image,
8866 NULL
8870 /* Return non-zero if OBJECT is a valid JPEG image specification. */
8872 static int
8873 jpeg_image_p (object)
8874 Lisp_Object object;
8876 struct image_keyword fmt[JPEG_LAST];
8878 bcopy (jpeg_format, fmt, sizeof fmt);
8880 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
8881 return 0;
8883 /* Must specify either the :data or :file keyword. */
8884 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
8888 struct my_jpeg_error_mgr
8890 struct jpeg_error_mgr pub;
8891 jmp_buf setjmp_buffer;
8895 static void
8896 my_error_exit (cinfo)
8897 j_common_ptr cinfo;
8899 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
8900 longjmp (mgr->setjmp_buffer, 1);
8904 /* Init source method for JPEG data source manager. Called by
8905 jpeg_read_header() before any data is actually read. See
8906 libjpeg.doc from the JPEG lib distribution. */
8908 static void
8909 our_init_source (cinfo)
8910 j_decompress_ptr cinfo;
8915 /* Fill input buffer method for JPEG data source manager. Called
8916 whenever more data is needed. We read the whole image in one step,
8917 so this only adds a fake end of input marker at the end. */
8919 static boolean
8920 our_fill_input_buffer (cinfo)
8921 j_decompress_ptr cinfo;
8923 /* Insert a fake EOI marker. */
8924 struct jpeg_source_mgr *src = cinfo->src;
8925 static JOCTET buffer[2];
8927 buffer[0] = (JOCTET) 0xFF;
8928 buffer[1] = (JOCTET) JPEG_EOI;
8930 src->next_input_byte = buffer;
8931 src->bytes_in_buffer = 2;
8932 return TRUE;
8936 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
8937 is the JPEG data source manager. */
8939 static void
8940 our_skip_input_data (cinfo, num_bytes)
8941 j_decompress_ptr cinfo;
8942 long num_bytes;
8944 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
8946 if (src)
8948 if (num_bytes > src->bytes_in_buffer)
8949 ERREXIT (cinfo, JERR_INPUT_EOF);
8951 src->bytes_in_buffer -= num_bytes;
8952 src->next_input_byte += num_bytes;
8957 /* Method to terminate data source. Called by
8958 jpeg_finish_decompress() after all data has been processed. */
8960 static void
8961 our_term_source (cinfo)
8962 j_decompress_ptr cinfo;
8967 /* Set up the JPEG lib for reading an image from DATA which contains
8968 LEN bytes. CINFO is the decompression info structure created for
8969 reading the image. */
8971 static void
8972 jpeg_memory_src (cinfo, data, len)
8973 j_decompress_ptr cinfo;
8974 JOCTET *data;
8975 unsigned int len;
8977 struct jpeg_source_mgr *src;
8979 if (cinfo->src == NULL)
8981 /* First time for this JPEG object? */
8982 cinfo->src = (struct jpeg_source_mgr *)
8983 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
8984 sizeof (struct jpeg_source_mgr));
8985 src = (struct jpeg_source_mgr *) cinfo->src;
8986 src->next_input_byte = data;
8989 src = (struct jpeg_source_mgr *) cinfo->src;
8990 src->init_source = our_init_source;
8991 src->fill_input_buffer = our_fill_input_buffer;
8992 src->skip_input_data = our_skip_input_data;
8993 src->resync_to_restart = jpeg_resync_to_restart; /* Use default method. */
8994 src->term_source = our_term_source;
8995 src->bytes_in_buffer = len;
8996 src->next_input_byte = data;
9000 /* Load image IMG for use on frame F. Patterned after example.c
9001 from the JPEG lib. */
9003 static int
9004 jpeg_load (f, img)
9005 struct frame *f;
9006 struct image *img;
9008 struct jpeg_decompress_struct cinfo;
9009 struct my_jpeg_error_mgr mgr;
9010 Lisp_Object file, specified_file;
9011 Lisp_Object specified_data;
9012 FILE * volatile fp = NULL;
9013 JSAMPARRAY buffer;
9014 int row_stride, x, y;
9015 XImage *ximg = NULL;
9016 int rc;
9017 unsigned long *colors;
9018 int width, height;
9019 struct gcpro gcpro1;
9021 /* Open the JPEG file. */
9022 specified_file = image_spec_value (img->spec, QCfile, NULL);
9023 specified_data = image_spec_value (img->spec, QCdata, NULL);
9024 file = Qnil;
9025 GCPRO1 (file);
9027 if (NILP (specified_data))
9029 file = x_find_image_file (specified_file);
9030 if (!STRINGP (file))
9032 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9033 UNGCPRO;
9034 return 0;
9037 fp = fopen (XSTRING (file)->data, "r");
9038 if (fp == NULL)
9040 image_error ("Cannot open `%s'", file, Qnil);
9041 UNGCPRO;
9042 return 0;
9046 /* Customize libjpeg's error handling to call my_error_exit when an
9047 error is detected. This function will perform a longjmp. */
9048 cinfo.err = jpeg_std_error (&mgr.pub);
9049 mgr.pub.error_exit = my_error_exit;
9051 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
9053 if (rc == 1)
9055 /* Called from my_error_exit. Display a JPEG error. */
9056 char buffer[JMSG_LENGTH_MAX];
9057 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
9058 image_error ("Error reading JPEG image `%s': %s", img->spec,
9059 build_string (buffer));
9062 /* Close the input file and destroy the JPEG object. */
9063 if (fp)
9064 fclose ((FILE *) fp);
9065 jpeg_destroy_decompress (&cinfo);
9067 /* If we already have an XImage, free that. */
9068 x_destroy_x_image (ximg);
9070 /* Free pixmap and colors. */
9071 x_clear_image (f, img);
9073 UNGCPRO;
9074 return 0;
9077 /* Create the JPEG decompression object. Let it read from fp.
9078 Read the JPEG image header. */
9079 jpeg_create_decompress (&cinfo);
9081 if (NILP (specified_data))
9082 jpeg_stdio_src (&cinfo, (FILE *) fp);
9083 else
9084 jpeg_memory_src (&cinfo, XSTRING (specified_data)->data,
9085 STRING_BYTES (XSTRING (specified_data)));
9087 jpeg_read_header (&cinfo, TRUE);
9089 /* Customize decompression so that color quantization will be used.
9090 Start decompression. */
9091 cinfo.quantize_colors = TRUE;
9092 jpeg_start_decompress (&cinfo);
9093 width = img->width = cinfo.output_width;
9094 height = img->height = cinfo.output_height;
9096 /* Create X image and pixmap. */
9097 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9098 longjmp (mgr.setjmp_buffer, 2);
9100 /* Allocate colors. When color quantization is used,
9101 cinfo.actual_number_of_colors has been set with the number of
9102 colors generated, and cinfo.colormap is a two-dimensional array
9103 of color indices in the range 0..cinfo.actual_number_of_colors.
9104 No more than 255 colors will be generated. */
9106 int i, ir, ig, ib;
9108 if (cinfo.out_color_components > 2)
9109 ir = 0, ig = 1, ib = 2;
9110 else if (cinfo.out_color_components > 1)
9111 ir = 0, ig = 1, ib = 0;
9112 else
9113 ir = 0, ig = 0, ib = 0;
9115 /* Use the color table mechanism because it handles colors that
9116 cannot be allocated nicely. Such colors will be replaced with
9117 a default color, and we don't have to care about which colors
9118 can be freed safely, and which can't. */
9119 init_color_table ();
9120 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
9121 * sizeof *colors);
9123 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
9125 /* Multiply RGB values with 255 because X expects RGB values
9126 in the range 0..0xffff. */
9127 int r = cinfo.colormap[ir][i] << 8;
9128 int g = cinfo.colormap[ig][i] << 8;
9129 int b = cinfo.colormap[ib][i] << 8;
9130 colors[i] = lookup_rgb_color (f, r, g, b);
9133 /* Remember those colors actually allocated. */
9134 img->colors = colors_in_color_table (&img->ncolors);
9135 free_color_table ();
9138 /* Read pixels. */
9139 row_stride = width * cinfo.output_components;
9140 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
9141 row_stride, 1);
9142 for (y = 0; y < height; ++y)
9144 jpeg_read_scanlines (&cinfo, buffer, 1);
9145 for (x = 0; x < cinfo.output_width; ++x)
9146 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
9149 /* Clean up. */
9150 jpeg_finish_decompress (&cinfo);
9151 jpeg_destroy_decompress (&cinfo);
9152 if (fp)
9153 fclose ((FILE *) fp);
9155 /* Put the image into the pixmap. */
9156 x_put_x_image (f, ximg, img->pixmap, width, height);
9157 x_destroy_x_image (ximg);
9158 UNGCPRO;
9159 return 1;
9162 #endif /* HAVE_JPEG */
9166 /***********************************************************************
9167 TIFF
9168 ***********************************************************************/
9170 #if HAVE_TIFF
9172 #include <tiffio.h>
9174 static int tiff_image_p P_ ((Lisp_Object object));
9175 static int tiff_load P_ ((struct frame *f, struct image *img));
9177 /* The symbol `tiff' identifying images of this type. */
9179 Lisp_Object Qtiff;
9181 /* Indices of image specification fields in tiff_format, below. */
9183 enum tiff_keyword_index
9185 TIFF_TYPE,
9186 TIFF_DATA,
9187 TIFF_FILE,
9188 TIFF_ASCENT,
9189 TIFF_MARGIN,
9190 TIFF_RELIEF,
9191 TIFF_ALGORITHM,
9192 TIFF_HEURISTIC_MASK,
9193 TIFF_MASK,
9194 TIFF_LAST
9197 /* Vector of image_keyword structures describing the format
9198 of valid user-defined image specifications. */
9200 static struct image_keyword tiff_format[TIFF_LAST] =
9202 {":type", IMAGE_SYMBOL_VALUE, 1},
9203 {":data", IMAGE_STRING_VALUE, 0},
9204 {":file", IMAGE_STRING_VALUE, 0},
9205 {":ascent", IMAGE_ASCENT_VALUE, 0},
9206 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
9207 {":relief", IMAGE_INTEGER_VALUE, 0},
9208 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9209 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9210 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9213 /* Structure describing the image type `tiff'. */
9215 static struct image_type tiff_type =
9217 &Qtiff,
9218 tiff_image_p,
9219 tiff_load,
9220 x_clear_image,
9221 NULL
9225 /* Return non-zero if OBJECT is a valid TIFF image specification. */
9227 static int
9228 tiff_image_p (object)
9229 Lisp_Object object;
9231 struct image_keyword fmt[TIFF_LAST];
9232 bcopy (tiff_format, fmt, sizeof fmt);
9234 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
9235 return 0;
9237 /* Must specify either the :data or :file keyword. */
9238 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
9242 /* Reading from a memory buffer for TIFF images Based on the PNG
9243 memory source, but we have to provide a lot of extra functions.
9244 Blah.
9246 We really only need to implement read and seek, but I am not
9247 convinced that the TIFF library is smart enough not to destroy
9248 itself if we only hand it the function pointers we need to
9249 override. */
9251 typedef struct
9253 unsigned char *bytes;
9254 size_t len;
9255 int index;
9257 tiff_memory_source;
9260 static size_t
9261 tiff_read_from_memory (data, buf, size)
9262 thandle_t data;
9263 tdata_t buf;
9264 tsize_t size;
9266 tiff_memory_source *src = (tiff_memory_source *) data;
9268 if (size > src->len - src->index)
9269 return (size_t) -1;
9270 bcopy (src->bytes + src->index, buf, size);
9271 src->index += size;
9272 return size;
9276 static size_t
9277 tiff_write_from_memory (data, buf, size)
9278 thandle_t data;
9279 tdata_t buf;
9280 tsize_t size;
9282 return (size_t) -1;
9286 static toff_t
9287 tiff_seek_in_memory (data, off, whence)
9288 thandle_t data;
9289 toff_t off;
9290 int whence;
9292 tiff_memory_source *src = (tiff_memory_source *) data;
9293 int idx;
9295 switch (whence)
9297 case SEEK_SET: /* Go from beginning of source. */
9298 idx = off;
9299 break;
9301 case SEEK_END: /* Go from end of source. */
9302 idx = src->len + off;
9303 break;
9305 case SEEK_CUR: /* Go from current position. */
9306 idx = src->index + off;
9307 break;
9309 default: /* Invalid `whence'. */
9310 return -1;
9313 if (idx > src->len || idx < 0)
9314 return -1;
9316 src->index = idx;
9317 return src->index;
9321 static int
9322 tiff_close_memory (data)
9323 thandle_t data;
9325 /* NOOP */
9326 return 0;
9330 static int
9331 tiff_mmap_memory (data, pbase, psize)
9332 thandle_t data;
9333 tdata_t *pbase;
9334 toff_t *psize;
9336 /* It is already _IN_ memory. */
9337 return 0;
9341 static void
9342 tiff_unmap_memory (data, base, size)
9343 thandle_t data;
9344 tdata_t base;
9345 toff_t size;
9347 /* We don't need to do this. */
9351 static toff_t
9352 tiff_size_of_memory (data)
9353 thandle_t data;
9355 return ((tiff_memory_source *) data)->len;
9359 /* Load TIFF image IMG for use on frame F. Value is non-zero if
9360 successful. */
9362 static int
9363 tiff_load (f, img)
9364 struct frame *f;
9365 struct image *img;
9367 Lisp_Object file, specified_file;
9368 Lisp_Object specified_data;
9369 TIFF *tiff;
9370 int width, height, x, y;
9371 uint32 *buf;
9372 int rc;
9373 XImage *ximg;
9374 struct gcpro gcpro1;
9375 tiff_memory_source memsrc;
9377 specified_file = image_spec_value (img->spec, QCfile, NULL);
9378 specified_data = image_spec_value (img->spec, QCdata, NULL);
9379 file = Qnil;
9380 GCPRO1 (file);
9382 if (NILP (specified_data))
9384 /* Read from a file */
9385 file = x_find_image_file (specified_file);
9386 if (!STRINGP (file))
9388 image_error ("Cannot find image file `%s'", file, Qnil);
9389 UNGCPRO;
9390 return 0;
9393 /* Try to open the image file. */
9394 tiff = TIFFOpen (XSTRING (file)->data, "r");
9395 if (tiff == NULL)
9397 image_error ("Cannot open `%s'", file, Qnil);
9398 UNGCPRO;
9399 return 0;
9402 else
9404 /* Memory source! */
9405 memsrc.bytes = XSTRING (specified_data)->data;
9406 memsrc.len = STRING_BYTES (XSTRING (specified_data));
9407 memsrc.index = 0;
9409 tiff = TIFFClientOpen ("memory_source", "r", &memsrc,
9410 (TIFFReadWriteProc) tiff_read_from_memory,
9411 (TIFFReadWriteProc) tiff_write_from_memory,
9412 tiff_seek_in_memory,
9413 tiff_close_memory,
9414 tiff_size_of_memory,
9415 tiff_mmap_memory,
9416 tiff_unmap_memory);
9418 if (!tiff)
9420 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
9421 UNGCPRO;
9422 return 0;
9426 /* Get width and height of the image, and allocate a raster buffer
9427 of width x height 32-bit values. */
9428 TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
9429 TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
9430 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
9432 rc = TIFFReadRGBAImage (tiff, width, height, buf, 0);
9433 TIFFClose (tiff);
9434 if (!rc)
9436 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
9437 xfree (buf);
9438 UNGCPRO;
9439 return 0;
9442 /* Create the X image and pixmap. */
9443 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9445 xfree (buf);
9446 UNGCPRO;
9447 return 0;
9450 /* Initialize the color table. */
9451 init_color_table ();
9453 /* Process the pixel raster. Origin is in the lower-left corner. */
9454 for (y = 0; y < height; ++y)
9456 uint32 *row = buf + y * width;
9458 for (x = 0; x < width; ++x)
9460 uint32 abgr = row[x];
9461 int r = TIFFGetR (abgr) << 8;
9462 int g = TIFFGetG (abgr) << 8;
9463 int b = TIFFGetB (abgr) << 8;
9464 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
9468 /* Remember the colors allocated for the image. Free the color table. */
9469 img->colors = colors_in_color_table (&img->ncolors);
9470 free_color_table ();
9472 /* Put the image into the pixmap, then free the X image and its buffer. */
9473 x_put_x_image (f, ximg, img->pixmap, width, height);
9474 x_destroy_x_image (ximg);
9475 xfree (buf);
9477 img->width = width;
9478 img->height = height;
9480 UNGCPRO;
9481 return 1;
9484 #endif /* HAVE_TIFF != 0 */
9488 /***********************************************************************
9490 ***********************************************************************/
9492 #if HAVE_GIF
9494 #include <gif_lib.h>
9496 static int gif_image_p P_ ((Lisp_Object object));
9497 static int gif_load P_ ((struct frame *f, struct image *img));
9499 /* The symbol `gif' identifying images of this type. */
9501 Lisp_Object Qgif;
9503 /* Indices of image specification fields in gif_format, below. */
9505 enum gif_keyword_index
9507 GIF_TYPE,
9508 GIF_DATA,
9509 GIF_FILE,
9510 GIF_ASCENT,
9511 GIF_MARGIN,
9512 GIF_RELIEF,
9513 GIF_ALGORITHM,
9514 GIF_HEURISTIC_MASK,
9515 GIF_MASK,
9516 GIF_IMAGE,
9517 GIF_LAST
9520 /* Vector of image_keyword structures describing the format
9521 of valid user-defined image specifications. */
9523 static struct image_keyword gif_format[GIF_LAST] =
9525 {":type", IMAGE_SYMBOL_VALUE, 1},
9526 {":data", IMAGE_STRING_VALUE, 0},
9527 {":file", IMAGE_STRING_VALUE, 0},
9528 {":ascent", IMAGE_ASCENT_VALUE, 0},
9529 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
9530 {":relief", IMAGE_INTEGER_VALUE, 0},
9531 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9532 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9533 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9534 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0}
9537 /* Structure describing the image type `gif'. */
9539 static struct image_type gif_type =
9541 &Qgif,
9542 gif_image_p,
9543 gif_load,
9544 x_clear_image,
9545 NULL
9549 /* Return non-zero if OBJECT is a valid GIF image specification. */
9551 static int
9552 gif_image_p (object)
9553 Lisp_Object object;
9555 struct image_keyword fmt[GIF_LAST];
9556 bcopy (gif_format, fmt, sizeof fmt);
9558 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
9559 return 0;
9561 /* Must specify either the :data or :file keyword. */
9562 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
9566 /* Reading a GIF image from memory
9567 Based on the PNG memory stuff to a certain extent. */
9569 typedef struct
9571 unsigned char *bytes;
9572 size_t len;
9573 int index;
9575 gif_memory_source;
9578 /* Make the current memory source available to gif_read_from_memory.
9579 It's done this way because not all versions of libungif support
9580 a UserData field in the GifFileType structure. */
9581 static gif_memory_source *current_gif_memory_src;
9583 static int
9584 gif_read_from_memory (file, buf, len)
9585 GifFileType *file;
9586 GifByteType *buf;
9587 int len;
9589 gif_memory_source *src = current_gif_memory_src;
9591 if (len > src->len - src->index)
9592 return -1;
9594 bcopy (src->bytes + src->index, buf, len);
9595 src->index += len;
9596 return len;
9600 /* Load GIF image IMG for use on frame F. Value is non-zero if
9601 successful. */
9603 static int
9604 gif_load (f, img)
9605 struct frame *f;
9606 struct image *img;
9608 Lisp_Object file, specified_file;
9609 Lisp_Object specified_data;
9610 int rc, width, height, x, y, i;
9611 XImage *ximg;
9612 ColorMapObject *gif_color_map;
9613 unsigned long pixel_colors[256];
9614 GifFileType *gif;
9615 struct gcpro gcpro1;
9616 Lisp_Object image;
9617 int ino, image_left, image_top, image_width, image_height;
9618 gif_memory_source memsrc;
9619 unsigned char *raster;
9621 specified_file = image_spec_value (img->spec, QCfile, NULL);
9622 specified_data = image_spec_value (img->spec, QCdata, NULL);
9623 file = Qnil;
9624 GCPRO1 (file);
9626 if (NILP (specified_data))
9628 file = x_find_image_file (specified_file);
9629 if (!STRINGP (file))
9631 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9632 UNGCPRO;
9633 return 0;
9636 /* Open the GIF file. */
9637 gif = DGifOpenFileName (XSTRING (file)->data);
9638 if (gif == NULL)
9640 image_error ("Cannot open `%s'", file, Qnil);
9641 UNGCPRO;
9642 return 0;
9645 else
9647 /* Read from memory! */
9648 current_gif_memory_src = &memsrc;
9649 memsrc.bytes = XSTRING (specified_data)->data;
9650 memsrc.len = STRING_BYTES (XSTRING (specified_data));
9651 memsrc.index = 0;
9653 gif = DGifOpen(&memsrc, gif_read_from_memory);
9654 if (!gif)
9656 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
9657 UNGCPRO;
9658 return 0;
9662 /* Read entire contents. */
9663 rc = DGifSlurp (gif);
9664 if (rc == GIF_ERROR)
9666 image_error ("Error reading `%s'", img->spec, Qnil);
9667 DGifCloseFile (gif);
9668 UNGCPRO;
9669 return 0;
9672 image = image_spec_value (img->spec, QCindex, NULL);
9673 ino = INTEGERP (image) ? XFASTINT (image) : 0;
9674 if (ino >= gif->ImageCount)
9676 image_error ("Invalid image number `%s' in image `%s'",
9677 image, img->spec);
9678 DGifCloseFile (gif);
9679 UNGCPRO;
9680 return 0;
9683 width = img->width = gif->SWidth;
9684 height = img->height = gif->SHeight;
9686 /* Create the X image and pixmap. */
9687 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9689 DGifCloseFile (gif);
9690 UNGCPRO;
9691 return 0;
9694 /* Allocate colors. */
9695 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
9696 if (!gif_color_map)
9697 gif_color_map = gif->SColorMap;
9698 init_color_table ();
9699 bzero (pixel_colors, sizeof pixel_colors);
9701 for (i = 0; i < gif_color_map->ColorCount; ++i)
9703 int r = gif_color_map->Colors[i].Red << 8;
9704 int g = gif_color_map->Colors[i].Green << 8;
9705 int b = gif_color_map->Colors[i].Blue << 8;
9706 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
9709 img->colors = colors_in_color_table (&img->ncolors);
9710 free_color_table ();
9712 /* Clear the part of the screen image that are not covered by
9713 the image from the GIF file. Full animated GIF support
9714 requires more than can be done here (see the gif89 spec,
9715 disposal methods). Let's simply assume that the part
9716 not covered by a sub-image is in the frame's background color. */
9717 image_top = gif->SavedImages[ino].ImageDesc.Top;
9718 image_left = gif->SavedImages[ino].ImageDesc.Left;
9719 image_width = gif->SavedImages[ino].ImageDesc.Width;
9720 image_height = gif->SavedImages[ino].ImageDesc.Height;
9722 for (y = 0; y < image_top; ++y)
9723 for (x = 0; x < width; ++x)
9724 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9726 for (y = image_top + image_height; y < height; ++y)
9727 for (x = 0; x < width; ++x)
9728 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9730 for (y = image_top; y < image_top + image_height; ++y)
9732 for (x = 0; x < image_left; ++x)
9733 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9734 for (x = image_left + image_width; x < width; ++x)
9735 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9738 /* Read the GIF image into the X image. We use a local variable
9739 `raster' here because RasterBits below is a char *, and invites
9740 problems with bytes >= 0x80. */
9741 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
9743 if (gif->SavedImages[ino].ImageDesc.Interlace)
9745 static int interlace_start[] = {0, 4, 2, 1};
9746 static int interlace_increment[] = {8, 8, 4, 2};
9747 int pass;
9748 int row = interlace_start[0];
9750 pass = 0;
9752 for (y = 0; y < image_height; y++)
9754 if (row >= image_height)
9756 row = interlace_start[++pass];
9757 while (row >= image_height)
9758 row = interlace_start[++pass];
9761 for (x = 0; x < image_width; x++)
9763 int i = raster[(y * image_width) + x];
9764 XPutPixel (ximg, x + image_left, row + image_top,
9765 pixel_colors[i]);
9768 row += interlace_increment[pass];
9771 else
9773 for (y = 0; y < image_height; ++y)
9774 for (x = 0; x < image_width; ++x)
9776 int i = raster[y * image_width + x];
9777 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
9781 DGifCloseFile (gif);
9783 /* Put the image into the pixmap, then free the X image and its buffer. */
9784 x_put_x_image (f, ximg, img->pixmap, width, height);
9785 x_destroy_x_image (ximg);
9787 UNGCPRO;
9788 return 1;
9791 #endif /* HAVE_GIF != 0 */
9795 /***********************************************************************
9796 Ghostscript
9797 ***********************************************************************/
9799 static int gs_image_p P_ ((Lisp_Object object));
9800 static int gs_load P_ ((struct frame *f, struct image *img));
9801 static void gs_clear_image P_ ((struct frame *f, struct image *img));
9803 /* The symbol `postscript' identifying images of this type. */
9805 Lisp_Object Qpostscript;
9807 /* Keyword symbols. */
9809 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
9811 /* Indices of image specification fields in gs_format, below. */
9813 enum gs_keyword_index
9815 GS_TYPE,
9816 GS_PT_WIDTH,
9817 GS_PT_HEIGHT,
9818 GS_FILE,
9819 GS_LOADER,
9820 GS_BOUNDING_BOX,
9821 GS_ASCENT,
9822 GS_MARGIN,
9823 GS_RELIEF,
9824 GS_ALGORITHM,
9825 GS_HEURISTIC_MASK,
9826 GS_MASK,
9827 GS_LAST
9830 /* Vector of image_keyword structures describing the format
9831 of valid user-defined image specifications. */
9833 static struct image_keyword gs_format[GS_LAST] =
9835 {":type", IMAGE_SYMBOL_VALUE, 1},
9836 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9837 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9838 {":file", IMAGE_STRING_VALUE, 1},
9839 {":loader", IMAGE_FUNCTION_VALUE, 0},
9840 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
9841 {":ascent", IMAGE_ASCENT_VALUE, 0},
9842 {":margin", IMAGE_POSITIVE_INTEGER_VALUE, 0},
9843 {":relief", IMAGE_INTEGER_VALUE, 0},
9844 {":algorithm", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9845 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9846 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9849 /* Structure describing the image type `ghostscript'. */
9851 static struct image_type gs_type =
9853 &Qpostscript,
9854 gs_image_p,
9855 gs_load,
9856 gs_clear_image,
9857 NULL
9861 /* Free X resources of Ghostscript image IMG which is used on frame F. */
9863 static void
9864 gs_clear_image (f, img)
9865 struct frame *f;
9866 struct image *img;
9868 /* IMG->data.ptr_val may contain a recorded colormap. */
9869 xfree (img->data.ptr_val);
9870 x_clear_image (f, img);
9874 /* Return non-zero if OBJECT is a valid Ghostscript image
9875 specification. */
9877 static int
9878 gs_image_p (object)
9879 Lisp_Object object;
9881 struct image_keyword fmt[GS_LAST];
9882 Lisp_Object tem;
9883 int i;
9885 bcopy (gs_format, fmt, sizeof fmt);
9887 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
9888 return 0;
9890 /* Bounding box must be a list or vector containing 4 integers. */
9891 tem = fmt[GS_BOUNDING_BOX].value;
9892 if (CONSP (tem))
9894 for (i = 0; i < 4; ++i, tem = XCDR (tem))
9895 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
9896 return 0;
9897 if (!NILP (tem))
9898 return 0;
9900 else if (VECTORP (tem))
9902 if (XVECTOR (tem)->size != 4)
9903 return 0;
9904 for (i = 0; i < 4; ++i)
9905 if (!INTEGERP (XVECTOR (tem)->contents[i]))
9906 return 0;
9908 else
9909 return 0;
9911 return 1;
9915 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
9916 if successful. */
9918 static int
9919 gs_load (f, img)
9920 struct frame *f;
9921 struct image *img;
9923 char buffer[100];
9924 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
9925 struct gcpro gcpro1, gcpro2;
9926 Lisp_Object frame;
9927 double in_width, in_height;
9928 Lisp_Object pixel_colors = Qnil;
9930 /* Compute pixel size of pixmap needed from the given size in the
9931 image specification. Sizes in the specification are in pt. 1 pt
9932 = 1/72 in, xdpi and ydpi are stored in the frame's X display
9933 info. */
9934 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
9935 in_width = XFASTINT (pt_width) / 72.0;
9936 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
9937 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
9938 in_height = XFASTINT (pt_height) / 72.0;
9939 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
9941 /* Create the pixmap. */
9942 xassert (img->pixmap == None);
9943 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9944 img->width, img->height,
9945 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
9947 if (!img->pixmap)
9949 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
9950 return 0;
9953 /* Call the loader to fill the pixmap. It returns a process object
9954 if successful. We do not record_unwind_protect here because
9955 other places in redisplay like calling window scroll functions
9956 don't either. Let the Lisp loader use `unwind-protect' instead. */
9957 GCPRO2 (window_and_pixmap_id, pixel_colors);
9959 sprintf (buffer, "%lu %lu",
9960 (unsigned long) FRAME_X_WINDOW (f),
9961 (unsigned long) img->pixmap);
9962 window_and_pixmap_id = build_string (buffer);
9964 sprintf (buffer, "%lu %lu",
9965 FRAME_FOREGROUND_PIXEL (f),
9966 FRAME_BACKGROUND_PIXEL (f));
9967 pixel_colors = build_string (buffer);
9969 XSETFRAME (frame, f);
9970 loader = image_spec_value (img->spec, QCloader, NULL);
9971 if (NILP (loader))
9972 loader = intern ("gs-load-image");
9974 img->data.lisp_val = call6 (loader, frame, img->spec,
9975 make_number (img->width),
9976 make_number (img->height),
9977 window_and_pixmap_id,
9978 pixel_colors);
9979 UNGCPRO;
9980 return PROCESSP (img->data.lisp_val);
9984 /* Kill the Ghostscript process that was started to fill PIXMAP on
9985 frame F. Called from XTread_socket when receiving an event
9986 telling Emacs that Ghostscript has finished drawing. */
9988 void
9989 x_kill_gs_process (pixmap, f)
9990 Pixmap pixmap;
9991 struct frame *f;
9993 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
9994 int class, i;
9995 struct image *img;
9997 /* Find the image containing PIXMAP. */
9998 for (i = 0; i < c->used; ++i)
9999 if (c->images[i]->pixmap == pixmap)
10000 break;
10002 /* Kill the GS process. We should have found PIXMAP in the image
10003 cache and its image should contain a process object. */
10004 xassert (i < c->used);
10005 img = c->images[i];
10006 xassert (PROCESSP (img->data.lisp_val));
10007 Fkill_process (img->data.lisp_val, Qnil);
10008 img->data.lisp_val = Qnil;
10010 /* On displays with a mutable colormap, figure out the colors
10011 allocated for the image by looking at the pixels of an XImage for
10012 img->pixmap. */
10013 class = FRAME_X_VISUAL (f)->class;
10014 if (class != StaticColor && class != StaticGray && class != TrueColor)
10016 XImage *ximg;
10018 BLOCK_INPUT;
10020 /* Try to get an XImage for img->pixmep. */
10021 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
10022 0, 0, img->width, img->height, ~0, ZPixmap);
10023 if (ximg)
10025 int x, y;
10027 /* Initialize the color table. */
10028 init_color_table ();
10030 /* For each pixel of the image, look its color up in the
10031 color table. After having done so, the color table will
10032 contain an entry for each color used by the image. */
10033 for (y = 0; y < img->height; ++y)
10034 for (x = 0; x < img->width; ++x)
10036 unsigned long pixel = XGetPixel (ximg, x, y);
10037 lookup_pixel_color (f, pixel);
10040 /* Record colors in the image. Free color table and XImage. */
10041 img->colors = colors_in_color_table (&img->ncolors);
10042 free_color_table ();
10043 XDestroyImage (ximg);
10045 #if 0 /* This doesn't seem to be the case. If we free the colors
10046 here, we get a BadAccess later in x_clear_image when
10047 freeing the colors. */
10048 /* We have allocated colors once, but Ghostscript has also
10049 allocated colors on behalf of us. So, to get the
10050 reference counts right, free them once. */
10051 if (img->ncolors)
10052 x_free_colors (f, img->colors, img->ncolors);
10053 #endif
10055 else
10056 image_error ("Cannot get X image of `%s'; colors will not be freed",
10057 img->spec, Qnil);
10059 UNBLOCK_INPUT;
10065 /***********************************************************************
10066 Window properties
10067 ***********************************************************************/
10069 DEFUN ("x-change-window-property", Fx_change_window_property,
10070 Sx_change_window_property, 2, 3, 0,
10071 "Change window property PROP to VALUE on the X window of FRAME.\n\
10072 PROP and VALUE must be strings. FRAME nil or omitted means use the\n\
10073 selected frame. Value is VALUE.")
10074 (prop, value, frame)
10075 Lisp_Object frame, prop, value;
10077 struct frame *f = check_x_frame (frame);
10078 Atom prop_atom;
10080 CHECK_STRING (prop, 1);
10081 CHECK_STRING (value, 2);
10083 BLOCK_INPUT;
10084 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10085 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10086 prop_atom, XA_STRING, 8, PropModeReplace,
10087 XSTRING (value)->data, XSTRING (value)->size);
10089 /* Make sure the property is set when we return. */
10090 XFlush (FRAME_X_DISPLAY (f));
10091 UNBLOCK_INPUT;
10093 return value;
10097 DEFUN ("x-delete-window-property", Fx_delete_window_property,
10098 Sx_delete_window_property, 1, 2, 0,
10099 "Remove window property PROP from X window of FRAME.\n\
10100 FRAME nil or omitted means use the selected frame. Value is PROP.")
10101 (prop, frame)
10102 Lisp_Object prop, frame;
10104 struct frame *f = check_x_frame (frame);
10105 Atom prop_atom;
10107 CHECK_STRING (prop, 1);
10108 BLOCK_INPUT;
10109 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10110 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
10112 /* Make sure the property is removed when we return. */
10113 XFlush (FRAME_X_DISPLAY (f));
10114 UNBLOCK_INPUT;
10116 return prop;
10120 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
10121 1, 2, 0,
10122 "Value is the value of window property PROP on FRAME.\n\
10123 If FRAME is nil or omitted, use the selected frame. Value is nil\n\
10124 if FRAME hasn't a property with name PROP or if PROP has no string\n\
10125 value.")
10126 (prop, frame)
10127 Lisp_Object prop, frame;
10129 struct frame *f = check_x_frame (frame);
10130 Atom prop_atom;
10131 int rc;
10132 Lisp_Object prop_value = Qnil;
10133 char *tmp_data = NULL;
10134 Atom actual_type;
10135 int actual_format;
10136 unsigned long actual_size, bytes_remaining;
10138 CHECK_STRING (prop, 1);
10139 BLOCK_INPUT;
10140 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10141 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10142 prop_atom, 0, 0, False, XA_STRING,
10143 &actual_type, &actual_format, &actual_size,
10144 &bytes_remaining, (unsigned char **) &tmp_data);
10145 if (rc == Success)
10147 int size = bytes_remaining;
10149 XFree (tmp_data);
10150 tmp_data = NULL;
10152 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10153 prop_atom, 0, bytes_remaining,
10154 False, XA_STRING,
10155 &actual_type, &actual_format,
10156 &actual_size, &bytes_remaining,
10157 (unsigned char **) &tmp_data);
10158 if (rc == Success)
10159 prop_value = make_string (tmp_data, size);
10161 XFree (tmp_data);
10164 UNBLOCK_INPUT;
10165 return prop_value;
10170 /***********************************************************************
10171 Busy cursor
10172 ***********************************************************************/
10174 /* If non-null, an asynchronous timer that, when it expires, displays
10175 a busy cursor on all frames. */
10177 static struct atimer *busy_cursor_atimer;
10179 /* Non-zero means a busy cursor is currently shown. */
10181 static int busy_cursor_shown_p;
10183 /* Number of seconds to wait before displaying a busy cursor. */
10185 static Lisp_Object Vbusy_cursor_delay;
10187 /* Default number of seconds to wait before displaying a busy
10188 cursor. */
10190 #define DEFAULT_BUSY_CURSOR_DELAY 1
10192 /* Function prototypes. */
10194 static void show_busy_cursor P_ ((struct atimer *));
10195 static void hide_busy_cursor P_ ((void));
10198 /* Cancel a currently active busy-cursor timer, and start a new one. */
10200 void
10201 start_busy_cursor ()
10203 EMACS_TIME delay;
10204 int secs, usecs = 0;
10206 cancel_busy_cursor ();
10208 if (INTEGERP (Vbusy_cursor_delay)
10209 && XINT (Vbusy_cursor_delay) > 0)
10210 secs = XFASTINT (Vbusy_cursor_delay);
10211 else if (FLOATP (Vbusy_cursor_delay)
10212 && XFLOAT_DATA (Vbusy_cursor_delay) > 0)
10214 Lisp_Object tem;
10215 tem = Ftruncate (Vbusy_cursor_delay, Qnil);
10216 secs = XFASTINT (tem);
10217 usecs = (XFLOAT_DATA (Vbusy_cursor_delay) - secs) * 1000000;
10219 else
10220 secs = DEFAULT_BUSY_CURSOR_DELAY;
10222 EMACS_SET_SECS_USECS (delay, secs, usecs);
10223 busy_cursor_atimer = start_atimer (ATIMER_RELATIVE, delay,
10224 show_busy_cursor, NULL);
10228 /* Cancel the busy cursor timer if active, hide a busy cursor if
10229 shown. */
10231 void
10232 cancel_busy_cursor ()
10234 if (busy_cursor_atimer)
10236 cancel_atimer (busy_cursor_atimer);
10237 busy_cursor_atimer = NULL;
10240 if (busy_cursor_shown_p)
10241 hide_busy_cursor ();
10245 /* Timer function of busy_cursor_atimer. TIMER is equal to
10246 busy_cursor_atimer.
10248 Display a busy cursor on all frames by mapping the frames'
10249 busy_window. Set the busy_p flag in the frames' output_data.x
10250 structure to indicate that a busy cursor is shown on the
10251 frames. */
10253 static void
10254 show_busy_cursor (timer)
10255 struct atimer *timer;
10257 /* The timer implementation will cancel this timer automatically
10258 after this function has run. Set busy_cursor_atimer to null
10259 so that we know the timer doesn't have to be canceled. */
10260 busy_cursor_atimer = NULL;
10262 if (!busy_cursor_shown_p)
10264 Lisp_Object rest, frame;
10266 BLOCK_INPUT;
10268 FOR_EACH_FRAME (rest, frame)
10270 struct frame *f = XFRAME (frame);
10272 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
10274 Display *dpy = FRAME_X_DISPLAY (f);
10276 #ifdef USE_X_TOOLKIT
10277 if (f->output_data.x->widget)
10278 #else
10279 if (FRAME_OUTER_WINDOW (f))
10280 #endif
10282 f->output_data.x->busy_p = 1;
10284 if (!f->output_data.x->busy_window)
10286 unsigned long mask = CWCursor;
10287 XSetWindowAttributes attrs;
10289 attrs.cursor = f->output_data.x->busy_cursor;
10291 f->output_data.x->busy_window
10292 = XCreateWindow (dpy, FRAME_OUTER_WINDOW (f),
10293 0, 0, 32000, 32000, 0, 0,
10294 InputOnly,
10295 CopyFromParent,
10296 mask, &attrs);
10299 XMapRaised (dpy, f->output_data.x->busy_window);
10300 XFlush (dpy);
10305 busy_cursor_shown_p = 1;
10306 UNBLOCK_INPUT;
10311 /* Hide the busy cursor on all frames, if it is currently shown. */
10313 static void
10314 hide_busy_cursor ()
10316 if (busy_cursor_shown_p)
10318 Lisp_Object rest, frame;
10320 BLOCK_INPUT;
10321 FOR_EACH_FRAME (rest, frame)
10323 struct frame *f = XFRAME (frame);
10325 if (FRAME_X_P (f)
10326 /* Watch out for newly created frames. */
10327 && f->output_data.x->busy_window)
10329 XUnmapWindow (FRAME_X_DISPLAY (f), f->output_data.x->busy_window);
10330 /* Sync here because XTread_socket looks at the busy_p flag
10331 that is reset to zero below. */
10332 XSync (FRAME_X_DISPLAY (f), False);
10333 f->output_data.x->busy_p = 0;
10337 busy_cursor_shown_p = 0;
10338 UNBLOCK_INPUT;
10344 /***********************************************************************
10345 Tool tips
10346 ***********************************************************************/
10348 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
10349 Lisp_Object));
10351 /* The frame of a currently visible tooltip. */
10353 Lisp_Object tip_frame;
10355 /* If non-nil, a timer started that hides the last tooltip when it
10356 fires. */
10358 Lisp_Object tip_timer;
10359 Window tip_window;
10362 static Lisp_Object
10363 unwind_create_tip_frame (frame)
10364 Lisp_Object frame;
10366 Lisp_Object deleted;
10368 deleted = unwind_create_frame (frame);
10369 if (EQ (deleted, Qt))
10371 tip_window = None;
10372 tip_frame = Qnil;
10375 return deleted;
10379 /* Create a frame for a tooltip on the display described by DPYINFO.
10380 PARMS is a list of frame parameters. Value is the frame.
10382 Note that functions called here, esp. x_default_parameter can
10383 signal errors, for instance when a specified color name is
10384 undefined. We have to make sure that we're in a consistent state
10385 when this happens. */
10387 static Lisp_Object
10388 x_create_tip_frame (dpyinfo, parms)
10389 struct x_display_info *dpyinfo;
10390 Lisp_Object parms;
10392 struct frame *f;
10393 Lisp_Object frame, tem;
10394 Lisp_Object name;
10395 long window_prompting = 0;
10396 int width, height;
10397 int count = BINDING_STACK_SIZE ();
10398 struct gcpro gcpro1, gcpro2, gcpro3;
10399 struct kboard *kb;
10401 check_x ();
10403 /* Use this general default value to start with until we know if
10404 this frame has a specified name. */
10405 Vx_resource_name = Vinvocation_name;
10407 #ifdef MULTI_KBOARD
10408 kb = dpyinfo->kboard;
10409 #else
10410 kb = &the_only_kboard;
10411 #endif
10413 /* Get the name of the frame to use for resource lookup. */
10414 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
10415 if (!STRINGP (name)
10416 && !EQ (name, Qunbound)
10417 && !NILP (name))
10418 error ("Invalid frame name--not a string or nil");
10419 Vx_resource_name = name;
10421 frame = Qnil;
10422 GCPRO3 (parms, name, frame);
10423 f = make_frame (1);
10424 XSETFRAME (frame, f);
10425 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
10426 record_unwind_protect (unwind_create_tip_frame, frame);
10428 /* By setting the output method, we're essentially saying that
10429 the frame is live, as per FRAME_LIVE_P. If we get a signal
10430 from this point on, x_destroy_window might screw up reference
10431 counts etc. */
10432 f->output_method = output_x_window;
10433 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
10434 bzero (f->output_data.x, sizeof (struct x_output));
10435 f->output_data.x->icon_bitmap = -1;
10436 f->output_data.x->fontset = -1;
10437 f->output_data.x->scroll_bar_foreground_pixel = -1;
10438 f->output_data.x->scroll_bar_background_pixel = -1;
10439 f->icon_name = Qnil;
10440 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
10441 #if GLYPH_DEBUG
10442 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
10443 dpyinfo_refcount = dpyinfo->reference_count;
10444 #endif /* GLYPH_DEBUG */
10445 #ifdef MULTI_KBOARD
10446 FRAME_KBOARD (f) = kb;
10447 #endif
10448 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10449 f->output_data.x->explicit_parent = 0;
10451 /* These colors will be set anyway later, but it's important
10452 to get the color reference counts right, so initialize them! */
10454 Lisp_Object black;
10455 struct gcpro gcpro1;
10457 black = build_string ("black");
10458 GCPRO1 (black);
10459 f->output_data.x->foreground_pixel
10460 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10461 f->output_data.x->background_pixel
10462 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10463 f->output_data.x->cursor_pixel
10464 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10465 f->output_data.x->cursor_foreground_pixel
10466 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10467 f->output_data.x->border_pixel
10468 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10469 f->output_data.x->mouse_pixel
10470 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10471 UNGCPRO;
10474 /* Set the name; the functions to which we pass f expect the name to
10475 be set. */
10476 if (EQ (name, Qunbound) || NILP (name))
10478 f->name = build_string (dpyinfo->x_id_name);
10479 f->explicit_name = 0;
10481 else
10483 f->name = name;
10484 f->explicit_name = 1;
10485 /* use the frame's title when getting resources for this frame. */
10486 specbind (Qx_resource_name, name);
10489 /* Extract the window parameters from the supplied values that are
10490 needed to determine window geometry. */
10492 Lisp_Object font;
10494 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
10496 BLOCK_INPUT;
10497 /* First, try whatever font the caller has specified. */
10498 if (STRINGP (font))
10500 tem = Fquery_fontset (font, Qnil);
10501 if (STRINGP (tem))
10502 font = x_new_fontset (f, XSTRING (tem)->data);
10503 else
10504 font = x_new_font (f, XSTRING (font)->data);
10507 /* Try out a font which we hope has bold and italic variations. */
10508 if (!STRINGP (font))
10509 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
10510 if (!STRINGP (font))
10511 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10512 if (! STRINGP (font))
10513 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10514 if (! STRINGP (font))
10515 /* This was formerly the first thing tried, but it finds too many fonts
10516 and takes too long. */
10517 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
10518 /* If those didn't work, look for something which will at least work. */
10519 if (! STRINGP (font))
10520 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
10521 UNBLOCK_INPUT;
10522 if (! STRINGP (font))
10523 font = build_string ("fixed");
10525 x_default_parameter (f, parms, Qfont, font,
10526 "font", "Font", RES_TYPE_STRING);
10529 x_default_parameter (f, parms, Qborder_width, make_number (2),
10530 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
10532 /* This defaults to 2 in order to match xterm. We recognize either
10533 internalBorderWidth or internalBorder (which is what xterm calls
10534 it). */
10535 if (NILP (Fassq (Qinternal_border_width, parms)))
10537 Lisp_Object value;
10539 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
10540 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
10541 if (! EQ (value, Qunbound))
10542 parms = Fcons (Fcons (Qinternal_border_width, value),
10543 parms);
10546 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
10547 "internalBorderWidth", "internalBorderWidth",
10548 RES_TYPE_NUMBER);
10550 /* Also do the stuff which must be set before the window exists. */
10551 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
10552 "foreground", "Foreground", RES_TYPE_STRING);
10553 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
10554 "background", "Background", RES_TYPE_STRING);
10555 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
10556 "pointerColor", "Foreground", RES_TYPE_STRING);
10557 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
10558 "cursorColor", "Foreground", RES_TYPE_STRING);
10559 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
10560 "borderColor", "BorderColor", RES_TYPE_STRING);
10562 /* Init faces before x_default_parameter is called for scroll-bar
10563 parameters because that function calls x_set_scroll_bar_width,
10564 which calls change_frame_size, which calls Fset_window_buffer,
10565 which runs hooks, which call Fvertical_motion. At the end, we
10566 end up in init_iterator with a null face cache, which should not
10567 happen. */
10568 init_frame_faces (f);
10570 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10571 window_prompting = x_figure_window_size (f, parms);
10573 if (window_prompting & XNegative)
10575 if (window_prompting & YNegative)
10576 f->output_data.x->win_gravity = SouthEastGravity;
10577 else
10578 f->output_data.x->win_gravity = NorthEastGravity;
10580 else
10582 if (window_prompting & YNegative)
10583 f->output_data.x->win_gravity = SouthWestGravity;
10584 else
10585 f->output_data.x->win_gravity = NorthWestGravity;
10588 f->output_data.x->size_hint_flags = window_prompting;
10590 XSetWindowAttributes attrs;
10591 unsigned long mask;
10593 BLOCK_INPUT;
10594 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
10595 if (DoesSaveUnders (dpyinfo->screen))
10596 mask |= CWSaveUnder;
10598 /* Window managers look at the override-redirect flag to determine
10599 whether or net to give windows a decoration (Xlib spec, chapter
10600 3.2.8). */
10601 attrs.override_redirect = True;
10602 attrs.save_under = True;
10603 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
10604 /* Arrange for getting MapNotify and UnmapNotify events. */
10605 attrs.event_mask = StructureNotifyMask;
10606 tip_window
10607 = FRAME_X_WINDOW (f)
10608 = XCreateWindow (FRAME_X_DISPLAY (f),
10609 FRAME_X_DISPLAY_INFO (f)->root_window,
10610 /* x, y, width, height */
10611 0, 0, 1, 1,
10612 /* Border. */
10614 CopyFromParent, InputOutput, CopyFromParent,
10615 mask, &attrs);
10616 UNBLOCK_INPUT;
10619 x_make_gc (f);
10621 x_default_parameter (f, parms, Qauto_raise, Qnil,
10622 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
10623 x_default_parameter (f, parms, Qauto_lower, Qnil,
10624 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
10625 x_default_parameter (f, parms, Qcursor_type, Qbox,
10626 "cursorType", "CursorType", RES_TYPE_SYMBOL);
10628 /* Dimensions, especially f->height, must be done via change_frame_size.
10629 Change will not be effected unless different from the current
10630 f->height. */
10631 width = f->width;
10632 height = f->height;
10633 f->height = 0;
10634 SET_FRAME_WIDTH (f, 0);
10635 change_frame_size (f, height, width, 1, 0, 0);
10637 /* Set up faces after all frame parameters are known. This call
10638 also merges in face attributes specified for new frames. If we
10639 don't do this, the `menu' face for instance won't have the right
10640 colors, and the menu bar won't appear in the specified colors for
10641 new frames. */
10642 call1 (Qface_set_after_frame_default, frame);
10644 f->no_split = 1;
10646 UNGCPRO;
10648 /* It is now ok to make the frame official even if we get an error
10649 below. And the frame needs to be on Vframe_list or making it
10650 visible won't work. */
10651 Vframe_list = Fcons (frame, Vframe_list);
10652 tip_frame = frame;
10654 /* Now that the frame is official, it counts as a reference to
10655 its display. */
10656 FRAME_X_DISPLAY_INFO (f)->reference_count++;
10658 /* Discard the unwind_protect. */
10659 return unbind_to (count, frame);
10663 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
10664 "Show STRING in a \"tooltip\" window on frame FRAME.\n\
10665 A tooltip window is a small X window displaying a string.\n\
10667 FRAME nil or omitted means use the selected frame.\n\
10669 PARMS is an optional list of frame parameters which can be\n\
10670 used to change the tooltip's appearance.\n\
10672 Automatically hide the tooltip after TIMEOUT seconds.\n\
10673 TIMEOUT nil means use the default timeout of 5 seconds.\n\
10675 If the list of frame parameters PARAMS contains a `left' parameters,\n\
10676 the tooltip is displayed at that x-position. Otherwise it is\n\
10677 displayed at the mouse position, with offset DX added (default is 5 if\n\
10678 DX isn't specified). Likewise for the y-position; if a `top' frame\n\
10679 parameter is specified, it determines the y-position of the tooltip\n\
10680 window, otherwise it is displayed at the mouse position, with offset\n\
10681 DY added (default is -10).")
10682 (string, frame, parms, timeout, dx, dy)
10683 Lisp_Object string, frame, parms, timeout, dx, dy;
10685 struct frame *f;
10686 struct window *w;
10687 Window root, child;
10688 Lisp_Object buffer, top, left;
10689 struct buffer *old_buffer;
10690 struct text_pos pos;
10691 int i, width, height;
10692 int root_x, root_y, win_x, win_y;
10693 unsigned pmask;
10694 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10695 int old_windows_or_buffers_changed = windows_or_buffers_changed;
10696 int count = specpdl_ptr - specpdl;
10698 specbind (Qinhibit_redisplay, Qt);
10700 GCPRO4 (string, parms, frame, timeout);
10702 CHECK_STRING (string, 0);
10703 f = check_x_frame (frame);
10704 if (NILP (timeout))
10705 timeout = make_number (5);
10706 else
10707 CHECK_NATNUM (timeout, 2);
10709 if (NILP (dx))
10710 dx = make_number (5);
10711 else
10712 CHECK_NUMBER (dx, 5);
10714 if (NILP (dy))
10715 dy = make_number (-10);
10716 else
10717 CHECK_NUMBER (dy, 6);
10719 /* Hide a previous tip, if any. */
10720 Fx_hide_tip ();
10722 /* Add default values to frame parameters. */
10723 if (NILP (Fassq (Qname, parms)))
10724 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
10725 if (NILP (Fassq (Qinternal_border_width, parms)))
10726 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
10727 if (NILP (Fassq (Qborder_width, parms)))
10728 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
10729 if (NILP (Fassq (Qborder_color, parms)))
10730 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
10731 if (NILP (Fassq (Qbackground_color, parms)))
10732 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
10733 parms);
10735 /* Create a frame for the tooltip, and record it in the global
10736 variable tip_frame. */
10737 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms);
10738 f = XFRAME (frame);
10740 /* Set up the frame's root window. Currently we use a size of 80
10741 columns x 40 lines. If someone wants to show a larger tip, he
10742 will loose. I don't think this is a realistic case. */
10743 w = XWINDOW (FRAME_ROOT_WINDOW (f));
10744 w->left = w->top = make_number (0);
10745 w->width = make_number (80);
10746 w->height = make_number (40);
10747 adjust_glyphs (f);
10748 w->pseudo_window_p = 1;
10750 /* Display the tooltip text in a temporary buffer. */
10751 buffer = Fget_buffer_create (build_string (" *tip*"));
10752 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer);
10753 old_buffer = current_buffer;
10754 set_buffer_internal_1 (XBUFFER (buffer));
10755 Ferase_buffer ();
10756 Finsert (1, &string);
10757 clear_glyph_matrix (w->desired_matrix);
10758 clear_glyph_matrix (w->current_matrix);
10759 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
10760 try_window (FRAME_ROOT_WINDOW (f), pos);
10762 /* Compute width and height of the tooltip. */
10763 width = height = 0;
10764 for (i = 0; i < w->desired_matrix->nrows; ++i)
10766 struct glyph_row *row = &w->desired_matrix->rows[i];
10767 struct glyph *last;
10768 int row_width;
10770 /* Stop at the first empty row at the end. */
10771 if (!row->enabled_p || !row->displays_text_p)
10772 break;
10774 /* Let the row go over the full width of the frame. */
10775 row->full_width_p = 1;
10777 /* There's a glyph at the end of rows that is used to place
10778 the cursor there. Don't include the width of this glyph. */
10779 if (row->used[TEXT_AREA])
10781 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
10782 row_width = row->pixel_width - last->pixel_width;
10784 else
10785 row_width = row->pixel_width;
10787 height += row->height;
10788 width = max (width, row_width);
10791 /* Add the frame's internal border to the width and height the X
10792 window should have. */
10793 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
10794 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
10796 /* User-specified position? */
10797 left = Fcdr (Fassq (Qleft, parms));
10798 top = Fcdr (Fassq (Qtop, parms));
10800 /* Move the tooltip window where the mouse pointer is. Resize and
10801 show it. */
10802 BLOCK_INPUT;
10803 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
10804 &root, &child, &root_x, &root_y, &win_x, &win_y, &pmask);
10805 UNBLOCK_INPUT;
10807 root_x += XINT (dx);
10808 root_y += XINT (dy);
10810 if (INTEGERP (left))
10811 root_x = XINT (left);
10812 if (INTEGERP (top))
10813 root_y = XINT (top);
10815 BLOCK_INPUT;
10816 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10817 root_x, root_y - height, width, height);
10818 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
10819 UNBLOCK_INPUT;
10821 /* Draw into the window. */
10822 w->must_be_updated_p = 1;
10823 update_single_window (w, 1);
10825 /* Restore original current buffer. */
10826 set_buffer_internal_1 (old_buffer);
10827 windows_or_buffers_changed = old_windows_or_buffers_changed;
10829 /* Let the tip disappear after timeout seconds. */
10830 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
10831 intern ("x-hide-tip"));
10833 UNGCPRO;
10834 return unbind_to (count, Qnil);
10838 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
10839 "Hide the current tooltip window, if there is any.\n\
10840 Value is t is tooltip was open, nil otherwise.")
10843 int count;
10844 Lisp_Object deleted, frame, timer;
10845 struct gcpro gcpro1, gcpro2;
10847 /* Return quickly if nothing to do. */
10848 if (NILP (tip_timer) && NILP (tip_frame))
10849 return Qnil;
10851 frame = tip_frame;
10852 timer = tip_timer;
10853 GCPRO2 (frame, timer);
10854 tip_frame = tip_timer = deleted = Qnil;
10856 count = BINDING_STACK_SIZE ();
10857 specbind (Qinhibit_redisplay, Qt);
10858 specbind (Qinhibit_quit, Qt);
10860 if (!NILP (timer))
10861 call1 (intern ("cancel-timer"), timer);
10863 if (FRAMEP (frame))
10865 Fdelete_frame (frame, Qnil);
10866 deleted = Qt;
10868 #ifdef USE_LUCID
10869 /* Bloodcurdling hack alert: The Lucid menu bar widget's
10870 redisplay procedure is not called when a tip frame over menu
10871 items is unmapped. Redisplay the menu manually... */
10873 struct frame *f = SELECTED_FRAME ();
10874 Widget w = f->output_data.x->menubar_widget;
10875 extern void xlwmenu_redisplay P_ ((Widget));
10877 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
10878 && w != None)
10880 BLOCK_INPUT;
10881 xlwmenu_redisplay (w);
10882 UNBLOCK_INPUT;
10885 #endif /* USE_LUCID */
10888 UNGCPRO;
10889 return unbind_to (count, deleted);
10894 /***********************************************************************
10895 File selection dialog
10896 ***********************************************************************/
10898 #ifdef USE_MOTIF
10900 /* Callback for "OK" and "Cancel" on file selection dialog. */
10902 static void
10903 file_dialog_cb (widget, client_data, call_data)
10904 Widget widget;
10905 XtPointer call_data, client_data;
10907 int *result = (int *) client_data;
10908 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
10909 *result = cb->reason;
10913 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0,
10914 "Read file name, prompting with PROMPT in directory DIR.\n\
10915 Use a file selection dialog.\n\
10916 Select DEFAULT-FILENAME in the dialog's file selection box, if\n\
10917 specified. Don't let the user enter a file name in the file\n\
10918 selection dialog's entry field, if MUSTMATCH is non-nil.")
10919 (prompt, dir, default_filename, mustmatch)
10920 Lisp_Object prompt, dir, default_filename, mustmatch;
10922 int result;
10923 struct frame *f = SELECTED_FRAME ();
10924 Lisp_Object file = Qnil;
10925 Widget dialog, text, list, help;
10926 Arg al[10];
10927 int ac = 0;
10928 extern XtAppContext Xt_app_con;
10929 char *title;
10930 XmString dir_xmstring, pattern_xmstring;
10931 int popup_activated_flag;
10932 int count = specpdl_ptr - specpdl;
10933 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
10935 GCPRO5 (prompt, dir, default_filename, mustmatch, file);
10936 CHECK_STRING (prompt, 0);
10937 CHECK_STRING (dir, 1);
10939 /* Prevent redisplay. */
10940 specbind (Qinhibit_redisplay, Qt);
10942 BLOCK_INPUT;
10944 /* Create the dialog with PROMPT as title, using DIR as initial
10945 directory and using "*" as pattern. */
10946 dir = Fexpand_file_name (dir, Qnil);
10947 dir_xmstring = XmStringCreateLocalized (XSTRING (dir)->data);
10948 pattern_xmstring = XmStringCreateLocalized ("*");
10950 XtSetArg (al[ac], XmNtitle, XSTRING (prompt)->data); ++ac;
10951 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
10952 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
10953 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
10954 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
10955 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
10956 "fsb", al, ac);
10957 XmStringFree (dir_xmstring);
10958 XmStringFree (pattern_xmstring);
10960 /* Add callbacks for OK and Cancel. */
10961 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
10962 (XtPointer) &result);
10963 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
10964 (XtPointer) &result);
10966 /* Disable the help button since we can't display help. */
10967 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
10968 XtSetSensitive (help, False);
10970 /* Mark OK button as default. */
10971 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
10972 XmNshowAsDefault, True, NULL);
10974 /* If MUSTMATCH is non-nil, disable the file entry field of the
10975 dialog, so that the user must select a file from the files list
10976 box. We can't remove it because we wouldn't have a way to get at
10977 the result file name, then. */
10978 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
10979 if (!NILP (mustmatch))
10981 Widget label;
10982 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
10983 XtSetSensitive (text, False);
10984 XtSetSensitive (label, False);
10987 /* Manage the dialog, so that list boxes get filled. */
10988 XtManageChild (dialog);
10990 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
10991 must include the path for this to work. */
10992 list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
10993 if (STRINGP (default_filename))
10995 XmString default_xmstring;
10996 int item_pos;
10998 default_xmstring
10999 = XmStringCreateLocalized (XSTRING (default_filename)->data);
11001 if (!XmListItemExists (list, default_xmstring))
11003 /* Add a new item if DEFAULT_FILENAME is not in the list. */
11004 XmListAddItem (list, default_xmstring, 0);
11005 item_pos = 0;
11007 else
11008 item_pos = XmListItemPos (list, default_xmstring);
11009 XmStringFree (default_xmstring);
11011 /* Select the item and scroll it into view. */
11012 XmListSelectPos (list, item_pos, True);
11013 XmListSetPos (list, item_pos);
11016 #ifdef HAVE_MOTIF_2_1
11018 /* Process events until the user presses Cancel or OK. */
11019 result = 0;
11020 while (result == 0 || XtAppPending (Xt_app_con))
11021 XtAppProcessEvent (Xt_app_con, XtIMAll);
11023 #else /* not HAVE_MOTIF_2_1 */
11025 /* Process all events until the user presses Cancel or OK. */
11026 for (result = 0; result == 0;)
11028 XEvent event;
11029 Widget widget, parent;
11031 XtAppNextEvent (Xt_app_con, &event);
11033 /* See if the receiver of the event is one of the widgets of
11034 the file selection dialog. If so, dispatch it. If not,
11035 discard it. */
11036 widget = XtWindowToWidget (event.xany.display, event.xany.window);
11037 parent = widget;
11038 while (parent && parent != dialog)
11039 parent = XtParent (parent);
11041 if (parent == dialog
11042 || (event.type == Expose
11043 && !process_expose_from_menu (event)))
11044 XtDispatchEvent (&event);
11047 #endif /* not HAVE_MOTIF_2_1 */
11049 /* Get the result. */
11050 if (result == XmCR_OK)
11052 XmString text;
11053 String data;
11055 XtVaGetValues (dialog, XmNtextString, &text, NULL);
11056 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
11057 XmStringFree (text);
11058 file = build_string (data);
11059 XtFree (data);
11061 else
11062 file = Qnil;
11064 /* Clean up. */
11065 XtUnmanageChild (dialog);
11066 XtDestroyWidget (dialog);
11067 UNBLOCK_INPUT;
11068 UNGCPRO;
11070 /* Make "Cancel" equivalent to C-g. */
11071 if (NILP (file))
11072 Fsignal (Qquit, Qnil);
11074 return unbind_to (count, file);
11077 #endif /* USE_MOTIF */
11081 /***********************************************************************
11082 Keyboard
11083 ***********************************************************************/
11085 #ifdef HAVE_XKBGETKEYBOARD
11086 #include <X11/XKBlib.h>
11087 #include <X11/keysym.h>
11088 #endif
11090 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
11091 Sx_backspace_delete_keys_p, 0, 1, 0,
11092 "Check if both Backspace and Delete keys are on the keyboard of FRAME.\n\
11093 FRAME nil means use the selected frame.\n\
11094 Value is t if we know that both keys are present, and are mapped to the\n\
11095 usual X keysyms.")
11096 (frame)
11097 Lisp_Object frame;
11099 #ifdef HAVE_XKBGETKEYBOARD
11100 XkbDescPtr kb;
11101 struct frame *f = check_x_frame (frame);
11102 Display *dpy = FRAME_X_DISPLAY (f);
11103 Lisp_Object have_keys;
11104 int major, minor, op, event, error;
11106 BLOCK_INPUT;
11108 /* Check library version in case we're dynamically linked. */
11109 major = XkbMajorVersion;
11110 minor = XkbMinorVersion;
11111 if (!XkbLibraryVersion (&major, &minor))
11112 return Qnil;
11114 /* Check that the server supports XKB. */
11115 major = XkbMajorVersion;
11116 minor = XkbMinorVersion;
11117 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
11118 return Qnil;
11120 have_keys = Qnil;
11121 kb = XkbGetKeyboard (dpy, XkbAllComponentsMask, XkbUseCoreKbd);
11122 if (kb)
11124 int delete_keycode = 0, backspace_keycode = 0, i;
11126 for (i = kb->min_key_code;
11127 (i < kb->max_key_code
11128 && (delete_keycode == 0 || backspace_keycode == 0));
11129 ++i)
11131 /* The XKB symbolic key names can be seen most easily
11132 in the PS file generated by `xkbprint -label name $DISPLAY'. */
11133 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
11134 delete_keycode = i;
11135 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
11136 backspace_keycode = i;
11139 XkbFreeKeyboard (kb, 0, True);
11141 if (delete_keycode
11142 && backspace_keycode
11143 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
11144 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
11145 have_keys = Qt;
11147 UNBLOCK_INPUT;
11148 return have_keys;
11149 #else /* not HAVE_XKBGETKEYBOARD */
11150 return Qnil;
11151 #endif /* not HAVE_XKBGETKEYBOARD */
11156 /***********************************************************************
11157 Initialization
11158 ***********************************************************************/
11160 void
11161 syms_of_xfns ()
11163 /* This is zero if not using X windows. */
11164 x_in_use = 0;
11166 /* The section below is built by the lisp expression at the top of the file,
11167 just above where these variables are declared. */
11168 /*&&& init symbols here &&&*/
11169 Qauto_raise = intern ("auto-raise");
11170 staticpro (&Qauto_raise);
11171 Qauto_lower = intern ("auto-lower");
11172 staticpro (&Qauto_lower);
11173 Qbar = intern ("bar");
11174 staticpro (&Qbar);
11175 Qborder_color = intern ("border-color");
11176 staticpro (&Qborder_color);
11177 Qborder_width = intern ("border-width");
11178 staticpro (&Qborder_width);
11179 Qbox = intern ("box");
11180 staticpro (&Qbox);
11181 Qcursor_color = intern ("cursor-color");
11182 staticpro (&Qcursor_color);
11183 Qcursor_type = intern ("cursor-type");
11184 staticpro (&Qcursor_type);
11185 Qgeometry = intern ("geometry");
11186 staticpro (&Qgeometry);
11187 Qicon_left = intern ("icon-left");
11188 staticpro (&Qicon_left);
11189 Qicon_top = intern ("icon-top");
11190 staticpro (&Qicon_top);
11191 Qicon_type = intern ("icon-type");
11192 staticpro (&Qicon_type);
11193 Qicon_name = intern ("icon-name");
11194 staticpro (&Qicon_name);
11195 Qinternal_border_width = intern ("internal-border-width");
11196 staticpro (&Qinternal_border_width);
11197 Qleft = intern ("left");
11198 staticpro (&Qleft);
11199 Qright = intern ("right");
11200 staticpro (&Qright);
11201 Qmouse_color = intern ("mouse-color");
11202 staticpro (&Qmouse_color);
11203 Qnone = intern ("none");
11204 staticpro (&Qnone);
11205 Qparent_id = intern ("parent-id");
11206 staticpro (&Qparent_id);
11207 Qscroll_bar_width = intern ("scroll-bar-width");
11208 staticpro (&Qscroll_bar_width);
11209 Qsuppress_icon = intern ("suppress-icon");
11210 staticpro (&Qsuppress_icon);
11211 Qundefined_color = intern ("undefined-color");
11212 staticpro (&Qundefined_color);
11213 Qvertical_scroll_bars = intern ("vertical-scroll-bars");
11214 staticpro (&Qvertical_scroll_bars);
11215 Qvisibility = intern ("visibility");
11216 staticpro (&Qvisibility);
11217 Qwindow_id = intern ("window-id");
11218 staticpro (&Qwindow_id);
11219 Qouter_window_id = intern ("outer-window-id");
11220 staticpro (&Qouter_window_id);
11221 Qx_frame_parameter = intern ("x-frame-parameter");
11222 staticpro (&Qx_frame_parameter);
11223 Qx_resource_name = intern ("x-resource-name");
11224 staticpro (&Qx_resource_name);
11225 Quser_position = intern ("user-position");
11226 staticpro (&Quser_position);
11227 Quser_size = intern ("user-size");
11228 staticpro (&Quser_size);
11229 Qscroll_bar_foreground = intern ("scroll-bar-foreground");
11230 staticpro (&Qscroll_bar_foreground);
11231 Qscroll_bar_background = intern ("scroll-bar-background");
11232 staticpro (&Qscroll_bar_background);
11233 Qscreen_gamma = intern ("screen-gamma");
11234 staticpro (&Qscreen_gamma);
11235 Qline_spacing = intern ("line-spacing");
11236 staticpro (&Qline_spacing);
11237 Qcenter = intern ("center");
11238 staticpro (&Qcenter);
11239 Qcompound_text = intern ("compound-text");
11240 staticpro (&Qcompound_text);
11241 /* This is the end of symbol initialization. */
11243 /* Text property `display' should be nonsticky by default. */
11244 Vtext_property_default_nonsticky
11245 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
11248 Qlaplace = intern ("laplace");
11249 staticpro (&Qlaplace);
11250 Qemboss = intern ("emboss");
11251 staticpro (&Qemboss);
11252 Qedge_detection = intern ("edge-detection");
11253 staticpro (&Qedge_detection);
11254 Qheuristic = intern ("heuristic");
11255 staticpro (&Qheuristic);
11256 QCmatrix = intern (":matrix");
11257 staticpro (&QCmatrix);
11258 QCcolor_adjustment = intern (":color-adjustment");
11259 staticpro (&QCcolor_adjustment);
11260 QCmask = intern (":mask");
11261 staticpro (&QCmask);
11263 Qface_set_after_frame_default = intern ("face-set-after-frame-default");
11264 staticpro (&Qface_set_after_frame_default);
11266 Fput (Qundefined_color, Qerror_conditions,
11267 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
11268 Fput (Qundefined_color, Qerror_message,
11269 build_string ("Undefined color"));
11271 init_x_parm_symbols ();
11273 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
11274 "Non-nil means always draw a cross over disabled images.\n\
11275 Disabled images are those having an `:algorithm disabled' property.\n\
11276 A cross is always drawn on black & white displays.");
11277 cross_disabled_images = 0;
11279 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
11280 "List of directories to search for bitmap files for X.");
11281 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
11283 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
11284 "The shape of the pointer when over text.\n\
11285 Changing the value does not affect existing frames\n\
11286 unless you set the mouse color.");
11287 Vx_pointer_shape = Qnil;
11289 DEFVAR_LISP ("x-resource-name", &Vx_resource_name,
11290 "The name Emacs uses to look up X resources.\n\
11291 `x-get-resource' uses this as the first component of the instance name\n\
11292 when requesting resource values.\n\
11293 Emacs initially sets `x-resource-name' to the name under which Emacs\n\
11294 was invoked, or to the value specified with the `-name' or `-rn'\n\
11295 switches, if present.\n\
11297 It may be useful to bind this variable locally around a call\n\
11298 to `x-get-resource'. See also the variable `x-resource-class'.");
11299 Vx_resource_name = Qnil;
11301 DEFVAR_LISP ("x-resource-class", &Vx_resource_class,
11302 "The class Emacs uses to look up X resources.\n\
11303 `x-get-resource' uses this as the first component of the instance class\n\
11304 when requesting resource values.\n\
11305 Emacs initially sets `x-resource-class' to \"Emacs\".\n\
11307 Setting this variable permanently is not a reasonable thing to do,\n\
11308 but binding this variable locally around a call to `x-get-resource'\n\
11309 is a reasonable practice. See also the variable `x-resource-name'.");
11310 Vx_resource_class = build_string (EMACS_CLASS);
11312 #if 0 /* This doesn't really do anything. */
11313 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
11314 "The shape of the pointer when not over text.\n\
11315 This variable takes effect when you create a new frame\n\
11316 or when you set the mouse color.");
11317 #endif
11318 Vx_nontext_pointer_shape = Qnil;
11320 DEFVAR_LISP ("x-busy-pointer-shape", &Vx_busy_pointer_shape,
11321 "The shape of the pointer when Emacs is busy.\n\
11322 This variable takes effect when you create a new frame\n\
11323 or when you set the mouse color.");
11324 Vx_busy_pointer_shape = Qnil;
11326 DEFVAR_BOOL ("display-busy-cursor", &display_busy_cursor_p,
11327 "Non-zero means Emacs displays a busy cursor on window systems.");
11328 display_busy_cursor_p = 1;
11330 DEFVAR_LISP ("busy-cursor-delay", &Vbusy_cursor_delay,
11331 "*Seconds to wait before displaying a busy-cursor.\n\
11332 Value must be an integer or float.");
11333 Vbusy_cursor_delay = make_number (DEFAULT_BUSY_CURSOR_DELAY);
11335 #if 0 /* This doesn't really do anything. */
11336 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
11337 "The shape of the pointer when over the mode line.\n\
11338 This variable takes effect when you create a new frame\n\
11339 or when you set the mouse color.");
11340 #endif
11341 Vx_mode_pointer_shape = Qnil;
11343 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
11344 &Vx_sensitive_text_pointer_shape,
11345 "The shape of the pointer when over mouse-sensitive text.\n\
11346 This variable takes effect when you create a new frame\n\
11347 or when you set the mouse color.");
11348 Vx_sensitive_text_pointer_shape = Qnil;
11350 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
11351 &Vx_window_horizontal_drag_shape,
11352 "Pointer shape to use for indicating a window can be dragged horizontally.\n\
11353 This variable takes effect when you create a new frame\n\
11354 or when you set the mouse color.");
11355 Vx_window_horizontal_drag_shape = Qnil;
11357 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
11358 "A string indicating the foreground color of the cursor box.");
11359 Vx_cursor_fore_pixel = Qnil;
11361 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
11362 "Non-nil if no X window manager is in use.\n\
11363 Emacs doesn't try to figure this out; this is always nil\n\
11364 unless you set it to something else.");
11365 /* We don't have any way to find this out, so set it to nil
11366 and maybe the user would like to set it to t. */
11367 Vx_no_window_manager = Qnil;
11369 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
11370 &Vx_pixel_size_width_font_regexp,
11371 "Regexp matching a font name whose width is the same as `PIXEL_SIZE'.\n\
11373 Since Emacs gets width of a font matching with this regexp from\n\
11374 PIXEL_SIZE field of the name, font finding mechanism gets faster for\n\
11375 such a font. This is especially effective for such large fonts as\n\
11376 Chinese, Japanese, and Korean.");
11377 Vx_pixel_size_width_font_regexp = Qnil;
11379 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
11380 "Time after which cached images are removed from the cache.\n\
11381 When an image has not been displayed this many seconds, remove it\n\
11382 from the image cache. Value must be an integer or nil with nil\n\
11383 meaning don't clear the cache.");
11384 Vimage_cache_eviction_delay = make_number (30 * 60);
11386 #ifdef USE_X_TOOLKIT
11387 Fprovide (intern ("x-toolkit"));
11388 #endif
11389 #ifdef USE_MOTIF
11390 Fprovide (intern ("motif"));
11391 #endif
11393 defsubr (&Sx_get_resource);
11395 /* X window properties. */
11396 defsubr (&Sx_change_window_property);
11397 defsubr (&Sx_delete_window_property);
11398 defsubr (&Sx_window_property);
11400 defsubr (&Sxw_display_color_p);
11401 defsubr (&Sx_display_grayscale_p);
11402 defsubr (&Sxw_color_defined_p);
11403 defsubr (&Sxw_color_values);
11404 defsubr (&Sx_server_max_request_size);
11405 defsubr (&Sx_server_vendor);
11406 defsubr (&Sx_server_version);
11407 defsubr (&Sx_display_pixel_width);
11408 defsubr (&Sx_display_pixel_height);
11409 defsubr (&Sx_display_mm_width);
11410 defsubr (&Sx_display_mm_height);
11411 defsubr (&Sx_display_screens);
11412 defsubr (&Sx_display_planes);
11413 defsubr (&Sx_display_color_cells);
11414 defsubr (&Sx_display_visual_class);
11415 defsubr (&Sx_display_backing_store);
11416 defsubr (&Sx_display_save_under);
11417 defsubr (&Sx_parse_geometry);
11418 defsubr (&Sx_create_frame);
11419 defsubr (&Sx_open_connection);
11420 defsubr (&Sx_close_connection);
11421 defsubr (&Sx_display_list);
11422 defsubr (&Sx_synchronize);
11423 defsubr (&Sx_focus_frame);
11424 defsubr (&Sx_backspace_delete_keys_p);
11426 /* Setting callback functions for fontset handler. */
11427 get_font_info_func = x_get_font_info;
11429 #if 0 /* This function pointer doesn't seem to be used anywhere.
11430 And the pointer assigned has the wrong type, anyway. */
11431 list_fonts_func = x_list_fonts;
11432 #endif
11434 load_font_func = x_load_font;
11435 find_ccl_program_func = x_find_ccl_program;
11436 query_font_func = x_query_font;
11437 set_frame_fontset_func = x_set_font;
11438 check_window_system_func = check_x;
11440 /* Images. */
11441 Qxbm = intern ("xbm");
11442 staticpro (&Qxbm);
11443 QCtype = intern (":type");
11444 staticpro (&QCtype);
11445 QCalgorithm = intern (":algorithm");
11446 staticpro (&QCalgorithm);
11447 QCheuristic_mask = intern (":heuristic-mask");
11448 staticpro (&QCheuristic_mask);
11449 QCcolor_symbols = intern (":color-symbols");
11450 staticpro (&QCcolor_symbols);
11451 QCascent = intern (":ascent");
11452 staticpro (&QCascent);
11453 QCmargin = intern (":margin");
11454 staticpro (&QCmargin);
11455 QCrelief = intern (":relief");
11456 staticpro (&QCrelief);
11457 Qpostscript = intern ("postscript");
11458 staticpro (&Qpostscript);
11459 QCloader = intern (":loader");
11460 staticpro (&QCloader);
11461 QCbounding_box = intern (":bounding-box");
11462 staticpro (&QCbounding_box);
11463 QCpt_width = intern (":pt-width");
11464 staticpro (&QCpt_width);
11465 QCpt_height = intern (":pt-height");
11466 staticpro (&QCpt_height);
11467 QCindex = intern (":index");
11468 staticpro (&QCindex);
11469 Qpbm = intern ("pbm");
11470 staticpro (&Qpbm);
11472 #if HAVE_XPM
11473 Qxpm = intern ("xpm");
11474 staticpro (&Qxpm);
11475 #endif
11477 #if HAVE_JPEG
11478 Qjpeg = intern ("jpeg");
11479 staticpro (&Qjpeg);
11480 #endif
11482 #if HAVE_TIFF
11483 Qtiff = intern ("tiff");
11484 staticpro (&Qtiff);
11485 #endif
11487 #if HAVE_GIF
11488 Qgif = intern ("gif");
11489 staticpro (&Qgif);
11490 #endif
11492 #if HAVE_PNG
11493 Qpng = intern ("png");
11494 staticpro (&Qpng);
11495 #endif
11497 defsubr (&Sclear_image_cache);
11498 defsubr (&Simage_size);
11499 defsubr (&Simage_mask_p);
11501 busy_cursor_atimer = NULL;
11502 busy_cursor_shown_p = 0;
11504 defsubr (&Sx_show_tip);
11505 defsubr (&Sx_hide_tip);
11506 tip_timer = Qnil;
11507 staticpro (&tip_timer);
11508 tip_frame = Qnil;
11509 staticpro (&tip_frame);
11511 #ifdef USE_MOTIF
11512 defsubr (&Sx_file_dialog);
11513 #endif
11517 void
11518 init_xfns ()
11520 image_types = NULL;
11521 Vimage_types = Qnil;
11523 define_image_type (&xbm_type);
11524 define_image_type (&gs_type);
11525 define_image_type (&pbm_type);
11527 #if HAVE_XPM
11528 define_image_type (&xpm_type);
11529 #endif
11531 #if HAVE_JPEG
11532 define_image_type (&jpeg_type);
11533 #endif
11535 #if HAVE_TIFF
11536 define_image_type (&tiff_type);
11537 #endif
11539 #if HAVE_GIF
11540 define_image_type (&gif_type);
11541 #endif
11543 #if HAVE_PNG
11544 define_image_type (&png_type);
11545 #endif
11548 #endif /* HAVE_X_WINDOWS */