(vc-rcs-registered): Handle the autoload cookie so that the definition
[emacs.git] / src / xfns.c
blob1af4921e1c6564f5a77135cd0eb57747e32e510b
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 #ifdef HAVE_UNISTD_H
28 #include <unistd.h>
29 #endif
31 /* This makes the fields of a Display accessible, in Xlib header files. */
33 #define XLIB_ILLEGAL_ACCESS
35 #include "lisp.h"
36 #include "xterm.h"
37 #include "frame.h"
38 #include "window.h"
39 #include "buffer.h"
40 #include "intervals.h"
41 #include "dispextern.h"
42 #include "keyboard.h"
43 #include "blockinput.h"
44 #include <epaths.h>
45 #include "charset.h"
46 #include "coding.h"
47 #include "fontset.h"
48 #include "systime.h"
49 #include "termhooks.h"
50 #include "atimer.h"
52 #ifdef HAVE_X_WINDOWS
54 #include <ctype.h>
55 #include <sys/types.h>
56 #include <sys/stat.h>
58 #ifndef VMS
59 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
60 #include "bitmaps/gray.xbm"
61 #else
62 #include <X11/bitmaps/gray>
63 #endif
64 #else
65 #include "[.bitmaps]gray.xbm"
66 #endif
68 #ifdef USE_X_TOOLKIT
69 #include <X11/Shell.h>
71 #ifndef USE_MOTIF
72 #include <X11/Xaw/Paned.h>
73 #include <X11/Xaw/Label.h>
74 #endif /* USE_MOTIF */
76 #ifdef USG
77 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
78 #include <X11/Xos.h>
79 #define USG
80 #else
81 #include <X11/Xos.h>
82 #endif
84 #include "widget.h"
86 #include "../lwlib/lwlib.h"
88 #ifdef USE_MOTIF
89 #include <Xm/Xm.h>
90 #include <Xm/DialogS.h>
91 #include <Xm/FileSB.h>
92 #endif
94 /* Do the EDITRES protocol if running X11R5
95 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
97 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
98 #define HACK_EDITRES
99 extern void _XEditResCheckMessages ();
100 #endif /* R5 + Athena */
102 /* Unique id counter for widgets created by the Lucid Widget Library. */
104 extern LWLIB_ID widget_id_tick;
106 #ifdef USE_LUCID
107 /* This is part of a kludge--see lwlib/xlwmenu.c. */
108 extern XFontStruct *xlwmenu_default_font;
109 #endif
111 extern void free_frame_menubar ();
112 extern double atof ();
114 #ifdef USE_MOTIF
116 /* LessTif/Motif version info. */
118 static Lisp_Object Vmotif_version_string;
120 #endif /* USE_MOTIF */
122 #endif /* USE_X_TOOLKIT */
124 #ifdef HAVE_X11R4
125 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
126 #else
127 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
128 #endif
130 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
131 it, and including `bitmaps/gray' more than once is a problem when
132 config.h defines `static' as an empty replacement string. */
134 int gray_bitmap_width = gray_width;
135 int gray_bitmap_height = gray_height;
136 char *gray_bitmap_bits = gray_bits;
138 /* The name we're using in resource queries. Most often "emacs". */
140 Lisp_Object Vx_resource_name;
142 /* The application class we're using in resource queries.
143 Normally "Emacs". */
145 Lisp_Object Vx_resource_class;
147 /* Non-zero means we're allowed to display an hourglass cursor. */
149 int display_hourglass_p;
151 /* The background and shape of the mouse pointer, and shape when not
152 over text or in the modeline. */
154 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
155 Lisp_Object Vx_hourglass_pointer_shape;
157 /* The shape when over mouse-sensitive text. */
159 Lisp_Object Vx_sensitive_text_pointer_shape;
161 /* If non-nil, the pointer shape to indicate that windows can be
162 dragged horizontally. */
164 Lisp_Object Vx_window_horizontal_drag_shape;
166 /* Color of chars displayed in cursor box. */
168 Lisp_Object Vx_cursor_fore_pixel;
170 /* Nonzero if using X. */
172 static int x_in_use;
174 /* Non nil if no window manager is in use. */
176 Lisp_Object Vx_no_window_manager;
178 /* Search path for bitmap files. */
180 Lisp_Object Vx_bitmap_file_path;
182 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
184 Lisp_Object Vx_pixel_size_width_font_regexp;
186 Lisp_Object Qauto_raise;
187 Lisp_Object Qauto_lower;
188 Lisp_Object Qborder_color;
189 Lisp_Object Qborder_width;
190 extern 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;
221 Lisp_Object Qfullscreen;
222 Lisp_Object Qfullwidth;
223 Lisp_Object Qfullheight;
224 Lisp_Object Qfullboth;
226 /* The below are defined in frame.c. */
228 extern Lisp_Object Qheight, Qminibuffer, Qname, Qonly, Qwidth;
229 extern Lisp_Object Qunsplittable, Qmenu_bar_lines, Qbuffer_predicate, Qtitle;
230 extern Lisp_Object Qtool_bar_lines;
232 extern Lisp_Object Vwindow_system_version;
234 Lisp_Object Qface_set_after_frame_default;
236 #if GLYPH_DEBUG
237 int image_cache_refcount, dpyinfo_refcount;
238 #endif
242 /* Error if we are not connected to X. */
244 void
245 check_x ()
247 if (! x_in_use)
248 error ("X windows are not in use or not initialized");
251 /* Nonzero if we can use mouse menus.
252 You should not call this unless HAVE_MENUS is defined. */
255 have_menus_p ()
257 return x_in_use;
260 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
261 and checking validity for X. */
263 FRAME_PTR
264 check_x_frame (frame)
265 Lisp_Object frame;
267 FRAME_PTR f;
269 if (NILP (frame))
270 frame = selected_frame;
271 CHECK_LIVE_FRAME (frame);
272 f = XFRAME (frame);
273 if (! FRAME_X_P (f))
274 error ("Non-X frame used");
275 return f;
278 /* Let the user specify an X display with a frame.
279 nil stands for the selected frame--or, if that is not an X frame,
280 the first X display on the list. */
282 static struct x_display_info *
283 check_x_display_info (frame)
284 Lisp_Object frame;
286 struct x_display_info *dpyinfo = NULL;
288 if (NILP (frame))
290 struct frame *sf = XFRAME (selected_frame);
292 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
293 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
294 else if (x_display_list != 0)
295 dpyinfo = x_display_list;
296 else
297 error ("X windows are not in use or not initialized");
299 else if (STRINGP (frame))
300 dpyinfo = x_display_info_for_name (frame);
301 else
303 FRAME_PTR f = check_x_frame (frame);
304 dpyinfo = FRAME_X_DISPLAY_INFO (f);
307 return dpyinfo;
311 /* Return the Emacs frame-object corresponding to an X window.
312 It could be the frame's main window or an icon window. */
314 /* This function can be called during GC, so use GC_xxx type test macros. */
316 struct frame *
317 x_window_to_frame (dpyinfo, wdesc)
318 struct x_display_info *dpyinfo;
319 int wdesc;
321 Lisp_Object tail, frame;
322 struct frame *f;
324 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
326 frame = XCAR (tail);
327 if (!GC_FRAMEP (frame))
328 continue;
329 f = XFRAME (frame);
330 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
331 continue;
332 if (f->output_data.x->hourglass_window == wdesc)
333 return f;
334 #ifdef USE_X_TOOLKIT
335 if ((f->output_data.x->edit_widget
336 && XtWindow (f->output_data.x->edit_widget) == wdesc)
337 /* A tooltip frame? */
338 || (!f->output_data.x->edit_widget
339 && FRAME_X_WINDOW (f) == wdesc)
340 || f->output_data.x->icon_desc == wdesc)
341 return f;
342 #else /* not USE_X_TOOLKIT */
343 if (FRAME_X_WINDOW (f) == wdesc
344 || f->output_data.x->icon_desc == wdesc)
345 return f;
346 #endif /* not USE_X_TOOLKIT */
348 return 0;
351 #ifdef USE_X_TOOLKIT
352 /* Like x_window_to_frame but also compares the window with the widget's
353 windows. */
355 struct frame *
356 x_any_window_to_frame (dpyinfo, wdesc)
357 struct x_display_info *dpyinfo;
358 int wdesc;
360 Lisp_Object tail, frame;
361 struct frame *f, *found;
362 struct x_output *x;
364 found = NULL;
365 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
367 frame = XCAR (tail);
368 if (!GC_FRAMEP (frame))
369 continue;
371 f = XFRAME (frame);
372 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
374 /* This frame matches if the window is any of its widgets. */
375 x = f->output_data.x;
376 if (x->hourglass_window == wdesc)
377 found = f;
378 else if (x->widget)
380 if (wdesc == XtWindow (x->widget)
381 || wdesc == XtWindow (x->column_widget)
382 || wdesc == XtWindow (x->edit_widget))
383 found = f;
384 /* Match if the window is this frame's menubar. */
385 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
386 found = f;
388 else if (FRAME_X_WINDOW (f) == wdesc)
389 /* A tooltip frame. */
390 found = f;
394 return found;
397 /* Likewise, but exclude the menu bar widget. */
399 struct frame *
400 x_non_menubar_window_to_frame (dpyinfo, wdesc)
401 struct x_display_info *dpyinfo;
402 int wdesc;
404 Lisp_Object tail, frame;
405 struct frame *f;
406 struct x_output *x;
408 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
410 frame = XCAR (tail);
411 if (!GC_FRAMEP (frame))
412 continue;
413 f = XFRAME (frame);
414 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
415 continue;
416 x = f->output_data.x;
417 /* This frame matches if the window is any of its widgets. */
418 if (x->hourglass_window == wdesc)
419 return f;
420 else if (x->widget)
422 if (wdesc == XtWindow (x->widget)
423 || wdesc == XtWindow (x->column_widget)
424 || wdesc == XtWindow (x->edit_widget))
425 return f;
427 else if (FRAME_X_WINDOW (f) == wdesc)
428 /* A tooltip frame. */
429 return f;
431 return 0;
434 /* Likewise, but consider only the menu bar widget. */
436 struct frame *
437 x_menubar_window_to_frame (dpyinfo, wdesc)
438 struct x_display_info *dpyinfo;
439 int wdesc;
441 Lisp_Object tail, frame;
442 struct frame *f;
443 struct x_output *x;
445 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
447 frame = XCAR (tail);
448 if (!GC_FRAMEP (frame))
449 continue;
450 f = XFRAME (frame);
451 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
452 continue;
453 x = f->output_data.x;
454 /* Match if the window is this frame's menubar. */
455 if (x->menubar_widget
456 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
457 return f;
459 return 0;
462 /* Return the frame whose principal (outermost) window is WDESC.
463 If WDESC is some other (smaller) window, we return 0. */
465 struct frame *
466 x_top_window_to_frame (dpyinfo, wdesc)
467 struct x_display_info *dpyinfo;
468 int wdesc;
470 Lisp_Object tail, frame;
471 struct frame *f;
472 struct x_output *x;
474 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
476 frame = XCAR (tail);
477 if (!GC_FRAMEP (frame))
478 continue;
479 f = XFRAME (frame);
480 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
481 continue;
482 x = f->output_data.x;
484 if (x->widget)
486 /* This frame matches if the window is its topmost widget. */
487 if (wdesc == XtWindow (x->widget))
488 return f;
489 #if 0 /* I don't know why it did this,
490 but it seems logically wrong,
491 and it causes trouble for MapNotify events. */
492 /* Match if the window is this frame's menubar. */
493 if (x->menubar_widget
494 && wdesc == XtWindow (x->menubar_widget))
495 return f;
496 #endif
498 else if (FRAME_X_WINDOW (f) == wdesc)
499 /* Tooltip frame. */
500 return f;
502 return 0;
504 #endif /* USE_X_TOOLKIT */
508 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
509 id, which is just an int that this section returns. Bitmaps are
510 reference counted so they can be shared among frames.
512 Bitmap indices are guaranteed to be > 0, so a negative number can
513 be used to indicate no bitmap.
515 If you use x_create_bitmap_from_data, then you must keep track of
516 the bitmaps yourself. That is, creating a bitmap from the same
517 data more than once will not be caught. */
520 /* Functions to access the contents of a bitmap, given an id. */
523 x_bitmap_height (f, id)
524 FRAME_PTR f;
525 int id;
527 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
531 x_bitmap_width (f, id)
532 FRAME_PTR f;
533 int id;
535 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
539 x_bitmap_pixmap (f, id)
540 FRAME_PTR f;
541 int id;
543 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
547 /* Allocate a new bitmap record. Returns index of new record. */
549 static int
550 x_allocate_bitmap_record (f)
551 FRAME_PTR f;
553 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
554 int i;
556 if (dpyinfo->bitmaps == NULL)
558 dpyinfo->bitmaps_size = 10;
559 dpyinfo->bitmaps
560 = (struct x_bitmap_record *) xmalloc (dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
561 dpyinfo->bitmaps_last = 1;
562 return 1;
565 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
566 return ++dpyinfo->bitmaps_last;
568 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
569 if (dpyinfo->bitmaps[i].refcount == 0)
570 return i + 1;
572 dpyinfo->bitmaps_size *= 2;
573 dpyinfo->bitmaps
574 = (struct x_bitmap_record *) xrealloc (dpyinfo->bitmaps,
575 dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
576 return ++dpyinfo->bitmaps_last;
579 /* Add one reference to the reference count of the bitmap with id ID. */
581 void
582 x_reference_bitmap (f, id)
583 FRAME_PTR f;
584 int id;
586 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
589 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
592 x_create_bitmap_from_data (f, bits, width, height)
593 struct frame *f;
594 char *bits;
595 unsigned int width, height;
597 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
598 Pixmap bitmap;
599 int id;
601 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
602 bits, width, height);
604 if (! bitmap)
605 return -1;
607 id = x_allocate_bitmap_record (f);
608 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
609 dpyinfo->bitmaps[id - 1].file = NULL;
610 dpyinfo->bitmaps[id - 1].refcount = 1;
611 dpyinfo->bitmaps[id - 1].depth = 1;
612 dpyinfo->bitmaps[id - 1].height = height;
613 dpyinfo->bitmaps[id - 1].width = width;
615 return id;
618 /* Create bitmap from file FILE for frame F. */
621 x_create_bitmap_from_file (f, file)
622 struct frame *f;
623 Lisp_Object file;
625 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
626 unsigned int width, height;
627 Pixmap bitmap;
628 int xhot, yhot, result, id;
629 Lisp_Object found;
630 int fd;
631 char *filename;
633 /* Look for an existing bitmap with the same name. */
634 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
636 if (dpyinfo->bitmaps[id].refcount
637 && dpyinfo->bitmaps[id].file
638 && !strcmp (dpyinfo->bitmaps[id].file, (char *) SDATA (file)))
640 ++dpyinfo->bitmaps[id].refcount;
641 return id + 1;
645 /* Search bitmap-file-path for the file, if appropriate. */
646 fd = openp (Vx_bitmap_file_path, file, Qnil, &found, Qnil);
647 if (fd < 0)
648 return -1;
649 emacs_close (fd);
651 filename = (char *) SDATA (found);
653 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
654 filename, &width, &height, &bitmap, &xhot, &yhot);
655 if (result != BitmapSuccess)
656 return -1;
658 id = x_allocate_bitmap_record (f);
659 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
660 dpyinfo->bitmaps[id - 1].refcount = 1;
661 dpyinfo->bitmaps[id - 1].file
662 = (char *) xmalloc (SBYTES (file) + 1);
663 dpyinfo->bitmaps[id - 1].depth = 1;
664 dpyinfo->bitmaps[id - 1].height = height;
665 dpyinfo->bitmaps[id - 1].width = width;
666 strcpy (dpyinfo->bitmaps[id - 1].file, SDATA (file));
668 return id;
671 /* Remove reference to bitmap with id number ID. */
673 void
674 x_destroy_bitmap (f, id)
675 FRAME_PTR f;
676 int id;
678 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
680 if (id > 0)
682 --dpyinfo->bitmaps[id - 1].refcount;
683 if (dpyinfo->bitmaps[id - 1].refcount == 0)
685 BLOCK_INPUT;
686 XFreePixmap (FRAME_X_DISPLAY (f), dpyinfo->bitmaps[id - 1].pixmap);
687 if (dpyinfo->bitmaps[id - 1].file)
689 xfree (dpyinfo->bitmaps[id - 1].file);
690 dpyinfo->bitmaps[id - 1].file = NULL;
692 UNBLOCK_INPUT;
697 /* Free all the bitmaps for the display specified by DPYINFO. */
699 static void
700 x_destroy_all_bitmaps (dpyinfo)
701 struct x_display_info *dpyinfo;
703 int i;
704 for (i = 0; i < dpyinfo->bitmaps_last; i++)
705 if (dpyinfo->bitmaps[i].refcount > 0)
707 XFreePixmap (dpyinfo->display, dpyinfo->bitmaps[i].pixmap);
708 if (dpyinfo->bitmaps[i].file)
709 xfree (dpyinfo->bitmaps[i].file);
711 dpyinfo->bitmaps_last = 0;
714 /* Connect the frame-parameter names for X frames
715 to the ways of passing the parameter values to the window system.
717 The name of a parameter, as a Lisp symbol,
718 has an `x-frame-parameter' property which is an integer in Lisp
719 that is an index in this table. */
721 struct x_frame_parm_table
723 char *name;
724 void (*setter) P_ ((struct frame *, Lisp_Object, Lisp_Object));
727 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
728 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
729 static void x_change_window_heights P_ ((Lisp_Object, int));
730 static void x_disable_image P_ ((struct frame *, struct image *));
731 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
732 static void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
733 static void x_set_wait_for_wm P_ ((struct frame *, Lisp_Object, Lisp_Object));
734 static void x_set_fullscreen P_ ((struct frame *, Lisp_Object, Lisp_Object));
735 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
736 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
737 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
738 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
739 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
740 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
741 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
742 static void x_set_fringe_width 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 {"left-fringe", x_set_fringe_width},
806 {"right-fringe", x_set_fringe_width},
807 {"wait-for-wm", x_set_wait_for_wm},
808 {"fullscreen", x_set_fullscreen},
812 /* Attach the `x-frame-parameter' properties to
813 the Lisp symbol names of parameters relevant to X. */
815 void
816 init_x_parm_symbols ()
818 int i;
820 for (i = 0; i < sizeof (x_frame_parms) / sizeof (x_frame_parms[0]); i++)
821 Fput (intern (x_frame_parms[i].name), Qx_frame_parameter,
822 make_number (i));
826 /* Really try to move where we want to be in case of fullscreen. Some WMs
827 moves the window where we tell them. Some (mwm, twm) moves the outer
828 window manager window there instead.
829 Try to compensate for those WM here. */
830 static void
831 x_fullscreen_move (f, new_top, new_left)
832 struct frame *f;
833 int new_top;
834 int new_left;
836 if (new_top != f->output_data.x->top_pos
837 || new_left != f->output_data.x->left_pos)
839 int move_x = new_left + f->output_data.x->x_pixels_outer_diff;
840 int move_y = new_top + f->output_data.x->y_pixels_outer_diff;
842 f->output_data.x->want_fullscreen |= FULLSCREEN_MOVE_WAIT;
843 x_set_offset (f, move_x, move_y, 1);
847 /* Change the parameters of frame F as specified by ALIST.
848 If a parameter is not specially recognized, do nothing special;
849 otherwise call the `x_set_...' function for that parameter.
850 Except for certain geometry properties, always call store_frame_param
851 to store the new value in the parameter alist. */
853 void
854 x_set_frame_parameters (f, alist)
855 FRAME_PTR f;
856 Lisp_Object alist;
858 Lisp_Object tail;
860 /* If both of these parameters are present, it's more efficient to
861 set them both at once. So we wait until we've looked at the
862 entire list before we set them. */
863 int width, height;
865 /* Same here. */
866 Lisp_Object left, top;
868 /* Same with these. */
869 Lisp_Object icon_left, icon_top;
871 /* Record in these vectors all the parms specified. */
872 Lisp_Object *parms;
873 Lisp_Object *values;
874 int i, p;
875 int left_no_change = 0, top_no_change = 0;
876 int icon_left_no_change = 0, icon_top_no_change = 0;
877 int fullscreen_is_being_set = 0;
879 struct gcpro gcpro1, gcpro2;
881 i = 0;
882 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
883 i++;
885 parms = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
886 values = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
888 /* Extract parm names and values into those vectors. */
890 i = 0;
891 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
893 Lisp_Object elt;
895 elt = Fcar (tail);
896 parms[i] = Fcar (elt);
897 values[i] = Fcdr (elt);
898 i++;
900 /* TAIL and ALIST are not used again below here. */
901 alist = tail = Qnil;
903 GCPRO2 (*parms, *values);
904 gcpro1.nvars = i;
905 gcpro2.nvars = i;
907 /* There is no need to gcpro LEFT, TOP, ICON_LEFT, or ICON_TOP,
908 because their values appear in VALUES and strings are not valid. */
909 top = left = Qunbound;
910 icon_left = icon_top = Qunbound;
912 /* Provide default values for HEIGHT and WIDTH. */
913 if (FRAME_NEW_WIDTH (f))
914 width = FRAME_NEW_WIDTH (f);
915 else
916 width = FRAME_WIDTH (f);
918 if (FRAME_NEW_HEIGHT (f))
919 height = FRAME_NEW_HEIGHT (f);
920 else
921 height = FRAME_HEIGHT (f);
923 /* Process foreground_color and background_color before anything else.
924 They are independent of other properties, but other properties (e.g.,
925 cursor_color) are dependent upon them. */
926 /* Process default font as well, since fringe widths depends on it. */
927 /* Also, process fullscreen, width and height depend upon that */
928 for (p = 0; p < i; p++)
930 Lisp_Object prop, val;
932 prop = parms[p];
933 val = values[p];
934 if (EQ (prop, Qforeground_color)
935 || EQ (prop, Qbackground_color)
936 || EQ (prop, Qfont)
937 || EQ (prop, Qfullscreen))
939 register Lisp_Object param_index, old_value;
941 old_value = get_frame_param (f, prop);
942 fullscreen_is_being_set |= EQ (prop, Qfullscreen);
944 if (NILP (Fequal (val, old_value)))
946 store_frame_param (f, prop, val);
948 param_index = Fget (prop, Qx_frame_parameter);
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);
957 /* Now process them in reverse of specified order. */
958 for (i--; i >= 0; i--)
960 Lisp_Object prop, val;
962 prop = parms[i];
963 val = values[i];
965 if (EQ (prop, Qwidth) && NUMBERP (val))
966 width = XFASTINT (val);
967 else if (EQ (prop, Qheight) && NUMBERP (val))
968 height = XFASTINT (val);
969 else if (EQ (prop, Qtop))
970 top = val;
971 else if (EQ (prop, Qleft))
972 left = val;
973 else if (EQ (prop, Qicon_top))
974 icon_top = val;
975 else if (EQ (prop, Qicon_left))
976 icon_left = val;
977 else if (EQ (prop, Qforeground_color)
978 || EQ (prop, Qbackground_color)
979 || EQ (prop, Qfont)
980 || EQ (prop, Qfullscreen))
981 /* Processed above. */
982 continue;
983 else
985 register Lisp_Object param_index, old_value;
987 old_value = get_frame_param (f, prop);
989 store_frame_param (f, prop, val);
991 param_index = Fget (prop, Qx_frame_parameter);
992 if (NATNUMP (param_index)
993 && (XFASTINT (param_index)
994 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
995 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
999 /* Don't die if just one of these was set. */
1000 if (EQ (left, Qunbound))
1002 left_no_change = 1;
1003 if (f->output_data.x->left_pos < 0)
1004 left = Fcons (Qplus, Fcons (make_number (f->output_data.x->left_pos), Qnil));
1005 else
1006 XSETINT (left, f->output_data.x->left_pos);
1008 if (EQ (top, Qunbound))
1010 top_no_change = 1;
1011 if (f->output_data.x->top_pos < 0)
1012 top = Fcons (Qplus, Fcons (make_number (f->output_data.x->top_pos), Qnil));
1013 else
1014 XSETINT (top, f->output_data.x->top_pos);
1017 /* If one of the icon positions was not set, preserve or default it. */
1018 if (EQ (icon_left, Qunbound) || ! INTEGERP (icon_left))
1020 icon_left_no_change = 1;
1021 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
1022 if (NILP (icon_left))
1023 XSETINT (icon_left, 0);
1025 if (EQ (icon_top, Qunbound) || ! INTEGERP (icon_top))
1027 icon_top_no_change = 1;
1028 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
1029 if (NILP (icon_top))
1030 XSETINT (icon_top, 0);
1033 if (FRAME_VISIBLE_P (f) && fullscreen_is_being_set)
1035 /* If the frame is visible already and the fullscreen parameter is
1036 being set, it is too late to set WM manager hints to specify
1037 size and position.
1038 Here we first get the width, height and position that applies to
1039 fullscreen. We then move the frame to the appropriate
1040 position. Resize of the frame is taken care of in the code after
1041 this if-statement. */
1042 int new_left, new_top;
1044 x_fullscreen_adjust (f, &width, &height, &new_top, &new_left);
1045 x_fullscreen_move (f, new_top, new_left);
1048 /* Don't set these parameters unless they've been explicitly
1049 specified. The window might be mapped or resized while we're in
1050 this function, and we don't want to override that unless the lisp
1051 code has asked for it.
1053 Don't set these parameters unless they actually differ from the
1054 window's current parameters; the window may not actually exist
1055 yet. */
1057 Lisp_Object frame;
1059 check_frame_size (f, &height, &width);
1061 XSETFRAME (frame, f);
1063 if (width != FRAME_WIDTH (f)
1064 || height != FRAME_HEIGHT (f)
1065 || FRAME_NEW_HEIGHT (f) || FRAME_NEW_WIDTH (f))
1066 Fset_frame_size (frame, make_number (width), make_number (height));
1068 if ((!NILP (left) || !NILP (top))
1069 && ! (left_no_change && top_no_change)
1070 && ! (NUMBERP (left) && XINT (left) == f->output_data.x->left_pos
1071 && NUMBERP (top) && XINT (top) == f->output_data.x->top_pos))
1073 int leftpos = 0;
1074 int toppos = 0;
1076 /* Record the signs. */
1077 f->output_data.x->size_hint_flags &= ~ (XNegative | YNegative);
1078 if (EQ (left, Qminus))
1079 f->output_data.x->size_hint_flags |= XNegative;
1080 else if (INTEGERP (left))
1082 leftpos = XINT (left);
1083 if (leftpos < 0)
1084 f->output_data.x->size_hint_flags |= XNegative;
1086 else if (CONSP (left) && EQ (XCAR (left), Qminus)
1087 && CONSP (XCDR (left))
1088 && INTEGERP (XCAR (XCDR (left))))
1090 leftpos = - XINT (XCAR (XCDR (left)));
1091 f->output_data.x->size_hint_flags |= XNegative;
1093 else if (CONSP (left) && EQ (XCAR (left), Qplus)
1094 && CONSP (XCDR (left))
1095 && INTEGERP (XCAR (XCDR (left))))
1097 leftpos = XINT (XCAR (XCDR (left)));
1100 if (EQ (top, Qminus))
1101 f->output_data.x->size_hint_flags |= YNegative;
1102 else if (INTEGERP (top))
1104 toppos = XINT (top);
1105 if (toppos < 0)
1106 f->output_data.x->size_hint_flags |= YNegative;
1108 else if (CONSP (top) && EQ (XCAR (top), Qminus)
1109 && CONSP (XCDR (top))
1110 && INTEGERP (XCAR (XCDR (top))))
1112 toppos = - XINT (XCAR (XCDR (top)));
1113 f->output_data.x->size_hint_flags |= YNegative;
1115 else if (CONSP (top) && EQ (XCAR (top), Qplus)
1116 && CONSP (XCDR (top))
1117 && INTEGERP (XCAR (XCDR (top))))
1119 toppos = XINT (XCAR (XCDR (top)));
1123 /* Store the numeric value of the position. */
1124 f->output_data.x->top_pos = toppos;
1125 f->output_data.x->left_pos = leftpos;
1127 f->output_data.x->win_gravity = NorthWestGravity;
1129 /* Actually set that position, and convert to absolute. */
1130 x_set_offset (f, leftpos, toppos, -1);
1133 if ((!NILP (icon_left) || !NILP (icon_top))
1134 && ! (icon_left_no_change && icon_top_no_change))
1135 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
1138 UNGCPRO;
1141 /* Store the screen positions of frame F into XPTR and YPTR.
1142 These are the positions of the containing window manager window,
1143 not Emacs's own window. */
1145 void
1146 x_real_positions (f, xptr, yptr)
1147 FRAME_PTR f;
1148 int *xptr, *yptr;
1150 int win_x, win_y, outer_x, outer_y;
1151 int real_x = 0, real_y = 0;
1152 int had_errors = 0;
1153 Window win = f->output_data.x->parent_desc;
1155 int count;
1157 BLOCK_INPUT;
1159 count = x_catch_errors (FRAME_X_DISPLAY (f));
1161 if (win == FRAME_X_DISPLAY_INFO (f)->root_window)
1162 win = FRAME_OUTER_WINDOW (f);
1164 /* This loop traverses up the containment tree until we hit the root
1165 window. Window managers may intersect many windows between our window
1166 and the root window. The window we find just before the root window
1167 should be the outer WM window. */
1168 for (;;)
1170 Window wm_window, rootw;
1171 Window *tmp_children;
1172 unsigned int tmp_nchildren;
1173 int success;
1175 success = XQueryTree (FRAME_X_DISPLAY (f), win, &rootw,
1176 &wm_window, &tmp_children, &tmp_nchildren);
1178 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
1180 /* Don't free tmp_children if XQueryTree failed. */
1181 if (! success)
1182 break;
1184 XFree ((char *) tmp_children);
1186 if (wm_window == rootw || had_errors)
1187 break;
1189 win = wm_window;
1192 if (! had_errors)
1194 int ign;
1195 Window child, rootw;
1197 /* Get the real coordinates for the WM window upper left corner */
1198 XGetGeometry (FRAME_X_DISPLAY (f), win,
1199 &rootw, &real_x, &real_y, &ign, &ign, &ign, &ign);
1201 /* Translate real coordinates to coordinates relative to our
1202 window. For our window, the upper left corner is 0, 0.
1203 Since the upper left corner of the WM window is outside
1204 our window, win_x and win_y will be negative:
1206 ------------------ ---> x
1207 | title |
1208 | ----------------- v y
1209 | | our window
1211 XTranslateCoordinates (FRAME_X_DISPLAY (f),
1213 /* From-window, to-window. */
1214 FRAME_X_DISPLAY_INFO (f)->root_window,
1215 FRAME_X_WINDOW (f),
1217 /* From-position, to-position. */
1218 real_x, real_y, &win_x, &win_y,
1220 /* Child of win. */
1221 &child);
1223 if (FRAME_X_WINDOW (f) == FRAME_OUTER_WINDOW (f))
1225 outer_x = win_x;
1226 outer_y = win_y;
1228 else
1230 XTranslateCoordinates (FRAME_X_DISPLAY (f),
1232 /* From-window, to-window. */
1233 FRAME_X_DISPLAY_INFO (f)->root_window,
1234 FRAME_OUTER_WINDOW (f),
1236 /* From-position, to-position. */
1237 real_x, real_y, &outer_x, &outer_y,
1239 /* Child of win. */
1240 &child);
1243 had_errors = x_had_errors_p (FRAME_X_DISPLAY (f));
1246 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1248 UNBLOCK_INPUT;
1250 if (had_errors) return;
1252 f->output_data.x->x_pixels_diff = -win_x;
1253 f->output_data.x->y_pixels_diff = -win_y;
1254 f->output_data.x->x_pixels_outer_diff = -outer_x;
1255 f->output_data.x->y_pixels_outer_diff = -outer_y;
1257 *xptr = real_x;
1258 *yptr = real_y;
1261 /* Insert a description of internally-recorded parameters of frame X
1262 into the parameter alist *ALISTPTR that is to be given to the user.
1263 Only parameters that are specific to the X window system
1264 and whose values are not correctly recorded in the frame's
1265 param_alist need to be considered here. */
1267 void
1268 x_report_frame_params (f, alistptr)
1269 struct frame *f;
1270 Lisp_Object *alistptr;
1272 char buf[16];
1273 Lisp_Object tem;
1275 /* Represent negative positions (off the top or left screen edge)
1276 in a way that Fmodify_frame_parameters will understand correctly. */
1277 XSETINT (tem, f->output_data.x->left_pos);
1278 if (f->output_data.x->left_pos >= 0)
1279 store_in_alist (alistptr, Qleft, tem);
1280 else
1281 store_in_alist (alistptr, Qleft, Fcons (Qplus, Fcons (tem, Qnil)));
1283 XSETINT (tem, f->output_data.x->top_pos);
1284 if (f->output_data.x->top_pos >= 0)
1285 store_in_alist (alistptr, Qtop, tem);
1286 else
1287 store_in_alist (alistptr, Qtop, Fcons (Qplus, Fcons (tem, Qnil)));
1289 store_in_alist (alistptr, Qborder_width,
1290 make_number (f->output_data.x->border_width));
1291 store_in_alist (alistptr, Qinternal_border_width,
1292 make_number (f->output_data.x->internal_border_width));
1293 store_in_alist (alistptr, Qleft_fringe,
1294 make_number (f->output_data.x->left_fringe_width));
1295 store_in_alist (alistptr, Qright_fringe,
1296 make_number (f->output_data.x->right_fringe_width));
1297 store_in_alist (alistptr, Qscroll_bar_width,
1298 (! FRAME_HAS_VERTICAL_SCROLL_BARS (f)
1299 ? make_number (0)
1300 : FRAME_SCROLL_BAR_PIXEL_WIDTH (f) > 0
1301 ? make_number (FRAME_SCROLL_BAR_PIXEL_WIDTH (f))
1302 /* nil means "use default width"
1303 for non-toolkit scroll bar.
1304 ruler-mode.el depends on this. */
1305 : Qnil));
1306 sprintf (buf, "%ld", (long) FRAME_X_WINDOW (f));
1307 store_in_alist (alistptr, Qwindow_id,
1308 build_string (buf));
1309 #ifdef USE_X_TOOLKIT
1310 /* Tooltip frame may not have this widget. */
1311 if (f->output_data.x->widget)
1312 #endif
1313 sprintf (buf, "%ld", (long) FRAME_OUTER_WINDOW (f));
1314 store_in_alist (alistptr, Qouter_window_id,
1315 build_string (buf));
1316 store_in_alist (alistptr, Qicon_name, f->icon_name);
1317 FRAME_SAMPLE_VISIBILITY (f);
1318 store_in_alist (alistptr, Qvisibility,
1319 (FRAME_VISIBLE_P (f) ? Qt
1320 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
1321 store_in_alist (alistptr, Qdisplay,
1322 XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element));
1324 if (f->output_data.x->parent_desc == FRAME_X_DISPLAY_INFO (f)->root_window)
1325 tem = Qnil;
1326 else
1327 XSETFASTINT (tem, f->output_data.x->parent_desc);
1328 store_in_alist (alistptr, Qparent_id, tem);
1333 /* Gamma-correct COLOR on frame F. */
1335 void
1336 gamma_correct (f, color)
1337 struct frame *f;
1338 XColor *color;
1340 if (f->gamma)
1342 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
1343 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
1344 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
1349 /* Decide if color named COLOR_NAME is valid for use on frame F. If
1350 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
1351 allocate the color. Value is zero if COLOR_NAME is invalid, or
1352 no color could be allocated. */
1355 x_defined_color (f, color_name, color, alloc_p)
1356 struct frame *f;
1357 char *color_name;
1358 XColor *color;
1359 int alloc_p;
1361 int success_p;
1362 Display *dpy = FRAME_X_DISPLAY (f);
1363 Colormap cmap = FRAME_X_COLORMAP (f);
1365 BLOCK_INPUT;
1366 success_p = XParseColor (dpy, cmap, color_name, color);
1367 if (success_p && alloc_p)
1368 success_p = x_alloc_nearest_color (f, cmap, color);
1369 UNBLOCK_INPUT;
1371 return success_p;
1375 /* Return the pixel color value for color COLOR_NAME on frame F. If F
1376 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
1377 Signal an error if color can't be allocated. */
1380 x_decode_color (f, color_name, mono_color)
1381 FRAME_PTR f;
1382 Lisp_Object color_name;
1383 int mono_color;
1385 XColor cdef;
1387 CHECK_STRING (color_name);
1389 #if 0 /* Don't do this. It's wrong when we're not using the default
1390 colormap, it makes freeing difficult, and it's probably not
1391 an important optimization. */
1392 if (strcmp (SDATA (color_name), "black") == 0)
1393 return BLACK_PIX_DEFAULT (f);
1394 else if (strcmp (SDATA (color_name), "white") == 0)
1395 return WHITE_PIX_DEFAULT (f);
1396 #endif
1398 /* Return MONO_COLOR for monochrome frames. */
1399 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
1400 return mono_color;
1402 /* x_defined_color is responsible for coping with failures
1403 by looking for a near-miss. */
1404 if (x_defined_color (f, SDATA (color_name), &cdef, 1))
1405 return cdef.pixel;
1407 Fsignal (Qerror, Fcons (build_string ("Undefined color"),
1408 Fcons (color_name, Qnil)));
1409 return 0;
1414 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
1415 the previous value of that parameter, NEW_VALUE is the new value. */
1417 static void
1418 x_set_line_spacing (f, new_value, old_value)
1419 struct frame *f;
1420 Lisp_Object new_value, old_value;
1422 if (NILP (new_value))
1423 f->extra_line_spacing = 0;
1424 else if (NATNUMP (new_value))
1425 f->extra_line_spacing = XFASTINT (new_value);
1426 else
1427 Fsignal (Qerror, Fcons (build_string ("Invalid line-spacing"),
1428 Fcons (new_value, Qnil)));
1429 if (FRAME_VISIBLE_P (f))
1430 redraw_frame (f);
1434 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
1435 the previous value of that parameter, NEW_VALUE is the new value.
1436 See also the comment of wait_for_wm in struct x_output. */
1438 static void
1439 x_set_wait_for_wm (f, new_value, old_value)
1440 struct frame *f;
1441 Lisp_Object new_value, old_value;
1443 f->output_data.x->wait_for_wm = !NILP (new_value);
1447 /* Change the `fullscreen' frame parameter of frame F. OLD_VALUE is
1448 the previous value of that parameter, NEW_VALUE is the new value. */
1450 static void
1451 x_set_fullscreen (f, new_value, old_value)
1452 struct frame *f;
1453 Lisp_Object new_value, old_value;
1455 if (NILP (new_value))
1456 f->output_data.x->want_fullscreen = FULLSCREEN_NONE;
1457 else if (EQ (new_value, Qfullboth))
1458 f->output_data.x->want_fullscreen = FULLSCREEN_BOTH;
1459 else if (EQ (new_value, Qfullwidth))
1460 f->output_data.x->want_fullscreen = FULLSCREEN_WIDTH;
1461 else if (EQ (new_value, Qfullheight))
1462 f->output_data.x->want_fullscreen = FULLSCREEN_HEIGHT;
1466 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
1467 the previous value of that parameter, NEW_VALUE is the new
1468 value. */
1470 static void
1471 x_set_screen_gamma (f, new_value, old_value)
1472 struct frame *f;
1473 Lisp_Object new_value, old_value;
1475 if (NILP (new_value))
1476 f->gamma = 0;
1477 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
1478 /* The value 0.4545 is the normal viewing gamma. */
1479 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
1480 else
1481 Fsignal (Qerror, Fcons (build_string ("Invalid screen-gamma"),
1482 Fcons (new_value, Qnil)));
1484 clear_face_cache (0);
1488 /* Functions called only from `x_set_frame_param'
1489 to set individual parameters.
1491 If FRAME_X_WINDOW (f) is 0,
1492 the frame is being created and its X-window does not exist yet.
1493 In that case, just record the parameter's new value
1494 in the standard place; do not attempt to change the window. */
1496 void
1497 x_set_foreground_color (f, arg, oldval)
1498 struct frame *f;
1499 Lisp_Object arg, oldval;
1501 struct x_output *x = f->output_data.x;
1502 unsigned long fg, old_fg;
1504 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1505 old_fg = x->foreground_pixel;
1506 x->foreground_pixel = fg;
1508 if (FRAME_X_WINDOW (f) != 0)
1510 Display *dpy = FRAME_X_DISPLAY (f);
1512 BLOCK_INPUT;
1513 XSetForeground (dpy, x->normal_gc, fg);
1514 XSetBackground (dpy, x->reverse_gc, fg);
1516 if (x->cursor_pixel == old_fg)
1518 unload_color (f, x->cursor_pixel);
1519 x->cursor_pixel = x_copy_color (f, fg);
1520 XSetBackground (dpy, x->cursor_gc, x->cursor_pixel);
1523 UNBLOCK_INPUT;
1525 update_face_from_frame_parameter (f, Qforeground_color, arg);
1527 if (FRAME_VISIBLE_P (f))
1528 redraw_frame (f);
1531 unload_color (f, old_fg);
1534 void
1535 x_set_background_color (f, arg, oldval)
1536 struct frame *f;
1537 Lisp_Object arg, oldval;
1539 struct x_output *x = f->output_data.x;
1540 unsigned long bg;
1542 bg = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1543 unload_color (f, x->background_pixel);
1544 x->background_pixel = bg;
1546 if (FRAME_X_WINDOW (f) != 0)
1548 Display *dpy = FRAME_X_DISPLAY (f);
1550 BLOCK_INPUT;
1551 XSetBackground (dpy, x->normal_gc, bg);
1552 XSetForeground (dpy, x->reverse_gc, bg);
1553 XSetWindowBackground (dpy, FRAME_X_WINDOW (f), bg);
1554 XSetForeground (dpy, x->cursor_gc, bg);
1556 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
1557 toolkit scroll bars. */
1559 Lisp_Object bar;
1560 for (bar = FRAME_SCROLL_BARS (f);
1561 !NILP (bar);
1562 bar = XSCROLL_BAR (bar)->next)
1564 Window window = SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar));
1565 XSetWindowBackground (dpy, window, bg);
1568 #endif /* USE_TOOLKIT_SCROLL_BARS */
1570 UNBLOCK_INPUT;
1571 update_face_from_frame_parameter (f, Qbackground_color, arg);
1573 if (FRAME_VISIBLE_P (f))
1574 redraw_frame (f);
1578 void
1579 x_set_mouse_color (f, arg, oldval)
1580 struct frame *f;
1581 Lisp_Object arg, oldval;
1583 struct x_output *x = f->output_data.x;
1584 Display *dpy = FRAME_X_DISPLAY (f);
1585 Cursor cursor, nontext_cursor, mode_cursor, cross_cursor;
1586 Cursor hourglass_cursor, horizontal_drag_cursor;
1587 int count;
1588 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1589 unsigned long mask_color = x->background_pixel;
1591 /* Don't let pointers be invisible. */
1592 if (mask_color == pixel)
1594 x_free_colors (f, &pixel, 1);
1595 pixel = x_copy_color (f, x->foreground_pixel);
1598 unload_color (f, x->mouse_pixel);
1599 x->mouse_pixel = pixel;
1601 BLOCK_INPUT;
1603 /* It's not okay to crash if the user selects a screwy cursor. */
1604 count = x_catch_errors (dpy);
1606 if (!NILP (Vx_pointer_shape))
1608 CHECK_NUMBER (Vx_pointer_shape);
1609 cursor = XCreateFontCursor (dpy, XINT (Vx_pointer_shape));
1611 else
1612 cursor = XCreateFontCursor (dpy, XC_xterm);
1613 x_check_errors (dpy, "bad text pointer cursor: %s");
1615 if (!NILP (Vx_nontext_pointer_shape))
1617 CHECK_NUMBER (Vx_nontext_pointer_shape);
1618 nontext_cursor
1619 = XCreateFontCursor (dpy, XINT (Vx_nontext_pointer_shape));
1621 else
1622 nontext_cursor = XCreateFontCursor (dpy, XC_left_ptr);
1623 x_check_errors (dpy, "bad nontext pointer cursor: %s");
1625 if (!NILP (Vx_hourglass_pointer_shape))
1627 CHECK_NUMBER (Vx_hourglass_pointer_shape);
1628 hourglass_cursor
1629 = XCreateFontCursor (dpy, XINT (Vx_hourglass_pointer_shape));
1631 else
1632 hourglass_cursor = XCreateFontCursor (dpy, XC_watch);
1633 x_check_errors (dpy, "bad hourglass pointer cursor: %s");
1635 x_check_errors (dpy, "bad nontext pointer cursor: %s");
1636 if (!NILP (Vx_mode_pointer_shape))
1638 CHECK_NUMBER (Vx_mode_pointer_shape);
1639 mode_cursor = XCreateFontCursor (dpy, XINT (Vx_mode_pointer_shape));
1641 else
1642 mode_cursor = XCreateFontCursor (dpy, XC_xterm);
1643 x_check_errors (dpy, "bad modeline pointer cursor: %s");
1645 if (!NILP (Vx_sensitive_text_pointer_shape))
1647 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1648 cross_cursor
1649 = XCreateFontCursor (dpy, XINT (Vx_sensitive_text_pointer_shape));
1651 else
1652 cross_cursor = XCreateFontCursor (dpy, XC_hand2);
1654 if (!NILP (Vx_window_horizontal_drag_shape))
1656 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1657 horizontal_drag_cursor
1658 = XCreateFontCursor (dpy, XINT (Vx_window_horizontal_drag_shape));
1660 else
1661 horizontal_drag_cursor
1662 = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
1664 /* Check and report errors with the above calls. */
1665 x_check_errors (dpy, "can't set cursor shape: %s");
1666 x_uncatch_errors (dpy, count);
1669 XColor fore_color, back_color;
1671 fore_color.pixel = x->mouse_pixel;
1672 x_query_color (f, &fore_color);
1673 back_color.pixel = mask_color;
1674 x_query_color (f, &back_color);
1676 XRecolorCursor (dpy, cursor, &fore_color, &back_color);
1677 XRecolorCursor (dpy, nontext_cursor, &fore_color, &back_color);
1678 XRecolorCursor (dpy, mode_cursor, &fore_color, &back_color);
1679 XRecolorCursor (dpy, cross_cursor, &fore_color, &back_color);
1680 XRecolorCursor (dpy, hourglass_cursor, &fore_color, &back_color);
1681 XRecolorCursor (dpy, horizontal_drag_cursor, &fore_color, &back_color);
1684 if (FRAME_X_WINDOW (f) != 0)
1685 XDefineCursor (dpy, FRAME_X_WINDOW (f), cursor);
1687 if (cursor != x->text_cursor
1688 && x->text_cursor != 0)
1689 XFreeCursor (dpy, x->text_cursor);
1690 x->text_cursor = cursor;
1692 if (nontext_cursor != x->nontext_cursor
1693 && x->nontext_cursor != 0)
1694 XFreeCursor (dpy, x->nontext_cursor);
1695 x->nontext_cursor = nontext_cursor;
1697 if (hourglass_cursor != x->hourglass_cursor
1698 && x->hourglass_cursor != 0)
1699 XFreeCursor (dpy, x->hourglass_cursor);
1700 x->hourglass_cursor = hourglass_cursor;
1702 if (mode_cursor != x->modeline_cursor
1703 && x->modeline_cursor != 0)
1704 XFreeCursor (dpy, f->output_data.x->modeline_cursor);
1705 x->modeline_cursor = mode_cursor;
1707 if (cross_cursor != x->cross_cursor
1708 && x->cross_cursor != 0)
1709 XFreeCursor (dpy, x->cross_cursor);
1710 x->cross_cursor = cross_cursor;
1712 if (horizontal_drag_cursor != x->horizontal_drag_cursor
1713 && x->horizontal_drag_cursor != 0)
1714 XFreeCursor (dpy, x->horizontal_drag_cursor);
1715 x->horizontal_drag_cursor = horizontal_drag_cursor;
1717 XFlush (dpy);
1718 UNBLOCK_INPUT;
1720 update_face_from_frame_parameter (f, Qmouse_color, arg);
1723 void
1724 x_set_cursor_color (f, arg, oldval)
1725 struct frame *f;
1726 Lisp_Object arg, oldval;
1728 unsigned long fore_pixel, pixel;
1729 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1730 struct x_output *x = f->output_data.x;
1732 if (!NILP (Vx_cursor_fore_pixel))
1734 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1735 WHITE_PIX_DEFAULT (f));
1736 fore_pixel_allocated_p = 1;
1738 else
1739 fore_pixel = x->background_pixel;
1741 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1742 pixel_allocated_p = 1;
1744 /* Make sure that the cursor color differs from the background color. */
1745 if (pixel == x->background_pixel)
1747 if (pixel_allocated_p)
1749 x_free_colors (f, &pixel, 1);
1750 pixel_allocated_p = 0;
1753 pixel = x->mouse_pixel;
1754 if (pixel == fore_pixel)
1756 if (fore_pixel_allocated_p)
1758 x_free_colors (f, &fore_pixel, 1);
1759 fore_pixel_allocated_p = 0;
1761 fore_pixel = x->background_pixel;
1765 unload_color (f, x->cursor_foreground_pixel);
1766 if (!fore_pixel_allocated_p)
1767 fore_pixel = x_copy_color (f, fore_pixel);
1768 x->cursor_foreground_pixel = fore_pixel;
1770 unload_color (f, x->cursor_pixel);
1771 if (!pixel_allocated_p)
1772 pixel = x_copy_color (f, pixel);
1773 x->cursor_pixel = pixel;
1775 if (FRAME_X_WINDOW (f) != 0)
1777 BLOCK_INPUT;
1778 XSetBackground (FRAME_X_DISPLAY (f), x->cursor_gc, x->cursor_pixel);
1779 XSetForeground (FRAME_X_DISPLAY (f), x->cursor_gc, fore_pixel);
1780 UNBLOCK_INPUT;
1782 if (FRAME_VISIBLE_P (f))
1784 x_update_cursor (f, 0);
1785 x_update_cursor (f, 1);
1789 update_face_from_frame_parameter (f, Qcursor_color, arg);
1792 /* Set the border-color of frame F to value described by ARG.
1793 ARG can be a string naming a color.
1794 The border-color is used for the border that is drawn by the X server.
1795 Note that this does not fully take effect if done before
1796 F has an x-window; it must be redone when the window is created.
1798 Note: this is done in two routines because of the way X10 works.
1800 Note: under X11, this is normally the province of the window manager,
1801 and so emacs' border colors may be overridden. */
1803 void
1804 x_set_border_color (f, arg, oldval)
1805 struct frame *f;
1806 Lisp_Object arg, oldval;
1808 int pix;
1810 CHECK_STRING (arg);
1811 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1812 x_set_border_pixel (f, pix);
1813 update_face_from_frame_parameter (f, Qborder_color, arg);
1816 /* Set the border-color of frame F to pixel value PIX.
1817 Note that this does not fully take effect if done before
1818 F has an x-window. */
1820 void
1821 x_set_border_pixel (f, pix)
1822 struct frame *f;
1823 int pix;
1825 unload_color (f, f->output_data.x->border_pixel);
1826 f->output_data.x->border_pixel = pix;
1828 if (FRAME_X_WINDOW (f) != 0 && f->output_data.x->border_width > 0)
1830 BLOCK_INPUT;
1831 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1832 (unsigned long)pix);
1833 UNBLOCK_INPUT;
1835 if (FRAME_VISIBLE_P (f))
1836 redraw_frame (f);
1842 void
1843 x_set_cursor_type (f, arg, oldval)
1844 FRAME_PTR f;
1845 Lisp_Object arg, oldval;
1847 set_frame_cursor_types (f, arg);
1849 /* Make sure the cursor gets redrawn. */
1850 cursor_type_changed = 1;
1853 void
1854 x_set_icon_type (f, arg, oldval)
1855 struct frame *f;
1856 Lisp_Object arg, oldval;
1858 int result;
1860 if (STRINGP (arg))
1862 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1863 return;
1865 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1866 return;
1868 BLOCK_INPUT;
1869 if (NILP (arg))
1870 result = x_text_icon (f,
1871 (char *) SDATA ((!NILP (f->icon_name)
1872 ? f->icon_name
1873 : f->name)));
1874 else
1875 result = x_bitmap_icon (f, arg);
1877 if (result)
1879 UNBLOCK_INPUT;
1880 error ("No icon window available");
1883 XFlush (FRAME_X_DISPLAY (f));
1884 UNBLOCK_INPUT;
1887 /* Return non-nil if frame F wants a bitmap icon. */
1889 Lisp_Object
1890 x_icon_type (f)
1891 FRAME_PTR f;
1893 Lisp_Object tem;
1895 tem = assq_no_quit (Qicon_type, f->param_alist);
1896 if (CONSP (tem))
1897 return XCDR (tem);
1898 else
1899 return Qnil;
1902 void
1903 x_set_icon_name (f, arg, oldval)
1904 struct frame *f;
1905 Lisp_Object arg, oldval;
1907 int result;
1909 if (STRINGP (arg))
1911 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1912 return;
1914 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1915 return;
1917 f->icon_name = arg;
1919 if (f->output_data.x->icon_bitmap != 0)
1920 return;
1922 BLOCK_INPUT;
1924 result = x_text_icon (f,
1925 (char *) SDATA ((!NILP (f->icon_name)
1926 ? f->icon_name
1927 : !NILP (f->title)
1928 ? f->title
1929 : f->name)));
1931 if (result)
1933 UNBLOCK_INPUT;
1934 error ("No icon window available");
1937 XFlush (FRAME_X_DISPLAY (f));
1938 UNBLOCK_INPUT;
1941 void
1942 x_set_font (f, arg, oldval)
1943 struct frame *f;
1944 Lisp_Object arg, oldval;
1946 Lisp_Object result;
1947 Lisp_Object fontset_name;
1948 Lisp_Object frame;
1949 int old_fontset = f->output_data.x->fontset;
1951 CHECK_STRING (arg);
1953 fontset_name = Fquery_fontset (arg, Qnil);
1955 BLOCK_INPUT;
1956 result = (STRINGP (fontset_name)
1957 ? x_new_fontset (f, SDATA (fontset_name))
1958 : x_new_font (f, SDATA (arg)));
1959 UNBLOCK_INPUT;
1961 if (EQ (result, Qnil))
1962 error ("Font `%s' is not defined", SDATA (arg));
1963 else if (EQ (result, Qt))
1964 error ("The characters of the given font have varying widths");
1965 else if (STRINGP (result))
1967 if (STRINGP (fontset_name))
1969 /* Fontset names are built from ASCII font names, so the
1970 names may be equal despite there was a change. */
1971 if (old_fontset == f->output_data.x->fontset)
1972 return;
1974 else if (!NILP (Fequal (result, oldval)))
1975 return;
1977 store_frame_param (f, Qfont, result);
1978 recompute_basic_faces (f);
1980 else
1981 abort ();
1983 do_pending_window_change (0);
1985 /* Don't call `face-set-after-frame-default' when faces haven't been
1986 initialized yet. This is the case when called from
1987 Fx_create_frame. In that case, the X widget or window doesn't
1988 exist either, and we can end up in x_report_frame_params with a
1989 null widget which gives a segfault. */
1990 if (FRAME_FACE_CACHE (f))
1992 XSETFRAME (frame, f);
1993 call1 (Qface_set_after_frame_default, frame);
1997 static void
1998 x_set_fringe_width (f, new_value, old_value)
1999 struct frame *f;
2000 Lisp_Object new_value, old_value;
2002 x_compute_fringe_widths (f, 1);
2005 void
2006 x_set_border_width (f, arg, oldval)
2007 struct frame *f;
2008 Lisp_Object arg, oldval;
2010 CHECK_NUMBER (arg);
2012 if (XINT (arg) == f->output_data.x->border_width)
2013 return;
2015 if (FRAME_X_WINDOW (f) != 0)
2016 error ("Cannot change the border width of a window");
2018 f->output_data.x->border_width = XINT (arg);
2021 void
2022 x_set_internal_border_width (f, arg, oldval)
2023 struct frame *f;
2024 Lisp_Object arg, oldval;
2026 int old = f->output_data.x->internal_border_width;
2028 CHECK_NUMBER (arg);
2029 f->output_data.x->internal_border_width = XINT (arg);
2030 if (f->output_data.x->internal_border_width < 0)
2031 f->output_data.x->internal_border_width = 0;
2033 #ifdef USE_X_TOOLKIT
2034 if (f->output_data.x->edit_widget)
2035 widget_store_internal_border (f->output_data.x->edit_widget);
2036 #endif
2038 if (f->output_data.x->internal_border_width == old)
2039 return;
2041 if (FRAME_X_WINDOW (f) != 0)
2043 x_set_window_size (f, 0, f->width, f->height);
2044 SET_FRAME_GARBAGED (f);
2045 do_pending_window_change (0);
2047 else
2048 SET_FRAME_GARBAGED (f);
2051 void
2052 x_set_visibility (f, value, oldval)
2053 struct frame *f;
2054 Lisp_Object value, oldval;
2056 Lisp_Object frame;
2057 XSETFRAME (frame, f);
2059 if (NILP (value))
2060 Fmake_frame_invisible (frame, Qt);
2061 else if (EQ (value, Qicon))
2062 Ficonify_frame (frame);
2063 else
2064 Fmake_frame_visible (frame);
2068 /* Change window heights in windows rooted in WINDOW by N lines. */
2070 static void
2071 x_change_window_heights (window, n)
2072 Lisp_Object window;
2073 int n;
2075 struct window *w = XWINDOW (window);
2077 XSETFASTINT (w->top, XFASTINT (w->top) + n);
2078 XSETFASTINT (w->height, XFASTINT (w->height) - n);
2080 if (INTEGERP (w->orig_top))
2081 XSETFASTINT (w->orig_top, XFASTINT (w->orig_top) + n);
2082 if (INTEGERP (w->orig_height))
2083 XSETFASTINT (w->orig_height, XFASTINT (w->orig_height) - n);
2085 /* Handle just the top child in a vertical split. */
2086 if (!NILP (w->vchild))
2087 x_change_window_heights (w->vchild, n);
2089 /* Adjust all children in a horizontal split. */
2090 for (window = w->hchild; !NILP (window); window = w->next)
2092 w = XWINDOW (window);
2093 x_change_window_heights (window, n);
2097 void
2098 x_set_menu_bar_lines (f, value, oldval)
2099 struct frame *f;
2100 Lisp_Object value, oldval;
2102 int nlines;
2103 #ifndef USE_X_TOOLKIT
2104 int olines = FRAME_MENU_BAR_LINES (f);
2105 #endif
2107 /* Right now, menu bars don't work properly in minibuf-only frames;
2108 most of the commands try to apply themselves to the minibuffer
2109 frame itself, and get an error because you can't switch buffers
2110 in or split the minibuffer window. */
2111 if (FRAME_MINIBUF_ONLY_P (f))
2112 return;
2114 if (INTEGERP (value))
2115 nlines = XINT (value);
2116 else
2117 nlines = 0;
2119 /* Make sure we redisplay all windows in this frame. */
2120 windows_or_buffers_changed++;
2122 #ifdef USE_X_TOOLKIT
2123 FRAME_MENU_BAR_LINES (f) = 0;
2124 if (nlines)
2126 FRAME_EXTERNAL_MENU_BAR (f) = 1;
2127 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
2128 /* Make sure next redisplay shows the menu bar. */
2129 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
2131 else
2133 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
2134 free_frame_menubar (f);
2135 FRAME_EXTERNAL_MENU_BAR (f) = 0;
2136 if (FRAME_X_P (f))
2137 f->output_data.x->menubar_widget = 0;
2139 #else /* not USE_X_TOOLKIT */
2140 FRAME_MENU_BAR_LINES (f) = nlines;
2141 x_change_window_heights (f->root_window, nlines - olines);
2142 #endif /* not USE_X_TOOLKIT */
2143 adjust_glyphs (f);
2147 /* Set the number of lines used for the tool bar of frame F to VALUE.
2148 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
2149 is the old number of tool bar lines. This function changes the
2150 height of all windows on frame F to match the new tool bar height.
2151 The frame's height doesn't change. */
2153 void
2154 x_set_tool_bar_lines (f, value, oldval)
2155 struct frame *f;
2156 Lisp_Object value, oldval;
2158 int delta, nlines, root_height;
2159 Lisp_Object root_window;
2161 /* Treat tool bars like menu bars. */
2162 if (FRAME_MINIBUF_ONLY_P (f))
2163 return;
2165 /* Use VALUE only if an integer >= 0. */
2166 if (INTEGERP (value) && XINT (value) >= 0)
2167 nlines = XFASTINT (value);
2168 else
2169 nlines = 0;
2171 /* Make sure we redisplay all windows in this frame. */
2172 ++windows_or_buffers_changed;
2174 delta = nlines - FRAME_TOOL_BAR_LINES (f);
2176 /* Don't resize the tool-bar to more than we have room for. */
2177 root_window = FRAME_ROOT_WINDOW (f);
2178 root_height = XINT (XWINDOW (root_window)->height);
2179 if (root_height - delta < 1)
2181 delta = root_height - 1;
2182 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
2185 FRAME_TOOL_BAR_LINES (f) = nlines;
2186 x_change_window_heights (root_window, delta);
2187 adjust_glyphs (f);
2189 /* We also have to make sure that the internal border at the top of
2190 the frame, below the menu bar or tool bar, is redrawn when the
2191 tool bar disappears. This is so because the internal border is
2192 below the tool bar if one is displayed, but is below the menu bar
2193 if there isn't a tool bar. The tool bar draws into the area
2194 below the menu bar. */
2195 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
2197 updating_frame = f;
2198 clear_frame ();
2199 clear_current_matrices (f);
2200 updating_frame = NULL;
2203 /* If the tool bar gets smaller, the internal border below it
2204 has to be cleared. It was formerly part of the display
2205 of the larger tool bar, and updating windows won't clear it. */
2206 if (delta < 0)
2208 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
2209 int width = PIXEL_WIDTH (f);
2210 int y = nlines * CANON_Y_UNIT (f);
2212 BLOCK_INPUT;
2213 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2214 0, y, width, height, False);
2215 UNBLOCK_INPUT;
2217 if (WINDOWP (f->tool_bar_window))
2218 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
2223 /* Set the foreground color for scroll bars on frame F to VALUE.
2224 VALUE should be a string, a color name. If it isn't a string or
2225 isn't a valid color name, do nothing. OLDVAL is the old value of
2226 the frame parameter. */
2228 void
2229 x_set_scroll_bar_foreground (f, value, oldval)
2230 struct frame *f;
2231 Lisp_Object value, oldval;
2233 unsigned long pixel;
2235 if (STRINGP (value))
2236 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
2237 else
2238 pixel = -1;
2240 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
2241 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
2243 f->output_data.x->scroll_bar_foreground_pixel = pixel;
2244 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2246 /* Remove all scroll bars because they have wrong colors. */
2247 if (condemn_scroll_bars_hook)
2248 (*condemn_scroll_bars_hook) (f);
2249 if (judge_scroll_bars_hook)
2250 (*judge_scroll_bars_hook) (f);
2252 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
2253 redraw_frame (f);
2258 /* Set the background color for scroll bars on frame F to VALUE VALUE
2259 should be a string, a color name. If it isn't a string or isn't a
2260 valid color name, do nothing. OLDVAL is the old value of the frame
2261 parameter. */
2263 void
2264 x_set_scroll_bar_background (f, value, oldval)
2265 struct frame *f;
2266 Lisp_Object value, oldval;
2268 unsigned long pixel;
2270 if (STRINGP (value))
2271 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
2272 else
2273 pixel = -1;
2275 if (f->output_data.x->scroll_bar_background_pixel != -1)
2276 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
2278 #ifdef USE_TOOLKIT_SCROLL_BARS
2279 /* Scrollbar shadow colors. */
2280 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
2282 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
2283 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
2285 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
2287 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
2288 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
2290 #endif /* USE_TOOLKIT_SCROLL_BARS */
2292 f->output_data.x->scroll_bar_background_pixel = pixel;
2293 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2295 /* Remove all scroll bars because they have wrong colors. */
2296 if (condemn_scroll_bars_hook)
2297 (*condemn_scroll_bars_hook) (f);
2298 if (judge_scroll_bars_hook)
2299 (*judge_scroll_bars_hook) (f);
2301 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
2302 redraw_frame (f);
2307 /* Encode Lisp string STRING as a text in a format appropriate for
2308 XICCC (X Inter Client Communication Conventions).
2310 If STRING contains only ASCII characters, do no conversion and
2311 return the string data of STRING. Otherwise, encode the text by
2312 CODING_SYSTEM, and return a newly allocated memory area which
2313 should be freed by `xfree' by a caller.
2315 SELECTIONP non-zero means the string is being encoded for an X
2316 selection, so it is safe to run pre-write conversions (which
2317 may run Lisp code).
2319 Store the byte length of resulting text in *TEXT_BYTES.
2321 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
2322 which means that the `encoding' of the result can be `STRING'.
2323 Otherwise store 0 in *STRINGP, which means that the `encoding' of
2324 the result should be `COMPOUND_TEXT'. */
2326 unsigned char *
2327 x_encode_text (string, coding_system, selectionp, text_bytes, stringp)
2328 Lisp_Object string, coding_system;
2329 int *text_bytes, *stringp;
2330 int selectionp;
2332 unsigned char *str = SDATA (string);
2333 int chars = SCHARS (string);
2334 int bytes = SBYTES (string);
2335 int charset_info;
2336 int bufsize;
2337 unsigned char *buf;
2338 struct coding_system coding;
2339 extern Lisp_Object Qcompound_text_with_extensions;
2341 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
2342 if (charset_info == 0)
2344 /* No multibyte character in OBJ. We need not encode it. */
2345 *text_bytes = bytes;
2346 *stringp = 1;
2347 return str;
2350 setup_coding_system (coding_system, &coding);
2351 if (selectionp
2352 && SYMBOLP (coding.pre_write_conversion)
2353 && !NILP (Ffboundp (coding.pre_write_conversion)))
2355 string = run_pre_post_conversion_on_str (string, &coding, 1);
2356 str = SDATA (string);
2357 chars = SCHARS (string);
2358 bytes = SBYTES (string);
2360 coding.src_multibyte = 1;
2361 coding.dst_multibyte = 0;
2362 coding.mode |= CODING_MODE_LAST_BLOCK;
2363 if (coding.type == coding_type_iso2022)
2364 coding.flags |= CODING_FLAG_ISO_SAFE;
2365 /* We suppress producing escape sequences for composition. */
2366 coding.composing = COMPOSITION_DISABLED;
2367 bufsize = encoding_buffer_size (&coding, bytes);
2368 buf = (unsigned char *) xmalloc (bufsize);
2369 encode_coding (&coding, str, buf, bytes, bufsize);
2370 *text_bytes = coding.produced;
2371 *stringp = (charset_info == 1
2372 || (!EQ (coding_system, Qcompound_text)
2373 && !EQ (coding_system, Qcompound_text_with_extensions)));
2374 return buf;
2378 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
2379 x_id_name.
2381 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2382 name; if NAME is a string, set F's name to NAME and set
2383 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2385 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2386 suggesting a new name, which lisp code should override; if
2387 F->explicit_name is set, ignore the new name; otherwise, set it. */
2389 void
2390 x_set_name (f, name, explicit)
2391 struct frame *f;
2392 Lisp_Object name;
2393 int explicit;
2395 /* Make sure that requests from lisp code override requests from
2396 Emacs redisplay code. */
2397 if (explicit)
2399 /* If we're switching from explicit to implicit, we had better
2400 update the mode lines and thereby update the title. */
2401 if (f->explicit_name && NILP (name))
2402 update_mode_lines = 1;
2404 f->explicit_name = ! NILP (name);
2406 else if (f->explicit_name)
2407 return;
2409 /* If NAME is nil, set the name to the x_id_name. */
2410 if (NILP (name))
2412 /* Check for no change needed in this very common case
2413 before we do any consing. */
2414 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
2415 SDATA (f->name)))
2416 return;
2417 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
2419 else
2420 CHECK_STRING (name);
2422 /* Don't change the name if it's already NAME. */
2423 if (! NILP (Fstring_equal (name, f->name)))
2424 return;
2426 f->name = name;
2428 /* For setting the frame title, the title parameter should override
2429 the name parameter. */
2430 if (! NILP (f->title))
2431 name = f->title;
2433 if (FRAME_X_WINDOW (f))
2435 BLOCK_INPUT;
2436 #ifdef HAVE_X11R4
2438 XTextProperty text, icon;
2439 int bytes, stringp;
2440 Lisp_Object coding_system;
2442 coding_system = Qcompound_text;
2443 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp);
2444 text.encoding = (stringp ? XA_STRING
2445 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2446 text.format = 8;
2447 text.nitems = bytes;
2449 if (NILP (f->icon_name))
2451 icon = text;
2453 else
2455 icon.value = x_encode_text (f->icon_name, coding_system, 0,
2456 &bytes, &stringp);
2457 icon.encoding = (stringp ? XA_STRING
2458 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2459 icon.format = 8;
2460 icon.nitems = bytes;
2462 #ifdef USE_X_TOOLKIT
2463 XSetWMName (FRAME_X_DISPLAY (f),
2464 XtWindow (f->output_data.x->widget), &text);
2465 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2466 &icon);
2467 #else /* not USE_X_TOOLKIT */
2468 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2469 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2470 #endif /* not USE_X_TOOLKIT */
2471 if (!NILP (f->icon_name)
2472 && icon.value != (unsigned char *) SDATA (f->icon_name))
2473 xfree (icon.value);
2474 if (text.value != (unsigned char *) SDATA (name))
2475 xfree (text.value);
2477 #else /* not HAVE_X11R4 */
2478 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2479 SDATA (name));
2480 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2481 SDATA (name));
2482 #endif /* not HAVE_X11R4 */
2483 UNBLOCK_INPUT;
2487 /* This function should be called when the user's lisp code has
2488 specified a name for the frame; the name will override any set by the
2489 redisplay code. */
2490 void
2491 x_explicitly_set_name (f, arg, oldval)
2492 FRAME_PTR f;
2493 Lisp_Object arg, oldval;
2495 x_set_name (f, arg, 1);
2498 /* This function should be called by Emacs redisplay code to set the
2499 name; names set this way will never override names set by the user's
2500 lisp code. */
2501 void
2502 x_implicitly_set_name (f, arg, oldval)
2503 FRAME_PTR f;
2504 Lisp_Object arg, oldval;
2506 x_set_name (f, arg, 0);
2509 /* Change the title of frame F to NAME.
2510 If NAME is nil, use the frame name as the title.
2512 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2513 name; if NAME is a string, set F's name to NAME and set
2514 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2516 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2517 suggesting a new name, which lisp code should override; if
2518 F->explicit_name is set, ignore the new name; otherwise, set it. */
2520 void
2521 x_set_title (f, name, old_name)
2522 struct frame *f;
2523 Lisp_Object name, old_name;
2525 /* Don't change the title if it's already NAME. */
2526 if (EQ (name, f->title))
2527 return;
2529 update_mode_lines = 1;
2531 f->title = name;
2533 if (NILP (name))
2534 name = f->name;
2535 else
2536 CHECK_STRING (name);
2538 if (FRAME_X_WINDOW (f))
2540 BLOCK_INPUT;
2541 #ifdef HAVE_X11R4
2543 XTextProperty text, icon;
2544 int bytes, stringp;
2545 Lisp_Object coding_system;
2547 coding_system = Qcompound_text;
2548 text.value = x_encode_text (name, coding_system, 0, &bytes, &stringp);
2549 text.encoding = (stringp ? XA_STRING
2550 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2551 text.format = 8;
2552 text.nitems = bytes;
2554 if (NILP (f->icon_name))
2556 icon = text;
2558 else
2560 icon.value = x_encode_text (f->icon_name, coding_system, 0,
2561 &bytes, &stringp);
2562 icon.encoding = (stringp ? XA_STRING
2563 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2564 icon.format = 8;
2565 icon.nitems = bytes;
2567 #ifdef USE_X_TOOLKIT
2568 XSetWMName (FRAME_X_DISPLAY (f),
2569 XtWindow (f->output_data.x->widget), &text);
2570 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2571 &icon);
2572 #else /* not USE_X_TOOLKIT */
2573 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2574 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2575 #endif /* not USE_X_TOOLKIT */
2576 if (!NILP (f->icon_name)
2577 && icon.value != (unsigned char *) SDATA (f->icon_name))
2578 xfree (icon.value);
2579 if (text.value != (unsigned char *) SDATA (name))
2580 xfree (text.value);
2582 #else /* not HAVE_X11R4 */
2583 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2584 SDATA (name));
2585 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2586 SDATA (name));
2587 #endif /* not HAVE_X11R4 */
2588 UNBLOCK_INPUT;
2592 void
2593 x_set_autoraise (f, arg, oldval)
2594 struct frame *f;
2595 Lisp_Object arg, oldval;
2597 f->auto_raise = !EQ (Qnil, arg);
2600 void
2601 x_set_autolower (f, arg, oldval)
2602 struct frame *f;
2603 Lisp_Object arg, oldval;
2605 f->auto_lower = !EQ (Qnil, arg);
2608 void
2609 x_set_unsplittable (f, arg, oldval)
2610 struct frame *f;
2611 Lisp_Object arg, oldval;
2613 f->no_split = !NILP (arg);
2616 void
2617 x_set_vertical_scroll_bars (f, arg, oldval)
2618 struct frame *f;
2619 Lisp_Object arg, oldval;
2621 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
2622 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
2623 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
2624 || (!NILP (arg) && ! FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
2626 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
2627 = (NILP (arg)
2628 ? vertical_scroll_bar_none
2629 : EQ (Qright, arg)
2630 ? vertical_scroll_bar_right
2631 : vertical_scroll_bar_left);
2633 /* We set this parameter before creating the X window for the
2634 frame, so we can get the geometry right from the start.
2635 However, if the window hasn't been created yet, we shouldn't
2636 call x_set_window_size. */
2637 if (FRAME_X_WINDOW (f))
2638 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2639 do_pending_window_change (0);
2643 void
2644 x_set_scroll_bar_width (f, arg, oldval)
2645 struct frame *f;
2646 Lisp_Object arg, oldval;
2648 int wid = FONT_WIDTH (f->output_data.x->font);
2650 if (NILP (arg))
2652 #ifdef USE_TOOLKIT_SCROLL_BARS
2653 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2654 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2655 FRAME_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
2656 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = width;
2657 #else
2658 /* Make the actual width at least 14 pixels and a multiple of a
2659 character width. */
2660 FRAME_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
2662 /* Use all of that space (aside from required margins) for the
2663 scroll bar. */
2664 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = 0;
2665 #endif
2667 if (FRAME_X_WINDOW (f))
2668 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2669 do_pending_window_change (0);
2671 else if (INTEGERP (arg) && XINT (arg) > 0
2672 && XFASTINT (arg) != FRAME_SCROLL_BAR_PIXEL_WIDTH (f))
2674 if (XFASTINT (arg) <= 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM)
2675 XSETINT (arg, 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM + 1);
2677 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = XFASTINT (arg);
2678 FRAME_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + wid-1) / wid;
2679 if (FRAME_X_WINDOW (f))
2680 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2683 change_frame_size (f, 0, FRAME_WIDTH (f), 0, 0, 0);
2684 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
2685 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
2690 /* Subroutines of creating an X frame. */
2692 /* Make sure that Vx_resource_name is set to a reasonable value.
2693 Fix it up, or set it to `emacs' if it is too hopeless. */
2695 static void
2696 validate_x_resource_name ()
2698 int len = 0;
2699 /* Number of valid characters in the resource name. */
2700 int good_count = 0;
2701 /* Number of invalid characters in the resource name. */
2702 int bad_count = 0;
2703 Lisp_Object new;
2704 int i;
2706 if (!STRINGP (Vx_resource_class))
2707 Vx_resource_class = build_string (EMACS_CLASS);
2709 if (STRINGP (Vx_resource_name))
2711 unsigned char *p = SDATA (Vx_resource_name);
2712 int i;
2714 len = SBYTES (Vx_resource_name);
2716 /* Only letters, digits, - and _ are valid in resource names.
2717 Count the valid characters and count the invalid ones. */
2718 for (i = 0; i < len; i++)
2720 int c = p[i];
2721 if (! ((c >= 'a' && c <= 'z')
2722 || (c >= 'A' && c <= 'Z')
2723 || (c >= '0' && c <= '9')
2724 || c == '-' || c == '_'))
2725 bad_count++;
2726 else
2727 good_count++;
2730 else
2731 /* Not a string => completely invalid. */
2732 bad_count = 5, good_count = 0;
2734 /* If name is valid already, return. */
2735 if (bad_count == 0)
2736 return;
2738 /* If name is entirely invalid, or nearly so, use `emacs'. */
2739 if (good_count == 0
2740 || (good_count == 1 && bad_count > 0))
2742 Vx_resource_name = build_string ("emacs");
2743 return;
2746 /* Name is partly valid. Copy it and replace the invalid characters
2747 with underscores. */
2749 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
2751 for (i = 0; i < len; i++)
2753 int c = SREF (new, i);
2754 if (! ((c >= 'a' && c <= 'z')
2755 || (c >= 'A' && c <= 'Z')
2756 || (c >= '0' && c <= '9')
2757 || c == '-' || c == '_'))
2758 SSET (new, i, '_');
2763 extern char *x_get_string_resource ();
2765 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
2766 doc: /* Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.
2767 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the
2768 class, where INSTANCE is the name under which Emacs was invoked, or
2769 the name specified by the `-name' or `-rn' command-line arguments.
2771 The optional arguments COMPONENT and SUBCLASS add to the key and the
2772 class, respectively. You must specify both of them or neither.
2773 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'
2774 and the class is `Emacs.CLASS.SUBCLASS'. */)
2775 (attribute, class, component, subclass)
2776 Lisp_Object attribute, class, component, subclass;
2778 register char *value;
2779 char *name_key;
2780 char *class_key;
2782 check_x ();
2784 CHECK_STRING (attribute);
2785 CHECK_STRING (class);
2787 if (!NILP (component))
2788 CHECK_STRING (component);
2789 if (!NILP (subclass))
2790 CHECK_STRING (subclass);
2791 if (NILP (component) != NILP (subclass))
2792 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2794 validate_x_resource_name ();
2796 /* Allocate space for the components, the dots which separate them,
2797 and the final '\0'. Make them big enough for the worst case. */
2798 name_key = (char *) alloca (SBYTES (Vx_resource_name)
2799 + (STRINGP (component)
2800 ? SBYTES (component) : 0)
2801 + SBYTES (attribute)
2802 + 3);
2804 class_key = (char *) alloca (SBYTES (Vx_resource_class)
2805 + SBYTES (class)
2806 + (STRINGP (subclass)
2807 ? SBYTES (subclass) : 0)
2808 + 3);
2810 /* Start with emacs.FRAMENAME for the name (the specific one)
2811 and with `Emacs' for the class key (the general one). */
2812 strcpy (name_key, SDATA (Vx_resource_name));
2813 strcpy (class_key, SDATA (Vx_resource_class));
2815 strcat (class_key, ".");
2816 strcat (class_key, SDATA (class));
2818 if (!NILP (component))
2820 strcat (class_key, ".");
2821 strcat (class_key, SDATA (subclass));
2823 strcat (name_key, ".");
2824 strcat (name_key, SDATA (component));
2827 strcat (name_key, ".");
2828 strcat (name_key, SDATA (attribute));
2830 value = x_get_string_resource (check_x_display_info (Qnil)->xrdb,
2831 name_key, class_key);
2833 if (value != (char *) 0)
2834 return build_string (value);
2835 else
2836 return Qnil;
2839 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
2841 Lisp_Object
2842 display_x_get_resource (dpyinfo, attribute, class, component, subclass)
2843 struct x_display_info *dpyinfo;
2844 Lisp_Object attribute, class, component, subclass;
2846 register char *value;
2847 char *name_key;
2848 char *class_key;
2850 CHECK_STRING (attribute);
2851 CHECK_STRING (class);
2853 if (!NILP (component))
2854 CHECK_STRING (component);
2855 if (!NILP (subclass))
2856 CHECK_STRING (subclass);
2857 if (NILP (component) != NILP (subclass))
2858 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2860 validate_x_resource_name ();
2862 /* Allocate space for the components, the dots which separate them,
2863 and the final '\0'. Make them big enough for the worst case. */
2864 name_key = (char *) alloca (SBYTES (Vx_resource_name)
2865 + (STRINGP (component)
2866 ? SBYTES (component) : 0)
2867 + SBYTES (attribute)
2868 + 3);
2870 class_key = (char *) alloca (SBYTES (Vx_resource_class)
2871 + SBYTES (class)
2872 + (STRINGP (subclass)
2873 ? SBYTES (subclass) : 0)
2874 + 3);
2876 /* Start with emacs.FRAMENAME for the name (the specific one)
2877 and with `Emacs' for the class key (the general one). */
2878 strcpy (name_key, SDATA (Vx_resource_name));
2879 strcpy (class_key, SDATA (Vx_resource_class));
2881 strcat (class_key, ".");
2882 strcat (class_key, SDATA (class));
2884 if (!NILP (component))
2886 strcat (class_key, ".");
2887 strcat (class_key, SDATA (subclass));
2889 strcat (name_key, ".");
2890 strcat (name_key, SDATA (component));
2893 strcat (name_key, ".");
2894 strcat (name_key, SDATA (attribute));
2896 value = x_get_string_resource (dpyinfo->xrdb, name_key, class_key);
2898 if (value != (char *) 0)
2899 return build_string (value);
2900 else
2901 return Qnil;
2904 /* Used when C code wants a resource value. */
2906 char *
2907 x_get_resource_string (attribute, class)
2908 char *attribute, *class;
2910 char *name_key;
2911 char *class_key;
2912 struct frame *sf = SELECTED_FRAME ();
2914 /* Allocate space for the components, the dots which separate them,
2915 and the final '\0'. */
2916 name_key = (char *) alloca (SBYTES (Vinvocation_name)
2917 + strlen (attribute) + 2);
2918 class_key = (char *) alloca ((sizeof (EMACS_CLASS) - 1)
2919 + strlen (class) + 2);
2921 sprintf (name_key, "%s.%s",
2922 SDATA (Vinvocation_name),
2923 attribute);
2924 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
2926 return x_get_string_resource (FRAME_X_DISPLAY_INFO (sf)->xrdb,
2927 name_key, class_key);
2930 /* Types we might convert a resource string into. */
2931 enum resource_types
2933 RES_TYPE_NUMBER,
2934 RES_TYPE_FLOAT,
2935 RES_TYPE_BOOLEAN,
2936 RES_TYPE_STRING,
2937 RES_TYPE_SYMBOL
2940 /* Return the value of parameter PARAM.
2942 First search ALIST, then Vdefault_frame_alist, then the X defaults
2943 database, using ATTRIBUTE as the attribute name and CLASS as its class.
2945 Convert the resource to the type specified by desired_type.
2947 If no default is specified, return Qunbound. If you call
2948 x_get_arg, make sure you deal with Qunbound in a reasonable way,
2949 and don't let it get stored in any Lisp-visible variables! */
2951 static Lisp_Object
2952 x_get_arg (dpyinfo, alist, param, attribute, class, type)
2953 struct x_display_info *dpyinfo;
2954 Lisp_Object alist, param;
2955 char *attribute;
2956 char *class;
2957 enum resource_types type;
2959 register Lisp_Object tem;
2961 tem = Fassq (param, alist);
2962 if (EQ (tem, Qnil))
2963 tem = Fassq (param, Vdefault_frame_alist);
2964 if (EQ (tem, Qnil))
2967 if (attribute)
2969 tem = display_x_get_resource (dpyinfo,
2970 build_string (attribute),
2971 build_string (class),
2972 Qnil, Qnil);
2974 if (NILP (tem))
2975 return Qunbound;
2977 switch (type)
2979 case RES_TYPE_NUMBER:
2980 return make_number (atoi (SDATA (tem)));
2982 case RES_TYPE_FLOAT:
2983 return make_float (atof (SDATA (tem)));
2985 case RES_TYPE_BOOLEAN:
2986 tem = Fdowncase (tem);
2987 if (!strcmp (SDATA (tem), "on")
2988 || !strcmp (SDATA (tem), "true"))
2989 return Qt;
2990 else
2991 return Qnil;
2993 case RES_TYPE_STRING:
2994 return tem;
2996 case RES_TYPE_SYMBOL:
2997 /* As a special case, we map the values `true' and `on'
2998 to Qt, and `false' and `off' to Qnil. */
3000 Lisp_Object lower;
3001 lower = Fdowncase (tem);
3002 if (!strcmp (SDATA (lower), "on")
3003 || !strcmp (SDATA (lower), "true"))
3004 return Qt;
3005 else if (!strcmp (SDATA (lower), "off")
3006 || !strcmp (SDATA (lower), "false"))
3007 return Qnil;
3008 else
3009 return Fintern (tem, Qnil);
3012 default:
3013 abort ();
3016 else
3017 return Qunbound;
3019 return Fcdr (tem);
3022 /* Like x_get_arg, but also record the value in f->param_alist. */
3024 static Lisp_Object
3025 x_get_and_record_arg (f, alist, param, attribute, class, type)
3026 struct frame *f;
3027 Lisp_Object alist, param;
3028 char *attribute;
3029 char *class;
3030 enum resource_types type;
3032 Lisp_Object value;
3034 value = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, param,
3035 attribute, class, type);
3036 if (! NILP (value))
3037 store_frame_param (f, param, value);
3039 return value;
3042 /* Record in frame F the specified or default value according to ALIST
3043 of the parameter named PROP (a Lisp symbol).
3044 If no value is specified for PROP, look for an X default for XPROP
3045 on the frame named NAME.
3046 If that is not found either, use the value DEFLT. */
3048 static Lisp_Object
3049 x_default_parameter (f, alist, prop, deflt, xprop, xclass, type)
3050 struct frame *f;
3051 Lisp_Object alist;
3052 Lisp_Object prop;
3053 Lisp_Object deflt;
3054 char *xprop;
3055 char *xclass;
3056 enum resource_types type;
3058 Lisp_Object tem;
3060 tem = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, prop, xprop, xclass, type);
3061 if (EQ (tem, Qunbound))
3062 tem = deflt;
3063 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
3064 return tem;
3068 /* Record in frame F the specified or default value according to ALIST
3069 of the parameter named PROP (a Lisp symbol). If no value is
3070 specified for PROP, look for an X default for XPROP on the frame
3071 named NAME. If that is not found either, use the value DEFLT. */
3073 static Lisp_Object
3074 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
3075 foreground_p)
3076 struct frame *f;
3077 Lisp_Object alist;
3078 Lisp_Object prop;
3079 char *xprop;
3080 char *xclass;
3081 int foreground_p;
3083 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3084 Lisp_Object tem;
3086 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
3087 if (EQ (tem, Qunbound))
3089 #ifdef USE_TOOLKIT_SCROLL_BARS
3091 /* See if an X resource for the scroll bar color has been
3092 specified. */
3093 tem = display_x_get_resource (dpyinfo,
3094 build_string (foreground_p
3095 ? "foreground"
3096 : "background"),
3097 empty_string,
3098 build_string ("verticalScrollBar"),
3099 empty_string);
3100 if (!STRINGP (tem))
3102 /* If nothing has been specified, scroll bars will use a
3103 toolkit-dependent default. Because these defaults are
3104 difficult to get at without actually creating a scroll
3105 bar, use nil to indicate that no color has been
3106 specified. */
3107 tem = Qnil;
3110 #else /* not USE_TOOLKIT_SCROLL_BARS */
3112 tem = Qnil;
3114 #endif /* not USE_TOOLKIT_SCROLL_BARS */
3117 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
3118 return tem;
3123 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
3124 doc: /* Parse an X-style geometry string STRING.
3125 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).
3126 The properties returned may include `top', `left', `height', and `width'.
3127 The value of `left' or `top' may be an integer,
3128 or a list (+ N) meaning N pixels relative to top/left corner,
3129 or a list (- N) meaning -N pixels relative to bottom/right corner. */)
3130 (string)
3131 Lisp_Object string;
3133 int geometry, x, y;
3134 unsigned int width, height;
3135 Lisp_Object result;
3137 CHECK_STRING (string);
3139 geometry = XParseGeometry ((char *) SDATA (string),
3140 &x, &y, &width, &height);
3142 #if 0
3143 if (!!(geometry & XValue) != !!(geometry & YValue))
3144 error ("Must specify both x and y position, or neither");
3145 #endif
3147 result = Qnil;
3148 if (geometry & XValue)
3150 Lisp_Object element;
3152 if (x >= 0 && (geometry & XNegative))
3153 element = Fcons (Qleft, Fcons (Qminus, Fcons (make_number (-x), Qnil)));
3154 else if (x < 0 && ! (geometry & XNegative))
3155 element = Fcons (Qleft, Fcons (Qplus, Fcons (make_number (x), Qnil)));
3156 else
3157 element = Fcons (Qleft, make_number (x));
3158 result = Fcons (element, result);
3161 if (geometry & YValue)
3163 Lisp_Object element;
3165 if (y >= 0 && (geometry & YNegative))
3166 element = Fcons (Qtop, Fcons (Qminus, Fcons (make_number (-y), Qnil)));
3167 else if (y < 0 && ! (geometry & YNegative))
3168 element = Fcons (Qtop, Fcons (Qplus, Fcons (make_number (y), Qnil)));
3169 else
3170 element = Fcons (Qtop, make_number (y));
3171 result = Fcons (element, result);
3174 if (geometry & WidthValue)
3175 result = Fcons (Fcons (Qwidth, make_number (width)), result);
3176 if (geometry & HeightValue)
3177 result = Fcons (Fcons (Qheight, make_number (height)), result);
3179 return result;
3182 /* Calculate the desired size and position of this window,
3183 and return the flags saying which aspects were specified.
3185 This function does not make the coordinates positive. */
3187 #define DEFAULT_ROWS 40
3188 #define DEFAULT_COLS 80
3190 static int
3191 x_figure_window_size (f, parms)
3192 struct frame *f;
3193 Lisp_Object parms;
3195 register Lisp_Object tem0, tem1, tem2;
3196 long window_prompting = 0;
3197 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3199 /* Default values if we fall through.
3200 Actually, if that happens we should get
3201 window manager prompting. */
3202 SET_FRAME_WIDTH (f, DEFAULT_COLS);
3203 f->height = DEFAULT_ROWS;
3204 /* Window managers expect that if program-specified
3205 positions are not (0,0), they're intentional, not defaults. */
3206 f->output_data.x->top_pos = 0;
3207 f->output_data.x->left_pos = 0;
3209 tem0 = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
3210 tem1 = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
3211 tem2 = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
3212 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3214 if (!EQ (tem0, Qunbound))
3216 CHECK_NUMBER (tem0);
3217 f->height = XINT (tem0);
3219 if (!EQ (tem1, Qunbound))
3221 CHECK_NUMBER (tem1);
3222 SET_FRAME_WIDTH (f, XINT (tem1));
3224 if (!NILP (tem2) && !EQ (tem2, Qunbound))
3225 window_prompting |= USSize;
3226 else
3227 window_prompting |= PSize;
3230 f->output_data.x->vertical_scroll_bar_extra
3231 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
3233 : (FRAME_SCROLL_BAR_COLS (f) * FONT_WIDTH (f->output_data.x->font)));
3235 x_compute_fringe_widths (f, 0);
3237 f->output_data.x->pixel_width = CHAR_TO_PIXEL_WIDTH (f, f->width);
3238 f->output_data.x->pixel_height = CHAR_TO_PIXEL_HEIGHT (f, f->height);
3240 tem0 = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
3241 tem1 = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
3242 tem2 = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
3243 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3245 if (EQ (tem0, Qminus))
3247 f->output_data.x->top_pos = 0;
3248 window_prompting |= YNegative;
3250 else if (CONSP (tem0) && EQ (XCAR (tem0), Qminus)
3251 && CONSP (XCDR (tem0))
3252 && INTEGERP (XCAR (XCDR (tem0))))
3254 f->output_data.x->top_pos = - XINT (XCAR (XCDR (tem0)));
3255 window_prompting |= YNegative;
3257 else if (CONSP (tem0) && EQ (XCAR (tem0), Qplus)
3258 && CONSP (XCDR (tem0))
3259 && INTEGERP (XCAR (XCDR (tem0))))
3261 f->output_data.x->top_pos = XINT (XCAR (XCDR (tem0)));
3263 else if (EQ (tem0, Qunbound))
3264 f->output_data.x->top_pos = 0;
3265 else
3267 CHECK_NUMBER (tem0);
3268 f->output_data.x->top_pos = XINT (tem0);
3269 if (f->output_data.x->top_pos < 0)
3270 window_prompting |= YNegative;
3273 if (EQ (tem1, Qminus))
3275 f->output_data.x->left_pos = 0;
3276 window_prompting |= XNegative;
3278 else if (CONSP (tem1) && EQ (XCAR (tem1), Qminus)
3279 && CONSP (XCDR (tem1))
3280 && INTEGERP (XCAR (XCDR (tem1))))
3282 f->output_data.x->left_pos = - XINT (XCAR (XCDR (tem1)));
3283 window_prompting |= XNegative;
3285 else if (CONSP (tem1) && EQ (XCAR (tem1), Qplus)
3286 && CONSP (XCDR (tem1))
3287 && INTEGERP (XCAR (XCDR (tem1))))
3289 f->output_data.x->left_pos = XINT (XCAR (XCDR (tem1)));
3291 else if (EQ (tem1, Qunbound))
3292 f->output_data.x->left_pos = 0;
3293 else
3295 CHECK_NUMBER (tem1);
3296 f->output_data.x->left_pos = XINT (tem1);
3297 if (f->output_data.x->left_pos < 0)
3298 window_prompting |= XNegative;
3301 if (!NILP (tem2) && ! EQ (tem2, Qunbound))
3302 window_prompting |= USPosition;
3303 else
3304 window_prompting |= PPosition;
3307 if (f->output_data.x->want_fullscreen != FULLSCREEN_NONE)
3309 int left, top;
3310 int width, height;
3312 /* It takes both for some WM:s to place it where we want */
3313 window_prompting = USPosition | PPosition;
3314 x_fullscreen_adjust (f, &width, &height, &top, &left);
3315 f->width = width;
3316 f->height = height;
3317 f->output_data.x->pixel_width = CHAR_TO_PIXEL_WIDTH (f, f->width);
3318 f->output_data.x->pixel_height = CHAR_TO_PIXEL_HEIGHT (f, f->height);
3319 f->output_data.x->left_pos = left;
3320 f->output_data.x->top_pos = top;
3323 return window_prompting;
3326 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
3328 Status
3329 XSetWMProtocols (dpy, w, protocols, count)
3330 Display *dpy;
3331 Window w;
3332 Atom *protocols;
3333 int count;
3335 Atom prop;
3336 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
3337 if (prop == None) return False;
3338 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
3339 (unsigned char *) protocols, count);
3340 return True;
3342 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
3344 #ifdef USE_X_TOOLKIT
3346 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
3347 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
3348 already be present because of the toolkit (Motif adds some of them,
3349 for example, but Xt doesn't). */
3351 static void
3352 hack_wm_protocols (f, widget)
3353 FRAME_PTR f;
3354 Widget widget;
3356 Display *dpy = XtDisplay (widget);
3357 Window w = XtWindow (widget);
3358 int need_delete = 1;
3359 int need_focus = 1;
3360 int need_save = 1;
3362 BLOCK_INPUT;
3364 Atom type, *atoms = 0;
3365 int format = 0;
3366 unsigned long nitems = 0;
3367 unsigned long bytes_after;
3369 if ((XGetWindowProperty (dpy, w,
3370 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3371 (long)0, (long)100, False, XA_ATOM,
3372 &type, &format, &nitems, &bytes_after,
3373 (unsigned char **) &atoms)
3374 == Success)
3375 && format == 32 && type == XA_ATOM)
3376 while (nitems > 0)
3378 nitems--;
3379 if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
3380 need_delete = 0;
3381 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
3382 need_focus = 0;
3383 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
3384 need_save = 0;
3386 if (atoms) XFree ((char *) atoms);
3389 Atom props [10];
3390 int count = 0;
3391 if (need_delete)
3392 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3393 if (need_focus)
3394 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
3395 if (need_save)
3396 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3397 if (count)
3398 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3399 XA_ATOM, 32, PropModeAppend,
3400 (unsigned char *) props, count);
3402 UNBLOCK_INPUT;
3404 #endif
3408 /* Support routines for XIC (X Input Context). */
3410 #ifdef HAVE_X_I18N
3412 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
3413 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
3416 /* Supported XIM styles, ordered by preferenc. */
3418 static XIMStyle supported_xim_styles[] =
3420 XIMPreeditPosition | XIMStatusArea,
3421 XIMPreeditPosition | XIMStatusNothing,
3422 XIMPreeditPosition | XIMStatusNone,
3423 XIMPreeditNothing | XIMStatusArea,
3424 XIMPreeditNothing | XIMStatusNothing,
3425 XIMPreeditNothing | XIMStatusNone,
3426 XIMPreeditNone | XIMStatusArea,
3427 XIMPreeditNone | XIMStatusNothing,
3428 XIMPreeditNone | XIMStatusNone,
3433 /* Create an X fontset on frame F with base font name
3434 BASE_FONTNAME.. */
3436 static XFontSet
3437 xic_create_xfontset (f, base_fontname)
3438 struct frame *f;
3439 char *base_fontname;
3441 XFontSet xfs;
3442 char **missing_list;
3443 int missing_count;
3444 char *def_string;
3446 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
3447 base_fontname, &missing_list,
3448 &missing_count, &def_string);
3449 if (missing_list)
3450 XFreeStringList (missing_list);
3452 /* No need to free def_string. */
3453 return xfs;
3457 /* Value is the best input style, given user preferences USER (already
3458 checked to be supported by Emacs), and styles supported by the
3459 input method XIM. */
3461 static XIMStyle
3462 best_xim_style (user, xim)
3463 XIMStyles *user;
3464 XIMStyles *xim;
3466 int i, j;
3468 for (i = 0; i < user->count_styles; ++i)
3469 for (j = 0; j < xim->count_styles; ++j)
3470 if (user->supported_styles[i] == xim->supported_styles[j])
3471 return user->supported_styles[i];
3473 /* Return the default style. */
3474 return XIMPreeditNothing | XIMStatusNothing;
3477 /* Create XIC for frame F. */
3479 static XIMStyle xic_style;
3481 void
3482 create_frame_xic (f)
3483 struct frame *f;
3485 XIM xim;
3486 XIC xic = NULL;
3487 XFontSet xfs = NULL;
3489 if (FRAME_XIC (f))
3490 return;
3492 xim = FRAME_X_XIM (f);
3493 if (xim)
3495 XRectangle s_area;
3496 XPoint spot;
3497 XVaNestedList preedit_attr;
3498 XVaNestedList status_attr;
3499 char *base_fontname;
3500 int fontset;
3502 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
3503 spot.x = 0; spot.y = 1;
3504 /* Create X fontset. */
3505 fontset = FRAME_FONTSET (f);
3506 if (fontset < 0)
3507 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3508 else
3510 /* Determine the base fontname from the ASCII font name of
3511 FONTSET. */
3512 char *ascii_font = (char *) SDATA (fontset_ascii (fontset));
3513 char *p = ascii_font;
3514 int i;
3516 for (i = 0; *p; p++)
3517 if (*p == '-') i++;
3518 if (i != 14)
3519 /* As the font name doesn't conform to XLFD, we can't
3520 modify it to get a suitable base fontname for the
3521 frame. */
3522 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3523 else
3525 int len = strlen (ascii_font) + 1;
3526 char *p1 = NULL;
3528 for (i = 0, p = ascii_font; i < 8; p++)
3530 if (*p == '-')
3532 i++;
3533 if (i == 3)
3534 p1 = p + 1;
3537 base_fontname = (char *) alloca (len);
3538 bzero (base_fontname, len);
3539 strcpy (base_fontname, "-*-*-");
3540 bcopy (p1, base_fontname + 5, p - p1);
3541 strcat (base_fontname, "*-*-*-*-*-*-*");
3544 xfs = xic_create_xfontset (f, base_fontname);
3546 /* Determine XIC style. */
3547 if (xic_style == 0)
3549 XIMStyles supported_list;
3550 supported_list.count_styles = (sizeof supported_xim_styles
3551 / sizeof supported_xim_styles[0]);
3552 supported_list.supported_styles = supported_xim_styles;
3553 xic_style = best_xim_style (&supported_list,
3554 FRAME_X_XIM_STYLES (f));
3557 preedit_attr = XVaCreateNestedList (0,
3558 XNFontSet, xfs,
3559 XNForeground,
3560 FRAME_FOREGROUND_PIXEL (f),
3561 XNBackground,
3562 FRAME_BACKGROUND_PIXEL (f),
3563 (xic_style & XIMPreeditPosition
3564 ? XNSpotLocation
3565 : NULL),
3566 &spot,
3567 NULL);
3568 status_attr = XVaCreateNestedList (0,
3569 XNArea,
3570 &s_area,
3571 XNFontSet,
3572 xfs,
3573 XNForeground,
3574 FRAME_FOREGROUND_PIXEL (f),
3575 XNBackground,
3576 FRAME_BACKGROUND_PIXEL (f),
3577 NULL);
3579 xic = XCreateIC (xim,
3580 XNInputStyle, xic_style,
3581 XNClientWindow, FRAME_X_WINDOW(f),
3582 XNFocusWindow, FRAME_X_WINDOW(f),
3583 XNStatusAttributes, status_attr,
3584 XNPreeditAttributes, preedit_attr,
3585 NULL);
3586 XFree (preedit_attr);
3587 XFree (status_attr);
3590 FRAME_XIC (f) = xic;
3591 FRAME_XIC_STYLE (f) = xic_style;
3592 FRAME_XIC_FONTSET (f) = xfs;
3596 /* Destroy XIC and free XIC fontset of frame F, if any. */
3598 void
3599 free_frame_xic (f)
3600 struct frame *f;
3602 if (FRAME_XIC (f) == NULL)
3603 return;
3605 XDestroyIC (FRAME_XIC (f));
3606 if (FRAME_XIC_FONTSET (f))
3607 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3609 FRAME_XIC (f) = NULL;
3610 FRAME_XIC_FONTSET (f) = NULL;
3614 /* Place preedit area for XIC of window W's frame to specified
3615 pixel position X/Y. X and Y are relative to window W. */
3617 void
3618 xic_set_preeditarea (w, x, y)
3619 struct window *w;
3620 int x, y;
3622 struct frame *f = XFRAME (w->frame);
3623 XVaNestedList attr;
3624 XPoint spot;
3626 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x);
3627 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
3628 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
3629 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3630 XFree (attr);
3634 /* Place status area for XIC in bottom right corner of frame F.. */
3636 void
3637 xic_set_statusarea (f)
3638 struct frame *f;
3640 XIC xic = FRAME_XIC (f);
3641 XVaNestedList attr;
3642 XRectangle area;
3643 XRectangle *needed;
3645 /* Negotiate geometry of status area. If input method has existing
3646 status area, use its current size. */
3647 area.x = area.y = area.width = area.height = 0;
3648 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
3649 XSetICValues (xic, XNStatusAttributes, attr, NULL);
3650 XFree (attr);
3652 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
3653 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3654 XFree (attr);
3656 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
3658 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
3659 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3660 XFree (attr);
3663 area.width = needed->width;
3664 area.height = needed->height;
3665 area.x = PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
3666 area.y = (PIXEL_HEIGHT (f) - area.height
3667 - FRAME_MENUBAR_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f));
3668 XFree (needed);
3670 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
3671 XSetICValues(xic, XNStatusAttributes, attr, NULL);
3672 XFree (attr);
3676 /* Set X fontset for XIC of frame F, using base font name
3677 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
3679 void
3680 xic_set_xfontset (f, base_fontname)
3681 struct frame *f;
3682 char *base_fontname;
3684 XVaNestedList attr;
3685 XFontSet xfs;
3687 xfs = xic_create_xfontset (f, base_fontname);
3689 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
3690 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
3691 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3692 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
3693 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
3694 XFree (attr);
3696 if (FRAME_XIC_FONTSET (f))
3697 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3698 FRAME_XIC_FONTSET (f) = xfs;
3701 #endif /* HAVE_X_I18N */
3705 #ifdef USE_X_TOOLKIT
3707 /* Create and set up the X widget for frame F. */
3709 static void
3710 x_window (f, window_prompting, minibuffer_only)
3711 struct frame *f;
3712 long window_prompting;
3713 int minibuffer_only;
3715 XClassHint class_hints;
3716 XSetWindowAttributes attributes;
3717 unsigned long attribute_mask;
3718 Widget shell_widget;
3719 Widget pane_widget;
3720 Widget frame_widget;
3721 Arg al [25];
3722 int ac;
3724 BLOCK_INPUT;
3726 /* Use the resource name as the top-level widget name
3727 for looking up resources. Make a non-Lisp copy
3728 for the window manager, so GC relocation won't bother it.
3730 Elsewhere we specify the window name for the window manager. */
3733 char *str = (char *) SDATA (Vx_resource_name);
3734 f->namebuf = (char *) xmalloc (strlen (str) + 1);
3735 strcpy (f->namebuf, str);
3738 ac = 0;
3739 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
3740 XtSetArg (al[ac], XtNinput, 1); ac++;
3741 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3742 XtSetArg (al[ac], XtNborderWidth, f->output_data.x->border_width); ac++;
3743 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3744 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3745 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3746 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
3747 applicationShellWidgetClass,
3748 FRAME_X_DISPLAY (f), al, ac);
3750 f->output_data.x->widget = shell_widget;
3751 /* maybe_set_screen_title_format (shell_widget); */
3753 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
3754 (widget_value *) NULL,
3755 shell_widget, False,
3756 (lw_callback) NULL,
3757 (lw_callback) NULL,
3758 (lw_callback) NULL,
3759 (lw_callback) NULL);
3761 ac = 0;
3762 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3763 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3764 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3765 XtSetValues (pane_widget, al, ac);
3766 f->output_data.x->column_widget = pane_widget;
3768 /* mappedWhenManaged to false tells to the paned window to not map/unmap
3769 the emacs screen when changing menubar. This reduces flickering. */
3771 ac = 0;
3772 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3773 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
3774 XtSetArg (al[ac], XtNallowResize, 1); ac++;
3775 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
3776 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
3777 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3778 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3779 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3780 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
3781 al, ac);
3783 f->output_data.x->edit_widget = frame_widget;
3785 XtManageChild (frame_widget);
3787 /* Do some needed geometry management. */
3789 int len;
3790 char *tem, shell_position[32];
3791 Arg al[2];
3792 int ac = 0;
3793 int extra_borders = 0;
3794 int menubar_size
3795 = (f->output_data.x->menubar_widget
3796 ? (f->output_data.x->menubar_widget->core.height
3797 + f->output_data.x->menubar_widget->core.border_width)
3798 : 0);
3800 #if 0 /* Experimentally, we now get the right results
3801 for -geometry -0-0 without this. 24 Aug 96, rms. */
3802 if (FRAME_EXTERNAL_MENU_BAR (f))
3804 Dimension ibw = 0;
3805 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
3806 menubar_size += ibw;
3808 #endif
3810 f->output_data.x->menubar_height = menubar_size;
3812 #ifndef USE_LUCID
3813 /* Motif seems to need this amount added to the sizes
3814 specified for the shell widget. The Athena/Lucid widgets don't.
3815 Both conclusions reached experimentally. -- rms. */
3816 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
3817 &extra_borders, NULL);
3818 extra_borders *= 2;
3819 #endif
3821 /* Convert our geometry parameters into a geometry string
3822 and specify it.
3823 Note that we do not specify here whether the position
3824 is a user-specified or program-specified one.
3825 We pass that information later, in x_wm_set_size_hints. */
3827 int left = f->output_data.x->left_pos;
3828 int xneg = window_prompting & XNegative;
3829 int top = f->output_data.x->top_pos;
3830 int yneg = window_prompting & YNegative;
3831 if (xneg)
3832 left = -left;
3833 if (yneg)
3834 top = -top;
3836 if (window_prompting & USPosition)
3837 sprintf (shell_position, "=%dx%d%c%d%c%d",
3838 PIXEL_WIDTH (f) + extra_borders,
3839 PIXEL_HEIGHT (f) + menubar_size + extra_borders,
3840 (xneg ? '-' : '+'), left,
3841 (yneg ? '-' : '+'), top);
3842 else
3843 sprintf (shell_position, "=%dx%d",
3844 PIXEL_WIDTH (f) + extra_borders,
3845 PIXEL_HEIGHT (f) + menubar_size + extra_borders);
3848 len = strlen (shell_position) + 1;
3849 /* We don't free this because we don't know whether
3850 it is safe to free it while the frame exists.
3851 It isn't worth the trouble of arranging to free it
3852 when the frame is deleted. */
3853 tem = (char *) xmalloc (len);
3854 strncpy (tem, shell_position, len);
3855 XtSetArg (al[ac], XtNgeometry, tem); ac++;
3856 XtSetValues (shell_widget, al, ac);
3859 XtManageChild (pane_widget);
3860 XtRealizeWidget (shell_widget);
3862 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
3864 validate_x_resource_name ();
3866 class_hints.res_name = (char *) SDATA (Vx_resource_name);
3867 class_hints.res_class = (char *) SDATA (Vx_resource_class);
3868 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
3870 #ifdef HAVE_X_I18N
3871 FRAME_XIC (f) = NULL;
3872 #ifdef USE_XIM
3873 create_frame_xic (f);
3874 #endif
3875 #endif
3877 f->output_data.x->wm_hints.input = True;
3878 f->output_data.x->wm_hints.flags |= InputHint;
3879 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3880 &f->output_data.x->wm_hints);
3882 hack_wm_protocols (f, shell_widget);
3884 #ifdef HACK_EDITRES
3885 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
3886 #endif
3888 /* Do a stupid property change to force the server to generate a
3889 PropertyNotify event so that the event_stream server timestamp will
3890 be initialized to something relevant to the time we created the window.
3892 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
3893 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3894 XA_ATOM, 32, PropModeAppend,
3895 (unsigned char*) NULL, 0);
3897 /* Make all the standard events reach the Emacs frame. */
3898 attributes.event_mask = STANDARD_EVENT_SET;
3900 #ifdef HAVE_X_I18N
3901 if (FRAME_XIC (f))
3903 /* XIM server might require some X events. */
3904 unsigned long fevent = NoEventMask;
3905 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3906 attributes.event_mask |= fevent;
3908 #endif /* HAVE_X_I18N */
3910 attribute_mask = CWEventMask;
3911 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
3912 attribute_mask, &attributes);
3914 XtMapWidget (frame_widget);
3916 /* x_set_name normally ignores requests to set the name if the
3917 requested name is the same as the current name. This is the one
3918 place where that assumption isn't correct; f->name is set, but
3919 the X server hasn't been told. */
3921 Lisp_Object name;
3922 int explicit = f->explicit_name;
3924 f->explicit_name = 0;
3925 name = f->name;
3926 f->name = Qnil;
3927 x_set_name (f, name, explicit);
3930 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3931 f->output_data.x->text_cursor);
3933 UNBLOCK_INPUT;
3935 /* This is a no-op, except under Motif. Make sure main areas are
3936 set to something reasonable, in case we get an error later. */
3937 lw_set_main_areas (pane_widget, 0, frame_widget);
3940 #else /* not USE_X_TOOLKIT */
3942 /* Create and set up the X window for frame F. */
3944 void
3945 x_window (f)
3946 struct frame *f;
3949 XClassHint class_hints;
3950 XSetWindowAttributes attributes;
3951 unsigned long attribute_mask;
3953 attributes.background_pixel = f->output_data.x->background_pixel;
3954 attributes.border_pixel = f->output_data.x->border_pixel;
3955 attributes.bit_gravity = StaticGravity;
3956 attributes.backing_store = NotUseful;
3957 attributes.save_under = True;
3958 attributes.event_mask = STANDARD_EVENT_SET;
3959 attributes.colormap = FRAME_X_COLORMAP (f);
3960 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
3961 | CWColormap);
3963 BLOCK_INPUT;
3964 FRAME_X_WINDOW (f)
3965 = XCreateWindow (FRAME_X_DISPLAY (f),
3966 f->output_data.x->parent_desc,
3967 f->output_data.x->left_pos,
3968 f->output_data.x->top_pos,
3969 PIXEL_WIDTH (f), PIXEL_HEIGHT (f),
3970 f->output_data.x->border_width,
3971 CopyFromParent, /* depth */
3972 InputOutput, /* class */
3973 FRAME_X_VISUAL (f),
3974 attribute_mask, &attributes);
3976 #ifdef HAVE_X_I18N
3977 #ifdef USE_XIM
3978 create_frame_xic (f);
3979 if (FRAME_XIC (f))
3981 /* XIM server might require some X events. */
3982 unsigned long fevent = NoEventMask;
3983 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3984 attributes.event_mask |= fevent;
3985 attribute_mask = CWEventMask;
3986 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3987 attribute_mask, &attributes);
3989 #endif
3990 #endif /* HAVE_X_I18N */
3992 validate_x_resource_name ();
3994 class_hints.res_name = (char *) SDATA (Vx_resource_name);
3995 class_hints.res_class = (char *) SDATA (Vx_resource_class);
3996 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
3998 /* The menubar is part of the ordinary display;
3999 it does not count in addition to the height of the window. */
4000 f->output_data.x->menubar_height = 0;
4002 /* This indicates that we use the "Passive Input" input model.
4003 Unless we do this, we don't get the Focus{In,Out} events that we
4004 need to draw the cursor correctly. Accursed bureaucrats.
4005 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
4007 f->output_data.x->wm_hints.input = True;
4008 f->output_data.x->wm_hints.flags |= InputHint;
4009 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4010 &f->output_data.x->wm_hints);
4011 f->output_data.x->wm_hints.icon_pixmap = None;
4013 /* Request "save yourself" and "delete window" commands from wm. */
4015 Atom protocols[2];
4016 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
4017 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
4018 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
4021 /* x_set_name normally ignores requests to set the name if the
4022 requested name is the same as the current name. This is the one
4023 place where that assumption isn't correct; f->name is set, but
4024 the X server hasn't been told. */
4026 Lisp_Object name;
4027 int explicit = f->explicit_name;
4029 f->explicit_name = 0;
4030 name = f->name;
4031 f->name = Qnil;
4032 x_set_name (f, name, explicit);
4035 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4036 f->output_data.x->text_cursor);
4038 UNBLOCK_INPUT;
4040 if (FRAME_X_WINDOW (f) == 0)
4041 error ("Unable to create window");
4044 #endif /* not USE_X_TOOLKIT */
4046 /* Handle the icon stuff for this window. Perhaps later we might
4047 want an x_set_icon_position which can be called interactively as
4048 well. */
4050 static void
4051 x_icon (f, parms)
4052 struct frame *f;
4053 Lisp_Object parms;
4055 Lisp_Object icon_x, icon_y;
4056 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4058 /* Set the position of the icon. Note that twm groups all
4059 icons in an icon window. */
4060 icon_x = x_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
4061 icon_y = x_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
4062 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
4064 CHECK_NUMBER (icon_x);
4065 CHECK_NUMBER (icon_y);
4067 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
4068 error ("Both left and top icon corners of icon must be specified");
4070 BLOCK_INPUT;
4072 if (! EQ (icon_x, Qunbound))
4073 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
4075 /* Start up iconic or window? */
4076 x_wm_set_window_state
4077 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
4078 Qicon)
4079 ? IconicState
4080 : NormalState));
4082 x_text_icon (f, (char *) SDATA ((!NILP (f->icon_name)
4083 ? f->icon_name
4084 : f->name)));
4086 UNBLOCK_INPUT;
4089 /* Make the GCs needed for this window, setting the
4090 background, border and mouse colors; also create the
4091 mouse cursor and the gray border tile. */
4093 static char cursor_bits[] =
4095 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
4096 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
4097 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
4098 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
4101 static void
4102 x_make_gc (f)
4103 struct frame *f;
4105 XGCValues gc_values;
4107 BLOCK_INPUT;
4109 /* Create the GCs of this frame.
4110 Note that many default values are used. */
4112 /* Normal video */
4113 gc_values.font = f->output_data.x->font->fid;
4114 gc_values.foreground = f->output_data.x->foreground_pixel;
4115 gc_values.background = f->output_data.x->background_pixel;
4116 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
4117 f->output_data.x->normal_gc
4118 = XCreateGC (FRAME_X_DISPLAY (f),
4119 FRAME_X_WINDOW (f),
4120 GCLineWidth | GCFont | GCForeground | GCBackground,
4121 &gc_values);
4123 /* Reverse video style. */
4124 gc_values.foreground = f->output_data.x->background_pixel;
4125 gc_values.background = f->output_data.x->foreground_pixel;
4126 f->output_data.x->reverse_gc
4127 = XCreateGC (FRAME_X_DISPLAY (f),
4128 FRAME_X_WINDOW (f),
4129 GCFont | GCForeground | GCBackground | GCLineWidth,
4130 &gc_values);
4132 /* Cursor has cursor-color background, background-color foreground. */
4133 gc_values.foreground = f->output_data.x->background_pixel;
4134 gc_values.background = f->output_data.x->cursor_pixel;
4135 gc_values.fill_style = FillOpaqueStippled;
4136 gc_values.stipple
4137 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
4138 FRAME_X_DISPLAY_INFO (f)->root_window,
4139 cursor_bits, 16, 16);
4140 f->output_data.x->cursor_gc
4141 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4142 (GCFont | GCForeground | GCBackground
4143 | GCFillStyle /* | GCStipple */ | GCLineWidth),
4144 &gc_values);
4146 /* Reliefs. */
4147 f->output_data.x->white_relief.gc = 0;
4148 f->output_data.x->black_relief.gc = 0;
4150 /* Create the gray border tile used when the pointer is not in
4151 the frame. Since this depends on the frame's pixel values,
4152 this must be done on a per-frame basis. */
4153 f->output_data.x->border_tile
4154 = (XCreatePixmapFromBitmapData
4155 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
4156 gray_bits, gray_width, gray_height,
4157 f->output_data.x->foreground_pixel,
4158 f->output_data.x->background_pixel,
4159 DefaultDepth (FRAME_X_DISPLAY (f), FRAME_X_SCREEN_NUMBER (f))));
4161 UNBLOCK_INPUT;
4165 /* Free what was was allocated in x_make_gc. */
4167 void
4168 x_free_gcs (f)
4169 struct frame *f;
4171 Display *dpy = FRAME_X_DISPLAY (f);
4173 BLOCK_INPUT;
4175 if (f->output_data.x->normal_gc)
4177 XFreeGC (dpy, f->output_data.x->normal_gc);
4178 f->output_data.x->normal_gc = 0;
4181 if (f->output_data.x->reverse_gc)
4183 XFreeGC (dpy, f->output_data.x->reverse_gc);
4184 f->output_data.x->reverse_gc = 0;
4187 if (f->output_data.x->cursor_gc)
4189 XFreeGC (dpy, f->output_data.x->cursor_gc);
4190 f->output_data.x->cursor_gc = 0;
4193 if (f->output_data.x->border_tile)
4195 XFreePixmap (dpy, f->output_data.x->border_tile);
4196 f->output_data.x->border_tile = 0;
4199 UNBLOCK_INPUT;
4203 /* Handler for signals raised during x_create_frame and
4204 x_create_top_frame. FRAME is the frame which is partially
4205 constructed. */
4207 static Lisp_Object
4208 unwind_create_frame (frame)
4209 Lisp_Object frame;
4211 struct frame *f = XFRAME (frame);
4213 /* If frame is ``official'', nothing to do. */
4214 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
4216 #if GLYPH_DEBUG
4217 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4218 #endif
4220 x_free_frame_resources (f);
4222 /* Check that reference counts are indeed correct. */
4223 xassert (dpyinfo->reference_count == dpyinfo_refcount);
4224 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
4225 return Qt;
4228 return Qnil;
4232 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4233 1, 1, 0,
4234 doc: /* Make a new X window, which is called a "frame" in Emacs terms.
4235 Returns an Emacs frame object.
4236 ALIST is an alist of frame parameters.
4237 If the parameters specify that the frame should not have a minibuffer,
4238 and do not specify a specific minibuffer window to use,
4239 then `default-minibuffer-frame' must be a frame whose minibuffer can
4240 be shared by the new frame.
4242 This function is an internal primitive--use `make-frame' instead. */)
4243 (parms)
4244 Lisp_Object parms;
4246 struct frame *f;
4247 Lisp_Object frame, tem;
4248 Lisp_Object name;
4249 int minibuffer_only = 0;
4250 long window_prompting = 0;
4251 int width, height;
4252 int count = SPECPDL_INDEX ();
4253 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4254 Lisp_Object display;
4255 struct x_display_info *dpyinfo = NULL;
4256 Lisp_Object parent;
4257 struct kboard *kb;
4259 check_x ();
4261 /* Use this general default value to start with
4262 until we know if this frame has a specified name. */
4263 Vx_resource_name = Vinvocation_name;
4265 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
4266 if (EQ (display, Qunbound))
4267 display = Qnil;
4268 dpyinfo = check_x_display_info (display);
4269 #ifdef MULTI_KBOARD
4270 kb = dpyinfo->kboard;
4271 #else
4272 kb = &the_only_kboard;
4273 #endif
4275 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4276 if (!STRINGP (name)
4277 && ! EQ (name, Qunbound)
4278 && ! NILP (name))
4279 error ("Invalid frame name--not a string or nil");
4281 if (STRINGP (name))
4282 Vx_resource_name = name;
4284 /* See if parent window is specified. */
4285 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4286 if (EQ (parent, Qunbound))
4287 parent = Qnil;
4288 if (! NILP (parent))
4289 CHECK_NUMBER (parent);
4291 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4292 /* No need to protect DISPLAY because that's not used after passing
4293 it to make_frame_without_minibuffer. */
4294 frame = Qnil;
4295 GCPRO4 (parms, parent, name, frame);
4296 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
4297 RES_TYPE_SYMBOL);
4298 if (EQ (tem, Qnone) || NILP (tem))
4299 f = make_frame_without_minibuffer (Qnil, kb, display);
4300 else if (EQ (tem, Qonly))
4302 f = make_minibuffer_frame ();
4303 minibuffer_only = 1;
4305 else if (WINDOWP (tem))
4306 f = make_frame_without_minibuffer (tem, kb, display);
4307 else
4308 f = make_frame (1);
4310 XSETFRAME (frame, f);
4312 /* Note that X Windows does support scroll bars. */
4313 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
4315 f->output_method = output_x_window;
4316 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4317 bzero (f->output_data.x, sizeof (struct x_output));
4318 f->output_data.x->icon_bitmap = -1;
4319 f->output_data.x->fontset = -1;
4320 f->output_data.x->scroll_bar_foreground_pixel = -1;
4321 f->output_data.x->scroll_bar_background_pixel = -1;
4322 #ifdef USE_TOOLKIT_SCROLL_BARS
4323 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
4324 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
4325 #endif /* USE_TOOLKIT_SCROLL_BARS */
4326 record_unwind_protect (unwind_create_frame, frame);
4328 f->icon_name
4329 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
4330 RES_TYPE_STRING);
4331 if (! STRINGP (f->icon_name))
4332 f->icon_name = Qnil;
4334 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4335 #if GLYPH_DEBUG
4336 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4337 dpyinfo_refcount = dpyinfo->reference_count;
4338 #endif /* GLYPH_DEBUG */
4339 #ifdef MULTI_KBOARD
4340 FRAME_KBOARD (f) = kb;
4341 #endif
4343 /* These colors will be set anyway later, but it's important
4344 to get the color reference counts right, so initialize them! */
4346 Lisp_Object black;
4347 struct gcpro gcpro1;
4349 /* Function x_decode_color can signal an error. Make
4350 sure to initialize color slots so that we won't try
4351 to free colors we haven't allocated. */
4352 f->output_data.x->foreground_pixel = -1;
4353 f->output_data.x->background_pixel = -1;
4354 f->output_data.x->cursor_pixel = -1;
4355 f->output_data.x->cursor_foreground_pixel = -1;
4356 f->output_data.x->border_pixel = -1;
4357 f->output_data.x->mouse_pixel = -1;
4359 black = build_string ("black");
4360 GCPRO1 (black);
4361 f->output_data.x->foreground_pixel
4362 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4363 f->output_data.x->background_pixel
4364 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4365 f->output_data.x->cursor_pixel
4366 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4367 f->output_data.x->cursor_foreground_pixel
4368 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4369 f->output_data.x->border_pixel
4370 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4371 f->output_data.x->mouse_pixel
4372 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4373 UNGCPRO;
4376 /* Specify the parent under which to make this X window. */
4378 if (!NILP (parent))
4380 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
4381 f->output_data.x->explicit_parent = 1;
4383 else
4385 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4386 f->output_data.x->explicit_parent = 0;
4389 /* Set the name; the functions to which we pass f expect the name to
4390 be set. */
4391 if (EQ (name, Qunbound) || NILP (name))
4393 f->name = build_string (dpyinfo->x_id_name);
4394 f->explicit_name = 0;
4396 else
4398 f->name = name;
4399 f->explicit_name = 1;
4400 /* use the frame's title when getting resources for this frame. */
4401 specbind (Qx_resource_name, name);
4404 /* Extract the window parameters from the supplied values
4405 that are needed to determine window geometry. */
4407 Lisp_Object font;
4409 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4411 BLOCK_INPUT;
4412 /* First, try whatever font the caller has specified. */
4413 if (STRINGP (font))
4415 tem = Fquery_fontset (font, Qnil);
4416 if (STRINGP (tem))
4417 font = x_new_fontset (f, SDATA (tem));
4418 else
4419 font = x_new_font (f, SDATA (font));
4422 /* Try out a font which we hope has bold and italic variations. */
4423 if (!STRINGP (font))
4424 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4425 if (!STRINGP (font))
4426 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4427 if (! STRINGP (font))
4428 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4429 if (! STRINGP (font))
4430 /* This was formerly the first thing tried, but it finds too many fonts
4431 and takes too long. */
4432 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4433 /* If those didn't work, look for something which will at least work. */
4434 if (! STRINGP (font))
4435 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4436 UNBLOCK_INPUT;
4437 if (! STRINGP (font))
4438 font = build_string ("fixed");
4440 x_default_parameter (f, parms, Qfont, font,
4441 "font", "Font", RES_TYPE_STRING);
4444 #ifdef USE_LUCID
4445 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
4446 whereby it fails to get any font. */
4447 xlwmenu_default_font = f->output_data.x->font;
4448 #endif
4450 x_default_parameter (f, parms, Qborder_width, make_number (2),
4451 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4453 /* This defaults to 1 in order to match xterm. We recognize either
4454 internalBorderWidth or internalBorder (which is what xterm calls
4455 it). */
4456 if (NILP (Fassq (Qinternal_border_width, parms)))
4458 Lisp_Object value;
4460 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4461 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4462 if (! EQ (value, Qunbound))
4463 parms = Fcons (Fcons (Qinternal_border_width, value),
4464 parms);
4466 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4467 "internalBorderWidth", "internalBorderWidth",
4468 RES_TYPE_NUMBER);
4469 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
4470 "verticalScrollBars", "ScrollBars",
4471 RES_TYPE_SYMBOL);
4473 /* Also do the stuff which must be set before the window exists. */
4474 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4475 "foreground", "Foreground", RES_TYPE_STRING);
4476 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4477 "background", "Background", RES_TYPE_STRING);
4478 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4479 "pointerColor", "Foreground", RES_TYPE_STRING);
4480 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4481 "cursorColor", "Foreground", RES_TYPE_STRING);
4482 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4483 "borderColor", "BorderColor", RES_TYPE_STRING);
4484 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
4485 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4486 x_default_parameter (f, parms, Qline_spacing, Qnil,
4487 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4488 x_default_parameter (f, parms, Qleft_fringe, Qnil,
4489 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
4490 x_default_parameter (f, parms, Qright_fringe, Qnil,
4491 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
4493 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
4494 "scrollBarForeground",
4495 "ScrollBarForeground", 1);
4496 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
4497 "scrollBarBackground",
4498 "ScrollBarBackground", 0);
4500 /* Init faces before x_default_parameter is called for scroll-bar
4501 parameters because that function calls x_set_scroll_bar_width,
4502 which calls change_frame_size, which calls Fset_window_buffer,
4503 which runs hooks, which call Fvertical_motion. At the end, we
4504 end up in init_iterator with a null face cache, which should not
4505 happen. */
4506 init_frame_faces (f);
4508 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
4509 "menuBar", "MenuBar", RES_TYPE_NUMBER);
4510 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
4511 "toolBar", "ToolBar", RES_TYPE_NUMBER);
4512 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
4513 "bufferPredicate", "BufferPredicate",
4514 RES_TYPE_SYMBOL);
4515 x_default_parameter (f, parms, Qtitle, Qnil,
4516 "title", "Title", RES_TYPE_STRING);
4517 x_default_parameter (f, parms, Qwait_for_wm, Qt,
4518 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN);
4519 x_default_parameter (f, parms, Qfullscreen, Qnil,
4520 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
4522 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4524 /* Add the tool-bar height to the initial frame height so that the
4525 user gets a text display area of the size he specified with -g or
4526 via .Xdefaults. Later changes of the tool-bar height don't
4527 change the frame size. This is done so that users can create
4528 tall Emacs frames without having to guess how tall the tool-bar
4529 will get. */
4530 if (FRAME_TOOL_BAR_LINES (f))
4532 int margin, relief, bar_height;
4534 relief = (tool_bar_button_relief >= 0
4535 ? tool_bar_button_relief
4536 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
4538 if (INTEGERP (Vtool_bar_button_margin)
4539 && XINT (Vtool_bar_button_margin) > 0)
4540 margin = XFASTINT (Vtool_bar_button_margin);
4541 else if (CONSP (Vtool_bar_button_margin)
4542 && INTEGERP (XCDR (Vtool_bar_button_margin))
4543 && XINT (XCDR (Vtool_bar_button_margin)) > 0)
4544 margin = XFASTINT (XCDR (Vtool_bar_button_margin));
4545 else
4546 margin = 0;
4548 bar_height = DEFAULT_TOOL_BAR_IMAGE_HEIGHT + 2 * margin + 2 * relief;
4549 f->height += (bar_height + CANON_Y_UNIT (f) - 1) / CANON_Y_UNIT (f);
4552 /* Compute the size of the X window. */
4553 window_prompting = x_figure_window_size (f, parms);
4555 if (window_prompting & XNegative)
4557 if (window_prompting & YNegative)
4558 f->output_data.x->win_gravity = SouthEastGravity;
4559 else
4560 f->output_data.x->win_gravity = NorthEastGravity;
4562 else
4564 if (window_prompting & YNegative)
4565 f->output_data.x->win_gravity = SouthWestGravity;
4566 else
4567 f->output_data.x->win_gravity = NorthWestGravity;
4570 f->output_data.x->size_hint_flags = window_prompting;
4572 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4573 f->no_split = minibuffer_only || EQ (tem, Qt);
4575 /* Create the X widget or window. */
4576 #ifdef USE_X_TOOLKIT
4577 x_window (f, window_prompting, minibuffer_only);
4578 #else
4579 x_window (f);
4580 #endif
4582 x_icon (f, parms);
4583 x_make_gc (f);
4585 /* Now consider the frame official. */
4586 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4587 Vframe_list = Fcons (frame, Vframe_list);
4589 /* We need to do this after creating the X window, so that the
4590 icon-creation functions can say whose icon they're describing. */
4591 x_default_parameter (f, parms, Qicon_type, Qnil,
4592 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4594 x_default_parameter (f, parms, Qauto_raise, Qnil,
4595 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4596 x_default_parameter (f, parms, Qauto_lower, Qnil,
4597 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4598 x_default_parameter (f, parms, Qcursor_type, Qbox,
4599 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4600 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
4601 "scrollBarWidth", "ScrollBarWidth",
4602 RES_TYPE_NUMBER);
4604 /* Dimensions, especially f->height, must be done via change_frame_size.
4605 Change will not be effected unless different from the current
4606 f->height. */
4607 width = f->width;
4608 height = f->height;
4610 f->height = 0;
4611 SET_FRAME_WIDTH (f, 0);
4612 change_frame_size (f, height, width, 1, 0, 0);
4614 /* Set up faces after all frame parameters are known. This call
4615 also merges in face attributes specified for new frames. If we
4616 don't do this, the `menu' face for instance won't have the right
4617 colors, and the menu bar won't appear in the specified colors for
4618 new frames. */
4619 call1 (Qface_set_after_frame_default, frame);
4621 #ifdef USE_X_TOOLKIT
4622 /* Create the menu bar. */
4623 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4625 /* If this signals an error, we haven't set size hints for the
4626 frame and we didn't make it visible. */
4627 initialize_frame_menubar (f);
4629 /* This is a no-op, except under Motif where it arranges the
4630 main window for the widgets on it. */
4631 lw_set_main_areas (f->output_data.x->column_widget,
4632 f->output_data.x->menubar_widget,
4633 f->output_data.x->edit_widget);
4635 #endif /* USE_X_TOOLKIT */
4637 /* Tell the server what size and position, etc, we want, and how
4638 badly we want them. This should be done after we have the menu
4639 bar so that its size can be taken into account. */
4640 BLOCK_INPUT;
4641 x_wm_set_size_hint (f, window_prompting, 0);
4642 UNBLOCK_INPUT;
4644 /* Make the window appear on the frame and enable display, unless
4645 the caller says not to. However, with explicit parent, Emacs
4646 cannot control visibility, so don't try. */
4647 if (! f->output_data.x->explicit_parent)
4649 Lisp_Object visibility;
4651 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
4652 RES_TYPE_SYMBOL);
4653 if (EQ (visibility, Qunbound))
4654 visibility = Qt;
4656 if (EQ (visibility, Qicon))
4657 x_iconify_frame (f);
4658 else if (! NILP (visibility))
4659 x_make_frame_visible (f);
4660 else
4661 /* Must have been Qnil. */
4665 UNGCPRO;
4667 /* Make sure windows on this frame appear in calls to next-window
4668 and similar functions. */
4669 Vwindow_list = Qnil;
4671 return unbind_to (count, frame);
4675 /* FRAME is used only to get a handle on the X display. We don't pass the
4676 display info directly because we're called from frame.c, which doesn't
4677 know about that structure. */
4679 Lisp_Object
4680 x_get_focus_frame (frame)
4681 struct frame *frame;
4683 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
4684 Lisp_Object xfocus;
4685 if (! dpyinfo->x_focus_frame)
4686 return Qnil;
4688 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
4689 return xfocus;
4693 /* In certain situations, when the window manager follows a
4694 click-to-focus policy, there seems to be no way around calling
4695 XSetInputFocus to give another frame the input focus .
4697 In an ideal world, XSetInputFocus should generally be avoided so
4698 that applications don't interfere with the window manager's focus
4699 policy. But I think it's okay to use when it's clearly done
4700 following a user-command. */
4702 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4703 doc: /* Set the input focus to FRAME.
4704 FRAME nil means use the selected frame. */)
4705 (frame)
4706 Lisp_Object frame;
4708 struct frame *f = check_x_frame (frame);
4709 Display *dpy = FRAME_X_DISPLAY (f);
4710 int count;
4712 BLOCK_INPUT;
4713 count = x_catch_errors (dpy);
4714 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4715 RevertToParent, CurrentTime);
4716 x_uncatch_errors (dpy, count);
4717 UNBLOCK_INPUT;
4719 return Qnil;
4723 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4724 doc: /* Internal function called by `color-defined-p', which see. */)
4725 (color, frame)
4726 Lisp_Object color, frame;
4728 XColor foo;
4729 FRAME_PTR f = check_x_frame (frame);
4731 CHECK_STRING (color);
4733 if (x_defined_color (f, SDATA (color), &foo, 0))
4734 return Qt;
4735 else
4736 return Qnil;
4739 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4740 doc: /* Internal function called by `color-values', which see. */)
4741 (color, frame)
4742 Lisp_Object color, frame;
4744 XColor foo;
4745 FRAME_PTR f = check_x_frame (frame);
4747 CHECK_STRING (color);
4749 if (x_defined_color (f, SDATA (color), &foo, 0))
4751 Lisp_Object rgb[3];
4753 rgb[0] = make_number (foo.red);
4754 rgb[1] = make_number (foo.green);
4755 rgb[2] = make_number (foo.blue);
4756 return Flist (3, rgb);
4758 else
4759 return Qnil;
4762 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4763 doc: /* Internal function called by `display-color-p', which see. */)
4764 (display)
4765 Lisp_Object display;
4767 struct x_display_info *dpyinfo = check_x_display_info (display);
4769 if (dpyinfo->n_planes <= 2)
4770 return Qnil;
4772 switch (dpyinfo->visual->class)
4774 case StaticColor:
4775 case PseudoColor:
4776 case TrueColor:
4777 case DirectColor:
4778 return Qt;
4780 default:
4781 return Qnil;
4785 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
4786 0, 1, 0,
4787 doc: /* Return t if the X display supports shades of gray.
4788 Note that color displays do support shades of gray.
4789 The optional argument DISPLAY specifies which display to ask about.
4790 DISPLAY should be either a frame or a display name (a string).
4791 If omitted or nil, that stands for the selected frame's display. */)
4792 (display)
4793 Lisp_Object display;
4795 struct x_display_info *dpyinfo = check_x_display_info (display);
4797 if (dpyinfo->n_planes <= 1)
4798 return Qnil;
4800 switch (dpyinfo->visual->class)
4802 case StaticColor:
4803 case PseudoColor:
4804 case TrueColor:
4805 case DirectColor:
4806 case StaticGray:
4807 case GrayScale:
4808 return Qt;
4810 default:
4811 return Qnil;
4815 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
4816 0, 1, 0,
4817 doc: /* Returns the width in pixels of the X display DISPLAY.
4818 The optional argument DISPLAY specifies which display to ask about.
4819 DISPLAY should be either a frame or a display name (a string).
4820 If omitted or nil, that stands for the selected frame's display. */)
4821 (display)
4822 Lisp_Object display;
4824 struct x_display_info *dpyinfo = check_x_display_info (display);
4826 return make_number (dpyinfo->width);
4829 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4830 Sx_display_pixel_height, 0, 1, 0,
4831 doc: /* Returns the height in pixels of the X display DISPLAY.
4832 The optional argument DISPLAY specifies which display to ask about.
4833 DISPLAY should be either a frame or a display name (a string).
4834 If omitted or nil, that stands for the selected frame's display. */)
4835 (display)
4836 Lisp_Object display;
4838 struct x_display_info *dpyinfo = check_x_display_info (display);
4840 return make_number (dpyinfo->height);
4843 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4844 0, 1, 0,
4845 doc: /* Returns the number of bitplanes of the X display DISPLAY.
4846 The optional argument DISPLAY specifies which display to ask about.
4847 DISPLAY should be either a frame or a display name (a string).
4848 If omitted or nil, that stands for the selected frame's display. */)
4849 (display)
4850 Lisp_Object display;
4852 struct x_display_info *dpyinfo = check_x_display_info (display);
4854 return make_number (dpyinfo->n_planes);
4857 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4858 0, 1, 0,
4859 doc: /* Returns the number of color cells of the X display DISPLAY.
4860 The optional argument DISPLAY specifies which display to ask about.
4861 DISPLAY should be either a frame or a display name (a string).
4862 If omitted or nil, that stands for the selected frame's display. */)
4863 (display)
4864 Lisp_Object display;
4866 struct x_display_info *dpyinfo = check_x_display_info (display);
4868 return make_number (DisplayCells (dpyinfo->display,
4869 XScreenNumberOfScreen (dpyinfo->screen)));
4872 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4873 Sx_server_max_request_size,
4874 0, 1, 0,
4875 doc: /* Returns the maximum request size of the X server of display DISPLAY.
4876 The optional argument DISPLAY specifies which display to ask about.
4877 DISPLAY should be either a frame or a display name (a string).
4878 If omitted or nil, that stands for the selected frame's display. */)
4879 (display)
4880 Lisp_Object display;
4882 struct x_display_info *dpyinfo = check_x_display_info (display);
4884 return make_number (MAXREQUEST (dpyinfo->display));
4887 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4888 doc: /* Returns the vendor ID string of the X server of display DISPLAY.
4889 The optional argument DISPLAY specifies which display to ask about.
4890 DISPLAY should be either a frame or a display name (a string).
4891 If omitted or nil, that stands for the selected frame's display. */)
4892 (display)
4893 Lisp_Object display;
4895 struct x_display_info *dpyinfo = check_x_display_info (display);
4896 char *vendor = ServerVendor (dpyinfo->display);
4898 if (! vendor) vendor = "";
4899 return build_string (vendor);
4902 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4903 doc: /* Returns the version numbers of the X server of display DISPLAY.
4904 The value is a list of three integers: the major and minor
4905 version numbers of the X Protocol in use, and the vendor-specific release
4906 number. See also the function `x-server-vendor'.
4908 The optional argument DISPLAY specifies which display to ask about.
4909 DISPLAY should be either a frame or a display name (a string).
4910 If omitted or nil, that stands for the selected frame's display. */)
4911 (display)
4912 Lisp_Object display;
4914 struct x_display_info *dpyinfo = check_x_display_info (display);
4915 Display *dpy = dpyinfo->display;
4917 return Fcons (make_number (ProtocolVersion (dpy)),
4918 Fcons (make_number (ProtocolRevision (dpy)),
4919 Fcons (make_number (VendorRelease (dpy)), Qnil)));
4922 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4923 doc: /* Return the number of screens on the X server of display DISPLAY.
4924 The optional argument DISPLAY specifies which display to ask about.
4925 DISPLAY should be either a frame or a display name (a string).
4926 If omitted or nil, that stands for the selected frame's display. */)
4927 (display)
4928 Lisp_Object display;
4930 struct x_display_info *dpyinfo = check_x_display_info (display);
4932 return make_number (ScreenCount (dpyinfo->display));
4935 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
4936 doc: /* Return the height in millimeters of the X display DISPLAY.
4937 The optional argument DISPLAY specifies which display to ask about.
4938 DISPLAY should be either a frame or a display name (a string).
4939 If omitted or nil, that stands for the selected frame's display. */)
4940 (display)
4941 Lisp_Object display;
4943 struct x_display_info *dpyinfo = check_x_display_info (display);
4945 return make_number (HeightMMOfScreen (dpyinfo->screen));
4948 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4949 doc: /* Return the width in millimeters of the X display DISPLAY.
4950 The optional argument DISPLAY specifies which display to ask about.
4951 DISPLAY should be either a frame or a display name (a string).
4952 If omitted or nil, that stands for the selected frame's display. */)
4953 (display)
4954 Lisp_Object display;
4956 struct x_display_info *dpyinfo = check_x_display_info (display);
4958 return make_number (WidthMMOfScreen (dpyinfo->screen));
4961 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4962 Sx_display_backing_store, 0, 1, 0,
4963 doc: /* Returns an indication of whether X display DISPLAY does backing store.
4964 The value may be `always', `when-mapped', or `not-useful'.
4965 The optional argument DISPLAY specifies which display to ask about.
4966 DISPLAY should be either a frame or a display name (a string).
4967 If omitted or nil, that stands for the selected frame's display. */)
4968 (display)
4969 Lisp_Object display;
4971 struct x_display_info *dpyinfo = check_x_display_info (display);
4972 Lisp_Object result;
4974 switch (DoesBackingStore (dpyinfo->screen))
4976 case Always:
4977 result = intern ("always");
4978 break;
4980 case WhenMapped:
4981 result = intern ("when-mapped");
4982 break;
4984 case NotUseful:
4985 result = intern ("not-useful");
4986 break;
4988 default:
4989 error ("Strange value for BackingStore parameter of screen");
4990 result = Qnil;
4993 return result;
4996 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4997 Sx_display_visual_class, 0, 1, 0,
4998 doc: /* Return the visual class of the X display DISPLAY.
4999 The value is one of the symbols `static-gray', `gray-scale',
5000 `static-color', `pseudo-color', `true-color', or `direct-color'.
5002 The optional argument DISPLAY specifies which display to ask about.
5003 DISPLAY should be either a frame or a display name (a string).
5004 If omitted or nil, that stands for the selected frame's display. */)
5005 (display)
5006 Lisp_Object display;
5008 struct x_display_info *dpyinfo = check_x_display_info (display);
5009 Lisp_Object result;
5011 switch (dpyinfo->visual->class)
5013 case StaticGray:
5014 result = intern ("static-gray");
5015 break;
5016 case GrayScale:
5017 result = intern ("gray-scale");
5018 break;
5019 case StaticColor:
5020 result = intern ("static-color");
5021 break;
5022 case PseudoColor:
5023 result = intern ("pseudo-color");
5024 break;
5025 case TrueColor:
5026 result = intern ("true-color");
5027 break;
5028 case DirectColor:
5029 result = intern ("direct-color");
5030 break;
5031 default:
5032 error ("Display has an unknown visual class");
5033 result = Qnil;
5036 return result;
5039 DEFUN ("x-display-save-under", Fx_display_save_under,
5040 Sx_display_save_under, 0, 1, 0,
5041 doc: /* Returns t if the X display DISPLAY supports the save-under feature.
5042 The optional argument DISPLAY specifies which display to ask about.
5043 DISPLAY should be either a frame or a display name (a string).
5044 If omitted or nil, that stands for the selected frame's display. */)
5045 (display)
5046 Lisp_Object display;
5048 struct x_display_info *dpyinfo = check_x_display_info (display);
5050 if (DoesSaveUnders (dpyinfo->screen) == True)
5051 return Qt;
5052 else
5053 return Qnil;
5057 x_pixel_width (f)
5058 register struct frame *f;
5060 return PIXEL_WIDTH (f);
5064 x_pixel_height (f)
5065 register struct frame *f;
5067 return PIXEL_HEIGHT (f);
5071 x_char_width (f)
5072 register struct frame *f;
5074 return FONT_WIDTH (f->output_data.x->font);
5078 x_char_height (f)
5079 register struct frame *f;
5081 return f->output_data.x->line_height;
5085 x_screen_planes (f)
5086 register struct frame *f;
5088 return FRAME_X_DISPLAY_INFO (f)->n_planes;
5093 /************************************************************************
5094 X Displays
5095 ************************************************************************/
5098 /* Mapping visual names to visuals. */
5100 static struct visual_class
5102 char *name;
5103 int class;
5105 visual_classes[] =
5107 {"StaticGray", StaticGray},
5108 {"GrayScale", GrayScale},
5109 {"StaticColor", StaticColor},
5110 {"PseudoColor", PseudoColor},
5111 {"TrueColor", TrueColor},
5112 {"DirectColor", DirectColor},
5113 {NULL, 0}
5117 #ifndef HAVE_XSCREENNUMBEROFSCREEN
5119 /* Value is the screen number of screen SCR. This is a substitute for
5120 the X function with the same name when that doesn't exist. */
5123 XScreenNumberOfScreen (scr)
5124 register Screen *scr;
5126 Display *dpy = scr->display;
5127 int i;
5129 for (i = 0; i < dpy->nscreens; ++i)
5130 if (scr == dpy->screens + i)
5131 break;
5133 return i;
5136 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
5139 /* Select the visual that should be used on display DPYINFO. Set
5140 members of DPYINFO appropriately. Called from x_term_init. */
5142 void
5143 select_visual (dpyinfo)
5144 struct x_display_info *dpyinfo;
5146 Display *dpy = dpyinfo->display;
5147 Screen *screen = dpyinfo->screen;
5148 Lisp_Object value;
5150 /* See if a visual is specified. */
5151 value = display_x_get_resource (dpyinfo,
5152 build_string ("visualClass"),
5153 build_string ("VisualClass"),
5154 Qnil, Qnil);
5155 if (STRINGP (value))
5157 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
5158 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
5159 depth, a decimal number. NAME is compared with case ignored. */
5160 char *s = (char *) alloca (SBYTES (value) + 1);
5161 char *dash;
5162 int i, class = -1;
5163 XVisualInfo vinfo;
5165 strcpy (s, SDATA (value));
5166 dash = index (s, '-');
5167 if (dash)
5169 dpyinfo->n_planes = atoi (dash + 1);
5170 *dash = '\0';
5172 else
5173 /* We won't find a matching visual with depth 0, so that
5174 an error will be printed below. */
5175 dpyinfo->n_planes = 0;
5177 /* Determine the visual class. */
5178 for (i = 0; visual_classes[i].name; ++i)
5179 if (xstricmp (s, visual_classes[i].name) == 0)
5181 class = visual_classes[i].class;
5182 break;
5185 /* Look up a matching visual for the specified class. */
5186 if (class == -1
5187 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
5188 dpyinfo->n_planes, class, &vinfo))
5189 fatal ("Invalid visual specification `%s'", SDATA (value));
5191 dpyinfo->visual = vinfo.visual;
5193 else
5195 int n_visuals;
5196 XVisualInfo *vinfo, vinfo_template;
5198 dpyinfo->visual = DefaultVisualOfScreen (screen);
5200 #ifdef HAVE_X11R4
5201 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
5202 #else
5203 vinfo_template.visualid = dpyinfo->visual->visualid;
5204 #endif
5205 vinfo_template.screen = XScreenNumberOfScreen (screen);
5206 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
5207 &vinfo_template, &n_visuals);
5208 if (n_visuals != 1)
5209 fatal ("Can't get proper X visual info");
5211 dpyinfo->n_planes = vinfo->depth;
5212 XFree ((char *) vinfo);
5217 /* Return the X display structure for the display named NAME.
5218 Open a new connection if necessary. */
5220 struct x_display_info *
5221 x_display_info_for_name (name)
5222 Lisp_Object name;
5224 Lisp_Object names;
5225 struct x_display_info *dpyinfo;
5227 CHECK_STRING (name);
5229 if (! EQ (Vwindow_system, intern ("x")))
5230 error ("Not using X Windows");
5232 for (dpyinfo = x_display_list, names = x_display_name_list;
5233 dpyinfo;
5234 dpyinfo = dpyinfo->next, names = XCDR (names))
5236 Lisp_Object tem;
5237 tem = Fstring_equal (XCAR (XCAR (names)), name);
5238 if (!NILP (tem))
5239 return dpyinfo;
5242 /* Use this general default value to start with. */
5243 Vx_resource_name = Vinvocation_name;
5245 validate_x_resource_name ();
5247 dpyinfo = x_term_init (name, (char *)0,
5248 (char *) SDATA (Vx_resource_name));
5250 if (dpyinfo == 0)
5251 error ("Cannot connect to X server %s", SDATA (name));
5253 x_in_use = 1;
5254 XSETFASTINT (Vwindow_system_version, 11);
5256 return dpyinfo;
5260 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5261 1, 3, 0,
5262 doc: /* Open a connection to an X server.
5263 DISPLAY is the name of the display to connect to.
5264 Optional second arg XRM-STRING is a string of resources in xrdb format.
5265 If the optional third arg MUST-SUCCEED is non-nil,
5266 terminate Emacs if we can't open the connection. */)
5267 (display, xrm_string, must_succeed)
5268 Lisp_Object display, xrm_string, must_succeed;
5270 unsigned char *xrm_option;
5271 struct x_display_info *dpyinfo;
5273 CHECK_STRING (display);
5274 if (! NILP (xrm_string))
5275 CHECK_STRING (xrm_string);
5277 if (! EQ (Vwindow_system, intern ("x")))
5278 error ("Not using X Windows");
5280 if (! NILP (xrm_string))
5281 xrm_option = (unsigned char *) SDATA (xrm_string);
5282 else
5283 xrm_option = (unsigned char *) 0;
5285 validate_x_resource_name ();
5287 /* This is what opens the connection and sets x_current_display.
5288 This also initializes many symbols, such as those used for input. */
5289 dpyinfo = x_term_init (display, xrm_option,
5290 (char *) SDATA (Vx_resource_name));
5292 if (dpyinfo == 0)
5294 if (!NILP (must_succeed))
5295 fatal ("Cannot connect to X server %s.\n\
5296 Check the DISPLAY environment variable or use `-d'.\n\
5297 Also use the `xauth' program to verify that you have the proper\n\
5298 authorization information needed to connect the X server.\n\
5299 An insecure way to solve the problem may be to use `xhost'.\n",
5300 SDATA (display));
5301 else
5302 error ("Cannot connect to X server %s", SDATA (display));
5305 x_in_use = 1;
5307 XSETFASTINT (Vwindow_system_version, 11);
5308 return Qnil;
5311 DEFUN ("x-close-connection", Fx_close_connection,
5312 Sx_close_connection, 1, 1, 0,
5313 doc: /* Close the connection to DISPLAY's X server.
5314 For DISPLAY, specify either a frame or a display name (a string).
5315 If DISPLAY is nil, that stands for the selected frame's display. */)
5316 (display)
5317 Lisp_Object display;
5319 struct x_display_info *dpyinfo = check_x_display_info (display);
5320 int i;
5322 if (dpyinfo->reference_count > 0)
5323 error ("Display still has frames on it");
5325 BLOCK_INPUT;
5326 /* Free the fonts in the font table. */
5327 for (i = 0; i < dpyinfo->n_fonts; i++)
5328 if (dpyinfo->font_table[i].name)
5330 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
5331 xfree (dpyinfo->font_table[i].full_name);
5332 xfree (dpyinfo->font_table[i].name);
5333 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
5336 x_destroy_all_bitmaps (dpyinfo);
5337 XSetCloseDownMode (dpyinfo->display, DestroyAll);
5339 #ifdef USE_X_TOOLKIT
5340 XtCloseDisplay (dpyinfo->display);
5341 #else
5342 XCloseDisplay (dpyinfo->display);
5343 #endif
5345 x_delete_display (dpyinfo);
5346 UNBLOCK_INPUT;
5348 return Qnil;
5351 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5352 doc: /* Return the list of display names that Emacs has connections to. */)
5355 Lisp_Object tail, result;
5357 result = Qnil;
5358 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
5359 result = Fcons (XCAR (XCAR (tail)), result);
5361 return result;
5364 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5365 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5366 If ON is nil, allow buffering of requests.
5367 Turning on synchronization prohibits the Xlib routines from buffering
5368 requests and seriously degrades performance, but makes debugging much
5369 easier.
5370 The optional second argument DISPLAY specifies which display to act on.
5371 DISPLAY should be either a frame or a display name (a string).
5372 If DISPLAY is omitted or nil, that stands for the selected frame's display. */)
5373 (on, display)
5374 Lisp_Object display, on;
5376 struct x_display_info *dpyinfo = check_x_display_info (display);
5378 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
5380 return Qnil;
5383 /* Wait for responses to all X commands issued so far for frame F. */
5385 void
5386 x_sync (f)
5387 FRAME_PTR f;
5389 BLOCK_INPUT;
5390 XSync (FRAME_X_DISPLAY (f), False);
5391 UNBLOCK_INPUT;
5395 /***********************************************************************
5396 Image types
5397 ***********************************************************************/
5399 /* Value is the number of elements of vector VECTOR. */
5401 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
5403 /* List of supported image types. Use define_image_type to add new
5404 types. Use lookup_image_type to find a type for a given symbol. */
5406 static struct image_type *image_types;
5408 /* The symbol `image' which is the car of the lists used to represent
5409 images in Lisp. */
5411 extern Lisp_Object Qimage;
5413 /* The symbol `xbm' which is used as the type symbol for XBM images. */
5415 Lisp_Object Qxbm;
5417 /* Keywords. */
5419 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
5420 extern Lisp_Object QCdata, QCtype;
5421 Lisp_Object QCascent, QCmargin, QCrelief;
5422 Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
5423 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
5425 /* Other symbols. */
5427 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
5429 /* Time in seconds after which images should be removed from the cache
5430 if not displayed. */
5432 Lisp_Object Vimage_cache_eviction_delay;
5434 /* Function prototypes. */
5436 static void define_image_type P_ ((struct image_type *type));
5437 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
5438 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
5439 static void x_laplace P_ ((struct frame *, struct image *));
5440 static void x_emboss P_ ((struct frame *, struct image *));
5441 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
5442 Lisp_Object));
5445 /* Define a new image type from TYPE. This adds a copy of TYPE to
5446 image_types and adds the symbol *TYPE->type to Vimage_types. */
5448 static void
5449 define_image_type (type)
5450 struct image_type *type;
5452 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
5453 The initialized data segment is read-only. */
5454 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
5455 bcopy (type, p, sizeof *p);
5456 p->next = image_types;
5457 image_types = p;
5458 Vimage_types = Fcons (*p->type, Vimage_types);
5462 /* Look up image type SYMBOL, and return a pointer to its image_type
5463 structure. Value is null if SYMBOL is not a known image type. */
5465 static INLINE struct image_type *
5466 lookup_image_type (symbol)
5467 Lisp_Object symbol;
5469 struct image_type *type;
5471 for (type = image_types; type; type = type->next)
5472 if (EQ (symbol, *type->type))
5473 break;
5475 return type;
5479 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
5480 valid image specification is a list whose car is the symbol
5481 `image', and whose rest is a property list. The property list must
5482 contain a value for key `:type'. That value must be the name of a
5483 supported image type. The rest of the property list depends on the
5484 image type. */
5487 valid_image_p (object)
5488 Lisp_Object object;
5490 int valid_p = 0;
5492 if (CONSP (object) && EQ (XCAR (object), Qimage))
5494 Lisp_Object tem;
5496 for (tem = XCDR (object); CONSP (tem); tem = XCDR (tem))
5497 if (EQ (XCAR (tem), QCtype))
5499 tem = XCDR (tem);
5500 if (CONSP (tem) && SYMBOLP (XCAR (tem)))
5502 struct image_type *type;
5503 type = lookup_image_type (XCAR (tem));
5504 if (type)
5505 valid_p = type->valid_p (object);
5508 break;
5512 return valid_p;
5516 /* Log error message with format string FORMAT and argument ARG.
5517 Signaling an error, e.g. when an image cannot be loaded, is not a
5518 good idea because this would interrupt redisplay, and the error
5519 message display would lead to another redisplay. This function
5520 therefore simply displays a message. */
5522 static void
5523 image_error (format, arg1, arg2)
5524 char *format;
5525 Lisp_Object arg1, arg2;
5527 add_to_log (format, arg1, arg2);
5532 /***********************************************************************
5533 Image specifications
5534 ***********************************************************************/
5536 enum image_value_type
5538 IMAGE_DONT_CHECK_VALUE_TYPE,
5539 IMAGE_STRING_VALUE,
5540 IMAGE_STRING_OR_NIL_VALUE,
5541 IMAGE_SYMBOL_VALUE,
5542 IMAGE_POSITIVE_INTEGER_VALUE,
5543 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
5544 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
5545 IMAGE_ASCENT_VALUE,
5546 IMAGE_INTEGER_VALUE,
5547 IMAGE_FUNCTION_VALUE,
5548 IMAGE_NUMBER_VALUE,
5549 IMAGE_BOOL_VALUE
5552 /* Structure used when parsing image specifications. */
5554 struct image_keyword
5556 /* Name of keyword. */
5557 char *name;
5559 /* The type of value allowed. */
5560 enum image_value_type type;
5562 /* Non-zero means key must be present. */
5563 int mandatory_p;
5565 /* Used to recognize duplicate keywords in a property list. */
5566 int count;
5568 /* The value that was found. */
5569 Lisp_Object value;
5573 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
5574 int, Lisp_Object));
5575 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
5578 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
5579 has the format (image KEYWORD VALUE ...). One of the keyword/
5580 value pairs must be `:type TYPE'. KEYWORDS is a vector of
5581 image_keywords structures of size NKEYWORDS describing other
5582 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
5584 static int
5585 parse_image_spec (spec, keywords, nkeywords, type)
5586 Lisp_Object spec;
5587 struct image_keyword *keywords;
5588 int nkeywords;
5589 Lisp_Object type;
5591 int i;
5592 Lisp_Object plist;
5594 if (!CONSP (spec) || !EQ (XCAR (spec), Qimage))
5595 return 0;
5597 plist = XCDR (spec);
5598 while (CONSP (plist))
5600 Lisp_Object key, value;
5602 /* First element of a pair must be a symbol. */
5603 key = XCAR (plist);
5604 plist = XCDR (plist);
5605 if (!SYMBOLP (key))
5606 return 0;
5608 /* There must follow a value. */
5609 if (!CONSP (plist))
5610 return 0;
5611 value = XCAR (plist);
5612 plist = XCDR (plist);
5614 /* Find key in KEYWORDS. Error if not found. */
5615 for (i = 0; i < nkeywords; ++i)
5616 if (strcmp (keywords[i].name, SDATA (SYMBOL_NAME (key))) == 0)
5617 break;
5619 if (i == nkeywords)
5620 continue;
5622 /* Record that we recognized the keyword. If a keywords
5623 was found more than once, it's an error. */
5624 keywords[i].value = value;
5625 ++keywords[i].count;
5627 if (keywords[i].count > 1)
5628 return 0;
5630 /* Check type of value against allowed type. */
5631 switch (keywords[i].type)
5633 case IMAGE_STRING_VALUE:
5634 if (!STRINGP (value))
5635 return 0;
5636 break;
5638 case IMAGE_STRING_OR_NIL_VALUE:
5639 if (!STRINGP (value) && !NILP (value))
5640 return 0;
5641 break;
5643 case IMAGE_SYMBOL_VALUE:
5644 if (!SYMBOLP (value))
5645 return 0;
5646 break;
5648 case IMAGE_POSITIVE_INTEGER_VALUE:
5649 if (!INTEGERP (value) || XINT (value) <= 0)
5650 return 0;
5651 break;
5653 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
5654 if (INTEGERP (value) && XINT (value) >= 0)
5655 break;
5656 if (CONSP (value)
5657 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
5658 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
5659 break;
5660 return 0;
5662 case IMAGE_ASCENT_VALUE:
5663 if (SYMBOLP (value) && EQ (value, Qcenter))
5664 break;
5665 else if (INTEGERP (value)
5666 && XINT (value) >= 0
5667 && XINT (value) <= 100)
5668 break;
5669 return 0;
5671 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
5672 if (!INTEGERP (value) || XINT (value) < 0)
5673 return 0;
5674 break;
5676 case IMAGE_DONT_CHECK_VALUE_TYPE:
5677 break;
5679 case IMAGE_FUNCTION_VALUE:
5680 value = indirect_function (value);
5681 if (SUBRP (value)
5682 || COMPILEDP (value)
5683 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
5684 break;
5685 return 0;
5687 case IMAGE_NUMBER_VALUE:
5688 if (!INTEGERP (value) && !FLOATP (value))
5689 return 0;
5690 break;
5692 case IMAGE_INTEGER_VALUE:
5693 if (!INTEGERP (value))
5694 return 0;
5695 break;
5697 case IMAGE_BOOL_VALUE:
5698 if (!NILP (value) && !EQ (value, Qt))
5699 return 0;
5700 break;
5702 default:
5703 abort ();
5704 break;
5707 if (EQ (key, QCtype) && !EQ (type, value))
5708 return 0;
5711 /* Check that all mandatory fields are present. */
5712 for (i = 0; i < nkeywords; ++i)
5713 if (keywords[i].mandatory_p && keywords[i].count == 0)
5714 return 0;
5716 return NILP (plist);
5720 /* Return the value of KEY in image specification SPEC. Value is nil
5721 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
5722 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
5724 static Lisp_Object
5725 image_spec_value (spec, key, found)
5726 Lisp_Object spec, key;
5727 int *found;
5729 Lisp_Object tail;
5731 xassert (valid_image_p (spec));
5733 for (tail = XCDR (spec);
5734 CONSP (tail) && CONSP (XCDR (tail));
5735 tail = XCDR (XCDR (tail)))
5737 if (EQ (XCAR (tail), key))
5739 if (found)
5740 *found = 1;
5741 return XCAR (XCDR (tail));
5745 if (found)
5746 *found = 0;
5747 return Qnil;
5751 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
5752 doc: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
5753 PIXELS non-nil means return the size in pixels, otherwise return the
5754 size in canonical character units.
5755 FRAME is the frame on which the image will be displayed. FRAME nil
5756 or omitted means use the selected frame. */)
5757 (spec, pixels, frame)
5758 Lisp_Object spec, pixels, frame;
5760 Lisp_Object size;
5762 size = Qnil;
5763 if (valid_image_p (spec))
5765 struct frame *f = check_x_frame (frame);
5766 int id = lookup_image (f, spec);
5767 struct image *img = IMAGE_FROM_ID (f, id);
5768 int width = img->width + 2 * img->hmargin;
5769 int height = img->height + 2 * img->vmargin;
5771 if (NILP (pixels))
5772 size = Fcons (make_float ((double) width / CANON_X_UNIT (f)),
5773 make_float ((double) height / CANON_Y_UNIT (f)));
5774 else
5775 size = Fcons (make_number (width), make_number (height));
5777 else
5778 error ("Invalid image specification");
5780 return size;
5784 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
5785 doc: /* Return t if image SPEC has a mask bitmap.
5786 FRAME is the frame on which the image will be displayed. FRAME nil
5787 or omitted means use the selected frame. */)
5788 (spec, frame)
5789 Lisp_Object spec, frame;
5791 Lisp_Object mask;
5793 mask = Qnil;
5794 if (valid_image_p (spec))
5796 struct frame *f = check_x_frame (frame);
5797 int id = lookup_image (f, spec);
5798 struct image *img = IMAGE_FROM_ID (f, id);
5799 if (img->mask)
5800 mask = Qt;
5802 else
5803 error ("Invalid image specification");
5805 return mask;
5810 /***********************************************************************
5811 Image type independent image structures
5812 ***********************************************************************/
5814 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
5815 static void free_image P_ ((struct frame *f, struct image *img));
5818 /* Allocate and return a new image structure for image specification
5819 SPEC. SPEC has a hash value of HASH. */
5821 static struct image *
5822 make_image (spec, hash)
5823 Lisp_Object spec;
5824 unsigned hash;
5826 struct image *img = (struct image *) xmalloc (sizeof *img);
5828 xassert (valid_image_p (spec));
5829 bzero (img, sizeof *img);
5830 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
5831 xassert (img->type != NULL);
5832 img->spec = spec;
5833 img->data.lisp_val = Qnil;
5834 img->ascent = DEFAULT_IMAGE_ASCENT;
5835 img->hash = hash;
5836 return img;
5840 /* Free image IMG which was used on frame F, including its resources. */
5842 static void
5843 free_image (f, img)
5844 struct frame *f;
5845 struct image *img;
5847 if (img)
5849 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5851 /* Remove IMG from the hash table of its cache. */
5852 if (img->prev)
5853 img->prev->next = img->next;
5854 else
5855 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
5857 if (img->next)
5858 img->next->prev = img->prev;
5860 c->images[img->id] = NULL;
5862 /* Free resources, then free IMG. */
5863 img->type->free (f, img);
5864 xfree (img);
5869 /* Prepare image IMG for display on frame F. Must be called before
5870 drawing an image. */
5872 void
5873 prepare_image_for_display (f, img)
5874 struct frame *f;
5875 struct image *img;
5877 EMACS_TIME t;
5879 /* We're about to display IMG, so set its timestamp to `now'. */
5880 EMACS_GET_TIME (t);
5881 img->timestamp = EMACS_SECS (t);
5883 /* If IMG doesn't have a pixmap yet, load it now, using the image
5884 type dependent loader function. */
5885 if (img->pixmap == None && !img->load_failed_p)
5886 img->load_failed_p = img->type->load (f, img) == 0;
5890 /* Value is the number of pixels for the ascent of image IMG when
5891 drawn in face FACE. */
5894 image_ascent (img, face)
5895 struct image *img;
5896 struct face *face;
5898 int height = img->height + img->vmargin;
5899 int ascent;
5901 if (img->ascent == CENTERED_IMAGE_ASCENT)
5903 if (face->font)
5904 /* This expression is arranged so that if the image can't be
5905 exactly centered, it will be moved slightly up. This is
5906 because a typical font is `top-heavy' (due to the presence
5907 uppercase letters), so the image placement should err towards
5908 being top-heavy too. It also just generally looks better. */
5909 ascent = (height + face->font->ascent - face->font->descent + 1) / 2;
5910 else
5911 ascent = height / 2;
5913 else
5914 ascent = height * img->ascent / 100.0;
5916 return ascent;
5920 /* Image background colors. */
5922 static unsigned long
5923 four_corners_best (ximg, width, height)
5924 XImage *ximg;
5925 unsigned long width, height;
5927 unsigned long corners[4], best;
5928 int i, best_count;
5930 /* Get the colors at the corners of ximg. */
5931 corners[0] = XGetPixel (ximg, 0, 0);
5932 corners[1] = XGetPixel (ximg, width - 1, 0);
5933 corners[2] = XGetPixel (ximg, width - 1, height - 1);
5934 corners[3] = XGetPixel (ximg, 0, height - 1);
5936 /* Choose the most frequently found color as background. */
5937 for (i = best_count = 0; i < 4; ++i)
5939 int j, n;
5941 for (j = n = 0; j < 4; ++j)
5942 if (corners[i] == corners[j])
5943 ++n;
5945 if (n > best_count)
5946 best = corners[i], best_count = n;
5949 return best;
5952 /* Return the `background' field of IMG. If IMG doesn't have one yet,
5953 it is guessed heuristically. If non-zero, XIMG is an existing XImage
5954 object to use for the heuristic. */
5956 unsigned long
5957 image_background (img, f, ximg)
5958 struct image *img;
5959 struct frame *f;
5960 XImage *ximg;
5962 if (! img->background_valid)
5963 /* IMG doesn't have a background yet, try to guess a reasonable value. */
5965 int free_ximg = !ximg;
5967 if (! ximg)
5968 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
5969 0, 0, img->width, img->height, ~0, ZPixmap);
5971 img->background = four_corners_best (ximg, img->width, img->height);
5973 if (free_ximg)
5974 XDestroyImage (ximg);
5976 img->background_valid = 1;
5979 return img->background;
5982 /* Return the `background_transparent' field of IMG. If IMG doesn't
5983 have one yet, it is guessed heuristically. If non-zero, MASK is an
5984 existing XImage object to use for the heuristic. */
5987 image_background_transparent (img, f, mask)
5988 struct image *img;
5989 struct frame *f;
5990 XImage *mask;
5992 if (! img->background_transparent_valid)
5993 /* IMG doesn't have a background yet, try to guess a reasonable value. */
5995 if (img->mask)
5997 int free_mask = !mask;
5999 if (! mask)
6000 mask = XGetImage (FRAME_X_DISPLAY (f), img->mask,
6001 0, 0, img->width, img->height, ~0, ZPixmap);
6003 img->background_transparent
6004 = !four_corners_best (mask, img->width, img->height);
6006 if (free_mask)
6007 XDestroyImage (mask);
6009 else
6010 img->background_transparent = 0;
6012 img->background_transparent_valid = 1;
6015 return img->background_transparent;
6019 /***********************************************************************
6020 Helper functions for X image types
6021 ***********************************************************************/
6023 static void x_clear_image_1 P_ ((struct frame *, struct image *, int,
6024 int, int));
6025 static void x_clear_image P_ ((struct frame *f, struct image *img));
6026 static unsigned long x_alloc_image_color P_ ((struct frame *f,
6027 struct image *img,
6028 Lisp_Object color_name,
6029 unsigned long dflt));
6032 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
6033 free the pixmap if any. MASK_P non-zero means clear the mask
6034 pixmap if any. COLORS_P non-zero means free colors allocated for
6035 the image, if any. */
6037 static void
6038 x_clear_image_1 (f, img, pixmap_p, mask_p, colors_p)
6039 struct frame *f;
6040 struct image *img;
6041 int pixmap_p, mask_p, colors_p;
6043 if (pixmap_p && img->pixmap)
6045 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
6046 img->pixmap = None;
6047 img->background_valid = 0;
6050 if (mask_p && img->mask)
6052 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
6053 img->mask = None;
6054 img->background_transparent_valid = 0;
6057 if (colors_p && img->ncolors)
6059 x_free_colors (f, img->colors, img->ncolors);
6060 xfree (img->colors);
6061 img->colors = NULL;
6062 img->ncolors = 0;
6066 /* Free X resources of image IMG which is used on frame F. */
6068 static void
6069 x_clear_image (f, img)
6070 struct frame *f;
6071 struct image *img;
6073 BLOCK_INPUT;
6074 x_clear_image_1 (f, img, 1, 1, 1);
6075 UNBLOCK_INPUT;
6079 /* Allocate color COLOR_NAME for image IMG on frame F. If color
6080 cannot be allocated, use DFLT. Add a newly allocated color to
6081 IMG->colors, so that it can be freed again. Value is the pixel
6082 color. */
6084 static unsigned long
6085 x_alloc_image_color (f, img, color_name, dflt)
6086 struct frame *f;
6087 struct image *img;
6088 Lisp_Object color_name;
6089 unsigned long dflt;
6091 XColor color;
6092 unsigned long result;
6094 xassert (STRINGP (color_name));
6096 if (x_defined_color (f, SDATA (color_name), &color, 1))
6098 /* This isn't called frequently so we get away with simply
6099 reallocating the color vector to the needed size, here. */
6100 ++img->ncolors;
6101 img->colors =
6102 (unsigned long *) xrealloc (img->colors,
6103 img->ncolors * sizeof *img->colors);
6104 img->colors[img->ncolors - 1] = color.pixel;
6105 result = color.pixel;
6107 else
6108 result = dflt;
6110 return result;
6115 /***********************************************************************
6116 Image Cache
6117 ***********************************************************************/
6119 static void cache_image P_ ((struct frame *f, struct image *img));
6120 static void postprocess_image P_ ((struct frame *, struct image *));
6123 /* Return a new, initialized image cache that is allocated from the
6124 heap. Call free_image_cache to free an image cache. */
6126 struct image_cache *
6127 make_image_cache ()
6129 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
6130 int size;
6132 bzero (c, sizeof *c);
6133 c->size = 50;
6134 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
6135 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
6136 c->buckets = (struct image **) xmalloc (size);
6137 bzero (c->buckets, size);
6138 return c;
6142 /* Free image cache of frame F. Be aware that X frames share images
6143 caches. */
6145 void
6146 free_image_cache (f)
6147 struct frame *f;
6149 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6150 if (c)
6152 int i;
6154 /* Cache should not be referenced by any frame when freed. */
6155 xassert (c->refcount == 0);
6157 for (i = 0; i < c->used; ++i)
6158 free_image (f, c->images[i]);
6159 xfree (c->images);
6160 xfree (c->buckets);
6161 xfree (c);
6162 FRAME_X_IMAGE_CACHE (f) = NULL;
6167 /* Clear image cache of frame F. FORCE_P non-zero means free all
6168 images. FORCE_P zero means clear only images that haven't been
6169 displayed for some time. Should be called from time to time to
6170 reduce the number of loaded images. If image-eviction-seconds is
6171 non-nil, this frees images in the cache which weren't displayed for
6172 at least that many seconds. */
6174 void
6175 clear_image_cache (f, force_p)
6176 struct frame *f;
6177 int force_p;
6179 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6181 if (c && INTEGERP (Vimage_cache_eviction_delay))
6183 EMACS_TIME t;
6184 unsigned long old;
6185 int i, nfreed;
6187 EMACS_GET_TIME (t);
6188 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
6190 /* Block input so that we won't be interrupted by a SIGIO
6191 while being in an inconsistent state. */
6192 BLOCK_INPUT;
6194 for (i = nfreed = 0; i < c->used; ++i)
6196 struct image *img = c->images[i];
6197 if (img != NULL
6198 && (force_p || img->timestamp < old))
6200 free_image (f, img);
6201 ++nfreed;
6205 /* We may be clearing the image cache because, for example,
6206 Emacs was iconified for a longer period of time. In that
6207 case, current matrices may still contain references to
6208 images freed above. So, clear these matrices. */
6209 if (nfreed)
6211 Lisp_Object tail, frame;
6213 FOR_EACH_FRAME (tail, frame)
6215 struct frame *f = XFRAME (frame);
6216 if (FRAME_X_P (f)
6217 && FRAME_X_IMAGE_CACHE (f) == c)
6218 clear_current_matrices (f);
6221 ++windows_or_buffers_changed;
6224 UNBLOCK_INPUT;
6229 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
6230 0, 1, 0,
6231 doc: /* Clear the image cache of FRAME.
6232 FRAME nil or omitted means use the selected frame.
6233 FRAME t means clear the image caches of all frames. */)
6234 (frame)
6235 Lisp_Object frame;
6237 if (EQ (frame, Qt))
6239 Lisp_Object tail;
6241 FOR_EACH_FRAME (tail, frame)
6242 if (FRAME_X_P (XFRAME (frame)))
6243 clear_image_cache (XFRAME (frame), 1);
6245 else
6246 clear_image_cache (check_x_frame (frame), 1);
6248 return Qnil;
6252 /* Compute masks and transform image IMG on frame F, as specified
6253 by the image's specification, */
6255 static void
6256 postprocess_image (f, img)
6257 struct frame *f;
6258 struct image *img;
6260 /* Manipulation of the image's mask. */
6261 if (img->pixmap)
6263 Lisp_Object conversion, spec;
6264 Lisp_Object mask;
6266 spec = img->spec;
6268 /* `:heuristic-mask t'
6269 `:mask heuristic'
6270 means build a mask heuristically.
6271 `:heuristic-mask (R G B)'
6272 `:mask (heuristic (R G B))'
6273 means build a mask from color (R G B) in the
6274 image.
6275 `:mask nil'
6276 means remove a mask, if any. */
6278 mask = image_spec_value (spec, QCheuristic_mask, NULL);
6279 if (!NILP (mask))
6280 x_build_heuristic_mask (f, img, mask);
6281 else
6283 int found_p;
6285 mask = image_spec_value (spec, QCmask, &found_p);
6287 if (EQ (mask, Qheuristic))
6288 x_build_heuristic_mask (f, img, Qt);
6289 else if (CONSP (mask)
6290 && EQ (XCAR (mask), Qheuristic))
6292 if (CONSP (XCDR (mask)))
6293 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
6294 else
6295 x_build_heuristic_mask (f, img, XCDR (mask));
6297 else if (NILP (mask) && found_p && img->mask)
6299 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
6300 img->mask = None;
6305 /* Should we apply an image transformation algorithm? */
6306 conversion = image_spec_value (spec, QCconversion, NULL);
6307 if (EQ (conversion, Qdisabled))
6308 x_disable_image (f, img);
6309 else if (EQ (conversion, Qlaplace))
6310 x_laplace (f, img);
6311 else if (EQ (conversion, Qemboss))
6312 x_emboss (f, img);
6313 else if (CONSP (conversion)
6314 && EQ (XCAR (conversion), Qedge_detection))
6316 Lisp_Object tem;
6317 tem = XCDR (conversion);
6318 if (CONSP (tem))
6319 x_edge_detection (f, img,
6320 Fplist_get (tem, QCmatrix),
6321 Fplist_get (tem, QCcolor_adjustment));
6327 /* Return the id of image with Lisp specification SPEC on frame F.
6328 SPEC must be a valid Lisp image specification (see valid_image_p). */
6331 lookup_image (f, spec)
6332 struct frame *f;
6333 Lisp_Object spec;
6335 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6336 struct image *img;
6337 int i;
6338 unsigned hash;
6339 struct gcpro gcpro1;
6340 EMACS_TIME now;
6342 /* F must be a window-system frame, and SPEC must be a valid image
6343 specification. */
6344 xassert (FRAME_WINDOW_P (f));
6345 xassert (valid_image_p (spec));
6347 GCPRO1 (spec);
6349 /* Look up SPEC in the hash table of the image cache. */
6350 hash = sxhash (spec, 0);
6351 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
6353 for (img = c->buckets[i]; img; img = img->next)
6354 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
6355 break;
6357 /* If not found, create a new image and cache it. */
6358 if (img == NULL)
6360 extern Lisp_Object Qpostscript;
6362 BLOCK_INPUT;
6363 img = make_image (spec, hash);
6364 cache_image (f, img);
6365 img->load_failed_p = img->type->load (f, img) == 0;
6367 /* If we can't load the image, and we don't have a width and
6368 height, use some arbitrary width and height so that we can
6369 draw a rectangle for it. */
6370 if (img->load_failed_p)
6372 Lisp_Object value;
6374 value = image_spec_value (spec, QCwidth, NULL);
6375 img->width = (INTEGERP (value)
6376 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
6377 value = image_spec_value (spec, QCheight, NULL);
6378 img->height = (INTEGERP (value)
6379 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
6381 else
6383 /* Handle image type independent image attributes
6384 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
6385 `:background COLOR'. */
6386 Lisp_Object ascent, margin, relief, bg;
6388 ascent = image_spec_value (spec, QCascent, NULL);
6389 if (INTEGERP (ascent))
6390 img->ascent = XFASTINT (ascent);
6391 else if (EQ (ascent, Qcenter))
6392 img->ascent = CENTERED_IMAGE_ASCENT;
6394 margin = image_spec_value (spec, QCmargin, NULL);
6395 if (INTEGERP (margin) && XINT (margin) >= 0)
6396 img->vmargin = img->hmargin = XFASTINT (margin);
6397 else if (CONSP (margin) && INTEGERP (XCAR (margin))
6398 && INTEGERP (XCDR (margin)))
6400 if (XINT (XCAR (margin)) > 0)
6401 img->hmargin = XFASTINT (XCAR (margin));
6402 if (XINT (XCDR (margin)) > 0)
6403 img->vmargin = XFASTINT (XCDR (margin));
6406 relief = image_spec_value (spec, QCrelief, NULL);
6407 if (INTEGERP (relief))
6409 img->relief = XINT (relief);
6410 img->hmargin += abs (img->relief);
6411 img->vmargin += abs (img->relief);
6414 if (! img->background_valid)
6416 bg = image_spec_value (img->spec, QCbackground, NULL);
6417 if (!NILP (bg))
6419 img->background
6420 = x_alloc_image_color (f, img, bg,
6421 FRAME_BACKGROUND_PIXEL (f));
6422 img->background_valid = 1;
6426 /* Do image transformations and compute masks, unless we
6427 don't have the image yet. */
6428 if (!EQ (*img->type->type, Qpostscript))
6429 postprocess_image (f, img);
6432 UNBLOCK_INPUT;
6433 xassert (!interrupt_input_blocked);
6436 /* We're using IMG, so set its timestamp to `now'. */
6437 EMACS_GET_TIME (now);
6438 img->timestamp = EMACS_SECS (now);
6440 UNGCPRO;
6442 /* Value is the image id. */
6443 return img->id;
6447 /* Cache image IMG in the image cache of frame F. */
6449 static void
6450 cache_image (f, img)
6451 struct frame *f;
6452 struct image *img;
6454 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6455 int i;
6457 /* Find a free slot in c->images. */
6458 for (i = 0; i < c->used; ++i)
6459 if (c->images[i] == NULL)
6460 break;
6462 /* If no free slot found, maybe enlarge c->images. */
6463 if (i == c->used && c->used == c->size)
6465 c->size *= 2;
6466 c->images = (struct image **) xrealloc (c->images,
6467 c->size * sizeof *c->images);
6470 /* Add IMG to c->images, and assign IMG an id. */
6471 c->images[i] = img;
6472 img->id = i;
6473 if (i == c->used)
6474 ++c->used;
6476 /* Add IMG to the cache's hash table. */
6477 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
6478 img->next = c->buckets[i];
6479 if (img->next)
6480 img->next->prev = img;
6481 img->prev = NULL;
6482 c->buckets[i] = img;
6486 /* Call FN on every image in the image cache of frame F. Used to mark
6487 Lisp Objects in the image cache. */
6489 void
6490 forall_images_in_image_cache (f, fn)
6491 struct frame *f;
6492 void (*fn) P_ ((struct image *img));
6494 if (FRAME_LIVE_P (f) && FRAME_X_P (f))
6496 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6497 if (c)
6499 int i;
6500 for (i = 0; i < c->used; ++i)
6501 if (c->images[i])
6502 fn (c->images[i]);
6509 /***********************************************************************
6510 X support code
6511 ***********************************************************************/
6513 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
6514 XImage **, Pixmap *));
6515 static void x_destroy_x_image P_ ((XImage *));
6516 static void x_put_x_image P_ ((struct frame *, XImage *, Pixmap, int, int));
6519 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
6520 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
6521 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
6522 via xmalloc. Print error messages via image_error if an error
6523 occurs. Value is non-zero if successful. */
6525 static int
6526 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
6527 struct frame *f;
6528 int width, height, depth;
6529 XImage **ximg;
6530 Pixmap *pixmap;
6532 Display *display = FRAME_X_DISPLAY (f);
6533 Screen *screen = FRAME_X_SCREEN (f);
6534 Window window = FRAME_X_WINDOW (f);
6536 xassert (interrupt_input_blocked);
6538 if (depth <= 0)
6539 depth = DefaultDepthOfScreen (screen);
6540 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
6541 depth, ZPixmap, 0, NULL, width, height,
6542 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
6543 if (*ximg == NULL)
6545 image_error ("Unable to allocate X image", Qnil, Qnil);
6546 return 0;
6549 /* Allocate image raster. */
6550 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
6552 /* Allocate a pixmap of the same size. */
6553 *pixmap = XCreatePixmap (display, window, width, height, depth);
6554 if (*pixmap == None)
6556 x_destroy_x_image (*ximg);
6557 *ximg = NULL;
6558 image_error ("Unable to create X pixmap", Qnil, Qnil);
6559 return 0;
6562 return 1;
6566 /* Destroy XImage XIMG. Free XIMG->data. */
6568 static void
6569 x_destroy_x_image (ximg)
6570 XImage *ximg;
6572 xassert (interrupt_input_blocked);
6573 if (ximg)
6575 xfree (ximg->data);
6576 ximg->data = NULL;
6577 XDestroyImage (ximg);
6582 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
6583 are width and height of both the image and pixmap. */
6585 static void
6586 x_put_x_image (f, ximg, pixmap, width, height)
6587 struct frame *f;
6588 XImage *ximg;
6589 Pixmap pixmap;
6591 GC gc;
6593 xassert (interrupt_input_blocked);
6594 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
6595 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
6596 XFreeGC (FRAME_X_DISPLAY (f), gc);
6601 /***********************************************************************
6602 File Handling
6603 ***********************************************************************/
6605 static Lisp_Object x_find_image_file P_ ((Lisp_Object));
6606 static char *slurp_file P_ ((char *, int *));
6609 /* Find image file FILE. Look in data-directory, then
6610 x-bitmap-file-path. Value is the full name of the file found, or
6611 nil if not found. */
6613 static Lisp_Object
6614 x_find_image_file (file)
6615 Lisp_Object file;
6617 Lisp_Object file_found, search_path;
6618 struct gcpro gcpro1, gcpro2;
6619 int fd;
6621 file_found = Qnil;
6622 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
6623 GCPRO2 (file_found, search_path);
6625 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
6626 fd = openp (search_path, file, Qnil, &file_found, Qnil);
6628 if (fd == -1)
6629 file_found = Qnil;
6630 else
6631 close (fd);
6633 UNGCPRO;
6634 return file_found;
6638 /* Read FILE into memory. Value is a pointer to a buffer allocated
6639 with xmalloc holding FILE's contents. Value is null if an error
6640 occurred. *SIZE is set to the size of the file. */
6642 static char *
6643 slurp_file (file, size)
6644 char *file;
6645 int *size;
6647 FILE *fp = NULL;
6648 char *buf = NULL;
6649 struct stat st;
6651 if (stat (file, &st) == 0
6652 && (fp = fopen (file, "r")) != NULL
6653 && (buf = (char *) xmalloc (st.st_size),
6654 fread (buf, 1, st.st_size, fp) == st.st_size))
6656 *size = st.st_size;
6657 fclose (fp);
6659 else
6661 if (fp)
6662 fclose (fp);
6663 if (buf)
6665 xfree (buf);
6666 buf = NULL;
6670 return buf;
6675 /***********************************************************************
6676 XBM images
6677 ***********************************************************************/
6679 static int xbm_scan P_ ((char **, char *, char *, int *));
6680 static int xbm_load P_ ((struct frame *f, struct image *img));
6681 static int xbm_load_image P_ ((struct frame *f, struct image *img,
6682 char *, char *));
6683 static int xbm_image_p P_ ((Lisp_Object object));
6684 static int xbm_read_bitmap_data P_ ((char *, char *, int *, int *,
6685 unsigned char **));
6686 static int xbm_file_p P_ ((Lisp_Object));
6689 /* Indices of image specification fields in xbm_format, below. */
6691 enum xbm_keyword_index
6693 XBM_TYPE,
6694 XBM_FILE,
6695 XBM_WIDTH,
6696 XBM_HEIGHT,
6697 XBM_DATA,
6698 XBM_FOREGROUND,
6699 XBM_BACKGROUND,
6700 XBM_ASCENT,
6701 XBM_MARGIN,
6702 XBM_RELIEF,
6703 XBM_ALGORITHM,
6704 XBM_HEURISTIC_MASK,
6705 XBM_MASK,
6706 XBM_LAST
6709 /* Vector of image_keyword structures describing the format
6710 of valid XBM image specifications. */
6712 static struct image_keyword xbm_format[XBM_LAST] =
6714 {":type", IMAGE_SYMBOL_VALUE, 1},
6715 {":file", IMAGE_STRING_VALUE, 0},
6716 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6717 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6718 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6719 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
6720 {":background", IMAGE_STRING_OR_NIL_VALUE, 0},
6721 {":ascent", IMAGE_ASCENT_VALUE, 0},
6722 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6723 {":relief", IMAGE_INTEGER_VALUE, 0},
6724 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6725 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6726 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
6729 /* Structure describing the image type XBM. */
6731 static struct image_type xbm_type =
6733 &Qxbm,
6734 xbm_image_p,
6735 xbm_load,
6736 x_clear_image,
6737 NULL
6740 /* Tokens returned from xbm_scan. */
6742 enum xbm_token
6744 XBM_TK_IDENT = 256,
6745 XBM_TK_NUMBER
6749 /* Return non-zero if OBJECT is a valid XBM-type image specification.
6750 A valid specification is a list starting with the symbol `image'
6751 The rest of the list is a property list which must contain an
6752 entry `:type xbm..
6754 If the specification specifies a file to load, it must contain
6755 an entry `:file FILENAME' where FILENAME is a string.
6757 If the specification is for a bitmap loaded from memory it must
6758 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
6759 WIDTH and HEIGHT are integers > 0. DATA may be:
6761 1. a string large enough to hold the bitmap data, i.e. it must
6762 have a size >= (WIDTH + 7) / 8 * HEIGHT
6764 2. a bool-vector of size >= WIDTH * HEIGHT
6766 3. a vector of strings or bool-vectors, one for each line of the
6767 bitmap.
6769 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
6770 may not be specified in this case because they are defined in the
6771 XBM file.
6773 Both the file and data forms may contain the additional entries
6774 `:background COLOR' and `:foreground COLOR'. If not present,
6775 foreground and background of the frame on which the image is
6776 displayed is used. */
6778 static int
6779 xbm_image_p (object)
6780 Lisp_Object object;
6782 struct image_keyword kw[XBM_LAST];
6784 bcopy (xbm_format, kw, sizeof kw);
6785 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
6786 return 0;
6788 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
6790 if (kw[XBM_FILE].count)
6792 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
6793 return 0;
6795 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
6797 /* In-memory XBM file. */
6798 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
6799 return 0;
6801 else
6803 Lisp_Object data;
6804 int width, height;
6806 /* Entries for `:width', `:height' and `:data' must be present. */
6807 if (!kw[XBM_WIDTH].count
6808 || !kw[XBM_HEIGHT].count
6809 || !kw[XBM_DATA].count)
6810 return 0;
6812 data = kw[XBM_DATA].value;
6813 width = XFASTINT (kw[XBM_WIDTH].value);
6814 height = XFASTINT (kw[XBM_HEIGHT].value);
6816 /* Check type of data, and width and height against contents of
6817 data. */
6818 if (VECTORP (data))
6820 int i;
6822 /* Number of elements of the vector must be >= height. */
6823 if (XVECTOR (data)->size < height)
6824 return 0;
6826 /* Each string or bool-vector in data must be large enough
6827 for one line of the image. */
6828 for (i = 0; i < height; ++i)
6830 Lisp_Object elt = XVECTOR (data)->contents[i];
6832 if (STRINGP (elt))
6834 if (SCHARS (elt)
6835 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
6836 return 0;
6838 else if (BOOL_VECTOR_P (elt))
6840 if (XBOOL_VECTOR (elt)->size < width)
6841 return 0;
6843 else
6844 return 0;
6847 else if (STRINGP (data))
6849 if (SCHARS (data)
6850 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
6851 return 0;
6853 else if (BOOL_VECTOR_P (data))
6855 if (XBOOL_VECTOR (data)->size < width * height)
6856 return 0;
6858 else
6859 return 0;
6862 return 1;
6866 /* Scan a bitmap file. FP is the stream to read from. Value is
6867 either an enumerator from enum xbm_token, or a character for a
6868 single-character token, or 0 at end of file. If scanning an
6869 identifier, store the lexeme of the identifier in SVAL. If
6870 scanning a number, store its value in *IVAL. */
6872 static int
6873 xbm_scan (s, end, sval, ival)
6874 char **s, *end;
6875 char *sval;
6876 int *ival;
6878 int c;
6880 loop:
6882 /* Skip white space. */
6883 while (*s < end && (c = *(*s)++, isspace (c)))
6886 if (*s >= end)
6887 c = 0;
6888 else if (isdigit (c))
6890 int value = 0, digit;
6892 if (c == '0' && *s < end)
6894 c = *(*s)++;
6895 if (c == 'x' || c == 'X')
6897 while (*s < end)
6899 c = *(*s)++;
6900 if (isdigit (c))
6901 digit = c - '0';
6902 else if (c >= 'a' && c <= 'f')
6903 digit = c - 'a' + 10;
6904 else if (c >= 'A' && c <= 'F')
6905 digit = c - 'A' + 10;
6906 else
6907 break;
6908 value = 16 * value + digit;
6911 else if (isdigit (c))
6913 value = c - '0';
6914 while (*s < end
6915 && (c = *(*s)++, isdigit (c)))
6916 value = 8 * value + c - '0';
6919 else
6921 value = c - '0';
6922 while (*s < end
6923 && (c = *(*s)++, isdigit (c)))
6924 value = 10 * value + c - '0';
6927 if (*s < end)
6928 *s = *s - 1;
6929 *ival = value;
6930 c = XBM_TK_NUMBER;
6932 else if (isalpha (c) || c == '_')
6934 *sval++ = c;
6935 while (*s < end
6936 && (c = *(*s)++, (isalnum (c) || c == '_')))
6937 *sval++ = c;
6938 *sval = 0;
6939 if (*s < end)
6940 *s = *s - 1;
6941 c = XBM_TK_IDENT;
6943 else if (c == '/' && **s == '*')
6945 /* C-style comment. */
6946 ++*s;
6947 while (**s && (**s != '*' || *(*s + 1) != '/'))
6948 ++*s;
6949 if (**s)
6951 *s += 2;
6952 goto loop;
6956 return c;
6960 /* Replacement for XReadBitmapFileData which isn't available under old
6961 X versions. CONTENTS is a pointer to a buffer to parse; END is the
6962 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
6963 the image. Return in *DATA the bitmap data allocated with xmalloc.
6964 Value is non-zero if successful. DATA null means just test if
6965 CONTENTS looks like an in-memory XBM file. */
6967 static int
6968 xbm_read_bitmap_data (contents, end, width, height, data)
6969 char *contents, *end;
6970 int *width, *height;
6971 unsigned char **data;
6973 char *s = contents;
6974 char buffer[BUFSIZ];
6975 int padding_p = 0;
6976 int v10 = 0;
6977 int bytes_per_line, i, nbytes;
6978 unsigned char *p;
6979 int value;
6980 int LA1;
6982 #define match() \
6983 LA1 = xbm_scan (&s, end, buffer, &value)
6985 #define expect(TOKEN) \
6986 if (LA1 != (TOKEN)) \
6987 goto failure; \
6988 else \
6989 match ()
6991 #define expect_ident(IDENT) \
6992 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
6993 match (); \
6994 else \
6995 goto failure
6997 *width = *height = -1;
6998 if (data)
6999 *data = NULL;
7000 LA1 = xbm_scan (&s, end, buffer, &value);
7002 /* Parse defines for width, height and hot-spots. */
7003 while (LA1 == '#')
7005 match ();
7006 expect_ident ("define");
7007 expect (XBM_TK_IDENT);
7009 if (LA1 == XBM_TK_NUMBER);
7011 char *p = strrchr (buffer, '_');
7012 p = p ? p + 1 : buffer;
7013 if (strcmp (p, "width") == 0)
7014 *width = value;
7015 else if (strcmp (p, "height") == 0)
7016 *height = value;
7018 expect (XBM_TK_NUMBER);
7021 if (*width < 0 || *height < 0)
7022 goto failure;
7023 else if (data == NULL)
7024 goto success;
7026 /* Parse bits. Must start with `static'. */
7027 expect_ident ("static");
7028 if (LA1 == XBM_TK_IDENT)
7030 if (strcmp (buffer, "unsigned") == 0)
7032 match ();
7033 expect_ident ("char");
7035 else if (strcmp (buffer, "short") == 0)
7037 match ();
7038 v10 = 1;
7039 if (*width % 16 && *width % 16 < 9)
7040 padding_p = 1;
7042 else if (strcmp (buffer, "char") == 0)
7043 match ();
7044 else
7045 goto failure;
7047 else
7048 goto failure;
7050 expect (XBM_TK_IDENT);
7051 expect ('[');
7052 expect (']');
7053 expect ('=');
7054 expect ('{');
7056 bytes_per_line = (*width + 7) / 8 + padding_p;
7057 nbytes = bytes_per_line * *height;
7058 p = *data = (char *) xmalloc (nbytes);
7060 if (v10)
7062 for (i = 0; i < nbytes; i += 2)
7064 int val = value;
7065 expect (XBM_TK_NUMBER);
7067 *p++ = val;
7068 if (!padding_p || ((i + 2) % bytes_per_line))
7069 *p++ = value >> 8;
7071 if (LA1 == ',' || LA1 == '}')
7072 match ();
7073 else
7074 goto failure;
7077 else
7079 for (i = 0; i < nbytes; ++i)
7081 int val = value;
7082 expect (XBM_TK_NUMBER);
7084 *p++ = val;
7086 if (LA1 == ',' || LA1 == '}')
7087 match ();
7088 else
7089 goto failure;
7093 success:
7094 return 1;
7096 failure:
7098 if (data && *data)
7100 xfree (*data);
7101 *data = NULL;
7103 return 0;
7105 #undef match
7106 #undef expect
7107 #undef expect_ident
7111 /* Load XBM image IMG which will be displayed on frame F from buffer
7112 CONTENTS. END is the end of the buffer. Value is non-zero if
7113 successful. */
7115 static int
7116 xbm_load_image (f, img, contents, end)
7117 struct frame *f;
7118 struct image *img;
7119 char *contents, *end;
7121 int rc;
7122 unsigned char *data;
7123 int success_p = 0;
7125 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
7126 if (rc)
7128 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
7129 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
7130 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
7131 Lisp_Object value;
7133 xassert (img->width > 0 && img->height > 0);
7135 /* Get foreground and background colors, maybe allocate colors. */
7136 value = image_spec_value (img->spec, QCforeground, NULL);
7137 if (!NILP (value))
7138 foreground = x_alloc_image_color (f, img, value, foreground);
7139 value = image_spec_value (img->spec, QCbackground, NULL);
7140 if (!NILP (value))
7142 background = x_alloc_image_color (f, img, value, background);
7143 img->background = background;
7144 img->background_valid = 1;
7147 img->pixmap
7148 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
7149 FRAME_X_WINDOW (f),
7150 data,
7151 img->width, img->height,
7152 foreground, background,
7153 depth);
7154 xfree (data);
7156 if (img->pixmap == None)
7158 x_clear_image (f, img);
7159 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
7161 else
7162 success_p = 1;
7164 else
7165 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
7167 return success_p;
7171 /* Value is non-zero if DATA looks like an in-memory XBM file. */
7173 static int
7174 xbm_file_p (data)
7175 Lisp_Object data;
7177 int w, h;
7178 return (STRINGP (data)
7179 && xbm_read_bitmap_data (SDATA (data),
7180 (SDATA (data)
7181 + SBYTES (data)),
7182 &w, &h, NULL));
7186 /* Fill image IMG which is used on frame F with pixmap data. Value is
7187 non-zero if successful. */
7189 static int
7190 xbm_load (f, img)
7191 struct frame *f;
7192 struct image *img;
7194 int success_p = 0;
7195 Lisp_Object file_name;
7197 xassert (xbm_image_p (img->spec));
7199 /* If IMG->spec specifies a file name, create a non-file spec from it. */
7200 file_name = image_spec_value (img->spec, QCfile, NULL);
7201 if (STRINGP (file_name))
7203 Lisp_Object file;
7204 char *contents;
7205 int size;
7206 struct gcpro gcpro1;
7208 file = x_find_image_file (file_name);
7209 GCPRO1 (file);
7210 if (!STRINGP (file))
7212 image_error ("Cannot find image file `%s'", file_name, Qnil);
7213 UNGCPRO;
7214 return 0;
7217 contents = slurp_file (SDATA (file), &size);
7218 if (contents == NULL)
7220 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
7221 UNGCPRO;
7222 return 0;
7225 success_p = xbm_load_image (f, img, contents, contents + size);
7226 UNGCPRO;
7228 else
7230 struct image_keyword fmt[XBM_LAST];
7231 Lisp_Object data;
7232 int depth;
7233 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
7234 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
7235 char *bits;
7236 int parsed_p;
7237 int in_memory_file_p = 0;
7239 /* See if data looks like an in-memory XBM file. */
7240 data = image_spec_value (img->spec, QCdata, NULL);
7241 in_memory_file_p = xbm_file_p (data);
7243 /* Parse the image specification. */
7244 bcopy (xbm_format, fmt, sizeof fmt);
7245 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
7246 xassert (parsed_p);
7248 /* Get specified width, and height. */
7249 if (!in_memory_file_p)
7251 img->width = XFASTINT (fmt[XBM_WIDTH].value);
7252 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
7253 xassert (img->width > 0 && img->height > 0);
7256 /* Get foreground and background colors, maybe allocate colors. */
7257 if (fmt[XBM_FOREGROUND].count
7258 && STRINGP (fmt[XBM_FOREGROUND].value))
7259 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
7260 foreground);
7261 if (fmt[XBM_BACKGROUND].count
7262 && STRINGP (fmt[XBM_BACKGROUND].value))
7263 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
7264 background);
7266 if (in_memory_file_p)
7267 success_p = xbm_load_image (f, img, SDATA (data),
7268 (SDATA (data)
7269 + SBYTES (data)));
7270 else
7272 if (VECTORP (data))
7274 int i;
7275 char *p;
7276 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
7278 p = bits = (char *) alloca (nbytes * img->height);
7279 for (i = 0; i < img->height; ++i, p += nbytes)
7281 Lisp_Object line = XVECTOR (data)->contents[i];
7282 if (STRINGP (line))
7283 bcopy (SDATA (line), p, nbytes);
7284 else
7285 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
7288 else if (STRINGP (data))
7289 bits = SDATA (data);
7290 else
7291 bits = XBOOL_VECTOR (data)->data;
7293 /* Create the pixmap. */
7294 depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
7295 img->pixmap
7296 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
7297 FRAME_X_WINDOW (f),
7298 bits,
7299 img->width, img->height,
7300 foreground, background,
7301 depth);
7302 if (img->pixmap)
7303 success_p = 1;
7304 else
7306 image_error ("Unable to create pixmap for XBM image `%s'",
7307 img->spec, Qnil);
7308 x_clear_image (f, img);
7313 return success_p;
7318 /***********************************************************************
7319 XPM images
7320 ***********************************************************************/
7322 #if HAVE_XPM
7324 static int xpm_image_p P_ ((Lisp_Object object));
7325 static int xpm_load P_ ((struct frame *f, struct image *img));
7326 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
7328 #include "X11/xpm.h"
7330 /* The symbol `xpm' identifying XPM-format images. */
7332 Lisp_Object Qxpm;
7334 /* Indices of image specification fields in xpm_format, below. */
7336 enum xpm_keyword_index
7338 XPM_TYPE,
7339 XPM_FILE,
7340 XPM_DATA,
7341 XPM_ASCENT,
7342 XPM_MARGIN,
7343 XPM_RELIEF,
7344 XPM_ALGORITHM,
7345 XPM_HEURISTIC_MASK,
7346 XPM_MASK,
7347 XPM_COLOR_SYMBOLS,
7348 XPM_BACKGROUND,
7349 XPM_LAST
7352 /* Vector of image_keyword structures describing the format
7353 of valid XPM image specifications. */
7355 static struct image_keyword xpm_format[XPM_LAST] =
7357 {":type", IMAGE_SYMBOL_VALUE, 1},
7358 {":file", IMAGE_STRING_VALUE, 0},
7359 {":data", IMAGE_STRING_VALUE, 0},
7360 {":ascent", IMAGE_ASCENT_VALUE, 0},
7361 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
7362 {":relief", IMAGE_INTEGER_VALUE, 0},
7363 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7364 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7365 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7366 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7367 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
7370 /* Structure describing the image type XBM. */
7372 static struct image_type xpm_type =
7374 &Qxpm,
7375 xpm_image_p,
7376 xpm_load,
7377 x_clear_image,
7378 NULL
7382 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
7383 functions for allocating image colors. Our own functions handle
7384 color allocation failures more gracefully than the ones on the XPM
7385 lib. */
7387 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
7388 #define ALLOC_XPM_COLORS
7389 #endif
7391 #ifdef ALLOC_XPM_COLORS
7393 static void xpm_init_color_cache P_ ((struct frame *, XpmAttributes *));
7394 static void xpm_free_color_cache P_ ((void));
7395 static int xpm_lookup_color P_ ((struct frame *, char *, XColor *));
7396 static int xpm_color_bucket P_ ((char *));
7397 static struct xpm_cached_color *xpm_cache_color P_ ((struct frame *, char *,
7398 XColor *, int));
7400 /* An entry in a hash table used to cache color definitions of named
7401 colors. This cache is necessary to speed up XPM image loading in
7402 case we do color allocations ourselves. Without it, we would need
7403 a call to XParseColor per pixel in the image. */
7405 struct xpm_cached_color
7407 /* Next in collision chain. */
7408 struct xpm_cached_color *next;
7410 /* Color definition (RGB and pixel color). */
7411 XColor color;
7413 /* Color name. */
7414 char name[1];
7417 /* The hash table used for the color cache, and its bucket vector
7418 size. */
7420 #define XPM_COLOR_CACHE_BUCKETS 1001
7421 struct xpm_cached_color **xpm_color_cache;
7423 /* Initialize the color cache. */
7425 static void
7426 xpm_init_color_cache (f, attrs)
7427 struct frame *f;
7428 XpmAttributes *attrs;
7430 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
7431 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
7432 memset (xpm_color_cache, 0, nbytes);
7433 init_color_table ();
7435 if (attrs->valuemask & XpmColorSymbols)
7437 int i;
7438 XColor color;
7440 for (i = 0; i < attrs->numsymbols; ++i)
7441 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7442 attrs->colorsymbols[i].value, &color))
7444 color.pixel = lookup_rgb_color (f, color.red, color.green,
7445 color.blue);
7446 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
7452 /* Free the color cache. */
7454 static void
7455 xpm_free_color_cache ()
7457 struct xpm_cached_color *p, *next;
7458 int i;
7460 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
7461 for (p = xpm_color_cache[i]; p; p = next)
7463 next = p->next;
7464 xfree (p);
7467 xfree (xpm_color_cache);
7468 xpm_color_cache = NULL;
7469 free_color_table ();
7473 /* Return the bucket index for color named COLOR_NAME in the color
7474 cache. */
7476 static int
7477 xpm_color_bucket (color_name)
7478 char *color_name;
7480 unsigned h = 0;
7481 char *s;
7483 for (s = color_name; *s; ++s)
7484 h = (h << 2) ^ *s;
7485 return h %= XPM_COLOR_CACHE_BUCKETS;
7489 /* On frame F, cache values COLOR for color with name COLOR_NAME.
7490 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
7491 entry added. */
7493 static struct xpm_cached_color *
7494 xpm_cache_color (f, color_name, color, bucket)
7495 struct frame *f;
7496 char *color_name;
7497 XColor *color;
7498 int bucket;
7500 size_t nbytes;
7501 struct xpm_cached_color *p;
7503 if (bucket < 0)
7504 bucket = xpm_color_bucket (color_name);
7506 nbytes = sizeof *p + strlen (color_name);
7507 p = (struct xpm_cached_color *) xmalloc (nbytes);
7508 strcpy (p->name, color_name);
7509 p->color = *color;
7510 p->next = xpm_color_cache[bucket];
7511 xpm_color_cache[bucket] = p;
7512 return p;
7516 /* Look up color COLOR_NAME for frame F in the color cache. If found,
7517 return the cached definition in *COLOR. Otherwise, make a new
7518 entry in the cache and allocate the color. Value is zero if color
7519 allocation failed. */
7521 static int
7522 xpm_lookup_color (f, color_name, color)
7523 struct frame *f;
7524 char *color_name;
7525 XColor *color;
7527 struct xpm_cached_color *p;
7528 int h = xpm_color_bucket (color_name);
7530 for (p = xpm_color_cache[h]; p; p = p->next)
7531 if (strcmp (p->name, color_name) == 0)
7532 break;
7534 if (p != NULL)
7535 *color = p->color;
7536 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7537 color_name, color))
7539 color->pixel = lookup_rgb_color (f, color->red, color->green,
7540 color->blue);
7541 p = xpm_cache_color (f, color_name, color, h);
7544 return p != NULL;
7548 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
7549 CLOSURE is a pointer to the frame on which we allocate the
7550 color. Return in *COLOR the allocated color. Value is non-zero
7551 if successful. */
7553 static int
7554 xpm_alloc_color (dpy, cmap, color_name, color, closure)
7555 Display *dpy;
7556 Colormap cmap;
7557 char *color_name;
7558 XColor *color;
7559 void *closure;
7561 return xpm_lookup_color ((struct frame *) closure, color_name, color);
7565 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
7566 is a pointer to the frame on which we allocate the color. Value is
7567 non-zero if successful. */
7569 static int
7570 xpm_free_colors (dpy, cmap, pixels, npixels, closure)
7571 Display *dpy;
7572 Colormap cmap;
7573 Pixel *pixels;
7574 int npixels;
7575 void *closure;
7577 return 1;
7580 #endif /* ALLOC_XPM_COLORS */
7583 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
7584 for XPM images. Such a list must consist of conses whose car and
7585 cdr are strings. */
7587 static int
7588 xpm_valid_color_symbols_p (color_symbols)
7589 Lisp_Object color_symbols;
7591 while (CONSP (color_symbols))
7593 Lisp_Object sym = XCAR (color_symbols);
7594 if (!CONSP (sym)
7595 || !STRINGP (XCAR (sym))
7596 || !STRINGP (XCDR (sym)))
7597 break;
7598 color_symbols = XCDR (color_symbols);
7601 return NILP (color_symbols);
7605 /* Value is non-zero if OBJECT is a valid XPM image specification. */
7607 static int
7608 xpm_image_p (object)
7609 Lisp_Object object;
7611 struct image_keyword fmt[XPM_LAST];
7612 bcopy (xpm_format, fmt, sizeof fmt);
7613 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
7614 /* Either `:file' or `:data' must be present. */
7615 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
7616 /* Either no `:color-symbols' or it's a list of conses
7617 whose car and cdr are strings. */
7618 && (fmt[XPM_COLOR_SYMBOLS].count == 0
7619 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
7623 /* Load image IMG which will be displayed on frame F. Value is
7624 non-zero if successful. */
7626 static int
7627 xpm_load (f, img)
7628 struct frame *f;
7629 struct image *img;
7631 int rc;
7632 XpmAttributes attrs;
7633 Lisp_Object specified_file, color_symbols;
7635 /* Configure the XPM lib. Use the visual of frame F. Allocate
7636 close colors. Return colors allocated. */
7637 bzero (&attrs, sizeof attrs);
7638 attrs.visual = FRAME_X_VISUAL (f);
7639 attrs.colormap = FRAME_X_COLORMAP (f);
7640 attrs.valuemask |= XpmVisual;
7641 attrs.valuemask |= XpmColormap;
7643 #ifdef ALLOC_XPM_COLORS
7644 /* Allocate colors with our own functions which handle
7645 failing color allocation more gracefully. */
7646 attrs.color_closure = f;
7647 attrs.alloc_color = xpm_alloc_color;
7648 attrs.free_colors = xpm_free_colors;
7649 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
7650 #else /* not ALLOC_XPM_COLORS */
7651 /* Let the XPM lib allocate colors. */
7652 attrs.valuemask |= XpmReturnAllocPixels;
7653 #ifdef XpmAllocCloseColors
7654 attrs.alloc_close_colors = 1;
7655 attrs.valuemask |= XpmAllocCloseColors;
7656 #else /* not XpmAllocCloseColors */
7657 attrs.closeness = 600;
7658 attrs.valuemask |= XpmCloseness;
7659 #endif /* not XpmAllocCloseColors */
7660 #endif /* ALLOC_XPM_COLORS */
7662 /* If image specification contains symbolic color definitions, add
7663 these to `attrs'. */
7664 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
7665 if (CONSP (color_symbols))
7667 Lisp_Object tail;
7668 XpmColorSymbol *xpm_syms;
7669 int i, size;
7671 attrs.valuemask |= XpmColorSymbols;
7673 /* Count number of symbols. */
7674 attrs.numsymbols = 0;
7675 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
7676 ++attrs.numsymbols;
7678 /* Allocate an XpmColorSymbol array. */
7679 size = attrs.numsymbols * sizeof *xpm_syms;
7680 xpm_syms = (XpmColorSymbol *) alloca (size);
7681 bzero (xpm_syms, size);
7682 attrs.colorsymbols = xpm_syms;
7684 /* Fill the color symbol array. */
7685 for (tail = color_symbols, i = 0;
7686 CONSP (tail);
7687 ++i, tail = XCDR (tail))
7689 Lisp_Object name = XCAR (XCAR (tail));
7690 Lisp_Object color = XCDR (XCAR (tail));
7691 xpm_syms[i].name = (char *) alloca (SCHARS (name) + 1);
7692 strcpy (xpm_syms[i].name, SDATA (name));
7693 xpm_syms[i].value = (char *) alloca (SCHARS (color) + 1);
7694 strcpy (xpm_syms[i].value, SDATA (color));
7698 /* Create a pixmap for the image, either from a file, or from a
7699 string buffer containing data in the same format as an XPM file. */
7700 #ifdef ALLOC_XPM_COLORS
7701 xpm_init_color_cache (f, &attrs);
7702 #endif
7704 specified_file = image_spec_value (img->spec, QCfile, NULL);
7705 if (STRINGP (specified_file))
7707 Lisp_Object file = x_find_image_file (specified_file);
7708 if (!STRINGP (file))
7710 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7711 return 0;
7714 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7715 SDATA (file), &img->pixmap, &img->mask,
7716 &attrs);
7718 else
7720 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
7721 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7722 SDATA (buffer),
7723 &img->pixmap, &img->mask,
7724 &attrs);
7727 if (rc == XpmSuccess)
7729 #ifdef ALLOC_XPM_COLORS
7730 img->colors = colors_in_color_table (&img->ncolors);
7731 #else /* not ALLOC_XPM_COLORS */
7732 int i;
7734 img->ncolors = attrs.nalloc_pixels;
7735 img->colors = (unsigned long *) xmalloc (img->ncolors
7736 * sizeof *img->colors);
7737 for (i = 0; i < attrs.nalloc_pixels; ++i)
7739 img->colors[i] = attrs.alloc_pixels[i];
7740 #ifdef DEBUG_X_COLORS
7741 register_color (img->colors[i]);
7742 #endif
7744 #endif /* not ALLOC_XPM_COLORS */
7746 img->width = attrs.width;
7747 img->height = attrs.height;
7748 xassert (img->width > 0 && img->height > 0);
7750 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
7751 XpmFreeAttributes (&attrs);
7753 else
7755 switch (rc)
7757 case XpmOpenFailed:
7758 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
7759 break;
7761 case XpmFileInvalid:
7762 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
7763 break;
7765 case XpmNoMemory:
7766 image_error ("Out of memory (%s)", img->spec, Qnil);
7767 break;
7769 case XpmColorFailed:
7770 image_error ("Color allocation error (%s)", img->spec, Qnil);
7771 break;
7773 default:
7774 image_error ("Unknown error (%s)", img->spec, Qnil);
7775 break;
7779 #ifdef ALLOC_XPM_COLORS
7780 xpm_free_color_cache ();
7781 #endif
7782 return rc == XpmSuccess;
7785 #endif /* HAVE_XPM != 0 */
7788 /***********************************************************************
7789 Color table
7790 ***********************************************************************/
7792 /* An entry in the color table mapping an RGB color to a pixel color. */
7794 struct ct_color
7796 int r, g, b;
7797 unsigned long pixel;
7799 /* Next in color table collision list. */
7800 struct ct_color *next;
7803 /* The bucket vector size to use. Must be prime. */
7805 #define CT_SIZE 101
7807 /* Value is a hash of the RGB color given by R, G, and B. */
7809 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
7811 /* The color hash table. */
7813 struct ct_color **ct_table;
7815 /* Number of entries in the color table. */
7817 int ct_colors_allocated;
7819 /* Initialize the color table. */
7821 static void
7822 init_color_table ()
7824 int size = CT_SIZE * sizeof (*ct_table);
7825 ct_table = (struct ct_color **) xmalloc (size);
7826 bzero (ct_table, size);
7827 ct_colors_allocated = 0;
7831 /* Free memory associated with the color table. */
7833 static void
7834 free_color_table ()
7836 int i;
7837 struct ct_color *p, *next;
7839 for (i = 0; i < CT_SIZE; ++i)
7840 for (p = ct_table[i]; p; p = next)
7842 next = p->next;
7843 xfree (p);
7846 xfree (ct_table);
7847 ct_table = NULL;
7851 /* Value is a pixel color for RGB color R, G, B on frame F. If an
7852 entry for that color already is in the color table, return the
7853 pixel color of that entry. Otherwise, allocate a new color for R,
7854 G, B, and make an entry in the color table. */
7856 static unsigned long
7857 lookup_rgb_color (f, r, g, b)
7858 struct frame *f;
7859 int r, g, b;
7861 unsigned hash = CT_HASH_RGB (r, g, b);
7862 int i = hash % CT_SIZE;
7863 struct ct_color *p;
7865 for (p = ct_table[i]; p; p = p->next)
7866 if (p->r == r && p->g == g && p->b == b)
7867 break;
7869 if (p == NULL)
7871 XColor color;
7872 Colormap cmap;
7873 int rc;
7875 color.red = r;
7876 color.green = g;
7877 color.blue = b;
7879 cmap = FRAME_X_COLORMAP (f);
7880 rc = x_alloc_nearest_color (f, cmap, &color);
7882 if (rc)
7884 ++ct_colors_allocated;
7886 p = (struct ct_color *) xmalloc (sizeof *p);
7887 p->r = r;
7888 p->g = g;
7889 p->b = b;
7890 p->pixel = color.pixel;
7891 p->next = ct_table[i];
7892 ct_table[i] = p;
7894 else
7895 return FRAME_FOREGROUND_PIXEL (f);
7898 return p->pixel;
7902 /* Look up pixel color PIXEL which is used on frame F in the color
7903 table. If not already present, allocate it. Value is PIXEL. */
7905 static unsigned long
7906 lookup_pixel_color (f, pixel)
7907 struct frame *f;
7908 unsigned long pixel;
7910 int i = pixel % CT_SIZE;
7911 struct ct_color *p;
7913 for (p = ct_table[i]; p; p = p->next)
7914 if (p->pixel == pixel)
7915 break;
7917 if (p == NULL)
7919 XColor color;
7920 Colormap cmap;
7921 int rc;
7923 cmap = FRAME_X_COLORMAP (f);
7924 color.pixel = pixel;
7925 x_query_color (f, &color);
7926 rc = x_alloc_nearest_color (f, cmap, &color);
7928 if (rc)
7930 ++ct_colors_allocated;
7932 p = (struct ct_color *) xmalloc (sizeof *p);
7933 p->r = color.red;
7934 p->g = color.green;
7935 p->b = color.blue;
7936 p->pixel = pixel;
7937 p->next = ct_table[i];
7938 ct_table[i] = p;
7940 else
7941 return FRAME_FOREGROUND_PIXEL (f);
7944 return p->pixel;
7948 /* Value is a vector of all pixel colors contained in the color table,
7949 allocated via xmalloc. Set *N to the number of colors. */
7951 static unsigned long *
7952 colors_in_color_table (n)
7953 int *n;
7955 int i, j;
7956 struct ct_color *p;
7957 unsigned long *colors;
7959 if (ct_colors_allocated == 0)
7961 *n = 0;
7962 colors = NULL;
7964 else
7966 colors = (unsigned long *) xmalloc (ct_colors_allocated
7967 * sizeof *colors);
7968 *n = ct_colors_allocated;
7970 for (i = j = 0; i < CT_SIZE; ++i)
7971 for (p = ct_table[i]; p; p = p->next)
7972 colors[j++] = p->pixel;
7975 return colors;
7980 /***********************************************************************
7981 Algorithms
7982 ***********************************************************************/
7984 static XColor *x_to_xcolors P_ ((struct frame *, struct image *, int));
7985 static void x_from_xcolors P_ ((struct frame *, struct image *, XColor *));
7986 static void x_detect_edges P_ ((struct frame *, struct image *, int[9], int));
7988 /* Non-zero means draw a cross on images having `:conversion
7989 disabled'. */
7991 int cross_disabled_images;
7993 /* Edge detection matrices for different edge-detection
7994 strategies. */
7996 static int emboss_matrix[9] = {
7997 /* x - 1 x x + 1 */
7998 2, -1, 0, /* y - 1 */
7999 -1, 0, 1, /* y */
8000 0, 1, -2 /* y + 1 */
8003 static int laplace_matrix[9] = {
8004 /* x - 1 x x + 1 */
8005 1, 0, 0, /* y - 1 */
8006 0, 0, 0, /* y */
8007 0, 0, -1 /* y + 1 */
8010 /* Value is the intensity of the color whose red/green/blue values
8011 are R, G, and B. */
8013 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
8016 /* On frame F, return an array of XColor structures describing image
8017 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
8018 non-zero means also fill the red/green/blue members of the XColor
8019 structures. Value is a pointer to the array of XColors structures,
8020 allocated with xmalloc; it must be freed by the caller. */
8022 static XColor *
8023 x_to_xcolors (f, img, rgb_p)
8024 struct frame *f;
8025 struct image *img;
8026 int rgb_p;
8028 int x, y;
8029 XColor *colors, *p;
8030 XImage *ximg;
8032 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
8034 /* Get the X image IMG->pixmap. */
8035 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
8036 0, 0, img->width, img->height, ~0, ZPixmap);
8038 /* Fill the `pixel' members of the XColor array. I wished there
8039 were an easy and portable way to circumvent XGetPixel. */
8040 p = colors;
8041 for (y = 0; y < img->height; ++y)
8043 XColor *row = p;
8045 for (x = 0; x < img->width; ++x, ++p)
8046 p->pixel = XGetPixel (ximg, x, y);
8048 if (rgb_p)
8049 x_query_colors (f, row, img->width);
8052 XDestroyImage (ximg);
8053 return colors;
8057 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
8058 RGB members are set. F is the frame on which this all happens.
8059 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
8061 static void
8062 x_from_xcolors (f, img, colors)
8063 struct frame *f;
8064 struct image *img;
8065 XColor *colors;
8067 int x, y;
8068 XImage *oimg;
8069 Pixmap pixmap;
8070 XColor *p;
8072 init_color_table ();
8074 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
8075 &oimg, &pixmap);
8076 p = colors;
8077 for (y = 0; y < img->height; ++y)
8078 for (x = 0; x < img->width; ++x, ++p)
8080 unsigned long pixel;
8081 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
8082 XPutPixel (oimg, x, y, pixel);
8085 xfree (colors);
8086 x_clear_image_1 (f, img, 1, 0, 1);
8088 x_put_x_image (f, oimg, pixmap, img->width, img->height);
8089 x_destroy_x_image (oimg);
8090 img->pixmap = pixmap;
8091 img->colors = colors_in_color_table (&img->ncolors);
8092 free_color_table ();
8096 /* On frame F, perform edge-detection on image IMG.
8098 MATRIX is a nine-element array specifying the transformation
8099 matrix. See emboss_matrix for an example.
8101 COLOR_ADJUST is a color adjustment added to each pixel of the
8102 outgoing image. */
8104 static void
8105 x_detect_edges (f, img, matrix, color_adjust)
8106 struct frame *f;
8107 struct image *img;
8108 int matrix[9], color_adjust;
8110 XColor *colors = x_to_xcolors (f, img, 1);
8111 XColor *new, *p;
8112 int x, y, i, sum;
8114 for (i = sum = 0; i < 9; ++i)
8115 sum += abs (matrix[i]);
8117 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
8119 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
8121 for (y = 0; y < img->height; ++y)
8123 p = COLOR (new, 0, y);
8124 p->red = p->green = p->blue = 0xffff/2;
8125 p = COLOR (new, img->width - 1, y);
8126 p->red = p->green = p->blue = 0xffff/2;
8129 for (x = 1; x < img->width - 1; ++x)
8131 p = COLOR (new, x, 0);
8132 p->red = p->green = p->blue = 0xffff/2;
8133 p = COLOR (new, x, img->height - 1);
8134 p->red = p->green = p->blue = 0xffff/2;
8137 for (y = 1; y < img->height - 1; ++y)
8139 p = COLOR (new, 1, y);
8141 for (x = 1; x < img->width - 1; ++x, ++p)
8143 int r, g, b, y1, x1;
8145 r = g = b = i = 0;
8146 for (y1 = y - 1; y1 < y + 2; ++y1)
8147 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
8148 if (matrix[i])
8150 XColor *t = COLOR (colors, x1, y1);
8151 r += matrix[i] * t->red;
8152 g += matrix[i] * t->green;
8153 b += matrix[i] * t->blue;
8156 r = (r / sum + color_adjust) & 0xffff;
8157 g = (g / sum + color_adjust) & 0xffff;
8158 b = (b / sum + color_adjust) & 0xffff;
8159 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
8163 xfree (colors);
8164 x_from_xcolors (f, img, new);
8166 #undef COLOR
8170 /* Perform the pre-defined `emboss' edge-detection on image IMG
8171 on frame F. */
8173 static void
8174 x_emboss (f, img)
8175 struct frame *f;
8176 struct image *img;
8178 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
8182 /* Perform the pre-defined `laplace' edge-detection on image IMG
8183 on frame F. */
8185 static void
8186 x_laplace (f, img)
8187 struct frame *f;
8188 struct image *img;
8190 x_detect_edges (f, img, laplace_matrix, 45000);
8194 /* Perform edge-detection on image IMG on frame F, with specified
8195 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
8197 MATRIX must be either
8199 - a list of at least 9 numbers in row-major form
8200 - a vector of at least 9 numbers
8202 COLOR_ADJUST nil means use a default; otherwise it must be a
8203 number. */
8205 static void
8206 x_edge_detection (f, img, matrix, color_adjust)
8207 struct frame *f;
8208 struct image *img;
8209 Lisp_Object matrix, color_adjust;
8211 int i = 0;
8212 int trans[9];
8214 if (CONSP (matrix))
8216 for (i = 0;
8217 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
8218 ++i, matrix = XCDR (matrix))
8219 trans[i] = XFLOATINT (XCAR (matrix));
8221 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
8223 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
8224 trans[i] = XFLOATINT (AREF (matrix, i));
8227 if (NILP (color_adjust))
8228 color_adjust = make_number (0xffff / 2);
8230 if (i == 9 && NUMBERP (color_adjust))
8231 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
8235 /* Transform image IMG on frame F so that it looks disabled. */
8237 static void
8238 x_disable_image (f, img)
8239 struct frame *f;
8240 struct image *img;
8242 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8244 if (dpyinfo->n_planes >= 2)
8246 /* Color (or grayscale). Convert to gray, and equalize. Just
8247 drawing such images with a stipple can look very odd, so
8248 we're using this method instead. */
8249 XColor *colors = x_to_xcolors (f, img, 1);
8250 XColor *p, *end;
8251 const int h = 15000;
8252 const int l = 30000;
8254 for (p = colors, end = colors + img->width * img->height;
8255 p < end;
8256 ++p)
8258 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
8259 int i2 = (0xffff - h - l) * i / 0xffff + l;
8260 p->red = p->green = p->blue = i2;
8263 x_from_xcolors (f, img, colors);
8266 /* Draw a cross over the disabled image, if we must or if we
8267 should. */
8268 if (dpyinfo->n_planes < 2 || cross_disabled_images)
8270 Display *dpy = FRAME_X_DISPLAY (f);
8271 GC gc;
8273 gc = XCreateGC (dpy, img->pixmap, 0, NULL);
8274 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
8275 XDrawLine (dpy, img->pixmap, gc, 0, 0,
8276 img->width - 1, img->height - 1);
8277 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
8278 img->width - 1, 0);
8279 XFreeGC (dpy, gc);
8281 if (img->mask)
8283 gc = XCreateGC (dpy, img->mask, 0, NULL);
8284 XSetForeground (dpy, gc, WHITE_PIX_DEFAULT (f));
8285 XDrawLine (dpy, img->mask, gc, 0, 0,
8286 img->width - 1, img->height - 1);
8287 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
8288 img->width - 1, 0);
8289 XFreeGC (dpy, gc);
8295 /* Build a mask for image IMG which is used on frame F. FILE is the
8296 name of an image file, for error messages. HOW determines how to
8297 determine the background color of IMG. If it is a list '(R G B)',
8298 with R, G, and B being integers >= 0, take that as the color of the
8299 background. Otherwise, determine the background color of IMG
8300 heuristically. Value is non-zero if successful. */
8302 static int
8303 x_build_heuristic_mask (f, img, how)
8304 struct frame *f;
8305 struct image *img;
8306 Lisp_Object how;
8308 Display *dpy = FRAME_X_DISPLAY (f);
8309 XImage *ximg, *mask_img;
8310 int x, y, rc, use_img_background;
8311 unsigned long bg = 0;
8313 if (img->mask)
8315 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
8316 img->mask = None;
8317 img->background_transparent_valid = 0;
8320 /* Create an image and pixmap serving as mask. */
8321 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
8322 &mask_img, &img->mask);
8323 if (!rc)
8324 return 0;
8326 /* Get the X image of IMG->pixmap. */
8327 ximg = XGetImage (dpy, img->pixmap, 0, 0, img->width, img->height,
8328 ~0, ZPixmap);
8330 /* Determine the background color of ximg. If HOW is `(R G B)'
8331 take that as color. Otherwise, use the image's background color. */
8332 use_img_background = 1;
8334 if (CONSP (how))
8336 int rgb[3], i;
8338 for (i = 0; i < 3 && CONSP (how) && NATNUMP (XCAR (how)); ++i)
8340 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
8341 how = XCDR (how);
8344 if (i == 3 && NILP (how))
8346 char color_name[30];
8347 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
8348 bg = x_alloc_image_color (f, img, build_string (color_name), 0);
8349 use_img_background = 0;
8353 if (use_img_background)
8354 bg = four_corners_best (ximg, img->width, img->height);
8356 /* Set all bits in mask_img to 1 whose color in ximg is different
8357 from the background color bg. */
8358 for (y = 0; y < img->height; ++y)
8359 for (x = 0; x < img->width; ++x)
8360 XPutPixel (mask_img, x, y, XGetPixel (ximg, x, y) != bg);
8362 /* Fill in the background_transparent field while we have the mask handy. */
8363 image_background_transparent (img, f, mask_img);
8365 /* Put mask_img into img->mask. */
8366 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8367 x_destroy_x_image (mask_img);
8368 XDestroyImage (ximg);
8370 return 1;
8375 /***********************************************************************
8376 PBM (mono, gray, color)
8377 ***********************************************************************/
8379 static int pbm_image_p P_ ((Lisp_Object object));
8380 static int pbm_load P_ ((struct frame *f, struct image *img));
8381 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
8383 /* The symbol `pbm' identifying images of this type. */
8385 Lisp_Object Qpbm;
8387 /* Indices of image specification fields in gs_format, below. */
8389 enum pbm_keyword_index
8391 PBM_TYPE,
8392 PBM_FILE,
8393 PBM_DATA,
8394 PBM_ASCENT,
8395 PBM_MARGIN,
8396 PBM_RELIEF,
8397 PBM_ALGORITHM,
8398 PBM_HEURISTIC_MASK,
8399 PBM_MASK,
8400 PBM_FOREGROUND,
8401 PBM_BACKGROUND,
8402 PBM_LAST
8405 /* Vector of image_keyword structures describing the format
8406 of valid user-defined image specifications. */
8408 static struct image_keyword pbm_format[PBM_LAST] =
8410 {":type", IMAGE_SYMBOL_VALUE, 1},
8411 {":file", IMAGE_STRING_VALUE, 0},
8412 {":data", IMAGE_STRING_VALUE, 0},
8413 {":ascent", IMAGE_ASCENT_VALUE, 0},
8414 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8415 {":relief", IMAGE_INTEGER_VALUE, 0},
8416 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8417 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8418 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8419 {":foreground", IMAGE_STRING_OR_NIL_VALUE, 0},
8420 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
8423 /* Structure describing the image type `pbm'. */
8425 static struct image_type pbm_type =
8427 &Qpbm,
8428 pbm_image_p,
8429 pbm_load,
8430 x_clear_image,
8431 NULL
8435 /* Return non-zero if OBJECT is a valid PBM image specification. */
8437 static int
8438 pbm_image_p (object)
8439 Lisp_Object object;
8441 struct image_keyword fmt[PBM_LAST];
8443 bcopy (pbm_format, fmt, sizeof fmt);
8445 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
8446 return 0;
8448 /* Must specify either :data or :file. */
8449 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
8453 /* Scan a decimal number from *S and return it. Advance *S while
8454 reading the number. END is the end of the string. Value is -1 at
8455 end of input. */
8457 static int
8458 pbm_scan_number (s, end)
8459 unsigned char **s, *end;
8461 int c = 0, val = -1;
8463 while (*s < end)
8465 /* Skip white-space. */
8466 while (*s < end && (c = *(*s)++, isspace (c)))
8469 if (c == '#')
8471 /* Skip comment to end of line. */
8472 while (*s < end && (c = *(*s)++, c != '\n'))
8475 else if (isdigit (c))
8477 /* Read decimal number. */
8478 val = c - '0';
8479 while (*s < end && (c = *(*s)++, isdigit (c)))
8480 val = 10 * val + c - '0';
8481 break;
8483 else
8484 break;
8487 return val;
8491 /* Load PBM image IMG for use on frame F. */
8493 static int
8494 pbm_load (f, img)
8495 struct frame *f;
8496 struct image *img;
8498 int raw_p, x, y;
8499 int width, height, max_color_idx = 0;
8500 XImage *ximg;
8501 Lisp_Object file, specified_file;
8502 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
8503 struct gcpro gcpro1;
8504 unsigned char *contents = NULL;
8505 unsigned char *end, *p;
8506 int size;
8508 specified_file = image_spec_value (img->spec, QCfile, NULL);
8509 file = Qnil;
8510 GCPRO1 (file);
8512 if (STRINGP (specified_file))
8514 file = x_find_image_file (specified_file);
8515 if (!STRINGP (file))
8517 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8518 UNGCPRO;
8519 return 0;
8522 contents = slurp_file (SDATA (file), &size);
8523 if (contents == NULL)
8525 image_error ("Error reading `%s'", file, Qnil);
8526 UNGCPRO;
8527 return 0;
8530 p = contents;
8531 end = contents + size;
8533 else
8535 Lisp_Object data;
8536 data = image_spec_value (img->spec, QCdata, NULL);
8537 p = SDATA (data);
8538 end = p + SBYTES (data);
8541 /* Check magic number. */
8542 if (end - p < 2 || *p++ != 'P')
8544 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8545 error:
8546 xfree (contents);
8547 UNGCPRO;
8548 return 0;
8551 switch (*p++)
8553 case '1':
8554 raw_p = 0, type = PBM_MONO;
8555 break;
8557 case '2':
8558 raw_p = 0, type = PBM_GRAY;
8559 break;
8561 case '3':
8562 raw_p = 0, type = PBM_COLOR;
8563 break;
8565 case '4':
8566 raw_p = 1, type = PBM_MONO;
8567 break;
8569 case '5':
8570 raw_p = 1, type = PBM_GRAY;
8571 break;
8573 case '6':
8574 raw_p = 1, type = PBM_COLOR;
8575 break;
8577 default:
8578 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8579 goto error;
8582 /* Read width, height, maximum color-component. Characters
8583 starting with `#' up to the end of a line are ignored. */
8584 width = pbm_scan_number (&p, end);
8585 height = pbm_scan_number (&p, end);
8587 if (type != PBM_MONO)
8589 max_color_idx = pbm_scan_number (&p, end);
8590 if (raw_p && max_color_idx > 255)
8591 max_color_idx = 255;
8594 if (width < 0
8595 || height < 0
8596 || (type != PBM_MONO && max_color_idx < 0))
8597 goto error;
8599 if (!x_create_x_image_and_pixmap (f, width, height, 0,
8600 &ximg, &img->pixmap))
8601 goto error;
8603 /* Initialize the color hash table. */
8604 init_color_table ();
8606 if (type == PBM_MONO)
8608 int c = 0, g;
8609 struct image_keyword fmt[PBM_LAST];
8610 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
8611 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
8613 /* Parse the image specification. */
8614 bcopy (pbm_format, fmt, sizeof fmt);
8615 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
8617 /* Get foreground and background colors, maybe allocate colors. */
8618 if (fmt[PBM_FOREGROUND].count
8619 && STRINGP (fmt[PBM_FOREGROUND].value))
8620 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
8621 if (fmt[PBM_BACKGROUND].count
8622 && STRINGP (fmt[PBM_BACKGROUND].value))
8624 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
8625 img->background = bg;
8626 img->background_valid = 1;
8629 for (y = 0; y < height; ++y)
8630 for (x = 0; x < width; ++x)
8632 if (raw_p)
8634 if ((x & 7) == 0)
8635 c = *p++;
8636 g = c & 0x80;
8637 c <<= 1;
8639 else
8640 g = pbm_scan_number (&p, end);
8642 XPutPixel (ximg, x, y, g ? fg : bg);
8645 else
8647 for (y = 0; y < height; ++y)
8648 for (x = 0; x < width; ++x)
8650 int r, g, b;
8652 if (type == PBM_GRAY)
8653 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
8654 else if (raw_p)
8656 r = *p++;
8657 g = *p++;
8658 b = *p++;
8660 else
8662 r = pbm_scan_number (&p, end);
8663 g = pbm_scan_number (&p, end);
8664 b = pbm_scan_number (&p, end);
8667 if (r < 0 || g < 0 || b < 0)
8669 xfree (ximg->data);
8670 ximg->data = NULL;
8671 XDestroyImage (ximg);
8672 image_error ("Invalid pixel value in image `%s'",
8673 img->spec, Qnil);
8674 goto error;
8677 /* RGB values are now in the range 0..max_color_idx.
8678 Scale this to the range 0..0xffff supported by X. */
8679 r = (double) r * 65535 / max_color_idx;
8680 g = (double) g * 65535 / max_color_idx;
8681 b = (double) b * 65535 / max_color_idx;
8682 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8686 /* Store in IMG->colors the colors allocated for the image, and
8687 free the color table. */
8688 img->colors = colors_in_color_table (&img->ncolors);
8689 free_color_table ();
8691 /* Maybe fill in the background field while we have ximg handy. */
8692 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
8693 IMAGE_BACKGROUND (img, f, ximg);
8695 /* Put the image into a pixmap. */
8696 x_put_x_image (f, ximg, img->pixmap, width, height);
8697 x_destroy_x_image (ximg);
8699 img->width = width;
8700 img->height = height;
8702 UNGCPRO;
8703 xfree (contents);
8704 return 1;
8709 /***********************************************************************
8711 ***********************************************************************/
8713 #if HAVE_PNG
8715 #include <png.h>
8717 /* Function prototypes. */
8719 static int png_image_p P_ ((Lisp_Object object));
8720 static int png_load P_ ((struct frame *f, struct image *img));
8722 /* The symbol `png' identifying images of this type. */
8724 Lisp_Object Qpng;
8726 /* Indices of image specification fields in png_format, below. */
8728 enum png_keyword_index
8730 PNG_TYPE,
8731 PNG_DATA,
8732 PNG_FILE,
8733 PNG_ASCENT,
8734 PNG_MARGIN,
8735 PNG_RELIEF,
8736 PNG_ALGORITHM,
8737 PNG_HEURISTIC_MASK,
8738 PNG_MASK,
8739 PNG_BACKGROUND,
8740 PNG_LAST
8743 /* Vector of image_keyword structures describing the format
8744 of valid user-defined image specifications. */
8746 static struct image_keyword png_format[PNG_LAST] =
8748 {":type", IMAGE_SYMBOL_VALUE, 1},
8749 {":data", IMAGE_STRING_VALUE, 0},
8750 {":file", IMAGE_STRING_VALUE, 0},
8751 {":ascent", IMAGE_ASCENT_VALUE, 0},
8752 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8753 {":relief", IMAGE_INTEGER_VALUE, 0},
8754 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8755 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8756 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8757 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
8760 /* Structure describing the image type `png'. */
8762 static struct image_type png_type =
8764 &Qpng,
8765 png_image_p,
8766 png_load,
8767 x_clear_image,
8768 NULL
8772 /* Return non-zero if OBJECT is a valid PNG image specification. */
8774 static int
8775 png_image_p (object)
8776 Lisp_Object object;
8778 struct image_keyword fmt[PNG_LAST];
8779 bcopy (png_format, fmt, sizeof fmt);
8781 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
8782 return 0;
8784 /* Must specify either the :data or :file keyword. */
8785 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
8789 /* Error and warning handlers installed when the PNG library
8790 is initialized. */
8792 static void
8793 my_png_error (png_ptr, msg)
8794 png_struct *png_ptr;
8795 char *msg;
8797 xassert (png_ptr != NULL);
8798 image_error ("PNG error: %s", build_string (msg), Qnil);
8799 longjmp (png_ptr->jmpbuf, 1);
8803 static void
8804 my_png_warning (png_ptr, msg)
8805 png_struct *png_ptr;
8806 char *msg;
8808 xassert (png_ptr != NULL);
8809 image_error ("PNG warning: %s", build_string (msg), Qnil);
8812 /* Memory source for PNG decoding. */
8814 struct png_memory_storage
8816 unsigned char *bytes; /* The data */
8817 size_t len; /* How big is it? */
8818 int index; /* Where are we? */
8822 /* Function set as reader function when reading PNG image from memory.
8823 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
8824 bytes from the input to DATA. */
8826 static void
8827 png_read_from_memory (png_ptr, data, length)
8828 png_structp png_ptr;
8829 png_bytep data;
8830 png_size_t length;
8832 struct png_memory_storage *tbr
8833 = (struct png_memory_storage *) png_get_io_ptr (png_ptr);
8835 if (length > tbr->len - tbr->index)
8836 png_error (png_ptr, "Read error");
8838 bcopy (tbr->bytes + tbr->index, data, length);
8839 tbr->index = tbr->index + length;
8842 /* Load PNG image IMG for use on frame F. Value is non-zero if
8843 successful. */
8845 static int
8846 png_load (f, img)
8847 struct frame *f;
8848 struct image *img;
8850 Lisp_Object file, specified_file;
8851 Lisp_Object specified_data;
8852 int x, y, i;
8853 XImage *ximg, *mask_img = NULL;
8854 struct gcpro gcpro1;
8855 png_struct *png_ptr = NULL;
8856 png_info *info_ptr = NULL, *end_info = NULL;
8857 FILE *volatile fp = NULL;
8858 png_byte sig[8];
8859 png_byte * volatile pixels = NULL;
8860 png_byte ** volatile rows = NULL;
8861 png_uint_32 width, height;
8862 int bit_depth, color_type, interlace_type;
8863 png_byte channels;
8864 png_uint_32 row_bytes;
8865 int transparent_p;
8866 double screen_gamma, image_gamma;
8867 int intent;
8868 struct png_memory_storage tbr; /* Data to be read */
8870 /* Find out what file to load. */
8871 specified_file = image_spec_value (img->spec, QCfile, NULL);
8872 specified_data = image_spec_value (img->spec, QCdata, NULL);
8873 file = Qnil;
8874 GCPRO1 (file);
8876 if (NILP (specified_data))
8878 file = x_find_image_file (specified_file);
8879 if (!STRINGP (file))
8881 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8882 UNGCPRO;
8883 return 0;
8886 /* Open the image file. */
8887 fp = fopen (SDATA (file), "rb");
8888 if (!fp)
8890 image_error ("Cannot open image file `%s'", file, Qnil);
8891 UNGCPRO;
8892 fclose (fp);
8893 return 0;
8896 /* Check PNG signature. */
8897 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
8898 || !png_check_sig (sig, sizeof sig))
8900 image_error ("Not a PNG file: `%s'", file, Qnil);
8901 UNGCPRO;
8902 fclose (fp);
8903 return 0;
8906 else
8908 /* Read from memory. */
8909 tbr.bytes = SDATA (specified_data);
8910 tbr.len = SBYTES (specified_data);
8911 tbr.index = 0;
8913 /* Check PNG signature. */
8914 if (tbr.len < sizeof sig
8915 || !png_check_sig (tbr.bytes, sizeof sig))
8917 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
8918 UNGCPRO;
8919 return 0;
8922 /* Need to skip past the signature. */
8923 tbr.bytes += sizeof (sig);
8926 /* Initialize read and info structs for PNG lib. */
8927 png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
8928 my_png_error, my_png_warning);
8929 if (!png_ptr)
8931 if (fp) fclose (fp);
8932 UNGCPRO;
8933 return 0;
8936 info_ptr = png_create_info_struct (png_ptr);
8937 if (!info_ptr)
8939 png_destroy_read_struct (&png_ptr, NULL, NULL);
8940 if (fp) fclose (fp);
8941 UNGCPRO;
8942 return 0;
8945 end_info = png_create_info_struct (png_ptr);
8946 if (!end_info)
8948 png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
8949 if (fp) fclose (fp);
8950 UNGCPRO;
8951 return 0;
8954 /* Set error jump-back. We come back here when the PNG library
8955 detects an error. */
8956 if (setjmp (png_ptr->jmpbuf))
8958 error:
8959 if (png_ptr)
8960 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8961 xfree (pixels);
8962 xfree (rows);
8963 if (fp) fclose (fp);
8964 UNGCPRO;
8965 return 0;
8968 /* Read image info. */
8969 if (!NILP (specified_data))
8970 png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
8971 else
8972 png_init_io (png_ptr, fp);
8974 png_set_sig_bytes (png_ptr, sizeof sig);
8975 png_read_info (png_ptr, info_ptr);
8976 png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
8977 &interlace_type, NULL, NULL);
8979 /* If image contains simply transparency data, we prefer to
8980 construct a clipping mask. */
8981 if (png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
8982 transparent_p = 1;
8983 else
8984 transparent_p = 0;
8986 /* This function is easier to write if we only have to handle
8987 one data format: RGB or RGBA with 8 bits per channel. Let's
8988 transform other formats into that format. */
8990 /* Strip more than 8 bits per channel. */
8991 if (bit_depth == 16)
8992 png_set_strip_16 (png_ptr);
8994 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
8995 if available. */
8996 png_set_expand (png_ptr);
8998 /* Convert grayscale images to RGB. */
8999 if (color_type == PNG_COLOR_TYPE_GRAY
9000 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
9001 png_set_gray_to_rgb (png_ptr);
9003 screen_gamma = (f->gamma ? 1 / f->gamma / 0.45455 : 2.2);
9005 /* Tell the PNG lib to handle gamma correction for us. */
9007 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
9008 if (png_get_sRGB (png_ptr, info_ptr, &intent))
9009 /* The libpng documentation says this is right in this case. */
9010 png_set_gamma (png_ptr, screen_gamma, 0.45455);
9011 else
9012 #endif
9013 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
9014 /* Image contains gamma information. */
9015 png_set_gamma (png_ptr, screen_gamma, image_gamma);
9016 else
9017 /* Use the standard default for the image gamma. */
9018 png_set_gamma (png_ptr, screen_gamma, 0.45455);
9020 /* Handle alpha channel by combining the image with a background
9021 color. Do this only if a real alpha channel is supplied. For
9022 simple transparency, we prefer a clipping mask. */
9023 if (!transparent_p)
9025 png_color_16 *image_bg;
9026 Lisp_Object specified_bg
9027 = image_spec_value (img->spec, QCbackground, NULL);
9029 if (STRINGP (specified_bg))
9030 /* The user specified `:background', use that. */
9032 XColor color;
9033 if (x_defined_color (f, SDATA (specified_bg), &color, 0))
9035 png_color_16 user_bg;
9037 bzero (&user_bg, sizeof user_bg);
9038 user_bg.red = color.red;
9039 user_bg.green = color.green;
9040 user_bg.blue = color.blue;
9042 png_set_background (png_ptr, &user_bg,
9043 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
9046 else if (png_get_bKGD (png_ptr, info_ptr, &image_bg))
9047 /* Image contains a background color with which to
9048 combine the image. */
9049 png_set_background (png_ptr, image_bg,
9050 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
9051 else
9053 /* Image does not contain a background color with which
9054 to combine the image data via an alpha channel. Use
9055 the frame's background instead. */
9056 XColor color;
9057 Colormap cmap;
9058 png_color_16 frame_background;
9060 cmap = FRAME_X_COLORMAP (f);
9061 color.pixel = FRAME_BACKGROUND_PIXEL (f);
9062 x_query_color (f, &color);
9064 bzero (&frame_background, sizeof frame_background);
9065 frame_background.red = color.red;
9066 frame_background.green = color.green;
9067 frame_background.blue = color.blue;
9069 png_set_background (png_ptr, &frame_background,
9070 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
9074 /* Update info structure. */
9075 png_read_update_info (png_ptr, info_ptr);
9077 /* Get number of channels. Valid values are 1 for grayscale images
9078 and images with a palette, 2 for grayscale images with transparency
9079 information (alpha channel), 3 for RGB images, and 4 for RGB
9080 images with alpha channel, i.e. RGBA. If conversions above were
9081 sufficient we should only have 3 or 4 channels here. */
9082 channels = png_get_channels (png_ptr, info_ptr);
9083 xassert (channels == 3 || channels == 4);
9085 /* Number of bytes needed for one row of the image. */
9086 row_bytes = png_get_rowbytes (png_ptr, info_ptr);
9088 /* Allocate memory for the image. */
9089 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
9090 rows = (png_byte **) xmalloc (height * sizeof *rows);
9091 for (i = 0; i < height; ++i)
9092 rows[i] = pixels + i * row_bytes;
9094 /* Read the entire image. */
9095 png_read_image (png_ptr, rows);
9096 png_read_end (png_ptr, info_ptr);
9097 if (fp)
9099 fclose (fp);
9100 fp = NULL;
9103 /* Create the X image and pixmap. */
9104 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
9105 &img->pixmap))
9106 goto error;
9108 /* Create an image and pixmap serving as mask if the PNG image
9109 contains an alpha channel. */
9110 if (channels == 4
9111 && !transparent_p
9112 && !x_create_x_image_and_pixmap (f, width, height, 1,
9113 &mask_img, &img->mask))
9115 x_destroy_x_image (ximg);
9116 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
9117 img->pixmap = None;
9118 goto error;
9121 /* Fill the X image and mask from PNG data. */
9122 init_color_table ();
9124 for (y = 0; y < height; ++y)
9126 png_byte *p = rows[y];
9128 for (x = 0; x < width; ++x)
9130 unsigned r, g, b;
9132 r = *p++ << 8;
9133 g = *p++ << 8;
9134 b = *p++ << 8;
9135 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
9137 /* An alpha channel, aka mask channel, associates variable
9138 transparency with an image. Where other image formats
9139 support binary transparency---fully transparent or fully
9140 opaque---PNG allows up to 254 levels of partial transparency.
9141 The PNG library implements partial transparency by combining
9142 the image with a specified background color.
9144 I'm not sure how to handle this here nicely: because the
9145 background on which the image is displayed may change, for
9146 real alpha channel support, it would be necessary to create
9147 a new image for each possible background.
9149 What I'm doing now is that a mask is created if we have
9150 boolean transparency information. Otherwise I'm using
9151 the frame's background color to combine the image with. */
9153 if (channels == 4)
9155 if (mask_img)
9156 XPutPixel (mask_img, x, y, *p > 0);
9157 ++p;
9162 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
9163 /* Set IMG's background color from the PNG image, unless the user
9164 overrode it. */
9166 png_color_16 *bg;
9167 if (png_get_bKGD (png_ptr, info_ptr, &bg))
9169 img->background = lookup_rgb_color (f, bg->red, bg->green, bg->blue);
9170 img->background_valid = 1;
9174 /* Remember colors allocated for this image. */
9175 img->colors = colors_in_color_table (&img->ncolors);
9176 free_color_table ();
9178 /* Clean up. */
9179 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
9180 xfree (rows);
9181 xfree (pixels);
9183 img->width = width;
9184 img->height = height;
9186 /* Maybe fill in the background field while we have ximg handy. */
9187 IMAGE_BACKGROUND (img, f, ximg);
9189 /* Put the image into the pixmap, then free the X image and its buffer. */
9190 x_put_x_image (f, ximg, img->pixmap, width, height);
9191 x_destroy_x_image (ximg);
9193 /* Same for the mask. */
9194 if (mask_img)
9196 /* Fill in the background_transparent field while we have the mask
9197 handy. */
9198 image_background_transparent (img, f, mask_img);
9200 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
9201 x_destroy_x_image (mask_img);
9204 UNGCPRO;
9205 return 1;
9208 #endif /* HAVE_PNG != 0 */
9212 /***********************************************************************
9213 JPEG
9214 ***********************************************************************/
9216 #if HAVE_JPEG
9218 /* Work around a warning about HAVE_STDLIB_H being redefined in
9219 jconfig.h. */
9220 #ifdef HAVE_STDLIB_H
9221 #define HAVE_STDLIB_H_1
9222 #undef HAVE_STDLIB_H
9223 #endif /* HAVE_STLIB_H */
9225 #include <jpeglib.h>
9226 #include <jerror.h>
9227 #include <setjmp.h>
9229 #ifdef HAVE_STLIB_H_1
9230 #define HAVE_STDLIB_H 1
9231 #endif
9233 static int jpeg_image_p P_ ((Lisp_Object object));
9234 static int jpeg_load P_ ((struct frame *f, struct image *img));
9236 /* The symbol `jpeg' identifying images of this type. */
9238 Lisp_Object Qjpeg;
9240 /* Indices of image specification fields in gs_format, below. */
9242 enum jpeg_keyword_index
9244 JPEG_TYPE,
9245 JPEG_DATA,
9246 JPEG_FILE,
9247 JPEG_ASCENT,
9248 JPEG_MARGIN,
9249 JPEG_RELIEF,
9250 JPEG_ALGORITHM,
9251 JPEG_HEURISTIC_MASK,
9252 JPEG_MASK,
9253 JPEG_BACKGROUND,
9254 JPEG_LAST
9257 /* Vector of image_keyword structures describing the format
9258 of valid user-defined image specifications. */
9260 static struct image_keyword jpeg_format[JPEG_LAST] =
9262 {":type", IMAGE_SYMBOL_VALUE, 1},
9263 {":data", IMAGE_STRING_VALUE, 0},
9264 {":file", IMAGE_STRING_VALUE, 0},
9265 {":ascent", IMAGE_ASCENT_VALUE, 0},
9266 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9267 {":relief", IMAGE_INTEGER_VALUE, 0},
9268 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9269 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9270 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9271 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
9274 /* Structure describing the image type `jpeg'. */
9276 static struct image_type jpeg_type =
9278 &Qjpeg,
9279 jpeg_image_p,
9280 jpeg_load,
9281 x_clear_image,
9282 NULL
9286 /* Return non-zero if OBJECT is a valid JPEG image specification. */
9288 static int
9289 jpeg_image_p (object)
9290 Lisp_Object object;
9292 struct image_keyword fmt[JPEG_LAST];
9294 bcopy (jpeg_format, fmt, sizeof fmt);
9296 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
9297 return 0;
9299 /* Must specify either the :data or :file keyword. */
9300 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
9304 struct my_jpeg_error_mgr
9306 struct jpeg_error_mgr pub;
9307 jmp_buf setjmp_buffer;
9311 static void
9312 my_error_exit (cinfo)
9313 j_common_ptr cinfo;
9315 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
9316 longjmp (mgr->setjmp_buffer, 1);
9320 /* Init source method for JPEG data source manager. Called by
9321 jpeg_read_header() before any data is actually read. See
9322 libjpeg.doc from the JPEG lib distribution. */
9324 static void
9325 our_init_source (cinfo)
9326 j_decompress_ptr cinfo;
9331 /* Fill input buffer method for JPEG data source manager. Called
9332 whenever more data is needed. We read the whole image in one step,
9333 so this only adds a fake end of input marker at the end. */
9335 static boolean
9336 our_fill_input_buffer (cinfo)
9337 j_decompress_ptr cinfo;
9339 /* Insert a fake EOI marker. */
9340 struct jpeg_source_mgr *src = cinfo->src;
9341 static JOCTET buffer[2];
9343 buffer[0] = (JOCTET) 0xFF;
9344 buffer[1] = (JOCTET) JPEG_EOI;
9346 src->next_input_byte = buffer;
9347 src->bytes_in_buffer = 2;
9348 return TRUE;
9352 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
9353 is the JPEG data source manager. */
9355 static void
9356 our_skip_input_data (cinfo, num_bytes)
9357 j_decompress_ptr cinfo;
9358 long num_bytes;
9360 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
9362 if (src)
9364 if (num_bytes > src->bytes_in_buffer)
9365 ERREXIT (cinfo, JERR_INPUT_EOF);
9367 src->bytes_in_buffer -= num_bytes;
9368 src->next_input_byte += num_bytes;
9373 /* Method to terminate data source. Called by
9374 jpeg_finish_decompress() after all data has been processed. */
9376 static void
9377 our_term_source (cinfo)
9378 j_decompress_ptr cinfo;
9383 /* Set up the JPEG lib for reading an image from DATA which contains
9384 LEN bytes. CINFO is the decompression info structure created for
9385 reading the image. */
9387 static void
9388 jpeg_memory_src (cinfo, data, len)
9389 j_decompress_ptr cinfo;
9390 JOCTET *data;
9391 unsigned int len;
9393 struct jpeg_source_mgr *src;
9395 if (cinfo->src == NULL)
9397 /* First time for this JPEG object? */
9398 cinfo->src = (struct jpeg_source_mgr *)
9399 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
9400 sizeof (struct jpeg_source_mgr));
9401 src = (struct jpeg_source_mgr *) cinfo->src;
9402 src->next_input_byte = data;
9405 src = (struct jpeg_source_mgr *) cinfo->src;
9406 src->init_source = our_init_source;
9407 src->fill_input_buffer = our_fill_input_buffer;
9408 src->skip_input_data = our_skip_input_data;
9409 src->resync_to_restart = jpeg_resync_to_restart; /* Use default method. */
9410 src->term_source = our_term_source;
9411 src->bytes_in_buffer = len;
9412 src->next_input_byte = data;
9416 /* Load image IMG for use on frame F. Patterned after example.c
9417 from the JPEG lib. */
9419 static int
9420 jpeg_load (f, img)
9421 struct frame *f;
9422 struct image *img;
9424 struct jpeg_decompress_struct cinfo;
9425 struct my_jpeg_error_mgr mgr;
9426 Lisp_Object file, specified_file;
9427 Lisp_Object specified_data;
9428 FILE * volatile fp = NULL;
9429 JSAMPARRAY buffer;
9430 int row_stride, x, y;
9431 XImage *ximg = NULL;
9432 int rc;
9433 unsigned long *colors;
9434 int width, height;
9435 struct gcpro gcpro1;
9437 /* Open the JPEG file. */
9438 specified_file = image_spec_value (img->spec, QCfile, NULL);
9439 specified_data = image_spec_value (img->spec, QCdata, NULL);
9440 file = Qnil;
9441 GCPRO1 (file);
9443 if (NILP (specified_data))
9445 file = x_find_image_file (specified_file);
9446 if (!STRINGP (file))
9448 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9449 UNGCPRO;
9450 return 0;
9453 fp = fopen (SDATA (file), "r");
9454 if (fp == NULL)
9456 image_error ("Cannot open `%s'", file, Qnil);
9457 UNGCPRO;
9458 return 0;
9462 /* Customize libjpeg's error handling to call my_error_exit when an
9463 error is detected. This function will perform a longjmp. */
9464 cinfo.err = jpeg_std_error (&mgr.pub);
9465 mgr.pub.error_exit = my_error_exit;
9467 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
9469 if (rc == 1)
9471 /* Called from my_error_exit. Display a JPEG error. */
9472 char buffer[JMSG_LENGTH_MAX];
9473 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
9474 image_error ("Error reading JPEG image `%s': %s", img->spec,
9475 build_string (buffer));
9478 /* Close the input file and destroy the JPEG object. */
9479 if (fp)
9480 fclose ((FILE *) fp);
9481 jpeg_destroy_decompress (&cinfo);
9483 /* If we already have an XImage, free that. */
9484 x_destroy_x_image (ximg);
9486 /* Free pixmap and colors. */
9487 x_clear_image (f, img);
9489 UNGCPRO;
9490 return 0;
9493 /* Create the JPEG decompression object. Let it read from fp.
9494 Read the JPEG image header. */
9495 jpeg_create_decompress (&cinfo);
9497 if (NILP (specified_data))
9498 jpeg_stdio_src (&cinfo, (FILE *) fp);
9499 else
9500 jpeg_memory_src (&cinfo, SDATA (specified_data),
9501 SBYTES (specified_data));
9503 jpeg_read_header (&cinfo, TRUE);
9505 /* Customize decompression so that color quantization will be used.
9506 Start decompression. */
9507 cinfo.quantize_colors = TRUE;
9508 jpeg_start_decompress (&cinfo);
9509 width = img->width = cinfo.output_width;
9510 height = img->height = cinfo.output_height;
9512 /* Create X image and pixmap. */
9513 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9514 longjmp (mgr.setjmp_buffer, 2);
9516 /* Allocate colors. When color quantization is used,
9517 cinfo.actual_number_of_colors has been set with the number of
9518 colors generated, and cinfo.colormap is a two-dimensional array
9519 of color indices in the range 0..cinfo.actual_number_of_colors.
9520 No more than 255 colors will be generated. */
9522 int i, ir, ig, ib;
9524 if (cinfo.out_color_components > 2)
9525 ir = 0, ig = 1, ib = 2;
9526 else if (cinfo.out_color_components > 1)
9527 ir = 0, ig = 1, ib = 0;
9528 else
9529 ir = 0, ig = 0, ib = 0;
9531 /* Use the color table mechanism because it handles colors that
9532 cannot be allocated nicely. Such colors will be replaced with
9533 a default color, and we don't have to care about which colors
9534 can be freed safely, and which can't. */
9535 init_color_table ();
9536 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
9537 * sizeof *colors);
9539 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
9541 /* Multiply RGB values with 255 because X expects RGB values
9542 in the range 0..0xffff. */
9543 int r = cinfo.colormap[ir][i] << 8;
9544 int g = cinfo.colormap[ig][i] << 8;
9545 int b = cinfo.colormap[ib][i] << 8;
9546 colors[i] = lookup_rgb_color (f, r, g, b);
9549 /* Remember those colors actually allocated. */
9550 img->colors = colors_in_color_table (&img->ncolors);
9551 free_color_table ();
9554 /* Read pixels. */
9555 row_stride = width * cinfo.output_components;
9556 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
9557 row_stride, 1);
9558 for (y = 0; y < height; ++y)
9560 jpeg_read_scanlines (&cinfo, buffer, 1);
9561 for (x = 0; x < cinfo.output_width; ++x)
9562 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
9565 /* Clean up. */
9566 jpeg_finish_decompress (&cinfo);
9567 jpeg_destroy_decompress (&cinfo);
9568 if (fp)
9569 fclose ((FILE *) fp);
9571 /* Maybe fill in the background field while we have ximg handy. */
9572 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
9573 IMAGE_BACKGROUND (img, f, ximg);
9575 /* Put the image into the pixmap. */
9576 x_put_x_image (f, ximg, img->pixmap, width, height);
9577 x_destroy_x_image (ximg);
9578 UNGCPRO;
9579 return 1;
9582 #endif /* HAVE_JPEG */
9586 /***********************************************************************
9587 TIFF
9588 ***********************************************************************/
9590 #if HAVE_TIFF
9592 #include <tiffio.h>
9594 static int tiff_image_p P_ ((Lisp_Object object));
9595 static int tiff_load P_ ((struct frame *f, struct image *img));
9597 /* The symbol `tiff' identifying images of this type. */
9599 Lisp_Object Qtiff;
9601 /* Indices of image specification fields in tiff_format, below. */
9603 enum tiff_keyword_index
9605 TIFF_TYPE,
9606 TIFF_DATA,
9607 TIFF_FILE,
9608 TIFF_ASCENT,
9609 TIFF_MARGIN,
9610 TIFF_RELIEF,
9611 TIFF_ALGORITHM,
9612 TIFF_HEURISTIC_MASK,
9613 TIFF_MASK,
9614 TIFF_BACKGROUND,
9615 TIFF_LAST
9618 /* Vector of image_keyword structures describing the format
9619 of valid user-defined image specifications. */
9621 static struct image_keyword tiff_format[TIFF_LAST] =
9623 {":type", IMAGE_SYMBOL_VALUE, 1},
9624 {":data", IMAGE_STRING_VALUE, 0},
9625 {":file", IMAGE_STRING_VALUE, 0},
9626 {":ascent", IMAGE_ASCENT_VALUE, 0},
9627 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9628 {":relief", IMAGE_INTEGER_VALUE, 0},
9629 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9630 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9631 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9632 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
9635 /* Structure describing the image type `tiff'. */
9637 static struct image_type tiff_type =
9639 &Qtiff,
9640 tiff_image_p,
9641 tiff_load,
9642 x_clear_image,
9643 NULL
9647 /* Return non-zero if OBJECT is a valid TIFF image specification. */
9649 static int
9650 tiff_image_p (object)
9651 Lisp_Object object;
9653 struct image_keyword fmt[TIFF_LAST];
9654 bcopy (tiff_format, fmt, sizeof fmt);
9656 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
9657 return 0;
9659 /* Must specify either the :data or :file keyword. */
9660 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
9664 /* Reading from a memory buffer for TIFF images Based on the PNG
9665 memory source, but we have to provide a lot of extra functions.
9666 Blah.
9668 We really only need to implement read and seek, but I am not
9669 convinced that the TIFF library is smart enough not to destroy
9670 itself if we only hand it the function pointers we need to
9671 override. */
9673 typedef struct
9675 unsigned char *bytes;
9676 size_t len;
9677 int index;
9679 tiff_memory_source;
9682 static size_t
9683 tiff_read_from_memory (data, buf, size)
9684 thandle_t data;
9685 tdata_t buf;
9686 tsize_t size;
9688 tiff_memory_source *src = (tiff_memory_source *) data;
9690 if (size > src->len - src->index)
9691 return (size_t) -1;
9692 bcopy (src->bytes + src->index, buf, size);
9693 src->index += size;
9694 return size;
9698 static size_t
9699 tiff_write_from_memory (data, buf, size)
9700 thandle_t data;
9701 tdata_t buf;
9702 tsize_t size;
9704 return (size_t) -1;
9708 static toff_t
9709 tiff_seek_in_memory (data, off, whence)
9710 thandle_t data;
9711 toff_t off;
9712 int whence;
9714 tiff_memory_source *src = (tiff_memory_source *) data;
9715 int idx;
9717 switch (whence)
9719 case SEEK_SET: /* Go from beginning of source. */
9720 idx = off;
9721 break;
9723 case SEEK_END: /* Go from end of source. */
9724 idx = src->len + off;
9725 break;
9727 case SEEK_CUR: /* Go from current position. */
9728 idx = src->index + off;
9729 break;
9731 default: /* Invalid `whence'. */
9732 return -1;
9735 if (idx > src->len || idx < 0)
9736 return -1;
9738 src->index = idx;
9739 return src->index;
9743 static int
9744 tiff_close_memory (data)
9745 thandle_t data;
9747 /* NOOP */
9748 return 0;
9752 static int
9753 tiff_mmap_memory (data, pbase, psize)
9754 thandle_t data;
9755 tdata_t *pbase;
9756 toff_t *psize;
9758 /* It is already _IN_ memory. */
9759 return 0;
9763 static void
9764 tiff_unmap_memory (data, base, size)
9765 thandle_t data;
9766 tdata_t base;
9767 toff_t size;
9769 /* We don't need to do this. */
9773 static toff_t
9774 tiff_size_of_memory (data)
9775 thandle_t data;
9777 return ((tiff_memory_source *) data)->len;
9781 static void
9782 tiff_error_handler (title, format, ap)
9783 const char *title, *format;
9784 va_list ap;
9786 char buf[512];
9787 int len;
9789 len = sprintf (buf, "TIFF error: %s ", title);
9790 vsprintf (buf + len, format, ap);
9791 add_to_log (buf, Qnil, Qnil);
9795 static void
9796 tiff_warning_handler (title, format, ap)
9797 const char *title, *format;
9798 va_list ap;
9800 char buf[512];
9801 int len;
9803 len = sprintf (buf, "TIFF warning: %s ", title);
9804 vsprintf (buf + len, format, ap);
9805 add_to_log (buf, Qnil, Qnil);
9809 /* Load TIFF image IMG for use on frame F. Value is non-zero if
9810 successful. */
9812 static int
9813 tiff_load (f, img)
9814 struct frame *f;
9815 struct image *img;
9817 Lisp_Object file, specified_file;
9818 Lisp_Object specified_data;
9819 TIFF *tiff;
9820 int width, height, x, y;
9821 uint32 *buf;
9822 int rc;
9823 XImage *ximg;
9824 struct gcpro gcpro1;
9825 tiff_memory_source memsrc;
9827 specified_file = image_spec_value (img->spec, QCfile, NULL);
9828 specified_data = image_spec_value (img->spec, QCdata, NULL);
9829 file = Qnil;
9830 GCPRO1 (file);
9832 TIFFSetErrorHandler (tiff_error_handler);
9833 TIFFSetWarningHandler (tiff_warning_handler);
9835 if (NILP (specified_data))
9837 /* Read from a file */
9838 file = x_find_image_file (specified_file);
9839 if (!STRINGP (file))
9841 image_error ("Cannot find image file `%s'", file, Qnil);
9842 UNGCPRO;
9843 return 0;
9846 /* Try to open the image file. */
9847 tiff = TIFFOpen (SDATA (file), "r");
9848 if (tiff == NULL)
9850 image_error ("Cannot open `%s'", file, Qnil);
9851 UNGCPRO;
9852 return 0;
9855 else
9857 /* Memory source! */
9858 memsrc.bytes = SDATA (specified_data);
9859 memsrc.len = SBYTES (specified_data);
9860 memsrc.index = 0;
9862 tiff = TIFFClientOpen ("memory_source", "r", &memsrc,
9863 (TIFFReadWriteProc) tiff_read_from_memory,
9864 (TIFFReadWriteProc) tiff_write_from_memory,
9865 tiff_seek_in_memory,
9866 tiff_close_memory,
9867 tiff_size_of_memory,
9868 tiff_mmap_memory,
9869 tiff_unmap_memory);
9871 if (!tiff)
9873 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
9874 UNGCPRO;
9875 return 0;
9879 /* Get width and height of the image, and allocate a raster buffer
9880 of width x height 32-bit values. */
9881 TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
9882 TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
9883 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
9885 rc = TIFFReadRGBAImage (tiff, width, height, buf, 0);
9886 TIFFClose (tiff);
9887 if (!rc)
9889 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
9890 xfree (buf);
9891 UNGCPRO;
9892 return 0;
9895 /* Create the X image and pixmap. */
9896 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9898 xfree (buf);
9899 UNGCPRO;
9900 return 0;
9903 /* Initialize the color table. */
9904 init_color_table ();
9906 /* Process the pixel raster. Origin is in the lower-left corner. */
9907 for (y = 0; y < height; ++y)
9909 uint32 *row = buf + y * width;
9911 for (x = 0; x < width; ++x)
9913 uint32 abgr = row[x];
9914 int r = TIFFGetR (abgr) << 8;
9915 int g = TIFFGetG (abgr) << 8;
9916 int b = TIFFGetB (abgr) << 8;
9917 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
9921 /* Remember the colors allocated for the image. Free the color table. */
9922 img->colors = colors_in_color_table (&img->ncolors);
9923 free_color_table ();
9925 img->width = width;
9926 img->height = height;
9928 /* Maybe fill in the background field while we have ximg handy. */
9929 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
9930 IMAGE_BACKGROUND (img, f, ximg);
9932 /* Put the image into the pixmap, then free the X image and its buffer. */
9933 x_put_x_image (f, ximg, img->pixmap, width, height);
9934 x_destroy_x_image (ximg);
9935 xfree (buf);
9937 UNGCPRO;
9938 return 1;
9941 #endif /* HAVE_TIFF != 0 */
9945 /***********************************************************************
9947 ***********************************************************************/
9949 #if HAVE_GIF
9951 #include <gif_lib.h>
9953 static int gif_image_p P_ ((Lisp_Object object));
9954 static int gif_load P_ ((struct frame *f, struct image *img));
9956 /* The symbol `gif' identifying images of this type. */
9958 Lisp_Object Qgif;
9960 /* Indices of image specification fields in gif_format, below. */
9962 enum gif_keyword_index
9964 GIF_TYPE,
9965 GIF_DATA,
9966 GIF_FILE,
9967 GIF_ASCENT,
9968 GIF_MARGIN,
9969 GIF_RELIEF,
9970 GIF_ALGORITHM,
9971 GIF_HEURISTIC_MASK,
9972 GIF_MASK,
9973 GIF_IMAGE,
9974 GIF_BACKGROUND,
9975 GIF_LAST
9978 /* Vector of image_keyword structures describing the format
9979 of valid user-defined image specifications. */
9981 static struct image_keyword gif_format[GIF_LAST] =
9983 {":type", IMAGE_SYMBOL_VALUE, 1},
9984 {":data", IMAGE_STRING_VALUE, 0},
9985 {":file", IMAGE_STRING_VALUE, 0},
9986 {":ascent", IMAGE_ASCENT_VALUE, 0},
9987 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9988 {":relief", IMAGE_INTEGER_VALUE, 0},
9989 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9990 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9991 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9992 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0},
9993 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
9996 /* Structure describing the image type `gif'. */
9998 static struct image_type gif_type =
10000 &Qgif,
10001 gif_image_p,
10002 gif_load,
10003 x_clear_image,
10004 NULL
10008 /* Return non-zero if OBJECT is a valid GIF image specification. */
10010 static int
10011 gif_image_p (object)
10012 Lisp_Object object;
10014 struct image_keyword fmt[GIF_LAST];
10015 bcopy (gif_format, fmt, sizeof fmt);
10017 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
10018 return 0;
10020 /* Must specify either the :data or :file keyword. */
10021 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
10025 /* Reading a GIF image from memory
10026 Based on the PNG memory stuff to a certain extent. */
10028 typedef struct
10030 unsigned char *bytes;
10031 size_t len;
10032 int index;
10034 gif_memory_source;
10037 /* Make the current memory source available to gif_read_from_memory.
10038 It's done this way because not all versions of libungif support
10039 a UserData field in the GifFileType structure. */
10040 static gif_memory_source *current_gif_memory_src;
10042 static int
10043 gif_read_from_memory (file, buf, len)
10044 GifFileType *file;
10045 GifByteType *buf;
10046 int len;
10048 gif_memory_source *src = current_gif_memory_src;
10050 if (len > src->len - src->index)
10051 return -1;
10053 bcopy (src->bytes + src->index, buf, len);
10054 src->index += len;
10055 return len;
10059 /* Load GIF image IMG for use on frame F. Value is non-zero if
10060 successful. */
10062 static int
10063 gif_load (f, img)
10064 struct frame *f;
10065 struct image *img;
10067 Lisp_Object file, specified_file;
10068 Lisp_Object specified_data;
10069 int rc, width, height, x, y, i;
10070 XImage *ximg;
10071 ColorMapObject *gif_color_map;
10072 unsigned long pixel_colors[256];
10073 GifFileType *gif;
10074 struct gcpro gcpro1;
10075 Lisp_Object image;
10076 int ino, image_left, image_top, image_width, image_height;
10077 gif_memory_source memsrc;
10078 unsigned char *raster;
10080 specified_file = image_spec_value (img->spec, QCfile, NULL);
10081 specified_data = image_spec_value (img->spec, QCdata, NULL);
10082 file = Qnil;
10083 GCPRO1 (file);
10085 if (NILP (specified_data))
10087 file = x_find_image_file (specified_file);
10088 if (!STRINGP (file))
10090 image_error ("Cannot find image file `%s'", specified_file, Qnil);
10091 UNGCPRO;
10092 return 0;
10095 /* Open the GIF file. */
10096 gif = DGifOpenFileName (SDATA (file));
10097 if (gif == NULL)
10099 image_error ("Cannot open `%s'", file, Qnil);
10100 UNGCPRO;
10101 return 0;
10104 else
10106 /* Read from memory! */
10107 current_gif_memory_src = &memsrc;
10108 memsrc.bytes = SDATA (specified_data);
10109 memsrc.len = SBYTES (specified_data);
10110 memsrc.index = 0;
10112 gif = DGifOpen(&memsrc, gif_read_from_memory);
10113 if (!gif)
10115 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
10116 UNGCPRO;
10117 return 0;
10121 /* Read entire contents. */
10122 rc = DGifSlurp (gif);
10123 if (rc == GIF_ERROR)
10125 image_error ("Error reading `%s'", img->spec, Qnil);
10126 DGifCloseFile (gif);
10127 UNGCPRO;
10128 return 0;
10131 image = image_spec_value (img->spec, QCindex, NULL);
10132 ino = INTEGERP (image) ? XFASTINT (image) : 0;
10133 if (ino >= gif->ImageCount)
10135 image_error ("Invalid image number `%s' in image `%s'",
10136 image, img->spec);
10137 DGifCloseFile (gif);
10138 UNGCPRO;
10139 return 0;
10142 width = img->width = max (gif->SWidth, gif->Image.Left + gif->Image.Width);
10143 height = img->height = max (gif->SHeight, gif->Image.Top + gif->Image.Height);
10145 /* Create the X image and pixmap. */
10146 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
10148 DGifCloseFile (gif);
10149 UNGCPRO;
10150 return 0;
10153 /* Allocate colors. */
10154 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
10155 if (!gif_color_map)
10156 gif_color_map = gif->SColorMap;
10157 init_color_table ();
10158 bzero (pixel_colors, sizeof pixel_colors);
10160 for (i = 0; i < gif_color_map->ColorCount; ++i)
10162 int r = gif_color_map->Colors[i].Red << 8;
10163 int g = gif_color_map->Colors[i].Green << 8;
10164 int b = gif_color_map->Colors[i].Blue << 8;
10165 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
10168 img->colors = colors_in_color_table (&img->ncolors);
10169 free_color_table ();
10171 /* Clear the part of the screen image that are not covered by
10172 the image from the GIF file. Full animated GIF support
10173 requires more than can be done here (see the gif89 spec,
10174 disposal methods). Let's simply assume that the part
10175 not covered by a sub-image is in the frame's background color. */
10176 image_top = gif->SavedImages[ino].ImageDesc.Top;
10177 image_left = gif->SavedImages[ino].ImageDesc.Left;
10178 image_width = gif->SavedImages[ino].ImageDesc.Width;
10179 image_height = gif->SavedImages[ino].ImageDesc.Height;
10181 for (y = 0; y < image_top; ++y)
10182 for (x = 0; x < width; ++x)
10183 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
10185 for (y = image_top + image_height; y < height; ++y)
10186 for (x = 0; x < width; ++x)
10187 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
10189 for (y = image_top; y < image_top + image_height; ++y)
10191 for (x = 0; x < image_left; ++x)
10192 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
10193 for (x = image_left + image_width; x < width; ++x)
10194 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
10197 /* Read the GIF image into the X image. We use a local variable
10198 `raster' here because RasterBits below is a char *, and invites
10199 problems with bytes >= 0x80. */
10200 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
10202 if (gif->SavedImages[ino].ImageDesc.Interlace)
10204 static int interlace_start[] = {0, 4, 2, 1};
10205 static int interlace_increment[] = {8, 8, 4, 2};
10206 int pass;
10207 int row = interlace_start[0];
10209 pass = 0;
10211 for (y = 0; y < image_height; y++)
10213 if (row >= image_height)
10215 row = interlace_start[++pass];
10216 while (row >= image_height)
10217 row = interlace_start[++pass];
10220 for (x = 0; x < image_width; x++)
10222 int i = raster[(y * image_width) + x];
10223 XPutPixel (ximg, x + image_left, row + image_top,
10224 pixel_colors[i]);
10227 row += interlace_increment[pass];
10230 else
10232 for (y = 0; y < image_height; ++y)
10233 for (x = 0; x < image_width; ++x)
10235 int i = raster[y * image_width + x];
10236 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
10240 DGifCloseFile (gif);
10242 /* Maybe fill in the background field while we have ximg handy. */
10243 if (NILP (image_spec_value (img->spec, QCbackground, NULL)))
10244 IMAGE_BACKGROUND (img, f, ximg);
10246 /* Put the image into the pixmap, then free the X image and its buffer. */
10247 x_put_x_image (f, ximg, img->pixmap, width, height);
10248 x_destroy_x_image (ximg);
10250 UNGCPRO;
10251 return 1;
10254 #endif /* HAVE_GIF != 0 */
10258 /***********************************************************************
10259 Ghostscript
10260 ***********************************************************************/
10262 static int gs_image_p P_ ((Lisp_Object object));
10263 static int gs_load P_ ((struct frame *f, struct image *img));
10264 static void gs_clear_image P_ ((struct frame *f, struct image *img));
10266 /* The symbol `postscript' identifying images of this type. */
10268 Lisp_Object Qpostscript;
10270 /* Keyword symbols. */
10272 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
10274 /* Indices of image specification fields in gs_format, below. */
10276 enum gs_keyword_index
10278 GS_TYPE,
10279 GS_PT_WIDTH,
10280 GS_PT_HEIGHT,
10281 GS_FILE,
10282 GS_LOADER,
10283 GS_BOUNDING_BOX,
10284 GS_ASCENT,
10285 GS_MARGIN,
10286 GS_RELIEF,
10287 GS_ALGORITHM,
10288 GS_HEURISTIC_MASK,
10289 GS_MASK,
10290 GS_BACKGROUND,
10291 GS_LAST
10294 /* Vector of image_keyword structures describing the format
10295 of valid user-defined image specifications. */
10297 static struct image_keyword gs_format[GS_LAST] =
10299 {":type", IMAGE_SYMBOL_VALUE, 1},
10300 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
10301 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
10302 {":file", IMAGE_STRING_VALUE, 1},
10303 {":loader", IMAGE_FUNCTION_VALUE, 0},
10304 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
10305 {":ascent", IMAGE_ASCENT_VALUE, 0},
10306 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
10307 {":relief", IMAGE_INTEGER_VALUE, 0},
10308 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
10309 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
10310 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
10311 {":background", IMAGE_STRING_OR_NIL_VALUE, 0}
10314 /* Structure describing the image type `ghostscript'. */
10316 static struct image_type gs_type =
10318 &Qpostscript,
10319 gs_image_p,
10320 gs_load,
10321 gs_clear_image,
10322 NULL
10326 /* Free X resources of Ghostscript image IMG which is used on frame F. */
10328 static void
10329 gs_clear_image (f, img)
10330 struct frame *f;
10331 struct image *img;
10333 /* IMG->data.ptr_val may contain a recorded colormap. */
10334 xfree (img->data.ptr_val);
10335 x_clear_image (f, img);
10339 /* Return non-zero if OBJECT is a valid Ghostscript image
10340 specification. */
10342 static int
10343 gs_image_p (object)
10344 Lisp_Object object;
10346 struct image_keyword fmt[GS_LAST];
10347 Lisp_Object tem;
10348 int i;
10350 bcopy (gs_format, fmt, sizeof fmt);
10352 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
10353 return 0;
10355 /* Bounding box must be a list or vector containing 4 integers. */
10356 tem = fmt[GS_BOUNDING_BOX].value;
10357 if (CONSP (tem))
10359 for (i = 0; i < 4; ++i, tem = XCDR (tem))
10360 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
10361 return 0;
10362 if (!NILP (tem))
10363 return 0;
10365 else if (VECTORP (tem))
10367 if (XVECTOR (tem)->size != 4)
10368 return 0;
10369 for (i = 0; i < 4; ++i)
10370 if (!INTEGERP (XVECTOR (tem)->contents[i]))
10371 return 0;
10373 else
10374 return 0;
10376 return 1;
10380 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
10381 if successful. */
10383 static int
10384 gs_load (f, img)
10385 struct frame *f;
10386 struct image *img;
10388 char buffer[100];
10389 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
10390 struct gcpro gcpro1, gcpro2;
10391 Lisp_Object frame;
10392 double in_width, in_height;
10393 Lisp_Object pixel_colors = Qnil;
10395 /* Compute pixel size of pixmap needed from the given size in the
10396 image specification. Sizes in the specification are in pt. 1 pt
10397 = 1/72 in, xdpi and ydpi are stored in the frame's X display
10398 info. */
10399 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
10400 in_width = XFASTINT (pt_width) / 72.0;
10401 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
10402 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
10403 in_height = XFASTINT (pt_height) / 72.0;
10404 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
10406 /* Create the pixmap. */
10407 xassert (img->pixmap == None);
10408 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10409 img->width, img->height,
10410 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
10412 if (!img->pixmap)
10414 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
10415 return 0;
10418 /* Call the loader to fill the pixmap. It returns a process object
10419 if successful. We do not record_unwind_protect here because
10420 other places in redisplay like calling window scroll functions
10421 don't either. Let the Lisp loader use `unwind-protect' instead. */
10422 GCPRO2 (window_and_pixmap_id, pixel_colors);
10424 sprintf (buffer, "%lu %lu",
10425 (unsigned long) FRAME_X_WINDOW (f),
10426 (unsigned long) img->pixmap);
10427 window_and_pixmap_id = build_string (buffer);
10429 sprintf (buffer, "%lu %lu",
10430 FRAME_FOREGROUND_PIXEL (f),
10431 FRAME_BACKGROUND_PIXEL (f));
10432 pixel_colors = build_string (buffer);
10434 XSETFRAME (frame, f);
10435 loader = image_spec_value (img->spec, QCloader, NULL);
10436 if (NILP (loader))
10437 loader = intern ("gs-load-image");
10439 img->data.lisp_val = call6 (loader, frame, img->spec,
10440 make_number (img->width),
10441 make_number (img->height),
10442 window_and_pixmap_id,
10443 pixel_colors);
10444 UNGCPRO;
10445 return PROCESSP (img->data.lisp_val);
10449 /* Kill the Ghostscript process that was started to fill PIXMAP on
10450 frame F. Called from XTread_socket when receiving an event
10451 telling Emacs that Ghostscript has finished drawing. */
10453 void
10454 x_kill_gs_process (pixmap, f)
10455 Pixmap pixmap;
10456 struct frame *f;
10458 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
10459 int class, i;
10460 struct image *img;
10462 /* Find the image containing PIXMAP. */
10463 for (i = 0; i < c->used; ++i)
10464 if (c->images[i]->pixmap == pixmap)
10465 break;
10467 /* Should someone in between have cleared the image cache, for
10468 instance, give up. */
10469 if (i == c->used)
10470 return;
10472 /* Kill the GS process. We should have found PIXMAP in the image
10473 cache and its image should contain a process object. */
10474 img = c->images[i];
10475 xassert (PROCESSP (img->data.lisp_val));
10476 Fkill_process (img->data.lisp_val, Qnil);
10477 img->data.lisp_val = Qnil;
10479 /* On displays with a mutable colormap, figure out the colors
10480 allocated for the image by looking at the pixels of an XImage for
10481 img->pixmap. */
10482 class = FRAME_X_VISUAL (f)->class;
10483 if (class != StaticColor && class != StaticGray && class != TrueColor)
10485 XImage *ximg;
10487 BLOCK_INPUT;
10489 /* Try to get an XImage for img->pixmep. */
10490 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
10491 0, 0, img->width, img->height, ~0, ZPixmap);
10492 if (ximg)
10494 int x, y;
10496 /* Initialize the color table. */
10497 init_color_table ();
10499 /* For each pixel of the image, look its color up in the
10500 color table. After having done so, the color table will
10501 contain an entry for each color used by the image. */
10502 for (y = 0; y < img->height; ++y)
10503 for (x = 0; x < img->width; ++x)
10505 unsigned long pixel = XGetPixel (ximg, x, y);
10506 lookup_pixel_color (f, pixel);
10509 /* Record colors in the image. Free color table and XImage. */
10510 img->colors = colors_in_color_table (&img->ncolors);
10511 free_color_table ();
10512 XDestroyImage (ximg);
10514 #if 0 /* This doesn't seem to be the case. If we free the colors
10515 here, we get a BadAccess later in x_clear_image when
10516 freeing the colors. */
10517 /* We have allocated colors once, but Ghostscript has also
10518 allocated colors on behalf of us. So, to get the
10519 reference counts right, free them once. */
10520 if (img->ncolors)
10521 x_free_colors (f, img->colors, img->ncolors);
10522 #endif
10524 else
10525 image_error ("Cannot get X image of `%s'; colors will not be freed",
10526 img->spec, Qnil);
10528 UNBLOCK_INPUT;
10531 /* Now that we have the pixmap, compute mask and transform the
10532 image if requested. */
10533 BLOCK_INPUT;
10534 postprocess_image (f, img);
10535 UNBLOCK_INPUT;
10540 /***********************************************************************
10541 Window properties
10542 ***********************************************************************/
10544 DEFUN ("x-change-window-property", Fx_change_window_property,
10545 Sx_change_window_property, 2, 3, 0,
10546 doc: /* Change window property PROP to VALUE on the X window of FRAME.
10547 PROP and VALUE must be strings. FRAME nil or omitted means use the
10548 selected frame. Value is VALUE. */)
10549 (prop, value, frame)
10550 Lisp_Object frame, prop, value;
10552 struct frame *f = check_x_frame (frame);
10553 Atom prop_atom;
10555 CHECK_STRING (prop);
10556 CHECK_STRING (value);
10558 BLOCK_INPUT;
10559 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
10560 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10561 prop_atom, XA_STRING, 8, PropModeReplace,
10562 SDATA (value), SCHARS (value));
10564 /* Make sure the property is set when we return. */
10565 XFlush (FRAME_X_DISPLAY (f));
10566 UNBLOCK_INPUT;
10568 return value;
10572 DEFUN ("x-delete-window-property", Fx_delete_window_property,
10573 Sx_delete_window_property, 1, 2, 0,
10574 doc: /* Remove window property PROP from X window of FRAME.
10575 FRAME nil or omitted means use the selected frame. Value is PROP. */)
10576 (prop, frame)
10577 Lisp_Object prop, frame;
10579 struct frame *f = check_x_frame (frame);
10580 Atom prop_atom;
10582 CHECK_STRING (prop);
10583 BLOCK_INPUT;
10584 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
10585 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
10587 /* Make sure the property is removed when we return. */
10588 XFlush (FRAME_X_DISPLAY (f));
10589 UNBLOCK_INPUT;
10591 return prop;
10595 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
10596 1, 2, 0,
10597 doc: /* Value is the value of window property PROP on FRAME.
10598 If FRAME is nil or omitted, use the selected frame. Value is nil
10599 if FRAME hasn't a property with name PROP or if PROP has no string
10600 value. */)
10601 (prop, frame)
10602 Lisp_Object prop, frame;
10604 struct frame *f = check_x_frame (frame);
10605 Atom prop_atom;
10606 int rc;
10607 Lisp_Object prop_value = Qnil;
10608 char *tmp_data = NULL;
10609 Atom actual_type;
10610 int actual_format;
10611 unsigned long actual_size, bytes_remaining;
10613 CHECK_STRING (prop);
10614 BLOCK_INPUT;
10615 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), SDATA (prop), False);
10616 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10617 prop_atom, 0, 0, False, XA_STRING,
10618 &actual_type, &actual_format, &actual_size,
10619 &bytes_remaining, (unsigned char **) &tmp_data);
10620 if (rc == Success)
10622 int size = bytes_remaining;
10624 XFree (tmp_data);
10625 tmp_data = NULL;
10627 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10628 prop_atom, 0, bytes_remaining,
10629 False, XA_STRING,
10630 &actual_type, &actual_format,
10631 &actual_size, &bytes_remaining,
10632 (unsigned char **) &tmp_data);
10633 if (rc == Success && tmp_data)
10634 prop_value = make_string (tmp_data, size);
10636 XFree (tmp_data);
10639 UNBLOCK_INPUT;
10640 return prop_value;
10645 /***********************************************************************
10646 Busy cursor
10647 ***********************************************************************/
10649 /* If non-null, an asynchronous timer that, when it expires, displays
10650 an hourglass cursor on all frames. */
10652 static struct atimer *hourglass_atimer;
10654 /* Non-zero means an hourglass cursor is currently shown. */
10656 static int hourglass_shown_p;
10658 /* Number of seconds to wait before displaying an hourglass cursor. */
10660 static Lisp_Object Vhourglass_delay;
10662 /* Default number of seconds to wait before displaying an hourglass
10663 cursor. */
10665 #define DEFAULT_HOURGLASS_DELAY 1
10667 /* Function prototypes. */
10669 static void show_hourglass P_ ((struct atimer *));
10670 static void hide_hourglass P_ ((void));
10673 /* Cancel a currently active hourglass timer, and start a new one. */
10675 void
10676 start_hourglass ()
10678 EMACS_TIME delay;
10679 int secs, usecs = 0;
10681 cancel_hourglass ();
10683 if (INTEGERP (Vhourglass_delay)
10684 && XINT (Vhourglass_delay) > 0)
10685 secs = XFASTINT (Vhourglass_delay);
10686 else if (FLOATP (Vhourglass_delay)
10687 && XFLOAT_DATA (Vhourglass_delay) > 0)
10689 Lisp_Object tem;
10690 tem = Ftruncate (Vhourglass_delay, Qnil);
10691 secs = XFASTINT (tem);
10692 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
10694 else
10695 secs = DEFAULT_HOURGLASS_DELAY;
10697 EMACS_SET_SECS_USECS (delay, secs, usecs);
10698 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
10699 show_hourglass, NULL);
10703 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
10704 shown. */
10706 void
10707 cancel_hourglass ()
10709 if (hourglass_atimer)
10711 cancel_atimer (hourglass_atimer);
10712 hourglass_atimer = NULL;
10715 if (hourglass_shown_p)
10716 hide_hourglass ();
10720 /* Timer function of hourglass_atimer. TIMER is equal to
10721 hourglass_atimer.
10723 Display an hourglass pointer on all frames by mapping the frames'
10724 hourglass_window. Set the hourglass_p flag in the frames'
10725 output_data.x structure to indicate that an hourglass cursor is
10726 shown on the frames. */
10728 static void
10729 show_hourglass (timer)
10730 struct atimer *timer;
10732 /* The timer implementation will cancel this timer automatically
10733 after this function has run. Set hourglass_atimer to null
10734 so that we know the timer doesn't have to be canceled. */
10735 hourglass_atimer = NULL;
10737 if (!hourglass_shown_p)
10739 Lisp_Object rest, frame;
10741 BLOCK_INPUT;
10743 FOR_EACH_FRAME (rest, frame)
10745 struct frame *f = XFRAME (frame);
10747 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
10749 Display *dpy = FRAME_X_DISPLAY (f);
10751 #ifdef USE_X_TOOLKIT
10752 if (f->output_data.x->widget)
10753 #else
10754 if (FRAME_OUTER_WINDOW (f))
10755 #endif
10757 f->output_data.x->hourglass_p = 1;
10759 if (!f->output_data.x->hourglass_window)
10761 unsigned long mask = CWCursor;
10762 XSetWindowAttributes attrs;
10764 attrs.cursor = f->output_data.x->hourglass_cursor;
10766 f->output_data.x->hourglass_window
10767 = XCreateWindow (dpy, FRAME_OUTER_WINDOW (f),
10768 0, 0, 32000, 32000, 0, 0,
10769 InputOnly,
10770 CopyFromParent,
10771 mask, &attrs);
10774 XMapRaised (dpy, f->output_data.x->hourglass_window);
10775 XFlush (dpy);
10780 hourglass_shown_p = 1;
10781 UNBLOCK_INPUT;
10786 /* Hide the hourglass pointer on all frames, if it is currently
10787 shown. */
10789 static void
10790 hide_hourglass ()
10792 if (hourglass_shown_p)
10794 Lisp_Object rest, frame;
10796 BLOCK_INPUT;
10797 FOR_EACH_FRAME (rest, frame)
10799 struct frame *f = XFRAME (frame);
10801 if (FRAME_X_P (f)
10802 /* Watch out for newly created frames. */
10803 && f->output_data.x->hourglass_window)
10805 XUnmapWindow (FRAME_X_DISPLAY (f),
10806 f->output_data.x->hourglass_window);
10807 /* Sync here because XTread_socket looks at the
10808 hourglass_p flag that is reset to zero below. */
10809 XSync (FRAME_X_DISPLAY (f), False);
10810 f->output_data.x->hourglass_p = 0;
10814 hourglass_shown_p = 0;
10815 UNBLOCK_INPUT;
10821 /***********************************************************************
10822 Tool tips
10823 ***********************************************************************/
10825 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
10826 Lisp_Object, Lisp_Object));
10827 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
10828 Lisp_Object, int, int, int *, int *));
10830 /* The frame of a currently visible tooltip. */
10832 Lisp_Object tip_frame;
10834 /* If non-nil, a timer started that hides the last tooltip when it
10835 fires. */
10837 Lisp_Object tip_timer;
10838 Window tip_window;
10840 /* If non-nil, a vector of 3 elements containing the last args
10841 with which x-show-tip was called. See there. */
10843 Lisp_Object last_show_tip_args;
10845 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
10847 Lisp_Object Vx_max_tooltip_size;
10850 static Lisp_Object
10851 unwind_create_tip_frame (frame)
10852 Lisp_Object frame;
10854 Lisp_Object deleted;
10856 deleted = unwind_create_frame (frame);
10857 if (EQ (deleted, Qt))
10859 tip_window = None;
10860 tip_frame = Qnil;
10863 return deleted;
10867 /* Create a frame for a tooltip on the display described by DPYINFO.
10868 PARMS is a list of frame parameters. TEXT is the string to
10869 display in the tip frame. Value is the frame.
10871 Note that functions called here, esp. x_default_parameter can
10872 signal errors, for instance when a specified color name is
10873 undefined. We have to make sure that we're in a consistent state
10874 when this happens. */
10876 static Lisp_Object
10877 x_create_tip_frame (dpyinfo, parms, text)
10878 struct x_display_info *dpyinfo;
10879 Lisp_Object parms, text;
10881 struct frame *f;
10882 Lisp_Object frame, tem;
10883 Lisp_Object name;
10884 long window_prompting = 0;
10885 int width, height;
10886 int count = SPECPDL_INDEX ();
10887 struct gcpro gcpro1, gcpro2, gcpro3;
10888 struct kboard *kb;
10889 int face_change_count_before = face_change_count;
10890 Lisp_Object buffer;
10891 struct buffer *old_buffer;
10893 check_x ();
10895 /* Use this general default value to start with until we know if
10896 this frame has a specified name. */
10897 Vx_resource_name = Vinvocation_name;
10899 #ifdef MULTI_KBOARD
10900 kb = dpyinfo->kboard;
10901 #else
10902 kb = &the_only_kboard;
10903 #endif
10905 /* Get the name of the frame to use for resource lookup. */
10906 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
10907 if (!STRINGP (name)
10908 && !EQ (name, Qunbound)
10909 && !NILP (name))
10910 error ("Invalid frame name--not a string or nil");
10911 Vx_resource_name = name;
10913 frame = Qnil;
10914 GCPRO3 (parms, name, frame);
10915 f = make_frame (1);
10916 XSETFRAME (frame, f);
10918 buffer = Fget_buffer_create (build_string (" *tip*"));
10919 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer);
10920 old_buffer = current_buffer;
10921 set_buffer_internal_1 (XBUFFER (buffer));
10922 current_buffer->truncate_lines = Qnil;
10923 Ferase_buffer ();
10924 Finsert (1, &text);
10925 set_buffer_internal_1 (old_buffer);
10927 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
10928 record_unwind_protect (unwind_create_tip_frame, frame);
10930 /* By setting the output method, we're essentially saying that
10931 the frame is live, as per FRAME_LIVE_P. If we get a signal
10932 from this point on, x_destroy_window might screw up reference
10933 counts etc. */
10934 f->output_method = output_x_window;
10935 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
10936 bzero (f->output_data.x, sizeof (struct x_output));
10937 f->output_data.x->icon_bitmap = -1;
10938 f->output_data.x->fontset = -1;
10939 f->output_data.x->scroll_bar_foreground_pixel = -1;
10940 f->output_data.x->scroll_bar_background_pixel = -1;
10941 #ifdef USE_TOOLKIT_SCROLL_BARS
10942 f->output_data.x->scroll_bar_top_shadow_pixel = -1;
10943 f->output_data.x->scroll_bar_bottom_shadow_pixel = -1;
10944 #endif /* USE_TOOLKIT_SCROLL_BARS */
10945 f->icon_name = Qnil;
10946 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
10947 #if GLYPH_DEBUG
10948 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
10949 dpyinfo_refcount = dpyinfo->reference_count;
10950 #endif /* GLYPH_DEBUG */
10951 #ifdef MULTI_KBOARD
10952 FRAME_KBOARD (f) = kb;
10953 #endif
10954 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10955 f->output_data.x->explicit_parent = 0;
10957 /* These colors will be set anyway later, but it's important
10958 to get the color reference counts right, so initialize them! */
10960 Lisp_Object black;
10961 struct gcpro gcpro1;
10963 black = build_string ("black");
10964 GCPRO1 (black);
10965 f->output_data.x->foreground_pixel
10966 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10967 f->output_data.x->background_pixel
10968 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10969 f->output_data.x->cursor_pixel
10970 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10971 f->output_data.x->cursor_foreground_pixel
10972 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10973 f->output_data.x->border_pixel
10974 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10975 f->output_data.x->mouse_pixel
10976 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10977 UNGCPRO;
10980 /* Set the name; the functions to which we pass f expect the name to
10981 be set. */
10982 if (EQ (name, Qunbound) || NILP (name))
10984 f->name = build_string (dpyinfo->x_id_name);
10985 f->explicit_name = 0;
10987 else
10989 f->name = name;
10990 f->explicit_name = 1;
10991 /* use the frame's title when getting resources for this frame. */
10992 specbind (Qx_resource_name, name);
10995 /* Extract the window parameters from the supplied values that are
10996 needed to determine window geometry. */
10998 Lisp_Object font;
11000 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
11002 BLOCK_INPUT;
11003 /* First, try whatever font the caller has specified. */
11004 if (STRINGP (font))
11006 tem = Fquery_fontset (font, Qnil);
11007 if (STRINGP (tem))
11008 font = x_new_fontset (f, SDATA (tem));
11009 else
11010 font = x_new_font (f, SDATA (font));
11013 /* Try out a font which we hope has bold and italic variations. */
11014 if (!STRINGP (font))
11015 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
11016 if (!STRINGP (font))
11017 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
11018 if (! STRINGP (font))
11019 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
11020 if (! STRINGP (font))
11021 /* This was formerly the first thing tried, but it finds too many fonts
11022 and takes too long. */
11023 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
11024 /* If those didn't work, look for something which will at least work. */
11025 if (! STRINGP (font))
11026 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
11027 UNBLOCK_INPUT;
11028 if (! STRINGP (font))
11029 font = build_string ("fixed");
11031 x_default_parameter (f, parms, Qfont, font,
11032 "font", "Font", RES_TYPE_STRING);
11035 x_default_parameter (f, parms, Qborder_width, make_number (2),
11036 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
11038 /* This defaults to 2 in order to match xterm. We recognize either
11039 internalBorderWidth or internalBorder (which is what xterm calls
11040 it). */
11041 if (NILP (Fassq (Qinternal_border_width, parms)))
11043 Lisp_Object value;
11045 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
11046 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
11047 if (! EQ (value, Qunbound))
11048 parms = Fcons (Fcons (Qinternal_border_width, value),
11049 parms);
11052 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
11053 "internalBorderWidth", "internalBorderWidth",
11054 RES_TYPE_NUMBER);
11056 /* Also do the stuff which must be set before the window exists. */
11057 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
11058 "foreground", "Foreground", RES_TYPE_STRING);
11059 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
11060 "background", "Background", RES_TYPE_STRING);
11061 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
11062 "pointerColor", "Foreground", RES_TYPE_STRING);
11063 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
11064 "cursorColor", "Foreground", RES_TYPE_STRING);
11065 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
11066 "borderColor", "BorderColor", RES_TYPE_STRING);
11068 /* Init faces before x_default_parameter is called for scroll-bar
11069 parameters because that function calls x_set_scroll_bar_width,
11070 which calls change_frame_size, which calls Fset_window_buffer,
11071 which runs hooks, which call Fvertical_motion. At the end, we
11072 end up in init_iterator with a null face cache, which should not
11073 happen. */
11074 init_frame_faces (f);
11076 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
11077 window_prompting = x_figure_window_size (f, parms);
11079 if (window_prompting & XNegative)
11081 if (window_prompting & YNegative)
11082 f->output_data.x->win_gravity = SouthEastGravity;
11083 else
11084 f->output_data.x->win_gravity = NorthEastGravity;
11086 else
11088 if (window_prompting & YNegative)
11089 f->output_data.x->win_gravity = SouthWestGravity;
11090 else
11091 f->output_data.x->win_gravity = NorthWestGravity;
11094 f->output_data.x->size_hint_flags = window_prompting;
11096 XSetWindowAttributes attrs;
11097 unsigned long mask;
11099 BLOCK_INPUT;
11100 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
11101 if (DoesSaveUnders (dpyinfo->screen))
11102 mask |= CWSaveUnder;
11104 /* Window managers look at the override-redirect flag to determine
11105 whether or net to give windows a decoration (Xlib spec, chapter
11106 3.2.8). */
11107 attrs.override_redirect = True;
11108 attrs.save_under = True;
11109 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
11110 /* Arrange for getting MapNotify and UnmapNotify events. */
11111 attrs.event_mask = StructureNotifyMask;
11112 tip_window
11113 = FRAME_X_WINDOW (f)
11114 = XCreateWindow (FRAME_X_DISPLAY (f),
11115 FRAME_X_DISPLAY_INFO (f)->root_window,
11116 /* x, y, width, height */
11117 0, 0, 1, 1,
11118 /* Border. */
11120 CopyFromParent, InputOutput, CopyFromParent,
11121 mask, &attrs);
11122 UNBLOCK_INPUT;
11125 x_make_gc (f);
11127 x_default_parameter (f, parms, Qauto_raise, Qnil,
11128 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
11129 x_default_parameter (f, parms, Qauto_lower, Qnil,
11130 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
11131 x_default_parameter (f, parms, Qcursor_type, Qbox,
11132 "cursorType", "CursorType", RES_TYPE_SYMBOL);
11134 /* Dimensions, especially f->height, must be done via change_frame_size.
11135 Change will not be effected unless different from the current
11136 f->height. */
11137 width = f->width;
11138 height = f->height;
11139 f->height = 0;
11140 SET_FRAME_WIDTH (f, 0);
11141 change_frame_size (f, height, width, 1, 0, 0);
11143 /* Add `tooltip' frame parameter's default value. */
11144 if (NILP (Fframe_parameter (frame, intern ("tooltip"))))
11145 Fmodify_frame_parameters (frame, Fcons (Fcons (intern ("tooltip"), Qt),
11146 Qnil));
11148 /* Set up faces after all frame parameters are known. This call
11149 also merges in face attributes specified for new frames.
11151 Frame parameters may be changed if .Xdefaults contains
11152 specifications for the default font. For example, if there is an
11153 `Emacs.default.attributeBackground: pink', the `background-color'
11154 attribute of the frame get's set, which let's the internal border
11155 of the tooltip frame appear in pink. Prevent this. */
11157 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
11159 /* Set tip_frame here, so that */
11160 tip_frame = frame;
11161 call1 (Qface_set_after_frame_default, frame);
11163 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
11164 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
11165 Qnil));
11168 f->no_split = 1;
11170 UNGCPRO;
11172 /* It is now ok to make the frame official even if we get an error
11173 below. And the frame needs to be on Vframe_list or making it
11174 visible won't work. */
11175 Vframe_list = Fcons (frame, Vframe_list);
11177 /* Now that the frame is official, it counts as a reference to
11178 its display. */
11179 FRAME_X_DISPLAY_INFO (f)->reference_count++;
11181 /* Setting attributes of faces of the tooltip frame from resources
11182 and similar will increment face_change_count, which leads to the
11183 clearing of all current matrices. Since this isn't necessary
11184 here, avoid it by resetting face_change_count to the value it
11185 had before we created the tip frame. */
11186 face_change_count = face_change_count_before;
11188 /* Discard the unwind_protect. */
11189 return unbind_to (count, frame);
11193 /* Compute where to display tip frame F. PARMS is the list of frame
11194 parameters for F. DX and DY are specified offsets from the current
11195 location of the mouse. WIDTH and HEIGHT are the width and height
11196 of the tooltip. Return coordinates relative to the root window of
11197 the display in *ROOT_X, and *ROOT_Y. */
11199 static void
11200 compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
11201 struct frame *f;
11202 Lisp_Object parms, dx, dy;
11203 int width, height;
11204 int *root_x, *root_y;
11206 Lisp_Object left, top;
11207 int win_x, win_y;
11208 Window root, child;
11209 unsigned pmask;
11211 /* User-specified position? */
11212 left = Fcdr (Fassq (Qleft, parms));
11213 top = Fcdr (Fassq (Qtop, parms));
11215 /* Move the tooltip window where the mouse pointer is. Resize and
11216 show it. */
11217 if (!INTEGERP (left) || !INTEGERP (top))
11219 BLOCK_INPUT;
11220 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
11221 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
11222 UNBLOCK_INPUT;
11225 if (INTEGERP (top))
11226 *root_y = XINT (top);
11227 else if (*root_y + XINT (dy) - height < 0)
11228 *root_y -= XINT (dy);
11229 else
11231 *root_y -= height;
11232 *root_y += XINT (dy);
11235 if (INTEGERP (left))
11236 *root_x = XINT (left);
11237 else if (*root_x + XINT (dx) + width <= FRAME_X_DISPLAY_INFO (f)->width)
11238 /* It fits to the right of the pointer. */
11239 *root_x += XINT (dx);
11240 else if (width + XINT (dx) <= *root_x)
11241 /* It fits to the left of the pointer. */
11242 *root_x -= width + XINT (dx);
11243 else
11244 /* Put it left-justified on the screen--it ought to fit that way. */
11245 *root_x = 0;
11249 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
11250 doc: /* Show STRING in a "tooltip" window on frame FRAME.
11251 A tooltip window is a small X window displaying a string.
11253 FRAME nil or omitted means use the selected frame.
11255 PARMS is an optional list of frame parameters which can be used to
11256 change the tooltip's appearance.
11258 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
11259 means use the default timeout of 5 seconds.
11261 If the list of frame parameters PARAMS contains a `left' parameters,
11262 the tooltip is displayed at that x-position. Otherwise it is
11263 displayed at the mouse position, with offset DX added (default is 5 if
11264 DX isn't specified). Likewise for the y-position; if a `top' frame
11265 parameter is specified, it determines the y-position of the tooltip
11266 window, otherwise it is displayed at the mouse position, with offset
11267 DY added (default is -10).
11269 A tooltip's maximum size is specified by `x-max-tooltip-size'.
11270 Text larger than the specified size is clipped. */)
11271 (string, frame, parms, timeout, dx, dy)
11272 Lisp_Object string, frame, parms, timeout, dx, dy;
11274 struct frame *f;
11275 struct window *w;
11276 int root_x, root_y;
11277 struct buffer *old_buffer;
11278 struct text_pos pos;
11279 int i, width, height;
11280 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
11281 int old_windows_or_buffers_changed = windows_or_buffers_changed;
11282 int count = SPECPDL_INDEX ();
11284 specbind (Qinhibit_redisplay, Qt);
11286 GCPRO4 (string, parms, frame, timeout);
11288 CHECK_STRING (string);
11289 f = check_x_frame (frame);
11290 if (NILP (timeout))
11291 timeout = make_number (5);
11292 else
11293 CHECK_NATNUM (timeout);
11295 if (NILP (dx))
11296 dx = make_number (5);
11297 else
11298 CHECK_NUMBER (dx);
11300 if (NILP (dy))
11301 dy = make_number (-10);
11302 else
11303 CHECK_NUMBER (dy);
11305 if (NILP (last_show_tip_args))
11306 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
11308 if (!NILP (tip_frame))
11310 Lisp_Object last_string = AREF (last_show_tip_args, 0);
11311 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
11312 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
11314 if (EQ (frame, last_frame)
11315 && !NILP (Fequal (last_string, string))
11316 && !NILP (Fequal (last_parms, parms)))
11318 struct frame *f = XFRAME (tip_frame);
11320 /* Only DX and DY have changed. */
11321 if (!NILP (tip_timer))
11323 Lisp_Object timer = tip_timer;
11324 tip_timer = Qnil;
11325 call1 (Qcancel_timer, timer);
11328 BLOCK_INPUT;
11329 compute_tip_xy (f, parms, dx, dy, PIXEL_WIDTH (f),
11330 PIXEL_HEIGHT (f), &root_x, &root_y);
11331 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11332 root_x, root_y);
11333 UNBLOCK_INPUT;
11334 goto start_timer;
11338 /* Hide a previous tip, if any. */
11339 Fx_hide_tip ();
11341 ASET (last_show_tip_args, 0, string);
11342 ASET (last_show_tip_args, 1, frame);
11343 ASET (last_show_tip_args, 2, parms);
11345 /* Add default values to frame parameters. */
11346 if (NILP (Fassq (Qname, parms)))
11347 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
11348 if (NILP (Fassq (Qinternal_border_width, parms)))
11349 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
11350 if (NILP (Fassq (Qborder_width, parms)))
11351 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
11352 if (NILP (Fassq (Qborder_color, parms)))
11353 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
11354 if (NILP (Fassq (Qbackground_color, parms)))
11355 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
11356 parms);
11358 /* Create a frame for the tooltip, and record it in the global
11359 variable tip_frame. */
11360 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
11361 f = XFRAME (frame);
11363 /* Set up the frame's root window. */
11364 w = XWINDOW (FRAME_ROOT_WINDOW (f));
11365 w->left = w->top = make_number (0);
11367 if (CONSP (Vx_max_tooltip_size)
11368 && INTEGERP (XCAR (Vx_max_tooltip_size))
11369 && XINT (XCAR (Vx_max_tooltip_size)) > 0
11370 && INTEGERP (XCDR (Vx_max_tooltip_size))
11371 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
11373 w->width = XCAR (Vx_max_tooltip_size);
11374 w->height = XCDR (Vx_max_tooltip_size);
11376 else
11378 w->width = make_number (80);
11379 w->height = make_number (40);
11382 f->window_width = XINT (w->width);
11383 adjust_glyphs (f);
11384 w->pseudo_window_p = 1;
11386 /* Display the tooltip text in a temporary buffer. */
11387 old_buffer = current_buffer;
11388 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
11389 current_buffer->truncate_lines = Qnil;
11390 clear_glyph_matrix (w->desired_matrix);
11391 clear_glyph_matrix (w->current_matrix);
11392 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
11393 try_window (FRAME_ROOT_WINDOW (f), pos);
11395 /* Compute width and height of the tooltip. */
11396 width = height = 0;
11397 for (i = 0; i < w->desired_matrix->nrows; ++i)
11399 struct glyph_row *row = &w->desired_matrix->rows[i];
11400 struct glyph *last;
11401 int row_width;
11403 /* Stop at the first empty row at the end. */
11404 if (!row->enabled_p || !row->displays_text_p)
11405 break;
11407 /* Let the row go over the full width of the frame. */
11408 row->full_width_p = 1;
11410 /* There's a glyph at the end of rows that is used to place
11411 the cursor there. Don't include the width of this glyph. */
11412 if (row->used[TEXT_AREA])
11414 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
11415 row_width = row->pixel_width - last->pixel_width;
11417 else
11418 row_width = row->pixel_width;
11420 height += row->height;
11421 width = max (width, row_width);
11424 /* Add the frame's internal border to the width and height the X
11425 window should have. */
11426 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
11427 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
11429 /* Move the tooltip window where the mouse pointer is. Resize and
11430 show it. */
11431 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
11433 BLOCK_INPUT;
11434 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11435 root_x, root_y, width, height);
11436 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11437 UNBLOCK_INPUT;
11439 /* Draw into the window. */
11440 w->must_be_updated_p = 1;
11441 update_single_window (w, 1);
11443 /* Restore original current buffer. */
11444 set_buffer_internal_1 (old_buffer);
11445 windows_or_buffers_changed = old_windows_or_buffers_changed;
11447 start_timer:
11448 /* Let the tip disappear after timeout seconds. */
11449 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
11450 intern ("x-hide-tip"));
11452 UNGCPRO;
11453 return unbind_to (count, Qnil);
11457 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
11458 doc: /* Hide the current tooltip window, if there is any.
11459 Value is t if tooltip was open, nil otherwise. */)
11462 int count;
11463 Lisp_Object deleted, frame, timer;
11464 struct gcpro gcpro1, gcpro2;
11466 /* Return quickly if nothing to do. */
11467 if (NILP (tip_timer) && NILP (tip_frame))
11468 return Qnil;
11470 frame = tip_frame;
11471 timer = tip_timer;
11472 GCPRO2 (frame, timer);
11473 tip_frame = tip_timer = deleted = Qnil;
11475 count = SPECPDL_INDEX ();
11476 specbind (Qinhibit_redisplay, Qt);
11477 specbind (Qinhibit_quit, Qt);
11479 if (!NILP (timer))
11480 call1 (Qcancel_timer, timer);
11482 if (FRAMEP (frame))
11484 Fdelete_frame (frame, Qnil);
11485 deleted = Qt;
11487 #ifdef USE_LUCID
11488 /* Bloodcurdling hack alert: The Lucid menu bar widget's
11489 redisplay procedure is not called when a tip frame over menu
11490 items is unmapped. Redisplay the menu manually... */
11492 struct frame *f = SELECTED_FRAME ();
11493 Widget w = f->output_data.x->menubar_widget;
11494 extern void xlwmenu_redisplay P_ ((Widget));
11496 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
11497 && w != NULL)
11499 BLOCK_INPUT;
11500 xlwmenu_redisplay (w);
11501 UNBLOCK_INPUT;
11504 #endif /* USE_LUCID */
11507 UNGCPRO;
11508 return unbind_to (count, deleted);
11513 /***********************************************************************
11514 File selection dialog
11515 ***********************************************************************/
11517 #ifdef USE_MOTIF
11519 /* Callback for "OK" and "Cancel" on file selection dialog. */
11521 static void
11522 file_dialog_cb (widget, client_data, call_data)
11523 Widget widget;
11524 XtPointer call_data, client_data;
11526 int *result = (int *) client_data;
11527 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
11528 *result = cb->reason;
11532 /* Callback for unmapping a file selection dialog. This is used to
11533 capture the case where a dialog is closed via a window manager's
11534 closer button, for example. Using a XmNdestroyCallback didn't work
11535 in this case. */
11537 static void
11538 file_dialog_unmap_cb (widget, client_data, call_data)
11539 Widget widget;
11540 XtPointer call_data, client_data;
11542 int *result = (int *) client_data;
11543 *result = XmCR_CANCEL;
11547 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0,
11548 doc: /* Read file name, prompting with PROMPT in directory DIR.
11549 Use a file selection dialog.
11550 Select DEFAULT-FILENAME in the dialog's file selection box, if
11551 specified. Don't let the user enter a file name in the file
11552 selection dialog's entry field, if MUSTMATCH is non-nil. */)
11553 (prompt, dir, default_filename, mustmatch)
11554 Lisp_Object prompt, dir, default_filename, mustmatch;
11556 int result;
11557 struct frame *f = SELECTED_FRAME ();
11558 Lisp_Object file = Qnil;
11559 Widget dialog, text, list, help;
11560 Arg al[10];
11561 int ac = 0;
11562 extern XtAppContext Xt_app_con;
11563 XmString dir_xmstring, pattern_xmstring;
11564 int count = SPECPDL_INDEX ();
11565 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
11567 GCPRO5 (prompt, dir, default_filename, mustmatch, file);
11568 CHECK_STRING (prompt);
11569 CHECK_STRING (dir);
11571 /* Prevent redisplay. */
11572 specbind (Qinhibit_redisplay, Qt);
11574 BLOCK_INPUT;
11576 /* Create the dialog with PROMPT as title, using DIR as initial
11577 directory and using "*" as pattern. */
11578 dir = Fexpand_file_name (dir, Qnil);
11579 dir_xmstring = XmStringCreateLocalized (SDATA (dir));
11580 pattern_xmstring = XmStringCreateLocalized ("*");
11582 XtSetArg (al[ac], XmNtitle, SDATA (prompt)); ++ac;
11583 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
11584 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
11585 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
11586 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
11587 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
11588 "fsb", al, ac);
11589 XmStringFree (dir_xmstring);
11590 XmStringFree (pattern_xmstring);
11592 /* Add callbacks for OK and Cancel. */
11593 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
11594 (XtPointer) &result);
11595 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
11596 (XtPointer) &result);
11597 XtAddCallback (dialog, XmNunmapCallback, file_dialog_unmap_cb,
11598 (XtPointer) &result);
11600 /* Disable the help button since we can't display help. */
11601 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
11602 XtSetSensitive (help, False);
11604 /* Mark OK button as default. */
11605 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
11606 XmNshowAsDefault, True, NULL);
11608 /* If MUSTMATCH is non-nil, disable the file entry field of the
11609 dialog, so that the user must select a file from the files list
11610 box. We can't remove it because we wouldn't have a way to get at
11611 the result file name, then. */
11612 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
11613 if (!NILP (mustmatch))
11615 Widget label;
11616 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
11617 XtSetSensitive (text, False);
11618 XtSetSensitive (label, False);
11621 /* Manage the dialog, so that list boxes get filled. */
11622 XtManageChild (dialog);
11624 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
11625 must include the path for this to work. */
11626 list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
11627 if (STRINGP (default_filename))
11629 XmString default_xmstring;
11630 int item_pos;
11632 default_xmstring
11633 = XmStringCreateLocalized (SDATA (default_filename));
11635 if (!XmListItemExists (list, default_xmstring))
11637 /* Add a new item if DEFAULT_FILENAME is not in the list. */
11638 XmListAddItem (list, default_xmstring, 0);
11639 item_pos = 0;
11641 else
11642 item_pos = XmListItemPos (list, default_xmstring);
11643 XmStringFree (default_xmstring);
11645 /* Select the item and scroll it into view. */
11646 XmListSelectPos (list, item_pos, True);
11647 XmListSetPos (list, item_pos);
11650 /* Process events until the user presses Cancel or OK. Block
11651 and unblock input here so that we get a chance of processing
11652 expose events. */
11653 UNBLOCK_INPUT;
11654 result = 0;
11655 while (result == 0)
11657 BLOCK_INPUT;
11658 XtAppProcessEvent (Xt_app_con, XtIMAll);
11659 UNBLOCK_INPUT;
11661 BLOCK_INPUT;
11663 /* Get the result. */
11664 if (result == XmCR_OK)
11666 XmString text;
11667 String data;
11669 XtVaGetValues (dialog, XmNtextString, &text, NULL);
11670 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
11671 XmStringFree (text);
11672 file = build_string (data);
11673 XtFree (data);
11675 else
11676 file = Qnil;
11678 /* Clean up. */
11679 XtUnmanageChild (dialog);
11680 XtDestroyWidget (dialog);
11681 UNBLOCK_INPUT;
11682 UNGCPRO;
11684 /* Make "Cancel" equivalent to C-g. */
11685 if (NILP (file))
11686 Fsignal (Qquit, Qnil);
11688 return unbind_to (count, file);
11691 #endif /* USE_MOTIF */
11695 /***********************************************************************
11696 Keyboard
11697 ***********************************************************************/
11699 #ifdef HAVE_XKBGETKEYBOARD
11700 #include <X11/XKBlib.h>
11701 #include <X11/keysym.h>
11702 #endif
11704 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
11705 Sx_backspace_delete_keys_p, 0, 1, 0,
11706 doc: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
11707 FRAME nil means use the selected frame.
11708 Value is t if we know that both keys are present, and are mapped to the
11709 usual X keysyms. */)
11710 (frame)
11711 Lisp_Object frame;
11713 #ifdef HAVE_XKBGETKEYBOARD
11714 XkbDescPtr kb;
11715 struct frame *f = check_x_frame (frame);
11716 Display *dpy = FRAME_X_DISPLAY (f);
11717 Lisp_Object have_keys;
11718 int major, minor, op, event, error;
11720 BLOCK_INPUT;
11722 /* Check library version in case we're dynamically linked. */
11723 major = XkbMajorVersion;
11724 minor = XkbMinorVersion;
11725 if (!XkbLibraryVersion (&major, &minor))
11727 UNBLOCK_INPUT;
11728 return Qnil;
11731 /* Check that the server supports XKB. */
11732 major = XkbMajorVersion;
11733 minor = XkbMinorVersion;
11734 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
11736 UNBLOCK_INPUT;
11737 return Qnil;
11740 have_keys = Qnil;
11741 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
11742 if (kb)
11744 int delete_keycode = 0, backspace_keycode = 0, i;
11746 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
11748 for (i = kb->min_key_code;
11749 (i < kb->max_key_code
11750 && (delete_keycode == 0 || backspace_keycode == 0));
11751 ++i)
11753 /* The XKB symbolic key names can be seen most easily in
11754 the PS file generated by `xkbprint -label name
11755 $DISPLAY'. */
11756 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
11757 delete_keycode = i;
11758 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
11759 backspace_keycode = i;
11762 XkbFreeNames (kb, 0, True);
11765 XkbFreeClientMap (kb, 0, True);
11767 if (delete_keycode
11768 && backspace_keycode
11769 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
11770 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
11771 have_keys = Qt;
11773 UNBLOCK_INPUT;
11774 return have_keys;
11775 #else /* not HAVE_XKBGETKEYBOARD */
11776 return Qnil;
11777 #endif /* not HAVE_XKBGETKEYBOARD */
11782 /***********************************************************************
11783 Initialization
11784 ***********************************************************************/
11786 void
11787 syms_of_xfns ()
11789 /* This is zero if not using X windows. */
11790 x_in_use = 0;
11792 /* The section below is built by the lisp expression at the top of the file,
11793 just above where these variables are declared. */
11794 /*&&& init symbols here &&&*/
11795 Qauto_raise = intern ("auto-raise");
11796 staticpro (&Qauto_raise);
11797 Qauto_lower = intern ("auto-lower");
11798 staticpro (&Qauto_lower);
11799 Qborder_color = intern ("border-color");
11800 staticpro (&Qborder_color);
11801 Qborder_width = intern ("border-width");
11802 staticpro (&Qborder_width);
11803 Qcursor_color = intern ("cursor-color");
11804 staticpro (&Qcursor_color);
11805 Qcursor_type = intern ("cursor-type");
11806 staticpro (&Qcursor_type);
11807 Qgeometry = intern ("geometry");
11808 staticpro (&Qgeometry);
11809 Qicon_left = intern ("icon-left");
11810 staticpro (&Qicon_left);
11811 Qicon_top = intern ("icon-top");
11812 staticpro (&Qicon_top);
11813 Qicon_type = intern ("icon-type");
11814 staticpro (&Qicon_type);
11815 Qicon_name = intern ("icon-name");
11816 staticpro (&Qicon_name);
11817 Qinternal_border_width = intern ("internal-border-width");
11818 staticpro (&Qinternal_border_width);
11819 Qleft = intern ("left");
11820 staticpro (&Qleft);
11821 Qright = intern ("right");
11822 staticpro (&Qright);
11823 Qmouse_color = intern ("mouse-color");
11824 staticpro (&Qmouse_color);
11825 Qnone = intern ("none");
11826 staticpro (&Qnone);
11827 Qparent_id = intern ("parent-id");
11828 staticpro (&Qparent_id);
11829 Qscroll_bar_width = intern ("scroll-bar-width");
11830 staticpro (&Qscroll_bar_width);
11831 Qsuppress_icon = intern ("suppress-icon");
11832 staticpro (&Qsuppress_icon);
11833 Qundefined_color = intern ("undefined-color");
11834 staticpro (&Qundefined_color);
11835 Qvertical_scroll_bars = intern ("vertical-scroll-bars");
11836 staticpro (&Qvertical_scroll_bars);
11837 Qvisibility = intern ("visibility");
11838 staticpro (&Qvisibility);
11839 Qwindow_id = intern ("window-id");
11840 staticpro (&Qwindow_id);
11841 Qouter_window_id = intern ("outer-window-id");
11842 staticpro (&Qouter_window_id);
11843 Qx_frame_parameter = intern ("x-frame-parameter");
11844 staticpro (&Qx_frame_parameter);
11845 Qx_resource_name = intern ("x-resource-name");
11846 staticpro (&Qx_resource_name);
11847 Quser_position = intern ("user-position");
11848 staticpro (&Quser_position);
11849 Quser_size = intern ("user-size");
11850 staticpro (&Quser_size);
11851 Qscroll_bar_foreground = intern ("scroll-bar-foreground");
11852 staticpro (&Qscroll_bar_foreground);
11853 Qscroll_bar_background = intern ("scroll-bar-background");
11854 staticpro (&Qscroll_bar_background);
11855 Qscreen_gamma = intern ("screen-gamma");
11856 staticpro (&Qscreen_gamma);
11857 Qline_spacing = intern ("line-spacing");
11858 staticpro (&Qline_spacing);
11859 Qcenter = intern ("center");
11860 staticpro (&Qcenter);
11861 Qcompound_text = intern ("compound-text");
11862 staticpro (&Qcompound_text);
11863 Qcancel_timer = intern ("cancel-timer");
11864 staticpro (&Qcancel_timer);
11865 Qwait_for_wm = intern ("wait-for-wm");
11866 staticpro (&Qwait_for_wm);
11867 Qfullscreen = intern ("fullscreen");
11868 staticpro (&Qfullscreen);
11869 Qfullwidth = intern ("fullwidth");
11870 staticpro (&Qfullwidth);
11871 Qfullheight = intern ("fullheight");
11872 staticpro (&Qfullheight);
11873 Qfullboth = intern ("fullboth");
11874 staticpro (&Qfullboth);
11875 /* This is the end of symbol initialization. */
11877 /* Text property `display' should be nonsticky by default. */
11878 Vtext_property_default_nonsticky
11879 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
11882 Qlaplace = intern ("laplace");
11883 staticpro (&Qlaplace);
11884 Qemboss = intern ("emboss");
11885 staticpro (&Qemboss);
11886 Qedge_detection = intern ("edge-detection");
11887 staticpro (&Qedge_detection);
11888 Qheuristic = intern ("heuristic");
11889 staticpro (&Qheuristic);
11890 QCmatrix = intern (":matrix");
11891 staticpro (&QCmatrix);
11892 QCcolor_adjustment = intern (":color-adjustment");
11893 staticpro (&QCcolor_adjustment);
11894 QCmask = intern (":mask");
11895 staticpro (&QCmask);
11897 Qface_set_after_frame_default = intern ("face-set-after-frame-default");
11898 staticpro (&Qface_set_after_frame_default);
11900 Fput (Qundefined_color, Qerror_conditions,
11901 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
11902 Fput (Qundefined_color, Qerror_message,
11903 build_string ("Undefined color"));
11905 init_x_parm_symbols ();
11907 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
11908 doc: /* Non-nil means always draw a cross over disabled images.
11909 Disabled images are those having an `:conversion disabled' property.
11910 A cross is always drawn on black & white displays. */);
11911 cross_disabled_images = 0;
11913 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
11914 doc: /* List of directories to search for bitmap files for X. */);
11915 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
11917 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
11918 doc: /* The shape of the pointer when over text.
11919 Changing the value does not affect existing frames
11920 unless you set the mouse color. */);
11921 Vx_pointer_shape = Qnil;
11923 DEFVAR_LISP ("x-resource-name", &Vx_resource_name,
11924 doc: /* The name Emacs uses to look up X resources.
11925 `x-get-resource' uses this as the first component of the instance name
11926 when requesting resource values.
11927 Emacs initially sets `x-resource-name' to the name under which Emacs
11928 was invoked, or to the value specified with the `-name' or `-rn'
11929 switches, if present.
11931 It may be useful to bind this variable locally around a call
11932 to `x-get-resource'. See also the variable `x-resource-class'. */);
11933 Vx_resource_name = Qnil;
11935 DEFVAR_LISP ("x-resource-class", &Vx_resource_class,
11936 doc: /* The class Emacs uses to look up X resources.
11937 `x-get-resource' uses this as the first component of the instance class
11938 when requesting resource values.
11940 Emacs initially sets `x-resource-class' to "Emacs".
11942 Setting this variable permanently is not a reasonable thing to do,
11943 but binding this variable locally around a call to `x-get-resource'
11944 is a reasonable practice. See also the variable `x-resource-name'. */);
11945 Vx_resource_class = build_string (EMACS_CLASS);
11947 #if 0 /* This doesn't really do anything. */
11948 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
11949 doc: /* The shape of the pointer when not over text.
11950 This variable takes effect when you create a new frame
11951 or when you set the mouse color. */);
11952 #endif
11953 Vx_nontext_pointer_shape = Qnil;
11955 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
11956 doc: /* The shape of the pointer when Emacs is busy.
11957 This variable takes effect when you create a new frame
11958 or when you set the mouse color. */);
11959 Vx_hourglass_pointer_shape = Qnil;
11961 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
11962 doc: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
11963 display_hourglass_p = 1;
11965 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
11966 doc: /* *Seconds to wait before displaying an hourglass pointer.
11967 Value must be an integer or float. */);
11968 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
11970 #if 0 /* This doesn't really do anything. */
11971 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
11972 doc: /* The shape of the pointer when over the mode line.
11973 This variable takes effect when you create a new frame
11974 or when you set the mouse color. */);
11975 #endif
11976 Vx_mode_pointer_shape = Qnil;
11978 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
11979 &Vx_sensitive_text_pointer_shape,
11980 doc: /* The shape of the pointer when over mouse-sensitive text.
11981 This variable takes effect when you create a new frame
11982 or when you set the mouse color. */);
11983 Vx_sensitive_text_pointer_shape = Qnil;
11985 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
11986 &Vx_window_horizontal_drag_shape,
11987 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
11988 This variable takes effect when you create a new frame
11989 or when you set the mouse color. */);
11990 Vx_window_horizontal_drag_shape = Qnil;
11992 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
11993 doc: /* A string indicating the foreground color of the cursor box. */);
11994 Vx_cursor_fore_pixel = Qnil;
11996 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size,
11997 doc: /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
11998 Text larger than this is clipped. */);
11999 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
12001 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
12002 doc: /* Non-nil if no X window manager is in use.
12003 Emacs doesn't try to figure this out; this is always nil
12004 unless you set it to something else. */);
12005 /* We don't have any way to find this out, so set it to nil
12006 and maybe the user would like to set it to t. */
12007 Vx_no_window_manager = Qnil;
12009 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
12010 &Vx_pixel_size_width_font_regexp,
12011 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
12013 Since Emacs gets width of a font matching with this regexp from
12014 PIXEL_SIZE field of the name, font finding mechanism gets faster for
12015 such a font. This is especially effective for such large fonts as
12016 Chinese, Japanese, and Korean. */);
12017 Vx_pixel_size_width_font_regexp = Qnil;
12019 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
12020 doc: /* Time after which cached images are removed from the cache.
12021 When an image has not been displayed this many seconds, remove it
12022 from the image cache. Value must be an integer or nil with nil
12023 meaning don't clear the cache. */);
12024 Vimage_cache_eviction_delay = make_number (30 * 60);
12026 #ifdef USE_X_TOOLKIT
12027 Fprovide (intern ("x-toolkit"), Qnil);
12028 #ifdef USE_MOTIF
12029 Fprovide (intern ("motif"), Qnil);
12031 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string,
12032 doc: /* Version info for LessTif/Motif. */);
12033 Vmotif_version_string = build_string (XmVERSION_STRING);
12034 #endif /* USE_MOTIF */
12035 #endif /* USE_X_TOOLKIT */
12037 defsubr (&Sx_get_resource);
12039 /* X window properties. */
12040 defsubr (&Sx_change_window_property);
12041 defsubr (&Sx_delete_window_property);
12042 defsubr (&Sx_window_property);
12044 defsubr (&Sxw_display_color_p);
12045 defsubr (&Sx_display_grayscale_p);
12046 defsubr (&Sxw_color_defined_p);
12047 defsubr (&Sxw_color_values);
12048 defsubr (&Sx_server_max_request_size);
12049 defsubr (&Sx_server_vendor);
12050 defsubr (&Sx_server_version);
12051 defsubr (&Sx_display_pixel_width);
12052 defsubr (&Sx_display_pixel_height);
12053 defsubr (&Sx_display_mm_width);
12054 defsubr (&Sx_display_mm_height);
12055 defsubr (&Sx_display_screens);
12056 defsubr (&Sx_display_planes);
12057 defsubr (&Sx_display_color_cells);
12058 defsubr (&Sx_display_visual_class);
12059 defsubr (&Sx_display_backing_store);
12060 defsubr (&Sx_display_save_under);
12061 defsubr (&Sx_parse_geometry);
12062 defsubr (&Sx_create_frame);
12063 defsubr (&Sx_open_connection);
12064 defsubr (&Sx_close_connection);
12065 defsubr (&Sx_display_list);
12066 defsubr (&Sx_synchronize);
12067 defsubr (&Sx_focus_frame);
12068 defsubr (&Sx_backspace_delete_keys_p);
12070 /* Setting callback functions for fontset handler. */
12071 get_font_info_func = x_get_font_info;
12073 #if 0 /* This function pointer doesn't seem to be used anywhere.
12074 And the pointer assigned has the wrong type, anyway. */
12075 list_fonts_func = x_list_fonts;
12076 #endif
12078 load_font_func = x_load_font;
12079 find_ccl_program_func = x_find_ccl_program;
12080 query_font_func = x_query_font;
12081 set_frame_fontset_func = x_set_font;
12082 check_window_system_func = check_x;
12084 /* Images. */
12085 Qxbm = intern ("xbm");
12086 staticpro (&Qxbm);
12087 QCconversion = intern (":conversion");
12088 staticpro (&QCconversion);
12089 QCheuristic_mask = intern (":heuristic-mask");
12090 staticpro (&QCheuristic_mask);
12091 QCcolor_symbols = intern (":color-symbols");
12092 staticpro (&QCcolor_symbols);
12093 QCascent = intern (":ascent");
12094 staticpro (&QCascent);
12095 QCmargin = intern (":margin");
12096 staticpro (&QCmargin);
12097 QCrelief = intern (":relief");
12098 staticpro (&QCrelief);
12099 Qpostscript = intern ("postscript");
12100 staticpro (&Qpostscript);
12101 QCloader = intern (":loader");
12102 staticpro (&QCloader);
12103 QCbounding_box = intern (":bounding-box");
12104 staticpro (&QCbounding_box);
12105 QCpt_width = intern (":pt-width");
12106 staticpro (&QCpt_width);
12107 QCpt_height = intern (":pt-height");
12108 staticpro (&QCpt_height);
12109 QCindex = intern (":index");
12110 staticpro (&QCindex);
12111 Qpbm = intern ("pbm");
12112 staticpro (&Qpbm);
12114 #if HAVE_XPM
12115 Qxpm = intern ("xpm");
12116 staticpro (&Qxpm);
12117 #endif
12119 #if HAVE_JPEG
12120 Qjpeg = intern ("jpeg");
12121 staticpro (&Qjpeg);
12122 #endif
12124 #if HAVE_TIFF
12125 Qtiff = intern ("tiff");
12126 staticpro (&Qtiff);
12127 #endif
12129 #if HAVE_GIF
12130 Qgif = intern ("gif");
12131 staticpro (&Qgif);
12132 #endif
12134 #if HAVE_PNG
12135 Qpng = intern ("png");
12136 staticpro (&Qpng);
12137 #endif
12139 defsubr (&Sclear_image_cache);
12140 defsubr (&Simage_size);
12141 defsubr (&Simage_mask_p);
12143 hourglass_atimer = NULL;
12144 hourglass_shown_p = 0;
12146 defsubr (&Sx_show_tip);
12147 defsubr (&Sx_hide_tip);
12148 tip_timer = Qnil;
12149 staticpro (&tip_timer);
12150 tip_frame = Qnil;
12151 staticpro (&tip_frame);
12153 last_show_tip_args = Qnil;
12154 staticpro (&last_show_tip_args);
12156 #ifdef USE_MOTIF
12157 defsubr (&Sx_file_dialog);
12158 #endif
12162 void
12163 init_xfns ()
12165 image_types = NULL;
12166 Vimage_types = Qnil;
12168 define_image_type (&xbm_type);
12169 define_image_type (&gs_type);
12170 define_image_type (&pbm_type);
12172 #if HAVE_XPM
12173 define_image_type (&xpm_type);
12174 #endif
12176 #if HAVE_JPEG
12177 define_image_type (&jpeg_type);
12178 #endif
12180 #if HAVE_TIFF
12181 define_image_type (&tiff_type);
12182 #endif
12184 #if HAVE_GIF
12185 define_image_type (&gif_type);
12186 #endif
12188 #if HAVE_PNG
12189 define_image_type (&png_type);
12190 #endif
12193 #endif /* HAVE_X_WINDOWS */