(Fx_create_frame): Initialize frame colors to -1,
[emacs.git] / src / xfns.c
blob0d66c03e23567f3ea118fbab7953088d347809fb
1 /* Functions for the X window system.
2 Copyright (C) 1989, 92, 93, 94, 95, 96, 1997, 1998, 1999, 2000, 2001
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 #ifdef USE_MOTIF
112 /* LessTif/Motif version info. */
114 static Lisp_Object Vmotif_version_string;
116 #endif /* USE_MOTIF */
118 #endif /* USE_X_TOOLKIT */
120 #define min(a,b) ((a) < (b) ? (a) : (b))
121 #define max(a,b) ((a) > (b) ? (a) : (b))
123 #ifdef HAVE_X11R4
124 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
125 #else
126 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
127 #endif
129 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
130 it, and including `bitmaps/gray' more than once is a problem when
131 config.h defines `static' as an empty replacement string. */
133 int gray_bitmap_width = gray_width;
134 int gray_bitmap_height = gray_height;
135 char *gray_bitmap_bits = gray_bits;
137 /* The name we're using in resource queries. Most often "emacs". */
139 Lisp_Object Vx_resource_name;
141 /* The application class we're using in resource queries.
142 Normally "Emacs". */
144 Lisp_Object Vx_resource_class;
146 /* Non-zero means we're allowed to display an hourglass cursor. */
148 int display_hourglass_p;
150 /* The background and shape of the mouse pointer, and shape when not
151 over text or in the modeline. */
153 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
154 Lisp_Object Vx_hourglass_pointer_shape;
156 /* The shape when over mouse-sensitive text. */
158 Lisp_Object Vx_sensitive_text_pointer_shape;
160 /* If non-nil, the pointer shape to indicate that windows can be
161 dragged horizontally. */
163 Lisp_Object Vx_window_horizontal_drag_shape;
165 /* Color of chars displayed in cursor box. */
167 Lisp_Object Vx_cursor_fore_pixel;
169 /* Nonzero if using X. */
171 static int x_in_use;
173 /* Non nil if no window manager is in use. */
175 Lisp_Object Vx_no_window_manager;
177 /* Search path for bitmap files. */
179 Lisp_Object Vx_bitmap_file_path;
181 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
183 Lisp_Object Vx_pixel_size_width_font_regexp;
185 Lisp_Object Qauto_raise;
186 Lisp_Object Qauto_lower;
187 Lisp_Object Qbar;
188 Lisp_Object Qborder_color;
189 Lisp_Object Qborder_width;
190 Lisp_Object Qbox;
191 Lisp_Object Qcursor_color;
192 Lisp_Object Qcursor_type;
193 Lisp_Object Qgeometry;
194 Lisp_Object Qicon_left;
195 Lisp_Object Qicon_top;
196 Lisp_Object Qicon_type;
197 Lisp_Object Qicon_name;
198 Lisp_Object Qinternal_border_width;
199 Lisp_Object Qleft;
200 Lisp_Object Qright;
201 Lisp_Object Qmouse_color;
202 Lisp_Object Qnone;
203 Lisp_Object Qouter_window_id;
204 Lisp_Object Qparent_id;
205 Lisp_Object Qscroll_bar_width;
206 Lisp_Object Qsuppress_icon;
207 extern Lisp_Object Qtop;
208 Lisp_Object Qundefined_color;
209 Lisp_Object Qvertical_scroll_bars;
210 Lisp_Object Qvisibility;
211 Lisp_Object Qwindow_id;
212 Lisp_Object Qx_frame_parameter;
213 Lisp_Object Qx_resource_name;
214 Lisp_Object Quser_position;
215 Lisp_Object Quser_size;
216 extern Lisp_Object Qdisplay;
217 Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
218 Lisp_Object Qscreen_gamma, Qline_spacing, Qcenter;
219 Lisp_Object Qcompound_text, Qcancel_timer;
220 Lisp_Object Qwait_for_wm;
222 /* The below are defined in frame.c. */
224 extern Lisp_Object Qheight, Qminibuffer, Qname, Qonly, Qwidth;
225 extern Lisp_Object Qunsplittable, Qmenu_bar_lines, Qbuffer_predicate, Qtitle;
226 extern Lisp_Object Qtool_bar_lines;
228 extern Lisp_Object Vwindow_system_version;
230 Lisp_Object Qface_set_after_frame_default;
232 #if GLYPH_DEBUG
233 int image_cache_refcount, dpyinfo_refcount;
234 #endif
238 /* Error if we are not connected to X. */
240 void
241 check_x ()
243 if (! x_in_use)
244 error ("X windows are not in use or not initialized");
247 /* Nonzero if we can use mouse menus.
248 You should not call this unless HAVE_MENUS is defined. */
251 have_menus_p ()
253 return x_in_use;
256 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
257 and checking validity for X. */
259 FRAME_PTR
260 check_x_frame (frame)
261 Lisp_Object frame;
263 FRAME_PTR f;
265 if (NILP (frame))
266 frame = selected_frame;
267 CHECK_LIVE_FRAME (frame, 0);
268 f = XFRAME (frame);
269 if (! FRAME_X_P (f))
270 error ("Non-X frame used");
271 return f;
274 /* Let the user specify an X display with a frame.
275 nil stands for the selected frame--or, if that is not an X frame,
276 the first X display on the list. */
278 static struct x_display_info *
279 check_x_display_info (frame)
280 Lisp_Object frame;
282 struct x_display_info *dpyinfo = NULL;
284 if (NILP (frame))
286 struct frame *sf = XFRAME (selected_frame);
288 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
289 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
290 else if (x_display_list != 0)
291 dpyinfo = x_display_list;
292 else
293 error ("X windows are not in use or not initialized");
295 else if (STRINGP (frame))
296 dpyinfo = x_display_info_for_name (frame);
297 else
299 FRAME_PTR f;
301 CHECK_LIVE_FRAME (frame, 0);
302 f = XFRAME (frame);
303 if (! FRAME_X_P (f))
304 error ("Non-X frame used");
305 dpyinfo = FRAME_X_DISPLAY_INFO (f);
308 return dpyinfo;
312 /* Return the Emacs frame-object corresponding to an X window.
313 It could be the frame's main window or an icon window. */
315 /* This function can be called during GC, so use GC_xxx type test macros. */
317 struct frame *
318 x_window_to_frame (dpyinfo, wdesc)
319 struct x_display_info *dpyinfo;
320 int wdesc;
322 Lisp_Object tail, frame;
323 struct frame *f;
325 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
327 frame = XCAR (tail);
328 if (!GC_FRAMEP (frame))
329 continue;
330 f = XFRAME (frame);
331 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
332 continue;
333 if (f->output_data.x->hourglass_window == wdesc)
334 return f;
335 #ifdef USE_X_TOOLKIT
336 if ((f->output_data.x->edit_widget
337 && XtWindow (f->output_data.x->edit_widget) == wdesc)
338 /* A tooltip frame? */
339 || (!f->output_data.x->edit_widget
340 && FRAME_X_WINDOW (f) == wdesc)
341 || f->output_data.x->icon_desc == wdesc)
342 return f;
343 #else /* not USE_X_TOOLKIT */
344 if (FRAME_X_WINDOW (f) == wdesc
345 || f->output_data.x->icon_desc == wdesc)
346 return f;
347 #endif /* not USE_X_TOOLKIT */
349 return 0;
352 #ifdef USE_X_TOOLKIT
353 /* Like x_window_to_frame but also compares the window with the widget's
354 windows. */
356 struct frame *
357 x_any_window_to_frame (dpyinfo, wdesc)
358 struct x_display_info *dpyinfo;
359 int wdesc;
361 Lisp_Object tail, frame;
362 struct frame *f, *found;
363 struct x_output *x;
365 found = NULL;
366 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
368 frame = XCAR (tail);
369 if (!GC_FRAMEP (frame))
370 continue;
372 f = XFRAME (frame);
373 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
375 /* This frame matches if the window is any of its widgets. */
376 x = f->output_data.x;
377 if (x->hourglass_window == wdesc)
378 found = f;
379 else if (x->widget)
381 if (wdesc == XtWindow (x->widget)
382 || wdesc == XtWindow (x->column_widget)
383 || wdesc == XtWindow (x->edit_widget))
384 found = f;
385 /* Match if the window is this frame's menubar. */
386 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
387 found = f;
389 else if (FRAME_X_WINDOW (f) == wdesc)
390 /* A tooltip frame. */
391 found = f;
395 return found;
398 /* Likewise, but exclude the menu bar widget. */
400 struct frame *
401 x_non_menubar_window_to_frame (dpyinfo, wdesc)
402 struct x_display_info *dpyinfo;
403 int wdesc;
405 Lisp_Object tail, frame;
406 struct frame *f;
407 struct x_output *x;
409 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
411 frame = XCAR (tail);
412 if (!GC_FRAMEP (frame))
413 continue;
414 f = XFRAME (frame);
415 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
416 continue;
417 x = f->output_data.x;
418 /* This frame matches if the window is any of its widgets. */
419 if (x->hourglass_window == wdesc)
420 return f;
421 else if (x->widget)
423 if (wdesc == XtWindow (x->widget)
424 || wdesc == XtWindow (x->column_widget)
425 || wdesc == XtWindow (x->edit_widget))
426 return f;
428 else if (FRAME_X_WINDOW (f) == wdesc)
429 /* A tooltip frame. */
430 return f;
432 return 0;
435 /* Likewise, but consider only the menu bar widget. */
437 struct frame *
438 x_menubar_window_to_frame (dpyinfo, wdesc)
439 struct x_display_info *dpyinfo;
440 int wdesc;
442 Lisp_Object tail, frame;
443 struct frame *f;
444 struct x_output *x;
446 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
448 frame = XCAR (tail);
449 if (!GC_FRAMEP (frame))
450 continue;
451 f = XFRAME (frame);
452 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
453 continue;
454 x = f->output_data.x;
455 /* Match if the window is this frame's menubar. */
456 if (x->menubar_widget
457 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
458 return f;
460 return 0;
463 /* Return the frame whose principal (outermost) window is WDESC.
464 If WDESC is some other (smaller) window, we return 0. */
466 struct frame *
467 x_top_window_to_frame (dpyinfo, wdesc)
468 struct x_display_info *dpyinfo;
469 int wdesc;
471 Lisp_Object tail, frame;
472 struct frame *f;
473 struct x_output *x;
475 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
477 frame = XCAR (tail);
478 if (!GC_FRAMEP (frame))
479 continue;
480 f = XFRAME (frame);
481 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
482 continue;
483 x = f->output_data.x;
485 if (x->widget)
487 /* This frame matches if the window is its topmost widget. */
488 if (wdesc == XtWindow (x->widget))
489 return f;
490 #if 0 /* I don't know why it did this,
491 but it seems logically wrong,
492 and it causes trouble for MapNotify events. */
493 /* Match if the window is this frame's menubar. */
494 if (x->menubar_widget
495 && wdesc == XtWindow (x->menubar_widget))
496 return f;
497 #endif
499 else if (FRAME_X_WINDOW (f) == wdesc)
500 /* Tooltip frame. */
501 return f;
503 return 0;
505 #endif /* USE_X_TOOLKIT */
509 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
510 id, which is just an int that this section returns. Bitmaps are
511 reference counted so they can be shared among frames.
513 Bitmap indices are guaranteed to be > 0, so a negative number can
514 be used to indicate no bitmap.
516 If you use x_create_bitmap_from_data, then you must keep track of
517 the bitmaps yourself. That is, creating a bitmap from the same
518 data more than once will not be caught. */
521 /* Functions to access the contents of a bitmap, given an id. */
524 x_bitmap_height (f, id)
525 FRAME_PTR f;
526 int id;
528 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
532 x_bitmap_width (f, id)
533 FRAME_PTR f;
534 int id;
536 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
540 x_bitmap_pixmap (f, id)
541 FRAME_PTR f;
542 int id;
544 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
548 /* Allocate a new bitmap record. Returns index of new record. */
550 static int
551 x_allocate_bitmap_record (f)
552 FRAME_PTR f;
554 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
555 int i;
557 if (dpyinfo->bitmaps == NULL)
559 dpyinfo->bitmaps_size = 10;
560 dpyinfo->bitmaps
561 = (struct x_bitmap_record *) xmalloc (dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
562 dpyinfo->bitmaps_last = 1;
563 return 1;
566 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
567 return ++dpyinfo->bitmaps_last;
569 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
570 if (dpyinfo->bitmaps[i].refcount == 0)
571 return i + 1;
573 dpyinfo->bitmaps_size *= 2;
574 dpyinfo->bitmaps
575 = (struct x_bitmap_record *) xrealloc (dpyinfo->bitmaps,
576 dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
577 return ++dpyinfo->bitmaps_last;
580 /* Add one reference to the reference count of the bitmap with id ID. */
582 void
583 x_reference_bitmap (f, id)
584 FRAME_PTR f;
585 int id;
587 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
590 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
593 x_create_bitmap_from_data (f, bits, width, height)
594 struct frame *f;
595 char *bits;
596 unsigned int width, height;
598 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
599 Pixmap bitmap;
600 int id;
602 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
603 bits, width, height);
605 if (! bitmap)
606 return -1;
608 id = x_allocate_bitmap_record (f);
609 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
610 dpyinfo->bitmaps[id - 1].file = NULL;
611 dpyinfo->bitmaps[id - 1].refcount = 1;
612 dpyinfo->bitmaps[id - 1].depth = 1;
613 dpyinfo->bitmaps[id - 1].height = height;
614 dpyinfo->bitmaps[id - 1].width = width;
616 return id;
619 /* Create bitmap from file FILE for frame F. */
622 x_create_bitmap_from_file (f, file)
623 struct frame *f;
624 Lisp_Object file;
626 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
627 unsigned int width, height;
628 Pixmap bitmap;
629 int xhot, yhot, result, id;
630 Lisp_Object found;
631 int fd;
632 char *filename;
634 /* Look for an existing bitmap with the same name. */
635 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
637 if (dpyinfo->bitmaps[id].refcount
638 && dpyinfo->bitmaps[id].file
639 && !strcmp (dpyinfo->bitmaps[id].file, (char *) XSTRING (file)->data))
641 ++dpyinfo->bitmaps[id].refcount;
642 return id + 1;
646 /* Search bitmap-file-path for the file, if appropriate. */
647 fd = openp (Vx_bitmap_file_path, file, "", &found, 0);
648 if (fd < 0)
649 return -1;
650 emacs_close (fd);
652 filename = (char *) XSTRING (found)->data;
654 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
655 filename, &width, &height, &bitmap, &xhot, &yhot);
656 if (result != BitmapSuccess)
657 return -1;
659 id = x_allocate_bitmap_record (f);
660 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
661 dpyinfo->bitmaps[id - 1].refcount = 1;
662 dpyinfo->bitmaps[id - 1].file
663 = (char *) xmalloc (STRING_BYTES (XSTRING (file)) + 1);
664 dpyinfo->bitmaps[id - 1].depth = 1;
665 dpyinfo->bitmaps[id - 1].height = height;
666 dpyinfo->bitmaps[id - 1].width = width;
667 strcpy (dpyinfo->bitmaps[id - 1].file, XSTRING (file)->data);
669 return id;
672 /* Remove reference to bitmap with id number ID. */
674 void
675 x_destroy_bitmap (f, id)
676 FRAME_PTR f;
677 int id;
679 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
681 if (id > 0)
683 --dpyinfo->bitmaps[id - 1].refcount;
684 if (dpyinfo->bitmaps[id - 1].refcount == 0)
686 BLOCK_INPUT;
687 XFreePixmap (FRAME_X_DISPLAY (f), dpyinfo->bitmaps[id - 1].pixmap);
688 if (dpyinfo->bitmaps[id - 1].file)
690 xfree (dpyinfo->bitmaps[id - 1].file);
691 dpyinfo->bitmaps[id - 1].file = NULL;
693 UNBLOCK_INPUT;
698 /* Free all the bitmaps for the display specified by DPYINFO. */
700 static void
701 x_destroy_all_bitmaps (dpyinfo)
702 struct x_display_info *dpyinfo;
704 int i;
705 for (i = 0; i < dpyinfo->bitmaps_last; i++)
706 if (dpyinfo->bitmaps[i].refcount > 0)
708 XFreePixmap (dpyinfo->display, dpyinfo->bitmaps[i].pixmap);
709 if (dpyinfo->bitmaps[i].file)
710 xfree (dpyinfo->bitmaps[i].file);
712 dpyinfo->bitmaps_last = 0;
715 /* Connect the frame-parameter names for X frames
716 to the ways of passing the parameter values to the window system.
718 The name of a parameter, as a Lisp symbol,
719 has an `x-frame-parameter' property which is an integer in Lisp
720 that is an index in this table. */
722 struct x_frame_parm_table
724 char *name;
725 void (*setter) P_ ((struct frame *, Lisp_Object, Lisp_Object));
728 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
729 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
730 static void x_change_window_heights P_ ((Lisp_Object, int));
731 static void x_disable_image P_ ((struct frame *, struct image *));
732 static void x_create_im P_ ((struct frame *));
733 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
734 static void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
735 static void x_set_wait_for_wm P_ ((struct frame *, Lisp_Object, Lisp_Object));
736 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
737 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
738 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
739 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
740 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
741 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
742 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
743 void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
744 void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
745 void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
746 Lisp_Object));
747 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
748 void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
749 void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
750 void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
751 Lisp_Object));
752 void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
753 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
754 void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
755 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
756 void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
757 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
758 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
759 Lisp_Object));
760 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
761 Lisp_Object));
762 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
763 Lisp_Object,
764 Lisp_Object,
765 char *, char *,
766 int));
767 static void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
768 static void x_edge_detection P_ ((struct frame *, struct image *, Lisp_Object,
769 Lisp_Object));
770 static void init_color_table P_ ((void));
771 static void free_color_table P_ ((void));
772 static unsigned long *colors_in_color_table P_ ((int *n));
773 static unsigned long lookup_rgb_color P_ ((struct frame *f, int r, int g, int b));
774 static unsigned long lookup_pixel_color P_ ((struct frame *f, unsigned long p));
778 static struct x_frame_parm_table x_frame_parms[] =
780 "auto-raise", x_set_autoraise,
781 "auto-lower", x_set_autolower,
782 "background-color", x_set_background_color,
783 "border-color", x_set_border_color,
784 "border-width", x_set_border_width,
785 "cursor-color", x_set_cursor_color,
786 "cursor-type", x_set_cursor_type,
787 "font", x_set_font,
788 "foreground-color", x_set_foreground_color,
789 "icon-name", x_set_icon_name,
790 "icon-type", x_set_icon_type,
791 "internal-border-width", x_set_internal_border_width,
792 "menu-bar-lines", x_set_menu_bar_lines,
793 "mouse-color", x_set_mouse_color,
794 "name", x_explicitly_set_name,
795 "scroll-bar-width", x_set_scroll_bar_width,
796 "title", x_set_title,
797 "unsplittable", x_set_unsplittable,
798 "vertical-scroll-bars", x_set_vertical_scroll_bars,
799 "visibility", x_set_visibility,
800 "tool-bar-lines", x_set_tool_bar_lines,
801 "scroll-bar-foreground", x_set_scroll_bar_foreground,
802 "scroll-bar-background", x_set_scroll_bar_background,
803 "screen-gamma", x_set_screen_gamma,
804 "line-spacing", x_set_line_spacing,
805 "wait-for-wm", x_set_wait_for_wm
808 /* Attach the `x-frame-parameter' properties to
809 the Lisp symbol names of parameters relevant to X. */
811 void
812 init_x_parm_symbols ()
814 int i;
816 for (i = 0; i < sizeof (x_frame_parms) / sizeof (x_frame_parms[0]); i++)
817 Fput (intern (x_frame_parms[i].name), Qx_frame_parameter,
818 make_number (i));
821 /* Change the parameters of frame F as specified by ALIST.
822 If a parameter is not specially recognized, do nothing special;
823 otherwise call the `x_set_...' function for that parameter.
824 Except for certain geometry properties, always call store_frame_param
825 to store the new value in the parameter alist. */
827 void
828 x_set_frame_parameters (f, alist)
829 FRAME_PTR f;
830 Lisp_Object alist;
832 Lisp_Object tail;
834 /* If both of these parameters are present, it's more efficient to
835 set them both at once. So we wait until we've looked at the
836 entire list before we set them. */
837 int width, height;
839 /* Same here. */
840 Lisp_Object left, top;
842 /* Same with these. */
843 Lisp_Object icon_left, icon_top;
845 /* Record in these vectors all the parms specified. */
846 Lisp_Object *parms;
847 Lisp_Object *values;
848 int i, p;
849 int left_no_change = 0, top_no_change = 0;
850 int icon_left_no_change = 0, icon_top_no_change = 0;
852 struct gcpro gcpro1, gcpro2;
854 i = 0;
855 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
856 i++;
858 parms = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
859 values = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
861 /* Extract parm names and values into those vectors. */
863 i = 0;
864 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
866 Lisp_Object elt;
868 elt = Fcar (tail);
869 parms[i] = Fcar (elt);
870 values[i] = Fcdr (elt);
871 i++;
873 /* TAIL and ALIST are not used again below here. */
874 alist = tail = Qnil;
876 GCPRO2 (*parms, *values);
877 gcpro1.nvars = i;
878 gcpro2.nvars = i;
880 /* There is no need to gcpro LEFT, TOP, ICON_LEFT, or ICON_TOP,
881 because their values appear in VALUES and strings are not valid. */
882 top = left = Qunbound;
883 icon_left = icon_top = Qunbound;
885 /* Provide default values for HEIGHT and WIDTH. */
886 if (FRAME_NEW_WIDTH (f))
887 width = FRAME_NEW_WIDTH (f);
888 else
889 width = FRAME_WIDTH (f);
891 if (FRAME_NEW_HEIGHT (f))
892 height = FRAME_NEW_HEIGHT (f);
893 else
894 height = FRAME_HEIGHT (f);
896 /* Process foreground_color and background_color before anything else.
897 They are independent of other properties, but other properties (e.g.,
898 cursor_color) are dependent upon them. */
899 for (p = 0; p < i; p++)
901 Lisp_Object prop, val;
903 prop = parms[p];
904 val = values[p];
905 if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
907 register Lisp_Object param_index, old_value;
909 param_index = Fget (prop, Qx_frame_parameter);
910 old_value = get_frame_param (f, prop);
911 store_frame_param (f, prop, val);
912 if (NATNUMP (param_index)
913 && (XFASTINT (param_index)
914 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
915 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
919 /* Now process them in reverse of specified order. */
920 for (i--; i >= 0; i--)
922 Lisp_Object prop, val;
924 prop = parms[i];
925 val = values[i];
927 if (EQ (prop, Qwidth) && NUMBERP (val))
928 width = XFASTINT (val);
929 else if (EQ (prop, Qheight) && NUMBERP (val))
930 height = XFASTINT (val);
931 else if (EQ (prop, Qtop))
932 top = val;
933 else if (EQ (prop, Qleft))
934 left = val;
935 else if (EQ (prop, Qicon_top))
936 icon_top = val;
937 else if (EQ (prop, Qicon_left))
938 icon_left = val;
939 else if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
940 /* Processed above. */
941 continue;
942 else
944 register Lisp_Object param_index, old_value;
946 param_index = Fget (prop, Qx_frame_parameter);
947 old_value = get_frame_param (f, prop);
948 store_frame_param (f, prop, val);
949 if (NATNUMP (param_index)
950 && (XFASTINT (param_index)
951 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
952 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
956 /* Don't die if just one of these was set. */
957 if (EQ (left, Qunbound))
959 left_no_change = 1;
960 if (f->output_data.x->left_pos < 0)
961 left = Fcons (Qplus, Fcons (make_number (f->output_data.x->left_pos), Qnil));
962 else
963 XSETINT (left, f->output_data.x->left_pos);
965 if (EQ (top, Qunbound))
967 top_no_change = 1;
968 if (f->output_data.x->top_pos < 0)
969 top = Fcons (Qplus, Fcons (make_number (f->output_data.x->top_pos), Qnil));
970 else
971 XSETINT (top, f->output_data.x->top_pos);
974 /* If one of the icon positions was not set, preserve or default it. */
975 if (EQ (icon_left, Qunbound) || ! INTEGERP (icon_left))
977 icon_left_no_change = 1;
978 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
979 if (NILP (icon_left))
980 XSETINT (icon_left, 0);
982 if (EQ (icon_top, Qunbound) || ! INTEGERP (icon_top))
984 icon_top_no_change = 1;
985 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
986 if (NILP (icon_top))
987 XSETINT (icon_top, 0);
990 /* Don't set these parameters unless they've been explicitly
991 specified. The window might be mapped or resized while we're in
992 this function, and we don't want to override that unless the lisp
993 code has asked for it.
995 Don't set these parameters unless they actually differ from the
996 window's current parameters; the window may not actually exist
997 yet. */
999 Lisp_Object frame;
1001 check_frame_size (f, &height, &width);
1003 XSETFRAME (frame, f);
1005 if (width != FRAME_WIDTH (f)
1006 || height != FRAME_HEIGHT (f)
1007 || FRAME_NEW_HEIGHT (f) || FRAME_NEW_WIDTH (f))
1008 Fset_frame_size (frame, make_number (width), make_number (height));
1010 if ((!NILP (left) || !NILP (top))
1011 && ! (left_no_change && top_no_change)
1012 && ! (NUMBERP (left) && XINT (left) == f->output_data.x->left_pos
1013 && NUMBERP (top) && XINT (top) == f->output_data.x->top_pos))
1015 int leftpos = 0;
1016 int toppos = 0;
1018 /* Record the signs. */
1019 f->output_data.x->size_hint_flags &= ~ (XNegative | YNegative);
1020 if (EQ (left, Qminus))
1021 f->output_data.x->size_hint_flags |= XNegative;
1022 else if (INTEGERP (left))
1024 leftpos = XINT (left);
1025 if (leftpos < 0)
1026 f->output_data.x->size_hint_flags |= XNegative;
1028 else if (CONSP (left) && EQ (XCAR (left), Qminus)
1029 && CONSP (XCDR (left))
1030 && INTEGERP (XCAR (XCDR (left))))
1032 leftpos = - XINT (XCAR (XCDR (left)));
1033 f->output_data.x->size_hint_flags |= XNegative;
1035 else if (CONSP (left) && EQ (XCAR (left), Qplus)
1036 && CONSP (XCDR (left))
1037 && INTEGERP (XCAR (XCDR (left))))
1039 leftpos = XINT (XCAR (XCDR (left)));
1042 if (EQ (top, Qminus))
1043 f->output_data.x->size_hint_flags |= YNegative;
1044 else if (INTEGERP (top))
1046 toppos = XINT (top);
1047 if (toppos < 0)
1048 f->output_data.x->size_hint_flags |= YNegative;
1050 else if (CONSP (top) && EQ (XCAR (top), Qminus)
1051 && CONSP (XCDR (top))
1052 && INTEGERP (XCAR (XCDR (top))))
1054 toppos = - XINT (XCAR (XCDR (top)));
1055 f->output_data.x->size_hint_flags |= YNegative;
1057 else if (CONSP (top) && EQ (XCAR (top), Qplus)
1058 && CONSP (XCDR (top))
1059 && INTEGERP (XCAR (XCDR (top))))
1061 toppos = XINT (XCAR (XCDR (top)));
1065 /* Store the numeric value of the position. */
1066 f->output_data.x->top_pos = toppos;
1067 f->output_data.x->left_pos = leftpos;
1069 f->output_data.x->win_gravity = NorthWestGravity;
1071 /* Actually set that position, and convert to absolute. */
1072 x_set_offset (f, leftpos, toppos, -1);
1075 if ((!NILP (icon_left) || !NILP (icon_top))
1076 && ! (icon_left_no_change && icon_top_no_change))
1077 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
1080 UNGCPRO;
1083 /* Store the screen positions of frame F into XPTR and YPTR.
1084 These are the positions of the containing window manager window,
1085 not Emacs's own window. */
1087 void
1088 x_real_positions (f, xptr, yptr)
1089 FRAME_PTR f;
1090 int *xptr, *yptr;
1092 int win_x, win_y;
1093 Window child;
1095 /* This is pretty gross, but seems to be the easiest way out of
1096 the problem that arises when restarting window-managers. */
1098 #ifdef USE_X_TOOLKIT
1099 Window outer = (f->output_data.x->widget
1100 ? XtWindow (f->output_data.x->widget)
1101 : FRAME_X_WINDOW (f));
1102 #else
1103 Window outer = f->output_data.x->window_desc;
1104 #endif
1105 Window tmp_root_window;
1106 Window *tmp_children;
1107 unsigned int tmp_nchildren;
1109 while (1)
1111 int count = x_catch_errors (FRAME_X_DISPLAY (f));
1112 Window outer_window;
1114 XQueryTree (FRAME_X_DISPLAY (f), outer, &tmp_root_window,
1115 &f->output_data.x->parent_desc,
1116 &tmp_children, &tmp_nchildren);
1117 XFree ((char *) tmp_children);
1119 win_x = win_y = 0;
1121 /* Find the position of the outside upper-left corner of
1122 the inner window, with respect to the outer window. */
1123 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
1124 outer_window = f->output_data.x->parent_desc;
1125 else
1126 outer_window = outer;
1128 XTranslateCoordinates (FRAME_X_DISPLAY (f),
1130 /* From-window, to-window. */
1131 outer_window,
1132 FRAME_X_DISPLAY_INFO (f)->root_window,
1134 /* From-position, to-position. */
1135 0, 0, &win_x, &win_y,
1137 /* Child of win. */
1138 &child);
1140 /* It is possible for the window returned by the XQueryNotify
1141 to become invalid by the time we call XTranslateCoordinates.
1142 That can happen when you restart some window managers.
1143 If so, we get an error in XTranslateCoordinates.
1144 Detect that and try the whole thing over. */
1145 if (! x_had_errors_p (FRAME_X_DISPLAY (f)))
1147 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1148 break;
1151 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1154 *xptr = win_x;
1155 *yptr = win_y;
1158 /* Insert a description of internally-recorded parameters of frame X
1159 into the parameter alist *ALISTPTR that is to be given to the user.
1160 Only parameters that are specific to the X window system
1161 and whose values are not correctly recorded in the frame's
1162 param_alist need to be considered here. */
1164 void
1165 x_report_frame_params (f, alistptr)
1166 struct frame *f;
1167 Lisp_Object *alistptr;
1169 char buf[16];
1170 Lisp_Object tem;
1172 /* Represent negative positions (off the top or left screen edge)
1173 in a way that Fmodify_frame_parameters will understand correctly. */
1174 XSETINT (tem, f->output_data.x->left_pos);
1175 if (f->output_data.x->left_pos >= 0)
1176 store_in_alist (alistptr, Qleft, tem);
1177 else
1178 store_in_alist (alistptr, Qleft, Fcons (Qplus, Fcons (tem, Qnil)));
1180 XSETINT (tem, f->output_data.x->top_pos);
1181 if (f->output_data.x->top_pos >= 0)
1182 store_in_alist (alistptr, Qtop, tem);
1183 else
1184 store_in_alist (alistptr, Qtop, Fcons (Qplus, Fcons (tem, Qnil)));
1186 store_in_alist (alistptr, Qborder_width,
1187 make_number (f->output_data.x->border_width));
1188 store_in_alist (alistptr, Qinternal_border_width,
1189 make_number (f->output_data.x->internal_border_width));
1190 sprintf (buf, "%ld", (long) FRAME_X_WINDOW (f));
1191 store_in_alist (alistptr, Qwindow_id,
1192 build_string (buf));
1193 #ifdef USE_X_TOOLKIT
1194 /* Tooltip frame may not have this widget. */
1195 if (f->output_data.x->widget)
1196 #endif
1197 sprintf (buf, "%ld", (long) FRAME_OUTER_WINDOW (f));
1198 store_in_alist (alistptr, Qouter_window_id,
1199 build_string (buf));
1200 store_in_alist (alistptr, Qicon_name, f->icon_name);
1201 FRAME_SAMPLE_VISIBILITY (f);
1202 store_in_alist (alistptr, Qvisibility,
1203 (FRAME_VISIBLE_P (f) ? Qt
1204 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
1205 store_in_alist (alistptr, Qdisplay,
1206 XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element));
1208 if (f->output_data.x->parent_desc == FRAME_X_DISPLAY_INFO (f)->root_window)
1209 tem = Qnil;
1210 else
1211 XSETFASTINT (tem, f->output_data.x->parent_desc);
1212 store_in_alist (alistptr, Qparent_id, tem);
1217 /* Gamma-correct COLOR on frame F. */
1219 void
1220 gamma_correct (f, color)
1221 struct frame *f;
1222 XColor *color;
1224 if (f->gamma)
1226 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
1227 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
1228 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
1233 /* Decide if color named COLOR_NAME is valid for use on frame F. If
1234 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
1235 allocate the color. Value is zero if COLOR_NAME is invalid, or
1236 no color could be allocated. */
1239 x_defined_color (f, color_name, color, alloc_p)
1240 struct frame *f;
1241 char *color_name;
1242 XColor *color;
1243 int alloc_p;
1245 int success_p;
1246 Display *dpy = FRAME_X_DISPLAY (f);
1247 Colormap cmap = FRAME_X_COLORMAP (f);
1249 BLOCK_INPUT;
1250 success_p = XParseColor (dpy, cmap, color_name, color);
1251 if (success_p && alloc_p)
1252 success_p = x_alloc_nearest_color (f, cmap, color);
1253 UNBLOCK_INPUT;
1255 return success_p;
1259 /* Return the pixel color value for color COLOR_NAME on frame F. If F
1260 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
1261 Signal an error if color can't be allocated. */
1264 x_decode_color (f, color_name, mono_color)
1265 FRAME_PTR f;
1266 Lisp_Object color_name;
1267 int mono_color;
1269 XColor cdef;
1271 CHECK_STRING (color_name, 0);
1273 #if 0 /* Don't do this. It's wrong when we're not using the default
1274 colormap, it makes freeing difficult, and it's probably not
1275 an important optimization. */
1276 if (strcmp (XSTRING (color_name)->data, "black") == 0)
1277 return BLACK_PIX_DEFAULT (f);
1278 else if (strcmp (XSTRING (color_name)->data, "white") == 0)
1279 return WHITE_PIX_DEFAULT (f);
1280 #endif
1282 /* Return MONO_COLOR for monochrome frames. */
1283 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
1284 return mono_color;
1286 /* x_defined_color is responsible for coping with failures
1287 by looking for a near-miss. */
1288 if (x_defined_color (f, XSTRING (color_name)->data, &cdef, 1))
1289 return cdef.pixel;
1291 Fsignal (Qerror, Fcons (build_string ("Undefined color"),
1292 Fcons (color_name, Qnil)));
1293 return 0;
1298 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
1299 the previous value of that parameter, NEW_VALUE is the new value. */
1301 static void
1302 x_set_line_spacing (f, new_value, old_value)
1303 struct frame *f;
1304 Lisp_Object new_value, old_value;
1306 if (NILP (new_value))
1307 f->extra_line_spacing = 0;
1308 else if (NATNUMP (new_value))
1309 f->extra_line_spacing = XFASTINT (new_value);
1310 else
1311 Fsignal (Qerror, Fcons (build_string ("Invalid line-spacing"),
1312 Fcons (new_value, Qnil)));
1313 if (FRAME_VISIBLE_P (f))
1314 redraw_frame (f);
1318 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
1319 the previous value of that parameter, NEW_VALUE is the new value.
1320 See also the comment of wait_for_wm in struct x_output. */
1322 static void
1323 x_set_wait_for_wm (f, new_value, old_value)
1324 struct frame *f;
1325 Lisp_Object new_value, old_value;
1327 f->output_data.x->wait_for_wm = !NILP (new_value);
1331 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
1332 the previous value of that parameter, NEW_VALUE is the new
1333 value. */
1335 static void
1336 x_set_screen_gamma (f, new_value, old_value)
1337 struct frame *f;
1338 Lisp_Object new_value, old_value;
1340 if (NILP (new_value))
1341 f->gamma = 0;
1342 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
1343 /* The value 0.4545 is the normal viewing gamma. */
1344 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
1345 else
1346 Fsignal (Qerror, Fcons (build_string ("Invalid screen-gamma"),
1347 Fcons (new_value, Qnil)));
1349 clear_face_cache (0);
1353 /* Functions called only from `x_set_frame_param'
1354 to set individual parameters.
1356 If FRAME_X_WINDOW (f) is 0,
1357 the frame is being created and its X-window does not exist yet.
1358 In that case, just record the parameter's new value
1359 in the standard place; do not attempt to change the window. */
1361 void
1362 x_set_foreground_color (f, arg, oldval)
1363 struct frame *f;
1364 Lisp_Object arg, oldval;
1366 struct x_output *x = f->output_data.x;
1367 unsigned long fg, old_fg;
1369 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1370 old_fg = x->foreground_pixel;
1371 x->foreground_pixel = fg;
1373 if (FRAME_X_WINDOW (f) != 0)
1375 Display *dpy = FRAME_X_DISPLAY (f);
1377 BLOCK_INPUT;
1378 XSetForeground (dpy, x->normal_gc, fg);
1379 XSetBackground (dpy, x->reverse_gc, fg);
1381 if (x->cursor_pixel == old_fg)
1383 unload_color (f, x->cursor_pixel);
1384 x->cursor_pixel = x_copy_color (f, fg);
1385 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
1388 UNBLOCK_INPUT;
1390 update_face_from_frame_parameter (f, Qforeground_color, arg);
1392 if (FRAME_VISIBLE_P (f))
1393 redraw_frame (f);
1396 unload_color (f, old_fg);
1399 void
1400 x_set_background_color (f, arg, oldval)
1401 struct frame *f;
1402 Lisp_Object arg, oldval;
1404 struct x_output *x = f->output_data.x;
1405 unsigned long bg;
1407 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1408 unload_color (f, x->background_pixel);
1409 x->background_pixel = bg;
1411 if (FRAME_X_WINDOW (f) != 0)
1413 Display *dpy = FRAME_X_DISPLAY (f);
1414 Lisp_Object bar;
1416 BLOCK_INPUT;
1417 XSetBackground (dpy, x->normal_gc, bg);
1418 XSetForeground (dpy, x->reverse_gc, bg);
1419 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
1420 XSetForeground (dpy, x->cursor_gc, bg);
1422 for (bar = FRAME_SCROLL_BARS (f);
1423 !NILP (bar);
1424 bar = XSCROLL_BAR (bar)->next)
1426 Window window = SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar));
1427 XSetWindowBackground (dpy, window, bg);
1430 UNBLOCK_INPUT;
1431 update_face_from_frame_parameter (f, Qbackground_color, arg);
1433 if (FRAME_VISIBLE_P (f))
1434 redraw_frame (f);
1438 void
1439 x_set_mouse_color (f, arg, oldval)
1440 struct frame *f;
1441 Lisp_Object arg, oldval;
1443 struct x_output *x = f->output_data.x;
1444 Display *dpy = FRAME_X_DISPLAY (f);
1445 Cursor cursor, nontext_cursor, mode_cursor, cross_cursor;
1446 Cursor hourglass_cursor, horizontal_drag_cursor;
1447 int count;
1448 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1449 unsigned long mask_color = x->background_pixel;
1451 /* Don't let pointers be invisible. */
1452 if (mask_color == pixel)
1454 x_free_colors (f, &pixel, 1);
1455 pixel = x_copy_color (f, x->foreground_pixel);
1458 unload_color (f, x->mouse_pixel);
1459 x->mouse_pixel = pixel;
1461 BLOCK_INPUT;
1463 /* It's not okay to crash if the user selects a screwy cursor. */
1464 count = x_catch_errors (dpy);
1466 if (!NILP (Vx_pointer_shape))
1468 CHECK_NUMBER (Vx_pointer_shape, 0);
1469 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
1471 else
1472 cursor = XCreateFontCursor (dpy, XC_xterm);
1473 x_check_errors (dpy, "bad text pointer cursor: %s");
1475 if (!NILP (Vx_nontext_pointer_shape))
1477 CHECK_NUMBER (Vx_nontext_pointer_shape, 0);
1478 nontext_cursor
1479 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
1481 else
1482 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
1483 x_check_errors (dpy, "bad nontext pointer cursor: %s");
1485 if (!NILP (Vx_hourglass_pointer_shape))
1487 CHECK_NUMBER (Vx_hourglass_pointer_shape, 0);
1488 hourglass_cursor
1489 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
1491 else
1492 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
1493 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
1495 x_check_errors (dpy, "bad nontext pointer cursor: %s");
1496 if (!NILP (Vx_mode_pointer_shape))
1498 CHECK_NUMBER (Vx_mode_pointer_shape, 0);
1499 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
1501 else
1502 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
1503 x_check_errors (dpy, "bad modeline pointer cursor: %s");
1505 if (!NILP (Vx_sensitive_text_pointer_shape))
1507 CHECK_NUMBER (Vx_sensitive_text_pointer_shape, 0);
1508 cross_cursor
1509 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
1511 else
1512 cross_cursor = XCreateFontCursor (dpy, XC_crosshair);
1514 if (!NILP (Vx_window_horizontal_drag_shape))
1516 CHECK_NUMBER (Vx_window_horizontal_drag_shape, 0);
1517 horizontal_drag_cursor
1518 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
1520 else
1521 horizontal_drag_cursor
1522 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
1524 /* Check and report errors with the above calls. */
1525 x_check_errors (dpy, "can't set cursor shape: %s");
1526 x_uncatch_errors (dpy, count);
1529 XColor fore_color, back_color;
1531 fore_color.pixel = x->mouse_pixel;
1532 x_query_color (f, &fore_color);
1533 back_color.pixel = mask_color;
1534 x_query_color (f, &back_color);
1536 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
1537 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
1538 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
1539 XRecolorCursor (dpy, cross_cursor, &fore_color, &back_color);
1540 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
1541 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
1544 if (FRAME_X_WINDOW (f) != 0)
1545 XDefineCursor (dpy, FRAME_X_WINDOW (f), cursor);
1547 if (cursor != x->text_cursor
1548 && x->text_cursor != 0)
1549 XFreeCursor (dpy, x->text_cursor);
1550 x->text_cursor = cursor;
1552 if (nontext_cursor != x->nontext_cursor
1553 && x->nontext_cursor != 0)
1554 XFreeCursor (dpy, x->nontext_cursor);
1555 x->nontext_cursor = nontext_cursor;
1557 if (hourglass_cursor != x->hourglass_cursor
1558 && x->hourglass_cursor != 0)
1559 XFreeCursor (dpy, x->hourglass_cursor);
1560 x->hourglass_cursor = hourglass_cursor;
1562 if (mode_cursor != x->modeline_cursor
1563 && x->modeline_cursor != 0)
1564 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
1565 x->modeline_cursor = mode_cursor;
1567 if (cross_cursor != x->cross_cursor
1568 && x->cross_cursor != 0)
1569 XFreeCursor (dpy, x->cross_cursor);
1570 x->cross_cursor = cross_cursor;
1572 if (horizontal_drag_cursor != x->horizontal_drag_cursor
1573 && x->horizontal_drag_cursor != 0)
1574 XFreeCursor (dpy, x->horizontal_drag_cursor);
1575 x->horizontal_drag_cursor = horizontal_drag_cursor;
1577 XFlush (dpy);
1578 UNBLOCK_INPUT;
1580 update_face_from_frame_parameter (f, Qmouse_color, arg);
1583 void
1584 x_set_cursor_color (f, arg, oldval)
1585 struct frame *f;
1586 Lisp_Object arg, oldval;
1588 unsigned long fore_pixel, pixel;
1589 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1590 struct x_output *x = f->output_data.x;
1592 if (!NILP (Vx_cursor_fore_pixel))
1594 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1595 WHITE_PIX_DEFAULT (f));
1596 fore_pixel_allocated_p = 1;
1598 else
1599 fore_pixel = x->background_pixel;
1601 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1602 pixel_allocated_p = 1;
1604 /* Make sure that the cursor color differs from the background color. */
1605 if (pixel == x->background_pixel)
1607 if (pixel_allocated_p)
1609 x_free_colors (f, &pixel, 1);
1610 pixel_allocated_p = 0;
1613 pixel = x->mouse_pixel;
1614 if (pixel == fore_pixel)
1616 if (fore_pixel_allocated_p)
1618 x_free_colors (f, &fore_pixel, 1);
1619 fore_pixel_allocated_p = 0;
1621 fore_pixel = x->background_pixel;
1625 unload_color (f, x->cursor_foreground_pixel);
1626 if (!fore_pixel_allocated_p)
1627 fore_pixel = x_copy_color (f, fore_pixel);
1628 x->cursor_foreground_pixel = fore_pixel;
1630 unload_color (f, x->cursor_pixel);
1631 if (!pixel_allocated_p)
1632 pixel = x_copy_color (f, pixel);
1633 x->cursor_pixel = pixel;
1635 if (FRAME_X_WINDOW (f) != 0)
1637 BLOCK_INPUT;
1638 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1639 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1640 UNBLOCK_INPUT;
1642 if (FRAME_VISIBLE_P (f))
1644 x_update_cursor (f, 0);
1645 x_update_cursor (f, 1);
1649 update_face_from_frame_parameter (f, Qcursor_color, arg);
1652 /* Set the border-color of frame F to value described by ARG.
1653 ARG can be a string naming a color.
1654 The border-color is used for the border that is drawn by the X server.
1655 Note that this does not fully take effect if done before
1656 F has an x-window; it must be redone when the window is created.
1658 Note: this is done in two routines because of the way X10 works.
1660 Note: under X11, this is normally the province of the window manager,
1661 and so emacs' border colors may be overridden. */
1663 void
1664 x_set_border_color (f, arg, oldval)
1665 struct frame *f;
1666 Lisp_Object arg, oldval;
1668 int pix;
1670 CHECK_STRING (arg, 0);
1671 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1672 x_set_border_pixel (f, pix);
1673 update_face_from_frame_parameter (f, Qborder_color, arg);
1676 /* Set the border-color of frame F to pixel value PIX.
1677 Note that this does not fully take effect if done before
1678 F has an x-window. */
1680 void
1681 x_set_border_pixel (f, pix)
1682 struct frame *f;
1683 int pix;
1685 unload_color (f, f->output_data.x->border_pixel);
1686 f->output_data.x->border_pixel = pix;
1688 if (FRAME_X_WINDOW (f) != 0 && f->output_data.x->border_width > 0)
1690 BLOCK_INPUT;
1691 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1692 (unsigned long)pix);
1693 UNBLOCK_INPUT;
1695 if (FRAME_VISIBLE_P (f))
1696 redraw_frame (f);
1701 /* Value is the internal representation of the specified cursor type
1702 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
1703 of the bar cursor. */
1705 enum text_cursor_kinds
1706 x_specified_cursor_type (arg, width)
1707 Lisp_Object arg;
1708 int *width;
1710 enum text_cursor_kinds type;
1712 if (EQ (arg, Qbar))
1714 type = BAR_CURSOR;
1715 *width = 2;
1717 else if (CONSP (arg)
1718 && EQ (XCAR (arg), Qbar)
1719 && INTEGERP (XCDR (arg))
1720 && XINT (XCDR (arg)) >= 0)
1722 type = BAR_CURSOR;
1723 *width = XINT (XCDR (arg));
1725 else if (NILP (arg))
1726 type = NO_CURSOR;
1727 else
1728 /* Treat anything unknown as "box cursor".
1729 It was bad to signal an error; people have trouble fixing
1730 .Xdefaults with Emacs, when it has something bad in it. */
1731 type = FILLED_BOX_CURSOR;
1733 return type;
1736 void
1737 x_set_cursor_type (f, arg, oldval)
1738 FRAME_PTR f;
1739 Lisp_Object arg, oldval;
1741 int width;
1743 FRAME_DESIRED_CURSOR (f) = x_specified_cursor_type (arg, &width);
1744 f->output_data.x->cursor_width = width;
1746 /* Make sure the cursor gets redrawn. This is overkill, but how
1747 often do people change cursor types? */
1748 update_mode_lines++;
1751 void
1752 x_set_icon_type (f, arg, oldval)
1753 struct frame *f;
1754 Lisp_Object arg, oldval;
1756 int result;
1758 if (STRINGP (arg))
1760 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1761 return;
1763 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1764 return;
1766 BLOCK_INPUT;
1767 if (NILP (arg))
1768 result = x_text_icon (f,
1769 (char *) XSTRING ((!NILP (f->icon_name)
1770 ? f->icon_name
1771 : f->name))->data);
1772 else
1773 result = x_bitmap_icon (f, arg);
1775 if (result)
1777 UNBLOCK_INPUT;
1778 error ("No icon window available");
1781 XFlush (FRAME_X_DISPLAY (f));
1782 UNBLOCK_INPUT;
1785 /* Return non-nil if frame F wants a bitmap icon. */
1787 Lisp_Object
1788 x_icon_type (f)
1789 FRAME_PTR f;
1791 Lisp_Object tem;
1793 tem = assq_no_quit (Qicon_type, f->param_alist);
1794 if (CONSP (tem))
1795 return XCDR (tem);
1796 else
1797 return Qnil;
1800 void
1801 x_set_icon_name (f, arg, oldval)
1802 struct frame *f;
1803 Lisp_Object arg, oldval;
1805 int result;
1807 if (STRINGP (arg))
1809 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1810 return;
1812 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1813 return;
1815 f->icon_name = arg;
1817 if (f->output_data.x->icon_bitmap != 0)
1818 return;
1820 BLOCK_INPUT;
1822 result = x_text_icon (f,
1823 (char *) XSTRING ((!NILP (f->icon_name)
1824 ? f->icon_name
1825 : !NILP (f->title)
1826 ? f->title
1827 : f->name))->data);
1829 if (result)
1831 UNBLOCK_INPUT;
1832 error ("No icon window available");
1835 XFlush (FRAME_X_DISPLAY (f));
1836 UNBLOCK_INPUT;
1839 void
1840 x_set_font (f, arg, oldval)
1841 struct frame *f;
1842 Lisp_Object arg, oldval;
1844 Lisp_Object result;
1845 Lisp_Object fontset_name;
1846 Lisp_Object frame;
1847 int old_fontset = f->output_data.x->fontset;
1849 CHECK_STRING (arg, 1);
1851 fontset_name = Fquery_fontset (arg, Qnil);
1853 BLOCK_INPUT;
1854 result = (STRINGP (fontset_name)
1855 ? x_new_fontset (f, XSTRING (fontset_name)->data)
1856 : x_new_font (f, XSTRING (arg)->data));
1857 UNBLOCK_INPUT;
1859 if (EQ (result, Qnil))
1860 error ("Font `%s' is not defined", XSTRING (arg)->data);
1861 else if (EQ (result, Qt))
1862 error ("The characters of the given font have varying widths");
1863 else if (STRINGP (result))
1865 if (STRINGP (fontset_name))
1867 /* Fontset names are built from ASCII font names, so the
1868 names may be equal despite there was a change. */
1869 if (old_fontset == f->output_data.x->fontset)
1870 return;
1872 else if (!NILP (Fequal (result, oldval)))
1873 return;
1875 store_frame_param (f, Qfont, result);
1876 recompute_basic_faces (f);
1878 else
1879 abort ();
1881 do_pending_window_change (0);
1883 /* Don't call `face-set-after-frame-default' when faces haven't been
1884 initialized yet. This is the case when called from
1885 Fx_create_frame. In that case, the X widget or window doesn't
1886 exist either, and we can end up in x_report_frame_params with a
1887 null widget which gives a segfault. */
1888 if (FRAME_FACE_CACHE (f))
1890 XSETFRAME (frame, f);
1891 call1 (Qface_set_after_frame_default, frame);
1895 void
1896 x_set_border_width (f, arg, oldval)
1897 struct frame *f;
1898 Lisp_Object arg, oldval;
1900 CHECK_NUMBER (arg, 0);
1902 if (XINT (arg) == f->output_data.x->border_width)
1903 return;
1905 if (FRAME_X_WINDOW (f) != 0)
1906 error ("Cannot change the border width of a window");
1908 f->output_data.x->border_width = XINT (arg);
1911 void
1912 x_set_internal_border_width (f, arg, oldval)
1913 struct frame *f;
1914 Lisp_Object arg, oldval;
1916 int old = f->output_data.x->internal_border_width;
1918 CHECK_NUMBER (arg, 0);
1919 f->output_data.x->internal_border_width = XINT (arg);
1920 if (f->output_data.x->internal_border_width < 0)
1921 f->output_data.x->internal_border_width = 0;
1923 #ifdef USE_X_TOOLKIT
1924 if (f->output_data.x->edit_widget)
1925 widget_store_internal_border (f->output_data.x->edit_widget);
1926 #endif
1928 if (f->output_data.x->internal_border_width == old)
1929 return;
1931 if (FRAME_X_WINDOW (f) != 0)
1933 x_set_window_size (f, 0, f->width, f->height);
1934 SET_FRAME_GARBAGED (f);
1935 do_pending_window_change (0);
1939 void
1940 x_set_visibility (f, value, oldval)
1941 struct frame *f;
1942 Lisp_Object value, oldval;
1944 Lisp_Object frame;
1945 XSETFRAME (frame, f);
1947 if (NILP (value))
1948 Fmake_frame_invisible (frame, Qt);
1949 else if (EQ (value, Qicon))
1950 Ficonify_frame (frame);
1951 else
1952 Fmake_frame_visible (frame);
1956 /* Change window heights in windows rooted in WINDOW by N lines. */
1958 static void
1959 x_change_window_heights (window, n)
1960 Lisp_Object window;
1961 int n;
1963 struct window *w = XWINDOW (window);
1965 XSETFASTINT (w->top, XFASTINT (w->top) + n);
1966 XSETFASTINT (w->height, XFASTINT (w->height) - n);
1968 if (INTEGERP (w->orig_top))
1969 XSETFASTINT (w->orig_top, XFASTINT (w->orig_top) + n);
1970 if (INTEGERP (w->orig_height))
1971 XSETFASTINT (w->orig_height, XFASTINT (w->orig_height) - n);
1973 /* Handle just the top child in a vertical split. */
1974 if (!NILP (w->vchild))
1975 x_change_window_heights (w->vchild, n);
1977 /* Adjust all children in a horizontal split. */
1978 for (window = w->hchild; !NILP (window); window = w->next)
1980 w = XWINDOW (window);
1981 x_change_window_heights (window, n);
1985 void
1986 x_set_menu_bar_lines (f, value, oldval)
1987 struct frame *f;
1988 Lisp_Object value, oldval;
1990 int nlines;
1991 #ifndef USE_X_TOOLKIT
1992 int olines = FRAME_MENU_BAR_LINES (f);
1993 #endif
1995 /* Right now, menu bars don't work properly in minibuf-only frames;
1996 most of the commands try to apply themselves to the minibuffer
1997 frame itself, and get an error because you can't switch buffers
1998 in or split the minibuffer window. */
1999 if (FRAME_MINIBUF_ONLY_P (f))
2000 return;
2002 if (INTEGERP (value))
2003 nlines = XINT (value);
2004 else
2005 nlines = 0;
2007 /* Make sure we redisplay all windows in this frame. */
2008 windows_or_buffers_changed++;
2010 #ifdef USE_X_TOOLKIT
2011 FRAME_MENU_BAR_LINES (f) = 0;
2012 if (nlines)
2014 FRAME_EXTERNAL_MENU_BAR (f) = 1;
2015 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
2016 /* Make sure next redisplay shows the menu bar. */
2017 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
2019 else
2021 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
2022 free_frame_menubar (f);
2023 FRAME_EXTERNAL_MENU_BAR (f) = 0;
2024 if (FRAME_X_P (f))
2025 f->output_data.x->menubar_widget = 0;
2027 #else /* not USE_X_TOOLKIT */
2028 FRAME_MENU_BAR_LINES (f) = nlines;
2029 x_change_window_heights (f->root_window, nlines - olines);
2030 #endif /* not USE_X_TOOLKIT */
2031 adjust_glyphs (f);
2035 /* Set the number of lines used for the tool bar of frame F to VALUE.
2036 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
2037 is the old number of tool bar lines. This function changes the
2038 height of all windows on frame F to match the new tool bar height.
2039 The frame's height doesn't change. */
2041 void
2042 x_set_tool_bar_lines (f, value, oldval)
2043 struct frame *f;
2044 Lisp_Object value, oldval;
2046 int delta, nlines, root_height;
2047 Lisp_Object root_window;
2049 /* Treat tool bars like menu bars. */
2050 if (FRAME_MINIBUF_ONLY_P (f))
2051 return;
2053 /* Use VALUE only if an integer >= 0. */
2054 if (INTEGERP (value) && XINT (value) >= 0)
2055 nlines = XFASTINT (value);
2056 else
2057 nlines = 0;
2059 /* Make sure we redisplay all windows in this frame. */
2060 ++windows_or_buffers_changed;
2062 delta = nlines - FRAME_TOOL_BAR_LINES (f);
2064 /* Don't resize the tool-bar to more than we have room for. */
2065 root_window = FRAME_ROOT_WINDOW (f);
2066 root_height = XINT (XWINDOW (root_window)->height);
2067 if (root_height - delta < 1)
2069 delta = root_height - 1;
2070 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
2073 FRAME_TOOL_BAR_LINES (f) = nlines;
2074 x_change_window_heights (root_window, delta);
2075 adjust_glyphs (f);
2077 /* We also have to make sure that the internal border at the top of
2078 the frame, below the menu bar or tool bar, is redrawn when the
2079 tool bar disappears. This is so because the internal border is
2080 below the tool bar if one is displayed, but is below the menu bar
2081 if there isn't a tool bar. The tool bar draws into the area
2082 below the menu bar. */
2083 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
2085 updating_frame = f;
2086 clear_frame ();
2087 clear_current_matrices (f);
2088 updating_frame = NULL;
2091 /* If the tool bar gets smaller, the internal border below it
2092 has to be cleared. It was formerly part of the display
2093 of the larger tool bar, and updating windows won't clear it. */
2094 if (delta < 0)
2096 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
2097 int width = PIXEL_WIDTH (f);
2098 int y = nlines * CANON_Y_UNIT (f);
2100 BLOCK_INPUT;
2101 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2102 0, y, width, height, False);
2103 UNBLOCK_INPUT;
2108 /* Set the foreground color for scroll bars on frame F to VALUE.
2109 VALUE should be a string, a color name. If it isn't a string or
2110 isn't a valid color name, do nothing. OLDVAL is the old value of
2111 the frame parameter. */
2113 void
2114 x_set_scroll_bar_foreground (f, value, oldval)
2115 struct frame *f;
2116 Lisp_Object value, oldval;
2118 unsigned long pixel;
2120 if (STRINGP (value))
2121 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
2122 else
2123 pixel = -1;
2125 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
2126 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
2128 f->output_data.x->scroll_bar_foreground_pixel = pixel;
2129 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2131 /* Remove all scroll bars because they have wrong colors. */
2132 if (condemn_scroll_bars_hook)
2133 (*condemn_scroll_bars_hook) (f);
2134 if (judge_scroll_bars_hook)
2135 (*judge_scroll_bars_hook) (f);
2137 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
2138 redraw_frame (f);
2143 /* Set the background color for scroll bars on frame F to VALUE VALUE
2144 should be a string, a color name. If it isn't a string or isn't a
2145 valid color name, do nothing. OLDVAL is the old value of the frame
2146 parameter. */
2148 void
2149 x_set_scroll_bar_background (f, value, oldval)
2150 struct frame *f;
2151 Lisp_Object value, oldval;
2153 unsigned long pixel;
2155 if (STRINGP (value))
2156 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
2157 else
2158 pixel = -1;
2160 if (f->output_data.x->scroll_bar_background_pixel != -1)
2161 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
2163 f->output_data.x->scroll_bar_background_pixel = pixel;
2164 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2166 /* Remove all scroll bars because they have wrong colors. */
2167 if (condemn_scroll_bars_hook)
2168 (*condemn_scroll_bars_hook) (f);
2169 if (judge_scroll_bars_hook)
2170 (*judge_scroll_bars_hook) (f);
2172 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
2173 redraw_frame (f);
2178 /* Encode Lisp string STRING as a text in a format appropriate for
2179 XICCC (X Inter Client Communication Conventions).
2181 If STRING contains only ASCII characters, do no conversion and
2182 return the string data of STRING. Otherwise, encode the text by
2183 CODING_SYSTEM, and return a newly allocated memory area which
2184 should be freed by `xfree' by a caller.
2186 Store the byte length of resulting text in *TEXT_BYTES.
2188 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
2189 which means that the `encoding' of the result can be `STRING'.
2190 Otherwise store 0 in *STRINGP, which means that the `encoding' of
2191 the result should be `COMPOUND_TEXT'. */
2193 unsigned char *
2194 x_encode_text (string, coding_system, text_bytes, stringp)
2195 Lisp_Object string, coding_system;
2196 int *text_bytes, *stringp;
2198 unsigned char *str = XSTRING (string)->data;
2199 int chars = XSTRING (string)->size;
2200 int bytes = STRING_BYTES (XSTRING (string));
2201 int charset_info;
2202 int bufsize;
2203 unsigned char *buf;
2204 struct coding_system coding;
2206 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
2207 if (charset_info == 0)
2209 /* No multibyte character in OBJ. We need not encode it. */
2210 *text_bytes = bytes;
2211 *stringp = 1;
2212 return str;
2215 setup_coding_system (coding_system, &coding);
2216 coding.src_multibyte = 1;
2217 coding.dst_multibyte = 0;
2218 coding.mode |= CODING_MODE_LAST_BLOCK;
2219 if (coding.type == coding_type_iso2022)
2220 coding.flags |= CODING_FLAG_ISO_SAFE;
2221 /* We suppress producing escape sequences for composition. */
2222 coding.composing = COMPOSITION_DISABLED;
2223 bufsize = encoding_buffer_size (&coding, bytes);
2224 buf = (unsigned char *) xmalloc (bufsize);
2225 encode_coding (&coding, str, buf, bytes, bufsize);
2226 *text_bytes = coding.produced;
2227 *stringp = (charset_info == 1 || !EQ (coding_system, Qcompound_text));
2228 return buf;
2232 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
2233 x_id_name.
2235 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2236 name; if NAME is a string, set F's name to NAME and set
2237 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2239 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2240 suggesting a new name, which lisp code should override; if
2241 F->explicit_name is set, ignore the new name; otherwise, set it. */
2243 void
2244 x_set_name (f, name, explicit)
2245 struct frame *f;
2246 Lisp_Object name;
2247 int explicit;
2249 /* Make sure that requests from lisp code override requests from
2250 Emacs redisplay code. */
2251 if (explicit)
2253 /* If we're switching from explicit to implicit, we had better
2254 update the mode lines and thereby update the title. */
2255 if (f->explicit_name && NILP (name))
2256 update_mode_lines = 1;
2258 f->explicit_name = ! NILP (name);
2260 else if (f->explicit_name)
2261 return;
2263 /* If NAME is nil, set the name to the x_id_name. */
2264 if (NILP (name))
2266 /* Check for no change needed in this very common case
2267 before we do any consing. */
2268 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
2269 XSTRING (f->name)->data))
2270 return;
2271 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
2273 else
2274 CHECK_STRING (name, 0);
2276 /* Don't change the name if it's already NAME. */
2277 if (! NILP (Fstring_equal (name, f->name)))
2278 return;
2280 f->name = name;
2282 /* For setting the frame title, the title parameter should override
2283 the name parameter. */
2284 if (! NILP (f->title))
2285 name = f->title;
2287 if (FRAME_X_WINDOW (f))
2289 BLOCK_INPUT;
2290 #ifdef HAVE_X11R4
2292 XTextProperty text, icon;
2293 int bytes, stringp;
2294 Lisp_Object coding_system;
2296 coding_system = Vlocale_coding_system;
2297 if (NILP (coding_system))
2298 coding_system = Qcompound_text;
2299 text.value = x_encode_text (name, coding_system, &bytes, &stringp);
2300 text.encoding = (stringp ? XA_STRING
2301 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2302 text.format = 8;
2303 text.nitems = bytes;
2305 if (NILP (f->icon_name))
2307 icon = text;
2309 else
2311 icon.value = x_encode_text (f->icon_name, coding_system,
2312 &bytes, &stringp);
2313 icon.encoding = (stringp ? XA_STRING
2314 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2315 icon.format = 8;
2316 icon.nitems = bytes;
2318 #ifdef USE_X_TOOLKIT
2319 XSetWMName (FRAME_X_DISPLAY (f),
2320 XtWindow (f->output_data.x->widget), &text);
2321 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2322 &icon);
2323 #else /* not USE_X_TOOLKIT */
2324 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2325 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2326 #endif /* not USE_X_TOOLKIT */
2327 if (!NILP (f->icon_name)
2328 && icon.value != XSTRING (f->icon_name)->data)
2329 xfree (icon.value);
2330 if (text.value != XSTRING (name)->data)
2331 xfree (text.value);
2333 #else /* not HAVE_X11R4 */
2334 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2335 XSTRING (name)->data);
2336 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2337 XSTRING (name)->data);
2338 #endif /* not HAVE_X11R4 */
2339 UNBLOCK_INPUT;
2343 /* This function should be called when the user's lisp code has
2344 specified a name for the frame; the name will override any set by the
2345 redisplay code. */
2346 void
2347 x_explicitly_set_name (f, arg, oldval)
2348 FRAME_PTR f;
2349 Lisp_Object arg, oldval;
2351 x_set_name (f, arg, 1);
2354 /* This function should be called by Emacs redisplay code to set the
2355 name; names set this way will never override names set by the user's
2356 lisp code. */
2357 void
2358 x_implicitly_set_name (f, arg, oldval)
2359 FRAME_PTR f;
2360 Lisp_Object arg, oldval;
2362 x_set_name (f, arg, 0);
2365 /* Change the title of frame F to NAME.
2366 If NAME is nil, use the frame name as the title.
2368 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2369 name; if NAME is a string, set F's name to NAME and set
2370 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2372 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2373 suggesting a new name, which lisp code should override; if
2374 F->explicit_name is set, ignore the new name; otherwise, set it. */
2376 void
2377 x_set_title (f, name, old_name)
2378 struct frame *f;
2379 Lisp_Object name, old_name;
2381 /* Don't change the title if it's already NAME. */
2382 if (EQ (name, f->title))
2383 return;
2385 update_mode_lines = 1;
2387 f->title = name;
2389 if (NILP (name))
2390 name = f->name;
2391 else
2392 CHECK_STRING (name, 0);
2394 if (FRAME_X_WINDOW (f))
2396 BLOCK_INPUT;
2397 #ifdef HAVE_X11R4
2399 XTextProperty text, icon;
2400 int bytes, stringp;
2401 Lisp_Object coding_system;
2403 coding_system = Vlocale_coding_system;
2404 if (NILP (coding_system))
2405 coding_system = Qcompound_text;
2406 text.value = x_encode_text (name, coding_system, &bytes, &stringp);
2407 text.encoding = (stringp ? XA_STRING
2408 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2409 text.format = 8;
2410 text.nitems = bytes;
2412 if (NILP (f->icon_name))
2414 icon = text;
2416 else
2418 icon.value = x_encode_text (f->icon_name, coding_system,
2419 &bytes, &stringp);
2420 icon.encoding = (stringp ? XA_STRING
2421 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2422 icon.format = 8;
2423 icon.nitems = bytes;
2425 #ifdef USE_X_TOOLKIT
2426 XSetWMName (FRAME_X_DISPLAY (f),
2427 XtWindow (f->output_data.x->widget), &text);
2428 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2429 &icon);
2430 #else /* not USE_X_TOOLKIT */
2431 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2432 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2433 #endif /* not USE_X_TOOLKIT */
2434 if (!NILP (f->icon_name)
2435 && icon.value != XSTRING (f->icon_name)->data)
2436 xfree (icon.value);
2437 if (text.value != XSTRING (name)->data)
2438 xfree (text.value);
2440 #else /* not HAVE_X11R4 */
2441 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2442 XSTRING (name)->data);
2443 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2444 XSTRING (name)->data);
2445 #endif /* not HAVE_X11R4 */
2446 UNBLOCK_INPUT;
2450 void
2451 x_set_autoraise (f, arg, oldval)
2452 struct frame *f;
2453 Lisp_Object arg, oldval;
2455 f->auto_raise = !EQ (Qnil, arg);
2458 void
2459 x_set_autolower (f, arg, oldval)
2460 struct frame *f;
2461 Lisp_Object arg, oldval;
2463 f->auto_lower = !EQ (Qnil, arg);
2466 void
2467 x_set_unsplittable (f, arg, oldval)
2468 struct frame *f;
2469 Lisp_Object arg, oldval;
2471 f->no_split = !NILP (arg);
2474 void
2475 x_set_vertical_scroll_bars (f, arg, oldval)
2476 struct frame *f;
2477 Lisp_Object arg, oldval;
2479 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
2480 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
2481 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
2482 || (!NILP (arg) && ! FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
2484 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
2485 = (NILP (arg)
2486 ? vertical_scroll_bar_none
2487 : EQ (Qright, arg)
2488 ? vertical_scroll_bar_right
2489 : vertical_scroll_bar_left);
2491 /* We set this parameter before creating the X window for the
2492 frame, so we can get the geometry right from the start.
2493 However, if the window hasn't been created yet, we shouldn't
2494 call x_set_window_size. */
2495 if (FRAME_X_WINDOW (f))
2496 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2497 do_pending_window_change (0);
2501 void
2502 x_set_scroll_bar_width (f, arg, oldval)
2503 struct frame *f;
2504 Lisp_Object arg, oldval;
2506 int wid = FONT_WIDTH (f->output_data.x->font);
2508 if (NILP (arg))
2510 #ifdef USE_TOOLKIT_SCROLL_BARS
2511 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2512 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2513 FRAME_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
2514 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = width;
2515 #else
2516 /* Make the actual width at least 14 pixels and a multiple of a
2517 character width. */
2518 FRAME_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
2520 /* Use all of that space (aside from required margins) for the
2521 scroll bar. */
2522 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = 0;
2523 #endif
2525 if (FRAME_X_WINDOW (f))
2526 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2527 do_pending_window_change (0);
2529 else if (INTEGERP (arg) && XINT (arg) > 0
2530 && XFASTINT (arg) != FRAME_SCROLL_BAR_PIXEL_WIDTH (f))
2532 if (XFASTINT (arg) <= 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM)
2533 XSETINT (arg, 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM + 1);
2535 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = XFASTINT (arg);
2536 FRAME_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + wid-1) / wid;
2537 if (FRAME_X_WINDOW (f))
2538 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2541 change_frame_size (f, 0, FRAME_WIDTH (f), 0, 0, 0);
2542 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
2543 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
2548 /* Subroutines of creating an X frame. */
2550 /* Make sure that Vx_resource_name is set to a reasonable value.
2551 Fix it up, or set it to `emacs' if it is too hopeless. */
2553 static void
2554 validate_x_resource_name ()
2556 int len = 0;
2557 /* Number of valid characters in the resource name. */
2558 int good_count = 0;
2559 /* Number of invalid characters in the resource name. */
2560 int bad_count = 0;
2561 Lisp_Object new;
2562 int i;
2564 if (!STRINGP (Vx_resource_class))
2565 Vx_resource_class = build_string (EMACS_CLASS);
2567 if (STRINGP (Vx_resource_name))
2569 unsigned char *p = XSTRING (Vx_resource_name)->data;
2570 int i;
2572 len = STRING_BYTES (XSTRING (Vx_resource_name));
2574 /* Only letters, digits, - and _ are valid in resource names.
2575 Count the valid characters and count the invalid ones. */
2576 for (i = 0; i < len; i++)
2578 int c = p[i];
2579 if (! ((c >= 'a' && c <= 'z')
2580 || (c >= 'A' && c <= 'Z')
2581 || (c >= '0' && c <= '9')
2582 || c == '-' || c == '_'))
2583 bad_count++;
2584 else
2585 good_count++;
2588 else
2589 /* Not a string => completely invalid. */
2590 bad_count = 5, good_count = 0;
2592 /* If name is valid already, return. */
2593 if (bad_count == 0)
2594 return;
2596 /* If name is entirely invalid, or nearly so, use `emacs'. */
2597 if (good_count == 0
2598 || (good_count == 1 && bad_count > 0))
2600 Vx_resource_name = build_string ("emacs");
2601 return;
2604 /* Name is partly valid. Copy it and replace the invalid characters
2605 with underscores. */
2607 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
2609 for (i = 0; i < len; i++)
2611 int c = XSTRING (new)->data[i];
2612 if (! ((c >= 'a' && c <= 'z')
2613 || (c >= 'A' && c <= 'Z')
2614 || (c >= '0' && c <= '9')
2615 || c == '-' || c == '_'))
2616 XSTRING (new)->data[i] = '_';
2621 extern char *x_get_string_resource ();
2623 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
2624 "Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.\n\
2625 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the\n\
2626 class, where INSTANCE is the name under which Emacs was invoked, or\n\
2627 the name specified by the `-name' or `-rn' command-line arguments.\n\
2629 The optional arguments COMPONENT and SUBCLASS add to the key and the\n\
2630 class, respectively. You must specify both of them or neither.\n\
2631 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'\n\
2632 and the class is `Emacs.CLASS.SUBCLASS'.")
2633 (attribute, class, component, subclass)
2634 Lisp_Object attribute, class, component, subclass;
2636 register char *value;
2637 char *name_key;
2638 char *class_key;
2640 check_x ();
2642 CHECK_STRING (attribute, 0);
2643 CHECK_STRING (class, 0);
2645 if (!NILP (component))
2646 CHECK_STRING (component, 1);
2647 if (!NILP (subclass))
2648 CHECK_STRING (subclass, 2);
2649 if (NILP (component) != NILP (subclass))
2650 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2652 validate_x_resource_name ();
2654 /* Allocate space for the components, the dots which separate them,
2655 and the final '\0'. Make them big enough for the worst case. */
2656 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2657 + (STRINGP (component)
2658 ? STRING_BYTES (XSTRING (component)) : 0)
2659 + STRING_BYTES (XSTRING (attribute))
2660 + 3);
2662 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2663 + STRING_BYTES (XSTRING (class))
2664 + (STRINGP (subclass)
2665 ? STRING_BYTES (XSTRING (subclass)) : 0)
2666 + 3);
2668 /* Start with emacs.FRAMENAME for the name (the specific one)
2669 and with `Emacs' for the class key (the general one). */
2670 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2671 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2673 strcat (class_key, ".");
2674 strcat (class_key, XSTRING (class)->data);
2676 if (!NILP (component))
2678 strcat (class_key, ".");
2679 strcat (class_key, XSTRING (subclass)->data);
2681 strcat (name_key, ".");
2682 strcat (name_key, XSTRING (component)->data);
2685 strcat (name_key, ".");
2686 strcat (name_key, XSTRING (attribute)->data);
2688 value = x_get_string_resource (check_x_display_info (Qnil)->xrdb,
2689 name_key, class_key);
2691 if (value != (char *) 0)
2692 return build_string (value);
2693 else
2694 return Qnil;
2697 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
2699 Lisp_Object
2700 display_x_get_resource (dpyinfo, attribute, class, component, subclass)
2701 struct x_display_info *dpyinfo;
2702 Lisp_Object attribute, class, component, subclass;
2704 register char *value;
2705 char *name_key;
2706 char *class_key;
2708 CHECK_STRING (attribute, 0);
2709 CHECK_STRING (class, 0);
2711 if (!NILP (component))
2712 CHECK_STRING (component, 1);
2713 if (!NILP (subclass))
2714 CHECK_STRING (subclass, 2);
2715 if (NILP (component) != NILP (subclass))
2716 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2718 validate_x_resource_name ();
2720 /* Allocate space for the components, the dots which separate them,
2721 and the final '\0'. Make them big enough for the worst case. */
2722 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2723 + (STRINGP (component)
2724 ? STRING_BYTES (XSTRING (component)) : 0)
2725 + STRING_BYTES (XSTRING (attribute))
2726 + 3);
2728 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2729 + STRING_BYTES (XSTRING (class))
2730 + (STRINGP (subclass)
2731 ? STRING_BYTES (XSTRING (subclass)) : 0)
2732 + 3);
2734 /* Start with emacs.FRAMENAME for the name (the specific one)
2735 and with `Emacs' for the class key (the general one). */
2736 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2737 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2739 strcat (class_key, ".");
2740 strcat (class_key, XSTRING (class)->data);
2742 if (!NILP (component))
2744 strcat (class_key, ".");
2745 strcat (class_key, XSTRING (subclass)->data);
2747 strcat (name_key, ".");
2748 strcat (name_key, XSTRING (component)->data);
2751 strcat (name_key, ".");
2752 strcat (name_key, XSTRING (attribute)->data);
2754 value = x_get_string_resource (dpyinfo->xrdb, name_key, class_key);
2756 if (value != (char *) 0)
2757 return build_string (value);
2758 else
2759 return Qnil;
2762 /* Used when C code wants a resource value. */
2764 char *
2765 x_get_resource_string (attribute, class)
2766 char *attribute, *class;
2768 char *name_key;
2769 char *class_key;
2770 struct frame *sf = SELECTED_FRAME ();
2772 /* Allocate space for the components, the dots which separate them,
2773 and the final '\0'. */
2774 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vinvocation_name))
2775 + strlen (attribute) + 2);
2776 class_key = (char *) alloca ((sizeof (EMACS_CLASS) - 1)
2777 + strlen (class) + 2);
2779 sprintf (name_key, "%s.%s",
2780 XSTRING (Vinvocation_name)->data,
2781 attribute);
2782 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
2784 return x_get_string_resource (FRAME_X_DISPLAY_INFO (sf)->xrdb,
2785 name_key, class_key);
2788 /* Types we might convert a resource string into. */
2789 enum resource_types
2791 RES_TYPE_NUMBER,
2792 RES_TYPE_FLOAT,
2793 RES_TYPE_BOOLEAN,
2794 RES_TYPE_STRING,
2795 RES_TYPE_SYMBOL
2798 /* Return the value of parameter PARAM.
2800 First search ALIST, then Vdefault_frame_alist, then the X defaults
2801 database, using ATTRIBUTE as the attribute name and CLASS as its class.
2803 Convert the resource to the type specified by desired_type.
2805 If no default is specified, return Qunbound. If you call
2806 x_get_arg, make sure you deal with Qunbound in a reasonable way,
2807 and don't let it get stored in any Lisp-visible variables! */
2809 static Lisp_Object
2810 x_get_arg (dpyinfo, alist, param, attribute, class, type)
2811 struct x_display_info *dpyinfo;
2812 Lisp_Object alist, param;
2813 char *attribute;
2814 char *class;
2815 enum resource_types type;
2817 register Lisp_Object tem;
2819 tem = Fassq (param, alist);
2820 if (EQ (tem, Qnil))
2821 tem = Fassq (param, Vdefault_frame_alist);
2822 if (EQ (tem, Qnil))
2825 if (attribute)
2827 tem = display_x_get_resource (dpyinfo,
2828 build_string (attribute),
2829 build_string (class),
2830 Qnil, Qnil);
2832 if (NILP (tem))
2833 return Qunbound;
2835 switch (type)
2837 case RES_TYPE_NUMBER:
2838 return make_number (atoi (XSTRING (tem)->data));
2840 case RES_TYPE_FLOAT:
2841 return make_float (atof (XSTRING (tem)->data));
2843 case RES_TYPE_BOOLEAN:
2844 tem = Fdowncase (tem);
2845 if (!strcmp (XSTRING (tem)->data, "on")
2846 || !strcmp (XSTRING (tem)->data, "true"))
2847 return Qt;
2848 else
2849 return Qnil;
2851 case RES_TYPE_STRING:
2852 return tem;
2854 case RES_TYPE_SYMBOL:
2855 /* As a special case, we map the values `true' and `on'
2856 to Qt, and `false' and `off' to Qnil. */
2858 Lisp_Object lower;
2859 lower = Fdowncase (tem);
2860 if (!strcmp (XSTRING (lower)->data, "on")
2861 || !strcmp (XSTRING (lower)->data, "true"))
2862 return Qt;
2863 else if (!strcmp (XSTRING (lower)->data, "off")
2864 || !strcmp (XSTRING (lower)->data, "false"))
2865 return Qnil;
2866 else
2867 return Fintern (tem, Qnil);
2870 default:
2871 abort ();
2874 else
2875 return Qunbound;
2877 return Fcdr (tem);
2880 /* Like x_get_arg, but also record the value in f->param_alist. */
2882 static Lisp_Object
2883 x_get_and_record_arg (f, alist, param, attribute, class, type)
2884 struct frame *f;
2885 Lisp_Object alist, param;
2886 char *attribute;
2887 char *class;
2888 enum resource_types type;
2890 Lisp_Object value;
2892 value = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, param,
2893 attribute, class, type);
2894 if (! NILP (value))
2895 store_frame_param (f, param, value);
2897 return value;
2900 /* Record in frame F the specified or default value according to ALIST
2901 of the parameter named PROP (a Lisp symbol).
2902 If no value is specified for PROP, look for an X default for XPROP
2903 on the frame named NAME.
2904 If that is not found either, use the value DEFLT. */
2906 static Lisp_Object
2907 x_default_parameter (f, alist, prop, deflt, xprop, xclass, type)
2908 struct frame *f;
2909 Lisp_Object alist;
2910 Lisp_Object prop;
2911 Lisp_Object deflt;
2912 char *xprop;
2913 char *xclass;
2914 enum resource_types type;
2916 Lisp_Object tem;
2918 tem = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, prop, xprop, xclass, type);
2919 if (EQ (tem, Qunbound))
2920 tem = deflt;
2921 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2922 return tem;
2926 /* Record in frame F the specified or default value according to ALIST
2927 of the parameter named PROP (a Lisp symbol). If no value is
2928 specified for PROP, look for an X default for XPROP on the frame
2929 named NAME. If that is not found either, use the value DEFLT. */
2931 static Lisp_Object
2932 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
2933 foreground_p)
2934 struct frame *f;
2935 Lisp_Object alist;
2936 Lisp_Object prop;
2937 char *xprop;
2938 char *xclass;
2939 int foreground_p;
2941 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2942 Lisp_Object tem;
2944 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
2945 if (EQ (tem, Qunbound))
2947 #ifdef USE_TOOLKIT_SCROLL_BARS
2949 /* See if an X resource for the scroll bar color has been
2950 specified. */
2951 tem = display_x_get_resource (dpyinfo,
2952 build_string (foreground_p
2953 ? "foreground"
2954 : "background"),
2955 build_string (""),
2956 build_string ("verticalScrollBar"),
2957 build_string (""));
2958 if (!STRINGP (tem))
2960 /* If nothing has been specified, scroll bars will use a
2961 toolkit-dependent default. Because these defaults are
2962 difficult to get at without actually creating a scroll
2963 bar, use nil to indicate that no color has been
2964 specified. */
2965 tem = Qnil;
2968 #else /* not USE_TOOLKIT_SCROLL_BARS */
2970 tem = Qnil;
2972 #endif /* not USE_TOOLKIT_SCROLL_BARS */
2975 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2976 return tem;
2981 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
2982 "Parse an X-style geometry string STRING.\n\
2983 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).\n\
2984 The properties returned may include `top', `left', `height', and `width'.\n\
2985 The value of `left' or `top' may be an integer,\n\
2986 or a list (+ N) meaning N pixels relative to top/left corner,\n\
2987 or a list (- N) meaning -N pixels relative to bottom/right corner.")
2988 (string)
2989 Lisp_Object string;
2991 int geometry, x, y;
2992 unsigned int width, height;
2993 Lisp_Object result;
2995 CHECK_STRING (string, 0);
2997 geometry = XParseGeometry ((char *) XSTRING (string)->data,
2998 &x, &y, &width, &height);
3000 #if 0
3001 if (!!(geometry & XValue) != !!(geometry & YValue))
3002 error ("Must specify both x and y position, or neither");
3003 #endif
3005 result = Qnil;
3006 if (geometry & XValue)
3008 Lisp_Object element;
3010 if (x >= 0 && (geometry & XNegative))
3011 element = Fcons (Qleft, Fcons (Qminus, Fcons (make_number (-x), Qnil)));
3012 else if (x < 0 && ! (geometry & XNegative))
3013 element = Fcons (Qleft, Fcons (Qplus, Fcons (make_number (x), Qnil)));
3014 else
3015 element = Fcons (Qleft, make_number (x));
3016 result = Fcons (element, result);
3019 if (geometry & YValue)
3021 Lisp_Object element;
3023 if (y >= 0 && (geometry & YNegative))
3024 element = Fcons (Qtop, Fcons (Qminus, Fcons (make_number (-y), Qnil)));
3025 else if (y < 0 && ! (geometry & YNegative))
3026 element = Fcons (Qtop, Fcons (Qplus, Fcons (make_number (y), Qnil)));
3027 else
3028 element = Fcons (Qtop, make_number (y));
3029 result = Fcons (element, result);
3032 if (geometry & WidthValue)
3033 result = Fcons (Fcons (Qwidth, make_number (width)), result);
3034 if (geometry & HeightValue)
3035 result = Fcons (Fcons (Qheight, make_number (height)), result);
3037 return result;
3040 /* Calculate the desired size and position of this window,
3041 and return the flags saying which aspects were specified.
3043 This function does not make the coordinates positive. */
3045 #define DEFAULT_ROWS 40
3046 #define DEFAULT_COLS 80
3048 static int
3049 x_figure_window_size (f, parms)
3050 struct frame *f;
3051 Lisp_Object parms;
3053 register Lisp_Object tem0, tem1, tem2;
3054 long window_prompting = 0;
3055 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3057 /* Default values if we fall through.
3058 Actually, if that happens we should get
3059 window manager prompting. */
3060 SET_FRAME_WIDTH (f, DEFAULT_COLS);
3061 f->height = DEFAULT_ROWS;
3062 /* Window managers expect that if program-specified
3063 positions are not (0,0), they're intentional, not defaults. */
3064 f->output_data.x->top_pos = 0;
3065 f->output_data.x->left_pos = 0;
3067 tem0 = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
3068 tem1 = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
3069 tem2 = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
3070 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3072 if (!EQ (tem0, Qunbound))
3074 CHECK_NUMBER (tem0, 0);
3075 f->height = XINT (tem0);
3077 if (!EQ (tem1, Qunbound))
3079 CHECK_NUMBER (tem1, 0);
3080 SET_FRAME_WIDTH (f, XINT (tem1));
3082 if (!NILP (tem2) && !EQ (tem2, Qunbound))
3083 window_prompting |= USSize;
3084 else
3085 window_prompting |= PSize;
3088 f->output_data.x->vertical_scroll_bar_extra
3089 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
3091 : (FRAME_SCROLL_BAR_COLS (f) * FONT_WIDTH (f->output_data.x->font)));
3092 f->output_data.x->flags_areas_extra
3093 = FRAME_FLAGS_AREA_WIDTH (f);
3094 f->output_data.x->pixel_width = CHAR_TO_PIXEL_WIDTH (f, f->width);
3095 f->output_data.x->pixel_height = CHAR_TO_PIXEL_HEIGHT (f, f->height);
3097 tem0 = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
3098 tem1 = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
3099 tem2 = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
3100 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3102 if (EQ (tem0, Qminus))
3104 f->output_data.x->top_pos = 0;
3105 window_prompting |= YNegative;
3107 else if (CONSP (tem0) && EQ (XCAR (tem0), Qminus)
3108 && CONSP (XCDR (tem0))
3109 && INTEGERP (XCAR (XCDR (tem0))))
3111 f->output_data.x->top_pos = - XINT (XCAR (XCDR (tem0)));
3112 window_prompting |= YNegative;
3114 else if (CONSP (tem0) && EQ (XCAR (tem0), Qplus)
3115 && CONSP (XCDR (tem0))
3116 && INTEGERP (XCAR (XCDR (tem0))))
3118 f->output_data.x->top_pos = XINT (XCAR (XCDR (tem0)));
3120 else if (EQ (tem0, Qunbound))
3121 f->output_data.x->top_pos = 0;
3122 else
3124 CHECK_NUMBER (tem0, 0);
3125 f->output_data.x->top_pos = XINT (tem0);
3126 if (f->output_data.x->top_pos < 0)
3127 window_prompting |= YNegative;
3130 if (EQ (tem1, Qminus))
3132 f->output_data.x->left_pos = 0;
3133 window_prompting |= XNegative;
3135 else if (CONSP (tem1) && EQ (XCAR (tem1), Qminus)
3136 && CONSP (XCDR (tem1))
3137 && INTEGERP (XCAR (XCDR (tem1))))
3139 f->output_data.x->left_pos = - XINT (XCAR (XCDR (tem1)));
3140 window_prompting |= XNegative;
3142 else if (CONSP (tem1) && EQ (XCAR (tem1), Qplus)
3143 && CONSP (XCDR (tem1))
3144 && INTEGERP (XCAR (XCDR (tem1))))
3146 f->output_data.x->left_pos = XINT (XCAR (XCDR (tem1)));
3148 else if (EQ (tem1, Qunbound))
3149 f->output_data.x->left_pos = 0;
3150 else
3152 CHECK_NUMBER (tem1, 0);
3153 f->output_data.x->left_pos = XINT (tem1);
3154 if (f->output_data.x->left_pos < 0)
3155 window_prompting |= XNegative;
3158 if (!NILP (tem2) && ! EQ (tem2, Qunbound))
3159 window_prompting |= USPosition;
3160 else
3161 window_prompting |= PPosition;
3164 return window_prompting;
3167 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
3169 Status
3170 XSetWMProtocols (dpy, w, protocols, count)
3171 Display *dpy;
3172 Window w;
3173 Atom *protocols;
3174 int count;
3176 Atom prop;
3177 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
3178 if (prop == None) return False;
3179 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
3180 (unsigned char *) protocols, count);
3181 return True;
3183 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
3185 #ifdef USE_X_TOOLKIT
3187 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
3188 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
3189 already be present because of the toolkit (Motif adds some of them,
3190 for example, but Xt doesn't). */
3192 static void
3193 hack_wm_protocols (f, widget)
3194 FRAME_PTR f;
3195 Widget widget;
3197 Display *dpy = XtDisplay (widget);
3198 Window w = XtWindow (widget);
3199 int need_delete = 1;
3200 int need_focus = 1;
3201 int need_save = 1;
3203 BLOCK_INPUT;
3205 Atom type, *atoms = 0;
3206 int format = 0;
3207 unsigned long nitems = 0;
3208 unsigned long bytes_after;
3210 if ((XGetWindowProperty (dpy, w,
3211 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3212 (long)0, (long)100, False, XA_ATOM,
3213 &type, &format, &nitems, &bytes_after,
3214 (unsigned char **) &atoms)
3215 == Success)
3216 && format == 32 && type == XA_ATOM)
3217 while (nitems > 0)
3219 nitems--;
3220 if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
3221 need_delete = 0;
3222 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
3223 need_focus = 0;
3224 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
3225 need_save = 0;
3227 if (atoms) XFree ((char *) atoms);
3230 Atom props [10];
3231 int count = 0;
3232 if (need_delete)
3233 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3234 if (need_focus)
3235 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
3236 if (need_save)
3237 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3238 if (count)
3239 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3240 XA_ATOM, 32, PropModeAppend,
3241 (unsigned char *) props, count);
3243 UNBLOCK_INPUT;
3245 #endif
3249 /* Support routines for XIC (X Input Context). */
3251 #ifdef HAVE_X_I18N
3253 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
3254 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
3257 /* Supported XIM styles, ordered by preferenc. */
3259 static XIMStyle supported_xim_styles[] =
3261 XIMPreeditPosition | XIMStatusArea,
3262 XIMPreeditPosition | XIMStatusNothing,
3263 XIMPreeditPosition | XIMStatusNone,
3264 XIMPreeditNothing | XIMStatusArea,
3265 XIMPreeditNothing | XIMStatusNothing,
3266 XIMPreeditNothing | XIMStatusNone,
3267 XIMPreeditNone | XIMStatusArea,
3268 XIMPreeditNone | XIMStatusNothing,
3269 XIMPreeditNone | XIMStatusNone,
3274 /* Create an X fontset on frame F with base font name
3275 BASE_FONTNAME.. */
3277 static XFontSet
3278 xic_create_xfontset (f, base_fontname)
3279 struct frame *f;
3280 char *base_fontname;
3282 XFontSet xfs;
3283 char **missing_list;
3284 int missing_count;
3285 char *def_string;
3287 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
3288 base_fontname, &missing_list,
3289 &missing_count, &def_string);
3290 if (missing_list)
3291 XFreeStringList (missing_list);
3293 /* No need to free def_string. */
3294 return xfs;
3298 /* Value is the best input style, given user preferences USER (already
3299 checked to be supported by Emacs), and styles supported by the
3300 input method XIM. */
3302 static XIMStyle
3303 best_xim_style (user, xim)
3304 XIMStyles *user;
3305 XIMStyles *xim;
3307 int i, j;
3309 for (i = 0; i < user->count_styles; ++i)
3310 for (j = 0; j < xim->count_styles; ++j)
3311 if (user->supported_styles[i] == xim->supported_styles[j])
3312 return user->supported_styles[i];
3314 /* Return the default style. */
3315 return XIMPreeditNothing | XIMStatusNothing;
3318 /* Create XIC for frame F. */
3320 static XIMStyle xic_style;
3322 void
3323 create_frame_xic (f)
3324 struct frame *f;
3326 XIM xim;
3327 XIC xic = NULL;
3328 XFontSet xfs = NULL;
3330 if (FRAME_XIC (f))
3331 return;
3333 xim = FRAME_X_XIM (f);
3334 if (xim)
3336 XRectangle s_area;
3337 XPoint spot;
3338 XVaNestedList preedit_attr;
3339 XVaNestedList status_attr;
3340 char *base_fontname;
3341 int fontset;
3343 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
3344 spot.x = 0; spot.y = 1;
3345 /* Create X fontset. */
3346 fontset = FRAME_FONTSET (f);
3347 if (fontset < 0)
3348 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3349 else
3351 /* Determine the base fontname from the ASCII font name of
3352 FONTSET. */
3353 char *ascii_font = (char *) XSTRING (fontset_ascii (fontset))->data;
3354 char *p = ascii_font;
3355 int i;
3357 for (i = 0; *p; p++)
3358 if (*p == '-') i++;
3359 if (i != 14)
3360 /* As the font name doesn't conform to XLFD, we can't
3361 modify it to get a suitable base fontname for the
3362 frame. */
3363 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3364 else
3366 int len = strlen (ascii_font) + 1;
3367 char *p1 = NULL;
3369 for (i = 0, p = ascii_font; i < 8; p++)
3371 if (*p == '-')
3373 i++;
3374 if (i == 3)
3375 p1 = p + 1;
3378 base_fontname = (char *) alloca (len);
3379 bzero (base_fontname, len);
3380 strcpy (base_fontname, "-*-*-");
3381 bcopy (p1, base_fontname + 5, p - p1);
3382 strcat (base_fontname, "*-*-*-*-*-*-*");
3385 xfs = xic_create_xfontset (f, base_fontname);
3387 /* Determine XIC style. */
3388 if (xic_style == 0)
3390 XIMStyles supported_list;
3391 supported_list.count_styles = (sizeof supported_xim_styles
3392 / sizeof supported_xim_styles[0]);
3393 supported_list.supported_styles = supported_xim_styles;
3394 xic_style = best_xim_style (&supported_list,
3395 FRAME_X_XIM_STYLES (f));
3398 preedit_attr = XVaCreateNestedList (0,
3399 XNFontSet, xfs,
3400 XNForeground,
3401 FRAME_FOREGROUND_PIXEL (f),
3402 XNBackground,
3403 FRAME_BACKGROUND_PIXEL (f),
3404 (xic_style & XIMPreeditPosition
3405 ? XNSpotLocation
3406 : NULL),
3407 &spot,
3408 NULL);
3409 status_attr = XVaCreateNestedList (0,
3410 XNArea,
3411 &s_area,
3412 XNFontSet,
3413 xfs,
3414 XNForeground,
3415 FRAME_FOREGROUND_PIXEL (f),
3416 XNBackground,
3417 FRAME_BACKGROUND_PIXEL (f),
3418 NULL);
3420 xic = XCreateIC (xim,
3421 XNInputStyle, xic_style,
3422 XNClientWindow, FRAME_X_WINDOW(f),
3423 XNFocusWindow, FRAME_X_WINDOW(f),
3424 XNStatusAttributes, status_attr,
3425 XNPreeditAttributes, preedit_attr,
3426 NULL);
3427 XFree (preedit_attr);
3428 XFree (status_attr);
3431 FRAME_XIC (f) = xic;
3432 FRAME_XIC_STYLE (f) = xic_style;
3433 FRAME_XIC_FONTSET (f) = xfs;
3437 /* Destroy XIC and free XIC fontset of frame F, if any. */
3439 void
3440 free_frame_xic (f)
3441 struct frame *f;
3443 if (FRAME_XIC (f) == NULL)
3444 return;
3446 XDestroyIC (FRAME_XIC (f));
3447 if (FRAME_XIC_FONTSET (f))
3448 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3450 FRAME_XIC (f) = NULL;
3451 FRAME_XIC_FONTSET (f) = NULL;
3455 /* Place preedit area for XIC of window W's frame to specified
3456 pixel position X/Y. X and Y are relative to window W. */
3458 void
3459 xic_set_preeditarea (w, x, y)
3460 struct window *w;
3461 int x, y;
3463 struct frame *f = XFRAME (w->frame);
3464 XVaNestedList attr;
3465 XPoint spot;
3467 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x);
3468 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
3469 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
3470 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3471 XFree (attr);
3475 /* Place status area for XIC in bottom right corner of frame F.. */
3477 void
3478 xic_set_statusarea (f)
3479 struct frame *f;
3481 XIC xic = FRAME_XIC (f);
3482 XVaNestedList attr;
3483 XRectangle area;
3484 XRectangle *needed;
3486 /* Negotiate geometry of status area. If input method has existing
3487 status area, use its current size. */
3488 area.x = area.y = area.width = area.height = 0;
3489 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
3490 XSetICValues (xic, XNStatusAttributes, attr, NULL);
3491 XFree (attr);
3493 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
3494 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3495 XFree (attr);
3497 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
3499 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
3500 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3501 XFree (attr);
3504 area.width = needed->width;
3505 area.height = needed->height;
3506 area.x = PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
3507 area.y = (PIXEL_HEIGHT (f) - area.height
3508 - FRAME_MENUBAR_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f));
3509 XFree (needed);
3511 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
3512 XSetICValues(xic, XNStatusAttributes, attr, NULL);
3513 XFree (attr);
3517 /* Set X fontset for XIC of frame F, using base font name
3518 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
3520 void
3521 xic_set_xfontset (f, base_fontname)
3522 struct frame *f;
3523 char *base_fontname;
3525 XVaNestedList attr;
3526 XFontSet xfs;
3528 xfs = xic_create_xfontset (f, base_fontname);
3530 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
3531 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
3532 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3533 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
3534 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
3535 XFree (attr);
3537 if (FRAME_XIC_FONTSET (f))
3538 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3539 FRAME_XIC_FONTSET (f) = xfs;
3542 #endif /* HAVE_X_I18N */
3546 #ifdef USE_X_TOOLKIT
3548 /* Create and set up the X widget for frame F. */
3550 static void
3551 x_window (f, window_prompting, minibuffer_only)
3552 struct frame *f;
3553 long window_prompting;
3554 int minibuffer_only;
3556 XClassHint class_hints;
3557 XSetWindowAttributes attributes;
3558 unsigned long attribute_mask;
3559 Widget shell_widget;
3560 Widget pane_widget;
3561 Widget frame_widget;
3562 Arg al [25];
3563 int ac;
3565 BLOCK_INPUT;
3567 /* Use the resource name as the top-level widget name
3568 for looking up resources. Make a non-Lisp copy
3569 for the window manager, so GC relocation won't bother it.
3571 Elsewhere we specify the window name for the window manager. */
3574 char *str = (char *) XSTRING (Vx_resource_name)->data;
3575 f->namebuf = (char *) xmalloc (strlen (str) + 1);
3576 strcpy (f->namebuf, str);
3579 ac = 0;
3580 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
3581 XtSetArg (al[ac], XtNinput, 1); ac++;
3582 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3583 XtSetArg (al[ac], XtNborderWidth, f->output_data.x->border_width); ac++;
3584 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3585 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3586 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3587 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
3588 applicationShellWidgetClass,
3589 FRAME_X_DISPLAY (f), al, ac);
3591 f->output_data.x->widget = shell_widget;
3592 /* maybe_set_screen_title_format (shell_widget); */
3594 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
3595 (widget_value *) NULL,
3596 shell_widget, False,
3597 (lw_callback) NULL,
3598 (lw_callback) NULL,
3599 (lw_callback) NULL,
3600 (lw_callback) NULL);
3602 ac = 0;
3603 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3604 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3605 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3606 XtSetValues (pane_widget, al, ac);
3607 f->output_data.x->column_widget = pane_widget;
3609 /* mappedWhenManaged to false tells to the paned window to not map/unmap
3610 the emacs screen when changing menubar. This reduces flickering. */
3612 ac = 0;
3613 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3614 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
3615 XtSetArg (al[ac], XtNallowResize, 1); ac++;
3616 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
3617 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
3618 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3619 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3620 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3621 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
3622 al, ac);
3624 f->output_data.x->edit_widget = frame_widget;
3626 XtManageChild (frame_widget);
3628 /* Do some needed geometry management. */
3630 int len;
3631 char *tem, shell_position[32];
3632 Arg al[2];
3633 int ac = 0;
3634 int extra_borders = 0;
3635 int menubar_size
3636 = (f->output_data.x->menubar_widget
3637 ? (f->output_data.x->menubar_widget->core.height
3638 + f->output_data.x->menubar_widget->core.border_width)
3639 : 0);
3641 #if 0 /* Experimentally, we now get the right results
3642 for -geometry -0-0 without this. 24 Aug 96, rms. */
3643 if (FRAME_EXTERNAL_MENU_BAR (f))
3645 Dimension ibw = 0;
3646 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
3647 menubar_size += ibw;
3649 #endif
3651 f->output_data.x->menubar_height = menubar_size;
3653 #ifndef USE_LUCID
3654 /* Motif seems to need this amount added to the sizes
3655 specified for the shell widget. The Athena/Lucid widgets don't.
3656 Both conclusions reached experimentally. -- rms. */
3657 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
3658 &extra_borders, NULL);
3659 extra_borders *= 2;
3660 #endif
3662 /* Convert our geometry parameters into a geometry string
3663 and specify it.
3664 Note that we do not specify here whether the position
3665 is a user-specified or program-specified one.
3666 We pass that information later, in x_wm_set_size_hints. */
3668 int left = f->output_data.x->left_pos;
3669 int xneg = window_prompting & XNegative;
3670 int top = f->output_data.x->top_pos;
3671 int yneg = window_prompting & YNegative;
3672 if (xneg)
3673 left = -left;
3674 if (yneg)
3675 top = -top;
3677 if (window_prompting & USPosition)
3678 sprintf (shell_position, "=%dx%d%c%d%c%d",
3679 PIXEL_WIDTH (f) + extra_borders,
3680 PIXEL_HEIGHT (f) + menubar_size + extra_borders,
3681 (xneg ? '-' : '+'), left,
3682 (yneg ? '-' : '+'), top);
3683 else
3684 sprintf (shell_position, "=%dx%d",
3685 PIXEL_WIDTH (f) + extra_borders,
3686 PIXEL_HEIGHT (f) + menubar_size + extra_borders);
3689 len = strlen (shell_position) + 1;
3690 /* We don't free this because we don't know whether
3691 it is safe to free it while the frame exists.
3692 It isn't worth the trouble of arranging to free it
3693 when the frame is deleted. */
3694 tem = (char *) xmalloc (len);
3695 strncpy (tem, shell_position, len);
3696 XtSetArg (al[ac], XtNgeometry, tem); ac++;
3697 XtSetValues (shell_widget, al, ac);
3700 XtManageChild (pane_widget);
3701 XtRealizeWidget (shell_widget);
3703 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
3705 validate_x_resource_name ();
3707 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3708 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3709 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
3711 #ifdef HAVE_X_I18N
3712 FRAME_XIC (f) = NULL;
3713 #ifdef USE_XIM
3714 create_frame_xic (f);
3715 #endif
3716 #endif
3718 f->output_data.x->wm_hints.input = True;
3719 f->output_data.x->wm_hints.flags |= InputHint;
3720 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3721 &f->output_data.x->wm_hints);
3723 hack_wm_protocols (f, shell_widget);
3725 #ifdef HACK_EDITRES
3726 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
3727 #endif
3729 /* Do a stupid property change to force the server to generate a
3730 PropertyNotify event so that the event_stream server timestamp will
3731 be initialized to something relevant to the time we created the window.
3733 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
3734 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3735 XA_ATOM, 32, PropModeAppend,
3736 (unsigned char*) NULL, 0);
3738 /* Make all the standard events reach the Emacs frame. */
3739 attributes.event_mask = STANDARD_EVENT_SET;
3741 #ifdef HAVE_X_I18N
3742 if (FRAME_XIC (f))
3744 /* XIM server might require some X events. */
3745 unsigned long fevent = NoEventMask;
3746 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3747 attributes.event_mask |= fevent;
3749 #endif /* HAVE_X_I18N */
3751 attribute_mask = CWEventMask;
3752 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
3753 attribute_mask, &attributes);
3755 XtMapWidget (frame_widget);
3757 /* x_set_name normally ignores requests to set the name if the
3758 requested name is the same as the current name. This is the one
3759 place where that assumption isn't correct; f->name is set, but
3760 the X server hasn't been told. */
3762 Lisp_Object name;
3763 int explicit = f->explicit_name;
3765 f->explicit_name = 0;
3766 name = f->name;
3767 f->name = Qnil;
3768 x_set_name (f, name, explicit);
3771 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3772 f->output_data.x->text_cursor);
3774 UNBLOCK_INPUT;
3776 /* This is a no-op, except under Motif. Make sure main areas are
3777 set to something reasonable, in case we get an error later. */
3778 lw_set_main_areas (pane_widget, 0, frame_widget);
3781 #else /* not USE_X_TOOLKIT */
3783 /* Create and set up the X window for frame F. */
3785 void
3786 x_window (f)
3787 struct frame *f;
3790 XClassHint class_hints;
3791 XSetWindowAttributes attributes;
3792 unsigned long attribute_mask;
3794 attributes.background_pixel = f->output_data.x->background_pixel;
3795 attributes.border_pixel = f->output_data.x->border_pixel;
3796 attributes.bit_gravity = StaticGravity;
3797 attributes.backing_store = NotUseful;
3798 attributes.save_under = True;
3799 attributes.event_mask = STANDARD_EVENT_SET;
3800 attributes.colormap = FRAME_X_COLORMAP (f);
3801 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
3802 | CWColormap);
3804 BLOCK_INPUT;
3805 FRAME_X_WINDOW (f)
3806 = XCreateWindow (FRAME_X_DISPLAY (f),
3807 f->output_data.x->parent_desc,
3808 f->output_data.x->left_pos,
3809 f->output_data.x->top_pos,
3810 PIXEL_WIDTH (f), PIXEL_HEIGHT (f),
3811 f->output_data.x->border_width,
3812 CopyFromParent, /* depth */
3813 InputOutput, /* class */
3814 FRAME_X_VISUAL (f),
3815 attribute_mask, &attributes);
3817 #ifdef HAVE_X_I18N
3818 #ifdef USE_XIM
3819 create_frame_xic (f);
3820 if (FRAME_XIC (f))
3822 /* XIM server might require some X events. */
3823 unsigned long fevent = NoEventMask;
3824 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3825 attributes.event_mask |= fevent;
3826 attribute_mask = CWEventMask;
3827 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3828 attribute_mask, &attributes);
3830 #endif
3831 #endif /* HAVE_X_I18N */
3833 validate_x_resource_name ();
3835 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3836 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3837 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
3839 /* The menubar is part of the ordinary display;
3840 it does not count in addition to the height of the window. */
3841 f->output_data.x->menubar_height = 0;
3843 /* This indicates that we use the "Passive Input" input model.
3844 Unless we do this, we don't get the Focus{In,Out} events that we
3845 need to draw the cursor correctly. Accursed bureaucrats.
3846 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
3848 f->output_data.x->wm_hints.input = True;
3849 f->output_data.x->wm_hints.flags |= InputHint;
3850 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3851 &f->output_data.x->wm_hints);
3852 f->output_data.x->wm_hints.icon_pixmap = None;
3854 /* Request "save yourself" and "delete window" commands from wm. */
3856 Atom protocols[2];
3857 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3858 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3859 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
3862 /* x_set_name normally ignores requests to set the name if the
3863 requested name is the same as the current name. This is the one
3864 place where that assumption isn't correct; f->name is set, but
3865 the X server hasn't been told. */
3867 Lisp_Object name;
3868 int explicit = f->explicit_name;
3870 f->explicit_name = 0;
3871 name = f->name;
3872 f->name = Qnil;
3873 x_set_name (f, name, explicit);
3876 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3877 f->output_data.x->text_cursor);
3879 UNBLOCK_INPUT;
3881 if (FRAME_X_WINDOW (f) == 0)
3882 error ("Unable to create window");
3885 #endif /* not USE_X_TOOLKIT */
3887 /* Handle the icon stuff for this window. Perhaps later we might
3888 want an x_set_icon_position which can be called interactively as
3889 well. */
3891 static void
3892 x_icon (f, parms)
3893 struct frame *f;
3894 Lisp_Object parms;
3896 Lisp_Object icon_x, icon_y;
3897 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3899 /* Set the position of the icon. Note that twm groups all
3900 icons in an icon window. */
3901 icon_x = x_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
3902 icon_y = x_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
3903 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
3905 CHECK_NUMBER (icon_x, 0);
3906 CHECK_NUMBER (icon_y, 0);
3908 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
3909 error ("Both left and top icon corners of icon must be specified");
3911 BLOCK_INPUT;
3913 if (! EQ (icon_x, Qunbound))
3914 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
3916 /* Start up iconic or window? */
3917 x_wm_set_window_state
3918 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
3919 Qicon)
3920 ? IconicState
3921 : NormalState));
3923 x_text_icon (f, (char *) XSTRING ((!NILP (f->icon_name)
3924 ? f->icon_name
3925 : f->name))->data);
3927 UNBLOCK_INPUT;
3930 /* Make the GCs needed for this window, setting the
3931 background, border and mouse colors; also create the
3932 mouse cursor and the gray border tile. */
3934 static char cursor_bits[] =
3936 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3937 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3938 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3939 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
3942 static void
3943 x_make_gc (f)
3944 struct frame *f;
3946 XGCValues gc_values;
3948 BLOCK_INPUT;
3950 /* Create the GCs of this frame.
3951 Note that many default values are used. */
3953 /* Normal video */
3954 gc_values.font = f->output_data.x->font->fid;
3955 gc_values.foreground = f->output_data.x->foreground_pixel;
3956 gc_values.background = f->output_data.x->background_pixel;
3957 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
3958 f->output_data.x->normal_gc
3959 = XCreateGC (FRAME_X_DISPLAY (f),
3960 FRAME_X_WINDOW (f),
3961 GCLineWidth | GCFont | GCForeground | GCBackground,
3962 &gc_values);
3964 /* Reverse video style. */
3965 gc_values.foreground = f->output_data.x->background_pixel;
3966 gc_values.background = f->output_data.x->foreground_pixel;
3967 f->output_data.x->reverse_gc
3968 = XCreateGC (FRAME_X_DISPLAY (f),
3969 FRAME_X_WINDOW (f),
3970 GCFont | GCForeground | GCBackground | GCLineWidth,
3971 &gc_values);
3973 /* Cursor has cursor-color background, background-color foreground. */
3974 gc_values.foreground = f->output_data.x->background_pixel;
3975 gc_values.background = f->output_data.x->cursor_pixel;
3976 gc_values.fill_style = FillOpaqueStippled;
3977 gc_values.stipple
3978 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
3979 FRAME_X_DISPLAY_INFO (f)->root_window,
3980 cursor_bits, 16, 16);
3981 f->output_data.x->cursor_gc
3982 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3983 (GCFont | GCForeground | GCBackground
3984 | GCFillStyle /* | GCStipple */ | GCLineWidth),
3985 &gc_values);
3987 /* Reliefs. */
3988 f->output_data.x->white_relief.gc = 0;
3989 f->output_data.x->black_relief.gc = 0;
3991 /* Create the gray border tile used when the pointer is not in
3992 the frame. Since this depends on the frame's pixel values,
3993 this must be done on a per-frame basis. */
3994 f->output_data.x->border_tile
3995 = (XCreatePixmapFromBitmapData
3996 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
3997 gray_bits, gray_width, gray_height,
3998 f->output_data.x->foreground_pixel,
3999 f->output_data.x->background_pixel,
4000 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
4002 UNBLOCK_INPUT;
4006 /* Free what was was allocated in x_make_gc. */
4008 void
4009 x_free_gcs (f)
4010 struct frame *f;
4012 Display *dpy = FRAME_X_DISPLAY (f);
4014 BLOCK_INPUT;
4016 if (f->output_data.x->normal_gc)
4018 XFreeGC (dpy, f->output_data.x->normal_gc);
4019 f->output_data.x->normal_gc = 0;
4022 if (f->output_data.x->reverse_gc)
4024 XFreeGC (dpy, f->output_data.x->reverse_gc);
4025 f->output_data.x->reverse_gc = 0;
4028 if (f->output_data.x->cursor_gc)
4030 XFreeGC (dpy, f->output_data.x->cursor_gc);
4031 f->output_data.x->cursor_gc = 0;
4034 if (f->output_data.x->border_tile)
4036 XFreePixmap (dpy, f->output_data.x->border_tile);
4037 f->output_data.x->border_tile = 0;
4040 UNBLOCK_INPUT;
4044 /* Handler for signals raised during x_create_frame and
4045 x_create_top_frame. FRAME is the frame which is partially
4046 constructed. */
4048 static Lisp_Object
4049 unwind_create_frame (frame)
4050 Lisp_Object frame;
4052 struct frame *f = XFRAME (frame);
4054 /* If frame is ``official'', nothing to do. */
4055 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
4057 #if GLYPH_DEBUG
4058 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4059 #endif
4061 x_free_frame_resources (f);
4063 /* Check that reference counts are indeed correct. */
4064 xassert (dpyinfo->reference_count == dpyinfo_refcount);
4065 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
4066 return Qt;
4069 return Qnil;
4073 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4074 1, 1, 0,
4075 "Make a new X window, which is called a \"frame\" in Emacs terms.\n\
4076 Returns an Emacs frame object.\n\
4077 ALIST is an alist of frame parameters.\n\
4078 If the parameters specify that the frame should not have a minibuffer,\n\
4079 and do not specify a specific minibuffer window to use,\n\
4080 then `default-minibuffer-frame' must be a frame whose minibuffer can\n\
4081 be shared by the new frame.\n\
4083 This function is an internal primitive--use `make-frame' instead.")
4084 (parms)
4085 Lisp_Object parms;
4087 struct frame *f;
4088 Lisp_Object frame, tem;
4089 Lisp_Object name;
4090 int minibuffer_only = 0;
4091 long window_prompting = 0;
4092 int width, height;
4093 int count = BINDING_STACK_SIZE ();
4094 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4095 Lisp_Object display;
4096 struct x_display_info *dpyinfo = NULL;
4097 Lisp_Object parent;
4098 struct kboard *kb;
4100 check_x ();
4102 /* Use this general default value to start with
4103 until we know if this frame has a specified name. */
4104 Vx_resource_name = Vinvocation_name;
4106 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
4107 if (EQ (display, Qunbound))
4108 display = Qnil;
4109 dpyinfo = check_x_display_info (display);
4110 #ifdef MULTI_KBOARD
4111 kb = dpyinfo->kboard;
4112 #else
4113 kb = &the_only_kboard;
4114 #endif
4116 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4117 if (!STRINGP (name)
4118 && ! EQ (name, Qunbound)
4119 && ! NILP (name))
4120 error ("Invalid frame name--not a string or nil");
4122 if (STRINGP (name))
4123 Vx_resource_name = name;
4125 /* See if parent window is specified. */
4126 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4127 if (EQ (parent, Qunbound))
4128 parent = Qnil;
4129 if (! NILP (parent))
4130 CHECK_NUMBER (parent, 0);
4132 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4133 /* No need to protect DISPLAY because that's not used after passing
4134 it to make_frame_without_minibuffer. */
4135 frame = Qnil;
4136 GCPRO4 (parms, parent, name, frame);
4137 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
4138 RES_TYPE_SYMBOL);
4139 if (EQ (tem, Qnone) || NILP (tem))
4140 f = make_frame_without_minibuffer (Qnil, kb, display);
4141 else if (EQ (tem, Qonly))
4143 f = make_minibuffer_frame ();
4144 minibuffer_only = 1;
4146 else if (WINDOWP (tem))
4147 f = make_frame_without_minibuffer (tem, kb, display);
4148 else
4149 f = make_frame (1);
4151 XSETFRAME (frame, f);
4153 /* Note that X Windows does support scroll bars. */
4154 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
4156 f->output_method = output_x_window;
4157 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4158 bzero (f->output_data.x, sizeof (struct x_output));
4159 f->output_data.x->icon_bitmap = -1;
4160 f->output_data.x->fontset = -1;
4161 f->output_data.x->scroll_bar_foreground_pixel = -1;
4162 f->output_data.x->scroll_bar_background_pixel = -1;
4163 record_unwind_protect (unwind_create_frame, frame);
4165 f->icon_name
4166 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
4167 RES_TYPE_STRING);
4168 if (! STRINGP (f->icon_name))
4169 f->icon_name = Qnil;
4171 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4172 #if GLYPH_DEBUG
4173 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4174 dpyinfo_refcount = dpyinfo->reference_count;
4175 #endif /* GLYPH_DEBUG */
4176 #ifdef MULTI_KBOARD
4177 FRAME_KBOARD (f) = kb;
4178 #endif
4180 /* These colors will be set anyway later, but it's important
4181 to get the color reference counts right, so initialize them! */
4183 Lisp_Object black;
4184 struct gcpro gcpro1;
4186 /* Function x_decode_color can signal an error. Make
4187 sure to initialize color slots so that we won't try
4188 to free colors we haven't allocated. */
4189 f->output_data.x->foreground_pixel = -1;
4190 f->output_data.x->background_pixel = -1;
4191 f->output_data.x->cursor_pixel = -1;
4192 f->output_data.x->cursor_foreground_pixel = -1;
4193 f->output_data.x->border_pixel = -1;
4194 f->output_data.x->mouse_pixel = -1;
4196 black = build_string ("black");
4197 GCPRO1 (black);
4198 f->output_data.x->foreground_pixel
4199 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4200 f->output_data.x->background_pixel
4201 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4202 f->output_data.x->cursor_pixel
4203 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4204 f->output_data.x->cursor_foreground_pixel
4205 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4206 f->output_data.x->border_pixel
4207 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4208 f->output_data.x->mouse_pixel
4209 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4210 UNGCPRO;
4213 /* Specify the parent under which to make this X window. */
4215 if (!NILP (parent))
4217 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
4218 f->output_data.x->explicit_parent = 1;
4220 else
4222 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4223 f->output_data.x->explicit_parent = 0;
4226 /* Set the name; the functions to which we pass f expect the name to
4227 be set. */
4228 if (EQ (name, Qunbound) || NILP (name))
4230 f->name = build_string (dpyinfo->x_id_name);
4231 f->explicit_name = 0;
4233 else
4235 f->name = name;
4236 f->explicit_name = 1;
4237 /* use the frame's title when getting resources for this frame. */
4238 specbind (Qx_resource_name, name);
4241 /* Extract the window parameters from the supplied values
4242 that are needed to determine window geometry. */
4244 Lisp_Object font;
4246 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4248 BLOCK_INPUT;
4249 /* First, try whatever font the caller has specified. */
4250 if (STRINGP (font))
4252 tem = Fquery_fontset (font, Qnil);
4253 if (STRINGP (tem))
4254 font = x_new_fontset (f, XSTRING (tem)->data);
4255 else
4256 font = x_new_font (f, XSTRING (font)->data);
4259 /* Try out a font which we hope has bold and italic variations. */
4260 if (!STRINGP (font))
4261 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4262 if (!STRINGP (font))
4263 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4264 if (! STRINGP (font))
4265 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4266 if (! STRINGP (font))
4267 /* This was formerly the first thing tried, but it finds too many fonts
4268 and takes too long. */
4269 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4270 /* If those didn't work, look for something which will at least work. */
4271 if (! STRINGP (font))
4272 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4273 UNBLOCK_INPUT;
4274 if (! STRINGP (font))
4275 font = build_string ("fixed");
4277 x_default_parameter (f, parms, Qfont, font,
4278 "font", "Font", RES_TYPE_STRING);
4281 #ifdef USE_LUCID
4282 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
4283 whereby it fails to get any font. */
4284 xlwmenu_default_font = f->output_data.x->font;
4285 #endif
4287 x_default_parameter (f, parms, Qborder_width, make_number (2),
4288 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4290 /* This defaults to 2 in order to match xterm. We recognize either
4291 internalBorderWidth or internalBorder (which is what xterm calls
4292 it). */
4293 if (NILP (Fassq (Qinternal_border_width, parms)))
4295 Lisp_Object value;
4297 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4298 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4299 if (! EQ (value, Qunbound))
4300 parms = Fcons (Fcons (Qinternal_border_width, value),
4301 parms);
4303 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4304 "internalBorderWidth", "internalBorderWidth",
4305 RES_TYPE_NUMBER);
4306 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
4307 "verticalScrollBars", "ScrollBars",
4308 RES_TYPE_SYMBOL);
4310 /* Also do the stuff which must be set before the window exists. */
4311 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4312 "foreground", "Foreground", RES_TYPE_STRING);
4313 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4314 "background", "Background", RES_TYPE_STRING);
4315 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4316 "pointerColor", "Foreground", RES_TYPE_STRING);
4317 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4318 "cursorColor", "Foreground", RES_TYPE_STRING);
4319 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4320 "borderColor", "BorderColor", RES_TYPE_STRING);
4321 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
4322 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4323 x_default_parameter (f, parms, Qline_spacing, Qnil,
4324 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4326 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
4327 "scrollBarForeground",
4328 "ScrollBarForeground", 1);
4329 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
4330 "scrollBarBackground",
4331 "ScrollBarBackground", 0);
4333 /* Init faces before x_default_parameter is called for scroll-bar
4334 parameters because that function calls x_set_scroll_bar_width,
4335 which calls change_frame_size, which calls Fset_window_buffer,
4336 which runs hooks, which call Fvertical_motion. At the end, we
4337 end up in init_iterator with a null face cache, which should not
4338 happen. */
4339 init_frame_faces (f);
4341 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
4342 "menuBar", "MenuBar", RES_TYPE_NUMBER);
4343 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
4344 "toolBar", "ToolBar", RES_TYPE_NUMBER);
4345 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
4346 "bufferPredicate", "BufferPredicate",
4347 RES_TYPE_SYMBOL);
4348 x_default_parameter (f, parms, Qtitle, Qnil,
4349 "title", "Title", RES_TYPE_STRING);
4350 x_default_parameter (f, parms, Qwait_for_wm, Qt,
4351 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
4353 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4355 /* Add the tool-bar height to the initial frame height so that the
4356 user gets a text display area of the size he specified with -g or
4357 via .Xdefaults. Later changes of the tool-bar height don't
4358 change the frame size. This is done so that users can create
4359 tall Emacs frames without having to guess how tall the tool-bar
4360 will get. */
4361 if (FRAME_TOOL_BAR_LINES (f))
4363 int margin, relief, bar_height;
4365 relief = (tool_bar_button_relief > 0
4366 ? tool_bar_button_relief
4367 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
4369 if (INTEGERP (Vtool_bar_button_margin)
4370 && XINT (Vtool_bar_button_margin) > 0)
4371 margin = XFASTINT (Vtool_bar_button_margin);
4372 else if (CONSP (Vtool_bar_button_margin)
4373 && INTEGERP (XCDR (Vtool_bar_button_margin))
4374 && XINT (XCDR (Vtool_bar_button_margin)) > 0)
4375 margin = XFASTINT (XCDR (Vtool_bar_button_margin));
4376 else
4377 margin = 0;
4379 bar_height = DEFAULT_TOOL_BAR_IMAGE_HEIGHT + 2 * margin + 2 * relief;
4380 f->height += (bar_height + CANON_Y_UNIT (f) - 1) / CANON_Y_UNIT (f);
4383 /* Compute the size of the X window. */
4384 window_prompting = x_figure_window_size (f, parms);
4386 if (window_prompting & XNegative)
4388 if (window_prompting & YNegative)
4389 f->output_data.x->win_gravity = SouthEastGravity;
4390 else
4391 f->output_data.x->win_gravity = NorthEastGravity;
4393 else
4395 if (window_prompting & YNegative)
4396 f->output_data.x->win_gravity = SouthWestGravity;
4397 else
4398 f->output_data.x->win_gravity = NorthWestGravity;
4401 f->output_data.x->size_hint_flags = window_prompting;
4403 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4404 f->no_split = minibuffer_only || EQ (tem, Qt);
4406 /* Create the X widget or window. */
4407 #ifdef USE_X_TOOLKIT
4408 x_window (f, window_prompting, minibuffer_only);
4409 #else
4410 x_window (f);
4411 #endif
4413 x_icon (f, parms);
4414 x_make_gc (f);
4416 /* Now consider the frame official. */
4417 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4418 Vframe_list = Fcons (frame, Vframe_list);
4420 /* We need to do this after creating the X window, so that the
4421 icon-creation functions can say whose icon they're describing. */
4422 x_default_parameter (f, parms, Qicon_type, Qnil,
4423 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4425 x_default_parameter (f, parms, Qauto_raise, Qnil,
4426 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4427 x_default_parameter (f, parms, Qauto_lower, Qnil,
4428 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4429 x_default_parameter (f, parms, Qcursor_type, Qbox,
4430 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4431 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
4432 "scrollBarWidth", "ScrollBarWidth",
4433 RES_TYPE_NUMBER);
4435 /* Dimensions, especially f->height, must be done via change_frame_size.
4436 Change will not be effected unless different from the current
4437 f->height. */
4438 width = f->width;
4439 height = f->height;
4441 f->height = 0;
4442 SET_FRAME_WIDTH (f, 0);
4443 change_frame_size (f, height, width, 1, 0, 0);
4445 /* Set up faces after all frame parameters are known. This call
4446 also merges in face attributes specified for new frames. If we
4447 don't do this, the `menu' face for instance won't have the right
4448 colors, and the menu bar won't appear in the specified colors for
4449 new frames. */
4450 call1 (Qface_set_after_frame_default, frame);
4452 #ifdef USE_X_TOOLKIT
4453 /* Create the menu bar. */
4454 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4456 /* If this signals an error, we haven't set size hints for the
4457 frame and we didn't make it visible. */
4458 initialize_frame_menubar (f);
4460 /* This is a no-op, except under Motif where it arranges the
4461 main window for the widgets on it. */
4462 lw_set_main_areas (f->output_data.x->column_widget,
4463 f->output_data.x->menubar_widget,
4464 f->output_data.x->edit_widget);
4466 #endif /* USE_X_TOOLKIT */
4468 /* Tell the server what size and position, etc, we want, and how
4469 badly we want them. This should be done after we have the menu
4470 bar so that its size can be taken into account. */
4471 BLOCK_INPUT;
4472 x_wm_set_size_hint (f, window_prompting, 0);
4473 UNBLOCK_INPUT;
4475 /* Make the window appear on the frame and enable display, unless
4476 the caller says not to. However, with explicit parent, Emacs
4477 cannot control visibility, so don't try. */
4478 if (! f->output_data.x->explicit_parent)
4480 Lisp_Object visibility;
4482 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
4483 RES_TYPE_SYMBOL);
4484 if (EQ (visibility, Qunbound))
4485 visibility = Qt;
4487 if (EQ (visibility, Qicon))
4488 x_iconify_frame (f);
4489 else if (! NILP (visibility))
4490 x_make_frame_visible (f);
4491 else
4492 /* Must have been Qnil. */
4496 UNGCPRO;
4498 /* Make sure windows on this frame appear in calls to next-window
4499 and similar functions. */
4500 Vwindow_list = Qnil;
4502 return unbind_to (count, frame);
4506 /* FRAME is used only to get a handle on the X display. We don't pass the
4507 display info directly because we're called from frame.c, which doesn't
4508 know about that structure. */
4510 Lisp_Object
4511 x_get_focus_frame (frame)
4512 struct frame *frame;
4514 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
4515 Lisp_Object xfocus;
4516 if (! dpyinfo->x_focus_frame)
4517 return Qnil;
4519 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
4520 return xfocus;
4524 /* In certain situations, when the window manager follows a
4525 click-to-focus policy, there seems to be no way around calling
4526 XSetInputFocus to give another frame the input focus .
4528 In an ideal world, XSetInputFocus should generally be avoided so
4529 that applications don't interfere with the window manager's focus
4530 policy. But I think it's okay to use when it's clearly done
4531 following a user-command. */
4533 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4534 "Set the input focus to FRAME.\n\
4535 FRAME nil means use the selected frame.")
4536 (frame)
4537 Lisp_Object frame;
4539 struct frame *f = check_x_frame (frame);
4540 Display *dpy = FRAME_X_DISPLAY (f);
4541 int count;
4543 BLOCK_INPUT;
4544 count = x_catch_errors (dpy);
4545 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4546 RevertToParent, CurrentTime);
4547 x_uncatch_errors (dpy, count);
4548 UNBLOCK_INPUT;
4550 return Qnil;
4554 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4555 "Internal function called by `color-defined-p', which see.")
4556 (color, frame)
4557 Lisp_Object color, frame;
4559 XColor foo;
4560 FRAME_PTR f = check_x_frame (frame);
4562 CHECK_STRING (color, 1);
4564 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4565 return Qt;
4566 else
4567 return Qnil;
4570 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4571 "Internal function called by `color-values', which see.")
4572 (color, frame)
4573 Lisp_Object color, frame;
4575 XColor foo;
4576 FRAME_PTR f = check_x_frame (frame);
4578 CHECK_STRING (color, 1);
4580 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4582 Lisp_Object rgb[3];
4584 rgb[0] = make_number (foo.red);
4585 rgb[1] = make_number (foo.green);
4586 rgb[2] = make_number (foo.blue);
4587 return Flist (3, rgb);
4589 else
4590 return Qnil;
4593 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4594 "Internal function called by `display-color-p', which see.")
4595 (display)
4596 Lisp_Object display;
4598 struct x_display_info *dpyinfo = check_x_display_info (display);
4600 if (dpyinfo->n_planes <= 2)
4601 return Qnil;
4603 switch (dpyinfo->visual->class)
4605 case StaticColor:
4606 case PseudoColor:
4607 case TrueColor:
4608 case DirectColor:
4609 return Qt;
4611 default:
4612 return Qnil;
4616 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
4617 0, 1, 0,
4618 "Return t if the X display supports shades of gray.\n\
4619 Note that color displays do support shades of gray.\n\
4620 The optional argument DISPLAY specifies which display to ask about.\n\
4621 DISPLAY should be either a frame or a display name (a string).\n\
4622 If omitted or nil, that stands for the selected frame's display.")
4623 (display)
4624 Lisp_Object display;
4626 struct x_display_info *dpyinfo = check_x_display_info (display);
4628 if (dpyinfo->n_planes <= 1)
4629 return Qnil;
4631 switch (dpyinfo->visual->class)
4633 case StaticColor:
4634 case PseudoColor:
4635 case TrueColor:
4636 case DirectColor:
4637 case StaticGray:
4638 case GrayScale:
4639 return Qt;
4641 default:
4642 return Qnil;
4646 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
4647 0, 1, 0,
4648 "Returns the width in pixels of the X display DISPLAY.\n\
4649 The optional argument DISPLAY specifies which display to ask about.\n\
4650 DISPLAY should be either a frame or a display name (a string).\n\
4651 If omitted or nil, that stands for the selected frame's display.")
4652 (display)
4653 Lisp_Object display;
4655 struct x_display_info *dpyinfo = check_x_display_info (display);
4657 return make_number (dpyinfo->width);
4660 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4661 Sx_display_pixel_height, 0, 1, 0,
4662 "Returns the height in pixels of the X display DISPLAY.\n\
4663 The optional argument DISPLAY specifies which display to ask about.\n\
4664 DISPLAY should be either a frame or a display name (a string).\n\
4665 If omitted or nil, that stands for the selected frame's display.")
4666 (display)
4667 Lisp_Object display;
4669 struct x_display_info *dpyinfo = check_x_display_info (display);
4671 return make_number (dpyinfo->height);
4674 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4675 0, 1, 0,
4676 "Returns the number of bitplanes of the X display DISPLAY.\n\
4677 The optional argument DISPLAY specifies which display to ask about.\n\
4678 DISPLAY should be either a frame or a display name (a string).\n\
4679 If omitted or nil, that stands for the selected frame's display.")
4680 (display)
4681 Lisp_Object display;
4683 struct x_display_info *dpyinfo = check_x_display_info (display);
4685 return make_number (dpyinfo->n_planes);
4688 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4689 0, 1, 0,
4690 "Returns the number of color cells of the X display DISPLAY.\n\
4691 The optional argument DISPLAY specifies which display to ask about.\n\
4692 DISPLAY should be either a frame or a display name (a string).\n\
4693 If omitted or nil, that stands for the selected frame's display.")
4694 (display)
4695 Lisp_Object display;
4697 struct x_display_info *dpyinfo = check_x_display_info (display);
4699 return make_number (DisplayCells (dpyinfo->display,
4700 XScreenNumberOfScreen (dpyinfo->screen)));
4703 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4704 Sx_server_max_request_size,
4705 0, 1, 0,
4706 "Returns the maximum request size of the X server of display DISPLAY.\n\
4707 The optional argument DISPLAY specifies which display to ask about.\n\
4708 DISPLAY should be either a frame or a display name (a string).\n\
4709 If omitted or nil, that stands for the selected frame's display.")
4710 (display)
4711 Lisp_Object display;
4713 struct x_display_info *dpyinfo = check_x_display_info (display);
4715 return make_number (MAXREQUEST (dpyinfo->display));
4718 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4719 "Returns the vendor ID string of the X server of display DISPLAY.\n\
4720 The optional argument DISPLAY specifies which display to ask about.\n\
4721 DISPLAY should be either a frame or a display name (a string).\n\
4722 If omitted or nil, that stands for the selected frame's display.")
4723 (display)
4724 Lisp_Object display;
4726 struct x_display_info *dpyinfo = check_x_display_info (display);
4727 char *vendor = ServerVendor (dpyinfo->display);
4729 if (! vendor) vendor = "";
4730 return build_string (vendor);
4733 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4734 "Returns the version numbers of the X server of display DISPLAY.\n\
4735 The value is a list of three integers: the major and minor\n\
4736 version numbers of the X Protocol in use, and the vendor-specific release\n\
4737 number. See also the function `x-server-vendor'.\n\n\
4738 The optional argument DISPLAY specifies which display to ask about.\n\
4739 DISPLAY should be either a frame or a display name (a string).\n\
4740 If omitted or nil, that stands for the selected frame's display.")
4741 (display)
4742 Lisp_Object display;
4744 struct x_display_info *dpyinfo = check_x_display_info (display);
4745 Display *dpy = dpyinfo->display;
4747 return Fcons (make_number (ProtocolVersion (dpy)),
4748 Fcons (make_number (ProtocolRevision (dpy)),
4749 Fcons (make_number (VendorRelease (dpy)), Qnil)));
4752 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4753 "Returns the number of screens on the X server of display DISPLAY.\n\
4754 The optional argument DISPLAY specifies which display to ask about.\n\
4755 DISPLAY should be either a frame or a display name (a string).\n\
4756 If omitted or nil, that stands for the selected frame's display.")
4757 (display)
4758 Lisp_Object display;
4760 struct x_display_info *dpyinfo = check_x_display_info (display);
4762 return make_number (ScreenCount (dpyinfo->display));
4765 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
4766 "Returns the height in millimeters of the X display DISPLAY.\n\
4767 The optional argument DISPLAY specifies which display to ask about.\n\
4768 DISPLAY should be either a frame or a display name (a string).\n\
4769 If omitted or nil, that stands for the selected frame's display.")
4770 (display)
4771 Lisp_Object display;
4773 struct x_display_info *dpyinfo = check_x_display_info (display);
4775 return make_number (HeightMMOfScreen (dpyinfo->screen));
4778 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4779 "Returns the width in millimeters of the X display DISPLAY.\n\
4780 The optional argument DISPLAY specifies which display to ask about.\n\
4781 DISPLAY should be either a frame or a display name (a string).\n\
4782 If omitted or nil, that stands for the selected frame's display.")
4783 (display)
4784 Lisp_Object display;
4786 struct x_display_info *dpyinfo = check_x_display_info (display);
4788 return make_number (WidthMMOfScreen (dpyinfo->screen));
4791 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4792 Sx_display_backing_store, 0, 1, 0,
4793 "Returns an indication of whether X display DISPLAY does backing store.\n\
4794 The value may be `always', `when-mapped', or `not-useful'.\n\
4795 The optional argument DISPLAY specifies which display to ask about.\n\
4796 DISPLAY should be either a frame or a display name (a string).\n\
4797 If omitted or nil, that stands for the selected frame's display.")
4798 (display)
4799 Lisp_Object display;
4801 struct x_display_info *dpyinfo = check_x_display_info (display);
4802 Lisp_Object result;
4804 switch (DoesBackingStore (dpyinfo->screen))
4806 case Always:
4807 result = intern ("always");
4808 break;
4810 case WhenMapped:
4811 result = intern ("when-mapped");
4812 break;
4814 case NotUseful:
4815 result = intern ("not-useful");
4816 break;
4818 default:
4819 error ("Strange value for BackingStore parameter of screen");
4820 result = Qnil;
4823 return result;
4826 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4827 Sx_display_visual_class, 0, 1, 0,
4828 "Returns the visual class of the X display DISPLAY.\n\
4829 The value is one of the symbols `static-gray', `gray-scale',\n\
4830 `static-color', `pseudo-color', `true-color', or `direct-color'.\n\n\
4831 The optional argument DISPLAY specifies which display to ask about.\n\
4832 DISPLAY should be either a frame or a display name (a string).\n\
4833 If omitted or nil, that stands for the selected frame's display.")
4834 (display)
4835 Lisp_Object display;
4837 struct x_display_info *dpyinfo = check_x_display_info (display);
4838 Lisp_Object result;
4840 switch (dpyinfo->visual->class)
4842 case StaticGray:
4843 result = intern ("static-gray");
4844 break;
4845 case GrayScale:
4846 result = intern ("gray-scale");
4847 break;
4848 case StaticColor:
4849 result = intern ("static-color");
4850 break;
4851 case PseudoColor:
4852 result = intern ("pseudo-color");
4853 break;
4854 case TrueColor:
4855 result = intern ("true-color");
4856 break;
4857 case DirectColor:
4858 result = intern ("direct-color");
4859 break;
4860 default:
4861 error ("Display has an unknown visual class");
4862 result = Qnil;
4865 return result;
4868 DEFUN ("x-display-save-under", Fx_display_save_under,
4869 Sx_display_save_under, 0, 1, 0,
4870 "Returns t if the X display DISPLAY supports the save-under feature.\n\
4871 The optional argument DISPLAY specifies which display to ask about.\n\
4872 DISPLAY should be either a frame or a display name (a string).\n\
4873 If omitted or nil, that stands for the selected frame's display.")
4874 (display)
4875 Lisp_Object display;
4877 struct x_display_info *dpyinfo = check_x_display_info (display);
4879 if (DoesSaveUnders (dpyinfo->screen) == True)
4880 return Qt;
4881 else
4882 return Qnil;
4886 x_pixel_width (f)
4887 register struct frame *f;
4889 return PIXEL_WIDTH (f);
4893 x_pixel_height (f)
4894 register struct frame *f;
4896 return PIXEL_HEIGHT (f);
4900 x_char_width (f)
4901 register struct frame *f;
4903 return FONT_WIDTH (f->output_data.x->font);
4907 x_char_height (f)
4908 register struct frame *f;
4910 return f->output_data.x->line_height;
4914 x_screen_planes (f)
4915 register struct frame *f;
4917 return FRAME_X_DISPLAY_INFO (f)->n_planes;
4922 /************************************************************************
4923 X Displays
4924 ************************************************************************/
4927 /* Mapping visual names to visuals. */
4929 static struct visual_class
4931 char *name;
4932 int class;
4934 visual_classes[] =
4936 {"StaticGray", StaticGray},
4937 {"GrayScale", GrayScale},
4938 {"StaticColor", StaticColor},
4939 {"PseudoColor", PseudoColor},
4940 {"TrueColor", TrueColor},
4941 {"DirectColor", DirectColor},
4942 NULL
4946 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4948 /* Value is the screen number of screen SCR. This is a substitute for
4949 the X function with the same name when that doesn't exist. */
4952 XScreenNumberOfScreen (scr)
4953 register Screen *scr;
4955 Display *dpy = scr->display;
4956 int i;
4958 for (i = 0; i < dpy->nscreens; ++i)
4959 if (scr == dpy->screens[i])
4960 break;
4962 return i;
4965 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4968 /* Select the visual that should be used on display DPYINFO. Set
4969 members of DPYINFO appropriately. Called from x_term_init. */
4971 void
4972 select_visual (dpyinfo)
4973 struct x_display_info *dpyinfo;
4975 Display *dpy = dpyinfo->display;
4976 Screen *screen = dpyinfo->screen;
4977 Lisp_Object value;
4979 /* See if a visual is specified. */
4980 value = display_x_get_resource (dpyinfo,
4981 build_string ("visualClass"),
4982 build_string ("VisualClass"),
4983 Qnil, Qnil);
4984 if (STRINGP (value))
4986 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4987 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4988 depth, a decimal number. NAME is compared with case ignored. */
4989 char *s = (char *) alloca (STRING_BYTES (XSTRING (value)) + 1);
4990 char *dash;
4991 int i, class = -1;
4992 XVisualInfo vinfo;
4994 strcpy (s, XSTRING (value)->data);
4995 dash = index (s, '-');
4996 if (dash)
4998 dpyinfo->n_planes = atoi (dash + 1);
4999 *dash = '\0';
5001 else
5002 /* We won't find a matching visual with depth 0, so that
5003 an error will be printed below. */
5004 dpyinfo->n_planes = 0;
5006 /* Determine the visual class. */
5007 for (i = 0; visual_classes[i].name; ++i)
5008 if (xstricmp (s, visual_classes[i].name) == 0)
5010 class = visual_classes[i].class;
5011 break;
5014 /* Look up a matching visual for the specified class. */
5015 if (class == -1
5016 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
5017 dpyinfo->n_planes, class, &vinfo))
5018 fatal ("Invalid visual specification `%s'", XSTRING (value)->data);
5020 dpyinfo->visual = vinfo.visual;
5022 else
5024 int n_visuals;
5025 XVisualInfo *vinfo, vinfo_template;
5027 dpyinfo->visual = DefaultVisualOfScreen (screen);
5029 #ifdef HAVE_X11R4
5030 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
5031 #else
5032 vinfo_template.visualid = dpyinfo->visual->visualid;
5033 #endif
5034 vinfo_template.screen = XScreenNumberOfScreen (screen);
5035 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
5036 &vinfo_template, &n_visuals);
5037 if (n_visuals != 1)
5038 fatal ("Can't get proper X visual info");
5040 dpyinfo->n_planes = vinfo->depth;
5041 XFree ((char *) vinfo);
5046 /* Return the X display structure for the display named NAME.
5047 Open a new connection if necessary. */
5049 struct x_display_info *
5050 x_display_info_for_name (name)
5051 Lisp_Object name;
5053 Lisp_Object names;
5054 struct x_display_info *dpyinfo;
5056 CHECK_STRING (name, 0);
5058 if (! EQ (Vwindow_system, intern ("x")))
5059 error ("Not using X Windows");
5061 for (dpyinfo = x_display_list, names = x_display_name_list;
5062 dpyinfo;
5063 dpyinfo = dpyinfo->next, names = XCDR (names))
5065 Lisp_Object tem;
5066 tem = Fstring_equal (XCAR (XCAR (names)), name);
5067 if (!NILP (tem))
5068 return dpyinfo;
5071 /* Use this general default value to start with. */
5072 Vx_resource_name = Vinvocation_name;
5074 validate_x_resource_name ();
5076 dpyinfo = x_term_init (name, (char *)0,
5077 (char *) XSTRING (Vx_resource_name)->data);
5079 if (dpyinfo == 0)
5080 error ("Cannot connect to X server %s", XSTRING (name)->data);
5082 x_in_use = 1;
5083 XSETFASTINT (Vwindow_system_version, 11);
5085 return dpyinfo;
5089 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5090 1, 3, 0, "Open a connection to an X server.\n\
5091 DISPLAY is the name of the display to connect to.\n\
5092 Optional second arg XRM-STRING is a string of resources in xrdb format.\n\
5093 If the optional third arg MUST-SUCCEED is non-nil,\n\
5094 terminate Emacs if we can't open the connection.")
5095 (display, xrm_string, must_succeed)
5096 Lisp_Object display, xrm_string, must_succeed;
5098 unsigned char *xrm_option;
5099 struct x_display_info *dpyinfo;
5101 CHECK_STRING (display, 0);
5102 if (! NILP (xrm_string))
5103 CHECK_STRING (xrm_string, 1);
5105 if (! EQ (Vwindow_system, intern ("x")))
5106 error ("Not using X Windows");
5108 if (! NILP (xrm_string))
5109 xrm_option = (unsigned char *) XSTRING (xrm_string)->data;
5110 else
5111 xrm_option = (unsigned char *) 0;
5113 validate_x_resource_name ();
5115 /* This is what opens the connection and sets x_current_display.
5116 This also initializes many symbols, such as those used for input. */
5117 dpyinfo = x_term_init (display, xrm_option,
5118 (char *) XSTRING (Vx_resource_name)->data);
5120 if (dpyinfo == 0)
5122 if (!NILP (must_succeed))
5123 fatal ("Cannot connect to X server %s.\n\
5124 Check the DISPLAY environment variable or use `-d'.\n\
5125 Also use the `xhost' program to verify that it is set to permit\n\
5126 connections from your machine.\n",
5127 XSTRING (display)->data);
5128 else
5129 error ("Cannot connect to X server %s", XSTRING (display)->data);
5132 x_in_use = 1;
5134 XSETFASTINT (Vwindow_system_version, 11);
5135 return Qnil;
5138 DEFUN ("x-close-connection", Fx_close_connection,
5139 Sx_close_connection, 1, 1, 0,
5140 "Close the connection to DISPLAY's X server.\n\
5141 For DISPLAY, specify either a frame or a display name (a string).\n\
5142 If DISPLAY is nil, that stands for the selected frame's display.")
5143 (display)
5144 Lisp_Object display;
5146 struct x_display_info *dpyinfo = check_x_display_info (display);
5147 int i;
5149 if (dpyinfo->reference_count > 0)
5150 error ("Display still has frames on it");
5152 BLOCK_INPUT;
5153 /* Free the fonts in the font table. */
5154 for (i = 0; i < dpyinfo->n_fonts; i++)
5155 if (dpyinfo->font_table[i].name)
5157 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
5158 xfree (dpyinfo->font_table[i].full_name);
5159 xfree (dpyinfo->font_table[i].name);
5160 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
5163 x_destroy_all_bitmaps (dpyinfo);
5164 XSetCloseDownMode (dpyinfo->display, DestroyAll);
5166 #ifdef USE_X_TOOLKIT
5167 XtCloseDisplay (dpyinfo->display);
5168 #else
5169 XCloseDisplay (dpyinfo->display);
5170 #endif
5172 x_delete_display (dpyinfo);
5173 UNBLOCK_INPUT;
5175 return Qnil;
5178 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5179 "Return the list of display names that Emacs has connections to.")
5182 Lisp_Object tail, result;
5184 result = Qnil;
5185 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
5186 result = Fcons (XCAR (XCAR (tail)), result);
5188 return result;
5191 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5192 "If ON is non-nil, report X errors as soon as the erring request is made.\n\
5193 If ON is nil, allow buffering of requests.\n\
5194 Turning on synchronization prohibits the Xlib routines from buffering\n\
5195 requests and seriously degrades performance, but makes debugging much\n\
5196 easier.\n\
5197 The optional second argument DISPLAY specifies which display to act on.\n\
5198 DISPLAY should be either a frame or a display name (a string).\n\
5199 If DISPLAY is omitted or nil, that stands for the selected frame's display.")
5200 (on, display)
5201 Lisp_Object display, on;
5203 struct x_display_info *dpyinfo = check_x_display_info (display);
5205 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
5207 return Qnil;
5210 /* Wait for responses to all X commands issued so far for frame F. */
5212 void
5213 x_sync (f)
5214 FRAME_PTR f;
5216 BLOCK_INPUT;
5217 XSync (FRAME_X_DISPLAY (f), False);
5218 UNBLOCK_INPUT;
5222 /***********************************************************************
5223 Image types
5224 ***********************************************************************/
5226 /* Value is the number of elements of vector VECTOR. */
5228 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
5230 /* List of supported image types. Use define_image_type to add new
5231 types. Use lookup_image_type to find a type for a given symbol. */
5233 static struct image_type *image_types;
5235 /* The symbol `image' which is the car of the lists used to represent
5236 images in Lisp. */
5238 extern Lisp_Object Qimage;
5240 /* The symbol `xbm' which is used as the type symbol for XBM images. */
5242 Lisp_Object Qxbm;
5244 /* Keywords. */
5246 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
5247 extern Lisp_Object QCdata;
5248 Lisp_Object QCtype, QCascent, QCmargin, QCrelief;
5249 Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
5250 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
5252 /* Other symbols. */
5254 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
5256 /* Time in seconds after which images should be removed from the cache
5257 if not displayed. */
5259 Lisp_Object Vimage_cache_eviction_delay;
5261 /* Function prototypes. */
5263 static void define_image_type P_ ((struct image_type *type));
5264 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
5265 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
5266 static void x_laplace P_ ((struct frame *, struct image *));
5267 static void x_emboss P_ ((struct frame *, struct image *));
5268 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
5269 Lisp_Object));
5272 /* Define a new image type from TYPE. This adds a copy of TYPE to
5273 image_types and adds the symbol *TYPE->type to Vimage_types. */
5275 static void
5276 define_image_type (type)
5277 struct image_type *type;
5279 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
5280 The initialized data segment is read-only. */
5281 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
5282 bcopy (type, p, sizeof *p);
5283 p->next = image_types;
5284 image_types = p;
5285 Vimage_types = Fcons (*p->type, Vimage_types);
5289 /* Look up image type SYMBOL, and return a pointer to its image_type
5290 structure. Value is null if SYMBOL is not a known image type. */
5292 static INLINE struct image_type *
5293 lookup_image_type (symbol)
5294 Lisp_Object symbol;
5296 struct image_type *type;
5298 for (type = image_types; type; type = type->next)
5299 if (EQ (symbol, *type->type))
5300 break;
5302 return type;
5306 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
5307 valid image specification is a list whose car is the symbol
5308 `image', and whose rest is a property list. The property list must
5309 contain a value for key `:type'. That value must be the name of a
5310 supported image type. The rest of the property list depends on the
5311 image type. */
5314 valid_image_p (object)
5315 Lisp_Object object;
5317 int valid_p = 0;
5319 if (CONSP (object) && EQ (XCAR (object), Qimage))
5321 Lisp_Object symbol = Fplist_get (XCDR (object), QCtype);
5322 struct image_type *type = lookup_image_type (symbol);
5324 if (type)
5325 valid_p = type->valid_p (object);
5328 return valid_p;
5332 /* Log error message with format string FORMAT and argument ARG.
5333 Signaling an error, e.g. when an image cannot be loaded, is not a
5334 good idea because this would interrupt redisplay, and the error
5335 message display would lead to another redisplay. This function
5336 therefore simply displays a message. */
5338 static void
5339 image_error (format, arg1, arg2)
5340 char *format;
5341 Lisp_Object arg1, arg2;
5343 add_to_log (format, arg1, arg2);
5348 /***********************************************************************
5349 Image specifications
5350 ***********************************************************************/
5352 enum image_value_type
5354 IMAGE_DONT_CHECK_VALUE_TYPE,
5355 IMAGE_STRING_VALUE,
5356 IMAGE_STRING_OR_NIL_VALUE,
5357 IMAGE_SYMBOL_VALUE,
5358 IMAGE_POSITIVE_INTEGER_VALUE,
5359 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
5360 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
5361 IMAGE_ASCENT_VALUE,
5362 IMAGE_INTEGER_VALUE,
5363 IMAGE_FUNCTION_VALUE,
5364 IMAGE_NUMBER_VALUE,
5365 IMAGE_BOOL_VALUE
5368 /* Structure used when parsing image specifications. */
5370 struct image_keyword
5372 /* Name of keyword. */
5373 char *name;
5375 /* The type of value allowed. */
5376 enum image_value_type type;
5378 /* Non-zero means key must be present. */
5379 int mandatory_p;
5381 /* Used to recognize duplicate keywords in a property list. */
5382 int count;
5384 /* The value that was found. */
5385 Lisp_Object value;
5389 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
5390 int, Lisp_Object));
5391 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
5394 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
5395 has the format (image KEYWORD VALUE ...). One of the keyword/
5396 value pairs must be `:type TYPE'. KEYWORDS is a vector of
5397 image_keywords structures of size NKEYWORDS describing other
5398 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
5400 static int
5401 parse_image_spec (spec, keywords, nkeywords, type)
5402 Lisp_Object spec;
5403 struct image_keyword *keywords;
5404 int nkeywords;
5405 Lisp_Object type;
5407 int i;
5408 Lisp_Object plist;
5410 if (!CONSP (spec) || !EQ (XCAR (spec), Qimage))
5411 return 0;
5413 plist = XCDR (spec);
5414 while (CONSP (plist))
5416 Lisp_Object key, value;
5418 /* First element of a pair must be a symbol. */
5419 key = XCAR (plist);
5420 plist = XCDR (plist);
5421 if (!SYMBOLP (key))
5422 return 0;
5424 /* There must follow a value. */
5425 if (!CONSP (plist))
5426 return 0;
5427 value = XCAR (plist);
5428 plist = XCDR (plist);
5430 /* Find key in KEYWORDS. Error if not found. */
5431 for (i = 0; i < nkeywords; ++i)
5432 if (strcmp (keywords[i].name, XSYMBOL (key)->name->data) == 0)
5433 break;
5435 if (i == nkeywords)
5436 continue;
5438 /* Record that we recognized the keyword. If a keywords
5439 was found more than once, it's an error. */
5440 keywords[i].value = value;
5441 ++keywords[i].count;
5443 if (keywords[i].count > 1)
5444 return 0;
5446 /* Check type of value against allowed type. */
5447 switch (keywords[i].type)
5449 case IMAGE_STRING_VALUE:
5450 if (!STRINGP (value))
5451 return 0;
5452 break;
5454 case IMAGE_STRING_OR_NIL_VALUE:
5455 if (!STRINGP (value) && !NILP (value))
5456 return 0;
5457 break;
5459 case IMAGE_SYMBOL_VALUE:
5460 if (!SYMBOLP (value))
5461 return 0;
5462 break;
5464 case IMAGE_POSITIVE_INTEGER_VALUE:
5465 if (!INTEGERP (value) || XINT (value) <= 0)
5466 return 0;
5467 break;
5469 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
5470 if (INTEGERP (value) && XINT (value) >= 0)
5471 break;
5472 if (CONSP (value)
5473 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
5474 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
5475 break;
5476 return 0;
5478 case IMAGE_ASCENT_VALUE:
5479 if (SYMBOLP (value) && EQ (value, Qcenter))
5480 break;
5481 else if (INTEGERP (value)
5482 && XINT (value) >= 0
5483 && XINT (value) <= 100)
5484 break;
5485 return 0;
5487 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
5488 if (!INTEGERP (value) || XINT (value) < 0)
5489 return 0;
5490 break;
5492 case IMAGE_DONT_CHECK_VALUE_TYPE:
5493 break;
5495 case IMAGE_FUNCTION_VALUE:
5496 value = indirect_function (value);
5497 if (SUBRP (value)
5498 || COMPILEDP (value)
5499 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
5500 break;
5501 return 0;
5503 case IMAGE_NUMBER_VALUE:
5504 if (!INTEGERP (value) && !FLOATP (value))
5505 return 0;
5506 break;
5508 case IMAGE_INTEGER_VALUE:
5509 if (!INTEGERP (value))
5510 return 0;
5511 break;
5513 case IMAGE_BOOL_VALUE:
5514 if (!NILP (value) && !EQ (value, Qt))
5515 return 0;
5516 break;
5518 default:
5519 abort ();
5520 break;
5523 if (EQ (key, QCtype) && !EQ (type, value))
5524 return 0;
5527 /* Check that all mandatory fields are present. */
5528 for (i = 0; i < nkeywords; ++i)
5529 if (keywords[i].mandatory_p && keywords[i].count == 0)
5530 return 0;
5532 return NILP (plist);
5536 /* Return the value of KEY in image specification SPEC. Value is nil
5537 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
5538 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
5540 static Lisp_Object
5541 image_spec_value (spec, key, found)
5542 Lisp_Object spec, key;
5543 int *found;
5545 Lisp_Object tail;
5547 xassert (valid_image_p (spec));
5549 for (tail = XCDR (spec);
5550 CONSP (tail) && CONSP (XCDR (tail));
5551 tail = XCDR (XCDR (tail)))
5553 if (EQ (XCAR (tail), key))
5555 if (found)
5556 *found = 1;
5557 return XCAR (XCDR (tail));
5561 if (found)
5562 *found = 0;
5563 return Qnil;
5567 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
5568 "Return the size of image SPEC as pair (WIDTH . HEIGHT).\n\
5569 PIXELS non-nil means return the size in pixels, otherwise return the\n\
5570 size in canonical character units.\n\
5571 FRAME is the frame on which the image will be displayed. FRAME nil\n\
5572 or omitted means use the selected frame.")
5573 (spec, pixels, frame)
5574 Lisp_Object spec, pixels, frame;
5576 Lisp_Object size;
5578 size = Qnil;
5579 if (valid_image_p (spec))
5581 struct frame *f = check_x_frame (frame);
5582 int id = lookup_image (f, spec);
5583 struct image *img = IMAGE_FROM_ID (f, id);
5584 int width = img->width + 2 * img->hmargin;
5585 int height = img->height + 2 * img->vmargin;
5587 if (NILP (pixels))
5588 size = Fcons (make_float ((double) width / CANON_X_UNIT (f)),
5589 make_float ((double) height / CANON_Y_UNIT (f)));
5590 else
5591 size = Fcons (make_number (width), make_number (height));
5593 else
5594 error ("Invalid image specification");
5596 return size;
5600 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
5601 "Return t if image SPEC has a mask bitmap.\n\
5602 FRAME is the frame on which the image will be displayed. FRAME nil\n\
5603 or omitted means use the selected frame.")
5604 (spec, frame)
5605 Lisp_Object spec, frame;
5607 Lisp_Object mask;
5609 mask = Qnil;
5610 if (valid_image_p (spec))
5612 struct frame *f = check_x_frame (frame);
5613 int id = lookup_image (f, spec);
5614 struct image *img = IMAGE_FROM_ID (f, id);
5615 if (img->mask)
5616 mask = Qt;
5618 else
5619 error ("Invalid image specification");
5621 return mask;
5626 /***********************************************************************
5627 Image type independent image structures
5628 ***********************************************************************/
5630 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
5631 static void free_image P_ ((struct frame *f, struct image *img));
5634 /* Allocate and return a new image structure for image specification
5635 SPEC. SPEC has a hash value of HASH. */
5637 static struct image *
5638 make_image (spec, hash)
5639 Lisp_Object spec;
5640 unsigned hash;
5642 struct image *img = (struct image *) xmalloc (sizeof *img);
5644 xassert (valid_image_p (spec));
5645 bzero (img, sizeof *img);
5646 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
5647 xassert (img->type != NULL);
5648 img->spec = spec;
5649 img->data.lisp_val = Qnil;
5650 img->ascent = DEFAULT_IMAGE_ASCENT;
5651 img->hash = hash;
5652 return img;
5656 /* Free image IMG which was used on frame F, including its resources. */
5658 static void
5659 free_image (f, img)
5660 struct frame *f;
5661 struct image *img;
5663 if (img)
5665 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5667 /* Remove IMG from the hash table of its cache. */
5668 if (img->prev)
5669 img->prev->next = img->next;
5670 else
5671 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
5673 if (img->next)
5674 img->next->prev = img->prev;
5676 c->images[img->id] = NULL;
5678 /* Free resources, then free IMG. */
5679 img->type->free (f, img);
5680 xfree (img);
5685 /* Prepare image IMG for display on frame F. Must be called before
5686 drawing an image. */
5688 void
5689 prepare_image_for_display (f, img)
5690 struct frame *f;
5691 struct image *img;
5693 EMACS_TIME t;
5695 /* We're about to display IMG, so set its timestamp to `now'. */
5696 EMACS_GET_TIME (t);
5697 img->timestamp = EMACS_SECS (t);
5699 /* If IMG doesn't have a pixmap yet, load it now, using the image
5700 type dependent loader function. */
5701 if (img->pixmap == None && !img->load_failed_p)
5702 img->load_failed_p = img->type->load (f, img) == 0;
5706 /* Value is the number of pixels for the ascent of image IMG when
5707 drawn in face FACE. */
5710 image_ascent (img, face)
5711 struct image *img;
5712 struct face *face;
5714 int height = img->height + img->vmargin;
5715 int ascent;
5717 if (img->ascent == CENTERED_IMAGE_ASCENT)
5719 if (face->font)
5720 /* This expression is arranged so that if the image can't be
5721 exactly centered, it will be moved slightly up. This is
5722 because a typical font is `top-heavy' (due to the presence
5723 uppercase letters), so the image placement should err towards
5724 being top-heavy too. It also just generally looks better. */
5725 ascent = (height + face->font->ascent - face->font->descent + 1) / 2;
5726 else
5727 ascent = height / 2;
5729 else
5730 ascent = height * img->ascent / 100.0;
5732 return ascent;
5737 /***********************************************************************
5738 Helper functions for X image types
5739 ***********************************************************************/
5741 static void x_clear_image_1 P_ ((struct frame *, struct image *, int,
5742 int, int));
5743 static void x_clear_image P_ ((struct frame *f, struct image *img));
5744 static unsigned long x_alloc_image_color P_ ((struct frame *f,
5745 struct image *img,
5746 Lisp_Object color_name,
5747 unsigned long dflt));
5750 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
5751 free the pixmap if any. MASK_P non-zero means clear the mask
5752 pixmap if any. COLORS_P non-zero means free colors allocated for
5753 the image, if any. */
5755 static void
5756 x_clear_image_1 (f, img, pixmap_p, mask_p, colors_p)
5757 struct frame *f;
5758 struct image *img;
5759 int pixmap_p, mask_p, colors_p;
5761 if (pixmap_p && img->pixmap)
5763 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
5764 img->pixmap = None;
5767 if (mask_p && img->mask)
5769 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
5770 img->mask = None;
5773 if (colors_p && img->ncolors)
5775 x_free_colors (f, img->colors, img->ncolors);
5776 xfree (img->colors);
5777 img->colors = NULL;
5778 img->ncolors = 0;
5782 /* Free X resources of image IMG which is used on frame F. */
5784 static void
5785 x_clear_image (f, img)
5786 struct frame *f;
5787 struct image *img;
5789 BLOCK_INPUT;
5790 x_clear_image_1 (f, img, 1, 1, 1);
5791 UNBLOCK_INPUT;
5795 /* Allocate color COLOR_NAME for image IMG on frame F. If color
5796 cannot be allocated, use DFLT. Add a newly allocated color to
5797 IMG->colors, so that it can be freed again. Value is the pixel
5798 color. */
5800 static unsigned long
5801 x_alloc_image_color (f, img, color_name, dflt)
5802 struct frame *f;
5803 struct image *img;
5804 Lisp_Object color_name;
5805 unsigned long dflt;
5807 XColor color;
5808 unsigned long result;
5810 xassert (STRINGP (color_name));
5812 if (x_defined_color (f, XSTRING (color_name)->data, &color, 1))
5814 /* This isn't called frequently so we get away with simply
5815 reallocating the color vector to the needed size, here. */
5816 ++img->ncolors;
5817 img->colors =
5818 (unsigned long *) xrealloc (img->colors,
5819 img->ncolors * sizeof *img->colors);
5820 img->colors[img->ncolors - 1] = color.pixel;
5821 result = color.pixel;
5823 else
5824 result = dflt;
5826 return result;
5831 /***********************************************************************
5832 Image Cache
5833 ***********************************************************************/
5835 static void cache_image P_ ((struct frame *f, struct image *img));
5836 static void postprocess_image P_ ((struct frame *, struct image *));
5839 /* Return a new, initialized image cache that is allocated from the
5840 heap. Call free_image_cache to free an image cache. */
5842 struct image_cache *
5843 make_image_cache ()
5845 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
5846 int size;
5848 bzero (c, sizeof *c);
5849 c->size = 50;
5850 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
5851 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5852 c->buckets = (struct image **) xmalloc (size);
5853 bzero (c->buckets, size);
5854 return c;
5858 /* Free image cache of frame F. Be aware that X frames share images
5859 caches. */
5861 void
5862 free_image_cache (f)
5863 struct frame *f;
5865 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5866 if (c)
5868 int i;
5870 /* Cache should not be referenced by any frame when freed. */
5871 xassert (c->refcount == 0);
5873 for (i = 0; i < c->used; ++i)
5874 free_image (f, c->images[i]);
5875 xfree (c->images);
5876 xfree (c->buckets);
5877 xfree (c);
5878 FRAME_X_IMAGE_CACHE (f) = NULL;
5883 /* Clear image cache of frame F. FORCE_P non-zero means free all
5884 images. FORCE_P zero means clear only images that haven't been
5885 displayed for some time. Should be called from time to time to
5886 reduce the number of loaded images. If image-eviction-seconds is
5887 non-nil, this frees images in the cache which weren't displayed for
5888 at least that many seconds. */
5890 void
5891 clear_image_cache (f, force_p)
5892 struct frame *f;
5893 int force_p;
5895 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5897 if (c && INTEGERP (Vimage_cache_eviction_delay))
5899 EMACS_TIME t;
5900 unsigned long old;
5901 int i, nfreed;
5903 EMACS_GET_TIME (t);
5904 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
5906 /* Block input so that we won't be interrupted by a SIGIO
5907 while being in an inconsistent state. */
5908 BLOCK_INPUT;
5910 for (i = nfreed = 0; i < c->used; ++i)
5912 struct image *img = c->images[i];
5913 if (img != NULL
5914 && (force_p || img->timestamp < old))
5916 free_image (f, img);
5917 ++nfreed;
5921 /* We may be clearing the image cache because, for example,
5922 Emacs was iconified for a longer period of time. In that
5923 case, current matrices may still contain references to
5924 images freed above. So, clear these matrices. */
5925 if (nfreed)
5927 Lisp_Object tail, frame;
5929 FOR_EACH_FRAME (tail, frame)
5931 struct frame *f = XFRAME (frame);
5932 if (FRAME_X_P (f)
5933 && FRAME_X_IMAGE_CACHE (f) == c)
5934 clear_current_matrices (f);
5937 ++windows_or_buffers_changed;
5940 UNBLOCK_INPUT;
5945 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
5946 0, 1, 0,
5947 "Clear the image cache of FRAME.\n\
5948 FRAME nil or omitted means use the selected frame.\n\
5949 FRAME t means clear the image caches of all frames.")
5950 (frame)
5951 Lisp_Object frame;
5953 if (EQ (frame, Qt))
5955 Lisp_Object tail;
5957 FOR_EACH_FRAME (tail, frame)
5958 if (FRAME_X_P (XFRAME (frame)))
5959 clear_image_cache (XFRAME (frame), 1);
5961 else
5962 clear_image_cache (check_x_frame (frame), 1);
5964 return Qnil;
5968 /* Compute masks and transform image IMG on frame F, as specified
5969 by the image's specification, */
5971 static void
5972 postprocess_image (f, img)
5973 struct frame *f;
5974 struct image *img;
5976 /* Manipulation of the image's mask. */
5977 if (img->pixmap)
5979 Lisp_Object conversion, spec;
5980 Lisp_Object mask;
5982 spec = img->spec;
5984 /* `:heuristic-mask t'
5985 `:mask heuristic'
5986 means build a mask heuristically.
5987 `:heuristic-mask (R G B)'
5988 `:mask (heuristic (R G B))'
5989 means build a mask from color (R G B) in the
5990 image.
5991 `:mask nil'
5992 means remove a mask, if any. */
5994 mask = image_spec_value (spec, QCheuristic_mask, NULL);
5995 if (!NILP (mask))
5996 x_build_heuristic_mask (f, img, mask);
5997 else
5999 int found_p;
6001 mask = image_spec_value (spec, QCmask, &found_p);
6003 if (EQ (mask, Qheuristic))
6004 x_build_heuristic_mask (f, img, Qt);
6005 else if (CONSP (mask)
6006 && EQ (XCAR (mask), Qheuristic))
6008 if (CONSP (XCDR (mask)))
6009 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
6010 else
6011 x_build_heuristic_mask (f, img, XCDR (mask));
6013 else if (NILP (mask) && found_p && img->mask)
6015 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
6016 img->mask = None;
6021 /* Should we apply an image transformation algorithm? */
6022 conversion = image_spec_value (spec, QCconversion, NULL);
6023 if (EQ (conversion, Qdisabled))
6024 x_disable_image (f, img);
6025 else if (EQ (conversion, Qlaplace))
6026 x_laplace (f, img);
6027 else if (EQ (conversion, Qemboss))
6028 x_emboss (f, img);
6029 else if (CONSP (conversion)
6030 && EQ (XCAR (conversion), Qedge_detection))
6032 Lisp_Object tem;
6033 tem = XCDR (conversion);
6034 if (CONSP (tem))
6035 x_edge_detection (f, img,
6036 Fplist_get (tem, QCmatrix),
6037 Fplist_get (tem, QCcolor_adjustment));
6043 /* Return the id of image with Lisp specification SPEC on frame F.
6044 SPEC must be a valid Lisp image specification (see valid_image_p). */
6047 lookup_image (f, spec)
6048 struct frame *f;
6049 Lisp_Object spec;
6051 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6052 struct image *img;
6053 int i;
6054 unsigned hash;
6055 struct gcpro gcpro1;
6056 EMACS_TIME now;
6058 /* F must be a window-system frame, and SPEC must be a valid image
6059 specification. */
6060 xassert (FRAME_WINDOW_P (f));
6061 xassert (valid_image_p (spec));
6063 GCPRO1 (spec);
6065 /* Look up SPEC in the hash table of the image cache. */
6066 hash = sxhash (spec, 0);
6067 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
6069 for (img = c->buckets[i]; img; img = img->next)
6070 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
6071 break;
6073 /* If not found, create a new image and cache it. */
6074 if (img == NULL)
6076 extern Lisp_Object Qpostscript;
6078 BLOCK_INPUT;
6079 img = make_image (spec, hash);
6080 cache_image (f, img);
6081 img->load_failed_p = img->type->load (f, img) == 0;
6083 /* If we can't load the image, and we don't have a width and
6084 height, use some arbitrary width and height so that we can
6085 draw a rectangle for it. */
6086 if (img->load_failed_p)
6088 Lisp_Object value;
6090 value = image_spec_value (spec, QCwidth, NULL);
6091 img->width = (INTEGERP (value)
6092 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
6093 value = image_spec_value (spec, QCheight, NULL);
6094 img->height = (INTEGERP (value)
6095 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
6097 else
6099 /* Handle image type independent image attributes
6100 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF'. */
6101 Lisp_Object ascent, margin, relief;
6103 ascent = image_spec_value (spec, QCascent, NULL);
6104 if (INTEGERP (ascent))
6105 img->ascent = XFASTINT (ascent);
6106 else if (EQ (ascent, Qcenter))
6107 img->ascent = CENTERED_IMAGE_ASCENT;
6109 margin = image_spec_value (spec, QCmargin, NULL);
6110 if (INTEGERP (margin) && XINT (margin) >= 0)
6111 img->vmargin = img->hmargin = XFASTINT (margin);
6112 else if (CONSP (margin) && INTEGERP (XCAR (margin))
6113 && INTEGERP (XCDR (margin)))
6115 if (XINT (XCAR (margin)) > 0)
6116 img->hmargin = XFASTINT (XCAR (margin));
6117 if (XINT (XCDR (margin)) > 0)
6118 img->vmargin = XFASTINT (XCDR (margin));
6121 relief = image_spec_value (spec, QCrelief, NULL);
6122 if (INTEGERP (relief))
6124 img->relief = XINT (relief);
6125 img->hmargin += abs (img->relief);
6126 img->vmargin += abs (img->relief);
6129 /* Do image transformations and compute masks, unless we
6130 don't have the image yet. */
6131 if (!EQ (*img->type->type, Qpostscript))
6132 postprocess_image (f, img);
6135 UNBLOCK_INPUT;
6136 xassert (!interrupt_input_blocked);
6139 /* We're using IMG, so set its timestamp to `now'. */
6140 EMACS_GET_TIME (now);
6141 img->timestamp = EMACS_SECS (now);
6143 UNGCPRO;
6145 /* Value is the image id. */
6146 return img->id;
6150 /* Cache image IMG in the image cache of frame F. */
6152 static void
6153 cache_image (f, img)
6154 struct frame *f;
6155 struct image *img;
6157 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6158 int i;
6160 /* Find a free slot in c->images. */
6161 for (i = 0; i < c->used; ++i)
6162 if (c->images[i] == NULL)
6163 break;
6165 /* If no free slot found, maybe enlarge c->images. */
6166 if (i == c->used && c->used == c->size)
6168 c->size *= 2;
6169 c->images = (struct image **) xrealloc (c->images,
6170 c->size * sizeof *c->images);
6173 /* Add IMG to c->images, and assign IMG an id. */
6174 c->images[i] = img;
6175 img->id = i;
6176 if (i == c->used)
6177 ++c->used;
6179 /* Add IMG to the cache's hash table. */
6180 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
6181 img->next = c->buckets[i];
6182 if (img->next)
6183 img->next->prev = img;
6184 img->prev = NULL;
6185 c->buckets[i] = img;
6189 /* Call FN on every image in the image cache of frame F. Used to mark
6190 Lisp Objects in the image cache. */
6192 void
6193 forall_images_in_image_cache (f, fn)
6194 struct frame *f;
6195 void (*fn) P_ ((struct image *img));
6197 if (FRAME_LIVE_P (f) && FRAME_X_P (f))
6199 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6200 if (c)
6202 int i;
6203 for (i = 0; i < c->used; ++i)
6204 if (c->images[i])
6205 fn (c->images[i]);
6212 /***********************************************************************
6213 X support code
6214 ***********************************************************************/
6216 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
6217 XImage **, Pixmap *));
6218 static void x_destroy_x_image P_ ((XImage *));
6219 static void x_put_x_image P_ ((struct frame *, XImage *, Pixmap, int, int));
6222 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
6223 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
6224 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
6225 via xmalloc. Print error messages via image_error if an error
6226 occurs. Value is non-zero if successful. */
6228 static int
6229 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
6230 struct frame *f;
6231 int width, height, depth;
6232 XImage **ximg;
6233 Pixmap *pixmap;
6235 Display *display = FRAME_X_DISPLAY (f);
6236 Screen *screen = FRAME_X_SCREEN (f);
6237 Window window = FRAME_X_WINDOW (f);
6239 xassert (interrupt_input_blocked);
6241 if (depth <= 0)
6242 depth = DefaultDepthOfScreen (screen);
6243 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
6244 depth, ZPixmap, 0, NULL, width, height,
6245 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
6246 if (*ximg == NULL)
6248 image_error ("Unable to allocate X image", Qnil, Qnil);
6249 return 0;
6252 /* Allocate image raster. */
6253 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
6255 /* Allocate a pixmap of the same size. */
6256 *pixmap = XCreatePixmap (display, window, width, height, depth);
6257 if (*pixmap == None)
6259 x_destroy_x_image (*ximg);
6260 *ximg = NULL;
6261 image_error ("Unable to create X pixmap", Qnil, Qnil);
6262 return 0;
6265 return 1;
6269 /* Destroy XImage XIMG. Free XIMG->data. */
6271 static void
6272 x_destroy_x_image (ximg)
6273 XImage *ximg;
6275 xassert (interrupt_input_blocked);
6276 if (ximg)
6278 xfree (ximg->data);
6279 ximg->data = NULL;
6280 XDestroyImage (ximg);
6285 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
6286 are width and height of both the image and pixmap. */
6288 static void
6289 x_put_x_image (f, ximg, pixmap, width, height)
6290 struct frame *f;
6291 XImage *ximg;
6292 Pixmap pixmap;
6294 GC gc;
6296 xassert (interrupt_input_blocked);
6297 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
6298 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
6299 XFreeGC (FRAME_X_DISPLAY (f), gc);
6304 /***********************************************************************
6305 File Handling
6306 ***********************************************************************/
6308 static Lisp_Object x_find_image_file P_ ((Lisp_Object));
6309 static char *slurp_file P_ ((char *, int *));
6312 /* Find image file FILE. Look in data-directory, then
6313 x-bitmap-file-path. Value is the full name of the file found, or
6314 nil if not found. */
6316 static Lisp_Object
6317 x_find_image_file (file)
6318 Lisp_Object file;
6320 Lisp_Object file_found, search_path;
6321 struct gcpro gcpro1, gcpro2;
6322 int fd;
6324 file_found = Qnil;
6325 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
6326 GCPRO2 (file_found, search_path);
6328 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
6329 fd = openp (search_path, file, "", &file_found, 0);
6331 if (fd == -1)
6332 file_found = Qnil;
6333 else
6334 close (fd);
6336 UNGCPRO;
6337 return file_found;
6341 /* Read FILE into memory. Value is a pointer to a buffer allocated
6342 with xmalloc holding FILE's contents. Value is null if an error
6343 occurred. *SIZE is set to the size of the file. */
6345 static char *
6346 slurp_file (file, size)
6347 char *file;
6348 int *size;
6350 FILE *fp = NULL;
6351 char *buf = NULL;
6352 struct stat st;
6354 if (stat (file, &st) == 0
6355 && (fp = fopen (file, "r")) != NULL
6356 && (buf = (char *) xmalloc (st.st_size),
6357 fread (buf, 1, st.st_size, fp) == st.st_size))
6359 *size = st.st_size;
6360 fclose (fp);
6362 else
6364 if (fp)
6365 fclose (fp);
6366 if (buf)
6368 xfree (buf);
6369 buf = NULL;
6373 return buf;
6378 /***********************************************************************
6379 XBM images
6380 ***********************************************************************/
6382 static int xbm_scan P_ ((char **, char *, char *, int *));
6383 static int xbm_load P_ ((struct frame *f, struct image *img));
6384 static int xbm_load_image P_ ((struct frame *f, struct image *img,
6385 char *, char *));
6386 static int xbm_image_p P_ ((Lisp_Object object));
6387 static int xbm_read_bitmap_data P_ ((char *, char *, int *, int *,
6388 unsigned char **));
6389 static int xbm_file_p P_ ((Lisp_Object));
6392 /* Indices of image specification fields in xbm_format, below. */
6394 enum xbm_keyword_index
6396 XBM_TYPE,
6397 XBM_FILE,
6398 XBM_WIDTH,
6399 XBM_HEIGHT,
6400 XBM_DATA,
6401 XBM_FOREGROUND,
6402 XBM_BACKGROUND,
6403 XBM_ASCENT,
6404 XBM_MARGIN,
6405 XBM_RELIEF,
6406 XBM_ALGORITHM,
6407 XBM_HEURISTIC_MASK,
6408 XBM_MASK,
6409 XBM_LAST
6412 /* Vector of image_keyword structures describing the format
6413 of valid XBM image specifications. */
6415 static struct image_keyword xbm_format[XBM_LAST] =
6417 {":type", IMAGE_SYMBOL_VALUE, 1},
6418 {":file", IMAGE_STRING_VALUE, 0},
6419 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6420 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6421 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6422 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
6423 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
6424 {":ascent", IMAGE_ASCENT_VALUE, 0},
6425 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6426 {":relief", IMAGE_INTEGER_VALUE, 0},
6427 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6428 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6429 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
6432 /* Structure describing the image type XBM. */
6434 static struct image_type xbm_type =
6436 &Qxbm,
6437 xbm_image_p,
6438 xbm_load,
6439 x_clear_image,
6440 NULL
6443 /* Tokens returned from xbm_scan. */
6445 enum xbm_token
6447 XBM_TK_IDENT = 256,
6448 XBM_TK_NUMBER
6452 /* Return non-zero if OBJECT is a valid XBM-type image specification.
6453 A valid specification is a list starting with the symbol `image'
6454 The rest of the list is a property list which must contain an
6455 entry `:type xbm..
6457 If the specification specifies a file to load, it must contain
6458 an entry `:file FILENAME' where FILENAME is a string.
6460 If the specification is for a bitmap loaded from memory it must
6461 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
6462 WIDTH and HEIGHT are integers > 0. DATA may be:
6464 1. a string large enough to hold the bitmap data, i.e. it must
6465 have a size >= (WIDTH + 7) / 8 * HEIGHT
6467 2. a bool-vector of size >= WIDTH * HEIGHT
6469 3. a vector of strings or bool-vectors, one for each line of the
6470 bitmap.
6472 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
6473 may not be specified in this case because they are defined in the
6474 XBM file.
6476 Both the file and data forms may contain the additional entries
6477 `:background COLOR' and `:foreground COLOR'. If not present,
6478 foreground and background of the frame on which the image is
6479 displayed is used. */
6481 static int
6482 xbm_image_p (object)
6483 Lisp_Object object;
6485 struct image_keyword kw[XBM_LAST];
6487 bcopy (xbm_format, kw, sizeof kw);
6488 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
6489 return 0;
6491 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
6493 if (kw[XBM_FILE].count)
6495 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
6496 return 0;
6498 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
6500 /* In-memory XBM file. */
6501 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
6502 return 0;
6504 else
6506 Lisp_Object data;
6507 int width, height;
6509 /* Entries for `:width', `:height' and `:data' must be present. */
6510 if (!kw[XBM_WIDTH].count
6511 || !kw[XBM_HEIGHT].count
6512 || !kw[XBM_DATA].count)
6513 return 0;
6515 data = kw[XBM_DATA].value;
6516 width = XFASTINT (kw[XBM_WIDTH].value);
6517 height = XFASTINT (kw[XBM_HEIGHT].value);
6519 /* Check type of data, and width and height against contents of
6520 data. */
6521 if (VECTORP (data))
6523 int i;
6525 /* Number of elements of the vector must be >= height. */
6526 if (XVECTOR (data)->size < height)
6527 return 0;
6529 /* Each string or bool-vector in data must be large enough
6530 for one line of the image. */
6531 for (i = 0; i < height; ++i)
6533 Lisp_Object elt = XVECTOR (data)->contents[i];
6535 if (STRINGP (elt))
6537 if (XSTRING (elt)->size
6538 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
6539 return 0;
6541 else if (BOOL_VECTOR_P (elt))
6543 if (XBOOL_VECTOR (elt)->size < width)
6544 return 0;
6546 else
6547 return 0;
6550 else if (STRINGP (data))
6552 if (XSTRING (data)->size
6553 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
6554 return 0;
6556 else if (BOOL_VECTOR_P (data))
6558 if (XBOOL_VECTOR (data)->size < width * height)
6559 return 0;
6561 else
6562 return 0;
6565 return 1;
6569 /* Scan a bitmap file. FP is the stream to read from. Value is
6570 either an enumerator from enum xbm_token, or a character for a
6571 single-character token, or 0 at end of file. If scanning an
6572 identifier, store the lexeme of the identifier in SVAL. If
6573 scanning a number, store its value in *IVAL. */
6575 static int
6576 xbm_scan (s, end, sval, ival)
6577 char **s, *end;
6578 char *sval;
6579 int *ival;
6581 int c;
6583 loop:
6585 /* Skip white space. */
6586 while (*s < end && (c = *(*s)++, isspace (c)))
6589 if (*s >= end)
6590 c = 0;
6591 else if (isdigit (c))
6593 int value = 0, digit;
6595 if (c == '0' && *s < end)
6597 c = *(*s)++;
6598 if (c == 'x' || c == 'X')
6600 while (*s < end)
6602 c = *(*s)++;
6603 if (isdigit (c))
6604 digit = c - '0';
6605 else if (c >= 'a' && c <= 'f')
6606 digit = c - 'a' + 10;
6607 else if (c >= 'A' && c <= 'F')
6608 digit = c - 'A' + 10;
6609 else
6610 break;
6611 value = 16 * value + digit;
6614 else if (isdigit (c))
6616 value = c - '0';
6617 while (*s < end
6618 && (c = *(*s)++, isdigit (c)))
6619 value = 8 * value + c - '0';
6622 else
6624 value = c - '0';
6625 while (*s < end
6626 && (c = *(*s)++, isdigit (c)))
6627 value = 10 * value + c - '0';
6630 if (*s < end)
6631 *s = *s - 1;
6632 *ival = value;
6633 c = XBM_TK_NUMBER;
6635 else if (isalpha (c) || c == '_')
6637 *sval++ = c;
6638 while (*s < end
6639 && (c = *(*s)++, (isalnum (c) || c == '_')))
6640 *sval++ = c;
6641 *sval = 0;
6642 if (*s < end)
6643 *s = *s - 1;
6644 c = XBM_TK_IDENT;
6646 else if (c == '/' && **s == '*')
6648 /* C-style comment. */
6649 ++*s;
6650 while (**s && (**s != '*' || *(*s + 1) != '/'))
6651 ++*s;
6652 if (**s)
6654 *s += 2;
6655 goto loop;
6659 return c;
6663 /* Replacement for XReadBitmapFileData which isn't available under old
6664 X versions. CONTENTS is a pointer to a buffer to parse; END is the
6665 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
6666 the image. Return in *DATA the bitmap data allocated with xmalloc.
6667 Value is non-zero if successful. DATA null means just test if
6668 CONTENTS looks like an in-memory XBM file. */
6670 static int
6671 xbm_read_bitmap_data (contents, end, width, height, data)
6672 char *contents, *end;
6673 int *width, *height;
6674 unsigned char **data;
6676 char *s = contents;
6677 char buffer[BUFSIZ];
6678 int padding_p = 0;
6679 int v10 = 0;
6680 int bytes_per_line, i, nbytes;
6681 unsigned char *p;
6682 int value;
6683 int LA1;
6685 #define match() \
6686 LA1 = xbm_scan (&s, end, buffer, &value)
6688 #define expect(TOKEN) \
6689 if (LA1 != (TOKEN)) \
6690 goto failure; \
6691 else \
6692 match ()
6694 #define expect_ident(IDENT) \
6695 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
6696 match (); \
6697 else \
6698 goto failure
6700 *width = *height = -1;
6701 if (data)
6702 *data = NULL;
6703 LA1 = xbm_scan (&s, end, buffer, &value);
6705 /* Parse defines for width, height and hot-spots. */
6706 while (LA1 == '#')
6708 match ();
6709 expect_ident ("define");
6710 expect (XBM_TK_IDENT);
6712 if (LA1 == XBM_TK_NUMBER);
6714 char *p = strrchr (buffer, '_');
6715 p = p ? p + 1 : buffer;
6716 if (strcmp (p, "width") == 0)
6717 *width = value;
6718 else if (strcmp (p, "height") == 0)
6719 *height = value;
6721 expect (XBM_TK_NUMBER);
6724 if (*width < 0 || *height < 0)
6725 goto failure;
6726 else if (data == NULL)
6727 goto success;
6729 /* Parse bits. Must start with `static'. */
6730 expect_ident ("static");
6731 if (LA1 == XBM_TK_IDENT)
6733 if (strcmp (buffer, "unsigned") == 0)
6735 match ();
6736 expect_ident ("char");
6738 else if (strcmp (buffer, "short") == 0)
6740 match ();
6741 v10 = 1;
6742 if (*width % 16 && *width % 16 < 9)
6743 padding_p = 1;
6745 else if (strcmp (buffer, "char") == 0)
6746 match ();
6747 else
6748 goto failure;
6750 else
6751 goto failure;
6753 expect (XBM_TK_IDENT);
6754 expect ('[');
6755 expect (']');
6756 expect ('=');
6757 expect ('{');
6759 bytes_per_line = (*width + 7) / 8 + padding_p;
6760 nbytes = bytes_per_line * *height;
6761 p = *data = (char *) xmalloc (nbytes);
6763 if (v10)
6765 for (i = 0; i < nbytes; i += 2)
6767 int val = value;
6768 expect (XBM_TK_NUMBER);
6770 *p++ = val;
6771 if (!padding_p || ((i + 2) % bytes_per_line))
6772 *p++ = value >> 8;
6774 if (LA1 == ',' || LA1 == '}')
6775 match ();
6776 else
6777 goto failure;
6780 else
6782 for (i = 0; i < nbytes; ++i)
6784 int val = value;
6785 expect (XBM_TK_NUMBER);
6787 *p++ = val;
6789 if (LA1 == ',' || LA1 == '}')
6790 match ();
6791 else
6792 goto failure;
6796 success:
6797 return 1;
6799 failure:
6801 if (data && *data)
6803 xfree (*data);
6804 *data = NULL;
6806 return 0;
6808 #undef match
6809 #undef expect
6810 #undef expect_ident
6814 /* Load XBM image IMG which will be displayed on frame F from buffer
6815 CONTENTS. END is the end of the buffer. Value is non-zero if
6816 successful. */
6818 static int
6819 xbm_load_image (f, img, contents, end)
6820 struct frame *f;
6821 struct image *img;
6822 char *contents, *end;
6824 int rc;
6825 unsigned char *data;
6826 int success_p = 0;
6828 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
6829 if (rc)
6831 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6832 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6833 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6834 Lisp_Object value;
6836 xassert (img->width > 0 && img->height > 0);
6838 /* Get foreground and background colors, maybe allocate colors. */
6839 value = image_spec_value (img->spec, QCforeground, NULL);
6840 if (!NILP (value))
6841 foreground = x_alloc_image_color (f, img, value, foreground);
6843 value = image_spec_value (img->spec, QCbackground, NULL);
6844 if (!NILP (value))
6845 background = x_alloc_image_color (f, img, value, background);
6847 img->pixmap
6848 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6849 FRAME_X_WINDOW (f),
6850 data,
6851 img->width, img->height,
6852 foreground, background,
6853 depth);
6854 xfree (data);
6856 if (img->pixmap == None)
6858 x_clear_image (f, img);
6859 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
6861 else
6862 success_p = 1;
6864 else
6865 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6867 return success_p;
6871 /* Value is non-zero if DATA looks like an in-memory XBM file. */
6873 static int
6874 xbm_file_p (data)
6875 Lisp_Object data;
6877 int w, h;
6878 return (STRINGP (data)
6879 && xbm_read_bitmap_data (XSTRING (data)->data,
6880 (XSTRING (data)->data
6881 + STRING_BYTES (XSTRING (data))),
6882 &w, &h, NULL));
6886 /* Fill image IMG which is used on frame F with pixmap data. Value is
6887 non-zero if successful. */
6889 static int
6890 xbm_load (f, img)
6891 struct frame *f;
6892 struct image *img;
6894 int success_p = 0;
6895 Lisp_Object file_name;
6897 xassert (xbm_image_p (img->spec));
6899 /* If IMG->spec specifies a file name, create a non-file spec from it. */
6900 file_name = image_spec_value (img->spec, QCfile, NULL);
6901 if (STRINGP (file_name))
6903 Lisp_Object file;
6904 char *contents;
6905 int size;
6906 struct gcpro gcpro1;
6908 file = x_find_image_file (file_name);
6909 GCPRO1 (file);
6910 if (!STRINGP (file))
6912 image_error ("Cannot find image file `%s'", file_name, Qnil);
6913 UNGCPRO;
6914 return 0;
6917 contents = slurp_file (XSTRING (file)->data, &size);
6918 if (contents == NULL)
6920 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6921 UNGCPRO;
6922 return 0;
6925 success_p = xbm_load_image (f, img, contents, contents + size);
6926 UNGCPRO;
6928 else
6930 struct image_keyword fmt[XBM_LAST];
6931 Lisp_Object data;
6932 int depth;
6933 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6934 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6935 char *bits;
6936 int parsed_p;
6937 int in_memory_file_p = 0;
6939 /* See if data looks like an in-memory XBM file. */
6940 data = image_spec_value (img->spec, QCdata, NULL);
6941 in_memory_file_p = xbm_file_p (data);
6943 /* Parse the image specification. */
6944 bcopy (xbm_format, fmt, sizeof fmt);
6945 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
6946 xassert (parsed_p);
6948 /* Get specified width, and height. */
6949 if (!in_memory_file_p)
6951 img->width = XFASTINT (fmt[XBM_WIDTH].value);
6952 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
6953 xassert (img->width > 0 && img->height > 0);
6956 /* Get foreground and background colors, maybe allocate colors. */
6957 if (fmt[XBM_FOREGROUND].count
6958 && STRINGP (fmt[XBM_FOREGROUND].value))
6959 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
6960 foreground);
6961 if (fmt[XBM_BACKGROUND].count
6962 && STRINGP (fmt[XBM_BACKGROUND].value))
6963 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
6964 background);
6966 if (in_memory_file_p)
6967 success_p = xbm_load_image (f, img, XSTRING (data)->data,
6968 (XSTRING (data)->data
6969 + STRING_BYTES (XSTRING (data))));
6970 else
6972 if (VECTORP (data))
6974 int i;
6975 char *p;
6976 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
6978 p = bits = (char *) alloca (nbytes * img->height);
6979 for (i = 0; i < img->height; ++i, p += nbytes)
6981 Lisp_Object line = XVECTOR (data)->contents[i];
6982 if (STRINGP (line))
6983 bcopy (XSTRING (line)->data, p, nbytes);
6984 else
6985 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
6988 else if (STRINGP (data))
6989 bits = XSTRING (data)->data;
6990 else
6991 bits = XBOOL_VECTOR (data)->data;
6993 /* Create the pixmap. */
6994 depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6995 img->pixmap
6996 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6997 FRAME_X_WINDOW (f),
6998 bits,
6999 img->width, img->height,
7000 foreground, background,
7001 depth);
7002 if (img->pixmap)
7003 success_p = 1;
7004 else
7006 image_error ("Unable to create pixmap for XBM image `%s'",
7007 img->spec, Qnil);
7008 x_clear_image (f, img);
7013 return success_p;
7018 /***********************************************************************
7019 XPM images
7020 ***********************************************************************/
7022 #if HAVE_XPM
7024 static int xpm_image_p P_ ((Lisp_Object object));
7025 static int xpm_load P_ ((struct frame *f, struct image *img));
7026 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
7028 #include "X11/xpm.h"
7030 /* The symbol `xpm' identifying XPM-format images. */
7032 Lisp_Object Qxpm;
7034 /* Indices of image specification fields in xpm_format, below. */
7036 enum xpm_keyword_index
7038 XPM_TYPE,
7039 XPM_FILE,
7040 XPM_DATA,
7041 XPM_ASCENT,
7042 XPM_MARGIN,
7043 XPM_RELIEF,
7044 XPM_ALGORITHM,
7045 XPM_HEURISTIC_MASK,
7046 XPM_MASK,
7047 XPM_COLOR_SYMBOLS,
7048 XPM_LAST
7051 /* Vector of image_keyword structures describing the format
7052 of valid XPM image specifications. */
7054 static struct image_keyword xpm_format[XPM_LAST] =
7056 {":type", IMAGE_SYMBOL_VALUE, 1},
7057 {":file", IMAGE_STRING_VALUE, 0},
7058 {":data", IMAGE_STRING_VALUE, 0},
7059 {":ascent", IMAGE_ASCENT_VALUE, 0},
7060 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7061 {":relief", IMAGE_INTEGER_VALUE, 0},
7062 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7063 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7064 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7065 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
7068 /* Structure describing the image type XBM. */
7070 static struct image_type xpm_type =
7072 &Qxpm,
7073 xpm_image_p,
7074 xpm_load,
7075 x_clear_image,
7076 NULL
7080 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
7081 functions for allocating image colors. Our own functions handle
7082 color allocation failures more gracefully than the ones on the XPM
7083 lib. */
7085 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
7086 #define ALLOC_XPM_COLORS
7087 #endif
7089 #ifdef ALLOC_XPM_COLORS
7091 static void xpm_init_color_cache P_ ((struct frame *, XpmAttributes *));
7092 static void xpm_free_color_cache P_ ((void));
7093 static int xpm_lookup_color P_ ((struct frame *, char *, XColor *));
7094 static int xpm_color_bucket P_ ((char *));
7095 static struct xpm_cached_color *xpm_cache_color P_ ((struct frame *, char *,
7096 XColor *, int));
7098 /* An entry in a hash table used to cache color definitions of named
7099 colors. This cache is necessary to speed up XPM image loading in
7100 case we do color allocations ourselves. Without it, we would need
7101 a call to XParseColor per pixel in the image. */
7103 struct xpm_cached_color
7105 /* Next in collision chain. */
7106 struct xpm_cached_color *next;
7108 /* Color definition (RGB and pixel color). */
7109 XColor color;
7111 /* Color name. */
7112 char name[1];
7115 /* The hash table used for the color cache, and its bucket vector
7116 size. */
7118 #define XPM_COLOR_CACHE_BUCKETS 1001
7119 struct xpm_cached_color **xpm_color_cache;
7121 /* Initialize the color cache. */
7123 static void
7124 xpm_init_color_cache (f, attrs)
7125 struct frame *f;
7126 XpmAttributes *attrs;
7128 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
7129 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
7130 memset (xpm_color_cache, 0, nbytes);
7131 init_color_table ();
7133 if (attrs->valuemask & XpmColorSymbols)
7135 int i;
7136 XColor color;
7138 for (i = 0; i < attrs->numsymbols; ++i)
7139 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7140 attrs->colorsymbols[i].value, &color))
7142 color.pixel = lookup_rgb_color (f, color.red, color.green,
7143 color.blue);
7144 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
7150 /* Free the color cache. */
7152 static void
7153 xpm_free_color_cache ()
7155 struct xpm_cached_color *p, *next;
7156 int i;
7158 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
7159 for (p = xpm_color_cache[i]; p; p = next)
7161 next = p->next;
7162 xfree (p);
7165 xfree (xpm_color_cache);
7166 xpm_color_cache = NULL;
7167 free_color_table ();
7171 /* Return the bucket index for color named COLOR_NAME in the color
7172 cache. */
7174 static int
7175 xpm_color_bucket (color_name)
7176 char *color_name;
7178 unsigned h = 0;
7179 char *s;
7181 for (s = color_name; *s; ++s)
7182 h = (h << 2) ^ *s;
7183 return h %= XPM_COLOR_CACHE_BUCKETS;
7187 /* On frame F, cache values COLOR for color with name COLOR_NAME.
7188 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
7189 entry added. */
7191 static struct xpm_cached_color *
7192 xpm_cache_color (f, color_name, color, bucket)
7193 struct frame *f;
7194 char *color_name;
7195 XColor *color;
7196 int bucket;
7198 size_t nbytes;
7199 struct xpm_cached_color *p;
7201 if (bucket < 0)
7202 bucket = xpm_color_bucket (color_name);
7204 nbytes = sizeof *p + strlen (color_name);
7205 p = (struct xpm_cached_color *) xmalloc (nbytes);
7206 strcpy (p->name, color_name);
7207 p->color = *color;
7208 p->next = xpm_color_cache[bucket];
7209 xpm_color_cache[bucket] = p;
7210 return p;
7214 /* Look up color COLOR_NAME for frame F in the color cache. If found,
7215 return the cached definition in *COLOR. Otherwise, make a new
7216 entry in the cache and allocate the color. Value is zero if color
7217 allocation failed. */
7219 static int
7220 xpm_lookup_color (f, color_name, color)
7221 struct frame *f;
7222 char *color_name;
7223 XColor *color;
7225 struct xpm_cached_color *p;
7226 int h = xpm_color_bucket (color_name);
7228 for (p = xpm_color_cache[h]; p; p = p->next)
7229 if (strcmp (p->name, color_name) == 0)
7230 break;
7232 if (p != NULL)
7233 *color = p->color;
7234 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7235 color_name, color))
7237 color->pixel = lookup_rgb_color (f, color->red, color->green,
7238 color->blue);
7239 p = xpm_cache_color (f, color_name, color, h);
7242 return p != NULL;
7246 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
7247 CLOSURE is a pointer to the frame on which we allocate the
7248 color. Return in *COLOR the allocated color. Value is non-zero
7249 if successful. */
7251 static int
7252 xpm_alloc_color (dpy, cmap, color_name, color, closure)
7253 Display *dpy;
7254 Colormap cmap;
7255 char *color_name;
7256 XColor *color;
7257 void *closure;
7259 return xpm_lookup_color ((struct frame *) closure, color_name, color);
7263 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
7264 is a pointer to the frame on which we allocate the color. Value is
7265 non-zero if successful. */
7267 static int
7268 xpm_free_colors (dpy, cmap, pixels, npixels, closure)
7269 Display *dpy;
7270 Colormap cmap;
7271 Pixel *pixels;
7272 int npixels;
7273 void *closure;
7275 return 1;
7278 #endif /* ALLOC_XPM_COLORS */
7281 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
7282 for XPM images. Such a list must consist of conses whose car and
7283 cdr are strings. */
7285 static int
7286 xpm_valid_color_symbols_p (color_symbols)
7287 Lisp_Object color_symbols;
7289 while (CONSP (color_symbols))
7291 Lisp_Object sym = XCAR (color_symbols);
7292 if (!CONSP (sym)
7293 || !STRINGP (XCAR (sym))
7294 || !STRINGP (XCDR (sym)))
7295 break;
7296 color_symbols = XCDR (color_symbols);
7299 return NILP (color_symbols);
7303 /* Value is non-zero if OBJECT is a valid XPM image specification. */
7305 static int
7306 xpm_image_p (object)
7307 Lisp_Object object;
7309 struct image_keyword fmt[XPM_LAST];
7310 bcopy (xpm_format, fmt, sizeof fmt);
7311 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
7312 /* Either `:file' or `:data' must be present. */
7313 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
7314 /* Either no `:color-symbols' or it's a list of conses
7315 whose car and cdr are strings. */
7316 && (fmt[XPM_COLOR_SYMBOLS].count == 0
7317 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
7321 /* Load image IMG which will be displayed on frame F. Value is
7322 non-zero if successful. */
7324 static int
7325 xpm_load (f, img)
7326 struct frame *f;
7327 struct image *img;
7329 int rc;
7330 XpmAttributes attrs;
7331 Lisp_Object specified_file, color_symbols;
7333 /* Configure the XPM lib. Use the visual of frame F. Allocate
7334 close colors. Return colors allocated. */
7335 bzero (&attrs, sizeof attrs);
7336 attrs.visual = FRAME_X_VISUAL (f);
7337 attrs.colormap = FRAME_X_COLORMAP (f);
7338 attrs.valuemask |= XpmVisual;
7339 attrs.valuemask |= XpmColormap;
7341 #ifdef ALLOC_XPM_COLORS
7342 /* Allocate colors with our own functions which handle
7343 failing color allocation more gracefully. */
7344 attrs.color_closure = f;
7345 attrs.alloc_color = xpm_alloc_color;
7346 attrs.free_colors = xpm_free_colors;
7347 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
7348 #else /* not ALLOC_XPM_COLORS */
7349 /* Let the XPM lib allocate colors. */
7350 attrs.valuemask |= XpmReturnAllocPixels;
7351 #ifdef XpmAllocCloseColors
7352 attrs.alloc_close_colors = 1;
7353 attrs.valuemask |= XpmAllocCloseColors;
7354 #else /* not XpmAllocCloseColors */
7355 attrs.closeness = 600;
7356 attrs.valuemask |= XpmCloseness;
7357 #endif /* not XpmAllocCloseColors */
7358 #endif /* ALLOC_XPM_COLORS */
7360 /* If image specification contains symbolic color definitions, add
7361 these to `attrs'. */
7362 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
7363 if (CONSP (color_symbols))
7365 Lisp_Object tail;
7366 XpmColorSymbol *xpm_syms;
7367 int i, size;
7369 attrs.valuemask |= XpmColorSymbols;
7371 /* Count number of symbols. */
7372 attrs.numsymbols = 0;
7373 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
7374 ++attrs.numsymbols;
7376 /* Allocate an XpmColorSymbol array. */
7377 size = attrs.numsymbols * sizeof *xpm_syms;
7378 xpm_syms = (XpmColorSymbol *) alloca (size);
7379 bzero (xpm_syms, size);
7380 attrs.colorsymbols = xpm_syms;
7382 /* Fill the color symbol array. */
7383 for (tail = color_symbols, i = 0;
7384 CONSP (tail);
7385 ++i, tail = XCDR (tail))
7387 Lisp_Object name = XCAR (XCAR (tail));
7388 Lisp_Object color = XCDR (XCAR (tail));
7389 xpm_syms[i].name = (char *) alloca (XSTRING (name)->size + 1);
7390 strcpy (xpm_syms[i].name, XSTRING (name)->data);
7391 xpm_syms[i].value = (char *) alloca (XSTRING (color)->size + 1);
7392 strcpy (xpm_syms[i].value, XSTRING (color)->data);
7396 /* Create a pixmap for the image, either from a file, or from a
7397 string buffer containing data in the same format as an XPM file. */
7398 #ifdef ALLOC_XPM_COLORS
7399 xpm_init_color_cache (f, &attrs);
7400 #endif
7402 specified_file = image_spec_value (img->spec, QCfile, NULL);
7403 if (STRINGP (specified_file))
7405 Lisp_Object file = x_find_image_file (specified_file);
7406 if (!STRINGP (file))
7408 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7409 return 0;
7412 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7413 XSTRING (file)->data, &img->pixmap, &img->mask,
7414 &attrs);
7416 else
7418 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
7419 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7420 XSTRING (buffer)->data,
7421 &img->pixmap, &img->mask,
7422 &attrs);
7425 if (rc == XpmSuccess)
7427 #ifdef ALLOC_XPM_COLORS
7428 img->colors = colors_in_color_table (&img->ncolors);
7429 #else /* not ALLOC_XPM_COLORS */
7430 int i;
7432 img->ncolors = attrs.nalloc_pixels;
7433 img->colors = (unsigned long *) xmalloc (img->ncolors
7434 * sizeof *img->colors);
7435 for (i = 0; i < attrs.nalloc_pixels; ++i)
7437 img->colors[i] = attrs.alloc_pixels[i];
7438 #ifdef DEBUG_X_COLORS
7439 register_color (img->colors[i]);
7440 #endif
7442 #endif /* not ALLOC_XPM_COLORS */
7444 img->width = attrs.width;
7445 img->height = attrs.height;
7446 xassert (img->width > 0 && img->height > 0);
7448 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
7449 XpmFreeAttributes (&attrs);
7451 else
7453 switch (rc)
7455 case XpmOpenFailed:
7456 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
7457 break;
7459 case XpmFileInvalid:
7460 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
7461 break;
7463 case XpmNoMemory:
7464 image_error ("Out of memory (%s)", img->spec, Qnil);
7465 break;
7467 case XpmColorFailed:
7468 image_error ("Color allocation error (%s)", img->spec, Qnil);
7469 break;
7471 default:
7472 image_error ("Unknown error (%s)", img->spec, Qnil);
7473 break;
7477 #ifdef ALLOC_XPM_COLORS
7478 xpm_free_color_cache ();
7479 #endif
7480 return rc == XpmSuccess;
7483 #endif /* HAVE_XPM != 0 */
7486 /***********************************************************************
7487 Color table
7488 ***********************************************************************/
7490 /* An entry in the color table mapping an RGB color to a pixel color. */
7492 struct ct_color
7494 int r, g, b;
7495 unsigned long pixel;
7497 /* Next in color table collision list. */
7498 struct ct_color *next;
7501 /* The bucket vector size to use. Must be prime. */
7503 #define CT_SIZE 101
7505 /* Value is a hash of the RGB color given by R, G, and B. */
7507 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
7509 /* The color hash table. */
7511 struct ct_color **ct_table;
7513 /* Number of entries in the color table. */
7515 int ct_colors_allocated;
7517 /* Initialize the color table. */
7519 static void
7520 init_color_table ()
7522 int size = CT_SIZE * sizeof (*ct_table);
7523 ct_table = (struct ct_color **) xmalloc (size);
7524 bzero (ct_table, size);
7525 ct_colors_allocated = 0;
7529 /* Free memory associated with the color table. */
7531 static void
7532 free_color_table ()
7534 int i;
7535 struct ct_color *p, *next;
7537 for (i = 0; i < CT_SIZE; ++i)
7538 for (p = ct_table[i]; p; p = next)
7540 next = p->next;
7541 xfree (p);
7544 xfree (ct_table);
7545 ct_table = NULL;
7549 /* Value is a pixel color for RGB color R, G, B on frame F. If an
7550 entry for that color already is in the color table, return the
7551 pixel color of that entry. Otherwise, allocate a new color for R,
7552 G, B, and make an entry in the color table. */
7554 static unsigned long
7555 lookup_rgb_color (f, r, g, b)
7556 struct frame *f;
7557 int r, g, b;
7559 unsigned hash = CT_HASH_RGB (r, g, b);
7560 int i = hash % CT_SIZE;
7561 struct ct_color *p;
7563 for (p = ct_table[i]; p; p = p->next)
7564 if (p->r == r && p->g == g && p->b == b)
7565 break;
7567 if (p == NULL)
7569 XColor color;
7570 Colormap cmap;
7571 int rc;
7573 color.red = r;
7574 color.green = g;
7575 color.blue = b;
7577 cmap = FRAME_X_COLORMAP (f);
7578 rc = x_alloc_nearest_color (f, cmap, &color);
7580 if (rc)
7582 ++ct_colors_allocated;
7584 p = (struct ct_color *) xmalloc (sizeof *p);
7585 p->r = r;
7586 p->g = g;
7587 p->b = b;
7588 p->pixel = color.pixel;
7589 p->next = ct_table[i];
7590 ct_table[i] = p;
7592 else
7593 return FRAME_FOREGROUND_PIXEL (f);
7596 return p->pixel;
7600 /* Look up pixel color PIXEL which is used on frame F in the color
7601 table. If not already present, allocate it. Value is PIXEL. */
7603 static unsigned long
7604 lookup_pixel_color (f, pixel)
7605 struct frame *f;
7606 unsigned long pixel;
7608 int i = pixel % CT_SIZE;
7609 struct ct_color *p;
7611 for (p = ct_table[i]; p; p = p->next)
7612 if (p->pixel == pixel)
7613 break;
7615 if (p == NULL)
7617 XColor color;
7618 Colormap cmap;
7619 int rc;
7621 cmap = FRAME_X_COLORMAP (f);
7622 color.pixel = pixel;
7623 x_query_color (f, &color);
7624 rc = x_alloc_nearest_color (f, cmap, &color);
7626 if (rc)
7628 ++ct_colors_allocated;
7630 p = (struct ct_color *) xmalloc (sizeof *p);
7631 p->r = color.red;
7632 p->g = color.green;
7633 p->b = color.blue;
7634 p->pixel = pixel;
7635 p->next = ct_table[i];
7636 ct_table[i] = p;
7638 else
7639 return FRAME_FOREGROUND_PIXEL (f);
7642 return p->pixel;
7646 /* Value is a vector of all pixel colors contained in the color table,
7647 allocated via xmalloc. Set *N to the number of colors. */
7649 static unsigned long *
7650 colors_in_color_table (n)
7651 int *n;
7653 int i, j;
7654 struct ct_color *p;
7655 unsigned long *colors;
7657 if (ct_colors_allocated == 0)
7659 *n = 0;
7660 colors = NULL;
7662 else
7664 colors = (unsigned long *) xmalloc (ct_colors_allocated
7665 * sizeof *colors);
7666 *n = ct_colors_allocated;
7668 for (i = j = 0; i < CT_SIZE; ++i)
7669 for (p = ct_table[i]; p; p = p->next)
7670 colors[j++] = p->pixel;
7673 return colors;
7678 /***********************************************************************
7679 Algorithms
7680 ***********************************************************************/
7682 static void x_laplace_write_row P_ ((struct frame *, long *,
7683 int, XImage *, int));
7684 static void x_laplace_read_row P_ ((struct frame *, Colormap,
7685 XColor *, int, XImage *, int));
7686 static XColor *x_to_xcolors P_ ((struct frame *, struct image *, int));
7687 static void x_from_xcolors P_ ((struct frame *, struct image *, XColor *));
7688 static void x_detect_edges P_ ((struct frame *, struct image *, int[9], int));
7690 /* Non-zero means draw a cross on images having `:conversion
7691 disabled'. */
7693 int cross_disabled_images;
7695 /* Edge detection matrices for different edge-detection
7696 strategies. */
7698 static int emboss_matrix[9] = {
7699 /* x - 1 x x + 1 */
7700 2, -1, 0, /* y - 1 */
7701 -1, 0, 1, /* y */
7702 0, 1, -2 /* y + 1 */
7705 static int laplace_matrix[9] = {
7706 /* x - 1 x x + 1 */
7707 1, 0, 0, /* y - 1 */
7708 0, 0, 0, /* y */
7709 0, 0, -1 /* y + 1 */
7712 /* Value is the intensity of the color whose red/green/blue values
7713 are R, G, and B. */
7715 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
7718 /* On frame F, return an array of XColor structures describing image
7719 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
7720 non-zero means also fill the red/green/blue members of the XColor
7721 structures. Value is a pointer to the array of XColors structures,
7722 allocated with xmalloc; it must be freed by the caller. */
7724 static XColor *
7725 x_to_xcolors (f, img, rgb_p)
7726 struct frame *f;
7727 struct image *img;
7728 int rgb_p;
7730 int x, y;
7731 XColor *colors, *p;
7732 XImage *ximg;
7734 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
7736 /* Get the X image IMG->pixmap. */
7737 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
7738 0, 0, img->width, img->height, ~0, ZPixmap);
7740 /* Fill the `pixel' members of the XColor array. I wished there
7741 were an easy and portable way to circumvent XGetPixel. */
7742 p = colors;
7743 for (y = 0; y < img->height; ++y)
7745 XColor *row = p;
7747 for (x = 0; x < img->width; ++x, ++p)
7748 p->pixel = XGetPixel (ximg, x, y);
7750 if (rgb_p)
7751 x_query_colors (f, row, img->width);
7754 XDestroyImage (ximg);
7755 return colors;
7759 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
7760 RGB members are set. F is the frame on which this all happens.
7761 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
7763 static void
7764 x_from_xcolors (f, img, colors)
7765 struct frame *f;
7766 struct image *img;
7767 XColor *colors;
7769 int x, y;
7770 XImage *oimg;
7771 Pixmap pixmap;
7772 XColor *p;
7774 init_color_table ();
7776 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
7777 &oimg, &pixmap);
7778 p = colors;
7779 for (y = 0; y < img->height; ++y)
7780 for (x = 0; x < img->width; ++x, ++p)
7782 unsigned long pixel;
7783 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
7784 XPutPixel (oimg, x, y, pixel);
7787 xfree (colors);
7788 x_clear_image_1 (f, img, 1, 0, 1);
7790 x_put_x_image (f, oimg, pixmap, img->width, img->height);
7791 x_destroy_x_image (oimg);
7792 img->pixmap = pixmap;
7793 img->colors = colors_in_color_table (&img->ncolors);
7794 free_color_table ();
7798 /* On frame F, perform edge-detection on image IMG.
7800 MATRIX is a nine-element array specifying the transformation
7801 matrix. See emboss_matrix for an example.
7803 COLOR_ADJUST is a color adjustment added to each pixel of the
7804 outgoing image. */
7806 static void
7807 x_detect_edges (f, img, matrix, color_adjust)
7808 struct frame *f;
7809 struct image *img;
7810 int matrix[9], color_adjust;
7812 XColor *colors = x_to_xcolors (f, img, 1);
7813 XColor *new, *p;
7814 int x, y, i, sum;
7816 for (i = sum = 0; i < 9; ++i)
7817 sum += abs (matrix[i]);
7819 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
7821 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
7823 for (y = 0; y < img->height; ++y)
7825 p = COLOR (new, 0, y);
7826 p->red = p->green = p->blue = 0xffff/2;
7827 p = COLOR (new, img->width - 1, y);
7828 p->red = p->green = p->blue = 0xffff/2;
7831 for (x = 1; x < img->width - 1; ++x)
7833 p = COLOR (new, x, 0);
7834 p->red = p->green = p->blue = 0xffff/2;
7835 p = COLOR (new, x, img->height - 1);
7836 p->red = p->green = p->blue = 0xffff/2;
7839 for (y = 1; y < img->height - 1; ++y)
7841 p = COLOR (new, 1, y);
7843 for (x = 1; x < img->width - 1; ++x, ++p)
7845 int r, g, b, y1, x1;
7847 r = g = b = i = 0;
7848 for (y1 = y - 1; y1 < y + 2; ++y1)
7849 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
7850 if (matrix[i])
7852 XColor *t = COLOR (colors, x1, y1);
7853 r += matrix[i] * t->red;
7854 g += matrix[i] * t->green;
7855 b += matrix[i] * t->blue;
7858 r = (r / sum + color_adjust) & 0xffff;
7859 g = (g / sum + color_adjust) & 0xffff;
7860 b = (b / sum + color_adjust) & 0xffff;
7861 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
7865 xfree (colors);
7866 x_from_xcolors (f, img, new);
7868 #undef COLOR
7872 /* Perform the pre-defined `emboss' edge-detection on image IMG
7873 on frame F. */
7875 static void
7876 x_emboss (f, img)
7877 struct frame *f;
7878 struct image *img;
7880 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
7884 /* Perform the pre-defined `laplace' edge-detection on image IMG
7885 on frame F. */
7887 static void
7888 x_laplace (f, img)
7889 struct frame *f;
7890 struct image *img;
7892 x_detect_edges (f, img, laplace_matrix, 45000);
7896 /* Perform edge-detection on image IMG on frame F, with specified
7897 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
7899 MATRIX must be either
7901 - a list of at least 9 numbers in row-major form
7902 - a vector of at least 9 numbers
7904 COLOR_ADJUST nil means use a default; otherwise it must be a
7905 number. */
7907 static void
7908 x_edge_detection (f, img, matrix, color_adjust)
7909 struct frame *f;
7910 struct image *img;
7911 Lisp_Object matrix, color_adjust;
7913 int i = 0;
7914 int trans[9];
7916 if (CONSP (matrix))
7918 for (i = 0;
7919 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
7920 ++i, matrix = XCDR (matrix))
7921 trans[i] = XFLOATINT (XCAR (matrix));
7923 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
7925 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
7926 trans[i] = XFLOATINT (AREF (matrix, i));
7929 if (NILP (color_adjust))
7930 color_adjust = make_number (0xffff / 2);
7932 if (i == 9 && NUMBERP (color_adjust))
7933 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
7937 /* Transform image IMG on frame F so that it looks disabled. */
7939 static void
7940 x_disable_image (f, img)
7941 struct frame *f;
7942 struct image *img;
7944 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7946 if (dpyinfo->n_planes >= 2)
7948 /* Color (or grayscale). Convert to gray, and equalize. Just
7949 drawing such images with a stipple can look very odd, so
7950 we're using this method instead. */
7951 XColor *colors = x_to_xcolors (f, img, 1);
7952 XColor *p, *end;
7953 const int h = 15000;
7954 const int l = 30000;
7956 for (p = colors, end = colors + img->width * img->height;
7957 p < end;
7958 ++p)
7960 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
7961 int i2 = (0xffff - h - l) * i / 0xffff + l;
7962 p->red = p->green = p->blue = i2;
7965 x_from_xcolors (f, img, colors);
7968 /* Draw a cross over the disabled image, if we must or if we
7969 should. */
7970 if (dpyinfo->n_planes < 2 || cross_disabled_images)
7972 Display *dpy = FRAME_X_DISPLAY (f);
7973 GC gc;
7975 gc = XCreateGC (dpy, img->pixmap, 0, NULL);
7976 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
7977 XDrawLine (dpy, img->pixmap, gc, 0, 0,
7978 img->width - 1, img->height - 1);
7979 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
7980 img->width - 1, 0);
7981 XFreeGC (dpy, gc);
7983 if (img->mask)
7985 gc = XCreateGC (dpy, img->mask, 0, NULL);
7986 XSetForeground (dpy, gc, WHITE_PIX_DEFAULT (f));
7987 XDrawLine (dpy, img->mask, gc, 0, 0,
7988 img->width - 1, img->height - 1);
7989 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
7990 img->width - 1, 0);
7991 XFreeGC (dpy, gc);
7997 /* Build a mask for image IMG which is used on frame F. FILE is the
7998 name of an image file, for error messages. HOW determines how to
7999 determine the background color of IMG. If it is a list '(R G B)',
8000 with R, G, and B being integers >= 0, take that as the color of the
8001 background. Otherwise, determine the background color of IMG
8002 heuristically. Value is non-zero if successful. */
8004 static int
8005 x_build_heuristic_mask (f, img, how)
8006 struct frame *f;
8007 struct image *img;
8008 Lisp_Object how;
8010 Display *dpy = FRAME_X_DISPLAY (f);
8011 XImage *ximg, *mask_img;
8012 int x, y, rc, look_at_corners_p;
8013 unsigned long bg = 0;
8015 if (img->mask)
8017 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
8018 img->mask = None;
8021 /* Create an image and pixmap serving as mask. */
8022 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
8023 &mask_img, &img->mask);
8024 if (!rc)
8025 return 0;
8027 /* Get the X image of IMG->pixmap. */
8028 ximg = XGetImage (dpy, img->pixmap, 0, 0, img->width, img->height,
8029 ~0, ZPixmap);
8031 /* Determine the background color of ximg. If HOW is `(R G B)'
8032 take that as color. Otherwise, try to determine the color
8033 heuristically. */
8034 look_at_corners_p = 1;
8036 if (CONSP (how))
8038 int rgb[3], i = 0;
8040 while (i < 3
8041 && CONSP (how)
8042 && NATNUMP (XCAR (how)))
8044 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
8045 how = XCDR (how);
8048 if (i == 3 && NILP (how))
8050 char color_name[30];
8051 XColor exact, color;
8052 Colormap cmap;
8054 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
8056 cmap = FRAME_X_COLORMAP (f);
8057 if (XLookupColor (dpy, cmap, color_name, &exact, &color))
8059 bg = color.pixel;
8060 look_at_corners_p = 0;
8065 if (look_at_corners_p)
8067 unsigned long corners[4];
8068 int i, best_count;
8070 /* Get the colors at the corners of ximg. */
8071 corners[0] = XGetPixel (ximg, 0, 0);
8072 corners[1] = XGetPixel (ximg, img->width - 1, 0);
8073 corners[2] = XGetPixel (ximg, img->width - 1, img->height - 1);
8074 corners[3] = XGetPixel (ximg, 0, img->height - 1);
8076 /* Choose the most frequently found color as background. */
8077 for (i = best_count = 0; i < 4; ++i)
8079 int j, n;
8081 for (j = n = 0; j < 4; ++j)
8082 if (corners[i] == corners[j])
8083 ++n;
8085 if (n > best_count)
8086 bg = corners[i], best_count = n;
8090 /* Set all bits in mask_img to 1 whose color in ximg is different
8091 from the background color bg. */
8092 for (y = 0; y < img->height; ++y)
8093 for (x = 0; x < img->width; ++x)
8094 XPutPixel (mask_img, x, y, XGetPixel (ximg, x, y) != bg);
8096 /* Put mask_img into img->mask. */
8097 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8098 x_destroy_x_image (mask_img);
8099 XDestroyImage (ximg);
8101 return 1;
8106 /***********************************************************************
8107 PBM (mono, gray, color)
8108 ***********************************************************************/
8110 static int pbm_image_p P_ ((Lisp_Object object));
8111 static int pbm_load P_ ((struct frame *f, struct image *img));
8112 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
8114 /* The symbol `pbm' identifying images of this type. */
8116 Lisp_Object Qpbm;
8118 /* Indices of image specification fields in gs_format, below. */
8120 enum pbm_keyword_index
8122 PBM_TYPE,
8123 PBM_FILE,
8124 PBM_DATA,
8125 PBM_ASCENT,
8126 PBM_MARGIN,
8127 PBM_RELIEF,
8128 PBM_ALGORITHM,
8129 PBM_HEURISTIC_MASK,
8130 PBM_MASK,
8131 PBM_FOREGROUND,
8132 PBM_BACKGROUND,
8133 PBM_LAST
8136 /* Vector of image_keyword structures describing the format
8137 of valid user-defined image specifications. */
8139 static struct image_keyword pbm_format[PBM_LAST] =
8141 {":type", IMAGE_SYMBOL_VALUE, 1},
8142 {":file", IMAGE_STRING_VALUE, 0},
8143 {":data", IMAGE_STRING_VALUE, 0},
8144 {":ascent", IMAGE_ASCENT_VALUE, 0},
8145 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8146 {":relief", IMAGE_INTEGER_VALUE, 0},
8147 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8148 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8149 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8150 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
8151 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
8154 /* Structure describing the image type `pbm'. */
8156 static struct image_type pbm_type =
8158 &Qpbm,
8159 pbm_image_p,
8160 pbm_load,
8161 x_clear_image,
8162 NULL
8166 /* Return non-zero if OBJECT is a valid PBM image specification. */
8168 static int
8169 pbm_image_p (object)
8170 Lisp_Object object;
8172 struct image_keyword fmt[PBM_LAST];
8174 bcopy (pbm_format, fmt, sizeof fmt);
8176 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
8177 return 0;
8179 /* Must specify either :data or :file. */
8180 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
8184 /* Scan a decimal number from *S and return it. Advance *S while
8185 reading the number. END is the end of the string. Value is -1 at
8186 end of input. */
8188 static int
8189 pbm_scan_number (s, end)
8190 unsigned char **s, *end;
8192 int c = 0, val = -1;
8194 while (*s < end)
8196 /* Skip white-space. */
8197 while (*s < end && (c = *(*s)++, isspace (c)))
8200 if (c == '#')
8202 /* Skip comment to end of line. */
8203 while (*s < end && (c = *(*s)++, c != '\n'))
8206 else if (isdigit (c))
8208 /* Read decimal number. */
8209 val = c - '0';
8210 while (*s < end && (c = *(*s)++, isdigit (c)))
8211 val = 10 * val + c - '0';
8212 break;
8214 else
8215 break;
8218 return val;
8222 /* Load PBM image IMG for use on frame F. */
8224 static int
8225 pbm_load (f, img)
8226 struct frame *f;
8227 struct image *img;
8229 int raw_p, x, y;
8230 int width, height, max_color_idx = 0;
8231 XImage *ximg;
8232 Lisp_Object file, specified_file;
8233 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
8234 struct gcpro gcpro1;
8235 unsigned char *contents = NULL;
8236 unsigned char *end, *p;
8237 int size;
8239 specified_file = image_spec_value (img->spec, QCfile, NULL);
8240 file = Qnil;
8241 GCPRO1 (file);
8243 if (STRINGP (specified_file))
8245 file = x_find_image_file (specified_file);
8246 if (!STRINGP (file))
8248 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8249 UNGCPRO;
8250 return 0;
8253 contents = slurp_file (XSTRING (file)->data, &size);
8254 if (contents == NULL)
8256 image_error ("Error reading `%s'", file, Qnil);
8257 UNGCPRO;
8258 return 0;
8261 p = contents;
8262 end = contents + size;
8264 else
8266 Lisp_Object data;
8267 data = image_spec_value (img->spec, QCdata, NULL);
8268 p = XSTRING (data)->data;
8269 end = p + STRING_BYTES (XSTRING (data));
8272 /* Check magic number. */
8273 if (end - p < 2 || *p++ != 'P')
8275 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8276 error:
8277 xfree (contents);
8278 UNGCPRO;
8279 return 0;
8282 switch (*p++)
8284 case '1':
8285 raw_p = 0, type = PBM_MONO;
8286 break;
8288 case '2':
8289 raw_p = 0, type = PBM_GRAY;
8290 break;
8292 case '3':
8293 raw_p = 0, type = PBM_COLOR;
8294 break;
8296 case '4':
8297 raw_p = 1, type = PBM_MONO;
8298 break;
8300 case '5':
8301 raw_p = 1, type = PBM_GRAY;
8302 break;
8304 case '6':
8305 raw_p = 1, type = PBM_COLOR;
8306 break;
8308 default:
8309 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8310 goto error;
8313 /* Read width, height, maximum color-component. Characters
8314 starting with `#' up to the end of a line are ignored. */
8315 width = pbm_scan_number (&p, end);
8316 height = pbm_scan_number (&p, end);
8318 if (type != PBM_MONO)
8320 max_color_idx = pbm_scan_number (&p, end);
8321 if (raw_p && max_color_idx > 255)
8322 max_color_idx = 255;
8325 if (width < 0
8326 || height < 0
8327 || (type != PBM_MONO && max_color_idx < 0))
8328 goto error;
8330 if (!x_create_x_image_and_pixmap (f, width, height, 0,
8331 &ximg, &img->pixmap))
8332 goto error;
8334 /* Initialize the color hash table. */
8335 init_color_table ();
8337 if (type == PBM_MONO)
8339 int c = 0, g;
8340 struct image_keyword fmt[PBM_LAST];
8341 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
8342 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
8344 /* Parse the image specification. */
8345 bcopy (pbm_format, fmt, sizeof fmt);
8346 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
8348 /* Get foreground and background colors, maybe allocate colors. */
8349 if (fmt[PBM_FOREGROUND].count
8350 && STRINGP (fmt[PBM_FOREGROUND].value))
8351 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
8352 if (fmt[PBM_BACKGROUND].count
8353 && STRINGP (fmt[PBM_BACKGROUND].value))
8354 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
8356 for (y = 0; y < height; ++y)
8357 for (x = 0; x < width; ++x)
8359 if (raw_p)
8361 if ((x & 7) == 0)
8362 c = *p++;
8363 g = c & 0x80;
8364 c <<= 1;
8366 else
8367 g = pbm_scan_number (&p, end);
8369 XPutPixel (ximg, x, y, g ? fg : bg);
8372 else
8374 for (y = 0; y < height; ++y)
8375 for (x = 0; x < width; ++x)
8377 int r, g, b;
8379 if (type == PBM_GRAY)
8380 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
8381 else if (raw_p)
8383 r = *p++;
8384 g = *p++;
8385 b = *p++;
8387 else
8389 r = pbm_scan_number (&p, end);
8390 g = pbm_scan_number (&p, end);
8391 b = pbm_scan_number (&p, end);
8394 if (r < 0 || g < 0 || b < 0)
8396 xfree (ximg->data);
8397 ximg->data = NULL;
8398 XDestroyImage (ximg);
8399 image_error ("Invalid pixel value in image `%s'",
8400 img->spec, Qnil);
8401 goto error;
8404 /* RGB values are now in the range 0..max_color_idx.
8405 Scale this to the range 0..0xffff supported by X. */
8406 r = (double) r * 65535 / max_color_idx;
8407 g = (double) g * 65535 / max_color_idx;
8408 b = (double) b * 65535 / max_color_idx;
8409 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8413 /* Store in IMG->colors the colors allocated for the image, and
8414 free the color table. */
8415 img->colors = colors_in_color_table (&img->ncolors);
8416 free_color_table ();
8418 /* Put the image into a pixmap. */
8419 x_put_x_image (f, ximg, img->pixmap, width, height);
8420 x_destroy_x_image (ximg);
8422 img->width = width;
8423 img->height = height;
8425 UNGCPRO;
8426 xfree (contents);
8427 return 1;
8432 /***********************************************************************
8434 ***********************************************************************/
8436 #if HAVE_PNG
8438 #include <png.h>
8440 /* Function prototypes. */
8442 static int png_image_p P_ ((Lisp_Object object));
8443 static int png_load P_ ((struct frame *f, struct image *img));
8445 /* The symbol `png' identifying images of this type. */
8447 Lisp_Object Qpng;
8449 /* Indices of image specification fields in png_format, below. */
8451 enum png_keyword_index
8453 PNG_TYPE,
8454 PNG_DATA,
8455 PNG_FILE,
8456 PNG_ASCENT,
8457 PNG_MARGIN,
8458 PNG_RELIEF,
8459 PNG_ALGORITHM,
8460 PNG_HEURISTIC_MASK,
8461 PNG_MASK,
8462 PNG_LAST
8465 /* Vector of image_keyword structures describing the format
8466 of valid user-defined image specifications. */
8468 static struct image_keyword png_format[PNG_LAST] =
8470 {":type", IMAGE_SYMBOL_VALUE, 1},
8471 {":data", IMAGE_STRING_VALUE, 0},
8472 {":file", IMAGE_STRING_VALUE, 0},
8473 {":ascent", IMAGE_ASCENT_VALUE, 0},
8474 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8475 {":relief", IMAGE_INTEGER_VALUE, 0},
8476 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8477 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8478 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8481 /* Structure describing the image type `png'. */
8483 static struct image_type png_type =
8485 &Qpng,
8486 png_image_p,
8487 png_load,
8488 x_clear_image,
8489 NULL
8493 /* Return non-zero if OBJECT is a valid PNG image specification. */
8495 static int
8496 png_image_p (object)
8497 Lisp_Object object;
8499 struct image_keyword fmt[PNG_LAST];
8500 bcopy (png_format, fmt, sizeof fmt);
8502 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
8503 return 0;
8505 /* Must specify either the :data or :file keyword. */
8506 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
8510 /* Error and warning handlers installed when the PNG library
8511 is initialized. */
8513 static void
8514 my_png_error (png_ptr, msg)
8515 png_struct *png_ptr;
8516 char *msg;
8518 xassert (png_ptr != NULL);
8519 image_error ("PNG error: %s", build_string (msg), Qnil);
8520 longjmp (png_ptr->jmpbuf, 1);
8524 static void
8525 my_png_warning (png_ptr, msg)
8526 png_struct *png_ptr;
8527 char *msg;
8529 xassert (png_ptr != NULL);
8530 image_error ("PNG warning: %s", build_string (msg), Qnil);
8533 /* Memory source for PNG decoding. */
8535 struct png_memory_storage
8537 unsigned char *bytes; /* The data */
8538 size_t len; /* How big is it? */
8539 int index; /* Where are we? */
8543 /* Function set as reader function when reading PNG image from memory.
8544 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
8545 bytes from the input to DATA. */
8547 static void
8548 png_read_from_memory (png_ptr, data, length)
8549 png_structp png_ptr;
8550 png_bytep data;
8551 png_size_t length;
8553 struct png_memory_storage *tbr
8554 = (struct png_memory_storage *) png_get_io_ptr (png_ptr);
8556 if (length > tbr->len - tbr->index)
8557 png_error (png_ptr, "Read error");
8559 bcopy (tbr->bytes + tbr->index, data, length);
8560 tbr->index = tbr->index + length;
8563 /* Load PNG image IMG for use on frame F. Value is non-zero if
8564 successful. */
8566 static int
8567 png_load (f, img)
8568 struct frame *f;
8569 struct image *img;
8571 Lisp_Object file, specified_file;
8572 Lisp_Object specified_data;
8573 int x, y, i;
8574 XImage *ximg, *mask_img = NULL;
8575 struct gcpro gcpro1;
8576 png_struct *png_ptr = NULL;
8577 png_info *info_ptr = NULL, *end_info = NULL;
8578 FILE *volatile fp = NULL;
8579 png_byte sig[8];
8580 png_byte * volatile pixels = NULL;
8581 png_byte ** volatile rows = NULL;
8582 png_uint_32 width, height;
8583 int bit_depth, color_type, interlace_type;
8584 png_byte channels;
8585 png_uint_32 row_bytes;
8586 int transparent_p;
8587 char *gamma_str;
8588 double screen_gamma, image_gamma;
8589 int intent;
8590 struct png_memory_storage tbr; /* Data to be read */
8592 /* Find out what file to load. */
8593 specified_file = image_spec_value (img->spec, QCfile, NULL);
8594 specified_data = image_spec_value (img->spec, QCdata, NULL);
8595 file = Qnil;
8596 GCPRO1 (file);
8598 if (NILP (specified_data))
8600 file = x_find_image_file (specified_file);
8601 if (!STRINGP (file))
8603 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8604 UNGCPRO;
8605 return 0;
8608 /* Open the image file. */
8609 fp = fopen (XSTRING (file)->data, "rb");
8610 if (!fp)
8612 image_error ("Cannot open image file `%s'", file, Qnil);
8613 UNGCPRO;
8614 fclose (fp);
8615 return 0;
8618 /* Check PNG signature. */
8619 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
8620 || !png_check_sig (sig, sizeof sig))
8622 image_error ("Not a PNG file: `%s'", file, Qnil);
8623 UNGCPRO;
8624 fclose (fp);
8625 return 0;
8628 else
8630 /* Read from memory. */
8631 tbr.bytes = XSTRING (specified_data)->data;
8632 tbr.len = STRING_BYTES (XSTRING (specified_data));
8633 tbr.index = 0;
8635 /* Check PNG signature. */
8636 if (tbr.len < sizeof sig
8637 || !png_check_sig (tbr.bytes, sizeof sig))
8639 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
8640 UNGCPRO;
8641 return 0;
8644 /* Need to skip past the signature. */
8645 tbr.bytes += sizeof (sig);
8648 /* Initialize read and info structs for PNG lib. */
8649 png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
8650 my_png_error, my_png_warning);
8651 if (!png_ptr)
8653 if (fp) fclose (fp);
8654 UNGCPRO;
8655 return 0;
8658 info_ptr = png_create_info_struct (png_ptr);
8659 if (!info_ptr)
8661 png_destroy_read_struct (&png_ptr, NULL, NULL);
8662 if (fp) fclose (fp);
8663 UNGCPRO;
8664 return 0;
8667 end_info = png_create_info_struct (png_ptr);
8668 if (!end_info)
8670 png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
8671 if (fp) fclose (fp);
8672 UNGCPRO;
8673 return 0;
8676 /* Set error jump-back. We come back here when the PNG library
8677 detects an error. */
8678 if (setjmp (png_ptr->jmpbuf))
8680 error:
8681 if (png_ptr)
8682 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8683 xfree (pixels);
8684 xfree (rows);
8685 if (fp) fclose (fp);
8686 UNGCPRO;
8687 return 0;
8690 /* Read image info. */
8691 if (!NILP (specified_data))
8692 png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
8693 else
8694 png_init_io (png_ptr, fp);
8696 png_set_sig_bytes (png_ptr, sizeof sig);
8697 png_read_info (png_ptr, info_ptr);
8698 png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
8699 &interlace_type, NULL, NULL);
8701 /* If image contains simply transparency data, we prefer to
8702 construct a clipping mask. */
8703 if (png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
8704 transparent_p = 1;
8705 else
8706 transparent_p = 0;
8708 /* This function is easier to write if we only have to handle
8709 one data format: RGB or RGBA with 8 bits per channel. Let's
8710 transform other formats into that format. */
8712 /* Strip more than 8 bits per channel. */
8713 if (bit_depth == 16)
8714 png_set_strip_16 (png_ptr);
8716 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
8717 if available. */
8718 png_set_expand (png_ptr);
8720 /* Convert grayscale images to RGB. */
8721 if (color_type == PNG_COLOR_TYPE_GRAY
8722 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
8723 png_set_gray_to_rgb (png_ptr);
8725 /* The value 2.2 is a guess for PC monitors from PNG example.c. */
8726 gamma_str = getenv ("SCREEN_GAMMA");
8727 screen_gamma = gamma_str ? atof (gamma_str) : 2.2;
8729 /* Tell the PNG lib to handle gamma correction for us. */
8731 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
8732 if (png_get_sRGB (png_ptr, info_ptr, &intent))
8733 /* There is a special chunk in the image specifying the gamma. */
8734 png_set_sRGB (png_ptr, info_ptr, intent);
8735 else
8736 #endif
8737 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
8738 /* Image contains gamma information. */
8739 png_set_gamma (png_ptr, screen_gamma, image_gamma);
8740 else
8741 /* Use a default of 0.5 for the image gamma. */
8742 png_set_gamma (png_ptr, screen_gamma, 0.5);
8744 /* Handle alpha channel by combining the image with a background
8745 color. Do this only if a real alpha channel is supplied. For
8746 simple transparency, we prefer a clipping mask. */
8747 if (!transparent_p)
8749 png_color_16 *image_background;
8751 if (png_get_bKGD (png_ptr, info_ptr, &image_background))
8752 /* Image contains a background color with which to
8753 combine the image. */
8754 png_set_background (png_ptr, image_background,
8755 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
8756 else
8758 /* Image does not contain a background color with which
8759 to combine the image data via an alpha channel. Use
8760 the frame's background instead. */
8761 XColor color;
8762 Colormap cmap;
8763 png_color_16 frame_background;
8765 cmap = FRAME_X_COLORMAP (f);
8766 color.pixel = FRAME_BACKGROUND_PIXEL (f);
8767 x_query_color (f, &color);
8769 bzero (&frame_background, sizeof frame_background);
8770 frame_background.red = color.red;
8771 frame_background.green = color.green;
8772 frame_background.blue = color.blue;
8774 png_set_background (png_ptr, &frame_background,
8775 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
8779 /* Update info structure. */
8780 png_read_update_info (png_ptr, info_ptr);
8782 /* Get number of channels. Valid values are 1 for grayscale images
8783 and images with a palette, 2 for grayscale images with transparency
8784 information (alpha channel), 3 for RGB images, and 4 for RGB
8785 images with alpha channel, i.e. RGBA. If conversions above were
8786 sufficient we should only have 3 or 4 channels here. */
8787 channels = png_get_channels (png_ptr, info_ptr);
8788 xassert (channels == 3 || channels == 4);
8790 /* Number of bytes needed for one row of the image. */
8791 row_bytes = png_get_rowbytes (png_ptr, info_ptr);
8793 /* Allocate memory for the image. */
8794 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
8795 rows = (png_byte **) xmalloc (height * sizeof *rows);
8796 for (i = 0; i < height; ++i)
8797 rows[i] = pixels + i * row_bytes;
8799 /* Read the entire image. */
8800 png_read_image (png_ptr, rows);
8801 png_read_end (png_ptr, info_ptr);
8802 if (fp)
8804 fclose (fp);
8805 fp = NULL;
8808 /* Create the X image and pixmap. */
8809 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
8810 &img->pixmap))
8811 goto error;
8813 /* Create an image and pixmap serving as mask if the PNG image
8814 contains an alpha channel. */
8815 if (channels == 4
8816 && !transparent_p
8817 && !x_create_x_image_and_pixmap (f, width, height, 1,
8818 &mask_img, &img->mask))
8820 x_destroy_x_image (ximg);
8821 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
8822 img->pixmap = None;
8823 goto error;
8826 /* Fill the X image and mask from PNG data. */
8827 init_color_table ();
8829 for (y = 0; y < height; ++y)
8831 png_byte *p = rows[y];
8833 for (x = 0; x < width; ++x)
8835 unsigned r, g, b;
8837 r = *p++ << 8;
8838 g = *p++ << 8;
8839 b = *p++ << 8;
8840 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8842 /* An alpha channel, aka mask channel, associates variable
8843 transparency with an image. Where other image formats
8844 support binary transparency---fully transparent or fully
8845 opaque---PNG allows up to 254 levels of partial transparency.
8846 The PNG library implements partial transparency by combining
8847 the image with a specified background color.
8849 I'm not sure how to handle this here nicely: because the
8850 background on which the image is displayed may change, for
8851 real alpha channel support, it would be necessary to create
8852 a new image for each possible background.
8854 What I'm doing now is that a mask is created if we have
8855 boolean transparency information. Otherwise I'm using
8856 the frame's background color to combine the image with. */
8858 if (channels == 4)
8860 if (mask_img)
8861 XPutPixel (mask_img, x, y, *p > 0);
8862 ++p;
8867 /* Remember colors allocated for this image. */
8868 img->colors = colors_in_color_table (&img->ncolors);
8869 free_color_table ();
8871 /* Clean up. */
8872 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8873 xfree (rows);
8874 xfree (pixels);
8876 img->width = width;
8877 img->height = height;
8879 /* Put the image into the pixmap, then free the X image and its buffer. */
8880 x_put_x_image (f, ximg, img->pixmap, width, height);
8881 x_destroy_x_image (ximg);
8883 /* Same for the mask. */
8884 if (mask_img)
8886 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8887 x_destroy_x_image (mask_img);
8890 UNGCPRO;
8891 return 1;
8894 #endif /* HAVE_PNG != 0 */
8898 /***********************************************************************
8899 JPEG
8900 ***********************************************************************/
8902 #if HAVE_JPEG
8904 /* Work around a warning about HAVE_STDLIB_H being redefined in
8905 jconfig.h. */
8906 #ifdef HAVE_STDLIB_H
8907 #define HAVE_STDLIB_H_1
8908 #undef HAVE_STDLIB_H
8909 #endif /* HAVE_STLIB_H */
8911 #include <jpeglib.h>
8912 #include <jerror.h>
8913 #include <setjmp.h>
8915 #ifdef HAVE_STLIB_H_1
8916 #define HAVE_STDLIB_H 1
8917 #endif
8919 static int jpeg_image_p P_ ((Lisp_Object object));
8920 static int jpeg_load P_ ((struct frame *f, struct image *img));
8922 /* The symbol `jpeg' identifying images of this type. */
8924 Lisp_Object Qjpeg;
8926 /* Indices of image specification fields in gs_format, below. */
8928 enum jpeg_keyword_index
8930 JPEG_TYPE,
8931 JPEG_DATA,
8932 JPEG_FILE,
8933 JPEG_ASCENT,
8934 JPEG_MARGIN,
8935 JPEG_RELIEF,
8936 JPEG_ALGORITHM,
8937 JPEG_HEURISTIC_MASK,
8938 JPEG_MASK,
8939 JPEG_LAST
8942 /* Vector of image_keyword structures describing the format
8943 of valid user-defined image specifications. */
8945 static struct image_keyword jpeg_format[JPEG_LAST] =
8947 {":type", IMAGE_SYMBOL_VALUE, 1},
8948 {":data", IMAGE_STRING_VALUE, 0},
8949 {":file", IMAGE_STRING_VALUE, 0},
8950 {":ascent", IMAGE_ASCENT_VALUE, 0},
8951 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8952 {":relief", IMAGE_INTEGER_VALUE, 0},
8953 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8954 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8955 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8958 /* Structure describing the image type `jpeg'. */
8960 static struct image_type jpeg_type =
8962 &Qjpeg,
8963 jpeg_image_p,
8964 jpeg_load,
8965 x_clear_image,
8966 NULL
8970 /* Return non-zero if OBJECT is a valid JPEG image specification. */
8972 static int
8973 jpeg_image_p (object)
8974 Lisp_Object object;
8976 struct image_keyword fmt[JPEG_LAST];
8978 bcopy (jpeg_format, fmt, sizeof fmt);
8980 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
8981 return 0;
8983 /* Must specify either the :data or :file keyword. */
8984 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
8988 struct my_jpeg_error_mgr
8990 struct jpeg_error_mgr pub;
8991 jmp_buf setjmp_buffer;
8995 static void
8996 my_error_exit (cinfo)
8997 j_common_ptr cinfo;
8999 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
9000 longjmp (mgr->setjmp_buffer, 1);
9004 /* Init source method for JPEG data source manager. Called by
9005 jpeg_read_header() before any data is actually read. See
9006 libjpeg.doc from the JPEG lib distribution. */
9008 static void
9009 our_init_source (cinfo)
9010 j_decompress_ptr cinfo;
9015 /* Fill input buffer method for JPEG data source manager. Called
9016 whenever more data is needed. We read the whole image in one step,
9017 so this only adds a fake end of input marker at the end. */
9019 static boolean
9020 our_fill_input_buffer (cinfo)
9021 j_decompress_ptr cinfo;
9023 /* Insert a fake EOI marker. */
9024 struct jpeg_source_mgr *src = cinfo->src;
9025 static JOCTET buffer[2];
9027 buffer[0] = (JOCTET) 0xFF;
9028 buffer[1] = (JOCTET) JPEG_EOI;
9030 src->next_input_byte = buffer;
9031 src->bytes_in_buffer = 2;
9032 return TRUE;
9036 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
9037 is the JPEG data source manager. */
9039 static void
9040 our_skip_input_data (cinfo, num_bytes)
9041 j_decompress_ptr cinfo;
9042 long num_bytes;
9044 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
9046 if (src)
9048 if (num_bytes > src->bytes_in_buffer)
9049 ERREXIT (cinfo, JERR_INPUT_EOF);
9051 src->bytes_in_buffer -= num_bytes;
9052 src->next_input_byte += num_bytes;
9057 /* Method to terminate data source. Called by
9058 jpeg_finish_decompress() after all data has been processed. */
9060 static void
9061 our_term_source (cinfo)
9062 j_decompress_ptr cinfo;
9067 /* Set up the JPEG lib for reading an image from DATA which contains
9068 LEN bytes. CINFO is the decompression info structure created for
9069 reading the image. */
9071 static void
9072 jpeg_memory_src (cinfo, data, len)
9073 j_decompress_ptr cinfo;
9074 JOCTET *data;
9075 unsigned int len;
9077 struct jpeg_source_mgr *src;
9079 if (cinfo->src == NULL)
9081 /* First time for this JPEG object? */
9082 cinfo->src = (struct jpeg_source_mgr *)
9083 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
9084 sizeof (struct jpeg_source_mgr));
9085 src = (struct jpeg_source_mgr *) cinfo->src;
9086 src->next_input_byte = data;
9089 src = (struct jpeg_source_mgr *) cinfo->src;
9090 src->init_source = our_init_source;
9091 src->fill_input_buffer = our_fill_input_buffer;
9092 src->skip_input_data = our_skip_input_data;
9093 src->resync_to_restart = jpeg_resync_to_restart; /* Use default method. */
9094 src->term_source = our_term_source;
9095 src->bytes_in_buffer = len;
9096 src->next_input_byte = data;
9100 /* Load image IMG for use on frame F. Patterned after example.c
9101 from the JPEG lib. */
9103 static int
9104 jpeg_load (f, img)
9105 struct frame *f;
9106 struct image *img;
9108 struct jpeg_decompress_struct cinfo;
9109 struct my_jpeg_error_mgr mgr;
9110 Lisp_Object file, specified_file;
9111 Lisp_Object specified_data;
9112 FILE * volatile fp = NULL;
9113 JSAMPARRAY buffer;
9114 int row_stride, x, y;
9115 XImage *ximg = NULL;
9116 int rc;
9117 unsigned long *colors;
9118 int width, height;
9119 struct gcpro gcpro1;
9121 /* Open the JPEG file. */
9122 specified_file = image_spec_value (img->spec, QCfile, NULL);
9123 specified_data = image_spec_value (img->spec, QCdata, NULL);
9124 file = Qnil;
9125 GCPRO1 (file);
9127 if (NILP (specified_data))
9129 file = x_find_image_file (specified_file);
9130 if (!STRINGP (file))
9132 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9133 UNGCPRO;
9134 return 0;
9137 fp = fopen (XSTRING (file)->data, "r");
9138 if (fp == NULL)
9140 image_error ("Cannot open `%s'", file, Qnil);
9141 UNGCPRO;
9142 return 0;
9146 /* Customize libjpeg's error handling to call my_error_exit when an
9147 error is detected. This function will perform a longjmp. */
9148 cinfo.err = jpeg_std_error (&mgr.pub);
9149 mgr.pub.error_exit = my_error_exit;
9151 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
9153 if (rc == 1)
9155 /* Called from my_error_exit. Display a JPEG error. */
9156 char buffer[JMSG_LENGTH_MAX];
9157 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
9158 image_error ("Error reading JPEG image `%s': %s", img->spec,
9159 build_string (buffer));
9162 /* Close the input file and destroy the JPEG object. */
9163 if (fp)
9164 fclose ((FILE *) fp);
9165 jpeg_destroy_decompress (&cinfo);
9167 /* If we already have an XImage, free that. */
9168 x_destroy_x_image (ximg);
9170 /* Free pixmap and colors. */
9171 x_clear_image (f, img);
9173 UNGCPRO;
9174 return 0;
9177 /* Create the JPEG decompression object. Let it read from fp.
9178 Read the JPEG image header. */
9179 jpeg_create_decompress (&cinfo);
9181 if (NILP (specified_data))
9182 jpeg_stdio_src (&cinfo, (FILE *) fp);
9183 else
9184 jpeg_memory_src (&cinfo, XSTRING (specified_data)->data,
9185 STRING_BYTES (XSTRING (specified_data)));
9187 jpeg_read_header (&cinfo, TRUE);
9189 /* Customize decompression so that color quantization will be used.
9190 Start decompression. */
9191 cinfo.quantize_colors = TRUE;
9192 jpeg_start_decompress (&cinfo);
9193 width = img->width = cinfo.output_width;
9194 height = img->height = cinfo.output_height;
9196 /* Create X image and pixmap. */
9197 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9198 longjmp (mgr.setjmp_buffer, 2);
9200 /* Allocate colors. When color quantization is used,
9201 cinfo.actual_number_of_colors has been set with the number of
9202 colors generated, and cinfo.colormap is a two-dimensional array
9203 of color indices in the range 0..cinfo.actual_number_of_colors.
9204 No more than 255 colors will be generated. */
9206 int i, ir, ig, ib;
9208 if (cinfo.out_color_components > 2)
9209 ir = 0, ig = 1, ib = 2;
9210 else if (cinfo.out_color_components > 1)
9211 ir = 0, ig = 1, ib = 0;
9212 else
9213 ir = 0, ig = 0, ib = 0;
9215 /* Use the color table mechanism because it handles colors that
9216 cannot be allocated nicely. Such colors will be replaced with
9217 a default color, and we don't have to care about which colors
9218 can be freed safely, and which can't. */
9219 init_color_table ();
9220 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
9221 * sizeof *colors);
9223 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
9225 /* Multiply RGB values with 255 because X expects RGB values
9226 in the range 0..0xffff. */
9227 int r = cinfo.colormap[ir][i] << 8;
9228 int g = cinfo.colormap[ig][i] << 8;
9229 int b = cinfo.colormap[ib][i] << 8;
9230 colors[i] = lookup_rgb_color (f, r, g, b);
9233 /* Remember those colors actually allocated. */
9234 img->colors = colors_in_color_table (&img->ncolors);
9235 free_color_table ();
9238 /* Read pixels. */
9239 row_stride = width * cinfo.output_components;
9240 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
9241 row_stride, 1);
9242 for (y = 0; y < height; ++y)
9244 jpeg_read_scanlines (&cinfo, buffer, 1);
9245 for (x = 0; x < cinfo.output_width; ++x)
9246 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
9249 /* Clean up. */
9250 jpeg_finish_decompress (&cinfo);
9251 jpeg_destroy_decompress (&cinfo);
9252 if (fp)
9253 fclose ((FILE *) fp);
9255 /* Put the image into the pixmap. */
9256 x_put_x_image (f, ximg, img->pixmap, width, height);
9257 x_destroy_x_image (ximg);
9258 UNGCPRO;
9259 return 1;
9262 #endif /* HAVE_JPEG */
9266 /***********************************************************************
9267 TIFF
9268 ***********************************************************************/
9270 #if HAVE_TIFF
9272 #include <tiffio.h>
9274 static int tiff_image_p P_ ((Lisp_Object object));
9275 static int tiff_load P_ ((struct frame *f, struct image *img));
9277 /* The symbol `tiff' identifying images of this type. */
9279 Lisp_Object Qtiff;
9281 /* Indices of image specification fields in tiff_format, below. */
9283 enum tiff_keyword_index
9285 TIFF_TYPE,
9286 TIFF_DATA,
9287 TIFF_FILE,
9288 TIFF_ASCENT,
9289 TIFF_MARGIN,
9290 TIFF_RELIEF,
9291 TIFF_ALGORITHM,
9292 TIFF_HEURISTIC_MASK,
9293 TIFF_MASK,
9294 TIFF_LAST
9297 /* Vector of image_keyword structures describing the format
9298 of valid user-defined image specifications. */
9300 static struct image_keyword tiff_format[TIFF_LAST] =
9302 {":type", IMAGE_SYMBOL_VALUE, 1},
9303 {":data", IMAGE_STRING_VALUE, 0},
9304 {":file", IMAGE_STRING_VALUE, 0},
9305 {":ascent", IMAGE_ASCENT_VALUE, 0},
9306 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9307 {":relief", IMAGE_INTEGER_VALUE, 0},
9308 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9309 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9310 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9313 /* Structure describing the image type `tiff'. */
9315 static struct image_type tiff_type =
9317 &Qtiff,
9318 tiff_image_p,
9319 tiff_load,
9320 x_clear_image,
9321 NULL
9325 /* Return non-zero if OBJECT is a valid TIFF image specification. */
9327 static int
9328 tiff_image_p (object)
9329 Lisp_Object object;
9331 struct image_keyword fmt[TIFF_LAST];
9332 bcopy (tiff_format, fmt, sizeof fmt);
9334 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
9335 return 0;
9337 /* Must specify either the :data or :file keyword. */
9338 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
9342 /* Reading from a memory buffer for TIFF images Based on the PNG
9343 memory source, but we have to provide a lot of extra functions.
9344 Blah.
9346 We really only need to implement read and seek, but I am not
9347 convinced that the TIFF library is smart enough not to destroy
9348 itself if we only hand it the function pointers we need to
9349 override. */
9351 typedef struct
9353 unsigned char *bytes;
9354 size_t len;
9355 int index;
9357 tiff_memory_source;
9360 static size_t
9361 tiff_read_from_memory (data, buf, size)
9362 thandle_t data;
9363 tdata_t buf;
9364 tsize_t size;
9366 tiff_memory_source *src = (tiff_memory_source *) data;
9368 if (size > src->len - src->index)
9369 return (size_t) -1;
9370 bcopy (src->bytes + src->index, buf, size);
9371 src->index += size;
9372 return size;
9376 static size_t
9377 tiff_write_from_memory (data, buf, size)
9378 thandle_t data;
9379 tdata_t buf;
9380 tsize_t size;
9382 return (size_t) -1;
9386 static toff_t
9387 tiff_seek_in_memory (data, off, whence)
9388 thandle_t data;
9389 toff_t off;
9390 int whence;
9392 tiff_memory_source *src = (tiff_memory_source *) data;
9393 int idx;
9395 switch (whence)
9397 case SEEK_SET: /* Go from beginning of source. */
9398 idx = off;
9399 break;
9401 case SEEK_END: /* Go from end of source. */
9402 idx = src->len + off;
9403 break;
9405 case SEEK_CUR: /* Go from current position. */
9406 idx = src->index + off;
9407 break;
9409 default: /* Invalid `whence'. */
9410 return -1;
9413 if (idx > src->len || idx < 0)
9414 return -1;
9416 src->index = idx;
9417 return src->index;
9421 static int
9422 tiff_close_memory (data)
9423 thandle_t data;
9425 /* NOOP */
9426 return 0;
9430 static int
9431 tiff_mmap_memory (data, pbase, psize)
9432 thandle_t data;
9433 tdata_t *pbase;
9434 toff_t *psize;
9436 /* It is already _IN_ memory. */
9437 return 0;
9441 static void
9442 tiff_unmap_memory (data, base, size)
9443 thandle_t data;
9444 tdata_t base;
9445 toff_t size;
9447 /* We don't need to do this. */
9451 static toff_t
9452 tiff_size_of_memory (data)
9453 thandle_t data;
9455 return ((tiff_memory_source *) data)->len;
9459 /* Load TIFF image IMG for use on frame F. Value is non-zero if
9460 successful. */
9462 static int
9463 tiff_load (f, img)
9464 struct frame *f;
9465 struct image *img;
9467 Lisp_Object file, specified_file;
9468 Lisp_Object specified_data;
9469 TIFF *tiff;
9470 int width, height, x, y;
9471 uint32 *buf;
9472 int rc;
9473 XImage *ximg;
9474 struct gcpro gcpro1;
9475 tiff_memory_source memsrc;
9477 specified_file = image_spec_value (img->spec, QCfile, NULL);
9478 specified_data = image_spec_value (img->spec, QCdata, NULL);
9479 file = Qnil;
9480 GCPRO1 (file);
9482 if (NILP (specified_data))
9484 /* Read from a file */
9485 file = x_find_image_file (specified_file);
9486 if (!STRINGP (file))
9488 image_error ("Cannot find image file `%s'", file, Qnil);
9489 UNGCPRO;
9490 return 0;
9493 /* Try to open the image file. */
9494 tiff = TIFFOpen (XSTRING (file)->data, "r");
9495 if (tiff == NULL)
9497 image_error ("Cannot open `%s'", file, Qnil);
9498 UNGCPRO;
9499 return 0;
9502 else
9504 /* Memory source! */
9505 memsrc.bytes = XSTRING (specified_data)->data;
9506 memsrc.len = STRING_BYTES (XSTRING (specified_data));
9507 memsrc.index = 0;
9509 tiff = TIFFClientOpen ("memory_source", "r", &memsrc,
9510 (TIFFReadWriteProc) tiff_read_from_memory,
9511 (TIFFReadWriteProc) tiff_write_from_memory,
9512 tiff_seek_in_memory,
9513 tiff_close_memory,
9514 tiff_size_of_memory,
9515 tiff_mmap_memory,
9516 tiff_unmap_memory);
9518 if (!tiff)
9520 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
9521 UNGCPRO;
9522 return 0;
9526 /* Get width and height of the image, and allocate a raster buffer
9527 of width x height 32-bit values. */
9528 TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
9529 TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
9530 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
9532 rc = TIFFReadRGBAImage (tiff, width, height, buf, 0);
9533 TIFFClose (tiff);
9534 if (!rc)
9536 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
9537 xfree (buf);
9538 UNGCPRO;
9539 return 0;
9542 /* Create the X image and pixmap. */
9543 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9545 xfree (buf);
9546 UNGCPRO;
9547 return 0;
9550 /* Initialize the color table. */
9551 init_color_table ();
9553 /* Process the pixel raster. Origin is in the lower-left corner. */
9554 for (y = 0; y < height; ++y)
9556 uint32 *row = buf + y * width;
9558 for (x = 0; x < width; ++x)
9560 uint32 abgr = row[x];
9561 int r = TIFFGetR (abgr) << 8;
9562 int g = TIFFGetG (abgr) << 8;
9563 int b = TIFFGetB (abgr) << 8;
9564 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
9568 /* Remember the colors allocated for the image. Free the color table. */
9569 img->colors = colors_in_color_table (&img->ncolors);
9570 free_color_table ();
9572 /* Put the image into the pixmap, then free the X image and its buffer. */
9573 x_put_x_image (f, ximg, img->pixmap, width, height);
9574 x_destroy_x_image (ximg);
9575 xfree (buf);
9577 img->width = width;
9578 img->height = height;
9580 UNGCPRO;
9581 return 1;
9584 #endif /* HAVE_TIFF != 0 */
9588 /***********************************************************************
9590 ***********************************************************************/
9592 #if HAVE_GIF
9594 #include <gif_lib.h>
9596 static int gif_image_p P_ ((Lisp_Object object));
9597 static int gif_load P_ ((struct frame *f, struct image *img));
9599 /* The symbol `gif' identifying images of this type. */
9601 Lisp_Object Qgif;
9603 /* Indices of image specification fields in gif_format, below. */
9605 enum gif_keyword_index
9607 GIF_TYPE,
9608 GIF_DATA,
9609 GIF_FILE,
9610 GIF_ASCENT,
9611 GIF_MARGIN,
9612 GIF_RELIEF,
9613 GIF_ALGORITHM,
9614 GIF_HEURISTIC_MASK,
9615 GIF_MASK,
9616 GIF_IMAGE,
9617 GIF_LAST
9620 /* Vector of image_keyword structures describing the format
9621 of valid user-defined image specifications. */
9623 static struct image_keyword gif_format[GIF_LAST] =
9625 {":type", IMAGE_SYMBOL_VALUE, 1},
9626 {":data", IMAGE_STRING_VALUE, 0},
9627 {":file", IMAGE_STRING_VALUE, 0},
9628 {":ascent", IMAGE_ASCENT_VALUE, 0},
9629 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9630 {":relief", IMAGE_INTEGER_VALUE, 0},
9631 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9632 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9633 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9634 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0}
9637 /* Structure describing the image type `gif'. */
9639 static struct image_type gif_type =
9641 &Qgif,
9642 gif_image_p,
9643 gif_load,
9644 x_clear_image,
9645 NULL
9649 /* Return non-zero if OBJECT is a valid GIF image specification. */
9651 static int
9652 gif_image_p (object)
9653 Lisp_Object object;
9655 struct image_keyword fmt[GIF_LAST];
9656 bcopy (gif_format, fmt, sizeof fmt);
9658 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
9659 return 0;
9661 /* Must specify either the :data or :file keyword. */
9662 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
9666 /* Reading a GIF image from memory
9667 Based on the PNG memory stuff to a certain extent. */
9669 typedef struct
9671 unsigned char *bytes;
9672 size_t len;
9673 int index;
9675 gif_memory_source;
9678 /* Make the current memory source available to gif_read_from_memory.
9679 It's done this way because not all versions of libungif support
9680 a UserData field in the GifFileType structure. */
9681 static gif_memory_source *current_gif_memory_src;
9683 static int
9684 gif_read_from_memory (file, buf, len)
9685 GifFileType *file;
9686 GifByteType *buf;
9687 int len;
9689 gif_memory_source *src = current_gif_memory_src;
9691 if (len > src->len - src->index)
9692 return -1;
9694 bcopy (src->bytes + src->index, buf, len);
9695 src->index += len;
9696 return len;
9700 /* Load GIF image IMG for use on frame F. Value is non-zero if
9701 successful. */
9703 static int
9704 gif_load (f, img)
9705 struct frame *f;
9706 struct image *img;
9708 Lisp_Object file, specified_file;
9709 Lisp_Object specified_data;
9710 int rc, width, height, x, y, i;
9711 XImage *ximg;
9712 ColorMapObject *gif_color_map;
9713 unsigned long pixel_colors[256];
9714 GifFileType *gif;
9715 struct gcpro gcpro1;
9716 Lisp_Object image;
9717 int ino, image_left, image_top, image_width, image_height;
9718 gif_memory_source memsrc;
9719 unsigned char *raster;
9721 specified_file = image_spec_value (img->spec, QCfile, NULL);
9722 specified_data = image_spec_value (img->spec, QCdata, NULL);
9723 file = Qnil;
9724 GCPRO1 (file);
9726 if (NILP (specified_data))
9728 file = x_find_image_file (specified_file);
9729 if (!STRINGP (file))
9731 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9732 UNGCPRO;
9733 return 0;
9736 /* Open the GIF file. */
9737 gif = DGifOpenFileName (XSTRING (file)->data);
9738 if (gif == NULL)
9740 image_error ("Cannot open `%s'", file, Qnil);
9741 UNGCPRO;
9742 return 0;
9745 else
9747 /* Read from memory! */
9748 current_gif_memory_src = &memsrc;
9749 memsrc.bytes = XSTRING (specified_data)->data;
9750 memsrc.len = STRING_BYTES (XSTRING (specified_data));
9751 memsrc.index = 0;
9753 gif = DGifOpen(&memsrc, gif_read_from_memory);
9754 if (!gif)
9756 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
9757 UNGCPRO;
9758 return 0;
9762 /* Read entire contents. */
9763 rc = DGifSlurp (gif);
9764 if (rc == GIF_ERROR)
9766 image_error ("Error reading `%s'", img->spec, Qnil);
9767 DGifCloseFile (gif);
9768 UNGCPRO;
9769 return 0;
9772 image = image_spec_value (img->spec, QCindex, NULL);
9773 ino = INTEGERP (image) ? XFASTINT (image) : 0;
9774 if (ino >= gif->ImageCount)
9776 image_error ("Invalid image number `%s' in image `%s'",
9777 image, img->spec);
9778 DGifCloseFile (gif);
9779 UNGCPRO;
9780 return 0;
9783 width = img->width = gif->SWidth;
9784 height = img->height = gif->SHeight;
9786 /* Create the X image and pixmap. */
9787 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9789 DGifCloseFile (gif);
9790 UNGCPRO;
9791 return 0;
9794 /* Allocate colors. */
9795 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
9796 if (!gif_color_map)
9797 gif_color_map = gif->SColorMap;
9798 init_color_table ();
9799 bzero (pixel_colors, sizeof pixel_colors);
9801 for (i = 0; i < gif_color_map->ColorCount; ++i)
9803 int r = gif_color_map->Colors[i].Red << 8;
9804 int g = gif_color_map->Colors[i].Green << 8;
9805 int b = gif_color_map->Colors[i].Blue << 8;
9806 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
9809 img->colors = colors_in_color_table (&img->ncolors);
9810 free_color_table ();
9812 /* Clear the part of the screen image that are not covered by
9813 the image from the GIF file. Full animated GIF support
9814 requires more than can be done here (see the gif89 spec,
9815 disposal methods). Let's simply assume that the part
9816 not covered by a sub-image is in the frame's background color. */
9817 image_top = gif->SavedImages[ino].ImageDesc.Top;
9818 image_left = gif->SavedImages[ino].ImageDesc.Left;
9819 image_width = gif->SavedImages[ino].ImageDesc.Width;
9820 image_height = gif->SavedImages[ino].ImageDesc.Height;
9822 for (y = 0; y < image_top; ++y)
9823 for (x = 0; x < width; ++x)
9824 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9826 for (y = image_top + image_height; y < height; ++y)
9827 for (x = 0; x < width; ++x)
9828 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9830 for (y = image_top; y < image_top + image_height; ++y)
9832 for (x = 0; x < image_left; ++x)
9833 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9834 for (x = image_left + image_width; x < width; ++x)
9835 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9838 /* Read the GIF image into the X image. We use a local variable
9839 `raster' here because RasterBits below is a char *, and invites
9840 problems with bytes >= 0x80. */
9841 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
9843 if (gif->SavedImages[ino].ImageDesc.Interlace)
9845 static int interlace_start[] = {0, 4, 2, 1};
9846 static int interlace_increment[] = {8, 8, 4, 2};
9847 int pass;
9848 int row = interlace_start[0];
9850 pass = 0;
9852 for (y = 0; y < image_height; y++)
9854 if (row >= image_height)
9856 row = interlace_start[++pass];
9857 while (row >= image_height)
9858 row = interlace_start[++pass];
9861 for (x = 0; x < image_width; x++)
9863 int i = raster[(y * image_width) + x];
9864 XPutPixel (ximg, x + image_left, row + image_top,
9865 pixel_colors[i]);
9868 row += interlace_increment[pass];
9871 else
9873 for (y = 0; y < image_height; ++y)
9874 for (x = 0; x < image_width; ++x)
9876 int i = raster[y * image_width + x];
9877 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
9881 DGifCloseFile (gif);
9883 /* Put the image into the pixmap, then free the X image and its buffer. */
9884 x_put_x_image (f, ximg, img->pixmap, width, height);
9885 x_destroy_x_image (ximg);
9887 UNGCPRO;
9888 return 1;
9891 #endif /* HAVE_GIF != 0 */
9895 /***********************************************************************
9896 Ghostscript
9897 ***********************************************************************/
9899 static int gs_image_p P_ ((Lisp_Object object));
9900 static int gs_load P_ ((struct frame *f, struct image *img));
9901 static void gs_clear_image P_ ((struct frame *f, struct image *img));
9903 /* The symbol `postscript' identifying images of this type. */
9905 Lisp_Object Qpostscript;
9907 /* Keyword symbols. */
9909 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
9911 /* Indices of image specification fields in gs_format, below. */
9913 enum gs_keyword_index
9915 GS_TYPE,
9916 GS_PT_WIDTH,
9917 GS_PT_HEIGHT,
9918 GS_FILE,
9919 GS_LOADER,
9920 GS_BOUNDING_BOX,
9921 GS_ASCENT,
9922 GS_MARGIN,
9923 GS_RELIEF,
9924 GS_ALGORITHM,
9925 GS_HEURISTIC_MASK,
9926 GS_MASK,
9927 GS_LAST
9930 /* Vector of image_keyword structures describing the format
9931 of valid user-defined image specifications. */
9933 static struct image_keyword gs_format[GS_LAST] =
9935 {":type", IMAGE_SYMBOL_VALUE, 1},
9936 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9937 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9938 {":file", IMAGE_STRING_VALUE, 1},
9939 {":loader", IMAGE_FUNCTION_VALUE, 0},
9940 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
9941 {":ascent", IMAGE_ASCENT_VALUE, 0},
9942 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9943 {":relief", IMAGE_INTEGER_VALUE, 0},
9944 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9945 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9946 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9949 /* Structure describing the image type `ghostscript'. */
9951 static struct image_type gs_type =
9953 &Qpostscript,
9954 gs_image_p,
9955 gs_load,
9956 gs_clear_image,
9957 NULL
9961 /* Free X resources of Ghostscript image IMG which is used on frame F. */
9963 static void
9964 gs_clear_image (f, img)
9965 struct frame *f;
9966 struct image *img;
9968 /* IMG->data.ptr_val may contain a recorded colormap. */
9969 xfree (img->data.ptr_val);
9970 x_clear_image (f, img);
9974 /* Return non-zero if OBJECT is a valid Ghostscript image
9975 specification. */
9977 static int
9978 gs_image_p (object)
9979 Lisp_Object object;
9981 struct image_keyword fmt[GS_LAST];
9982 Lisp_Object tem;
9983 int i;
9985 bcopy (gs_format, fmt, sizeof fmt);
9987 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
9988 return 0;
9990 /* Bounding box must be a list or vector containing 4 integers. */
9991 tem = fmt[GS_BOUNDING_BOX].value;
9992 if (CONSP (tem))
9994 for (i = 0; i < 4; ++i, tem = XCDR (tem))
9995 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
9996 return 0;
9997 if (!NILP (tem))
9998 return 0;
10000 else if (VECTORP (tem))
10002 if (XVECTOR (tem)->size != 4)
10003 return 0;
10004 for (i = 0; i < 4; ++i)
10005 if (!INTEGERP (XVECTOR (tem)->contents[i]))
10006 return 0;
10008 else
10009 return 0;
10011 return 1;
10015 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
10016 if successful. */
10018 static int
10019 gs_load (f, img)
10020 struct frame *f;
10021 struct image *img;
10023 char buffer[100];
10024 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
10025 struct gcpro gcpro1, gcpro2;
10026 Lisp_Object frame;
10027 double in_width, in_height;
10028 Lisp_Object pixel_colors = Qnil;
10030 /* Compute pixel size of pixmap needed from the given size in the
10031 image specification. Sizes in the specification are in pt. 1 pt
10032 = 1/72 in, xdpi and ydpi are stored in the frame's X display
10033 info. */
10034 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
10035 in_width = XFASTINT (pt_width) / 72.0;
10036 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
10037 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
10038 in_height = XFASTINT (pt_height) / 72.0;
10039 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
10041 /* Create the pixmap. */
10042 xassert (img->pixmap == None);
10043 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10044 img->width, img->height,
10045 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
10047 if (!img->pixmap)
10049 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
10050 return 0;
10053 /* Call the loader to fill the pixmap. It returns a process object
10054 if successful. We do not record_unwind_protect here because
10055 other places in redisplay like calling window scroll functions
10056 don't either. Let the Lisp loader use `unwind-protect' instead. */
10057 GCPRO2 (window_and_pixmap_id, pixel_colors);
10059 sprintf (buffer, "%lu %lu",
10060 (unsigned long) FRAME_X_WINDOW (f),
10061 (unsigned long) img->pixmap);
10062 window_and_pixmap_id = build_string (buffer);
10064 sprintf (buffer, "%lu %lu",
10065 FRAME_FOREGROUND_PIXEL (f),
10066 FRAME_BACKGROUND_PIXEL (f));
10067 pixel_colors = build_string (buffer);
10069 XSETFRAME (frame, f);
10070 loader = image_spec_value (img->spec, QCloader, NULL);
10071 if (NILP (loader))
10072 loader = intern ("gs-load-image");
10074 img->data.lisp_val = call6 (loader, frame, img->spec,
10075 make_number (img->width),
10076 make_number (img->height),
10077 window_and_pixmap_id,
10078 pixel_colors);
10079 UNGCPRO;
10080 return PROCESSP (img->data.lisp_val);
10084 /* Kill the Ghostscript process that was started to fill PIXMAP on
10085 frame F. Called from XTread_socket when receiving an event
10086 telling Emacs that Ghostscript has finished drawing. */
10088 void
10089 x_kill_gs_process (pixmap, f)
10090 Pixmap pixmap;
10091 struct frame *f;
10093 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
10094 int class, i;
10095 struct image *img;
10097 /* Find the image containing PIXMAP. */
10098 for (i = 0; i < c->used; ++i)
10099 if (c->images[i]->pixmap == pixmap)
10100 break;
10102 /* Kill the GS process. We should have found PIXMAP in the image
10103 cache and its image should contain a process object. */
10104 xassert (i < c->used);
10105 img = c->images[i];
10106 xassert (PROCESSP (img->data.lisp_val));
10107 Fkill_process (img->data.lisp_val, Qnil);
10108 img->data.lisp_val = Qnil;
10110 /* On displays with a mutable colormap, figure out the colors
10111 allocated for the image by looking at the pixels of an XImage for
10112 img->pixmap. */
10113 class = FRAME_X_VISUAL (f)->class;
10114 if (class != StaticColor && class != StaticGray && class != TrueColor)
10116 XImage *ximg;
10118 BLOCK_INPUT;
10120 /* Try to get an XImage for img->pixmep. */
10121 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
10122 0, 0, img->width, img->height, ~0, ZPixmap);
10123 if (ximg)
10125 int x, y;
10127 /* Initialize the color table. */
10128 init_color_table ();
10130 /* For each pixel of the image, look its color up in the
10131 color table. After having done so, the color table will
10132 contain an entry for each color used by the image. */
10133 for (y = 0; y < img->height; ++y)
10134 for (x = 0; x < img->width; ++x)
10136 unsigned long pixel = XGetPixel (ximg, x, y);
10137 lookup_pixel_color (f, pixel);
10140 /* Record colors in the image. Free color table and XImage. */
10141 img->colors = colors_in_color_table (&img->ncolors);
10142 free_color_table ();
10143 XDestroyImage (ximg);
10145 #if 0 /* This doesn't seem to be the case. If we free the colors
10146 here, we get a BadAccess later in x_clear_image when
10147 freeing the colors. */
10148 /* We have allocated colors once, but Ghostscript has also
10149 allocated colors on behalf of us. So, to get the
10150 reference counts right, free them once. */
10151 if (img->ncolors)
10152 x_free_colors (f, img->colors, img->ncolors);
10153 #endif
10155 else
10156 image_error ("Cannot get X image of `%s'; colors will not be freed",
10157 img->spec, Qnil);
10159 UNBLOCK_INPUT;
10162 /* Now that we have the pixmap, compute mask and transform the
10163 image if requested. */
10164 BLOCK_INPUT;
10165 postprocess_image (f, img);
10166 UNBLOCK_INPUT;
10171 /***********************************************************************
10172 Window properties
10173 ***********************************************************************/
10175 DEFUN ("x-change-window-property", Fx_change_window_property,
10176 Sx_change_window_property, 2, 3, 0,
10177 "Change window property PROP to VALUE on the X window of FRAME.\n\
10178 PROP and VALUE must be strings. FRAME nil or omitted means use the\n\
10179 selected frame. Value is VALUE.")
10180 (prop, value, frame)
10181 Lisp_Object frame, prop, value;
10183 struct frame *f = check_x_frame (frame);
10184 Atom prop_atom;
10186 CHECK_STRING (prop, 1);
10187 CHECK_STRING (value, 2);
10189 BLOCK_INPUT;
10190 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10191 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10192 prop_atom, XA_STRING, 8, PropModeReplace,
10193 XSTRING (value)->data, XSTRING (value)->size);
10195 /* Make sure the property is set when we return. */
10196 XFlush (FRAME_X_DISPLAY (f));
10197 UNBLOCK_INPUT;
10199 return value;
10203 DEFUN ("x-delete-window-property", Fx_delete_window_property,
10204 Sx_delete_window_property, 1, 2, 0,
10205 "Remove window property PROP from X window of FRAME.\n\
10206 FRAME nil or omitted means use the selected frame. Value is PROP.")
10207 (prop, frame)
10208 Lisp_Object prop, frame;
10210 struct frame *f = check_x_frame (frame);
10211 Atom prop_atom;
10213 CHECK_STRING (prop, 1);
10214 BLOCK_INPUT;
10215 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10216 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
10218 /* Make sure the property is removed when we return. */
10219 XFlush (FRAME_X_DISPLAY (f));
10220 UNBLOCK_INPUT;
10222 return prop;
10226 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
10227 1, 2, 0,
10228 "Value is the value of window property PROP on FRAME.\n\
10229 If FRAME is nil or omitted, use the selected frame. Value is nil\n\
10230 if FRAME hasn't a property with name PROP or if PROP has no string\n\
10231 value.")
10232 (prop, frame)
10233 Lisp_Object prop, frame;
10235 struct frame *f = check_x_frame (frame);
10236 Atom prop_atom;
10237 int rc;
10238 Lisp_Object prop_value = Qnil;
10239 char *tmp_data = NULL;
10240 Atom actual_type;
10241 int actual_format;
10242 unsigned long actual_size, bytes_remaining;
10244 CHECK_STRING (prop, 1);
10245 BLOCK_INPUT;
10246 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10247 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10248 prop_atom, 0, 0, False, XA_STRING,
10249 &actual_type, &actual_format, &actual_size,
10250 &bytes_remaining, (unsigned char **) &tmp_data);
10251 if (rc == Success)
10253 int size = bytes_remaining;
10255 XFree (tmp_data);
10256 tmp_data = NULL;
10258 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10259 prop_atom, 0, bytes_remaining,
10260 False, XA_STRING,
10261 &actual_type, &actual_format,
10262 &actual_size, &bytes_remaining,
10263 (unsigned char **) &tmp_data);
10264 if (rc == Success)
10265 prop_value = make_string (tmp_data, size);
10267 XFree (tmp_data);
10270 UNBLOCK_INPUT;
10271 return prop_value;
10276 /***********************************************************************
10277 Busy cursor
10278 ***********************************************************************/
10280 /* If non-null, an asynchronous timer that, when it expires, displays
10281 an hourglass cursor on all frames. */
10283 static struct atimer *hourglass_atimer;
10285 /* Non-zero means an hourglass cursor is currently shown. */
10287 static int hourglass_shown_p;
10289 /* Number of seconds to wait before displaying an hourglass cursor. */
10291 static Lisp_Object Vhourglass_delay;
10293 /* Default number of seconds to wait before displaying an hourglass
10294 cursor. */
10296 #define DEFAULT_HOURGLASS_DELAY 1
10298 /* Function prototypes. */
10300 static void show_hourglass P_ ((struct atimer *));
10301 static void hide_hourglass P_ ((void));
10304 /* Cancel a currently active hourglass timer, and start a new one. */
10306 void
10307 start_hourglass ()
10309 EMACS_TIME delay;
10310 int secs, usecs = 0;
10312 cancel_hourglass ();
10314 if (INTEGERP (Vhourglass_delay)
10315 && XINT (Vhourglass_delay) > 0)
10316 secs = XFASTINT (Vhourglass_delay);
10317 else if (FLOATP (Vhourglass_delay)
10318 && XFLOAT_DATA (Vhourglass_delay) > 0)
10320 Lisp_Object tem;
10321 tem = Ftruncate (Vhourglass_delay, Qnil);
10322 secs = XFASTINT (tem);
10323 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
10325 else
10326 secs = DEFAULT_HOURGLASS_DELAY;
10328 EMACS_SET_SECS_USECS (delay, secs, usecs);
10329 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
10330 show_hourglass, NULL);
10334 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
10335 shown. */
10337 void
10338 cancel_hourglass ()
10340 if (hourglass_atimer)
10342 cancel_atimer (hourglass_atimer);
10343 hourglass_atimer = NULL;
10346 if (hourglass_shown_p)
10347 hide_hourglass ();
10351 /* Timer function of hourglass_atimer. TIMER is equal to
10352 hourglass_atimer.
10354 Display an hourglass pointer on all frames by mapping the frames'
10355 hourglass_window. Set the hourglass_p flag in the frames'
10356 output_data.x structure to indicate that an hourglass cursor is
10357 shown on the frames. */
10359 static void
10360 show_hourglass (timer)
10361 struct atimer *timer;
10363 /* The timer implementation will cancel this timer automatically
10364 after this function has run. Set hourglass_atimer to null
10365 so that we know the timer doesn't have to be canceled. */
10366 hourglass_atimer = NULL;
10368 if (!hourglass_shown_p)
10370 Lisp_Object rest, frame;
10372 BLOCK_INPUT;
10374 FOR_EACH_FRAME (rest, frame)
10376 struct frame *f = XFRAME (frame);
10378 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
10380 Display *dpy = FRAME_X_DISPLAY (f);
10382 #ifdef USE_X_TOOLKIT
10383 if (f->output_data.x->widget)
10384 #else
10385 if (FRAME_OUTER_WINDOW (f))
10386 #endif
10388 f->output_data.x->hourglass_p = 1;
10390 if (!f->output_data.x->hourglass_window)
10392 unsigned long mask = CWCursor;
10393 XSetWindowAttributes attrs;
10395 attrs.cursor = f->output_data.x->hourglass_cursor;
10397 f->output_data.x->hourglass_window
10398 = XCreateWindow (dpy, FRAME_OUTER_WINDOW (f),
10399 0, 0, 32000, 32000, 0, 0,
10400 InputOnly,
10401 CopyFromParent,
10402 mask, &attrs);
10405 XMapRaised (dpy, f->output_data.x->hourglass_window);
10406 XFlush (dpy);
10411 hourglass_shown_p = 1;
10412 UNBLOCK_INPUT;
10417 /* Hide the hourglass pointer on all frames, if it is currently
10418 shown. */
10420 static void
10421 hide_hourglass ()
10423 if (hourglass_shown_p)
10425 Lisp_Object rest, frame;
10427 BLOCK_INPUT;
10428 FOR_EACH_FRAME (rest, frame)
10430 struct frame *f = XFRAME (frame);
10432 if (FRAME_X_P (f)
10433 /* Watch out for newly created frames. */
10434 && f->output_data.x->hourglass_window)
10436 XUnmapWindow (FRAME_X_DISPLAY (f),
10437 f->output_data.x->hourglass_window);
10438 /* Sync here because XTread_socket looks at the
10439 hourglass_p flag that is reset to zero below. */
10440 XSync (FRAME_X_DISPLAY (f), False);
10441 f->output_data.x->hourglass_p = 0;
10445 hourglass_shown_p = 0;
10446 UNBLOCK_INPUT;
10452 /***********************************************************************
10453 Tool tips
10454 ***********************************************************************/
10456 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
10457 Lisp_Object, Lisp_Object));
10458 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
10459 Lisp_Object, int, int, int *, int *));
10461 /* The frame of a currently visible tooltip. */
10463 Lisp_Object tip_frame;
10465 /* If non-nil, a timer started that hides the last tooltip when it
10466 fires. */
10468 Lisp_Object tip_timer;
10469 Window tip_window;
10471 /* If non-nil, a vector of 3 elements containing the last args
10472 with which x-show-tip was called. See there. */
10474 Lisp_Object last_show_tip_args;
10477 static Lisp_Object
10478 unwind_create_tip_frame (frame)
10479 Lisp_Object frame;
10481 Lisp_Object deleted;
10483 deleted = unwind_create_frame (frame);
10484 if (EQ (deleted, Qt))
10486 tip_window = None;
10487 tip_frame = Qnil;
10490 return deleted;
10494 /* Create a frame for a tooltip on the display described by DPYINFO.
10495 PARMS is a list of frame parameters. TEXT is the string to
10496 display in the tip frame. Value is the frame.
10498 Note that functions called here, esp. x_default_parameter can
10499 signal errors, for instance when a specified color name is
10500 undefined. We have to make sure that we're in a consistent state
10501 when this happens. */
10503 static Lisp_Object
10504 x_create_tip_frame (dpyinfo, parms, text)
10505 struct x_display_info *dpyinfo;
10506 Lisp_Object parms, text;
10508 struct frame *f;
10509 Lisp_Object frame, tem;
10510 Lisp_Object name;
10511 long window_prompting = 0;
10512 int width, height;
10513 int count = BINDING_STACK_SIZE ();
10514 struct gcpro gcpro1, gcpro2, gcpro3;
10515 struct kboard *kb;
10516 int face_change_count_before = face_change_count;
10517 Lisp_Object buffer;
10518 struct buffer *old_buffer;
10520 check_x ();
10522 /* Use this general default value to start with until we know if
10523 this frame has a specified name. */
10524 Vx_resource_name = Vinvocation_name;
10526 #ifdef MULTI_KBOARD
10527 kb = dpyinfo->kboard;
10528 #else
10529 kb = &the_only_kboard;
10530 #endif
10532 /* Get the name of the frame to use for resource lookup. */
10533 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
10534 if (!STRINGP (name)
10535 && !EQ (name, Qunbound)
10536 && !NILP (name))
10537 error ("Invalid frame name--not a string or nil");
10538 Vx_resource_name = name;
10540 frame = Qnil;
10541 GCPRO3 (parms, name, frame);
10542 f = make_frame (1);
10543 XSETFRAME (frame, f);
10545 buffer = Fget_buffer_create (build_string (" *tip*"));
10546 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer);
10547 old_buffer = current_buffer;
10548 set_buffer_internal_1 (XBUFFER (buffer));
10549 Ferase_buffer ();
10550 Finsert (1, &text);
10551 set_buffer_internal_1 (old_buffer);
10553 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
10554 record_unwind_protect (unwind_create_tip_frame, frame);
10556 /* By setting the output method, we're essentially saying that
10557 the frame is live, as per FRAME_LIVE_P. If we get a signal
10558 from this point on, x_destroy_window might screw up reference
10559 counts etc. */
10560 f->output_method = output_x_window;
10561 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
10562 bzero (f->output_data.x, sizeof (struct x_output));
10563 f->output_data.x->icon_bitmap = -1;
10564 f->output_data.x->fontset = -1;
10565 f->output_data.x->scroll_bar_foreground_pixel = -1;
10566 f->output_data.x->scroll_bar_background_pixel = -1;
10567 f->icon_name = Qnil;
10568 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
10569 #if GLYPH_DEBUG
10570 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
10571 dpyinfo_refcount = dpyinfo->reference_count;
10572 #endif /* GLYPH_DEBUG */
10573 #ifdef MULTI_KBOARD
10574 FRAME_KBOARD (f) = kb;
10575 #endif
10576 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10577 f->output_data.x->explicit_parent = 0;
10579 /* These colors will be set anyway later, but it's important
10580 to get the color reference counts right, so initialize them! */
10582 Lisp_Object black;
10583 struct gcpro gcpro1;
10585 black = build_string ("black");
10586 GCPRO1 (black);
10587 f->output_data.x->foreground_pixel
10588 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10589 f->output_data.x->background_pixel
10590 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10591 f->output_data.x->cursor_pixel
10592 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10593 f->output_data.x->cursor_foreground_pixel
10594 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10595 f->output_data.x->border_pixel
10596 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10597 f->output_data.x->mouse_pixel
10598 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10599 UNGCPRO;
10602 /* Set the name; the functions to which we pass f expect the name to
10603 be set. */
10604 if (EQ (name, Qunbound) || NILP (name))
10606 f->name = build_string (dpyinfo->x_id_name);
10607 f->explicit_name = 0;
10609 else
10611 f->name = name;
10612 f->explicit_name = 1;
10613 /* use the frame's title when getting resources for this frame. */
10614 specbind (Qx_resource_name, name);
10617 /* Extract the window parameters from the supplied values that are
10618 needed to determine window geometry. */
10620 Lisp_Object font;
10622 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
10624 BLOCK_INPUT;
10625 /* First, try whatever font the caller has specified. */
10626 if (STRINGP (font))
10628 tem = Fquery_fontset (font, Qnil);
10629 if (STRINGP (tem))
10630 font = x_new_fontset (f, XSTRING (tem)->data);
10631 else
10632 font = x_new_font (f, XSTRING (font)->data);
10635 /* Try out a font which we hope has bold and italic variations. */
10636 if (!STRINGP (font))
10637 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
10638 if (!STRINGP (font))
10639 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10640 if (! STRINGP (font))
10641 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10642 if (! STRINGP (font))
10643 /* This was formerly the first thing tried, but it finds too many fonts
10644 and takes too long. */
10645 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
10646 /* If those didn't work, look for something which will at least work. */
10647 if (! STRINGP (font))
10648 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
10649 UNBLOCK_INPUT;
10650 if (! STRINGP (font))
10651 font = build_string ("fixed");
10653 x_default_parameter (f, parms, Qfont, font,
10654 "font", "Font", RES_TYPE_STRING);
10657 x_default_parameter (f, parms, Qborder_width, make_number (2),
10658 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
10660 /* This defaults to 2 in order to match xterm. We recognize either
10661 internalBorderWidth or internalBorder (which is what xterm calls
10662 it). */
10663 if (NILP (Fassq (Qinternal_border_width, parms)))
10665 Lisp_Object value;
10667 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
10668 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
10669 if (! EQ (value, Qunbound))
10670 parms = Fcons (Fcons (Qinternal_border_width, value),
10671 parms);
10674 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
10675 "internalBorderWidth", "internalBorderWidth",
10676 RES_TYPE_NUMBER);
10678 /* Also do the stuff which must be set before the window exists. */
10679 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
10680 "foreground", "Foreground", RES_TYPE_STRING);
10681 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
10682 "background", "Background", RES_TYPE_STRING);
10683 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
10684 "pointerColor", "Foreground", RES_TYPE_STRING);
10685 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
10686 "cursorColor", "Foreground", RES_TYPE_STRING);
10687 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
10688 "borderColor", "BorderColor", RES_TYPE_STRING);
10690 /* Init faces before x_default_parameter is called for scroll-bar
10691 parameters because that function calls x_set_scroll_bar_width,
10692 which calls change_frame_size, which calls Fset_window_buffer,
10693 which runs hooks, which call Fvertical_motion. At the end, we
10694 end up in init_iterator with a null face cache, which should not
10695 happen. */
10696 init_frame_faces (f);
10698 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10699 window_prompting = x_figure_window_size (f, parms);
10701 if (window_prompting & XNegative)
10703 if (window_prompting & YNegative)
10704 f->output_data.x->win_gravity = SouthEastGravity;
10705 else
10706 f->output_data.x->win_gravity = NorthEastGravity;
10708 else
10710 if (window_prompting & YNegative)
10711 f->output_data.x->win_gravity = SouthWestGravity;
10712 else
10713 f->output_data.x->win_gravity = NorthWestGravity;
10716 f->output_data.x->size_hint_flags = window_prompting;
10718 XSetWindowAttributes attrs;
10719 unsigned long mask;
10721 BLOCK_INPUT;
10722 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
10723 if (DoesSaveUnders (dpyinfo->screen))
10724 mask |= CWSaveUnder;
10726 /* Window managers look at the override-redirect flag to determine
10727 whether or net to give windows a decoration (Xlib spec, chapter
10728 3.2.8). */
10729 attrs.override_redirect = True;
10730 attrs.save_under = True;
10731 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
10732 /* Arrange for getting MapNotify and UnmapNotify events. */
10733 attrs.event_mask = StructureNotifyMask;
10734 tip_window
10735 = FRAME_X_WINDOW (f)
10736 = XCreateWindow (FRAME_X_DISPLAY (f),
10737 FRAME_X_DISPLAY_INFO (f)->root_window,
10738 /* x, y, width, height */
10739 0, 0, 1, 1,
10740 /* Border. */
10742 CopyFromParent, InputOutput, CopyFromParent,
10743 mask, &attrs);
10744 UNBLOCK_INPUT;
10747 x_make_gc (f);
10749 x_default_parameter (f, parms, Qauto_raise, Qnil,
10750 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
10751 x_default_parameter (f, parms, Qauto_lower, Qnil,
10752 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
10753 x_default_parameter (f, parms, Qcursor_type, Qbox,
10754 "cursorType", "CursorType", RES_TYPE_SYMBOL);
10756 /* Dimensions, especially f->height, must be done via change_frame_size.
10757 Change will not be effected unless different from the current
10758 f->height. */
10759 width = f->width;
10760 height = f->height;
10761 f->height = 0;
10762 SET_FRAME_WIDTH (f, 0);
10763 change_frame_size (f, height, width, 1, 0, 0);
10765 /* Set up faces after all frame parameters are known. This call
10766 also merges in face attributes specified for new frames.
10768 Frame parameters may be changed if .Xdefaults contains
10769 specifications for the default font. For example, if there is an
10770 `Emacs.default.attributeBackground: pink', the `background-color'
10771 attribute of the frame get's set, which let's the internal border
10772 of the tooltip frame appear in pink. Prevent this. */
10774 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
10776 /* Set tip_frame here, so that */
10777 tip_frame = frame;
10778 call1 (Qface_set_after_frame_default, frame);
10780 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
10781 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
10782 Qnil));
10785 f->no_split = 1;
10787 UNGCPRO;
10789 /* It is now ok to make the frame official even if we get an error
10790 below. And the frame needs to be on Vframe_list or making it
10791 visible won't work. */
10792 Vframe_list = Fcons (frame, Vframe_list);
10794 /* Now that the frame is official, it counts as a reference to
10795 its display. */
10796 FRAME_X_DISPLAY_INFO (f)->reference_count++;
10798 /* Setting attributes of faces of the tooltip frame from resources
10799 and similar will increment face_change_count, which leads to the
10800 clearing of all current matrices. Since this isn't necessary
10801 here, avoid it by resetting face_change_count to the value it
10802 had before we created the tip frame. */
10803 face_change_count = face_change_count_before;
10805 /* Discard the unwind_protect. */
10806 return unbind_to (count, frame);
10810 /* Compute where to display tip frame F. PARMS is the list of frame
10811 parameters for F. DX and DY are specified offsets from the current
10812 location of the mouse. WIDTH and HEIGHT are the width and height
10813 of the tooltip. Return coordinates relative to the root window of
10814 the display in *ROOT_X, and *ROOT_Y. */
10816 static void
10817 compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
10818 struct frame *f;
10819 Lisp_Object parms, dx, dy;
10820 int width, height;
10821 int *root_x, *root_y;
10823 Lisp_Object left, top;
10824 int win_x, win_y;
10825 Window root, child;
10826 unsigned pmask;
10828 /* User-specified position? */
10829 left = Fcdr (Fassq (Qleft, parms));
10830 top = Fcdr (Fassq (Qtop, parms));
10832 /* Move the tooltip window where the mouse pointer is. Resize and
10833 show it. */
10834 if (!INTEGERP (left) && !INTEGERP (top))
10836 BLOCK_INPUT;
10837 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
10838 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
10839 UNBLOCK_INPUT;
10842 if (INTEGERP (top))
10843 *root_y = XINT (top);
10844 else if (*root_y + XINT (dy) - height < 0)
10845 *root_y -= XINT (dy);
10846 else
10848 *root_y -= height;
10849 *root_y += XINT (dy);
10852 if (INTEGERP (left))
10853 *root_x = XINT (left);
10854 else if (*root_x + XINT (dx) + width > FRAME_X_DISPLAY_INFO (f)->width)
10855 *root_x -= width + XINT (dx);
10856 else
10857 *root_x += XINT (dx);
10861 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
10862 "Show STRING in a \"tooltip\" window on frame FRAME.\n\
10863 A tooltip window is a small X window displaying a string.\n\
10865 FRAME nil or omitted means use the selected frame.\n\
10867 PARMS is an optional list of frame parameters which can be\n\
10868 used to change the tooltip's appearance.\n\
10870 Automatically hide the tooltip after TIMEOUT seconds.\n\
10871 TIMEOUT nil means use the default timeout of 5 seconds.\n\
10873 If the list of frame parameters PARAMS contains a `left' parameters,\n\
10874 the tooltip is displayed at that x-position. Otherwise it is\n\
10875 displayed at the mouse position, with offset DX added (default is 5 if\n\
10876 DX isn't specified). Likewise for the y-position; if a `top' frame\n\
10877 parameter is specified, it determines the y-position of the tooltip\n\
10878 window, otherwise it is displayed at the mouse position, with offset\n\
10879 DY added (default is -10).")
10880 (string, frame, parms, timeout, dx, dy)
10881 Lisp_Object string, frame, parms, timeout, dx, dy;
10883 struct frame *f;
10884 struct window *w;
10885 Lisp_Object buffer, top, left;
10886 int root_x, root_y;
10887 struct buffer *old_buffer;
10888 struct text_pos pos;
10889 int i, width, height;
10890 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10891 int old_windows_or_buffers_changed = windows_or_buffers_changed;
10892 int count = BINDING_STACK_SIZE ();
10894 specbind (Qinhibit_redisplay, Qt);
10896 GCPRO4 (string, parms, frame, timeout);
10898 CHECK_STRING (string, 0);
10899 f = check_x_frame (frame);
10900 if (NILP (timeout))
10901 timeout = make_number (5);
10902 else
10903 CHECK_NATNUM (timeout, 2);
10905 if (NILP (dx))
10906 dx = make_number (5);
10907 else
10908 CHECK_NUMBER (dx, 5);
10910 if (NILP (dy))
10911 dy = make_number (-10);
10912 else
10913 CHECK_NUMBER (dy, 6);
10915 if (NILP (last_show_tip_args))
10916 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
10918 if (!NILP (tip_frame))
10920 Lisp_Object last_string = AREF (last_show_tip_args, 0);
10921 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
10922 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
10924 if (EQ (frame, last_frame)
10925 && !NILP (Fequal (last_string, string))
10926 && !NILP (Fequal (last_parms, parms)))
10928 struct frame *f = XFRAME (tip_frame);
10930 /* Only DX and DY have changed. */
10931 if (!NILP (tip_timer))
10933 Lisp_Object timer = tip_timer;
10934 tip_timer = Qnil;
10935 call1 (Qcancel_timer, timer);
10938 BLOCK_INPUT;
10939 compute_tip_xy (f, parms, dx, dy, PIXEL_WIDTH (f),
10940 PIXEL_HEIGHT (f), &root_x, &root_y);
10941 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10942 root_x, root_y);
10943 UNBLOCK_INPUT;
10944 goto start_timer;
10948 /* Hide a previous tip, if any. */
10949 Fx_hide_tip ();
10951 ASET (last_show_tip_args, 0, string);
10952 ASET (last_show_tip_args, 1, frame);
10953 ASET (last_show_tip_args, 2, parms);
10955 /* Add default values to frame parameters. */
10956 if (NILP (Fassq (Qname, parms)))
10957 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
10958 if (NILP (Fassq (Qinternal_border_width, parms)))
10959 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
10960 if (NILP (Fassq (Qborder_width, parms)))
10961 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
10962 if (NILP (Fassq (Qborder_color, parms)))
10963 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
10964 if (NILP (Fassq (Qbackground_color, parms)))
10965 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
10966 parms);
10968 /* Create a frame for the tooltip, and record it in the global
10969 variable tip_frame. */
10970 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
10971 f = XFRAME (frame);
10973 /* Set up the frame's root window. Currently we use a size of 80
10974 columns x 40 lines. If someone wants to show a larger tip, he
10975 will loose. I don't think this is a realistic case. */
10976 w = XWINDOW (FRAME_ROOT_WINDOW (f));
10977 w->left = w->top = make_number (0);
10978 w->width = make_number (80);
10979 w->height = make_number (40);
10980 adjust_glyphs (f);
10981 w->pseudo_window_p = 1;
10983 /* Display the tooltip text in a temporary buffer. */
10984 old_buffer = current_buffer;
10985 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
10986 clear_glyph_matrix (w->desired_matrix);
10987 clear_glyph_matrix (w->current_matrix);
10988 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
10989 try_window (FRAME_ROOT_WINDOW (f), pos);
10991 /* Compute width and height of the tooltip. */
10992 width = height = 0;
10993 for (i = 0; i < w->desired_matrix->nrows; ++i)
10995 struct glyph_row *row = &w->desired_matrix->rows[i];
10996 struct glyph *last;
10997 int row_width;
10999 /* Stop at the first empty row at the end. */
11000 if (!row->enabled_p || !row->displays_text_p)
11001 break;
11003 /* Let the row go over the full width of the frame. */
11004 row->full_width_p = 1;
11006 /* There's a glyph at the end of rows that is used to place
11007 the cursor there. Don't include the width of this glyph. */
11008 if (row->used[TEXT_AREA])
11010 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
11011 row_width = row->pixel_width - last->pixel_width;
11013 else
11014 row_width = row->pixel_width;
11016 height += row->height;
11017 width = max (width, row_width);
11020 /* Add the frame's internal border to the width and height the X
11021 window should have. */
11022 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
11023 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
11025 /* Move the tooltip window where the mouse pointer is. Resize and
11026 show it. */
11027 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
11029 BLOCK_INPUT;
11030 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11031 root_x, root_y, width, height);
11032 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11033 UNBLOCK_INPUT;
11035 /* Draw into the window. */
11036 w->must_be_updated_p = 1;
11037 update_single_window (w, 1);
11039 /* Restore original current buffer. */
11040 set_buffer_internal_1 (old_buffer);
11041 windows_or_buffers_changed = old_windows_or_buffers_changed;
11043 start_timer:
11044 /* Let the tip disappear after timeout seconds. */
11045 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
11046 intern ("x-hide-tip"));
11048 UNGCPRO;
11049 return unbind_to (count, Qnil);
11053 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
11054 "Hide the current tooltip window, if there is any.\n\
11055 Value is t is tooltip was open, nil otherwise.")
11058 int count;
11059 Lisp_Object deleted, frame, timer;
11060 struct gcpro gcpro1, gcpro2;
11062 /* Return quickly if nothing to do. */
11063 if (NILP (tip_timer) && NILP (tip_frame))
11064 return Qnil;
11066 frame = tip_frame;
11067 timer = tip_timer;
11068 GCPRO2 (frame, timer);
11069 tip_frame = tip_timer = deleted = Qnil;
11071 count = BINDING_STACK_SIZE ();
11072 specbind (Qinhibit_redisplay, Qt);
11073 specbind (Qinhibit_quit, Qt);
11075 if (!NILP (timer))
11076 call1 (Qcancel_timer, timer);
11078 if (FRAMEP (frame))
11080 Fdelete_frame (frame, Qnil);
11081 deleted = Qt;
11083 #ifdef USE_LUCID
11084 /* Bloodcurdling hack alert: The Lucid menu bar widget's
11085 redisplay procedure is not called when a tip frame over menu
11086 items is unmapped. Redisplay the menu manually... */
11088 struct frame *f = SELECTED_FRAME ();
11089 Widget w = f->output_data.x->menubar_widget;
11090 extern void xlwmenu_redisplay P_ ((Widget));
11092 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
11093 && w != NULL)
11095 BLOCK_INPUT;
11096 xlwmenu_redisplay (w);
11097 UNBLOCK_INPUT;
11100 #endif /* USE_LUCID */
11103 UNGCPRO;
11104 return unbind_to (count, deleted);
11109 /***********************************************************************
11110 File selection dialog
11111 ***********************************************************************/
11113 #ifdef USE_MOTIF
11115 /* Callback for "OK" and "Cancel" on file selection dialog. */
11117 static void
11118 file_dialog_cb (widget, client_data, call_data)
11119 Widget widget;
11120 XtPointer call_data, client_data;
11122 int *result = (int *) client_data;
11123 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
11124 *result = cb->reason;
11128 /* Callback for unmapping a file selection dialog. This is used to
11129 capture the case where a dialog is closed via a window manager's
11130 closer button, for example. Using a XmNdestroyCallback didn't work
11131 in this case. */
11133 static void
11134 file_dialog_unmap_cb (widget, client_data, call_data)
11135 Widget widget;
11136 XtPointer call_data, client_data;
11138 int *result = (int *) client_data;
11139 *result = XmCR_CANCEL;
11143 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0,
11144 "Read file name, prompting with PROMPT in directory DIR.\n\
11145 Use a file selection dialog.\n\
11146 Select DEFAULT-FILENAME in the dialog's file selection box, if\n\
11147 specified. Don't let the user enter a file name in the file\n\
11148 selection dialog's entry field, if MUSTMATCH is non-nil.")
11149 (prompt, dir, default_filename, mustmatch)
11150 Lisp_Object prompt, dir, default_filename, mustmatch;
11152 int result;
11153 struct frame *f = SELECTED_FRAME ();
11154 Lisp_Object file = Qnil;
11155 Widget dialog, text, list, help;
11156 Arg al[10];
11157 int ac = 0;
11158 extern XtAppContext Xt_app_con;
11159 char *title;
11160 XmString dir_xmstring, pattern_xmstring;
11161 int popup_activated_flag;
11162 int count = specpdl_ptr - specpdl;
11163 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
11165 GCPRO5 (prompt, dir, default_filename, mustmatch, file);
11166 CHECK_STRING (prompt, 0);
11167 CHECK_STRING (dir, 1);
11169 /* Prevent redisplay. */
11170 specbind (Qinhibit_redisplay, Qt);
11172 BLOCK_INPUT;
11174 /* Create the dialog with PROMPT as title, using DIR as initial
11175 directory and using "*" as pattern. */
11176 dir = Fexpand_file_name (dir, Qnil);
11177 dir_xmstring = XmStringCreateLocalized (XSTRING (dir)->data);
11178 pattern_xmstring = XmStringCreateLocalized ("*");
11180 XtSetArg (al[ac], XmNtitle, XSTRING (prompt)->data); ++ac;
11181 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
11182 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
11183 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
11184 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
11185 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
11186 "fsb", al, ac);
11187 XmStringFree (dir_xmstring);
11188 XmStringFree (pattern_xmstring);
11190 /* Add callbacks for OK and Cancel. */
11191 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
11192 (XtPointer) &result);
11193 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
11194 (XtPointer) &result);
11195 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
11196 (XtPointer) &result);
11198 /* Disable the help button since we can't display help. */
11199 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
11200 XtSetSensitive (help, False);
11202 /* Mark OK button as default. */
11203 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
11204 XmNshowAsDefault, True, NULL);
11206 /* If MUSTMATCH is non-nil, disable the file entry field of the
11207 dialog, so that the user must select a file from the files list
11208 box. We can't remove it because we wouldn't have a way to get at
11209 the result file name, then. */
11210 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
11211 if (!NILP (mustmatch))
11213 Widget label;
11214 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
11215 XtSetSensitive (text, False);
11216 XtSetSensitive (label, False);
11219 /* Manage the dialog, so that list boxes get filled. */
11220 XtManageChild (dialog);
11222 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
11223 must include the path for this to work. */
11224 list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
11225 if (STRINGP (default_filename))
11227 XmString default_xmstring;
11228 int item_pos;
11230 default_xmstring
11231 = XmStringCreateLocalized (XSTRING (default_filename)->data);
11233 if (!XmListItemExists (list, default_xmstring))
11235 /* Add a new item if DEFAULT_FILENAME is not in the list. */
11236 XmListAddItem (list, default_xmstring, 0);
11237 item_pos = 0;
11239 else
11240 item_pos = XmListItemPos (list, default_xmstring);
11241 XmStringFree (default_xmstring);
11243 /* Select the item and scroll it into view. */
11244 XmListSelectPos (list, item_pos, True);
11245 XmListSetPos (list, item_pos);
11248 /* Process events until the user presses Cancel or OK. */
11249 result = 0;
11250 while (result == 0)
11251 XtAppProcessEvent (Xt_app_con, XtIMAll);
11253 /* Get the result. */
11254 if (result == XmCR_OK)
11256 XmString text;
11257 String data;
11259 XtVaGetValues (dialog, XmNtextString, &text, NULL);
11260 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
11261 XmStringFree (text);
11262 file = build_string (data);
11263 XtFree (data);
11265 else
11266 file = Qnil;
11268 /* Clean up. */
11269 XtUnmanageChild (dialog);
11270 XtDestroyWidget (dialog);
11271 UNBLOCK_INPUT;
11272 UNGCPRO;
11274 /* Make "Cancel" equivalent to C-g. */
11275 if (NILP (file))
11276 Fsignal (Qquit, Qnil);
11278 return unbind_to (count, file);
11281 #endif /* USE_MOTIF */
11285 /***********************************************************************
11286 Keyboard
11287 ***********************************************************************/
11289 #ifdef HAVE_XKBGETKEYBOARD
11290 #include <X11/XKBlib.h>
11291 #include <X11/keysym.h>
11292 #endif
11294 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
11295 Sx_backspace_delete_keys_p, 0, 1, 0,
11296 "Check if both Backspace and Delete keys are on the keyboard of FRAME.\n\
11297 FRAME nil means use the selected frame.\n\
11298 Value is t if we know that both keys are present, and are mapped to the\n\
11299 usual X keysyms.")
11300 (frame)
11301 Lisp_Object frame;
11303 #ifdef HAVE_XKBGETKEYBOARD
11304 XkbDescPtr kb;
11305 struct frame *f = check_x_frame (frame);
11306 Display *dpy = FRAME_X_DISPLAY (f);
11307 Lisp_Object have_keys;
11308 int major, minor, op, event, error;
11310 BLOCK_INPUT;
11312 /* Check library version in case we're dynamically linked. */
11313 major = XkbMajorVersion;
11314 minor = XkbMinorVersion;
11315 if (!XkbLibraryVersion (&major, &minor))
11317 UNBLOCK_INPUT;
11318 return Qnil;
11321 /* Check that the server supports XKB. */
11322 major = XkbMajorVersion;
11323 minor = XkbMinorVersion;
11324 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
11326 UNBLOCK_INPUT;
11327 return Qnil;
11330 have_keys = Qnil;
11331 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
11332 if (kb)
11334 int delete_keycode = 0, backspace_keycode = 0, i;
11336 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
11338 for (i = kb->min_key_code;
11339 (i < kb->max_key_code
11340 && (delete_keycode == 0 || backspace_keycode == 0));
11341 ++i)
11343 /* The XKB symbolic key names can be seen most easily
11344 in the PS file generated by `xkbprint -label name $DISPLAY'. */
11345 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
11346 delete_keycode = i;
11347 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
11348 backspace_keycode = i;
11351 XkbFreeNames (kb, 0, True);
11354 XkbFreeClientMap (kb, 0, True);
11356 if (delete_keycode
11357 && backspace_keycode
11358 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
11359 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
11360 have_keys = Qt;
11362 UNBLOCK_INPUT;
11363 return have_keys;
11364 #else /* not HAVE_XKBGETKEYBOARD */
11365 return Qnil;
11366 #endif /* not HAVE_XKBGETKEYBOARD */
11371 /***********************************************************************
11372 Initialization
11373 ***********************************************************************/
11375 void
11376 syms_of_xfns ()
11378 /* This is zero if not using X windows. */
11379 x_in_use = 0;
11381 /* The section below is built by the lisp expression at the top of the file,
11382 just above where these variables are declared. */
11383 /*&&& init symbols here &&&*/
11384 Qauto_raise = intern ("auto-raise");
11385 staticpro (&Qauto_raise);
11386 Qauto_lower = intern ("auto-lower");
11387 staticpro (&Qauto_lower);
11388 Qbar = intern ("bar");
11389 staticpro (&Qbar);
11390 Qborder_color = intern ("border-color");
11391 staticpro (&Qborder_color);
11392 Qborder_width = intern ("border-width");
11393 staticpro (&Qborder_width);
11394 Qbox = intern ("box");
11395 staticpro (&Qbox);
11396 Qcursor_color = intern ("cursor-color");
11397 staticpro (&Qcursor_color);
11398 Qcursor_type = intern ("cursor-type");
11399 staticpro (&Qcursor_type);
11400 Qgeometry = intern ("geometry");
11401 staticpro (&Qgeometry);
11402 Qicon_left = intern ("icon-left");
11403 staticpro (&Qicon_left);
11404 Qicon_top = intern ("icon-top");
11405 staticpro (&Qicon_top);
11406 Qicon_type = intern ("icon-type");
11407 staticpro (&Qicon_type);
11408 Qicon_name = intern ("icon-name");
11409 staticpro (&Qicon_name);
11410 Qinternal_border_width = intern ("internal-border-width");
11411 staticpro (&Qinternal_border_width);
11412 Qleft = intern ("left");
11413 staticpro (&Qleft);
11414 Qright = intern ("right");
11415 staticpro (&Qright);
11416 Qmouse_color = intern ("mouse-color");
11417 staticpro (&Qmouse_color);
11418 Qnone = intern ("none");
11419 staticpro (&Qnone);
11420 Qparent_id = intern ("parent-id");
11421 staticpro (&Qparent_id);
11422 Qscroll_bar_width = intern ("scroll-bar-width");
11423 staticpro (&Qscroll_bar_width);
11424 Qsuppress_icon = intern ("suppress-icon");
11425 staticpro (&Qsuppress_icon);
11426 Qundefined_color = intern ("undefined-color");
11427 staticpro (&Qundefined_color);
11428 Qvertical_scroll_bars = intern ("vertical-scroll-bars");
11429 staticpro (&Qvertical_scroll_bars);
11430 Qvisibility = intern ("visibility");
11431 staticpro (&Qvisibility);
11432 Qwindow_id = intern ("window-id");
11433 staticpro (&Qwindow_id);
11434 Qouter_window_id = intern ("outer-window-id");
11435 staticpro (&Qouter_window_id);
11436 Qx_frame_parameter = intern ("x-frame-parameter");
11437 staticpro (&Qx_frame_parameter);
11438 Qx_resource_name = intern ("x-resource-name");
11439 staticpro (&Qx_resource_name);
11440 Quser_position = intern ("user-position");
11441 staticpro (&Quser_position);
11442 Quser_size = intern ("user-size");
11443 staticpro (&Quser_size);
11444 Qscroll_bar_foreground = intern ("scroll-bar-foreground");
11445 staticpro (&Qscroll_bar_foreground);
11446 Qscroll_bar_background = intern ("scroll-bar-background");
11447 staticpro (&Qscroll_bar_background);
11448 Qscreen_gamma = intern ("screen-gamma");
11449 staticpro (&Qscreen_gamma);
11450 Qline_spacing = intern ("line-spacing");
11451 staticpro (&Qline_spacing);
11452 Qcenter = intern ("center");
11453 staticpro (&Qcenter);
11454 Qcompound_text = intern ("compound-text");
11455 staticpro (&Qcompound_text);
11456 Qcancel_timer = intern ("cancel-timer");
11457 staticpro (&Qcancel_timer);
11458 Qwait_for_wm = intern ("wait-for-wm");
11459 staticpro (&Qwait_for_wm);
11460 /* This is the end of symbol initialization. */
11462 /* Text property `display' should be nonsticky by default. */
11463 Vtext_property_default_nonsticky
11464 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
11467 Qlaplace = intern ("laplace");
11468 staticpro (&Qlaplace);
11469 Qemboss = intern ("emboss");
11470 staticpro (&Qemboss);
11471 Qedge_detection = intern ("edge-detection");
11472 staticpro (&Qedge_detection);
11473 Qheuristic = intern ("heuristic");
11474 staticpro (&Qheuristic);
11475 QCmatrix = intern (":matrix");
11476 staticpro (&QCmatrix);
11477 QCcolor_adjustment = intern (":color-adjustment");
11478 staticpro (&QCcolor_adjustment);
11479 QCmask = intern (":mask");
11480 staticpro (&QCmask);
11482 Qface_set_after_frame_default = intern ("face-set-after-frame-default");
11483 staticpro (&Qface_set_after_frame_default);
11485 Fput (Qundefined_color, Qerror_conditions,
11486 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
11487 Fput (Qundefined_color, Qerror_message,
11488 build_string ("Undefined color"));
11490 init_x_parm_symbols ();
11492 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
11493 "Non-nil means always draw a cross over disabled images.\n\
11494 Disabled images are those having an `:conversion disabled' property.\n\
11495 A cross is always drawn on black & white displays.");
11496 cross_disabled_images = 0;
11498 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
11499 "List of directories to search for bitmap files for X.");
11500 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
11502 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
11503 "The shape of the pointer when over text.\n\
11504 Changing the value does not affect existing frames\n\
11505 unless you set the mouse color.");
11506 Vx_pointer_shape = Qnil;
11508 DEFVAR_LISP ("x-resource-name", &Vx_resource_name,
11509 "The name Emacs uses to look up X resources.\n\
11510 `x-get-resource' uses this as the first component of the instance name\n\
11511 when requesting resource values.\n\
11512 Emacs initially sets `x-resource-name' to the name under which Emacs\n\
11513 was invoked, or to the value specified with the `-name' or `-rn'\n\
11514 switches, if present.\n\
11516 It may be useful to bind this variable locally around a call\n\
11517 to `x-get-resource'. See also the variable `x-resource-class'.");
11518 Vx_resource_name = Qnil;
11520 DEFVAR_LISP ("x-resource-class", &Vx_resource_class,
11521 "The class Emacs uses to look up X resources.\n\
11522 `x-get-resource' uses this as the first component of the instance class\n\
11523 when requesting resource values.\n\
11524 Emacs initially sets `x-resource-class' to \"Emacs\".\n\
11526 Setting this variable permanently is not a reasonable thing to do,\n\
11527 but binding this variable locally around a call to `x-get-resource'\n\
11528 is a reasonable practice. See also the variable `x-resource-name'.");
11529 Vx_resource_class = build_string (EMACS_CLASS);
11531 #if 0 /* This doesn't really do anything. */
11532 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
11533 "The shape of the pointer when not over text.\n\
11534 This variable takes effect when you create a new frame\n\
11535 or when you set the mouse color.");
11536 #endif
11537 Vx_nontext_pointer_shape = Qnil;
11539 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
11540 "The shape of the pointer when Emacs is busy.\n\
11541 This variable takes effect when you create a new frame\n\
11542 or when you set the mouse color.");
11543 Vx_hourglass_pointer_shape = Qnil;
11545 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
11546 "Non-zero means Emacs displays an hourglass pointer on window systems.");
11547 display_hourglass_p = 1;
11549 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
11550 "*Seconds to wait before displaying an hourglass pointer.\n\
11551 Value must be an integer or float.");
11552 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
11554 #if 0 /* This doesn't really do anything. */
11555 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
11556 "The shape of the pointer when over the mode line.\n\
11557 This variable takes effect when you create a new frame\n\
11558 or when you set the mouse color.");
11559 #endif
11560 Vx_mode_pointer_shape = Qnil;
11562 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
11563 &Vx_sensitive_text_pointer_shape,
11564 "The shape of the pointer when over mouse-sensitive text.\n\
11565 This variable takes effect when you create a new frame\n\
11566 or when you set the mouse color.");
11567 Vx_sensitive_text_pointer_shape = Qnil;
11569 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
11570 &Vx_window_horizontal_drag_shape,
11571 "Pointer shape to use for indicating a window can be dragged horizontally.\n\
11572 This variable takes effect when you create a new frame\n\
11573 or when you set the mouse color.");
11574 Vx_window_horizontal_drag_shape = Qnil;
11576 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
11577 "A string indicating the foreground color of the cursor box.");
11578 Vx_cursor_fore_pixel = Qnil;
11580 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
11581 "Non-nil if no X window manager is in use.\n\
11582 Emacs doesn't try to figure this out; this is always nil\n\
11583 unless you set it to something else.");
11584 /* We don't have any way to find this out, so set it to nil
11585 and maybe the user would like to set it to t. */
11586 Vx_no_window_manager = Qnil;
11588 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
11589 &Vx_pixel_size_width_font_regexp,
11590 "Regexp matching a font name whose width is the same as `PIXEL_SIZE'.\n\
11592 Since Emacs gets width of a font matching with this regexp from\n\
11593 PIXEL_SIZE field of the name, font finding mechanism gets faster for\n\
11594 such a font. This is especially effective for such large fonts as\n\
11595 Chinese, Japanese, and Korean.");
11596 Vx_pixel_size_width_font_regexp = Qnil;
11598 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
11599 "Time after which cached images are removed from the cache.\n\
11600 When an image has not been displayed this many seconds, remove it\n\
11601 from the image cache. Value must be an integer or nil with nil\n\
11602 meaning don't clear the cache.");
11603 Vimage_cache_eviction_delay = make_number (30 * 60);
11605 #ifdef USE_X_TOOLKIT
11606 Fprovide (intern ("x-toolkit"));
11608 #ifdef USE_MOTIF
11609 Fprovide (intern ("motif"));
11611 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string,
11612 "Version info for LessTif/Motif.");
11613 Vmotif_version_string = build_string (XmVERSION_STRING);
11614 #endif /* USE_MOTIF */
11615 #endif /* USE_X_TOOLKIT */
11617 defsubr (&Sx_get_resource);
11619 /* X window properties. */
11620 defsubr (&Sx_change_window_property);
11621 defsubr (&Sx_delete_window_property);
11622 defsubr (&Sx_window_property);
11624 defsubr (&Sxw_display_color_p);
11625 defsubr (&Sx_display_grayscale_p);
11626 defsubr (&Sxw_color_defined_p);
11627 defsubr (&Sxw_color_values);
11628 defsubr (&Sx_server_max_request_size);
11629 defsubr (&Sx_server_vendor);
11630 defsubr (&Sx_server_version);
11631 defsubr (&Sx_display_pixel_width);
11632 defsubr (&Sx_display_pixel_height);
11633 defsubr (&Sx_display_mm_width);
11634 defsubr (&Sx_display_mm_height);
11635 defsubr (&Sx_display_screens);
11636 defsubr (&Sx_display_planes);
11637 defsubr (&Sx_display_color_cells);
11638 defsubr (&Sx_display_visual_class);
11639 defsubr (&Sx_display_backing_store);
11640 defsubr (&Sx_display_save_under);
11641 defsubr (&Sx_parse_geometry);
11642 defsubr (&Sx_create_frame);
11643 defsubr (&Sx_open_connection);
11644 defsubr (&Sx_close_connection);
11645 defsubr (&Sx_display_list);
11646 defsubr (&Sx_synchronize);
11647 defsubr (&Sx_focus_frame);
11648 defsubr (&Sx_backspace_delete_keys_p);
11650 /* Setting callback functions for fontset handler. */
11651 get_font_info_func = x_get_font_info;
11653 #if 0 /* This function pointer doesn't seem to be used anywhere.
11654 And the pointer assigned has the wrong type, anyway. */
11655 list_fonts_func = x_list_fonts;
11656 #endif
11658 load_font_func = x_load_font;
11659 find_ccl_program_func = x_find_ccl_program;
11660 query_font_func = x_query_font;
11661 set_frame_fontset_func = x_set_font;
11662 check_window_system_func = check_x;
11664 /* Images. */
11665 Qxbm = intern ("xbm");
11666 staticpro (&Qxbm);
11667 QCtype = intern (":type");
11668 staticpro (&QCtype);
11669 QCconversion = intern (":conversion");
11670 staticpro (&QCconversion);
11671 QCheuristic_mask = intern (":heuristic-mask");
11672 staticpro (&QCheuristic_mask);
11673 QCcolor_symbols = intern (":color-symbols");
11674 staticpro (&QCcolor_symbols);
11675 QCascent = intern (":ascent");
11676 staticpro (&QCascent);
11677 QCmargin = intern (":margin");
11678 staticpro (&QCmargin);
11679 QCrelief = intern (":relief");
11680 staticpro (&QCrelief);
11681 Qpostscript = intern ("postscript");
11682 staticpro (&Qpostscript);
11683 QCloader = intern (":loader");
11684 staticpro (&QCloader);
11685 QCbounding_box = intern (":bounding-box");
11686 staticpro (&QCbounding_box);
11687 QCpt_width = intern (":pt-width");
11688 staticpro (&QCpt_width);
11689 QCpt_height = intern (":pt-height");
11690 staticpro (&QCpt_height);
11691 QCindex = intern (":index");
11692 staticpro (&QCindex);
11693 Qpbm = intern ("pbm");
11694 staticpro (&Qpbm);
11696 #if HAVE_XPM
11697 Qxpm = intern ("xpm");
11698 staticpro (&Qxpm);
11699 #endif
11701 #if HAVE_JPEG
11702 Qjpeg = intern ("jpeg");
11703 staticpro (&Qjpeg);
11704 #endif
11706 #if HAVE_TIFF
11707 Qtiff = intern ("tiff");
11708 staticpro (&Qtiff);
11709 #endif
11711 #if HAVE_GIF
11712 Qgif = intern ("gif");
11713 staticpro (&Qgif);
11714 #endif
11716 #if HAVE_PNG
11717 Qpng = intern ("png");
11718 staticpro (&Qpng);
11719 #endif
11721 defsubr (&Sclear_image_cache);
11722 defsubr (&Simage_size);
11723 defsubr (&Simage_mask_p);
11725 hourglass_atimer = NULL;
11726 hourglass_shown_p = 0;
11728 defsubr (&Sx_show_tip);
11729 defsubr (&Sx_hide_tip);
11730 tip_timer = Qnil;
11731 staticpro (&tip_timer);
11732 tip_frame = Qnil;
11733 staticpro (&tip_frame);
11735 last_show_tip_args = Qnil;
11736 staticpro (&last_show_tip_args);
11738 #ifdef USE_MOTIF
11739 defsubr (&Sx_file_dialog);
11740 #endif
11744 void
11745 init_xfns ()
11747 image_types = NULL;
11748 Vimage_types = Qnil;
11750 define_image_type (&xbm_type);
11751 define_image_type (&gs_type);
11752 define_image_type (&pbm_type);
11754 #if HAVE_XPM
11755 define_image_type (&xpm_type);
11756 #endif
11758 #if HAVE_JPEG
11759 define_image_type (&jpeg_type);
11760 #endif
11762 #if HAVE_TIFF
11763 define_image_type (&tiff_type);
11764 #endif
11766 #if HAVE_GIF
11767 define_image_type (&gif_type);
11768 #endif
11770 #if HAVE_PNG
11771 define_image_type (&png_type);
11772 #endif
11775 #endif /* HAVE_X_WINDOWS */