Some doc fixes.
[emacs/old-mirror.git] / src / xfns.c
blobddd158ed98a13b22c5ddfc2a95534cb1eecc783d
1 /* Functions for the X window system.
2 Copyright (C) 1989, 92, 93, 94, 95, 96, 1997, 1998, 1999, 2000, 2001
3 Free Software Foundation.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
23 #include <signal.h>
24 #include <stdio.h>
25 #include <math.h>
27 /* This makes the fields of a Display accessible, in Xlib header files. */
29 #define XLIB_ILLEGAL_ACCESS
31 #include "lisp.h"
32 #include "xterm.h"
33 #include "frame.h"
34 #include "window.h"
35 #include "buffer.h"
36 #include "intervals.h"
37 #include "dispextern.h"
38 #include "keyboard.h"
39 #include "blockinput.h"
40 #include <epaths.h>
41 #include "charset.h"
42 #include "coding.h"
43 #include "fontset.h"
44 #include "systime.h"
45 #include "termhooks.h"
46 #include "atimer.h"
48 #ifdef HAVE_X_WINDOWS
50 #include <ctype.h>
51 #include <sys/types.h>
52 #include <sys/stat.h>
54 #ifndef VMS
55 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
56 #include "bitmaps/gray.xbm"
57 #else
58 #include <X11/bitmaps/gray>
59 #endif
60 #else
61 #include "[.bitmaps]gray.xbm"
62 #endif
64 #ifdef USE_X_TOOLKIT
65 #include <X11/Shell.h>
67 #ifndef USE_MOTIF
68 #include <X11/Xaw/Paned.h>
69 #include <X11/Xaw/Label.h>
70 #endif /* USE_MOTIF */
72 #ifdef USG
73 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
74 #include <X11/Xos.h>
75 #define USG
76 #else
77 #include <X11/Xos.h>
78 #endif
80 #include "widget.h"
82 #include "../lwlib/lwlib.h"
84 #ifdef USE_MOTIF
85 #include <Xm/Xm.h>
86 #include <Xm/DialogS.h>
87 #include <Xm/FileSB.h>
88 #endif
90 /* Do the EDITRES protocol if running X11R5
91 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
93 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
94 #define HACK_EDITRES
95 extern void _XEditResCheckMessages ();
96 #endif /* R5 + Athena */
98 /* Unique id counter for widgets created by the Lucid Widget Library. */
100 extern LWLIB_ID widget_id_tick;
102 #ifdef USE_LUCID
103 /* This is part of a kludge--see lwlib/xlwmenu.c. */
104 extern XFontStruct *xlwmenu_default_font;
105 #endif
107 extern void free_frame_menubar ();
108 extern double atof ();
110 #endif /* USE_X_TOOLKIT */
112 #define min(a,b) ((a) < (b) ? (a) : (b))
113 #define max(a,b) ((a) > (b) ? (a) : (b))
115 #ifdef HAVE_X11R4
116 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
117 #else
118 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
119 #endif
121 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
122 it, and including `bitmaps/gray' more than once is a problem when
123 config.h defines `static' as an empty replacement string. */
125 int gray_bitmap_width = gray_width;
126 int gray_bitmap_height = gray_height;
127 char *gray_bitmap_bits = gray_bits;
129 /* The name we're using in resource queries. Most often "emacs". */
131 Lisp_Object Vx_resource_name;
133 /* The application class we're using in resource queries.
134 Normally "Emacs". */
136 Lisp_Object Vx_resource_class;
138 /* Non-zero means we're allowed to display an hourglass cursor. */
140 int display_hourglass_p;
142 /* The background and shape of the mouse pointer, and shape when not
143 over text or in the modeline. */
145 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
146 Lisp_Object Vx_hourglass_pointer_shape;
148 /* The shape when over mouse-sensitive text. */
150 Lisp_Object Vx_sensitive_text_pointer_shape;
152 /* If non-nil, the pointer shape to indicate that windows can be
153 dragged horizontally. */
155 Lisp_Object Vx_window_horizontal_drag_shape;
157 /* Color of chars displayed in cursor box. */
159 Lisp_Object Vx_cursor_fore_pixel;
161 /* Nonzero if using X. */
163 static int x_in_use;
165 /* Non nil if no window manager is in use. */
167 Lisp_Object Vx_no_window_manager;
169 /* Search path for bitmap files. */
171 Lisp_Object Vx_bitmap_file_path;
173 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
175 Lisp_Object Vx_pixel_size_width_font_regexp;
177 Lisp_Object Qauto_raise;
178 Lisp_Object Qauto_lower;
179 Lisp_Object Qbar;
180 Lisp_Object Qborder_color;
181 Lisp_Object Qborder_width;
182 Lisp_Object Qbox;
183 Lisp_Object Qcursor_color;
184 Lisp_Object Qcursor_type;
185 Lisp_Object Qgeometry;
186 Lisp_Object Qicon_left;
187 Lisp_Object Qicon_top;
188 Lisp_Object Qicon_type;
189 Lisp_Object Qicon_name;
190 Lisp_Object Qinternal_border_width;
191 Lisp_Object Qleft;
192 Lisp_Object Qright;
193 Lisp_Object Qmouse_color;
194 Lisp_Object Qnone;
195 Lisp_Object Qouter_window_id;
196 Lisp_Object Qparent_id;
197 Lisp_Object Qscroll_bar_width;
198 Lisp_Object Qsuppress_icon;
199 extern Lisp_Object Qtop;
200 Lisp_Object Qundefined_color;
201 Lisp_Object Qvertical_scroll_bars;
202 Lisp_Object Qvisibility;
203 Lisp_Object Qwindow_id;
204 Lisp_Object Qx_frame_parameter;
205 Lisp_Object Qx_resource_name;
206 Lisp_Object Quser_position;
207 Lisp_Object Quser_size;
208 extern Lisp_Object Qdisplay;
209 Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
210 Lisp_Object Qscreen_gamma, Qline_spacing, Qcenter;
211 Lisp_Object Qcompound_text, Qcancel_timer;
213 /* The below are defined in frame.c. */
215 extern Lisp_Object Qheight, Qminibuffer, Qname, Qonly, Qwidth;
216 extern Lisp_Object Qunsplittable, Qmenu_bar_lines, Qbuffer_predicate, Qtitle;
217 extern Lisp_Object Qtool_bar_lines;
219 extern Lisp_Object Vwindow_system_version;
221 Lisp_Object Qface_set_after_frame_default;
223 #if GLYPH_DEBUG
224 int image_cache_refcount, dpyinfo_refcount;
225 #endif
229 /* Error if we are not connected to X. */
231 void
232 check_x ()
234 if (! x_in_use)
235 error ("X windows are not in use or not initialized");
238 /* Nonzero if we can use mouse menus.
239 You should not call this unless HAVE_MENUS is defined. */
242 have_menus_p ()
244 return x_in_use;
247 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
248 and checking validity for X. */
250 FRAME_PTR
251 check_x_frame (frame)
252 Lisp_Object frame;
254 FRAME_PTR f;
256 if (NILP (frame))
257 frame = selected_frame;
258 CHECK_LIVE_FRAME (frame, 0);
259 f = XFRAME (frame);
260 if (! FRAME_X_P (f))
261 error ("Non-X frame used");
262 return f;
265 /* Let the user specify an X display with a frame.
266 nil stands for the selected frame--or, if that is not an X frame,
267 the first X display on the list. */
269 static struct x_display_info *
270 check_x_display_info (frame)
271 Lisp_Object frame;
273 struct x_display_info *dpyinfo = NULL;
275 if (NILP (frame))
277 struct frame *sf = XFRAME (selected_frame);
279 if (FRAME_X_P (sf) && FRAME_LIVE_P (sf))
280 dpyinfo = FRAME_X_DISPLAY_INFO (sf);
281 else if (x_display_list != 0)
282 dpyinfo = x_display_list;
283 else
284 error ("X windows are not in use or not initialized");
286 else if (STRINGP (frame))
287 dpyinfo = x_display_info_for_name (frame);
288 else
290 FRAME_PTR f;
292 CHECK_LIVE_FRAME (frame, 0);
293 f = XFRAME (frame);
294 if (! FRAME_X_P (f))
295 error ("Non-X frame used");
296 dpyinfo = FRAME_X_DISPLAY_INFO (f);
299 return dpyinfo;
303 /* Return the Emacs frame-object corresponding to an X window.
304 It could be the frame's main window or an icon window. */
306 /* This function can be called during GC, so use GC_xxx type test macros. */
308 struct frame *
309 x_window_to_frame (dpyinfo, wdesc)
310 struct x_display_info *dpyinfo;
311 int wdesc;
313 Lisp_Object tail, frame;
314 struct frame *f;
316 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
318 frame = XCAR (tail);
319 if (!GC_FRAMEP (frame))
320 continue;
321 f = XFRAME (frame);
322 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
323 continue;
324 if (f->output_data.x->hourglass_window == wdesc)
325 return f;
326 #ifdef USE_X_TOOLKIT
327 if ((f->output_data.x->edit_widget
328 && XtWindow (f->output_data.x->edit_widget) == wdesc)
329 /* A tooltip frame? */
330 || (!f->output_data.x->edit_widget
331 && FRAME_X_WINDOW (f) == wdesc)
332 || f->output_data.x->icon_desc == wdesc)
333 return f;
334 #else /* not USE_X_TOOLKIT */
335 if (FRAME_X_WINDOW (f) == wdesc
336 || f->output_data.x->icon_desc == wdesc)
337 return f;
338 #endif /* not USE_X_TOOLKIT */
340 return 0;
343 #ifdef USE_X_TOOLKIT
344 /* Like x_window_to_frame but also compares the window with the widget's
345 windows. */
347 struct frame *
348 x_any_window_to_frame (dpyinfo, wdesc)
349 struct x_display_info *dpyinfo;
350 int wdesc;
352 Lisp_Object tail, frame;
353 struct frame *f, *found;
354 struct x_output *x;
356 found = NULL;
357 for (tail = Vframe_list; GC_CONSP (tail) && !found; tail = XCDR (tail))
359 frame = XCAR (tail);
360 if (!GC_FRAMEP (frame))
361 continue;
363 f = XFRAME (frame);
364 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
366 /* This frame matches if the window is any of its widgets. */
367 x = f->output_data.x;
368 if (x->hourglass_window == wdesc)
369 found = f;
370 else if (x->widget)
372 if (wdesc == XtWindow (x->widget)
373 || wdesc == XtWindow (x->column_widget)
374 || wdesc == XtWindow (x->edit_widget))
375 found = f;
376 /* Match if the window is this frame's menubar. */
377 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
378 found = f;
380 else if (FRAME_X_WINDOW (f) == wdesc)
381 /* A tooltip frame. */
382 found = f;
386 return found;
389 /* Likewise, but exclude the menu bar widget. */
391 struct frame *
392 x_non_menubar_window_to_frame (dpyinfo, wdesc)
393 struct x_display_info *dpyinfo;
394 int wdesc;
396 Lisp_Object tail, frame;
397 struct frame *f;
398 struct x_output *x;
400 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
402 frame = XCAR (tail);
403 if (!GC_FRAMEP (frame))
404 continue;
405 f = XFRAME (frame);
406 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
407 continue;
408 x = f->output_data.x;
409 /* This frame matches if the window is any of its widgets. */
410 if (x->hourglass_window == wdesc)
411 return f;
412 else if (x->widget)
414 if (wdesc == XtWindow (x->widget)
415 || wdesc == XtWindow (x->column_widget)
416 || wdesc == XtWindow (x->edit_widget))
417 return f;
419 else if (FRAME_X_WINDOW (f) == wdesc)
420 /* A tooltip frame. */
421 return f;
423 return 0;
426 /* Likewise, but consider only the menu bar widget. */
428 struct frame *
429 x_menubar_window_to_frame (dpyinfo, wdesc)
430 struct x_display_info *dpyinfo;
431 int wdesc;
433 Lisp_Object tail, frame;
434 struct frame *f;
435 struct x_output *x;
437 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
439 frame = XCAR (tail);
440 if (!GC_FRAMEP (frame))
441 continue;
442 f = XFRAME (frame);
443 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
444 continue;
445 x = f->output_data.x;
446 /* Match if the window is this frame's menubar. */
447 if (x->menubar_widget
448 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
449 return f;
451 return 0;
454 /* Return the frame whose principal (outermost) window is WDESC.
455 If WDESC is some other (smaller) window, we return 0. */
457 struct frame *
458 x_top_window_to_frame (dpyinfo, wdesc)
459 struct x_display_info *dpyinfo;
460 int wdesc;
462 Lisp_Object tail, frame;
463 struct frame *f;
464 struct x_output *x;
466 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
468 frame = XCAR (tail);
469 if (!GC_FRAMEP (frame))
470 continue;
471 f = XFRAME (frame);
472 if (!FRAME_X_P (f) || FRAME_X_DISPLAY_INFO (f) != dpyinfo)
473 continue;
474 x = f->output_data.x;
476 if (x->widget)
478 /* This frame matches if the window is its topmost widget. */
479 if (wdesc == XtWindow (x->widget))
480 return f;
481 #if 0 /* I don't know why it did this,
482 but it seems logically wrong,
483 and it causes trouble for MapNotify events. */
484 /* Match if the window is this frame's menubar. */
485 if (x->menubar_widget
486 && wdesc == XtWindow (x->menubar_widget))
487 return f;
488 #endif
490 else if (FRAME_X_WINDOW (f) == wdesc)
491 /* Tooltip frame. */
492 return f;
494 return 0;
496 #endif /* USE_X_TOOLKIT */
500 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
501 id, which is just an int that this section returns. Bitmaps are
502 reference counted so they can be shared among frames.
504 Bitmap indices are guaranteed to be > 0, so a negative number can
505 be used to indicate no bitmap.
507 If you use x_create_bitmap_from_data, then you must keep track of
508 the bitmaps yourself. That is, creating a bitmap from the same
509 data more than once will not be caught. */
512 /* Functions to access the contents of a bitmap, given an id. */
515 x_bitmap_height (f, id)
516 FRAME_PTR f;
517 int id;
519 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].height;
523 x_bitmap_width (f, id)
524 FRAME_PTR f;
525 int id;
527 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].width;
531 x_bitmap_pixmap (f, id)
532 FRAME_PTR f;
533 int id;
535 return FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].pixmap;
539 /* Allocate a new bitmap record. Returns index of new record. */
541 static int
542 x_allocate_bitmap_record (f)
543 FRAME_PTR f;
545 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
546 int i;
548 if (dpyinfo->bitmaps == NULL)
550 dpyinfo->bitmaps_size = 10;
551 dpyinfo->bitmaps
552 = (struct x_bitmap_record *) xmalloc (dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
553 dpyinfo->bitmaps_last = 1;
554 return 1;
557 if (dpyinfo->bitmaps_last < dpyinfo->bitmaps_size)
558 return ++dpyinfo->bitmaps_last;
560 for (i = 0; i < dpyinfo->bitmaps_size; ++i)
561 if (dpyinfo->bitmaps[i].refcount == 0)
562 return i + 1;
564 dpyinfo->bitmaps_size *= 2;
565 dpyinfo->bitmaps
566 = (struct x_bitmap_record *) xrealloc (dpyinfo->bitmaps,
567 dpyinfo->bitmaps_size * sizeof (struct x_bitmap_record));
568 return ++dpyinfo->bitmaps_last;
571 /* Add one reference to the reference count of the bitmap with id ID. */
573 void
574 x_reference_bitmap (f, id)
575 FRAME_PTR f;
576 int id;
578 ++FRAME_X_DISPLAY_INFO (f)->bitmaps[id - 1].refcount;
581 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
584 x_create_bitmap_from_data (f, bits, width, height)
585 struct frame *f;
586 char *bits;
587 unsigned int width, height;
589 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
590 Pixmap bitmap;
591 int id;
593 bitmap = XCreateBitmapFromData (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
594 bits, width, height);
596 if (! bitmap)
597 return -1;
599 id = x_allocate_bitmap_record (f);
600 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
601 dpyinfo->bitmaps[id - 1].file = NULL;
602 dpyinfo->bitmaps[id - 1].refcount = 1;
603 dpyinfo->bitmaps[id - 1].depth = 1;
604 dpyinfo->bitmaps[id - 1].height = height;
605 dpyinfo->bitmaps[id - 1].width = width;
607 return id;
610 /* Create bitmap from file FILE for frame F. */
613 x_create_bitmap_from_file (f, file)
614 struct frame *f;
615 Lisp_Object file;
617 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
618 unsigned int width, height;
619 Pixmap bitmap;
620 int xhot, yhot, result, id;
621 Lisp_Object found;
622 int fd;
623 char *filename;
625 /* Look for an existing bitmap with the same name. */
626 for (id = 0; id < dpyinfo->bitmaps_last; ++id)
628 if (dpyinfo->bitmaps[id].refcount
629 && dpyinfo->bitmaps[id].file
630 && !strcmp (dpyinfo->bitmaps[id].file, (char *) XSTRING (file)->data))
632 ++dpyinfo->bitmaps[id].refcount;
633 return id + 1;
637 /* Search bitmap-file-path for the file, if appropriate. */
638 fd = openp (Vx_bitmap_file_path, file, "", &found, 0);
639 if (fd < 0)
640 return -1;
641 emacs_close (fd);
643 filename = (char *) XSTRING (found)->data;
645 result = XReadBitmapFile (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
646 filename, &width, &height, &bitmap, &xhot, &yhot);
647 if (result != BitmapSuccess)
648 return -1;
650 id = x_allocate_bitmap_record (f);
651 dpyinfo->bitmaps[id - 1].pixmap = bitmap;
652 dpyinfo->bitmaps[id - 1].refcount = 1;
653 dpyinfo->bitmaps[id - 1].file
654 = (char *) xmalloc (STRING_BYTES (XSTRING (file)) + 1);
655 dpyinfo->bitmaps[id - 1].depth = 1;
656 dpyinfo->bitmaps[id - 1].height = height;
657 dpyinfo->bitmaps[id - 1].width = width;
658 strcpy (dpyinfo->bitmaps[id - 1].file, XSTRING (file)->data);
660 return id;
663 /* Remove reference to bitmap with id number ID. */
665 void
666 x_destroy_bitmap (f, id)
667 FRAME_PTR f;
668 int id;
670 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
672 if (id > 0)
674 --dpyinfo->bitmaps[id - 1].refcount;
675 if (dpyinfo->bitmaps[id - 1].refcount == 0)
677 BLOCK_INPUT;
678 XFreePixmap (FRAME_X_DISPLAY (f), dpyinfo->bitmaps[id - 1].pixmap);
679 if (dpyinfo->bitmaps[id - 1].file)
681 xfree (dpyinfo->bitmaps[id - 1].file);
682 dpyinfo->bitmaps[id - 1].file = NULL;
684 UNBLOCK_INPUT;
689 /* Free all the bitmaps for the display specified by DPYINFO. */
691 static void
692 x_destroy_all_bitmaps (dpyinfo)
693 struct x_display_info *dpyinfo;
695 int i;
696 for (i = 0; i < dpyinfo->bitmaps_last; i++)
697 if (dpyinfo->bitmaps[i].refcount > 0)
699 XFreePixmap (dpyinfo->display, dpyinfo->bitmaps[i].pixmap);
700 if (dpyinfo->bitmaps[i].file)
701 xfree (dpyinfo->bitmaps[i].file);
703 dpyinfo->bitmaps_last = 0;
706 /* Connect the frame-parameter names for X frames
707 to the ways of passing the parameter values to the window system.
709 The name of a parameter, as a Lisp symbol,
710 has an `x-frame-parameter' property which is an integer in Lisp
711 that is an index in this table. */
713 struct x_frame_parm_table
715 char *name;
716 void (*setter) P_ ((struct frame *, Lisp_Object, Lisp_Object));
719 static Lisp_Object unwind_create_frame P_ ((Lisp_Object));
720 static Lisp_Object unwind_create_tip_frame P_ ((Lisp_Object));
721 static void x_change_window_heights P_ ((Lisp_Object, int));
722 static void x_disable_image P_ ((struct frame *, struct image *));
723 static void x_create_im P_ ((struct frame *));
724 void x_set_foreground_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
725 static void x_set_line_spacing P_ ((struct frame *, Lisp_Object, Lisp_Object));
726 void x_set_background_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
727 void x_set_mouse_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
728 void x_set_cursor_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
729 void x_set_border_color P_ ((struct frame *, Lisp_Object, Lisp_Object));
730 void x_set_cursor_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
731 void x_set_icon_type P_ ((struct frame *, Lisp_Object, Lisp_Object));
732 void x_set_icon_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
733 void x_set_font P_ ((struct frame *, Lisp_Object, Lisp_Object));
734 void x_set_border_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
735 void x_set_internal_border_width P_ ((struct frame *, Lisp_Object,
736 Lisp_Object));
737 void x_explicitly_set_name P_ ((struct frame *, Lisp_Object, Lisp_Object));
738 void x_set_autoraise P_ ((struct frame *, Lisp_Object, Lisp_Object));
739 void x_set_autolower P_ ((struct frame *, Lisp_Object, Lisp_Object));
740 void x_set_vertical_scroll_bars P_ ((struct frame *, Lisp_Object,
741 Lisp_Object));
742 void x_set_visibility P_ ((struct frame *, Lisp_Object, Lisp_Object));
743 void x_set_menu_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
744 void x_set_scroll_bar_width P_ ((struct frame *, Lisp_Object, Lisp_Object));
745 void x_set_title P_ ((struct frame *, Lisp_Object, Lisp_Object));
746 void x_set_unsplittable P_ ((struct frame *, Lisp_Object, Lisp_Object));
747 void x_set_tool_bar_lines P_ ((struct frame *, Lisp_Object, Lisp_Object));
748 void x_set_scroll_bar_foreground P_ ((struct frame *, Lisp_Object,
749 Lisp_Object));
750 void x_set_scroll_bar_background P_ ((struct frame *, Lisp_Object,
751 Lisp_Object));
752 static Lisp_Object x_default_scroll_bar_color_parameter P_ ((struct frame *,
753 Lisp_Object,
754 Lisp_Object,
755 char *, char *,
756 int));
757 static void x_set_screen_gamma P_ ((struct frame *, Lisp_Object, Lisp_Object));
758 static void x_edge_detection P_ ((struct frame *, struct image *, Lisp_Object,
759 Lisp_Object));
760 static void init_color_table P_ ((void));
761 static void free_color_table P_ ((void));
762 static unsigned long *colors_in_color_table P_ ((int *n));
763 static unsigned long lookup_rgb_color P_ ((struct frame *f, int r, int g, int b));
764 static unsigned long lookup_pixel_color P_ ((struct frame *f, unsigned long p));
768 static struct x_frame_parm_table x_frame_parms[] =
770 "auto-raise", x_set_autoraise,
771 "auto-lower", x_set_autolower,
772 "background-color", x_set_background_color,
773 "border-color", x_set_border_color,
774 "border-width", x_set_border_width,
775 "cursor-color", x_set_cursor_color,
776 "cursor-type", x_set_cursor_type,
777 "font", x_set_font,
778 "foreground-color", x_set_foreground_color,
779 "icon-name", x_set_icon_name,
780 "icon-type", x_set_icon_type,
781 "internal-border-width", x_set_internal_border_width,
782 "menu-bar-lines", x_set_menu_bar_lines,
783 "mouse-color", x_set_mouse_color,
784 "name", x_explicitly_set_name,
785 "scroll-bar-width", x_set_scroll_bar_width,
786 "title", x_set_title,
787 "unsplittable", x_set_unsplittable,
788 "vertical-scroll-bars", x_set_vertical_scroll_bars,
789 "visibility", x_set_visibility,
790 "tool-bar-lines", x_set_tool_bar_lines,
791 "scroll-bar-foreground", x_set_scroll_bar_foreground,
792 "scroll-bar-background", x_set_scroll_bar_background,
793 "screen-gamma", x_set_screen_gamma,
794 "line-spacing", x_set_line_spacing
797 /* Attach the `x-frame-parameter' properties to
798 the Lisp symbol names of parameters relevant to X. */
800 void
801 init_x_parm_symbols ()
803 int i;
805 for (i = 0; i < sizeof (x_frame_parms) / sizeof (x_frame_parms[0]); i++)
806 Fput (intern (x_frame_parms[i].name), Qx_frame_parameter,
807 make_number (i));
810 /* Change the parameters of frame F as specified by ALIST.
811 If a parameter is not specially recognized, do nothing special;
812 otherwise call the `x_set_...' function for that parameter.
813 Except for certain geometry properties, always call store_frame_param
814 to store the new value in the parameter alist. */
816 void
817 x_set_frame_parameters (f, alist)
818 FRAME_PTR f;
819 Lisp_Object alist;
821 Lisp_Object tail;
823 /* If both of these parameters are present, it's more efficient to
824 set them both at once. So we wait until we've looked at the
825 entire list before we set them. */
826 int width, height;
828 /* Same here. */
829 Lisp_Object left, top;
831 /* Same with these. */
832 Lisp_Object icon_left, icon_top;
834 /* Record in these vectors all the parms specified. */
835 Lisp_Object *parms;
836 Lisp_Object *values;
837 int i, p;
838 int left_no_change = 0, top_no_change = 0;
839 int icon_left_no_change = 0, icon_top_no_change = 0;
841 struct gcpro gcpro1, gcpro2;
843 i = 0;
844 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
845 i++;
847 parms = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
848 values = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
850 /* Extract parm names and values into those vectors. */
852 i = 0;
853 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
855 Lisp_Object elt;
857 elt = Fcar (tail);
858 parms[i] = Fcar (elt);
859 values[i] = Fcdr (elt);
860 i++;
862 /* TAIL and ALIST are not used again below here. */
863 alist = tail = Qnil;
865 GCPRO2 (*parms, *values);
866 gcpro1.nvars = i;
867 gcpro2.nvars = i;
869 /* There is no need to gcpro LEFT, TOP, ICON_LEFT, or ICON_TOP,
870 because their values appear in VALUES and strings are not valid. */
871 top = left = Qunbound;
872 icon_left = icon_top = Qunbound;
874 /* Provide default values for HEIGHT and WIDTH. */
875 if (FRAME_NEW_WIDTH (f))
876 width = FRAME_NEW_WIDTH (f);
877 else
878 width = FRAME_WIDTH (f);
880 if (FRAME_NEW_HEIGHT (f))
881 height = FRAME_NEW_HEIGHT (f);
882 else
883 height = FRAME_HEIGHT (f);
885 /* Process foreground_color and background_color before anything else.
886 They are independent of other properties, but other properties (e.g.,
887 cursor_color) are dependent upon them. */
888 for (p = 0; p < i; p++)
890 Lisp_Object prop, val;
892 prop = parms[p];
893 val = values[p];
894 if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
896 register Lisp_Object param_index, old_value;
898 param_index = Fget (prop, Qx_frame_parameter);
899 old_value = get_frame_param (f, prop);
900 store_frame_param (f, prop, val);
901 if (NATNUMP (param_index)
902 && (XFASTINT (param_index)
903 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
904 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
908 /* Now process them in reverse of specified order. */
909 for (i--; i >= 0; i--)
911 Lisp_Object prop, val;
913 prop = parms[i];
914 val = values[i];
916 if (EQ (prop, Qwidth) && NUMBERP (val))
917 width = XFASTINT (val);
918 else if (EQ (prop, Qheight) && NUMBERP (val))
919 height = XFASTINT (val);
920 else if (EQ (prop, Qtop))
921 top = val;
922 else if (EQ (prop, Qleft))
923 left = val;
924 else if (EQ (prop, Qicon_top))
925 icon_top = val;
926 else if (EQ (prop, Qicon_left))
927 icon_left = val;
928 else if (EQ (prop, Qforeground_color) || EQ (prop, Qbackground_color))
929 /* Processed above. */
930 continue;
931 else
933 register Lisp_Object param_index, old_value;
935 param_index = Fget (prop, Qx_frame_parameter);
936 old_value = get_frame_param (f, prop);
937 store_frame_param (f, prop, val);
938 if (NATNUMP (param_index)
939 && (XFASTINT (param_index)
940 < sizeof (x_frame_parms)/sizeof (x_frame_parms[0])))
941 (*x_frame_parms[XINT (param_index)].setter)(f, val, old_value);
945 /* Don't die if just one of these was set. */
946 if (EQ (left, Qunbound))
948 left_no_change = 1;
949 if (f->output_data.x->left_pos < 0)
950 left = Fcons (Qplus, Fcons (make_number (f->output_data.x->left_pos), Qnil));
951 else
952 XSETINT (left, f->output_data.x->left_pos);
954 if (EQ (top, Qunbound))
956 top_no_change = 1;
957 if (f->output_data.x->top_pos < 0)
958 top = Fcons (Qplus, Fcons (make_number (f->output_data.x->top_pos), Qnil));
959 else
960 XSETINT (top, f->output_data.x->top_pos);
963 /* If one of the icon positions was not set, preserve or default it. */
964 if (EQ (icon_left, Qunbound) || ! INTEGERP (icon_left))
966 icon_left_no_change = 1;
967 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
968 if (NILP (icon_left))
969 XSETINT (icon_left, 0);
971 if (EQ (icon_top, Qunbound) || ! INTEGERP (icon_top))
973 icon_top_no_change = 1;
974 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
975 if (NILP (icon_top))
976 XSETINT (icon_top, 0);
979 /* Don't set these parameters unless they've been explicitly
980 specified. The window might be mapped or resized while we're in
981 this function, and we don't want to override that unless the lisp
982 code has asked for it.
984 Don't set these parameters unless they actually differ from the
985 window's current parameters; the window may not actually exist
986 yet. */
988 Lisp_Object frame;
990 check_frame_size (f, &height, &width);
992 XSETFRAME (frame, f);
994 if (width != FRAME_WIDTH (f)
995 || height != FRAME_HEIGHT (f)
996 || FRAME_NEW_HEIGHT (f) || FRAME_NEW_WIDTH (f))
997 Fset_frame_size (frame, make_number (width), make_number (height));
999 if ((!NILP (left) || !NILP (top))
1000 && ! (left_no_change && top_no_change)
1001 && ! (NUMBERP (left) && XINT (left) == f->output_data.x->left_pos
1002 && NUMBERP (top) && XINT (top) == f->output_data.x->top_pos))
1004 int leftpos = 0;
1005 int toppos = 0;
1007 /* Record the signs. */
1008 f->output_data.x->size_hint_flags &= ~ (XNegative | YNegative);
1009 if (EQ (left, Qminus))
1010 f->output_data.x->size_hint_flags |= XNegative;
1011 else if (INTEGERP (left))
1013 leftpos = XINT (left);
1014 if (leftpos < 0)
1015 f->output_data.x->size_hint_flags |= XNegative;
1017 else if (CONSP (left) && EQ (XCAR (left), Qminus)
1018 && CONSP (XCDR (left))
1019 && INTEGERP (XCAR (XCDR (left))))
1021 leftpos = - XINT (XCAR (XCDR (left)));
1022 f->output_data.x->size_hint_flags |= XNegative;
1024 else if (CONSP (left) && EQ (XCAR (left), Qplus)
1025 && CONSP (XCDR (left))
1026 && INTEGERP (XCAR (XCDR (left))))
1028 leftpos = XINT (XCAR (XCDR (left)));
1031 if (EQ (top, Qminus))
1032 f->output_data.x->size_hint_flags |= YNegative;
1033 else if (INTEGERP (top))
1035 toppos = XINT (top);
1036 if (toppos < 0)
1037 f->output_data.x->size_hint_flags |= YNegative;
1039 else if (CONSP (top) && EQ (XCAR (top), Qminus)
1040 && CONSP (XCDR (top))
1041 && INTEGERP (XCAR (XCDR (top))))
1043 toppos = - XINT (XCAR (XCDR (top)));
1044 f->output_data.x->size_hint_flags |= YNegative;
1046 else if (CONSP (top) && EQ (XCAR (top), Qplus)
1047 && CONSP (XCDR (top))
1048 && INTEGERP (XCAR (XCDR (top))))
1050 toppos = XINT (XCAR (XCDR (top)));
1054 /* Store the numeric value of the position. */
1055 f->output_data.x->top_pos = toppos;
1056 f->output_data.x->left_pos = leftpos;
1058 f->output_data.x->win_gravity = NorthWestGravity;
1060 /* Actually set that position, and convert to absolute. */
1061 x_set_offset (f, leftpos, toppos, -1);
1064 if ((!NILP (icon_left) || !NILP (icon_top))
1065 && ! (icon_left_no_change && icon_top_no_change))
1066 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
1069 UNGCPRO;
1072 /* Store the screen positions of frame F into XPTR and YPTR.
1073 These are the positions of the containing window manager window,
1074 not Emacs's own window. */
1076 void
1077 x_real_positions (f, xptr, yptr)
1078 FRAME_PTR f;
1079 int *xptr, *yptr;
1081 int win_x, win_y;
1082 Window child;
1084 /* This is pretty gross, but seems to be the easiest way out of
1085 the problem that arises when restarting window-managers. */
1087 #ifdef USE_X_TOOLKIT
1088 Window outer = (f->output_data.x->widget
1089 ? XtWindow (f->output_data.x->widget)
1090 : FRAME_X_WINDOW (f));
1091 #else
1092 Window outer = f->output_data.x->window_desc;
1093 #endif
1094 Window tmp_root_window;
1095 Window *tmp_children;
1096 unsigned int tmp_nchildren;
1098 while (1)
1100 int count = x_catch_errors (FRAME_X_DISPLAY (f));
1101 Window outer_window;
1103 XQueryTree (FRAME_X_DISPLAY (f), outer, &tmp_root_window,
1104 &f->output_data.x->parent_desc,
1105 &tmp_children, &tmp_nchildren);
1106 XFree ((char *) tmp_children);
1108 win_x = win_y = 0;
1110 /* Find the position of the outside upper-left corner of
1111 the inner window, with respect to the outer window. */
1112 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
1113 outer_window = f->output_data.x->parent_desc;
1114 else
1115 outer_window = outer;
1117 XTranslateCoordinates (FRAME_X_DISPLAY (f),
1119 /* From-window, to-window. */
1120 outer_window,
1121 FRAME_X_DISPLAY_INFO (f)->root_window,
1123 /* From-position, to-position. */
1124 0, 0, &win_x, &win_y,
1126 /* Child of win. */
1127 &child);
1129 /* It is possible for the window returned by the XQueryNotify
1130 to become invalid by the time we call XTranslateCoordinates.
1131 That can happen when you restart some window managers.
1132 If so, we get an error in XTranslateCoordinates.
1133 Detect that and try the whole thing over. */
1134 if (! x_had_errors_p (FRAME_X_DISPLAY (f)))
1136 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1137 break;
1140 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1143 *xptr = win_x;
1144 *yptr = win_y;
1147 /* Insert a description of internally-recorded parameters of frame X
1148 into the parameter alist *ALISTPTR that is to be given to the user.
1149 Only parameters that are specific to the X window system
1150 and whose values are not correctly recorded in the frame's
1151 param_alist need to be considered here. */
1153 void
1154 x_report_frame_params (f, alistptr)
1155 struct frame *f;
1156 Lisp_Object *alistptr;
1158 char buf[16];
1159 Lisp_Object tem;
1161 /* Represent negative positions (off the top or left screen edge)
1162 in a way that Fmodify_frame_parameters will understand correctly. */
1163 XSETINT (tem, f->output_data.x->left_pos);
1164 if (f->output_data.x->left_pos >= 0)
1165 store_in_alist (alistptr, Qleft, tem);
1166 else
1167 store_in_alist (alistptr, Qleft, Fcons (Qplus, Fcons (tem, Qnil)));
1169 XSETINT (tem, f->output_data.x->top_pos);
1170 if (f->output_data.x->top_pos >= 0)
1171 store_in_alist (alistptr, Qtop, tem);
1172 else
1173 store_in_alist (alistptr, Qtop, Fcons (Qplus, Fcons (tem, Qnil)));
1175 store_in_alist (alistptr, Qborder_width,
1176 make_number (f->output_data.x->border_width));
1177 store_in_alist (alistptr, Qinternal_border_width,
1178 make_number (f->output_data.x->internal_border_width));
1179 sprintf (buf, "%ld", (long) FRAME_X_WINDOW (f));
1180 store_in_alist (alistptr, Qwindow_id,
1181 build_string (buf));
1182 #ifdef USE_X_TOOLKIT
1183 /* Tooltip frame may not have this widget. */
1184 if (f->output_data.x->widget)
1185 #endif
1186 sprintf (buf, "%ld", (long) FRAME_OUTER_WINDOW (f));
1187 store_in_alist (alistptr, Qouter_window_id,
1188 build_string (buf));
1189 store_in_alist (alistptr, Qicon_name, f->icon_name);
1190 FRAME_SAMPLE_VISIBILITY (f);
1191 store_in_alist (alistptr, Qvisibility,
1192 (FRAME_VISIBLE_P (f) ? Qt
1193 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
1194 store_in_alist (alistptr, Qdisplay,
1195 XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element));
1197 if (f->output_data.x->parent_desc == FRAME_X_DISPLAY_INFO (f)->root_window)
1198 tem = Qnil;
1199 else
1200 XSETFASTINT (tem, f->output_data.x->parent_desc);
1201 store_in_alist (alistptr, Qparent_id, tem);
1206 /* Gamma-correct COLOR on frame F. */
1208 void
1209 gamma_correct (f, color)
1210 struct frame *f;
1211 XColor *color;
1213 if (f->gamma)
1215 color->red = pow (color->red / 65535.0, f->gamma) * 65535.0 + 0.5;
1216 color->green = pow (color->green / 65535.0, f->gamma) * 65535.0 + 0.5;
1217 color->blue = pow (color->blue / 65535.0, f->gamma) * 65535.0 + 0.5;
1222 /* Decide if color named COLOR_NAME is valid for use on frame F. If
1223 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
1224 allocate the color. Value is zero if COLOR_NAME is invalid, or
1225 no color could be allocated. */
1228 x_defined_color (f, color_name, color, alloc_p)
1229 struct frame *f;
1230 char *color_name;
1231 XColor *color;
1232 int alloc_p;
1234 int success_p;
1235 Display *dpy = FRAME_X_DISPLAY (f);
1236 Colormap cmap = FRAME_X_COLORMAP (f);
1238 BLOCK_INPUT;
1239 success_p = XParseColor (dpy, cmap, color_name, color);
1240 if (success_p && alloc_p)
1241 success_p = x_alloc_nearest_color (f, cmap, color);
1242 UNBLOCK_INPUT;
1244 return success_p;
1248 /* Return the pixel color value for color COLOR_NAME on frame F. If F
1249 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
1250 Signal an error if color can't be allocated. */
1253 x_decode_color (f, color_name, mono_color)
1254 FRAME_PTR f;
1255 Lisp_Object color_name;
1256 int mono_color;
1258 XColor cdef;
1260 CHECK_STRING (color_name, 0);
1262 #if 0 /* Don't do this. It's wrong when we're not using the default
1263 colormap, it makes freeing difficult, and it's probably not
1264 an important optimization. */
1265 if (strcmp (XSTRING (color_name)->data, "black") == 0)
1266 return BLACK_PIX_DEFAULT (f);
1267 else if (strcmp (XSTRING (color_name)->data, "white") == 0)
1268 return WHITE_PIX_DEFAULT (f);
1269 #endif
1271 /* Return MONO_COLOR for monochrome frames. */
1272 if (FRAME_X_DISPLAY_INFO (f)->n_planes == 1)
1273 return mono_color;
1275 /* x_defined_color is responsible for coping with failures
1276 by looking for a near-miss. */
1277 if (x_defined_color (f, XSTRING (color_name)->data, &cdef, 1))
1278 return cdef.pixel;
1280 Fsignal (Qerror, Fcons (build_string ("Undefined color"),
1281 Fcons (color_name, Qnil)));
1282 return 0;
1287 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
1288 the previous value of that parameter, NEW_VALUE is the new value. */
1290 static void
1291 x_set_line_spacing (f, new_value, old_value)
1292 struct frame *f;
1293 Lisp_Object new_value, old_value;
1295 if (NILP (new_value))
1296 f->extra_line_spacing = 0;
1297 else if (NATNUMP (new_value))
1298 f->extra_line_spacing = XFASTINT (new_value);
1299 else
1300 Fsignal (Qerror, Fcons (build_string ("Invalid line-spacing"),
1301 Fcons (new_value, Qnil)));
1302 if (FRAME_VISIBLE_P (f))
1303 redraw_frame (f);
1307 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
1308 the previous value of that parameter, NEW_VALUE is the new value. */
1310 static void
1311 x_set_screen_gamma (f, new_value, old_value)
1312 struct frame *f;
1313 Lisp_Object new_value, old_value;
1315 if (NILP (new_value))
1316 f->gamma = 0;
1317 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
1318 /* The value 0.4545 is the normal viewing gamma. */
1319 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
1320 else
1321 Fsignal (Qerror, Fcons (build_string ("Invalid screen-gamma"),
1322 Fcons (new_value, Qnil)));
1324 clear_face_cache (0);
1328 /* Functions called only from `x_set_frame_param'
1329 to set individual parameters.
1331 If FRAME_X_WINDOW (f) is 0,
1332 the frame is being created and its X-window does not exist yet.
1333 In that case, just record the parameter's new value
1334 in the standard place; do not attempt to change the window. */
1336 void
1337 x_set_foreground_color (f, arg, oldval)
1338 struct frame *f;
1339 Lisp_Object arg, oldval;
1341 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1343 unload_color (f, f->output_data.x->foreground_pixel);
1344 f->output_data.x->foreground_pixel = pixel;
1346 if (FRAME_X_WINDOW (f) != 0)
1348 BLOCK_INPUT;
1349 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1350 f->output_data.x->foreground_pixel);
1351 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
1352 f->output_data.x->foreground_pixel);
1353 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1354 f->output_data.x->foreground_pixel);
1355 UNBLOCK_INPUT;
1356 update_face_from_frame_parameter (f, Qforeground_color, arg);
1357 if (FRAME_VISIBLE_P (f))
1358 redraw_frame (f);
1362 void
1363 x_set_background_color (f, arg, oldval)
1364 struct frame *f;
1365 Lisp_Object arg, oldval;
1367 unsigned long pixel = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1369 unload_color (f, f->output_data.x->background_pixel);
1370 f->output_data.x->background_pixel = pixel;
1372 if (FRAME_X_WINDOW (f) != 0)
1374 BLOCK_INPUT;
1375 /* The main frame area. */
1376 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1377 f->output_data.x->background_pixel);
1378 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
1379 f->output_data.x->background_pixel);
1380 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1381 f->output_data.x->background_pixel);
1382 XSetWindowBackground (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1383 f->output_data.x->background_pixel);
1385 Lisp_Object bar;
1386 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar);
1387 bar = XSCROLL_BAR (bar)->next)
1388 XSetWindowBackground (FRAME_X_DISPLAY (f),
1389 SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar)),
1390 f->output_data.x->background_pixel);
1392 UNBLOCK_INPUT;
1394 update_face_from_frame_parameter (f, Qbackground_color, arg);
1396 if (FRAME_VISIBLE_P (f))
1397 redraw_frame (f);
1401 void
1402 x_set_mouse_color (f, arg, oldval)
1403 struct frame *f;
1404 Lisp_Object arg, oldval;
1406 Cursor cursor, nontext_cursor, mode_cursor, cross_cursor;
1407 Cursor hourglass_cursor, horizontal_drag_cursor;
1408 int count;
1409 unsigned long pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1410 unsigned long mask_color = f->output_data.x->background_pixel;
1412 /* Don't let pointers be invisible. */
1413 if (mask_color == pixel
1414 && mask_color == f->output_data.x->background_pixel)
1416 x_free_colors (f, &pixel, 1);
1417 pixel = x_copy_color (f, f->output_data.x->foreground_pixel);
1420 unload_color (f, f->output_data.x->mouse_pixel);
1421 f->output_data.x->mouse_pixel = pixel;
1423 BLOCK_INPUT;
1425 /* It's not okay to crash if the user selects a screwy cursor. */
1426 count = x_catch_errors (FRAME_X_DISPLAY (f));
1428 if (!EQ (Qnil, Vx_pointer_shape))
1430 CHECK_NUMBER (Vx_pointer_shape, 0);
1431 cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XINT (Vx_pointer_shape));
1433 else
1434 cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_xterm);
1435 x_check_errors (FRAME_X_DISPLAY (f), "bad text pointer cursor: %s");
1437 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1439 CHECK_NUMBER (Vx_nontext_pointer_shape, 0);
1440 nontext_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1441 XINT (Vx_nontext_pointer_shape));
1443 else
1444 nontext_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_left_ptr);
1445 x_check_errors (FRAME_X_DISPLAY (f), "bad nontext pointer cursor: %s");
1447 if (!EQ (Qnil, Vx_hourglass_pointer_shape))
1449 CHECK_NUMBER (Vx_hourglass_pointer_shape, 0);
1450 hourglass_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1451 XINT (Vx_hourglass_pointer_shape));
1453 else
1454 hourglass_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_watch);
1455 x_check_errors (FRAME_X_DISPLAY (f), "bad hourglass pointer cursor: %s");
1457 x_check_errors (FRAME_X_DISPLAY (f), "bad nontext pointer cursor: %s");
1458 if (!EQ (Qnil, Vx_mode_pointer_shape))
1460 CHECK_NUMBER (Vx_mode_pointer_shape, 0);
1461 mode_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f),
1462 XINT (Vx_mode_pointer_shape));
1464 else
1465 mode_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_xterm);
1466 x_check_errors (FRAME_X_DISPLAY (f), "bad modeline pointer cursor: %s");
1468 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1470 CHECK_NUMBER (Vx_sensitive_text_pointer_shape, 0);
1471 cross_cursor
1472 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1473 XINT (Vx_sensitive_text_pointer_shape));
1475 else
1476 cross_cursor = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_crosshair);
1478 if (!NILP (Vx_window_horizontal_drag_shape))
1480 CHECK_NUMBER (Vx_window_horizontal_drag_shape, 0);
1481 horizontal_drag_cursor
1482 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1483 XINT (Vx_window_horizontal_drag_shape));
1485 else
1486 horizontal_drag_cursor
1487 = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_sb_h_double_arrow);
1489 /* Check and report errors with the above calls. */
1490 x_check_errors (FRAME_X_DISPLAY (f), "can't set cursor shape: %s");
1491 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
1494 XColor fore_color, back_color;
1496 fore_color.pixel = f->output_data.x->mouse_pixel;
1497 x_query_color (f, &fore_color);
1498 back_color.pixel = mask_color;
1499 x_query_color (f, &back_color);
1501 XRecolorCursor (FRAME_X_DISPLAY (f), cursor,
1502 &fore_color, &back_color);
1503 XRecolorCursor (FRAME_X_DISPLAY (f), nontext_cursor,
1504 &fore_color, &back_color);
1505 XRecolorCursor (FRAME_X_DISPLAY (f), mode_cursor,
1506 &fore_color, &back_color);
1507 XRecolorCursor (FRAME_X_DISPLAY (f), cross_cursor,
1508 &fore_color, &back_color);
1509 XRecolorCursor (FRAME_X_DISPLAY (f), hourglass_cursor,
1510 &fore_color, &back_color);
1511 XRecolorCursor (FRAME_X_DISPLAY (f), horizontal_drag_cursor,
1512 &fore_color, &back_color);
1515 if (FRAME_X_WINDOW (f) != 0)
1516 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
1518 if (cursor != f->output_data.x->text_cursor
1519 && f->output_data.x->text_cursor != 0)
1520 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->text_cursor);
1521 f->output_data.x->text_cursor = cursor;
1523 if (nontext_cursor != f->output_data.x->nontext_cursor
1524 && f->output_data.x->nontext_cursor != 0)
1525 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->nontext_cursor);
1526 f->output_data.x->nontext_cursor = nontext_cursor;
1528 if (hourglass_cursor != f->output_data.x->hourglass_cursor
1529 && f->output_data.x->hourglass_cursor != 0)
1530 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hourglass_cursor);
1531 f->output_data.x->hourglass_cursor = hourglass_cursor;
1533 if (mode_cursor != f->output_data.x->modeline_cursor
1534 && f->output_data.x->modeline_cursor != 0)
1535 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->modeline_cursor);
1536 f->output_data.x->modeline_cursor = mode_cursor;
1538 if (cross_cursor != f->output_data.x->cross_cursor
1539 && f->output_data.x->cross_cursor != 0)
1540 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->cross_cursor);
1541 f->output_data.x->cross_cursor = cross_cursor;
1543 if (horizontal_drag_cursor != f->output_data.x->horizontal_drag_cursor
1544 && f->output_data.x->horizontal_drag_cursor != 0)
1545 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->horizontal_drag_cursor);
1546 f->output_data.x->horizontal_drag_cursor = horizontal_drag_cursor;
1548 XFlush (FRAME_X_DISPLAY (f));
1549 UNBLOCK_INPUT;
1551 update_face_from_frame_parameter (f, Qmouse_color, arg);
1554 void
1555 x_set_cursor_color (f, arg, oldval)
1556 struct frame *f;
1557 Lisp_Object arg, oldval;
1559 unsigned long fore_pixel, pixel;
1560 int fore_pixel_allocated_p = 0, pixel_allocated_p = 0;
1562 if (!NILP (Vx_cursor_fore_pixel))
1564 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1565 WHITE_PIX_DEFAULT (f));
1566 fore_pixel_allocated_p = 1;
1568 else
1569 fore_pixel = f->output_data.x->background_pixel;
1571 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1572 pixel_allocated_p = 1;
1574 /* Make sure that the cursor color differs from the background color. */
1575 if (pixel == f->output_data.x->background_pixel)
1577 if (pixel_allocated_p)
1579 x_free_colors (f, &pixel, 1);
1580 pixel_allocated_p = 0;
1583 pixel = f->output_data.x->mouse_pixel;
1584 if (pixel == fore_pixel)
1586 if (fore_pixel_allocated_p)
1588 x_free_colors (f, &fore_pixel, 1);
1589 fore_pixel_allocated_p = 0;
1591 fore_pixel = f->output_data.x->background_pixel;
1595 unload_color (f, f->output_data.x->cursor_foreground_pixel);
1596 if (!fore_pixel_allocated_p)
1597 fore_pixel = x_copy_color (f, fore_pixel);
1598 f->output_data.x->cursor_foreground_pixel = fore_pixel;
1600 unload_color (f, f->output_data.x->cursor_pixel);
1601 if (!pixel_allocated_p)
1602 pixel = x_copy_color (f, pixel);
1603 f->output_data.x->cursor_pixel = pixel;
1605 if (FRAME_X_WINDOW (f) != 0)
1607 BLOCK_INPUT;
1608 XSetBackground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1609 f->output_data.x->cursor_pixel);
1610 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
1611 fore_pixel);
1612 UNBLOCK_INPUT;
1614 if (FRAME_VISIBLE_P (f))
1616 x_update_cursor (f, 0);
1617 x_update_cursor (f, 1);
1621 update_face_from_frame_parameter (f, Qcursor_color, arg);
1624 /* Set the border-color of frame F to value described by ARG.
1625 ARG can be a string naming a color.
1626 The border-color is used for the border that is drawn by the X server.
1627 Note that this does not fully take effect if done before
1628 F has an x-window; it must be redone when the window is created.
1630 Note: this is done in two routines because of the way X10 works.
1632 Note: under X11, this is normally the province of the window manager,
1633 and so emacs' border colors may be overridden. */
1635 void
1636 x_set_border_color (f, arg, oldval)
1637 struct frame *f;
1638 Lisp_Object arg, oldval;
1640 int pix;
1642 CHECK_STRING (arg, 0);
1643 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1644 x_set_border_pixel (f, pix);
1645 update_face_from_frame_parameter (f, Qborder_color, arg);
1648 /* Set the border-color of frame F to pixel value PIX.
1649 Note that this does not fully take effect if done before
1650 F has an x-window. */
1652 void
1653 x_set_border_pixel (f, pix)
1654 struct frame *f;
1655 int pix;
1657 unload_color (f, f->output_data.x->border_pixel);
1658 f->output_data.x->border_pixel = pix;
1660 if (FRAME_X_WINDOW (f) != 0 && f->output_data.x->border_width > 0)
1662 BLOCK_INPUT;
1663 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1664 (unsigned long)pix);
1665 UNBLOCK_INPUT;
1667 if (FRAME_VISIBLE_P (f))
1668 redraw_frame (f);
1673 /* Value is the internal representation of the specified cursor type
1674 ARG. If type is BAR_CURSOR, return in *WIDTH the specified width
1675 of the bar cursor. */
1677 enum text_cursor_kinds
1678 x_specified_cursor_type (arg, width)
1679 Lisp_Object arg;
1680 int *width;
1682 enum text_cursor_kinds type;
1684 if (EQ (arg, Qbar))
1686 type = BAR_CURSOR;
1687 *width = 2;
1689 else if (CONSP (arg)
1690 && EQ (XCAR (arg), Qbar)
1691 && INTEGERP (XCDR (arg))
1692 && XINT (XCDR (arg)) >= 0)
1694 type = BAR_CURSOR;
1695 *width = XINT (XCDR (arg));
1697 else if (NILP (arg))
1698 type = NO_CURSOR;
1699 else
1700 /* Treat anything unknown as "box cursor".
1701 It was bad to signal an error; people have trouble fixing
1702 .Xdefaults with Emacs, when it has something bad in it. */
1703 type = FILLED_BOX_CURSOR;
1705 return type;
1708 void
1709 x_set_cursor_type (f, arg, oldval)
1710 FRAME_PTR f;
1711 Lisp_Object arg, oldval;
1713 int width;
1715 FRAME_DESIRED_CURSOR (f) = x_specified_cursor_type (arg, &width);
1716 f->output_data.x->cursor_width = width;
1718 /* Make sure the cursor gets redrawn. This is overkill, but how
1719 often do people change cursor types? */
1720 update_mode_lines++;
1723 void
1724 x_set_icon_type (f, arg, oldval)
1725 struct frame *f;
1726 Lisp_Object arg, oldval;
1728 int result;
1730 if (STRINGP (arg))
1732 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1733 return;
1735 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1736 return;
1738 BLOCK_INPUT;
1739 if (NILP (arg))
1740 result = x_text_icon (f,
1741 (char *) XSTRING ((!NILP (f->icon_name)
1742 ? f->icon_name
1743 : f->name))->data);
1744 else
1745 result = x_bitmap_icon (f, arg);
1747 if (result)
1749 UNBLOCK_INPUT;
1750 error ("No icon window available");
1753 XFlush (FRAME_X_DISPLAY (f));
1754 UNBLOCK_INPUT;
1757 /* Return non-nil if frame F wants a bitmap icon. */
1759 Lisp_Object
1760 x_icon_type (f)
1761 FRAME_PTR f;
1763 Lisp_Object tem;
1765 tem = assq_no_quit (Qicon_type, f->param_alist);
1766 if (CONSP (tem))
1767 return XCDR (tem);
1768 else
1769 return Qnil;
1772 void
1773 x_set_icon_name (f, arg, oldval)
1774 struct frame *f;
1775 Lisp_Object arg, oldval;
1777 int result;
1779 if (STRINGP (arg))
1781 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1782 return;
1784 else if (!STRINGP (oldval) && EQ (oldval, Qnil) == EQ (arg, Qnil))
1785 return;
1787 f->icon_name = arg;
1789 if (f->output_data.x->icon_bitmap != 0)
1790 return;
1792 BLOCK_INPUT;
1794 result = x_text_icon (f,
1795 (char *) XSTRING ((!NILP (f->icon_name)
1796 ? f->icon_name
1797 : !NILP (f->title)
1798 ? f->title
1799 : f->name))->data);
1801 if (result)
1803 UNBLOCK_INPUT;
1804 error ("No icon window available");
1807 XFlush (FRAME_X_DISPLAY (f));
1808 UNBLOCK_INPUT;
1811 void
1812 x_set_font (f, arg, oldval)
1813 struct frame *f;
1814 Lisp_Object arg, oldval;
1816 Lisp_Object result;
1817 Lisp_Object fontset_name;
1818 Lisp_Object frame;
1819 int old_fontset = f->output_data.x->fontset;
1821 CHECK_STRING (arg, 1);
1823 fontset_name = Fquery_fontset (arg, Qnil);
1825 BLOCK_INPUT;
1826 result = (STRINGP (fontset_name)
1827 ? x_new_fontset (f, XSTRING (fontset_name)->data)
1828 : x_new_font (f, XSTRING (arg)->data));
1829 UNBLOCK_INPUT;
1831 if (EQ (result, Qnil))
1832 error ("Font `%s' is not defined", XSTRING (arg)->data);
1833 else if (EQ (result, Qt))
1834 error ("The characters of the given font have varying widths");
1835 else if (STRINGP (result))
1837 if (STRINGP (fontset_name))
1839 /* Fontset names are built from ASCII font names, so the
1840 names may be equal despite there was a change. */
1841 if (old_fontset == f->output_data.x->fontset)
1842 return;
1844 else if (!NILP (Fequal (result, oldval)))
1845 return;
1847 store_frame_param (f, Qfont, result);
1848 recompute_basic_faces (f);
1850 else
1851 abort ();
1853 do_pending_window_change (0);
1855 /* Don't call `face-set-after-frame-default' when faces haven't been
1856 initialized yet. This is the case when called from
1857 Fx_create_frame. In that case, the X widget or window doesn't
1858 exist either, and we can end up in x_report_frame_params with a
1859 null widget which gives a segfault. */
1860 if (FRAME_FACE_CACHE (f))
1862 XSETFRAME (frame, f);
1863 call1 (Qface_set_after_frame_default, frame);
1867 void
1868 x_set_border_width (f, arg, oldval)
1869 struct frame *f;
1870 Lisp_Object arg, oldval;
1872 CHECK_NUMBER (arg, 0);
1874 if (XINT (arg) == f->output_data.x->border_width)
1875 return;
1877 if (FRAME_X_WINDOW (f) != 0)
1878 error ("Cannot change the border width of a window");
1880 f->output_data.x->border_width = XINT (arg);
1883 void
1884 x_set_internal_border_width (f, arg, oldval)
1885 struct frame *f;
1886 Lisp_Object arg, oldval;
1888 int old = f->output_data.x->internal_border_width;
1890 CHECK_NUMBER (arg, 0);
1891 f->output_data.x->internal_border_width = XINT (arg);
1892 if (f->output_data.x->internal_border_width < 0)
1893 f->output_data.x->internal_border_width = 0;
1895 #ifdef USE_X_TOOLKIT
1896 if (f->output_data.x->edit_widget)
1897 widget_store_internal_border (f->output_data.x->edit_widget);
1898 #endif
1900 if (f->output_data.x->internal_border_width == old)
1901 return;
1903 if (FRAME_X_WINDOW (f) != 0)
1905 x_set_window_size (f, 0, f->width, f->height);
1906 SET_FRAME_GARBAGED (f);
1907 do_pending_window_change (0);
1911 void
1912 x_set_visibility (f, value, oldval)
1913 struct frame *f;
1914 Lisp_Object value, oldval;
1916 Lisp_Object frame;
1917 XSETFRAME (frame, f);
1919 if (NILP (value))
1920 Fmake_frame_invisible (frame, Qt);
1921 else if (EQ (value, Qicon))
1922 Ficonify_frame (frame);
1923 else
1924 Fmake_frame_visible (frame);
1928 /* Change window heights in windows rooted in WINDOW by N lines. */
1930 static void
1931 x_change_window_heights (window, n)
1932 Lisp_Object window;
1933 int n;
1935 struct window *w = XWINDOW (window);
1937 XSETFASTINT (w->top, XFASTINT (w->top) + n);
1938 XSETFASTINT (w->height, XFASTINT (w->height) - n);
1940 if (INTEGERP (w->orig_top))
1941 XSETFASTINT (w->orig_top, XFASTINT (w->orig_top) + n);
1942 if (INTEGERP (w->orig_height))
1943 XSETFASTINT (w->orig_height, XFASTINT (w->orig_height) - n);
1945 /* Handle just the top child in a vertical split. */
1946 if (!NILP (w->vchild))
1947 x_change_window_heights (w->vchild, n);
1949 /* Adjust all children in a horizontal split. */
1950 for (window = w->hchild; !NILP (window); window = w->next)
1952 w = XWINDOW (window);
1953 x_change_window_heights (window, n);
1957 void
1958 x_set_menu_bar_lines (f, value, oldval)
1959 struct frame *f;
1960 Lisp_Object value, oldval;
1962 int nlines;
1963 #ifndef USE_X_TOOLKIT
1964 int olines = FRAME_MENU_BAR_LINES (f);
1965 #endif
1967 /* Right now, menu bars don't work properly in minibuf-only frames;
1968 most of the commands try to apply themselves to the minibuffer
1969 frame itself, and get an error because you can't switch buffers
1970 in or split the minibuffer window. */
1971 if (FRAME_MINIBUF_ONLY_P (f))
1972 return;
1974 if (INTEGERP (value))
1975 nlines = XINT (value);
1976 else
1977 nlines = 0;
1979 /* Make sure we redisplay all windows in this frame. */
1980 windows_or_buffers_changed++;
1982 #ifdef USE_X_TOOLKIT
1983 FRAME_MENU_BAR_LINES (f) = 0;
1984 if (nlines)
1986 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1987 if (FRAME_X_P (f) && f->output_data.x->menubar_widget == 0)
1988 /* Make sure next redisplay shows the menu bar. */
1989 XWINDOW (FRAME_SELECTED_WINDOW (f))->update_mode_line = Qt;
1991 else
1993 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1994 free_frame_menubar (f);
1995 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1996 if (FRAME_X_P (f))
1997 f->output_data.x->menubar_widget = 0;
1999 #else /* not USE_X_TOOLKIT */
2000 FRAME_MENU_BAR_LINES (f) = nlines;
2001 x_change_window_heights (f->root_window, nlines - olines);
2002 #endif /* not USE_X_TOOLKIT */
2003 adjust_glyphs (f);
2007 /* Set the number of lines used for the tool bar of frame F to VALUE.
2008 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
2009 is the old number of tool bar lines. This function changes the
2010 height of all windows on frame F to match the new tool bar height.
2011 The frame's height doesn't change. */
2013 void
2014 x_set_tool_bar_lines (f, value, oldval)
2015 struct frame *f;
2016 Lisp_Object value, oldval;
2018 int delta, nlines, root_height;
2019 Lisp_Object root_window;
2021 /* Treat tool bars like menu bars. */
2022 if (FRAME_MINIBUF_ONLY_P (f))
2023 return;
2025 /* Use VALUE only if an integer >= 0. */
2026 if (INTEGERP (value) && XINT (value) >= 0)
2027 nlines = XFASTINT (value);
2028 else
2029 nlines = 0;
2031 /* Make sure we redisplay all windows in this frame. */
2032 ++windows_or_buffers_changed;
2034 delta = nlines - FRAME_TOOL_BAR_LINES (f);
2036 /* Don't resize the tool-bar to more than we have room for. */
2037 root_window = FRAME_ROOT_WINDOW (f);
2038 root_height = XINT (XWINDOW (root_window)->height);
2039 if (root_height - delta < 1)
2041 delta = root_height - 1;
2042 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
2045 FRAME_TOOL_BAR_LINES (f) = nlines;
2046 x_change_window_heights (root_window, delta);
2047 adjust_glyphs (f);
2049 /* We also have to make sure that the internal border at the top of
2050 the frame, below the menu bar or tool bar, is redrawn when the
2051 tool bar disappears. This is so because the internal border is
2052 below the tool bar if one is displayed, but is below the menu bar
2053 if there isn't a tool bar. The tool bar draws into the area
2054 below the menu bar. */
2055 if (FRAME_X_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
2057 updating_frame = f;
2058 clear_frame ();
2059 clear_current_matrices (f);
2060 updating_frame = NULL;
2063 /* If the tool bar gets smaller, the internal border below it
2064 has to be cleared. It was formerly part of the display
2065 of the larger tool bar, and updating windows won't clear it. */
2066 if (delta < 0)
2068 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
2069 int width = PIXEL_WIDTH (f);
2070 int y = nlines * CANON_Y_UNIT (f);
2072 BLOCK_INPUT;
2073 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2074 0, y, width, height, False);
2075 UNBLOCK_INPUT;
2080 /* Set the foreground color for scroll bars on frame F to VALUE.
2081 VALUE should be a string, a color name. If it isn't a string or
2082 isn't a valid color name, do nothing. OLDVAL is the old value of
2083 the frame parameter. */
2085 void
2086 x_set_scroll_bar_foreground (f, value, oldval)
2087 struct frame *f;
2088 Lisp_Object value, oldval;
2090 unsigned long pixel;
2092 if (STRINGP (value))
2093 pixel = x_decode_color (f, value, BLACK_PIX_DEFAULT (f));
2094 else
2095 pixel = -1;
2097 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
2098 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
2100 f->output_data.x->scroll_bar_foreground_pixel = pixel;
2101 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2103 /* Remove all scroll bars because they have wrong colors. */
2104 if (condemn_scroll_bars_hook)
2105 (*condemn_scroll_bars_hook) (f);
2106 if (judge_scroll_bars_hook)
2107 (*judge_scroll_bars_hook) (f);
2109 update_face_from_frame_parameter (f, Qscroll_bar_foreground, value);
2110 redraw_frame (f);
2115 /* Set the background color for scroll bars on frame F to VALUE VALUE
2116 should be a string, a color name. If it isn't a string or isn't a
2117 valid color name, do nothing. OLDVAL is the old value of the frame
2118 parameter. */
2120 void
2121 x_set_scroll_bar_background (f, value, oldval)
2122 struct frame *f;
2123 Lisp_Object value, oldval;
2125 unsigned long pixel;
2127 if (STRINGP (value))
2128 pixel = x_decode_color (f, value, WHITE_PIX_DEFAULT (f));
2129 else
2130 pixel = -1;
2132 if (f->output_data.x->scroll_bar_background_pixel != -1)
2133 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
2135 f->output_data.x->scroll_bar_background_pixel = pixel;
2136 if (FRAME_X_WINDOW (f) && FRAME_VISIBLE_P (f))
2138 /* Remove all scroll bars because they have wrong colors. */
2139 if (condemn_scroll_bars_hook)
2140 (*condemn_scroll_bars_hook) (f);
2141 if (judge_scroll_bars_hook)
2142 (*judge_scroll_bars_hook) (f);
2144 update_face_from_frame_parameter (f, Qscroll_bar_background, value);
2145 redraw_frame (f);
2150 /* Encode Lisp string STRING as a text in a format appropriate for
2151 XICCC (X Inter Client Communication Conventions).
2153 If STRING contains only ASCII characters, do no conversion and
2154 return the string data of STRING. Otherwise, encode the text by
2155 CODING_SYSTEM, and return a newly allocated memory area which
2156 should be freed by `xfree' by a caller.
2158 Store the byte length of resulting text in *TEXT_BYTES.
2160 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
2161 which means that the `encoding' of the result can be `STRING'.
2162 Otherwise store 0 in *STRINGP, which means that the `encoding' of
2163 the result should be `COMPOUND_TEXT'. */
2165 unsigned char *
2166 x_encode_text (string, coding_system, text_bytes, stringp)
2167 Lisp_Object string, coding_system;
2168 int *text_bytes, *stringp;
2170 unsigned char *str = XSTRING (string)->data;
2171 int chars = XSTRING (string)->size;
2172 int bytes = STRING_BYTES (XSTRING (string));
2173 int charset_info;
2174 int bufsize;
2175 unsigned char *buf;
2176 struct coding_system coding;
2178 charset_info = find_charset_in_text (str, chars, bytes, NULL, Qnil);
2179 if (charset_info == 0)
2181 /* No multibyte character in OBJ. We need not encode it. */
2182 *text_bytes = bytes;
2183 *stringp = 1;
2184 return str;
2187 setup_coding_system (coding_system, &coding);
2188 coding.src_multibyte = 1;
2189 coding.dst_multibyte = 0;
2190 coding.mode |= CODING_MODE_LAST_BLOCK;
2191 if (coding.type == coding_type_iso2022)
2192 coding.flags |= CODING_FLAG_ISO_SAFE;
2193 /* We suppress producing escape sequences for composition. */
2194 coding.composing = COMPOSITION_DISABLED;
2195 bufsize = encoding_buffer_size (&coding, bytes);
2196 buf = (unsigned char *) xmalloc (bufsize);
2197 encode_coding (&coding, str, buf, bytes, bufsize);
2198 *text_bytes = coding.produced;
2199 *stringp = (charset_info == 1 || !EQ (coding_system, Qcompound_text));
2200 return buf;
2204 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
2205 x_id_name.
2207 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2208 name; if NAME is a string, set F's name to NAME and set
2209 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2211 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2212 suggesting a new name, which lisp code should override; if
2213 F->explicit_name is set, ignore the new name; otherwise, set it. */
2215 void
2216 x_set_name (f, name, explicit)
2217 struct frame *f;
2218 Lisp_Object name;
2219 int explicit;
2221 /* Make sure that requests from lisp code override requests from
2222 Emacs redisplay code. */
2223 if (explicit)
2225 /* If we're switching from explicit to implicit, we had better
2226 update the mode lines and thereby update the title. */
2227 if (f->explicit_name && NILP (name))
2228 update_mode_lines = 1;
2230 f->explicit_name = ! NILP (name);
2232 else if (f->explicit_name)
2233 return;
2235 /* If NAME is nil, set the name to the x_id_name. */
2236 if (NILP (name))
2238 /* Check for no change needed in this very common case
2239 before we do any consing. */
2240 if (!strcmp (FRAME_X_DISPLAY_INFO (f)->x_id_name,
2241 XSTRING (f->name)->data))
2242 return;
2243 name = build_string (FRAME_X_DISPLAY_INFO (f)->x_id_name);
2245 else
2246 CHECK_STRING (name, 0);
2248 /* Don't change the name if it's already NAME. */
2249 if (! NILP (Fstring_equal (name, f->name)))
2250 return;
2252 f->name = name;
2254 /* For setting the frame title, the title parameter should override
2255 the name parameter. */
2256 if (! NILP (f->title))
2257 name = f->title;
2259 if (FRAME_X_WINDOW (f))
2261 BLOCK_INPUT;
2262 #ifdef HAVE_X11R4
2264 XTextProperty text, icon;
2265 int bytes, stringp;
2266 Lisp_Object coding_system;
2268 coding_system = Vlocale_coding_system;
2269 if (NILP (coding_system))
2270 coding_system = Qcompound_text;
2271 text.value = x_encode_text (name, coding_system, &bytes, &stringp);
2272 text.encoding = (stringp ? XA_STRING
2273 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2274 text.format = 8;
2275 text.nitems = bytes;
2277 if (NILP (f->icon_name))
2279 icon = text;
2281 else
2283 icon.value = x_encode_text (f->icon_name, coding_system,
2284 &bytes, &stringp);
2285 icon.encoding = (stringp ? XA_STRING
2286 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2287 icon.format = 8;
2288 icon.nitems = bytes;
2290 #ifdef USE_X_TOOLKIT
2291 XSetWMName (FRAME_X_DISPLAY (f),
2292 XtWindow (f->output_data.x->widget), &text);
2293 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2294 &icon);
2295 #else /* not USE_X_TOOLKIT */
2296 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2297 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2298 #endif /* not USE_X_TOOLKIT */
2299 if (!NILP (f->icon_name)
2300 && icon.value != XSTRING (f->icon_name)->data)
2301 xfree (icon.value);
2302 if (text.value != XSTRING (name)->data)
2303 xfree (text.value);
2305 #else /* not HAVE_X11R4 */
2306 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2307 XSTRING (name)->data);
2308 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2309 XSTRING (name)->data);
2310 #endif /* not HAVE_X11R4 */
2311 UNBLOCK_INPUT;
2315 /* This function should be called when the user's lisp code has
2316 specified a name for the frame; the name will override any set by the
2317 redisplay code. */
2318 void
2319 x_explicitly_set_name (f, arg, oldval)
2320 FRAME_PTR f;
2321 Lisp_Object arg, oldval;
2323 x_set_name (f, arg, 1);
2326 /* This function should be called by Emacs redisplay code to set the
2327 name; names set this way will never override names set by the user's
2328 lisp code. */
2329 void
2330 x_implicitly_set_name (f, arg, oldval)
2331 FRAME_PTR f;
2332 Lisp_Object arg, oldval;
2334 x_set_name (f, arg, 0);
2337 /* Change the title of frame F to NAME.
2338 If NAME is nil, use the frame name as the title.
2340 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2341 name; if NAME is a string, set F's name to NAME and set
2342 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2344 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2345 suggesting a new name, which lisp code should override; if
2346 F->explicit_name is set, ignore the new name; otherwise, set it. */
2348 void
2349 x_set_title (f, name, old_name)
2350 struct frame *f;
2351 Lisp_Object name, old_name;
2353 /* Don't change the title if it's already NAME. */
2354 if (EQ (name, f->title))
2355 return;
2357 update_mode_lines = 1;
2359 f->title = name;
2361 if (NILP (name))
2362 name = f->name;
2363 else
2364 CHECK_STRING (name, 0);
2366 if (FRAME_X_WINDOW (f))
2368 BLOCK_INPUT;
2369 #ifdef HAVE_X11R4
2371 XTextProperty text, icon;
2372 int bytes, stringp;
2373 Lisp_Object coding_system;
2375 coding_system = Vlocale_coding_system;
2376 if (NILP (coding_system))
2377 coding_system = Qcompound_text;
2378 text.value = x_encode_text (name, coding_system, &bytes, &stringp);
2379 text.encoding = (stringp ? XA_STRING
2380 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2381 text.format = 8;
2382 text.nitems = bytes;
2384 if (NILP (f->icon_name))
2386 icon = text;
2388 else
2390 icon.value = x_encode_text (f->icon_name, coding_system,
2391 &bytes, &stringp);
2392 icon.encoding = (stringp ? XA_STRING
2393 : FRAME_X_DISPLAY_INFO (f)->Xatom_COMPOUND_TEXT);
2394 icon.format = 8;
2395 icon.nitems = bytes;
2397 #ifdef USE_X_TOOLKIT
2398 XSetWMName (FRAME_X_DISPLAY (f),
2399 XtWindow (f->output_data.x->widget), &text);
2400 XSetWMIconName (FRAME_X_DISPLAY (f), XtWindow (f->output_data.x->widget),
2401 &icon);
2402 #else /* not USE_X_TOOLKIT */
2403 XSetWMName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &text);
2404 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &icon);
2405 #endif /* not USE_X_TOOLKIT */
2406 if (!NILP (f->icon_name)
2407 && icon.value != XSTRING (f->icon_name)->data)
2408 xfree (icon.value);
2409 if (text.value != XSTRING (name)->data)
2410 xfree (text.value);
2412 #else /* not HAVE_X11R4 */
2413 XSetIconName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2414 XSTRING (name)->data);
2415 XStoreName (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2416 XSTRING (name)->data);
2417 #endif /* not HAVE_X11R4 */
2418 UNBLOCK_INPUT;
2422 void
2423 x_set_autoraise (f, arg, oldval)
2424 struct frame *f;
2425 Lisp_Object arg, oldval;
2427 f->auto_raise = !EQ (Qnil, arg);
2430 void
2431 x_set_autolower (f, arg, oldval)
2432 struct frame *f;
2433 Lisp_Object arg, oldval;
2435 f->auto_lower = !EQ (Qnil, arg);
2438 void
2439 x_set_unsplittable (f, arg, oldval)
2440 struct frame *f;
2441 Lisp_Object arg, oldval;
2443 f->no_split = !NILP (arg);
2446 void
2447 x_set_vertical_scroll_bars (f, arg, oldval)
2448 struct frame *f;
2449 Lisp_Object arg, oldval;
2451 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
2452 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
2453 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
2454 || (!NILP (arg) && ! FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
2456 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
2457 = (NILP (arg)
2458 ? vertical_scroll_bar_none
2459 : EQ (Qright, arg)
2460 ? vertical_scroll_bar_right
2461 : vertical_scroll_bar_left);
2463 /* We set this parameter before creating the X window for the
2464 frame, so we can get the geometry right from the start.
2465 However, if the window hasn't been created yet, we shouldn't
2466 call x_set_window_size. */
2467 if (FRAME_X_WINDOW (f))
2468 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2469 do_pending_window_change (0);
2473 void
2474 x_set_scroll_bar_width (f, arg, oldval)
2475 struct frame *f;
2476 Lisp_Object arg, oldval;
2478 int wid = FONT_WIDTH (f->output_data.x->font);
2480 if (NILP (arg))
2482 #ifdef USE_TOOLKIT_SCROLL_BARS
2483 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2484 int width = 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2485 FRAME_SCROLL_BAR_COLS (f) = (width + wid - 1) / wid;
2486 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = width;
2487 #else
2488 /* Make the actual width at least 14 pixels and a multiple of a
2489 character width. */
2490 FRAME_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
2492 /* Use all of that space (aside from required margins) for the
2493 scroll bar. */
2494 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = 0;
2495 #endif
2497 if (FRAME_X_WINDOW (f))
2498 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2499 do_pending_window_change (0);
2501 else if (INTEGERP (arg) && XINT (arg) > 0
2502 && XFASTINT (arg) != FRAME_SCROLL_BAR_PIXEL_WIDTH (f))
2504 if (XFASTINT (arg) <= 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM)
2505 XSETINT (arg, 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM + 1);
2507 FRAME_SCROLL_BAR_PIXEL_WIDTH (f) = XFASTINT (arg);
2508 FRAME_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + wid-1) / wid;
2509 if (FRAME_X_WINDOW (f))
2510 x_set_window_size (f, 0, FRAME_WIDTH (f), FRAME_HEIGHT (f));
2513 change_frame_size (f, 0, FRAME_WIDTH (f), 0, 0, 0);
2514 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
2515 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
2520 /* Subroutines of creating an X frame. */
2522 /* Make sure that Vx_resource_name is set to a reasonable value.
2523 Fix it up, or set it to `emacs' if it is too hopeless. */
2525 static void
2526 validate_x_resource_name ()
2528 int len = 0;
2529 /* Number of valid characters in the resource name. */
2530 int good_count = 0;
2531 /* Number of invalid characters in the resource name. */
2532 int bad_count = 0;
2533 Lisp_Object new;
2534 int i;
2536 if (!STRINGP (Vx_resource_class))
2537 Vx_resource_class = build_string (EMACS_CLASS);
2539 if (STRINGP (Vx_resource_name))
2541 unsigned char *p = XSTRING (Vx_resource_name)->data;
2542 int i;
2544 len = STRING_BYTES (XSTRING (Vx_resource_name));
2546 /* Only letters, digits, - and _ are valid in resource names.
2547 Count the valid characters and count the invalid ones. */
2548 for (i = 0; i < len; i++)
2550 int c = p[i];
2551 if (! ((c >= 'a' && c <= 'z')
2552 || (c >= 'A' && c <= 'Z')
2553 || (c >= '0' && c <= '9')
2554 || c == '-' || c == '_'))
2555 bad_count++;
2556 else
2557 good_count++;
2560 else
2561 /* Not a string => completely invalid. */
2562 bad_count = 5, good_count = 0;
2564 /* If name is valid already, return. */
2565 if (bad_count == 0)
2566 return;
2568 /* If name is entirely invalid, or nearly so, use `emacs'. */
2569 if (good_count == 0
2570 || (good_count == 1 && bad_count > 0))
2572 Vx_resource_name = build_string ("emacs");
2573 return;
2576 /* Name is partly valid. Copy it and replace the invalid characters
2577 with underscores. */
2579 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
2581 for (i = 0; i < len; i++)
2583 int c = XSTRING (new)->data[i];
2584 if (! ((c >= 'a' && c <= 'z')
2585 || (c >= 'A' && c <= 'Z')
2586 || (c >= '0' && c <= '9')
2587 || c == '-' || c == '_'))
2588 XSTRING (new)->data[i] = '_';
2593 extern char *x_get_string_resource ();
2595 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
2596 "Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.\n\
2597 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the\n\
2598 class, where INSTANCE is the name under which Emacs was invoked, or\n\
2599 the name specified by the `-name' or `-rn' command-line arguments.\n\
2601 The optional arguments COMPONENT and SUBCLASS add to the key and the\n\
2602 class, respectively. You must specify both of them or neither.\n\
2603 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'\n\
2604 and the class is `Emacs.CLASS.SUBCLASS'.")
2605 (attribute, class, component, subclass)
2606 Lisp_Object attribute, class, component, subclass;
2608 register char *value;
2609 char *name_key;
2610 char *class_key;
2612 check_x ();
2614 CHECK_STRING (attribute, 0);
2615 CHECK_STRING (class, 0);
2617 if (!NILP (component))
2618 CHECK_STRING (component, 1);
2619 if (!NILP (subclass))
2620 CHECK_STRING (subclass, 2);
2621 if (NILP (component) != NILP (subclass))
2622 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2624 validate_x_resource_name ();
2626 /* Allocate space for the components, the dots which separate them,
2627 and the final '\0'. Make them big enough for the worst case. */
2628 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2629 + (STRINGP (component)
2630 ? STRING_BYTES (XSTRING (component)) : 0)
2631 + STRING_BYTES (XSTRING (attribute))
2632 + 3);
2634 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2635 + STRING_BYTES (XSTRING (class))
2636 + (STRINGP (subclass)
2637 ? STRING_BYTES (XSTRING (subclass)) : 0)
2638 + 3);
2640 /* Start with emacs.FRAMENAME for the name (the specific one)
2641 and with `Emacs' for the class key (the general one). */
2642 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2643 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2645 strcat (class_key, ".");
2646 strcat (class_key, XSTRING (class)->data);
2648 if (!NILP (component))
2650 strcat (class_key, ".");
2651 strcat (class_key, XSTRING (subclass)->data);
2653 strcat (name_key, ".");
2654 strcat (name_key, XSTRING (component)->data);
2657 strcat (name_key, ".");
2658 strcat (name_key, XSTRING (attribute)->data);
2660 value = x_get_string_resource (check_x_display_info (Qnil)->xrdb,
2661 name_key, class_key);
2663 if (value != (char *) 0)
2664 return build_string (value);
2665 else
2666 return Qnil;
2669 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
2671 Lisp_Object
2672 display_x_get_resource (dpyinfo, attribute, class, component, subclass)
2673 struct x_display_info *dpyinfo;
2674 Lisp_Object attribute, class, component, subclass;
2676 register char *value;
2677 char *name_key;
2678 char *class_key;
2680 CHECK_STRING (attribute, 0);
2681 CHECK_STRING (class, 0);
2683 if (!NILP (component))
2684 CHECK_STRING (component, 1);
2685 if (!NILP (subclass))
2686 CHECK_STRING (subclass, 2);
2687 if (NILP (component) != NILP (subclass))
2688 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
2690 validate_x_resource_name ();
2692 /* Allocate space for the components, the dots which separate them,
2693 and the final '\0'. Make them big enough for the worst case. */
2694 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_name))
2695 + (STRINGP (component)
2696 ? STRING_BYTES (XSTRING (component)) : 0)
2697 + STRING_BYTES (XSTRING (attribute))
2698 + 3);
2700 class_key = (char *) alloca (STRING_BYTES (XSTRING (Vx_resource_class))
2701 + STRING_BYTES (XSTRING (class))
2702 + (STRINGP (subclass)
2703 ? STRING_BYTES (XSTRING (subclass)) : 0)
2704 + 3);
2706 /* Start with emacs.FRAMENAME for the name (the specific one)
2707 and with `Emacs' for the class key (the general one). */
2708 strcpy (name_key, XSTRING (Vx_resource_name)->data);
2709 strcpy (class_key, XSTRING (Vx_resource_class)->data);
2711 strcat (class_key, ".");
2712 strcat (class_key, XSTRING (class)->data);
2714 if (!NILP (component))
2716 strcat (class_key, ".");
2717 strcat (class_key, XSTRING (subclass)->data);
2719 strcat (name_key, ".");
2720 strcat (name_key, XSTRING (component)->data);
2723 strcat (name_key, ".");
2724 strcat (name_key, XSTRING (attribute)->data);
2726 value = x_get_string_resource (dpyinfo->xrdb, name_key, class_key);
2728 if (value != (char *) 0)
2729 return build_string (value);
2730 else
2731 return Qnil;
2734 /* Used when C code wants a resource value. */
2736 char *
2737 x_get_resource_string (attribute, class)
2738 char *attribute, *class;
2740 char *name_key;
2741 char *class_key;
2742 struct frame *sf = SELECTED_FRAME ();
2744 /* Allocate space for the components, the dots which separate them,
2745 and the final '\0'. */
2746 name_key = (char *) alloca (STRING_BYTES (XSTRING (Vinvocation_name))
2747 + strlen (attribute) + 2);
2748 class_key = (char *) alloca ((sizeof (EMACS_CLASS) - 1)
2749 + strlen (class) + 2);
2751 sprintf (name_key, "%s.%s",
2752 XSTRING (Vinvocation_name)->data,
2753 attribute);
2754 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
2756 return x_get_string_resource (FRAME_X_DISPLAY_INFO (sf)->xrdb,
2757 name_key, class_key);
2760 /* Types we might convert a resource string into. */
2761 enum resource_types
2763 RES_TYPE_NUMBER,
2764 RES_TYPE_FLOAT,
2765 RES_TYPE_BOOLEAN,
2766 RES_TYPE_STRING,
2767 RES_TYPE_SYMBOL
2770 /* Return the value of parameter PARAM.
2772 First search ALIST, then Vdefault_frame_alist, then the X defaults
2773 database, using ATTRIBUTE as the attribute name and CLASS as its class.
2775 Convert the resource to the type specified by desired_type.
2777 If no default is specified, return Qunbound. If you call
2778 x_get_arg, make sure you deal with Qunbound in a reasonable way,
2779 and don't let it get stored in any Lisp-visible variables! */
2781 static Lisp_Object
2782 x_get_arg (dpyinfo, alist, param, attribute, class, type)
2783 struct x_display_info *dpyinfo;
2784 Lisp_Object alist, param;
2785 char *attribute;
2786 char *class;
2787 enum resource_types type;
2789 register Lisp_Object tem;
2791 tem = Fassq (param, alist);
2792 if (EQ (tem, Qnil))
2793 tem = Fassq (param, Vdefault_frame_alist);
2794 if (EQ (tem, Qnil))
2797 if (attribute)
2799 tem = display_x_get_resource (dpyinfo,
2800 build_string (attribute),
2801 build_string (class),
2802 Qnil, Qnil);
2804 if (NILP (tem))
2805 return Qunbound;
2807 switch (type)
2809 case RES_TYPE_NUMBER:
2810 return make_number (atoi (XSTRING (tem)->data));
2812 case RES_TYPE_FLOAT:
2813 return make_float (atof (XSTRING (tem)->data));
2815 case RES_TYPE_BOOLEAN:
2816 tem = Fdowncase (tem);
2817 if (!strcmp (XSTRING (tem)->data, "on")
2818 || !strcmp (XSTRING (tem)->data, "true"))
2819 return Qt;
2820 else
2821 return Qnil;
2823 case RES_TYPE_STRING:
2824 return tem;
2826 case RES_TYPE_SYMBOL:
2827 /* As a special case, we map the values `true' and `on'
2828 to Qt, and `false' and `off' to Qnil. */
2830 Lisp_Object lower;
2831 lower = Fdowncase (tem);
2832 if (!strcmp (XSTRING (lower)->data, "on")
2833 || !strcmp (XSTRING (lower)->data, "true"))
2834 return Qt;
2835 else if (!strcmp (XSTRING (lower)->data, "off")
2836 || !strcmp (XSTRING (lower)->data, "false"))
2837 return Qnil;
2838 else
2839 return Fintern (tem, Qnil);
2842 default:
2843 abort ();
2846 else
2847 return Qunbound;
2849 return Fcdr (tem);
2852 /* Like x_get_arg, but also record the value in f->param_alist. */
2854 static Lisp_Object
2855 x_get_and_record_arg (f, alist, param, attribute, class, type)
2856 struct frame *f;
2857 Lisp_Object alist, param;
2858 char *attribute;
2859 char *class;
2860 enum resource_types type;
2862 Lisp_Object value;
2864 value = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, param,
2865 attribute, class, type);
2866 if (! NILP (value))
2867 store_frame_param (f, param, value);
2869 return value;
2872 /* Record in frame F the specified or default value according to ALIST
2873 of the parameter named PROP (a Lisp symbol).
2874 If no value is specified for PROP, look for an X default for XPROP
2875 on the frame named NAME.
2876 If that is not found either, use the value DEFLT. */
2878 static Lisp_Object
2879 x_default_parameter (f, alist, prop, deflt, xprop, xclass, type)
2880 struct frame *f;
2881 Lisp_Object alist;
2882 Lisp_Object prop;
2883 Lisp_Object deflt;
2884 char *xprop;
2885 char *xclass;
2886 enum resource_types type;
2888 Lisp_Object tem;
2890 tem = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, prop, xprop, xclass, type);
2891 if (EQ (tem, Qunbound))
2892 tem = deflt;
2893 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2894 return tem;
2898 /* Record in frame F the specified or default value according to ALIST
2899 of the parameter named PROP (a Lisp symbol). If no value is
2900 specified for PROP, look for an X default for XPROP on the frame
2901 named NAME. If that is not found either, use the value DEFLT. */
2903 static Lisp_Object
2904 x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
2905 foreground_p)
2906 struct frame *f;
2907 Lisp_Object alist;
2908 Lisp_Object prop;
2909 char *xprop;
2910 char *xclass;
2911 int foreground_p;
2913 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
2914 Lisp_Object tem;
2916 tem = x_get_arg (dpyinfo, alist, prop, xprop, xclass, RES_TYPE_STRING);
2917 if (EQ (tem, Qunbound))
2919 #ifdef USE_TOOLKIT_SCROLL_BARS
2921 /* See if an X resource for the scroll bar color has been
2922 specified. */
2923 tem = display_x_get_resource (dpyinfo,
2924 build_string (foreground_p
2925 ? "foreground"
2926 : "background"),
2927 build_string (""),
2928 build_string ("verticalScrollBar"),
2929 build_string (""));
2930 if (!STRINGP (tem))
2932 /* If nothing has been specified, scroll bars will use a
2933 toolkit-dependent default. Because these defaults are
2934 difficult to get at without actually creating a scroll
2935 bar, use nil to indicate that no color has been
2936 specified. */
2937 tem = Qnil;
2940 #else /* not USE_TOOLKIT_SCROLL_BARS */
2942 tem = Qnil;
2944 #endif /* not USE_TOOLKIT_SCROLL_BARS */
2947 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
2948 return tem;
2953 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
2954 "Parse an X-style geometry string STRING.\n\
2955 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).\n\
2956 The properties returned may include `top', `left', `height', and `width'.\n\
2957 The value of `left' or `top' may be an integer,\n\
2958 or a list (+ N) meaning N pixels relative to top/left corner,\n\
2959 or a list (- N) meaning -N pixels relative to bottom/right corner.")
2960 (string)
2961 Lisp_Object string;
2963 int geometry, x, y;
2964 unsigned int width, height;
2965 Lisp_Object result;
2967 CHECK_STRING (string, 0);
2969 geometry = XParseGeometry ((char *) XSTRING (string)->data,
2970 &x, &y, &width, &height);
2972 #if 0
2973 if (!!(geometry & XValue) != !!(geometry & YValue))
2974 error ("Must specify both x and y position, or neither");
2975 #endif
2977 result = Qnil;
2978 if (geometry & XValue)
2980 Lisp_Object element;
2982 if (x >= 0 && (geometry & XNegative))
2983 element = Fcons (Qleft, Fcons (Qminus, Fcons (make_number (-x), Qnil)));
2984 else if (x < 0 && ! (geometry & XNegative))
2985 element = Fcons (Qleft, Fcons (Qplus, Fcons (make_number (x), Qnil)));
2986 else
2987 element = Fcons (Qleft, make_number (x));
2988 result = Fcons (element, result);
2991 if (geometry & YValue)
2993 Lisp_Object element;
2995 if (y >= 0 && (geometry & YNegative))
2996 element = Fcons (Qtop, Fcons (Qminus, Fcons (make_number (-y), Qnil)));
2997 else if (y < 0 && ! (geometry & YNegative))
2998 element = Fcons (Qtop, Fcons (Qplus, Fcons (make_number (y), Qnil)));
2999 else
3000 element = Fcons (Qtop, make_number (y));
3001 result = Fcons (element, result);
3004 if (geometry & WidthValue)
3005 result = Fcons (Fcons (Qwidth, make_number (width)), result);
3006 if (geometry & HeightValue)
3007 result = Fcons (Fcons (Qheight, make_number (height)), result);
3009 return result;
3012 /* Calculate the desired size and position of this window,
3013 and return the flags saying which aspects were specified.
3015 This function does not make the coordinates positive. */
3017 #define DEFAULT_ROWS 40
3018 #define DEFAULT_COLS 80
3020 static int
3021 x_figure_window_size (f, parms)
3022 struct frame *f;
3023 Lisp_Object parms;
3025 register Lisp_Object tem0, tem1, tem2;
3026 long window_prompting = 0;
3027 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3029 /* Default values if we fall through.
3030 Actually, if that happens we should get
3031 window manager prompting. */
3032 SET_FRAME_WIDTH (f, DEFAULT_COLS);
3033 f->height = DEFAULT_ROWS;
3034 /* Window managers expect that if program-specified
3035 positions are not (0,0), they're intentional, not defaults. */
3036 f->output_data.x->top_pos = 0;
3037 f->output_data.x->left_pos = 0;
3039 tem0 = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
3040 tem1 = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
3041 tem2 = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
3042 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3044 if (!EQ (tem0, Qunbound))
3046 CHECK_NUMBER (tem0, 0);
3047 f->height = XINT (tem0);
3049 if (!EQ (tem1, Qunbound))
3051 CHECK_NUMBER (tem1, 0);
3052 SET_FRAME_WIDTH (f, XINT (tem1));
3054 if (!NILP (tem2) && !EQ (tem2, Qunbound))
3055 window_prompting |= USSize;
3056 else
3057 window_prompting |= PSize;
3060 f->output_data.x->vertical_scroll_bar_extra
3061 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
3063 : (FRAME_SCROLL_BAR_COLS (f) * FONT_WIDTH (f->output_data.x->font)));
3064 f->output_data.x->flags_areas_extra
3065 = FRAME_FLAGS_AREA_WIDTH (f);
3066 f->output_data.x->pixel_width = CHAR_TO_PIXEL_WIDTH (f, f->width);
3067 f->output_data.x->pixel_height = CHAR_TO_PIXEL_HEIGHT (f, f->height);
3069 tem0 = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
3070 tem1 = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
3071 tem2 = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
3072 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
3074 if (EQ (tem0, Qminus))
3076 f->output_data.x->top_pos = 0;
3077 window_prompting |= YNegative;
3079 else if (CONSP (tem0) && EQ (XCAR (tem0), Qminus)
3080 && CONSP (XCDR (tem0))
3081 && INTEGERP (XCAR (XCDR (tem0))))
3083 f->output_data.x->top_pos = - XINT (XCAR (XCDR (tem0)));
3084 window_prompting |= YNegative;
3086 else if (CONSP (tem0) && EQ (XCAR (tem0), Qplus)
3087 && CONSP (XCDR (tem0))
3088 && INTEGERP (XCAR (XCDR (tem0))))
3090 f->output_data.x->top_pos = XINT (XCAR (XCDR (tem0)));
3092 else if (EQ (tem0, Qunbound))
3093 f->output_data.x->top_pos = 0;
3094 else
3096 CHECK_NUMBER (tem0, 0);
3097 f->output_data.x->top_pos = XINT (tem0);
3098 if (f->output_data.x->top_pos < 0)
3099 window_prompting |= YNegative;
3102 if (EQ (tem1, Qminus))
3104 f->output_data.x->left_pos = 0;
3105 window_prompting |= XNegative;
3107 else if (CONSP (tem1) && EQ (XCAR (tem1), Qminus)
3108 && CONSP (XCDR (tem1))
3109 && INTEGERP (XCAR (XCDR (tem1))))
3111 f->output_data.x->left_pos = - XINT (XCAR (XCDR (tem1)));
3112 window_prompting |= XNegative;
3114 else if (CONSP (tem1) && EQ (XCAR (tem1), Qplus)
3115 && CONSP (XCDR (tem1))
3116 && INTEGERP (XCAR (XCDR (tem1))))
3118 f->output_data.x->left_pos = XINT (XCAR (XCDR (tem1)));
3120 else if (EQ (tem1, Qunbound))
3121 f->output_data.x->left_pos = 0;
3122 else
3124 CHECK_NUMBER (tem1, 0);
3125 f->output_data.x->left_pos = XINT (tem1);
3126 if (f->output_data.x->left_pos < 0)
3127 window_prompting |= XNegative;
3130 if (!NILP (tem2) && ! EQ (tem2, Qunbound))
3131 window_prompting |= USPosition;
3132 else
3133 window_prompting |= PPosition;
3136 return window_prompting;
3139 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
3141 Status
3142 XSetWMProtocols (dpy, w, protocols, count)
3143 Display *dpy;
3144 Window w;
3145 Atom *protocols;
3146 int count;
3148 Atom prop;
3149 prop = XInternAtom (dpy, "WM_PROTOCOLS", False);
3150 if (prop == None) return False;
3151 XChangeProperty (dpy, w, prop, XA_ATOM, 32, PropModeReplace,
3152 (unsigned char *) protocols, count);
3153 return True;
3155 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
3157 #ifdef USE_X_TOOLKIT
3159 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
3160 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
3161 already be present because of the toolkit (Motif adds some of them,
3162 for example, but Xt doesn't). */
3164 static void
3165 hack_wm_protocols (f, widget)
3166 FRAME_PTR f;
3167 Widget widget;
3169 Display *dpy = XtDisplay (widget);
3170 Window w = XtWindow (widget);
3171 int need_delete = 1;
3172 int need_focus = 1;
3173 int need_save = 1;
3175 BLOCK_INPUT;
3177 Atom type, *atoms = 0;
3178 int format = 0;
3179 unsigned long nitems = 0;
3180 unsigned long bytes_after;
3182 if ((XGetWindowProperty (dpy, w,
3183 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3184 (long)0, (long)100, False, XA_ATOM,
3185 &type, &format, &nitems, &bytes_after,
3186 (unsigned char **) &atoms)
3187 == Success)
3188 && format == 32 && type == XA_ATOM)
3189 while (nitems > 0)
3191 nitems--;
3192 if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window)
3193 need_delete = 0;
3194 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus)
3195 need_focus = 0;
3196 else if (atoms[nitems] == FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself)
3197 need_save = 0;
3199 if (atoms) XFree ((char *) atoms);
3202 Atom props [10];
3203 int count = 0;
3204 if (need_delete)
3205 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3206 if (need_focus)
3207 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_take_focus;
3208 if (need_save)
3209 props[count++] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3210 if (count)
3211 XChangeProperty (dpy, w, FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3212 XA_ATOM, 32, PropModeAppend,
3213 (unsigned char *) props, count);
3215 UNBLOCK_INPUT;
3217 #endif
3221 /* Support routines for XIC (X Input Context). */
3223 #ifdef HAVE_X_I18N
3225 static XFontSet xic_create_xfontset P_ ((struct frame *, char *));
3226 static XIMStyle best_xim_style P_ ((XIMStyles *, XIMStyles *));
3229 /* Supported XIM styles, ordered by preferenc. */
3231 static XIMStyle supported_xim_styles[] =
3233 XIMPreeditPosition | XIMStatusArea,
3234 XIMPreeditPosition | XIMStatusNothing,
3235 XIMPreeditPosition | XIMStatusNone,
3236 XIMPreeditNothing | XIMStatusArea,
3237 XIMPreeditNothing | XIMStatusNothing,
3238 XIMPreeditNothing | XIMStatusNone,
3239 XIMPreeditNone | XIMStatusArea,
3240 XIMPreeditNone | XIMStatusNothing,
3241 XIMPreeditNone | XIMStatusNone,
3246 /* Create an X fontset on frame F with base font name
3247 BASE_FONTNAME.. */
3249 static XFontSet
3250 xic_create_xfontset (f, base_fontname)
3251 struct frame *f;
3252 char *base_fontname;
3254 XFontSet xfs;
3255 char **missing_list;
3256 int missing_count;
3257 char *def_string;
3259 xfs = XCreateFontSet (FRAME_X_DISPLAY (f),
3260 base_fontname, &missing_list,
3261 &missing_count, &def_string);
3262 if (missing_list)
3263 XFreeStringList (missing_list);
3265 /* No need to free def_string. */
3266 return xfs;
3270 /* Value is the best input style, given user preferences USER (already
3271 checked to be supported by Emacs), and styles supported by the
3272 input method XIM. */
3274 static XIMStyle
3275 best_xim_style (user, xim)
3276 XIMStyles *user;
3277 XIMStyles *xim;
3279 int i, j;
3281 for (i = 0; i < user->count_styles; ++i)
3282 for (j = 0; j < xim->count_styles; ++j)
3283 if (user->supported_styles[i] == xim->supported_styles[j])
3284 return user->supported_styles[i];
3286 /* Return the default style. */
3287 return XIMPreeditNothing | XIMStatusNothing;
3290 /* Create XIC for frame F. */
3292 static XIMStyle xic_style;
3294 void
3295 create_frame_xic (f)
3296 struct frame *f;
3298 XIM xim;
3299 XIC xic = NULL;
3300 XFontSet xfs = NULL;
3302 if (FRAME_XIC (f))
3303 return;
3305 xim = FRAME_X_XIM (f);
3306 if (xim)
3308 XRectangle s_area;
3309 XPoint spot;
3310 XVaNestedList preedit_attr;
3311 XVaNestedList status_attr;
3312 char *base_fontname;
3313 int fontset;
3315 s_area.x = 0; s_area.y = 0; s_area.width = 1; s_area.height = 1;
3316 spot.x = 0; spot.y = 1;
3317 /* Create X fontset. */
3318 fontset = FRAME_FONTSET (f);
3319 if (fontset < 0)
3320 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3321 else
3323 /* Determine the base fontname from the ASCII font name of
3324 FONTSET. */
3325 char *ascii_font = (char *) XSTRING (fontset_ascii (fontset))->data;
3326 char *p = ascii_font;
3327 int i;
3329 for (i = 0; *p; p++)
3330 if (*p == '-') i++;
3331 if (i != 14)
3332 /* As the font name doesn't conform to XLFD, we can't
3333 modify it to get a suitable base fontname for the
3334 frame. */
3335 base_fontname = "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
3336 else
3338 int len = strlen (ascii_font) + 1;
3339 char *p1 = NULL;
3341 for (i = 0, p = ascii_font; i < 8; p++)
3343 if (*p == '-')
3345 i++;
3346 if (i == 3)
3347 p1 = p + 1;
3350 base_fontname = (char *) alloca (len);
3351 bzero (base_fontname, len);
3352 strcpy (base_fontname, "-*-*-");
3353 bcopy (p1, base_fontname + 5, p - p1);
3354 strcat (base_fontname, "*-*-*-*-*-*-*");
3357 xfs = xic_create_xfontset (f, base_fontname);
3359 /* Determine XIC style. */
3360 if (xic_style == 0)
3362 XIMStyles supported_list;
3363 supported_list.count_styles = (sizeof supported_xim_styles
3364 / sizeof supported_xim_styles[0]);
3365 supported_list.supported_styles = supported_xim_styles;
3366 xic_style = best_xim_style (&supported_list,
3367 FRAME_X_XIM_STYLES (f));
3370 preedit_attr = XVaCreateNestedList (0,
3371 XNFontSet, xfs,
3372 XNForeground,
3373 FRAME_FOREGROUND_PIXEL (f),
3374 XNBackground,
3375 FRAME_BACKGROUND_PIXEL (f),
3376 (xic_style & XIMPreeditPosition
3377 ? XNSpotLocation
3378 : NULL),
3379 &spot,
3380 NULL);
3381 status_attr = XVaCreateNestedList (0,
3382 XNArea,
3383 &s_area,
3384 XNFontSet,
3385 xfs,
3386 XNForeground,
3387 FRAME_FOREGROUND_PIXEL (f),
3388 XNBackground,
3389 FRAME_BACKGROUND_PIXEL (f),
3390 NULL);
3392 xic = XCreateIC (xim,
3393 XNInputStyle, xic_style,
3394 XNClientWindow, FRAME_X_WINDOW(f),
3395 XNFocusWindow, FRAME_X_WINDOW(f),
3396 XNStatusAttributes, status_attr,
3397 XNPreeditAttributes, preedit_attr,
3398 NULL);
3399 XFree (preedit_attr);
3400 XFree (status_attr);
3403 FRAME_XIC (f) = xic;
3404 FRAME_XIC_STYLE (f) = xic_style;
3405 FRAME_XIC_FONTSET (f) = xfs;
3409 /* Destroy XIC and free XIC fontset of frame F, if any. */
3411 void
3412 free_frame_xic (f)
3413 struct frame *f;
3415 if (FRAME_XIC (f) == NULL)
3416 return;
3418 XDestroyIC (FRAME_XIC (f));
3419 if (FRAME_XIC_FONTSET (f))
3420 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3422 FRAME_XIC (f) = NULL;
3423 FRAME_XIC_FONTSET (f) = NULL;
3427 /* Place preedit area for XIC of window W's frame to specified
3428 pixel position X/Y. X and Y are relative to window W. */
3430 void
3431 xic_set_preeditarea (w, x, y)
3432 struct window *w;
3433 int x, y;
3435 struct frame *f = XFRAME (w->frame);
3436 XVaNestedList attr;
3437 XPoint spot;
3439 spot.x = WINDOW_TO_FRAME_PIXEL_X (w, x);
3440 spot.y = WINDOW_TO_FRAME_PIXEL_Y (w, y) + FONT_BASE (FRAME_FONT (f));
3441 attr = XVaCreateNestedList (0, XNSpotLocation, &spot, NULL);
3442 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3443 XFree (attr);
3447 /* Place status area for XIC in bottom right corner of frame F.. */
3449 void
3450 xic_set_statusarea (f)
3451 struct frame *f;
3453 XIC xic = FRAME_XIC (f);
3454 XVaNestedList attr;
3455 XRectangle area;
3456 XRectangle *needed;
3458 /* Negotiate geometry of status area. If input method has existing
3459 status area, use its current size. */
3460 area.x = area.y = area.width = area.height = 0;
3461 attr = XVaCreateNestedList (0, XNAreaNeeded, &area, NULL);
3462 XSetICValues (xic, XNStatusAttributes, attr, NULL);
3463 XFree (attr);
3465 attr = XVaCreateNestedList (0, XNAreaNeeded, &needed, NULL);
3466 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3467 XFree (attr);
3469 if (needed->width == 0) /* Use XNArea instead of XNAreaNeeded */
3471 attr = XVaCreateNestedList (0, XNArea, &needed, NULL);
3472 XGetICValues (xic, XNStatusAttributes, attr, NULL);
3473 XFree (attr);
3476 area.width = needed->width;
3477 area.height = needed->height;
3478 area.x = PIXEL_WIDTH (f) - area.width - FRAME_INTERNAL_BORDER_WIDTH (f);
3479 area.y = (PIXEL_HEIGHT (f) - area.height
3480 - FRAME_MENUBAR_HEIGHT (f) - FRAME_INTERNAL_BORDER_WIDTH (f));
3481 XFree (needed);
3483 attr = XVaCreateNestedList (0, XNArea, &area, NULL);
3484 XSetICValues(xic, XNStatusAttributes, attr, NULL);
3485 XFree (attr);
3489 /* Set X fontset for XIC of frame F, using base font name
3490 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
3492 void
3493 xic_set_xfontset (f, base_fontname)
3494 struct frame *f;
3495 char *base_fontname;
3497 XVaNestedList attr;
3498 XFontSet xfs;
3500 xfs = xic_create_xfontset (f, base_fontname);
3502 attr = XVaCreateNestedList (0, XNFontSet, xfs, NULL);
3503 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
3504 XSetICValues (FRAME_XIC (f), XNPreeditAttributes, attr, NULL);
3505 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
3506 XSetICValues (FRAME_XIC (f), XNStatusAttributes, attr, NULL);
3507 XFree (attr);
3509 if (FRAME_XIC_FONTSET (f))
3510 XFreeFontSet (FRAME_X_DISPLAY (f), FRAME_XIC_FONTSET (f));
3511 FRAME_XIC_FONTSET (f) = xfs;
3514 #endif /* HAVE_X_I18N */
3518 #ifdef USE_X_TOOLKIT
3520 /* Create and set up the X widget for frame F. */
3522 static void
3523 x_window (f, window_prompting, minibuffer_only)
3524 struct frame *f;
3525 long window_prompting;
3526 int minibuffer_only;
3528 XClassHint class_hints;
3529 XSetWindowAttributes attributes;
3530 unsigned long attribute_mask;
3531 Widget shell_widget;
3532 Widget pane_widget;
3533 Widget frame_widget;
3534 Arg al [25];
3535 int ac;
3537 BLOCK_INPUT;
3539 /* Use the resource name as the top-level widget name
3540 for looking up resources. Make a non-Lisp copy
3541 for the window manager, so GC relocation won't bother it.
3543 Elsewhere we specify the window name for the window manager. */
3546 char *str = (char *) XSTRING (Vx_resource_name)->data;
3547 f->namebuf = (char *) xmalloc (strlen (str) + 1);
3548 strcpy (f->namebuf, str);
3551 ac = 0;
3552 XtSetArg (al[ac], XtNallowShellResize, 1); ac++;
3553 XtSetArg (al[ac], XtNinput, 1); ac++;
3554 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3555 XtSetArg (al[ac], XtNborderWidth, f->output_data.x->border_width); ac++;
3556 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3557 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3558 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3559 shell_widget = XtAppCreateShell (f->namebuf, EMACS_CLASS,
3560 applicationShellWidgetClass,
3561 FRAME_X_DISPLAY (f), al, ac);
3563 f->output_data.x->widget = shell_widget;
3564 /* maybe_set_screen_title_format (shell_widget); */
3566 pane_widget = lw_create_widget ("main", "pane", widget_id_tick++,
3567 (widget_value *) NULL,
3568 shell_widget, False,
3569 (lw_callback) NULL,
3570 (lw_callback) NULL,
3571 (lw_callback) NULL,
3572 (lw_callback) NULL);
3574 ac = 0;
3575 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3576 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3577 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3578 XtSetValues (pane_widget, al, ac);
3579 f->output_data.x->column_widget = pane_widget;
3581 /* mappedWhenManaged to false tells to the paned window to not map/unmap
3582 the emacs screen when changing menubar. This reduces flickering. */
3584 ac = 0;
3585 XtSetArg (al[ac], XtNmappedWhenManaged, 0); ac++;
3586 XtSetArg (al[ac], XtNshowGrip, 0); ac++;
3587 XtSetArg (al[ac], XtNallowResize, 1); ac++;
3588 XtSetArg (al[ac], XtNresizeToPreferred, 1); ac++;
3589 XtSetArg (al[ac], XtNemacsFrame, f); ac++;
3590 XtSetArg (al[ac], XtNvisual, FRAME_X_VISUAL (f)); ac++;
3591 XtSetArg (al[ac], XtNdepth, FRAME_X_DISPLAY_INFO (f)->n_planes); ac++;
3592 XtSetArg (al[ac], XtNcolormap, FRAME_X_COLORMAP (f)); ac++;
3593 frame_widget = XtCreateWidget (f->namebuf, emacsFrameClass, pane_widget,
3594 al, ac);
3596 f->output_data.x->edit_widget = frame_widget;
3598 XtManageChild (frame_widget);
3600 /* Do some needed geometry management. */
3602 int len;
3603 char *tem, shell_position[32];
3604 Arg al[2];
3605 int ac = 0;
3606 int extra_borders = 0;
3607 int menubar_size
3608 = (f->output_data.x->menubar_widget
3609 ? (f->output_data.x->menubar_widget->core.height
3610 + f->output_data.x->menubar_widget->core.border_width)
3611 : 0);
3613 #if 0 /* Experimentally, we now get the right results
3614 for -geometry -0-0 without this. 24 Aug 96, rms. */
3615 if (FRAME_EXTERNAL_MENU_BAR (f))
3617 Dimension ibw = 0;
3618 XtVaGetValues (pane_widget, XtNinternalBorderWidth, &ibw, NULL);
3619 menubar_size += ibw;
3621 #endif
3623 f->output_data.x->menubar_height = menubar_size;
3625 #ifndef USE_LUCID
3626 /* Motif seems to need this amount added to the sizes
3627 specified for the shell widget. The Athena/Lucid widgets don't.
3628 Both conclusions reached experimentally. -- rms. */
3629 XtVaGetValues (f->output_data.x->edit_widget, XtNinternalBorderWidth,
3630 &extra_borders, NULL);
3631 extra_borders *= 2;
3632 #endif
3634 /* Convert our geometry parameters into a geometry string
3635 and specify it.
3636 Note that we do not specify here whether the position
3637 is a user-specified or program-specified one.
3638 We pass that information later, in x_wm_set_size_hints. */
3640 int left = f->output_data.x->left_pos;
3641 int xneg = window_prompting & XNegative;
3642 int top = f->output_data.x->top_pos;
3643 int yneg = window_prompting & YNegative;
3644 if (xneg)
3645 left = -left;
3646 if (yneg)
3647 top = -top;
3649 if (window_prompting & USPosition)
3650 sprintf (shell_position, "=%dx%d%c%d%c%d",
3651 PIXEL_WIDTH (f) + extra_borders,
3652 PIXEL_HEIGHT (f) + menubar_size + extra_borders,
3653 (xneg ? '-' : '+'), left,
3654 (yneg ? '-' : '+'), top);
3655 else
3656 sprintf (shell_position, "=%dx%d",
3657 PIXEL_WIDTH (f) + extra_borders,
3658 PIXEL_HEIGHT (f) + menubar_size + extra_borders);
3661 len = strlen (shell_position) + 1;
3662 /* We don't free this because we don't know whether
3663 it is safe to free it while the frame exists.
3664 It isn't worth the trouble of arranging to free it
3665 when the frame is deleted. */
3666 tem = (char *) xmalloc (len);
3667 strncpy (tem, shell_position, len);
3668 XtSetArg (al[ac], XtNgeometry, tem); ac++;
3669 XtSetValues (shell_widget, al, ac);
3672 XtManageChild (pane_widget);
3673 XtRealizeWidget (shell_widget);
3675 FRAME_X_WINDOW (f) = XtWindow (frame_widget);
3677 validate_x_resource_name ();
3679 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3680 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3681 XSetClassHint (FRAME_X_DISPLAY (f), XtWindow (shell_widget), &class_hints);
3683 #ifdef HAVE_X_I18N
3684 FRAME_XIC (f) = NULL;
3685 #ifdef USE_XIM
3686 create_frame_xic (f);
3687 #endif
3688 #endif
3690 f->output_data.x->wm_hints.input = True;
3691 f->output_data.x->wm_hints.flags |= InputHint;
3692 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3693 &f->output_data.x->wm_hints);
3695 hack_wm_protocols (f, shell_widget);
3697 #ifdef HACK_EDITRES
3698 XtAddEventHandler (shell_widget, 0, True, _XEditResCheckMessages, 0);
3699 #endif
3701 /* Do a stupid property change to force the server to generate a
3702 PropertyNotify event so that the event_stream server timestamp will
3703 be initialized to something relevant to the time we created the window.
3705 XChangeProperty (XtDisplay (frame_widget), XtWindow (frame_widget),
3706 FRAME_X_DISPLAY_INFO (f)->Xatom_wm_protocols,
3707 XA_ATOM, 32, PropModeAppend,
3708 (unsigned char*) NULL, 0);
3710 /* Make all the standard events reach the Emacs frame. */
3711 attributes.event_mask = STANDARD_EVENT_SET;
3713 #ifdef HAVE_X_I18N
3714 if (FRAME_XIC (f))
3716 /* XIM server might require some X events. */
3717 unsigned long fevent = NoEventMask;
3718 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3719 attributes.event_mask |= fevent;
3721 #endif /* HAVE_X_I18N */
3723 attribute_mask = CWEventMask;
3724 XChangeWindowAttributes (XtDisplay (shell_widget), XtWindow (shell_widget),
3725 attribute_mask, &attributes);
3727 XtMapWidget (frame_widget);
3729 /* x_set_name normally ignores requests to set the name if the
3730 requested name is the same as the current name. This is the one
3731 place where that assumption isn't correct; f->name is set, but
3732 the X server hasn't been told. */
3734 Lisp_Object name;
3735 int explicit = f->explicit_name;
3737 f->explicit_name = 0;
3738 name = f->name;
3739 f->name = Qnil;
3740 x_set_name (f, name, explicit);
3743 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3744 f->output_data.x->text_cursor);
3746 UNBLOCK_INPUT;
3748 /* This is a no-op, except under Motif. Make sure main areas are
3749 set to something reasonable, in case we get an error later. */
3750 lw_set_main_areas (pane_widget, 0, frame_widget);
3753 #else /* not USE_X_TOOLKIT */
3755 /* Create and set up the X window for frame F. */
3757 void
3758 x_window (f)
3759 struct frame *f;
3762 XClassHint class_hints;
3763 XSetWindowAttributes attributes;
3764 unsigned long attribute_mask;
3766 attributes.background_pixel = f->output_data.x->background_pixel;
3767 attributes.border_pixel = f->output_data.x->border_pixel;
3768 attributes.bit_gravity = StaticGravity;
3769 attributes.backing_store = NotUseful;
3770 attributes.save_under = True;
3771 attributes.event_mask = STANDARD_EVENT_SET;
3772 attributes.colormap = FRAME_X_COLORMAP (f);
3773 attribute_mask = (CWBackPixel | CWBorderPixel | CWBitGravity | CWEventMask
3774 | CWColormap);
3776 BLOCK_INPUT;
3777 FRAME_X_WINDOW (f)
3778 = XCreateWindow (FRAME_X_DISPLAY (f),
3779 f->output_data.x->parent_desc,
3780 f->output_data.x->left_pos,
3781 f->output_data.x->top_pos,
3782 PIXEL_WIDTH (f), PIXEL_HEIGHT (f),
3783 f->output_data.x->border_width,
3784 CopyFromParent, /* depth */
3785 InputOutput, /* class */
3786 FRAME_X_VISUAL (f),
3787 attribute_mask, &attributes);
3789 #ifdef HAVE_X_I18N
3790 #ifdef USE_XIM
3791 create_frame_xic (f);
3792 if (FRAME_XIC (f))
3794 /* XIM server might require some X events. */
3795 unsigned long fevent = NoEventMask;
3796 XGetICValues(FRAME_XIC (f), XNFilterEvents, &fevent, NULL);
3797 attributes.event_mask |= fevent;
3798 attribute_mask = CWEventMask;
3799 XChangeWindowAttributes (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3800 attribute_mask, &attributes);
3802 #endif
3803 #endif /* HAVE_X_I18N */
3805 validate_x_resource_name ();
3807 class_hints.res_name = (char *) XSTRING (Vx_resource_name)->data;
3808 class_hints.res_class = (char *) XSTRING (Vx_resource_class)->data;
3809 XSetClassHint (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), &class_hints);
3811 /* The menubar is part of the ordinary display;
3812 it does not count in addition to the height of the window. */
3813 f->output_data.x->menubar_height = 0;
3815 /* This indicates that we use the "Passive Input" input model.
3816 Unless we do this, we don't get the Focus{In,Out} events that we
3817 need to draw the cursor correctly. Accursed bureaucrats.
3818 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
3820 f->output_data.x->wm_hints.input = True;
3821 f->output_data.x->wm_hints.flags |= InputHint;
3822 XSetWMHints (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3823 &f->output_data.x->wm_hints);
3824 f->output_data.x->wm_hints.icon_pixmap = None;
3826 /* Request "save yourself" and "delete window" commands from wm. */
3828 Atom protocols[2];
3829 protocols[0] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_delete_window;
3830 protocols[1] = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_save_yourself;
3831 XSetWMProtocols (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), protocols, 2);
3834 /* x_set_name normally ignores requests to set the name if the
3835 requested name is the same as the current name. This is the one
3836 place where that assumption isn't correct; f->name is set, but
3837 the X server hasn't been told. */
3839 Lisp_Object name;
3840 int explicit = f->explicit_name;
3842 f->explicit_name = 0;
3843 name = f->name;
3844 f->name = Qnil;
3845 x_set_name (f, name, explicit);
3848 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3849 f->output_data.x->text_cursor);
3851 UNBLOCK_INPUT;
3853 if (FRAME_X_WINDOW (f) == 0)
3854 error ("Unable to create window");
3857 #endif /* not USE_X_TOOLKIT */
3859 /* Handle the icon stuff for this window. Perhaps later we might
3860 want an x_set_icon_position which can be called interactively as
3861 well. */
3863 static void
3864 x_icon (f, parms)
3865 struct frame *f;
3866 Lisp_Object parms;
3868 Lisp_Object icon_x, icon_y;
3869 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
3871 /* Set the position of the icon. Note that twm groups all
3872 icons in an icon window. */
3873 icon_x = x_get_and_record_arg (f, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
3874 icon_y = x_get_and_record_arg (f, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
3875 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
3877 CHECK_NUMBER (icon_x, 0);
3878 CHECK_NUMBER (icon_y, 0);
3880 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
3881 error ("Both left and top icon corners of icon must be specified");
3883 BLOCK_INPUT;
3885 if (! EQ (icon_x, Qunbound))
3886 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
3888 /* Start up iconic or window? */
3889 x_wm_set_window_state
3890 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL),
3891 Qicon)
3892 ? IconicState
3893 : NormalState));
3895 x_text_icon (f, (char *) XSTRING ((!NILP (f->icon_name)
3896 ? f->icon_name
3897 : f->name))->data);
3899 UNBLOCK_INPUT;
3902 /* Make the GCs needed for this window, setting the
3903 background, border and mouse colors; also create the
3904 mouse cursor and the gray border tile. */
3906 static char cursor_bits[] =
3908 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3909 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3910 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3911 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
3914 static void
3915 x_make_gc (f)
3916 struct frame *f;
3918 XGCValues gc_values;
3920 BLOCK_INPUT;
3922 /* Create the GCs of this frame.
3923 Note that many default values are used. */
3925 /* Normal video */
3926 gc_values.font = f->output_data.x->font->fid;
3927 gc_values.foreground = f->output_data.x->foreground_pixel;
3928 gc_values.background = f->output_data.x->background_pixel;
3929 gc_values.line_width = 0; /* Means 1 using fast algorithm. */
3930 f->output_data.x->normal_gc
3931 = XCreateGC (FRAME_X_DISPLAY (f),
3932 FRAME_X_WINDOW (f),
3933 GCLineWidth | GCFont | GCForeground | GCBackground,
3934 &gc_values);
3936 /* Reverse video style. */
3937 gc_values.foreground = f->output_data.x->background_pixel;
3938 gc_values.background = f->output_data.x->foreground_pixel;
3939 f->output_data.x->reverse_gc
3940 = XCreateGC (FRAME_X_DISPLAY (f),
3941 FRAME_X_WINDOW (f),
3942 GCFont | GCForeground | GCBackground | GCLineWidth,
3943 &gc_values);
3945 /* Cursor has cursor-color background, background-color foreground. */
3946 gc_values.foreground = f->output_data.x->background_pixel;
3947 gc_values.background = f->output_data.x->cursor_pixel;
3948 gc_values.fill_style = FillOpaqueStippled;
3949 gc_values.stipple
3950 = XCreateBitmapFromData (FRAME_X_DISPLAY (f),
3951 FRAME_X_DISPLAY_INFO (f)->root_window,
3952 cursor_bits, 16, 16);
3953 f->output_data.x->cursor_gc
3954 = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3955 (GCFont | GCForeground | GCBackground
3956 | GCFillStyle /* | GCStipple */ | GCLineWidth),
3957 &gc_values);
3959 /* Reliefs. */
3960 f->output_data.x->white_relief.gc = 0;
3961 f->output_data.x->black_relief.gc = 0;
3963 /* Create the gray border tile used when the pointer is not in
3964 the frame. Since this depends on the frame's pixel values,
3965 this must be done on a per-frame basis. */
3966 f->output_data.x->border_tile
3967 = (XCreatePixmapFromBitmapData
3968 (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
3969 gray_bits, gray_width, gray_height,
3970 f->output_data.x->foreground_pixel,
3971 f->output_data.x->background_pixel,
3972 DefaultDepth (FRAME_X_DISPLAY (f),
3973 XScreenNumberOfScreen (FRAME_X_SCREEN (f)))));
3975 UNBLOCK_INPUT;
3979 /* Free what was was allocated in x_make_gc. */
3981 void
3982 x_free_gcs (f)
3983 struct frame *f;
3985 Display *dpy = FRAME_X_DISPLAY (f);
3987 BLOCK_INPUT;
3989 if (f->output_data.x->normal_gc)
3991 XFreeGC (dpy, f->output_data.x->normal_gc);
3992 f->output_data.x->normal_gc = 0;
3995 if (f->output_data.x->reverse_gc)
3997 XFreeGC (dpy, f->output_data.x->reverse_gc);
3998 f->output_data.x->reverse_gc = 0;
4001 if (f->output_data.x->cursor_gc)
4003 XFreeGC (dpy, f->output_data.x->cursor_gc);
4004 f->output_data.x->cursor_gc = 0;
4007 if (f->output_data.x->border_tile)
4009 XFreePixmap (dpy, f->output_data.x->border_tile);
4010 f->output_data.x->border_tile = 0;
4013 UNBLOCK_INPUT;
4017 /* Handler for signals raised during x_create_frame and
4018 x_create_top_frame. FRAME is the frame which is partially
4019 constructed. */
4021 static Lisp_Object
4022 unwind_create_frame (frame)
4023 Lisp_Object frame;
4025 struct frame *f = XFRAME (frame);
4027 /* If frame is ``official'', nothing to do. */
4028 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
4030 #if GLYPH_DEBUG
4031 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4032 #endif
4034 x_free_frame_resources (f);
4036 /* Check that reference counts are indeed correct. */
4037 xassert (dpyinfo->reference_count == dpyinfo_refcount);
4038 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
4039 return Qt;
4042 return Qnil;
4046 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4047 1, 1, 0,
4048 "Make a new X window, which is called a \"frame\" in Emacs terms.\n\
4049 Returns an Emacs frame object.\n\
4050 ALIST is an alist of frame parameters.\n\
4051 If the parameters specify that the frame should not have a minibuffer,\n\
4052 and do not specify a specific minibuffer window to use,\n\
4053 then `default-minibuffer-frame' must be a frame whose minibuffer can\n\
4054 be shared by the new frame.\n\
4056 This function is an internal primitive--use `make-frame' instead.")
4057 (parms)
4058 Lisp_Object parms;
4060 struct frame *f;
4061 Lisp_Object frame, tem;
4062 Lisp_Object name;
4063 int minibuffer_only = 0;
4064 long window_prompting = 0;
4065 int width, height;
4066 int count = BINDING_STACK_SIZE ();
4067 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4068 Lisp_Object display;
4069 struct x_display_info *dpyinfo = NULL;
4070 Lisp_Object parent;
4071 struct kboard *kb;
4073 check_x ();
4075 /* Use this general default value to start with
4076 until we know if this frame has a specified name. */
4077 Vx_resource_name = Vinvocation_name;
4079 display = x_get_arg (dpyinfo, parms, Qdisplay, 0, 0, RES_TYPE_STRING);
4080 if (EQ (display, Qunbound))
4081 display = Qnil;
4082 dpyinfo = check_x_display_info (display);
4083 #ifdef MULTI_KBOARD
4084 kb = dpyinfo->kboard;
4085 #else
4086 kb = &the_only_kboard;
4087 #endif
4089 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
4090 if (!STRINGP (name)
4091 && ! EQ (name, Qunbound)
4092 && ! NILP (name))
4093 error ("Invalid frame name--not a string or nil");
4095 if (STRINGP (name))
4096 Vx_resource_name = name;
4098 /* See if parent window is specified. */
4099 parent = x_get_arg (dpyinfo, parms, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4100 if (EQ (parent, Qunbound))
4101 parent = Qnil;
4102 if (! NILP (parent))
4103 CHECK_NUMBER (parent, 0);
4105 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4106 /* No need to protect DISPLAY because that's not used after passing
4107 it to make_frame_without_minibuffer. */
4108 frame = Qnil;
4109 GCPRO4 (parms, parent, name, frame);
4110 tem = x_get_arg (dpyinfo, parms, Qminibuffer, "minibuffer", "Minibuffer",
4111 RES_TYPE_SYMBOL);
4112 if (EQ (tem, Qnone) || NILP (tem))
4113 f = make_frame_without_minibuffer (Qnil, kb, display);
4114 else if (EQ (tem, Qonly))
4116 f = make_minibuffer_frame ();
4117 minibuffer_only = 1;
4119 else if (WINDOWP (tem))
4120 f = make_frame_without_minibuffer (tem, kb, display);
4121 else
4122 f = make_frame (1);
4124 XSETFRAME (frame, f);
4126 /* Note that X Windows does support scroll bars. */
4127 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
4129 f->output_method = output_x_window;
4130 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
4131 bzero (f->output_data.x, sizeof (struct x_output));
4132 f->output_data.x->icon_bitmap = -1;
4133 f->output_data.x->fontset = -1;
4134 f->output_data.x->scroll_bar_foreground_pixel = -1;
4135 f->output_data.x->scroll_bar_background_pixel = -1;
4136 record_unwind_protect (unwind_create_frame, frame);
4138 f->icon_name
4139 = x_get_arg (dpyinfo, parms, Qicon_name, "iconName", "Title",
4140 RES_TYPE_STRING);
4141 if (! STRINGP (f->icon_name))
4142 f->icon_name = Qnil;
4144 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
4145 #if GLYPH_DEBUG
4146 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
4147 dpyinfo_refcount = dpyinfo->reference_count;
4148 #endif /* GLYPH_DEBUG */
4149 #ifdef MULTI_KBOARD
4150 FRAME_KBOARD (f) = kb;
4151 #endif
4153 /* These colors will be set anyway later, but it's important
4154 to get the color reference counts right, so initialize them! */
4156 Lisp_Object black;
4157 struct gcpro gcpro1;
4159 black = build_string ("black");
4160 GCPRO1 (black);
4161 f->output_data.x->foreground_pixel
4162 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4163 f->output_data.x->background_pixel
4164 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4165 f->output_data.x->cursor_pixel
4166 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4167 f->output_data.x->cursor_foreground_pixel
4168 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4169 f->output_data.x->border_pixel
4170 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4171 f->output_data.x->mouse_pixel
4172 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
4173 UNGCPRO;
4176 /* Specify the parent under which to make this X window. */
4178 if (!NILP (parent))
4180 f->output_data.x->parent_desc = (Window) XFASTINT (parent);
4181 f->output_data.x->explicit_parent = 1;
4183 else
4185 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4186 f->output_data.x->explicit_parent = 0;
4189 /* Set the name; the functions to which we pass f expect the name to
4190 be set. */
4191 if (EQ (name, Qunbound) || NILP (name))
4193 f->name = build_string (dpyinfo->x_id_name);
4194 f->explicit_name = 0;
4196 else
4198 f->name = name;
4199 f->explicit_name = 1;
4200 /* use the frame's title when getting resources for this frame. */
4201 specbind (Qx_resource_name, name);
4204 /* Extract the window parameters from the supplied values
4205 that are needed to determine window geometry. */
4207 Lisp_Object font;
4209 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4211 BLOCK_INPUT;
4212 /* First, try whatever font the caller has specified. */
4213 if (STRINGP (font))
4215 tem = Fquery_fontset (font, Qnil);
4216 if (STRINGP (tem))
4217 font = x_new_fontset (f, XSTRING (tem)->data);
4218 else
4219 font = x_new_font (f, XSTRING (font)->data);
4222 /* Try out a font which we hope has bold and italic variations. */
4223 if (!STRINGP (font))
4224 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
4225 if (!STRINGP (font))
4226 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4227 if (! STRINGP (font))
4228 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
4229 if (! STRINGP (font))
4230 /* This was formerly the first thing tried, but it finds too many fonts
4231 and takes too long. */
4232 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
4233 /* If those didn't work, look for something which will at least work. */
4234 if (! STRINGP (font))
4235 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
4236 UNBLOCK_INPUT;
4237 if (! STRINGP (font))
4238 font = build_string ("fixed");
4240 x_default_parameter (f, parms, Qfont, font,
4241 "font", "Font", RES_TYPE_STRING);
4244 #ifdef USE_LUCID
4245 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
4246 whereby it fails to get any font. */
4247 xlwmenu_default_font = f->output_data.x->font;
4248 #endif
4250 x_default_parameter (f, parms, Qborder_width, make_number (2),
4251 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4253 /* This defaults to 2 in order to match xterm. We recognize either
4254 internalBorderWidth or internalBorder (which is what xterm calls
4255 it). */
4256 if (NILP (Fassq (Qinternal_border_width, parms)))
4258 Lisp_Object value;
4260 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
4261 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
4262 if (! EQ (value, Qunbound))
4263 parms = Fcons (Fcons (Qinternal_border_width, value),
4264 parms);
4266 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
4267 "internalBorderWidth", "internalBorderWidth",
4268 RES_TYPE_NUMBER);
4269 x_default_parameter (f, parms, Qvertical_scroll_bars, Qleft,
4270 "verticalScrollBars", "ScrollBars",
4271 RES_TYPE_SYMBOL);
4273 /* Also do the stuff which must be set before the window exists. */
4274 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
4275 "foreground", "Foreground", RES_TYPE_STRING);
4276 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
4277 "background", "Background", RES_TYPE_STRING);
4278 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
4279 "pointerColor", "Foreground", RES_TYPE_STRING);
4280 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
4281 "cursorColor", "Foreground", RES_TYPE_STRING);
4282 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
4283 "borderColor", "BorderColor", RES_TYPE_STRING);
4284 x_default_parameter (f, parms, Qscreen_gamma, Qnil,
4285 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4286 x_default_parameter (f, parms, Qline_spacing, Qnil,
4287 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4289 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_foreground,
4290 "scrollBarForeground",
4291 "ScrollBarForeground", 1);
4292 x_default_scroll_bar_color_parameter (f, parms, Qscroll_bar_background,
4293 "scrollBarBackground",
4294 "ScrollBarBackground", 0);
4296 /* Init faces before x_default_parameter is called for scroll-bar
4297 parameters because that function calls x_set_scroll_bar_width,
4298 which calls change_frame_size, which calls Fset_window_buffer,
4299 which runs hooks, which call Fvertical_motion. At the end, we
4300 end up in init_iterator with a null face cache, which should not
4301 happen. */
4302 init_frame_faces (f);
4304 x_default_parameter (f, parms, Qmenu_bar_lines, make_number (1),
4305 "menuBar", "MenuBar", RES_TYPE_NUMBER);
4306 x_default_parameter (f, parms, Qtool_bar_lines, make_number (1),
4307 "toolBar", "ToolBar", RES_TYPE_NUMBER);
4308 x_default_parameter (f, parms, Qbuffer_predicate, Qnil,
4309 "bufferPredicate", "BufferPredicate",
4310 RES_TYPE_SYMBOL);
4311 x_default_parameter (f, parms, Qtitle, Qnil,
4312 "title", "Title", RES_TYPE_STRING);
4314 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
4316 /* Add the tool-bar height to the initial frame height so that the
4317 user gets a text display area of the size he specified with -g or
4318 via .Xdefaults. Later changes of the tool-bar height don't
4319 change the frame size. This is done so that users can create
4320 tall Emacs frames without having to guess how tall the tool-bar
4321 will get. */
4322 if (FRAME_TOOL_BAR_LINES (f))
4324 int margin, relief, bar_height;
4326 relief = (tool_bar_button_relief > 0
4327 ? tool_bar_button_relief
4328 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
4330 if (INTEGERP (Vtool_bar_button_margin)
4331 && XINT (Vtool_bar_button_margin) > 0)
4332 margin = XFASTINT (Vtool_bar_button_margin);
4333 else if (CONSP (Vtool_bar_button_margin)
4334 && INTEGERP (XCDR (Vtool_bar_button_margin))
4335 && XINT (XCDR (Vtool_bar_button_margin)) > 0)
4336 margin = XFASTINT (XCDR (Vtool_bar_button_margin));
4337 else
4338 margin = 0;
4340 bar_height = DEFAULT_TOOL_BAR_IMAGE_HEIGHT + 2 * margin + 2 * relief;
4341 f->height += (bar_height + CANON_Y_UNIT (f) - 1) / CANON_Y_UNIT (f);
4344 /* Compute the size of the X window. */
4345 window_prompting = x_figure_window_size (f, parms);
4347 if (window_prompting & XNegative)
4349 if (window_prompting & YNegative)
4350 f->output_data.x->win_gravity = SouthEastGravity;
4351 else
4352 f->output_data.x->win_gravity = NorthEastGravity;
4354 else
4356 if (window_prompting & YNegative)
4357 f->output_data.x->win_gravity = SouthWestGravity;
4358 else
4359 f->output_data.x->win_gravity = NorthWestGravity;
4362 f->output_data.x->size_hint_flags = window_prompting;
4364 tem = x_get_arg (dpyinfo, parms, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4365 f->no_split = minibuffer_only || EQ (tem, Qt);
4367 /* Create the X widget or window. */
4368 #ifdef USE_X_TOOLKIT
4369 x_window (f, window_prompting, minibuffer_only);
4370 #else
4371 x_window (f);
4372 #endif
4374 x_icon (f, parms);
4375 x_make_gc (f);
4377 /* Now consider the frame official. */
4378 FRAME_X_DISPLAY_INFO (f)->reference_count++;
4379 Vframe_list = Fcons (frame, Vframe_list);
4381 /* We need to do this after creating the X window, so that the
4382 icon-creation functions can say whose icon they're describing. */
4383 x_default_parameter (f, parms, Qicon_type, Qnil,
4384 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4386 x_default_parameter (f, parms, Qauto_raise, Qnil,
4387 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4388 x_default_parameter (f, parms, Qauto_lower, Qnil,
4389 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4390 x_default_parameter (f, parms, Qcursor_type, Qbox,
4391 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4392 x_default_parameter (f, parms, Qscroll_bar_width, Qnil,
4393 "scrollBarWidth", "ScrollBarWidth",
4394 RES_TYPE_NUMBER);
4396 /* Dimensions, especially f->height, must be done via change_frame_size.
4397 Change will not be effected unless different from the current
4398 f->height. */
4399 width = f->width;
4400 height = f->height;
4402 f->height = 0;
4403 SET_FRAME_WIDTH (f, 0);
4404 change_frame_size (f, height, width, 1, 0, 0);
4406 /* Set up faces after all frame parameters are known. This call
4407 also merges in face attributes specified for new frames. If we
4408 don't do this, the `menu' face for instance won't have the right
4409 colors, and the menu bar won't appear in the specified colors for
4410 new frames. */
4411 call1 (Qface_set_after_frame_default, frame);
4413 #ifdef USE_X_TOOLKIT
4414 /* Create the menu bar. */
4415 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4417 /* If this signals an error, we haven't set size hints for the
4418 frame and we didn't make it visible. */
4419 initialize_frame_menubar (f);
4421 /* This is a no-op, except under Motif where it arranges the
4422 main window for the widgets on it. */
4423 lw_set_main_areas (f->output_data.x->column_widget,
4424 f->output_data.x->menubar_widget,
4425 f->output_data.x->edit_widget);
4427 #endif /* USE_X_TOOLKIT */
4429 /* Tell the server what size and position, etc, we want, and how
4430 badly we want them. This should be done after we have the menu
4431 bar so that its size can be taken into account. */
4432 BLOCK_INPUT;
4433 x_wm_set_size_hint (f, window_prompting, 0);
4434 UNBLOCK_INPUT;
4436 /* Make the window appear on the frame and enable display, unless
4437 the caller says not to. However, with explicit parent, Emacs
4438 cannot control visibility, so don't try. */
4439 if (! f->output_data.x->explicit_parent)
4441 Lisp_Object visibility;
4443 visibility = x_get_arg (dpyinfo, parms, Qvisibility, 0, 0,
4444 RES_TYPE_SYMBOL);
4445 if (EQ (visibility, Qunbound))
4446 visibility = Qt;
4448 if (EQ (visibility, Qicon))
4449 x_iconify_frame (f);
4450 else if (! NILP (visibility))
4451 x_make_frame_visible (f);
4452 else
4453 /* Must have been Qnil. */
4457 UNGCPRO;
4459 /* Make sure windows on this frame appear in calls to next-window
4460 and similar functions. */
4461 Vwindow_list = Qnil;
4463 return unbind_to (count, frame);
4467 /* FRAME is used only to get a handle on the X display. We don't pass the
4468 display info directly because we're called from frame.c, which doesn't
4469 know about that structure. */
4471 Lisp_Object
4472 x_get_focus_frame (frame)
4473 struct frame *frame;
4475 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (frame);
4476 Lisp_Object xfocus;
4477 if (! dpyinfo->x_focus_frame)
4478 return Qnil;
4480 XSETFRAME (xfocus, dpyinfo->x_focus_frame);
4481 return xfocus;
4485 /* In certain situations, when the window manager follows a
4486 click-to-focus policy, there seems to be no way around calling
4487 XSetInputFocus to give another frame the input focus .
4489 In an ideal world, XSetInputFocus should generally be avoided so
4490 that applications don't interfere with the window manager's focus
4491 policy. But I think it's okay to use when it's clearly done
4492 following a user-command. */
4494 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4495 "Set the input focus to FRAME.\n\
4496 FRAME nil means use the selected frame.")
4497 (frame)
4498 Lisp_Object frame;
4500 struct frame *f = check_x_frame (frame);
4501 Display *dpy = FRAME_X_DISPLAY (f);
4502 int count;
4504 BLOCK_INPUT;
4505 count = x_catch_errors (dpy);
4506 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4507 RevertToParent, CurrentTime);
4508 x_uncatch_errors (dpy, count);
4509 UNBLOCK_INPUT;
4511 return Qnil;
4515 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4516 "Internal function called by `color-defined-p', which see.")
4517 (color, frame)
4518 Lisp_Object color, frame;
4520 XColor foo;
4521 FRAME_PTR f = check_x_frame (frame);
4523 CHECK_STRING (color, 1);
4525 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4526 return Qt;
4527 else
4528 return Qnil;
4531 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4532 "Internal function called by `color-values', which see.")
4533 (color, frame)
4534 Lisp_Object color, frame;
4536 XColor foo;
4537 FRAME_PTR f = check_x_frame (frame);
4539 CHECK_STRING (color, 1);
4541 if (x_defined_color (f, XSTRING (color)->data, &foo, 0))
4543 Lisp_Object rgb[3];
4545 rgb[0] = make_number (foo.red);
4546 rgb[1] = make_number (foo.green);
4547 rgb[2] = make_number (foo.blue);
4548 return Flist (3, rgb);
4550 else
4551 return Qnil;
4554 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4555 "Internal function called by `display-color-p', which see.")
4556 (display)
4557 Lisp_Object display;
4559 struct x_display_info *dpyinfo = check_x_display_info (display);
4561 if (dpyinfo->n_planes <= 2)
4562 return Qnil;
4564 switch (dpyinfo->visual->class)
4566 case StaticColor:
4567 case PseudoColor:
4568 case TrueColor:
4569 case DirectColor:
4570 return Qt;
4572 default:
4573 return Qnil;
4577 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
4578 0, 1, 0,
4579 "Return t if the X display supports shades of gray.\n\
4580 Note that color displays do support shades of gray.\n\
4581 The optional argument DISPLAY specifies which display to ask about.\n\
4582 DISPLAY should be either a frame or a display name (a string).\n\
4583 If omitted or nil, that stands for the selected frame's display.")
4584 (display)
4585 Lisp_Object display;
4587 struct x_display_info *dpyinfo = check_x_display_info (display);
4589 if (dpyinfo->n_planes <= 1)
4590 return Qnil;
4592 switch (dpyinfo->visual->class)
4594 case StaticColor:
4595 case PseudoColor:
4596 case TrueColor:
4597 case DirectColor:
4598 case StaticGray:
4599 case GrayScale:
4600 return Qt;
4602 default:
4603 return Qnil;
4607 DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
4608 0, 1, 0,
4609 "Returns the width in pixels of the X display DISPLAY.\n\
4610 The optional argument DISPLAY specifies which display to ask about.\n\
4611 DISPLAY should be either a frame or a display name (a string).\n\
4612 If omitted or nil, that stands for the selected frame's display.")
4613 (display)
4614 Lisp_Object display;
4616 struct x_display_info *dpyinfo = check_x_display_info (display);
4618 return make_number (dpyinfo->width);
4621 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4622 Sx_display_pixel_height, 0, 1, 0,
4623 "Returns the height in pixels of the X display DISPLAY.\n\
4624 The optional argument DISPLAY specifies which display to ask about.\n\
4625 DISPLAY should be either a frame or a display name (a string).\n\
4626 If omitted or nil, that stands for the selected frame's display.")
4627 (display)
4628 Lisp_Object display;
4630 struct x_display_info *dpyinfo = check_x_display_info (display);
4632 return make_number (dpyinfo->height);
4635 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4636 0, 1, 0,
4637 "Returns the number of bitplanes of the X display DISPLAY.\n\
4638 The optional argument DISPLAY specifies which display to ask about.\n\
4639 DISPLAY should be either a frame or a display name (a string).\n\
4640 If omitted or nil, that stands for the selected frame's display.")
4641 (display)
4642 Lisp_Object display;
4644 struct x_display_info *dpyinfo = check_x_display_info (display);
4646 return make_number (dpyinfo->n_planes);
4649 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4650 0, 1, 0,
4651 "Returns the number of color cells of the X display DISPLAY.\n\
4652 The optional argument DISPLAY specifies which display to ask about.\n\
4653 DISPLAY should be either a frame or a display name (a string).\n\
4654 If omitted or nil, that stands for the selected frame's display.")
4655 (display)
4656 Lisp_Object display;
4658 struct x_display_info *dpyinfo = check_x_display_info (display);
4660 return make_number (DisplayCells (dpyinfo->display,
4661 XScreenNumberOfScreen (dpyinfo->screen)));
4664 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4665 Sx_server_max_request_size,
4666 0, 1, 0,
4667 "Returns the maximum request size of the X server of display DISPLAY.\n\
4668 The optional argument DISPLAY specifies which display to ask about.\n\
4669 DISPLAY should be either a frame or a display name (a string).\n\
4670 If omitted or nil, that stands for the selected frame's display.")
4671 (display)
4672 Lisp_Object display;
4674 struct x_display_info *dpyinfo = check_x_display_info (display);
4676 return make_number (MAXREQUEST (dpyinfo->display));
4679 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4680 "Returns the vendor ID string of the X server of display DISPLAY.\n\
4681 The optional argument DISPLAY specifies which display to ask about.\n\
4682 DISPLAY should be either a frame or a display name (a string).\n\
4683 If omitted or nil, that stands for the selected frame's display.")
4684 (display)
4685 Lisp_Object display;
4687 struct x_display_info *dpyinfo = check_x_display_info (display);
4688 char *vendor = ServerVendor (dpyinfo->display);
4690 if (! vendor) vendor = "";
4691 return build_string (vendor);
4694 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4695 "Returns the version numbers of the X server of display DISPLAY.\n\
4696 The value is a list of three integers: the major and minor\n\
4697 version numbers of the X Protocol in use, and the vendor-specific release\n\
4698 number. See also the function `x-server-vendor'.\n\n\
4699 The optional argument DISPLAY specifies which display to ask about.\n\
4700 DISPLAY should be either a frame or a display name (a string).\n\
4701 If omitted or nil, that stands for the selected frame's display.")
4702 (display)
4703 Lisp_Object display;
4705 struct x_display_info *dpyinfo = check_x_display_info (display);
4706 Display *dpy = dpyinfo->display;
4708 return Fcons (make_number (ProtocolVersion (dpy)),
4709 Fcons (make_number (ProtocolRevision (dpy)),
4710 Fcons (make_number (VendorRelease (dpy)), Qnil)));
4713 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4714 "Returns the number of screens on the X server of display DISPLAY.\n\
4715 The optional argument DISPLAY specifies which display to ask about.\n\
4716 DISPLAY should be either a frame or a display name (a string).\n\
4717 If omitted or nil, that stands for the selected frame's display.")
4718 (display)
4719 Lisp_Object display;
4721 struct x_display_info *dpyinfo = check_x_display_info (display);
4723 return make_number (ScreenCount (dpyinfo->display));
4726 DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
4727 "Returns the height in millimeters of the X display DISPLAY.\n\
4728 The optional argument DISPLAY specifies which display to ask about.\n\
4729 DISPLAY should be either a frame or a display name (a string).\n\
4730 If omitted or nil, that stands for the selected frame's display.")
4731 (display)
4732 Lisp_Object display;
4734 struct x_display_info *dpyinfo = check_x_display_info (display);
4736 return make_number (HeightMMOfScreen (dpyinfo->screen));
4739 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4740 "Returns the width in millimeters of the X display DISPLAY.\n\
4741 The optional argument DISPLAY specifies which display to ask about.\n\
4742 DISPLAY should be either a frame or a display name (a string).\n\
4743 If omitted or nil, that stands for the selected frame's display.")
4744 (display)
4745 Lisp_Object display;
4747 struct x_display_info *dpyinfo = check_x_display_info (display);
4749 return make_number (WidthMMOfScreen (dpyinfo->screen));
4752 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4753 Sx_display_backing_store, 0, 1, 0,
4754 "Returns an indication of whether X display DISPLAY does backing store.\n\
4755 The value may be `always', `when-mapped', or `not-useful'.\n\
4756 The optional argument DISPLAY specifies which display to ask about.\n\
4757 DISPLAY should be either a frame or a display name (a string).\n\
4758 If omitted or nil, that stands for the selected frame's display.")
4759 (display)
4760 Lisp_Object display;
4762 struct x_display_info *dpyinfo = check_x_display_info (display);
4763 Lisp_Object result;
4765 switch (DoesBackingStore (dpyinfo->screen))
4767 case Always:
4768 result = intern ("always");
4769 break;
4771 case WhenMapped:
4772 result = intern ("when-mapped");
4773 break;
4775 case NotUseful:
4776 result = intern ("not-useful");
4777 break;
4779 default:
4780 error ("Strange value for BackingStore parameter of screen");
4781 result = Qnil;
4784 return result;
4787 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4788 Sx_display_visual_class, 0, 1, 0,
4789 "Returns the visual class of the X display DISPLAY.\n\
4790 The value is one of the symbols `static-gray', `gray-scale',\n\
4791 `static-color', `pseudo-color', `true-color', or `direct-color'.\n\n\
4792 The optional argument DISPLAY specifies which display to ask about.\n\
4793 DISPLAY should be either a frame or a display name (a string).\n\
4794 If omitted or nil, that stands for the selected frame's display.")
4795 (display)
4796 Lisp_Object display;
4798 struct x_display_info *dpyinfo = check_x_display_info (display);
4799 Lisp_Object result;
4801 switch (dpyinfo->visual->class)
4803 case StaticGray:
4804 result = intern ("static-gray");
4805 break;
4806 case GrayScale:
4807 result = intern ("gray-scale");
4808 break;
4809 case StaticColor:
4810 result = intern ("static-color");
4811 break;
4812 case PseudoColor:
4813 result = intern ("pseudo-color");
4814 break;
4815 case TrueColor:
4816 result = intern ("true-color");
4817 break;
4818 case DirectColor:
4819 result = intern ("direct-color");
4820 break;
4821 default:
4822 error ("Display has an unknown visual class");
4823 result = Qnil;
4826 return result;
4829 DEFUN ("x-display-save-under", Fx_display_save_under,
4830 Sx_display_save_under, 0, 1, 0,
4831 "Returns t if the X display DISPLAY supports the save-under feature.\n\
4832 The optional argument DISPLAY specifies which display to ask about.\n\
4833 DISPLAY should be either a frame or a display name (a string).\n\
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 if (DoesSaveUnders (dpyinfo->screen) == True)
4841 return Qt;
4842 else
4843 return Qnil;
4847 x_pixel_width (f)
4848 register struct frame *f;
4850 return PIXEL_WIDTH (f);
4854 x_pixel_height (f)
4855 register struct frame *f;
4857 return PIXEL_HEIGHT (f);
4861 x_char_width (f)
4862 register struct frame *f;
4864 return FONT_WIDTH (f->output_data.x->font);
4868 x_char_height (f)
4869 register struct frame *f;
4871 return f->output_data.x->line_height;
4875 x_screen_planes (f)
4876 register struct frame *f;
4878 return FRAME_X_DISPLAY_INFO (f)->n_planes;
4883 /************************************************************************
4884 X Displays
4885 ************************************************************************/
4888 /* Mapping visual names to visuals. */
4890 static struct visual_class
4892 char *name;
4893 int class;
4895 visual_classes[] =
4897 {"StaticGray", StaticGray},
4898 {"GrayScale", GrayScale},
4899 {"StaticColor", StaticColor},
4900 {"PseudoColor", PseudoColor},
4901 {"TrueColor", TrueColor},
4902 {"DirectColor", DirectColor},
4903 NULL
4907 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4909 /* Value is the screen number of screen SCR. This is a substitute for
4910 the X function with the same name when that doesn't exist. */
4913 XScreenNumberOfScreen (scr)
4914 register Screen *scr;
4916 Display *dpy = scr->display;
4917 int i;
4919 for (i = 0; i < dpy->nscreens; ++i)
4920 if (scr == dpy->screens[i])
4921 break;
4923 return i;
4926 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4929 /* Select the visual that should be used on display DPYINFO. Set
4930 members of DPYINFO appropriately. Called from x_term_init. */
4932 void
4933 select_visual (dpyinfo)
4934 struct x_display_info *dpyinfo;
4936 Display *dpy = dpyinfo->display;
4937 Screen *screen = dpyinfo->screen;
4938 Lisp_Object value;
4940 /* See if a visual is specified. */
4941 value = display_x_get_resource (dpyinfo,
4942 build_string ("visualClass"),
4943 build_string ("VisualClass"),
4944 Qnil, Qnil);
4945 if (STRINGP (value))
4947 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4948 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4949 depth, a decimal number. NAME is compared with case ignored. */
4950 char *s = (char *) alloca (STRING_BYTES (XSTRING (value)) + 1);
4951 char *dash;
4952 int i, class = -1;
4953 XVisualInfo vinfo;
4955 strcpy (s, XSTRING (value)->data);
4956 dash = index (s, '-');
4957 if (dash)
4959 dpyinfo->n_planes = atoi (dash + 1);
4960 *dash = '\0';
4962 else
4963 /* We won't find a matching visual with depth 0, so that
4964 an error will be printed below. */
4965 dpyinfo->n_planes = 0;
4967 /* Determine the visual class. */
4968 for (i = 0; visual_classes[i].name; ++i)
4969 if (xstricmp (s, visual_classes[i].name) == 0)
4971 class = visual_classes[i].class;
4972 break;
4975 /* Look up a matching visual for the specified class. */
4976 if (class == -1
4977 || !XMatchVisualInfo (dpy, XScreenNumberOfScreen (screen),
4978 dpyinfo->n_planes, class, &vinfo))
4979 fatal ("Invalid visual specification `%s'", XSTRING (value)->data);
4981 dpyinfo->visual = vinfo.visual;
4983 else
4985 int n_visuals;
4986 XVisualInfo *vinfo, vinfo_template;
4988 dpyinfo->visual = DefaultVisualOfScreen (screen);
4990 #ifdef HAVE_X11R4
4991 vinfo_template.visualid = XVisualIDFromVisual (dpyinfo->visual);
4992 #else
4993 vinfo_template.visualid = dpyinfo->visual->visualid;
4994 #endif
4995 vinfo_template.screen = XScreenNumberOfScreen (screen);
4996 vinfo = XGetVisualInfo (dpy, VisualIDMask | VisualScreenMask,
4997 &vinfo_template, &n_visuals);
4998 if (n_visuals != 1)
4999 fatal ("Can't get proper X visual info");
5001 dpyinfo->n_planes = vinfo->depth;
5002 XFree ((char *) vinfo);
5007 /* Return the X display structure for the display named NAME.
5008 Open a new connection if necessary. */
5010 struct x_display_info *
5011 x_display_info_for_name (name)
5012 Lisp_Object name;
5014 Lisp_Object names;
5015 struct x_display_info *dpyinfo;
5017 CHECK_STRING (name, 0);
5019 if (! EQ (Vwindow_system, intern ("x")))
5020 error ("Not using X Windows");
5022 for (dpyinfo = x_display_list, names = x_display_name_list;
5023 dpyinfo;
5024 dpyinfo = dpyinfo->next, names = XCDR (names))
5026 Lisp_Object tem;
5027 tem = Fstring_equal (XCAR (XCAR (names)), name);
5028 if (!NILP (tem))
5029 return dpyinfo;
5032 /* Use this general default value to start with. */
5033 Vx_resource_name = Vinvocation_name;
5035 validate_x_resource_name ();
5037 dpyinfo = x_term_init (name, (char *)0,
5038 (char *) XSTRING (Vx_resource_name)->data);
5040 if (dpyinfo == 0)
5041 error ("Cannot connect to X server %s", XSTRING (name)->data);
5043 x_in_use = 1;
5044 XSETFASTINT (Vwindow_system_version, 11);
5046 return dpyinfo;
5050 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5051 1, 3, 0, "Open a connection to an X server.\n\
5052 DISPLAY is the name of the display to connect to.\n\
5053 Optional second arg XRM-STRING is a string of resources in xrdb format.\n\
5054 If the optional third arg MUST-SUCCEED is non-nil,\n\
5055 terminate Emacs if we can't open the connection.")
5056 (display, xrm_string, must_succeed)
5057 Lisp_Object display, xrm_string, must_succeed;
5059 unsigned char *xrm_option;
5060 struct x_display_info *dpyinfo;
5062 CHECK_STRING (display, 0);
5063 if (! NILP (xrm_string))
5064 CHECK_STRING (xrm_string, 1);
5066 if (! EQ (Vwindow_system, intern ("x")))
5067 error ("Not using X Windows");
5069 if (! NILP (xrm_string))
5070 xrm_option = (unsigned char *) XSTRING (xrm_string)->data;
5071 else
5072 xrm_option = (unsigned char *) 0;
5074 validate_x_resource_name ();
5076 /* This is what opens the connection and sets x_current_display.
5077 This also initializes many symbols, such as those used for input. */
5078 dpyinfo = x_term_init (display, xrm_option,
5079 (char *) XSTRING (Vx_resource_name)->data);
5081 if (dpyinfo == 0)
5083 if (!NILP (must_succeed))
5084 fatal ("Cannot connect to X server %s.\n\
5085 Check the DISPLAY environment variable or use `-d'.\n\
5086 Also use the `xhost' program to verify that it is set to permit\n\
5087 connections from your machine.\n",
5088 XSTRING (display)->data);
5089 else
5090 error ("Cannot connect to X server %s", XSTRING (display)->data);
5093 x_in_use = 1;
5095 XSETFASTINT (Vwindow_system_version, 11);
5096 return Qnil;
5099 DEFUN ("x-close-connection", Fx_close_connection,
5100 Sx_close_connection, 1, 1, 0,
5101 "Close the connection to DISPLAY's X server.\n\
5102 For DISPLAY, specify either a frame or a display name (a string).\n\
5103 If DISPLAY is nil, that stands for the selected frame's display.")
5104 (display)
5105 Lisp_Object display;
5107 struct x_display_info *dpyinfo = check_x_display_info (display);
5108 int i;
5110 if (dpyinfo->reference_count > 0)
5111 error ("Display still has frames on it");
5113 BLOCK_INPUT;
5114 /* Free the fonts in the font table. */
5115 for (i = 0; i < dpyinfo->n_fonts; i++)
5116 if (dpyinfo->font_table[i].name)
5118 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
5119 xfree (dpyinfo->font_table[i].full_name);
5120 xfree (dpyinfo->font_table[i].name);
5121 XFreeFont (dpyinfo->display, dpyinfo->font_table[i].font);
5124 x_destroy_all_bitmaps (dpyinfo);
5125 XSetCloseDownMode (dpyinfo->display, DestroyAll);
5127 #ifdef USE_X_TOOLKIT
5128 XtCloseDisplay (dpyinfo->display);
5129 #else
5130 XCloseDisplay (dpyinfo->display);
5131 #endif
5133 x_delete_display (dpyinfo);
5134 UNBLOCK_INPUT;
5136 return Qnil;
5139 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5140 "Return the list of display names that Emacs has connections to.")
5143 Lisp_Object tail, result;
5145 result = Qnil;
5146 for (tail = x_display_name_list; ! NILP (tail); tail = XCDR (tail))
5147 result = Fcons (XCAR (XCAR (tail)), result);
5149 return result;
5152 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5153 "If ON is non-nil, report X errors as soon as the erring request is made.\n\
5154 If ON is nil, allow buffering of requests.\n\
5155 Turning on synchronization prohibits the Xlib routines from buffering\n\
5156 requests and seriously degrades performance, but makes debugging much\n\
5157 easier.\n\
5158 The optional second argument DISPLAY specifies which display to act on.\n\
5159 DISPLAY should be either a frame or a display name (a string).\n\
5160 If DISPLAY is omitted or nil, that stands for the selected frame's display.")
5161 (on, display)
5162 Lisp_Object display, on;
5164 struct x_display_info *dpyinfo = check_x_display_info (display);
5166 XSynchronize (dpyinfo->display, !EQ (on, Qnil));
5168 return Qnil;
5171 /* Wait for responses to all X commands issued so far for frame F. */
5173 void
5174 x_sync (f)
5175 FRAME_PTR f;
5177 BLOCK_INPUT;
5178 XSync (FRAME_X_DISPLAY (f), False);
5179 UNBLOCK_INPUT;
5183 /***********************************************************************
5184 Image types
5185 ***********************************************************************/
5187 /* Value is the number of elements of vector VECTOR. */
5189 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
5191 /* List of supported image types. Use define_image_type to add new
5192 types. Use lookup_image_type to find a type for a given symbol. */
5194 static struct image_type *image_types;
5196 /* The symbol `image' which is the car of the lists used to represent
5197 images in Lisp. */
5199 extern Lisp_Object Qimage;
5201 /* The symbol `xbm' which is used as the type symbol for XBM images. */
5203 Lisp_Object Qxbm;
5205 /* Keywords. */
5207 extern Lisp_Object QCwidth, QCheight, QCforeground, QCbackground, QCfile;
5208 extern Lisp_Object QCdata;
5209 Lisp_Object QCtype, QCascent, QCmargin, QCrelief;
5210 Lisp_Object QCconversion, QCcolor_symbols, QCheuristic_mask;
5211 Lisp_Object QCindex, QCmatrix, QCcolor_adjustment, QCmask;
5213 /* Other symbols. */
5215 Lisp_Object Qlaplace, Qemboss, Qedge_detection, Qheuristic;
5217 /* Time in seconds after which images should be removed from the cache
5218 if not displayed. */
5220 Lisp_Object Vimage_cache_eviction_delay;
5222 /* Function prototypes. */
5224 static void define_image_type P_ ((struct image_type *type));
5225 static struct image_type *lookup_image_type P_ ((Lisp_Object symbol));
5226 static void image_error P_ ((char *format, Lisp_Object, Lisp_Object));
5227 static void x_laplace P_ ((struct frame *, struct image *));
5228 static void x_emboss P_ ((struct frame *, struct image *));
5229 static int x_build_heuristic_mask P_ ((struct frame *, struct image *,
5230 Lisp_Object));
5233 /* Define a new image type from TYPE. This adds a copy of TYPE to
5234 image_types and adds the symbol *TYPE->type to Vimage_types. */
5236 static void
5237 define_image_type (type)
5238 struct image_type *type;
5240 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
5241 The initialized data segment is read-only. */
5242 struct image_type *p = (struct image_type *) xmalloc (sizeof *p);
5243 bcopy (type, p, sizeof *p);
5244 p->next = image_types;
5245 image_types = p;
5246 Vimage_types = Fcons (*p->type, Vimage_types);
5250 /* Look up image type SYMBOL, and return a pointer to its image_type
5251 structure. Value is null if SYMBOL is not a known image type. */
5253 static INLINE struct image_type *
5254 lookup_image_type (symbol)
5255 Lisp_Object symbol;
5257 struct image_type *type;
5259 for (type = image_types; type; type = type->next)
5260 if (EQ (symbol, *type->type))
5261 break;
5263 return type;
5267 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
5268 valid image specification is a list whose car is the symbol
5269 `image', and whose rest is a property list. The property list must
5270 contain a value for key `:type'. That value must be the name of a
5271 supported image type. The rest of the property list depends on the
5272 image type. */
5275 valid_image_p (object)
5276 Lisp_Object object;
5278 int valid_p = 0;
5280 if (CONSP (object) && EQ (XCAR (object), Qimage))
5282 Lisp_Object symbol = Fplist_get (XCDR (object), QCtype);
5283 struct image_type *type = lookup_image_type (symbol);
5285 if (type)
5286 valid_p = type->valid_p (object);
5289 return valid_p;
5293 /* Log error message with format string FORMAT and argument ARG.
5294 Signaling an error, e.g. when an image cannot be loaded, is not a
5295 good idea because this would interrupt redisplay, and the error
5296 message display would lead to another redisplay. This function
5297 therefore simply displays a message. */
5299 static void
5300 image_error (format, arg1, arg2)
5301 char *format;
5302 Lisp_Object arg1, arg2;
5304 add_to_log (format, arg1, arg2);
5309 /***********************************************************************
5310 Image specifications
5311 ***********************************************************************/
5313 enum image_value_type
5315 IMAGE_DONT_CHECK_VALUE_TYPE,
5316 IMAGE_STRING_VALUE,
5317 IMAGE_SYMBOL_VALUE,
5318 IMAGE_POSITIVE_INTEGER_VALUE,
5319 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR,
5320 IMAGE_NON_NEGATIVE_INTEGER_VALUE,
5321 IMAGE_ASCENT_VALUE,
5322 IMAGE_INTEGER_VALUE,
5323 IMAGE_FUNCTION_VALUE,
5324 IMAGE_NUMBER_VALUE,
5325 IMAGE_BOOL_VALUE
5328 /* Structure used when parsing image specifications. */
5330 struct image_keyword
5332 /* Name of keyword. */
5333 char *name;
5335 /* The type of value allowed. */
5336 enum image_value_type type;
5338 /* Non-zero means key must be present. */
5339 int mandatory_p;
5341 /* Used to recognize duplicate keywords in a property list. */
5342 int count;
5344 /* The value that was found. */
5345 Lisp_Object value;
5349 static int parse_image_spec P_ ((Lisp_Object, struct image_keyword *,
5350 int, Lisp_Object));
5351 static Lisp_Object image_spec_value P_ ((Lisp_Object, Lisp_Object, int *));
5354 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
5355 has the format (image KEYWORD VALUE ...). One of the keyword/
5356 value pairs must be `:type TYPE'. KEYWORDS is a vector of
5357 image_keywords structures of size NKEYWORDS describing other
5358 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
5360 static int
5361 parse_image_spec (spec, keywords, nkeywords, type)
5362 Lisp_Object spec;
5363 struct image_keyword *keywords;
5364 int nkeywords;
5365 Lisp_Object type;
5367 int i;
5368 Lisp_Object plist;
5370 if (!CONSP (spec) || !EQ (XCAR (spec), Qimage))
5371 return 0;
5373 plist = XCDR (spec);
5374 while (CONSP (plist))
5376 Lisp_Object key, value;
5378 /* First element of a pair must be a symbol. */
5379 key = XCAR (plist);
5380 plist = XCDR (plist);
5381 if (!SYMBOLP (key))
5382 return 0;
5384 /* There must follow a value. */
5385 if (!CONSP (plist))
5386 return 0;
5387 value = XCAR (plist);
5388 plist = XCDR (plist);
5390 /* Find key in KEYWORDS. Error if not found. */
5391 for (i = 0; i < nkeywords; ++i)
5392 if (strcmp (keywords[i].name, XSYMBOL (key)->name->data) == 0)
5393 break;
5395 if (i == nkeywords)
5396 continue;
5398 /* Record that we recognized the keyword. If a keywords
5399 was found more than once, it's an error. */
5400 keywords[i].value = value;
5401 ++keywords[i].count;
5403 if (keywords[i].count > 1)
5404 return 0;
5406 /* Check type of value against allowed type. */
5407 switch (keywords[i].type)
5409 case IMAGE_STRING_VALUE:
5410 if (!STRINGP (value))
5411 return 0;
5412 break;
5414 case IMAGE_SYMBOL_VALUE:
5415 if (!SYMBOLP (value))
5416 return 0;
5417 break;
5419 case IMAGE_POSITIVE_INTEGER_VALUE:
5420 if (!INTEGERP (value) || XINT (value) <= 0)
5421 return 0;
5422 break;
5424 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR:
5425 if (INTEGERP (value) && XINT (value) >= 0)
5426 break;
5427 if (CONSP (value)
5428 && INTEGERP (XCAR (value)) && INTEGERP (XCDR (value))
5429 && XINT (XCAR (value)) >= 0 && XINT (XCDR (value)) >= 0)
5430 break;
5431 return 0;
5433 case IMAGE_ASCENT_VALUE:
5434 if (SYMBOLP (value) && EQ (value, Qcenter))
5435 break;
5436 else if (INTEGERP (value)
5437 && XINT (value) >= 0
5438 && XINT (value) <= 100)
5439 break;
5440 return 0;
5442 case IMAGE_NON_NEGATIVE_INTEGER_VALUE:
5443 if (!INTEGERP (value) || XINT (value) < 0)
5444 return 0;
5445 break;
5447 case IMAGE_DONT_CHECK_VALUE_TYPE:
5448 break;
5450 case IMAGE_FUNCTION_VALUE:
5451 value = indirect_function (value);
5452 if (SUBRP (value)
5453 || COMPILEDP (value)
5454 || (CONSP (value) && EQ (XCAR (value), Qlambda)))
5455 break;
5456 return 0;
5458 case IMAGE_NUMBER_VALUE:
5459 if (!INTEGERP (value) && !FLOATP (value))
5460 return 0;
5461 break;
5463 case IMAGE_INTEGER_VALUE:
5464 if (!INTEGERP (value))
5465 return 0;
5466 break;
5468 case IMAGE_BOOL_VALUE:
5469 if (!NILP (value) && !EQ (value, Qt))
5470 return 0;
5471 break;
5473 default:
5474 abort ();
5475 break;
5478 if (EQ (key, QCtype) && !EQ (type, value))
5479 return 0;
5482 /* Check that all mandatory fields are present. */
5483 for (i = 0; i < nkeywords; ++i)
5484 if (keywords[i].mandatory_p && keywords[i].count == 0)
5485 return 0;
5487 return NILP (plist);
5491 /* Return the value of KEY in image specification SPEC. Value is nil
5492 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
5493 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
5495 static Lisp_Object
5496 image_spec_value (spec, key, found)
5497 Lisp_Object spec, key;
5498 int *found;
5500 Lisp_Object tail;
5502 xassert (valid_image_p (spec));
5504 for (tail = XCDR (spec);
5505 CONSP (tail) && CONSP (XCDR (tail));
5506 tail = XCDR (XCDR (tail)))
5508 if (EQ (XCAR (tail), key))
5510 if (found)
5511 *found = 1;
5512 return XCAR (XCDR (tail));
5516 if (found)
5517 *found = 0;
5518 return Qnil;
5522 DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
5523 "Return the size of image SPEC as pair (WIDTH . HEIGHT).\n\
5524 PIXELS non-nil means return the size in pixels, otherwise return the\n\
5525 size in canonical character units.\n\
5526 FRAME is the frame on which the image will be displayed. FRAME nil\n\
5527 or omitted means use the selected frame.")
5528 (spec, pixels, frame)
5529 Lisp_Object spec, pixels, frame;
5531 Lisp_Object size;
5533 size = Qnil;
5534 if (valid_image_p (spec))
5536 struct frame *f = check_x_frame (frame);
5537 int id = lookup_image (f, spec);
5538 struct image *img = IMAGE_FROM_ID (f, id);
5539 int width = img->width + 2 * img->hmargin;
5540 int height = img->height + 2 * img->vmargin;
5542 if (NILP (pixels))
5543 size = Fcons (make_float ((double) width / CANON_X_UNIT (f)),
5544 make_float ((double) height / CANON_Y_UNIT (f)));
5545 else
5546 size = Fcons (make_number (width), make_number (height));
5548 else
5549 error ("Invalid image specification");
5551 return size;
5555 DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
5556 "Return t if image SPEC has a mask bitmap.\n\
5557 FRAME is the frame on which the image will be displayed. FRAME nil\n\
5558 or omitted means use the selected frame.")
5559 (spec, frame)
5560 Lisp_Object spec, frame;
5562 Lisp_Object mask;
5564 mask = Qnil;
5565 if (valid_image_p (spec))
5567 struct frame *f = check_x_frame (frame);
5568 int id = lookup_image (f, spec);
5569 struct image *img = IMAGE_FROM_ID (f, id);
5570 if (img->mask)
5571 mask = Qt;
5573 else
5574 error ("Invalid image specification");
5576 return mask;
5581 /***********************************************************************
5582 Image type independent image structures
5583 ***********************************************************************/
5585 static struct image *make_image P_ ((Lisp_Object spec, unsigned hash));
5586 static void free_image P_ ((struct frame *f, struct image *img));
5589 /* Allocate and return a new image structure for image specification
5590 SPEC. SPEC has a hash value of HASH. */
5592 static struct image *
5593 make_image (spec, hash)
5594 Lisp_Object spec;
5595 unsigned hash;
5597 struct image *img = (struct image *) xmalloc (sizeof *img);
5599 xassert (valid_image_p (spec));
5600 bzero (img, sizeof *img);
5601 img->type = lookup_image_type (image_spec_value (spec, QCtype, NULL));
5602 xassert (img->type != NULL);
5603 img->spec = spec;
5604 img->data.lisp_val = Qnil;
5605 img->ascent = DEFAULT_IMAGE_ASCENT;
5606 img->hash = hash;
5607 return img;
5611 /* Free image IMG which was used on frame F, including its resources. */
5613 static void
5614 free_image (f, img)
5615 struct frame *f;
5616 struct image *img;
5618 if (img)
5620 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5622 /* Remove IMG from the hash table of its cache. */
5623 if (img->prev)
5624 img->prev->next = img->next;
5625 else
5626 c->buckets[img->hash % IMAGE_CACHE_BUCKETS_SIZE] = img->next;
5628 if (img->next)
5629 img->next->prev = img->prev;
5631 c->images[img->id] = NULL;
5633 /* Free resources, then free IMG. */
5634 img->type->free (f, img);
5635 xfree (img);
5640 /* Prepare image IMG for display on frame F. Must be called before
5641 drawing an image. */
5643 void
5644 prepare_image_for_display (f, img)
5645 struct frame *f;
5646 struct image *img;
5648 EMACS_TIME t;
5650 /* We're about to display IMG, so set its timestamp to `now'. */
5651 EMACS_GET_TIME (t);
5652 img->timestamp = EMACS_SECS (t);
5654 /* If IMG doesn't have a pixmap yet, load it now, using the image
5655 type dependent loader function. */
5656 if (img->pixmap == None && !img->load_failed_p)
5657 img->load_failed_p = img->type->load (f, img) == 0;
5661 /* Value is the number of pixels for the ascent of image IMG when
5662 drawn in face FACE. */
5665 image_ascent (img, face)
5666 struct image *img;
5667 struct face *face;
5669 int height = img->height + img->vmargin;
5670 int ascent;
5672 if (img->ascent == CENTERED_IMAGE_ASCENT)
5674 if (face->font)
5675 /* This expression is arranged so that if the image can't be
5676 exactly centered, it will be moved slightly up. This is
5677 because a typical font is `top-heavy' (due to the presence
5678 uppercase letters), so the image placement should err towards
5679 being top-heavy too. It also just generally looks better. */
5680 ascent = (height + face->font->ascent - face->font->descent + 1) / 2;
5681 else
5682 ascent = height / 2;
5684 else
5685 ascent = height * img->ascent / 100.0;
5687 return ascent;
5692 /***********************************************************************
5693 Helper functions for X image types
5694 ***********************************************************************/
5696 static void x_clear_image_1 P_ ((struct frame *, struct image *, int,
5697 int, int));
5698 static void x_clear_image P_ ((struct frame *f, struct image *img));
5699 static unsigned long x_alloc_image_color P_ ((struct frame *f,
5700 struct image *img,
5701 Lisp_Object color_name,
5702 unsigned long dflt));
5705 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
5706 free the pixmap if any. MASK_P non-zero means clear the mask
5707 pixmap if any. COLORS_P non-zero means free colors allocated for
5708 the image, if any. */
5710 static void
5711 x_clear_image_1 (f, img, pixmap_p, mask_p, colors_p)
5712 struct frame *f;
5713 struct image *img;
5714 int pixmap_p, mask_p, colors_p;
5716 if (pixmap_p && img->pixmap)
5718 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
5719 img->pixmap = None;
5722 if (mask_p && img->mask)
5724 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
5725 img->mask = None;
5728 if (colors_p && img->ncolors)
5730 x_free_colors (f, img->colors, img->ncolors);
5731 xfree (img->colors);
5732 img->colors = NULL;
5733 img->ncolors = 0;
5737 /* Free X resources of image IMG which is used on frame F. */
5739 static void
5740 x_clear_image (f, img)
5741 struct frame *f;
5742 struct image *img;
5744 BLOCK_INPUT;
5745 x_clear_image_1 (f, img, 1, 1, 1);
5746 UNBLOCK_INPUT;
5750 /* Allocate color COLOR_NAME for image IMG on frame F. If color
5751 cannot be allocated, use DFLT. Add a newly allocated color to
5752 IMG->colors, so that it can be freed again. Value is the pixel
5753 color. */
5755 static unsigned long
5756 x_alloc_image_color (f, img, color_name, dflt)
5757 struct frame *f;
5758 struct image *img;
5759 Lisp_Object color_name;
5760 unsigned long dflt;
5762 XColor color;
5763 unsigned long result;
5765 xassert (STRINGP (color_name));
5767 if (x_defined_color (f, XSTRING (color_name)->data, &color, 1))
5769 /* This isn't called frequently so we get away with simply
5770 reallocating the color vector to the needed size, here. */
5771 ++img->ncolors;
5772 img->colors =
5773 (unsigned long *) xrealloc (img->colors,
5774 img->ncolors * sizeof *img->colors);
5775 img->colors[img->ncolors - 1] = color.pixel;
5776 result = color.pixel;
5778 else
5779 result = dflt;
5781 return result;
5786 /***********************************************************************
5787 Image Cache
5788 ***********************************************************************/
5790 static void cache_image P_ ((struct frame *f, struct image *img));
5793 /* Return a new, initialized image cache that is allocated from the
5794 heap. Call free_image_cache to free an image cache. */
5796 struct image_cache *
5797 make_image_cache ()
5799 struct image_cache *c = (struct image_cache *) xmalloc (sizeof *c);
5800 int size;
5802 bzero (c, sizeof *c);
5803 c->size = 50;
5804 c->images = (struct image **) xmalloc (c->size * sizeof *c->images);
5805 size = IMAGE_CACHE_BUCKETS_SIZE * sizeof *c->buckets;
5806 c->buckets = (struct image **) xmalloc (size);
5807 bzero (c->buckets, size);
5808 return c;
5812 /* Free image cache of frame F. Be aware that X frames share images
5813 caches. */
5815 void
5816 free_image_cache (f)
5817 struct frame *f;
5819 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5820 if (c)
5822 int i;
5824 /* Cache should not be referenced by any frame when freed. */
5825 xassert (c->refcount == 0);
5827 for (i = 0; i < c->used; ++i)
5828 free_image (f, c->images[i]);
5829 xfree (c->images);
5830 xfree (c->buckets);
5831 xfree (c);
5832 FRAME_X_IMAGE_CACHE (f) = NULL;
5837 /* Clear image cache of frame F. FORCE_P non-zero means free all
5838 images. FORCE_P zero means clear only images that haven't been
5839 displayed for some time. Should be called from time to time to
5840 reduce the number of loaded images. If image-eviction-seconds is
5841 non-nil, this frees images in the cache which weren't displayed for
5842 at least that many seconds. */
5844 void
5845 clear_image_cache (f, force_p)
5846 struct frame *f;
5847 int force_p;
5849 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5851 if (c && INTEGERP (Vimage_cache_eviction_delay))
5853 EMACS_TIME t;
5854 unsigned long old;
5855 int i, nfreed;
5857 EMACS_GET_TIME (t);
5858 old = EMACS_SECS (t) - XFASTINT (Vimage_cache_eviction_delay);
5860 /* Block input so that we won't be interrupted by a SIGIO
5861 while being in an inconsistent state. */
5862 BLOCK_INPUT;
5864 for (i = nfreed = 0; i < c->used; ++i)
5866 struct image *img = c->images[i];
5867 if (img != NULL
5868 && (force_p || img->timestamp < old))
5870 free_image (f, img);
5871 ++nfreed;
5875 /* We may be clearing the image cache because, for example,
5876 Emacs was iconified for a longer period of time. In that
5877 case, current matrices may still contain references to
5878 images freed above. So, clear these matrices. */
5879 if (nfreed)
5881 Lisp_Object tail, frame;
5883 FOR_EACH_FRAME (tail, frame)
5885 struct frame *f = XFRAME (frame);
5886 if (FRAME_X_P (f)
5887 && FRAME_X_IMAGE_CACHE (f) == c)
5888 clear_current_matrices (f);
5891 ++windows_or_buffers_changed;
5894 UNBLOCK_INPUT;
5899 DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
5900 0, 1, 0,
5901 "Clear the image cache of FRAME.\n\
5902 FRAME nil or omitted means use the selected frame.\n\
5903 FRAME t means clear the image caches of all frames.")
5904 (frame)
5905 Lisp_Object frame;
5907 if (EQ (frame, Qt))
5909 Lisp_Object tail;
5911 FOR_EACH_FRAME (tail, frame)
5912 if (FRAME_X_P (XFRAME (frame)))
5913 clear_image_cache (XFRAME (frame), 1);
5915 else
5916 clear_image_cache (check_x_frame (frame), 1);
5918 return Qnil;
5922 /* Return the id of image with Lisp specification SPEC on frame F.
5923 SPEC must be a valid Lisp image specification (see valid_image_p). */
5926 lookup_image (f, spec)
5927 struct frame *f;
5928 Lisp_Object spec;
5930 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
5931 struct image *img;
5932 int i;
5933 unsigned hash;
5934 struct gcpro gcpro1;
5935 EMACS_TIME now;
5937 /* F must be a window-system frame, and SPEC must be a valid image
5938 specification. */
5939 xassert (FRAME_WINDOW_P (f));
5940 xassert (valid_image_p (spec));
5942 GCPRO1 (spec);
5944 /* Look up SPEC in the hash table of the image cache. */
5945 hash = sxhash (spec, 0);
5946 i = hash % IMAGE_CACHE_BUCKETS_SIZE;
5948 for (img = c->buckets[i]; img; img = img->next)
5949 if (img->hash == hash && !NILP (Fequal (img->spec, spec)))
5950 break;
5952 /* If not found, create a new image and cache it. */
5953 if (img == NULL)
5955 BLOCK_INPUT;
5956 img = make_image (spec, hash);
5957 cache_image (f, img);
5958 img->load_failed_p = img->type->load (f, img) == 0;
5960 /* If we can't load the image, and we don't have a width and
5961 height, use some arbitrary width and height so that we can
5962 draw a rectangle for it. */
5963 if (img->load_failed_p)
5965 Lisp_Object value;
5967 value = image_spec_value (spec, QCwidth, NULL);
5968 img->width = (INTEGERP (value)
5969 ? XFASTINT (value) : DEFAULT_IMAGE_WIDTH);
5970 value = image_spec_value (spec, QCheight, NULL);
5971 img->height = (INTEGERP (value)
5972 ? XFASTINT (value) : DEFAULT_IMAGE_HEIGHT);
5974 else
5976 /* Handle image type independent image attributes
5977 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF'. */
5978 Lisp_Object ascent, margin, relief;
5980 ascent = image_spec_value (spec, QCascent, NULL);
5981 if (INTEGERP (ascent))
5982 img->ascent = XFASTINT (ascent);
5983 else if (EQ (ascent, Qcenter))
5984 img->ascent = CENTERED_IMAGE_ASCENT;
5986 margin = image_spec_value (spec, QCmargin, NULL);
5987 if (INTEGERP (margin) && XINT (margin) >= 0)
5988 img->vmargin = img->hmargin = XFASTINT (margin);
5989 else if (CONSP (margin) && INTEGERP (XCAR (margin))
5990 && INTEGERP (XCDR (margin)))
5992 if (XINT (XCAR (margin)) > 0)
5993 img->hmargin = XFASTINT (XCAR (margin));
5994 if (XINT (XCDR (margin)) > 0)
5995 img->vmargin = XFASTINT (XCDR (margin));
5998 relief = image_spec_value (spec, QCrelief, NULL);
5999 if (INTEGERP (relief))
6001 img->relief = XINT (relief);
6002 img->hmargin += abs (img->relief);
6003 img->vmargin += abs (img->relief);
6006 /* Manipulation of the image's mask. */
6007 if (img->pixmap)
6009 /* `:heuristic-mask t'
6010 `:mask heuristic'
6011 means build a mask heuristically.
6012 `:heuristic-mask (R G B)'
6013 `:mask (heuristic (R G B))'
6014 means build a mask from color (R G B) in the
6015 image.
6016 `:mask nil'
6017 means remove a mask, if any. */
6019 Lisp_Object mask;
6021 mask = image_spec_value (spec, QCheuristic_mask, NULL);
6022 if (!NILP (mask))
6023 x_build_heuristic_mask (f, img, mask);
6024 else
6026 int found_p;
6028 mask = image_spec_value (spec, QCmask, &found_p);
6030 if (EQ (mask, Qheuristic))
6031 x_build_heuristic_mask (f, img, Qt);
6032 else if (CONSP (mask)
6033 && EQ (XCAR (mask), Qheuristic))
6035 if (CONSP (XCDR (mask)))
6036 x_build_heuristic_mask (f, img, XCAR (XCDR (mask)));
6037 else
6038 x_build_heuristic_mask (f, img, XCDR (mask));
6040 else if (NILP (mask) && found_p && img->mask)
6042 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
6043 img->mask = None;
6048 /* Should we apply an image transformation algorithm? */
6049 if (img->pixmap)
6051 Lisp_Object conversion;
6053 conversion = image_spec_value (spec, QCconversion, NULL);
6054 if (EQ (conversion, Qdisabled))
6055 x_disable_image (f, img);
6056 else if (EQ (conversion, Qlaplace))
6057 x_laplace (f, img);
6058 else if (EQ (conversion, Qemboss))
6059 x_emboss (f, img);
6060 else if (CONSP (conversion)
6061 && EQ (XCAR (conversion), Qedge_detection))
6063 Lisp_Object tem;
6064 tem = XCDR (conversion);
6065 if (CONSP (tem))
6066 x_edge_detection (f, img,
6067 Fplist_get (tem, QCmatrix),
6068 Fplist_get (tem, QCcolor_adjustment));
6073 UNBLOCK_INPUT;
6074 xassert (!interrupt_input_blocked);
6077 /* We're using IMG, so set its timestamp to `now'. */
6078 EMACS_GET_TIME (now);
6079 img->timestamp = EMACS_SECS (now);
6081 UNGCPRO;
6083 /* Value is the image id. */
6084 return img->id;
6088 /* Cache image IMG in the image cache of frame F. */
6090 static void
6091 cache_image (f, img)
6092 struct frame *f;
6093 struct image *img;
6095 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6096 int i;
6098 /* Find a free slot in c->images. */
6099 for (i = 0; i < c->used; ++i)
6100 if (c->images[i] == NULL)
6101 break;
6103 /* If no free slot found, maybe enlarge c->images. */
6104 if (i == c->used && c->used == c->size)
6106 c->size *= 2;
6107 c->images = (struct image **) xrealloc (c->images,
6108 c->size * sizeof *c->images);
6111 /* Add IMG to c->images, and assign IMG an id. */
6112 c->images[i] = img;
6113 img->id = i;
6114 if (i == c->used)
6115 ++c->used;
6117 /* Add IMG to the cache's hash table. */
6118 i = img->hash % IMAGE_CACHE_BUCKETS_SIZE;
6119 img->next = c->buckets[i];
6120 if (img->next)
6121 img->next->prev = img;
6122 img->prev = NULL;
6123 c->buckets[i] = img;
6127 /* Call FN on every image in the image cache of frame F. Used to mark
6128 Lisp Objects in the image cache. */
6130 void
6131 forall_images_in_image_cache (f, fn)
6132 struct frame *f;
6133 void (*fn) P_ ((struct image *img));
6135 if (FRAME_LIVE_P (f) && FRAME_X_P (f))
6137 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
6138 if (c)
6140 int i;
6141 for (i = 0; i < c->used; ++i)
6142 if (c->images[i])
6143 fn (c->images[i]);
6150 /***********************************************************************
6151 X support code
6152 ***********************************************************************/
6154 static int x_create_x_image_and_pixmap P_ ((struct frame *, int, int, int,
6155 XImage **, Pixmap *));
6156 static void x_destroy_x_image P_ ((XImage *));
6157 static void x_put_x_image P_ ((struct frame *, XImage *, Pixmap, int, int));
6160 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
6161 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
6162 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
6163 via xmalloc. Print error messages via image_error if an error
6164 occurs. Value is non-zero if successful. */
6166 static int
6167 x_create_x_image_and_pixmap (f, width, height, depth, ximg, pixmap)
6168 struct frame *f;
6169 int width, height, depth;
6170 XImage **ximg;
6171 Pixmap *pixmap;
6173 Display *display = FRAME_X_DISPLAY (f);
6174 Screen *screen = FRAME_X_SCREEN (f);
6175 Window window = FRAME_X_WINDOW (f);
6177 xassert (interrupt_input_blocked);
6179 if (depth <= 0)
6180 depth = DefaultDepthOfScreen (screen);
6181 *ximg = XCreateImage (display, DefaultVisualOfScreen (screen),
6182 depth, ZPixmap, 0, NULL, width, height,
6183 depth > 16 ? 32 : depth > 8 ? 16 : 8, 0);
6184 if (*ximg == NULL)
6186 image_error ("Unable to allocate X image", Qnil, Qnil);
6187 return 0;
6190 /* Allocate image raster. */
6191 (*ximg)->data = (char *) xmalloc ((*ximg)->bytes_per_line * height);
6193 /* Allocate a pixmap of the same size. */
6194 *pixmap = XCreatePixmap (display, window, width, height, depth);
6195 if (*pixmap == None)
6197 x_destroy_x_image (*ximg);
6198 *ximg = NULL;
6199 image_error ("Unable to create X pixmap", Qnil, Qnil);
6200 return 0;
6203 return 1;
6207 /* Destroy XImage XIMG. Free XIMG->data. */
6209 static void
6210 x_destroy_x_image (ximg)
6211 XImage *ximg;
6213 xassert (interrupt_input_blocked);
6214 if (ximg)
6216 xfree (ximg->data);
6217 ximg->data = NULL;
6218 XDestroyImage (ximg);
6223 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
6224 are width and height of both the image and pixmap. */
6226 static void
6227 x_put_x_image (f, ximg, pixmap, width, height)
6228 struct frame *f;
6229 XImage *ximg;
6230 Pixmap pixmap;
6232 GC gc;
6234 xassert (interrupt_input_blocked);
6235 gc = XCreateGC (FRAME_X_DISPLAY (f), pixmap, 0, NULL);
6236 XPutImage (FRAME_X_DISPLAY (f), pixmap, gc, ximg, 0, 0, 0, 0, width, height);
6237 XFreeGC (FRAME_X_DISPLAY (f), gc);
6242 /***********************************************************************
6243 File Handling
6244 ***********************************************************************/
6246 static Lisp_Object x_find_image_file P_ ((Lisp_Object));
6247 static char *slurp_file P_ ((char *, int *));
6250 /* Find image file FILE. Look in data-directory, then
6251 x-bitmap-file-path. Value is the full name of the file found, or
6252 nil if not found. */
6254 static Lisp_Object
6255 x_find_image_file (file)
6256 Lisp_Object file;
6258 Lisp_Object file_found, search_path;
6259 struct gcpro gcpro1, gcpro2;
6260 int fd;
6262 file_found = Qnil;
6263 search_path = Fcons (Vdata_directory, Vx_bitmap_file_path);
6264 GCPRO2 (file_found, search_path);
6266 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
6267 fd = openp (search_path, file, "", &file_found, 0);
6269 if (fd == -1)
6270 file_found = Qnil;
6271 else
6272 close (fd);
6274 UNGCPRO;
6275 return file_found;
6279 /* Read FILE into memory. Value is a pointer to a buffer allocated
6280 with xmalloc holding FILE's contents. Value is null if an error
6281 occurred. *SIZE is set to the size of the file. */
6283 static char *
6284 slurp_file (file, size)
6285 char *file;
6286 int *size;
6288 FILE *fp = NULL;
6289 char *buf = NULL;
6290 struct stat st;
6292 if (stat (file, &st) == 0
6293 && (fp = fopen (file, "r")) != NULL
6294 && (buf = (char *) xmalloc (st.st_size),
6295 fread (buf, 1, st.st_size, fp) == st.st_size))
6297 *size = st.st_size;
6298 fclose (fp);
6300 else
6302 if (fp)
6303 fclose (fp);
6304 if (buf)
6306 xfree (buf);
6307 buf = NULL;
6311 return buf;
6316 /***********************************************************************
6317 XBM images
6318 ***********************************************************************/
6320 static int xbm_scan P_ ((char **, char *, char *, int *));
6321 static int xbm_load P_ ((struct frame *f, struct image *img));
6322 static int xbm_load_image P_ ((struct frame *f, struct image *img,
6323 char *, char *));
6324 static int xbm_image_p P_ ((Lisp_Object object));
6325 static int xbm_read_bitmap_data P_ ((char *, char *, int *, int *,
6326 unsigned char **));
6327 static int xbm_file_p P_ ((Lisp_Object));
6330 /* Indices of image specification fields in xbm_format, below. */
6332 enum xbm_keyword_index
6334 XBM_TYPE,
6335 XBM_FILE,
6336 XBM_WIDTH,
6337 XBM_HEIGHT,
6338 XBM_DATA,
6339 XBM_FOREGROUND,
6340 XBM_BACKGROUND,
6341 XBM_ASCENT,
6342 XBM_MARGIN,
6343 XBM_RELIEF,
6344 XBM_ALGORITHM,
6345 XBM_HEURISTIC_MASK,
6346 XBM_MASK,
6347 XBM_LAST
6350 /* Vector of image_keyword structures describing the format
6351 of valid XBM image specifications. */
6353 static struct image_keyword xbm_format[XBM_LAST] =
6355 {":type", IMAGE_SYMBOL_VALUE, 1},
6356 {":file", IMAGE_STRING_VALUE, 0},
6357 {":width", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6358 {":height", IMAGE_POSITIVE_INTEGER_VALUE, 0},
6359 {":data", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6360 {":foreground", IMAGE_STRING_VALUE, 0},
6361 {":background", IMAGE_STRING_VALUE, 0},
6362 {":ascent", IMAGE_ASCENT_VALUE, 0},
6363 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6364 {":relief", IMAGE_INTEGER_VALUE, 0},
6365 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6366 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6367 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
6370 /* Structure describing the image type XBM. */
6372 static struct image_type xbm_type =
6374 &Qxbm,
6375 xbm_image_p,
6376 xbm_load,
6377 x_clear_image,
6378 NULL
6381 /* Tokens returned from xbm_scan. */
6383 enum xbm_token
6385 XBM_TK_IDENT = 256,
6386 XBM_TK_NUMBER
6390 /* Return non-zero if OBJECT is a valid XBM-type image specification.
6391 A valid specification is a list starting with the symbol `image'
6392 The rest of the list is a property list which must contain an
6393 entry `:type xbm..
6395 If the specification specifies a file to load, it must contain
6396 an entry `:file FILENAME' where FILENAME is a string.
6398 If the specification is for a bitmap loaded from memory it must
6399 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
6400 WIDTH and HEIGHT are integers > 0. DATA may be:
6402 1. a string large enough to hold the bitmap data, i.e. it must
6403 have a size >= (WIDTH + 7) / 8 * HEIGHT
6405 2. a bool-vector of size >= WIDTH * HEIGHT
6407 3. a vector of strings or bool-vectors, one for each line of the
6408 bitmap.
6410 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
6411 may not be specified in this case because they are defined in the
6412 XBM file.
6414 Both the file and data forms may contain the additional entries
6415 `:background COLOR' and `:foreground COLOR'. If not present,
6416 foreground and background of the frame on which the image is
6417 displayed is used. */
6419 static int
6420 xbm_image_p (object)
6421 Lisp_Object object;
6423 struct image_keyword kw[XBM_LAST];
6425 bcopy (xbm_format, kw, sizeof kw);
6426 if (!parse_image_spec (object, kw, XBM_LAST, Qxbm))
6427 return 0;
6429 xassert (EQ (kw[XBM_TYPE].value, Qxbm));
6431 if (kw[XBM_FILE].count)
6433 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_DATA].count)
6434 return 0;
6436 else if (kw[XBM_DATA].count && xbm_file_p (kw[XBM_DATA].value))
6438 /* In-memory XBM file. */
6439 if (kw[XBM_WIDTH].count || kw[XBM_HEIGHT].count || kw[XBM_FILE].count)
6440 return 0;
6442 else
6444 Lisp_Object data;
6445 int width, height;
6447 /* Entries for `:width', `:height' and `:data' must be present. */
6448 if (!kw[XBM_WIDTH].count
6449 || !kw[XBM_HEIGHT].count
6450 || !kw[XBM_DATA].count)
6451 return 0;
6453 data = kw[XBM_DATA].value;
6454 width = XFASTINT (kw[XBM_WIDTH].value);
6455 height = XFASTINT (kw[XBM_HEIGHT].value);
6457 /* Check type of data, and width and height against contents of
6458 data. */
6459 if (VECTORP (data))
6461 int i;
6463 /* Number of elements of the vector must be >= height. */
6464 if (XVECTOR (data)->size < height)
6465 return 0;
6467 /* Each string or bool-vector in data must be large enough
6468 for one line of the image. */
6469 for (i = 0; i < height; ++i)
6471 Lisp_Object elt = XVECTOR (data)->contents[i];
6473 if (STRINGP (elt))
6475 if (XSTRING (elt)->size
6476 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR)
6477 return 0;
6479 else if (BOOL_VECTOR_P (elt))
6481 if (XBOOL_VECTOR (elt)->size < width)
6482 return 0;
6484 else
6485 return 0;
6488 else if (STRINGP (data))
6490 if (XSTRING (data)->size
6491 < (width + BITS_PER_CHAR - 1) / BITS_PER_CHAR * height)
6492 return 0;
6494 else if (BOOL_VECTOR_P (data))
6496 if (XBOOL_VECTOR (data)->size < width * height)
6497 return 0;
6499 else
6500 return 0;
6503 return 1;
6507 /* Scan a bitmap file. FP is the stream to read from. Value is
6508 either an enumerator from enum xbm_token, or a character for a
6509 single-character token, or 0 at end of file. If scanning an
6510 identifier, store the lexeme of the identifier in SVAL. If
6511 scanning a number, store its value in *IVAL. */
6513 static int
6514 xbm_scan (s, end, sval, ival)
6515 char **s, *end;
6516 char *sval;
6517 int *ival;
6519 int c;
6521 loop:
6523 /* Skip white space. */
6524 while (*s < end && (c = *(*s)++, isspace (c)))
6527 if (*s >= end)
6528 c = 0;
6529 else if (isdigit (c))
6531 int value = 0, digit;
6533 if (c == '0' && *s < end)
6535 c = *(*s)++;
6536 if (c == 'x' || c == 'X')
6538 while (*s < end)
6540 c = *(*s)++;
6541 if (isdigit (c))
6542 digit = c - '0';
6543 else if (c >= 'a' && c <= 'f')
6544 digit = c - 'a' + 10;
6545 else if (c >= 'A' && c <= 'F')
6546 digit = c - 'A' + 10;
6547 else
6548 break;
6549 value = 16 * value + digit;
6552 else if (isdigit (c))
6554 value = c - '0';
6555 while (*s < end
6556 && (c = *(*s)++, isdigit (c)))
6557 value = 8 * value + c - '0';
6560 else
6562 value = c - '0';
6563 while (*s < end
6564 && (c = *(*s)++, isdigit (c)))
6565 value = 10 * value + c - '0';
6568 if (*s < end)
6569 *s = *s - 1;
6570 *ival = value;
6571 c = XBM_TK_NUMBER;
6573 else if (isalpha (c) || c == '_')
6575 *sval++ = c;
6576 while (*s < end
6577 && (c = *(*s)++, (isalnum (c) || c == '_')))
6578 *sval++ = c;
6579 *sval = 0;
6580 if (*s < end)
6581 *s = *s - 1;
6582 c = XBM_TK_IDENT;
6584 else if (c == '/' && **s == '*')
6586 /* C-style comment. */
6587 ++*s;
6588 while (**s && (**s != '*' || *(*s + 1) != '/'))
6589 ++*s;
6590 if (**s)
6592 *s += 2;
6593 goto loop;
6597 return c;
6601 /* Replacement for XReadBitmapFileData which isn't available under old
6602 X versions. CONTENTS is a pointer to a buffer to parse; END is the
6603 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
6604 the image. Return in *DATA the bitmap data allocated with xmalloc.
6605 Value is non-zero if successful. DATA null means just test if
6606 CONTENTS looks like an in-memory XBM file. */
6608 static int
6609 xbm_read_bitmap_data (contents, end, width, height, data)
6610 char *contents, *end;
6611 int *width, *height;
6612 unsigned char **data;
6614 char *s = contents;
6615 char buffer[BUFSIZ];
6616 int padding_p = 0;
6617 int v10 = 0;
6618 int bytes_per_line, i, nbytes;
6619 unsigned char *p;
6620 int value;
6621 int LA1;
6623 #define match() \
6624 LA1 = xbm_scan (&s, end, buffer, &value)
6626 #define expect(TOKEN) \
6627 if (LA1 != (TOKEN)) \
6628 goto failure; \
6629 else \
6630 match ()
6632 #define expect_ident(IDENT) \
6633 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
6634 match (); \
6635 else \
6636 goto failure
6638 *width = *height = -1;
6639 if (data)
6640 *data = NULL;
6641 LA1 = xbm_scan (&s, end, buffer, &value);
6643 /* Parse defines for width, height and hot-spots. */
6644 while (LA1 == '#')
6646 match ();
6647 expect_ident ("define");
6648 expect (XBM_TK_IDENT);
6650 if (LA1 == XBM_TK_NUMBER);
6652 char *p = strrchr (buffer, '_');
6653 p = p ? p + 1 : buffer;
6654 if (strcmp (p, "width") == 0)
6655 *width = value;
6656 else if (strcmp (p, "height") == 0)
6657 *height = value;
6659 expect (XBM_TK_NUMBER);
6662 if (*width < 0 || *height < 0)
6663 goto failure;
6664 else if (data == NULL)
6665 goto success;
6667 /* Parse bits. Must start with `static'. */
6668 expect_ident ("static");
6669 if (LA1 == XBM_TK_IDENT)
6671 if (strcmp (buffer, "unsigned") == 0)
6673 match ();
6674 expect_ident ("char");
6676 else if (strcmp (buffer, "short") == 0)
6678 match ();
6679 v10 = 1;
6680 if (*width % 16 && *width % 16 < 9)
6681 padding_p = 1;
6683 else if (strcmp (buffer, "char") == 0)
6684 match ();
6685 else
6686 goto failure;
6688 else
6689 goto failure;
6691 expect (XBM_TK_IDENT);
6692 expect ('[');
6693 expect (']');
6694 expect ('=');
6695 expect ('{');
6697 bytes_per_line = (*width + 7) / 8 + padding_p;
6698 nbytes = bytes_per_line * *height;
6699 p = *data = (char *) xmalloc (nbytes);
6701 if (v10)
6703 for (i = 0; i < nbytes; i += 2)
6705 int val = value;
6706 expect (XBM_TK_NUMBER);
6708 *p++ = val;
6709 if (!padding_p || ((i + 2) % bytes_per_line))
6710 *p++ = value >> 8;
6712 if (LA1 == ',' || LA1 == '}')
6713 match ();
6714 else
6715 goto failure;
6718 else
6720 for (i = 0; i < nbytes; ++i)
6722 int val = value;
6723 expect (XBM_TK_NUMBER);
6725 *p++ = val;
6727 if (LA1 == ',' || LA1 == '}')
6728 match ();
6729 else
6730 goto failure;
6734 success:
6735 return 1;
6737 failure:
6739 if (data && *data)
6741 xfree (*data);
6742 *data = NULL;
6744 return 0;
6746 #undef match
6747 #undef expect
6748 #undef expect_ident
6752 /* Load XBM image IMG which will be displayed on frame F from buffer
6753 CONTENTS. END is the end of the buffer. Value is non-zero if
6754 successful. */
6756 static int
6757 xbm_load_image (f, img, contents, end)
6758 struct frame *f;
6759 struct image *img;
6760 char *contents, *end;
6762 int rc;
6763 unsigned char *data;
6764 int success_p = 0;
6766 rc = xbm_read_bitmap_data (contents, end, &img->width, &img->height, &data);
6767 if (rc)
6769 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6770 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6771 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6772 Lisp_Object value;
6774 xassert (img->width > 0 && img->height > 0);
6776 /* Get foreground and background colors, maybe allocate colors. */
6777 value = image_spec_value (img->spec, QCforeground, NULL);
6778 if (!NILP (value))
6779 foreground = x_alloc_image_color (f, img, value, foreground);
6781 value = image_spec_value (img->spec, QCbackground, NULL);
6782 if (!NILP (value))
6783 background = x_alloc_image_color (f, img, value, background);
6785 img->pixmap
6786 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6787 FRAME_X_WINDOW (f),
6788 data,
6789 img->width, img->height,
6790 foreground, background,
6791 depth);
6792 xfree (data);
6794 if (img->pixmap == None)
6796 x_clear_image (f, img);
6797 image_error ("Unable to create X pixmap for `%s'", img->spec, Qnil);
6799 else
6800 success_p = 1;
6802 else
6803 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6805 return success_p;
6809 /* Value is non-zero if DATA looks like an in-memory XBM file. */
6811 static int
6812 xbm_file_p (data)
6813 Lisp_Object data;
6815 int w, h;
6816 return (STRINGP (data)
6817 && xbm_read_bitmap_data (XSTRING (data)->data,
6818 (XSTRING (data)->data
6819 + STRING_BYTES (XSTRING (data))),
6820 &w, &h, NULL));
6824 /* Fill image IMG which is used on frame F with pixmap data. Value is
6825 non-zero if successful. */
6827 static int
6828 xbm_load (f, img)
6829 struct frame *f;
6830 struct image *img;
6832 int success_p = 0;
6833 Lisp_Object file_name;
6835 xassert (xbm_image_p (img->spec));
6837 /* If IMG->spec specifies a file name, create a non-file spec from it. */
6838 file_name = image_spec_value (img->spec, QCfile, NULL);
6839 if (STRINGP (file_name))
6841 Lisp_Object file;
6842 char *contents;
6843 int size;
6844 struct gcpro gcpro1;
6846 file = x_find_image_file (file_name);
6847 GCPRO1 (file);
6848 if (!STRINGP (file))
6850 image_error ("Cannot find image file `%s'", file_name, Qnil);
6851 UNGCPRO;
6852 return 0;
6855 contents = slurp_file (XSTRING (file)->data, &size);
6856 if (contents == NULL)
6858 image_error ("Error loading XBM image `%s'", img->spec, Qnil);
6859 UNGCPRO;
6860 return 0;
6863 success_p = xbm_load_image (f, img, contents, contents + size);
6864 UNGCPRO;
6866 else
6868 struct image_keyword fmt[XBM_LAST];
6869 Lisp_Object data;
6870 int depth;
6871 unsigned long foreground = FRAME_FOREGROUND_PIXEL (f);
6872 unsigned long background = FRAME_BACKGROUND_PIXEL (f);
6873 char *bits;
6874 int parsed_p;
6875 int in_memory_file_p = 0;
6877 /* See if data looks like an in-memory XBM file. */
6878 data = image_spec_value (img->spec, QCdata, NULL);
6879 in_memory_file_p = xbm_file_p (data);
6881 /* Parse the image specification. */
6882 bcopy (xbm_format, fmt, sizeof fmt);
6883 parsed_p = parse_image_spec (img->spec, fmt, XBM_LAST, Qxbm);
6884 xassert (parsed_p);
6886 /* Get specified width, and height. */
6887 if (!in_memory_file_p)
6889 img->width = XFASTINT (fmt[XBM_WIDTH].value);
6890 img->height = XFASTINT (fmt[XBM_HEIGHT].value);
6891 xassert (img->width > 0 && img->height > 0);
6894 /* Get foreground and background colors, maybe allocate colors. */
6895 if (fmt[XBM_FOREGROUND].count)
6896 foreground = x_alloc_image_color (f, img, fmt[XBM_FOREGROUND].value,
6897 foreground);
6898 if (fmt[XBM_BACKGROUND].count)
6899 background = x_alloc_image_color (f, img, fmt[XBM_BACKGROUND].value,
6900 background);
6902 if (in_memory_file_p)
6903 success_p = xbm_load_image (f, img, XSTRING (data)->data,
6904 (XSTRING (data)->data
6905 + STRING_BYTES (XSTRING (data))));
6906 else
6908 if (VECTORP (data))
6910 int i;
6911 char *p;
6912 int nbytes = (img->width + BITS_PER_CHAR - 1) / BITS_PER_CHAR;
6914 p = bits = (char *) alloca (nbytes * img->height);
6915 for (i = 0; i < img->height; ++i, p += nbytes)
6917 Lisp_Object line = XVECTOR (data)->contents[i];
6918 if (STRINGP (line))
6919 bcopy (XSTRING (line)->data, p, nbytes);
6920 else
6921 bcopy (XBOOL_VECTOR (line)->data, p, nbytes);
6924 else if (STRINGP (data))
6925 bits = XSTRING (data)->data;
6926 else
6927 bits = XBOOL_VECTOR (data)->data;
6929 /* Create the pixmap. */
6930 depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
6931 img->pixmap
6932 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f),
6933 FRAME_X_WINDOW (f),
6934 bits,
6935 img->width, img->height,
6936 foreground, background,
6937 depth);
6938 if (img->pixmap)
6939 success_p = 1;
6940 else
6942 image_error ("Unable to create pixmap for XBM image `%s'",
6943 img->spec, Qnil);
6944 x_clear_image (f, img);
6949 return success_p;
6954 /***********************************************************************
6955 XPM images
6956 ***********************************************************************/
6958 #if HAVE_XPM
6960 static int xpm_image_p P_ ((Lisp_Object object));
6961 static int xpm_load P_ ((struct frame *f, struct image *img));
6962 static int xpm_valid_color_symbols_p P_ ((Lisp_Object));
6964 #include "X11/xpm.h"
6966 /* The symbol `xpm' identifying XPM-format images. */
6968 Lisp_Object Qxpm;
6970 /* Indices of image specification fields in xpm_format, below. */
6972 enum xpm_keyword_index
6974 XPM_TYPE,
6975 XPM_FILE,
6976 XPM_DATA,
6977 XPM_ASCENT,
6978 XPM_MARGIN,
6979 XPM_RELIEF,
6980 XPM_ALGORITHM,
6981 XPM_HEURISTIC_MASK,
6982 XPM_MASK,
6983 XPM_COLOR_SYMBOLS,
6984 XPM_LAST
6987 /* Vector of image_keyword structures describing the format
6988 of valid XPM image specifications. */
6990 static struct image_keyword xpm_format[XPM_LAST] =
6992 {":type", IMAGE_SYMBOL_VALUE, 1},
6993 {":file", IMAGE_STRING_VALUE, 0},
6994 {":data", IMAGE_STRING_VALUE, 0},
6995 {":ascent", IMAGE_ASCENT_VALUE, 0},
6996 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
6997 {":relief", IMAGE_INTEGER_VALUE, 0},
6998 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
6999 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7000 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
7001 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
7004 /* Structure describing the image type XBM. */
7006 static struct image_type xpm_type =
7008 &Qxpm,
7009 xpm_image_p,
7010 xpm_load,
7011 x_clear_image,
7012 NULL
7016 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
7017 functions for allocating image colors. Our own functions handle
7018 color allocation failures more gracefully than the ones on the XPM
7019 lib. */
7021 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
7022 #define ALLOC_XPM_COLORS
7023 #endif
7025 #ifdef ALLOC_XPM_COLORS
7027 static void xpm_init_color_cache P_ ((struct frame *, XpmAttributes *));
7028 static void xpm_free_color_cache P_ ((void));
7029 static int xpm_lookup_color P_ ((struct frame *, char *, XColor *));
7030 static int xpm_color_bucket P_ ((char *));
7031 static struct xpm_cached_color *xpm_cache_color P_ ((struct frame *, char *,
7032 XColor *, int));
7034 /* An entry in a hash table used to cache color definitions of named
7035 colors. This cache is necessary to speed up XPM image loading in
7036 case we do color allocations ourselves. Without it, we would need
7037 a call to XParseColor per pixel in the image. */
7039 struct xpm_cached_color
7041 /* Next in collision chain. */
7042 struct xpm_cached_color *next;
7044 /* Color definition (RGB and pixel color). */
7045 XColor color;
7047 /* Color name. */
7048 char name[1];
7051 /* The hash table used for the color cache, and its bucket vector
7052 size. */
7054 #define XPM_COLOR_CACHE_BUCKETS 1001
7055 struct xpm_cached_color **xpm_color_cache;
7057 /* Initialize the color cache. */
7059 static void
7060 xpm_init_color_cache (f, attrs)
7061 struct frame *f;
7062 XpmAttributes *attrs;
7064 size_t nbytes = XPM_COLOR_CACHE_BUCKETS * sizeof *xpm_color_cache;
7065 xpm_color_cache = (struct xpm_cached_color **) xmalloc (nbytes);
7066 memset (xpm_color_cache, 0, nbytes);
7067 init_color_table ();
7069 if (attrs->valuemask & XpmColorSymbols)
7071 int i;
7072 XColor color;
7074 for (i = 0; i < attrs->numsymbols; ++i)
7075 if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7076 attrs->colorsymbols[i].value, &color))
7078 color.pixel = lookup_rgb_color (f, color.red, color.green,
7079 color.blue);
7080 xpm_cache_color (f, attrs->colorsymbols[i].name, &color, -1);
7086 /* Free the color cache. */
7088 static void
7089 xpm_free_color_cache ()
7091 struct xpm_cached_color *p, *next;
7092 int i;
7094 for (i = 0; i < XPM_COLOR_CACHE_BUCKETS; ++i)
7095 for (p = xpm_color_cache[i]; p; p = next)
7097 next = p->next;
7098 xfree (p);
7101 xfree (xpm_color_cache);
7102 xpm_color_cache = NULL;
7103 free_color_table ();
7107 /* Return the bucket index for color named COLOR_NAME in the color
7108 cache. */
7110 static int
7111 xpm_color_bucket (color_name)
7112 char *color_name;
7114 unsigned h = 0;
7115 char *s;
7117 for (s = color_name; *s; ++s)
7118 h = (h << 2) ^ *s;
7119 return h %= XPM_COLOR_CACHE_BUCKETS;
7123 /* On frame F, cache values COLOR for color with name COLOR_NAME.
7124 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
7125 entry added. */
7127 static struct xpm_cached_color *
7128 xpm_cache_color (f, color_name, color, bucket)
7129 struct frame *f;
7130 char *color_name;
7131 XColor *color;
7132 int bucket;
7134 size_t nbytes;
7135 struct xpm_cached_color *p;
7137 if (bucket < 0)
7138 bucket = xpm_color_bucket (color_name);
7140 nbytes = sizeof *p + strlen (color_name);
7141 p = (struct xpm_cached_color *) xmalloc (nbytes);
7142 strcpy (p->name, color_name);
7143 p->color = *color;
7144 p->next = xpm_color_cache[bucket];
7145 xpm_color_cache[bucket] = p;
7146 return p;
7150 /* Look up color COLOR_NAME for frame F in the color cache. If found,
7151 return the cached definition in *COLOR. Otherwise, make a new
7152 entry in the cache and allocate the color. Value is zero if color
7153 allocation failed. */
7155 static int
7156 xpm_lookup_color (f, color_name, color)
7157 struct frame *f;
7158 char *color_name;
7159 XColor *color;
7161 struct xpm_cached_color *p;
7162 int h = xpm_color_bucket (color_name);
7164 for (p = xpm_color_cache[h]; p; p = p->next)
7165 if (strcmp (p->name, color_name) == 0)
7166 break;
7168 if (p != NULL)
7169 *color = p->color;
7170 else if (XParseColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
7171 color_name, color))
7173 color->pixel = lookup_rgb_color (f, color->red, color->green,
7174 color->blue);
7175 p = xpm_cache_color (f, color_name, color, h);
7178 return p != NULL;
7182 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
7183 CLOSURE is a pointer to the frame on which we allocate the
7184 color. Return in *COLOR the allocated color. Value is non-zero
7185 if successful. */
7187 static int
7188 xpm_alloc_color (dpy, cmap, color_name, color, closure)
7189 Display *dpy;
7190 Colormap cmap;
7191 char *color_name;
7192 XColor *color;
7193 void *closure;
7195 return xpm_lookup_color ((struct frame *) closure, color_name, color);
7199 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
7200 is a pointer to the frame on which we allocate the color. Value is
7201 non-zero if successful. */
7203 static int
7204 xpm_free_colors (dpy, cmap, pixels, npixels, closure)
7205 Display *dpy;
7206 Colormap cmap;
7207 Pixel *pixels;
7208 int npixels;
7209 void *closure;
7211 return 1;
7214 #endif /* ALLOC_XPM_COLORS */
7217 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
7218 for XPM images. Such a list must consist of conses whose car and
7219 cdr are strings. */
7221 static int
7222 xpm_valid_color_symbols_p (color_symbols)
7223 Lisp_Object color_symbols;
7225 while (CONSP (color_symbols))
7227 Lisp_Object sym = XCAR (color_symbols);
7228 if (!CONSP (sym)
7229 || !STRINGP (XCAR (sym))
7230 || !STRINGP (XCDR (sym)))
7231 break;
7232 color_symbols = XCDR (color_symbols);
7235 return NILP (color_symbols);
7239 /* Value is non-zero if OBJECT is a valid XPM image specification. */
7241 static int
7242 xpm_image_p (object)
7243 Lisp_Object object;
7245 struct image_keyword fmt[XPM_LAST];
7246 bcopy (xpm_format, fmt, sizeof fmt);
7247 return (parse_image_spec (object, fmt, XPM_LAST, Qxpm)
7248 /* Either `:file' or `:data' must be present. */
7249 && fmt[XPM_FILE].count + fmt[XPM_DATA].count == 1
7250 /* Either no `:color-symbols' or it's a list of conses
7251 whose car and cdr are strings. */
7252 && (fmt[XPM_COLOR_SYMBOLS].count == 0
7253 || xpm_valid_color_symbols_p (fmt[XPM_COLOR_SYMBOLS].value)));
7257 /* Load image IMG which will be displayed on frame F. Value is
7258 non-zero if successful. */
7260 static int
7261 xpm_load (f, img)
7262 struct frame *f;
7263 struct image *img;
7265 int rc;
7266 XpmAttributes attrs;
7267 Lisp_Object specified_file, color_symbols;
7269 /* Configure the XPM lib. Use the visual of frame F. Allocate
7270 close colors. Return colors allocated. */
7271 bzero (&attrs, sizeof attrs);
7272 attrs.visual = FRAME_X_VISUAL (f);
7273 attrs.colormap = FRAME_X_COLORMAP (f);
7274 attrs.valuemask |= XpmVisual;
7275 attrs.valuemask |= XpmColormap;
7277 #ifdef ALLOC_XPM_COLORS
7278 /* Allocate colors with our own functions which handle
7279 failing color allocation more gracefully. */
7280 attrs.color_closure = f;
7281 attrs.alloc_color = xpm_alloc_color;
7282 attrs.free_colors = xpm_free_colors;
7283 attrs.valuemask |= XpmAllocColor | XpmFreeColors | XpmColorClosure;
7284 #else /* not ALLOC_XPM_COLORS */
7285 /* Let the XPM lib allocate colors. */
7286 attrs.valuemask |= XpmReturnAllocPixels;
7287 #ifdef XpmAllocCloseColors
7288 attrs.alloc_close_colors = 1;
7289 attrs.valuemask |= XpmAllocCloseColors;
7290 #else /* not XpmAllocCloseColors */
7291 attrs.closeness = 600;
7292 attrs.valuemask |= XpmCloseness;
7293 #endif /* not XpmAllocCloseColors */
7294 #endif /* ALLOC_XPM_COLORS */
7296 /* If image specification contains symbolic color definitions, add
7297 these to `attrs'. */
7298 color_symbols = image_spec_value (img->spec, QCcolor_symbols, NULL);
7299 if (CONSP (color_symbols))
7301 Lisp_Object tail;
7302 XpmColorSymbol *xpm_syms;
7303 int i, size;
7305 attrs.valuemask |= XpmColorSymbols;
7307 /* Count number of symbols. */
7308 attrs.numsymbols = 0;
7309 for (tail = color_symbols; CONSP (tail); tail = XCDR (tail))
7310 ++attrs.numsymbols;
7312 /* Allocate an XpmColorSymbol array. */
7313 size = attrs.numsymbols * sizeof *xpm_syms;
7314 xpm_syms = (XpmColorSymbol *) alloca (size);
7315 bzero (xpm_syms, size);
7316 attrs.colorsymbols = xpm_syms;
7318 /* Fill the color symbol array. */
7319 for (tail = color_symbols, i = 0;
7320 CONSP (tail);
7321 ++i, tail = XCDR (tail))
7323 Lisp_Object name = XCAR (XCAR (tail));
7324 Lisp_Object color = XCDR (XCAR (tail));
7325 xpm_syms[i].name = (char *) alloca (XSTRING (name)->size + 1);
7326 strcpy (xpm_syms[i].name, XSTRING (name)->data);
7327 xpm_syms[i].value = (char *) alloca (XSTRING (color)->size + 1);
7328 strcpy (xpm_syms[i].value, XSTRING (color)->data);
7332 /* Create a pixmap for the image, either from a file, or from a
7333 string buffer containing data in the same format as an XPM file. */
7334 #ifdef ALLOC_XPM_COLORS
7335 xpm_init_color_cache (f, &attrs);
7336 #endif
7338 specified_file = image_spec_value (img->spec, QCfile, NULL);
7339 if (STRINGP (specified_file))
7341 Lisp_Object file = x_find_image_file (specified_file);
7342 if (!STRINGP (file))
7344 image_error ("Cannot find image file `%s'", specified_file, Qnil);
7345 return 0;
7348 rc = XpmReadFileToPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7349 XSTRING (file)->data, &img->pixmap, &img->mask,
7350 &attrs);
7352 else
7354 Lisp_Object buffer = image_spec_value (img->spec, QCdata, NULL);
7355 rc = XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7356 XSTRING (buffer)->data,
7357 &img->pixmap, &img->mask,
7358 &attrs);
7361 if (rc == XpmSuccess)
7363 #ifdef ALLOC_XPM_COLORS
7364 img->colors = colors_in_color_table (&img->ncolors);
7365 #else /* not ALLOC_XPM_COLORS */
7366 int i;
7368 img->ncolors = attrs.nalloc_pixels;
7369 img->colors = (unsigned long *) xmalloc (img->ncolors
7370 * sizeof *img->colors);
7371 for (i = 0; i < attrs.nalloc_pixels; ++i)
7373 img->colors[i] = attrs.alloc_pixels[i];
7374 #ifdef DEBUG_X_COLORS
7375 register_color (img->colors[i]);
7376 #endif
7378 #endif /* not ALLOC_XPM_COLORS */
7380 img->width = attrs.width;
7381 img->height = attrs.height;
7382 xassert (img->width > 0 && img->height > 0);
7384 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
7385 XpmFreeAttributes (&attrs);
7387 else
7389 switch (rc)
7391 case XpmOpenFailed:
7392 image_error ("Error opening XPM file (%s)", img->spec, Qnil);
7393 break;
7395 case XpmFileInvalid:
7396 image_error ("Invalid XPM file (%s)", img->spec, Qnil);
7397 break;
7399 case XpmNoMemory:
7400 image_error ("Out of memory (%s)", img->spec, Qnil);
7401 break;
7403 case XpmColorFailed:
7404 image_error ("Color allocation error (%s)", img->spec, Qnil);
7405 break;
7407 default:
7408 image_error ("Unknown error (%s)", img->spec, Qnil);
7409 break;
7413 #ifdef ALLOC_XPM_COLORS
7414 xpm_free_color_cache ();
7415 #endif
7416 return rc == XpmSuccess;
7419 #endif /* HAVE_XPM != 0 */
7422 /***********************************************************************
7423 Color table
7424 ***********************************************************************/
7426 /* An entry in the color table mapping an RGB color to a pixel color. */
7428 struct ct_color
7430 int r, g, b;
7431 unsigned long pixel;
7433 /* Next in color table collision list. */
7434 struct ct_color *next;
7437 /* The bucket vector size to use. Must be prime. */
7439 #define CT_SIZE 101
7441 /* Value is a hash of the RGB color given by R, G, and B. */
7443 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
7445 /* The color hash table. */
7447 struct ct_color **ct_table;
7449 /* Number of entries in the color table. */
7451 int ct_colors_allocated;
7453 /* Initialize the color table. */
7455 static void
7456 init_color_table ()
7458 int size = CT_SIZE * sizeof (*ct_table);
7459 ct_table = (struct ct_color **) xmalloc (size);
7460 bzero (ct_table, size);
7461 ct_colors_allocated = 0;
7465 /* Free memory associated with the color table. */
7467 static void
7468 free_color_table ()
7470 int i;
7471 struct ct_color *p, *next;
7473 for (i = 0; i < CT_SIZE; ++i)
7474 for (p = ct_table[i]; p; p = next)
7476 next = p->next;
7477 xfree (p);
7480 xfree (ct_table);
7481 ct_table = NULL;
7485 /* Value is a pixel color for RGB color R, G, B on frame F. If an
7486 entry for that color already is in the color table, return the
7487 pixel color of that entry. Otherwise, allocate a new color for R,
7488 G, B, and make an entry in the color table. */
7490 static unsigned long
7491 lookup_rgb_color (f, r, g, b)
7492 struct frame *f;
7493 int r, g, b;
7495 unsigned hash = CT_HASH_RGB (r, g, b);
7496 int i = hash % CT_SIZE;
7497 struct ct_color *p;
7499 for (p = ct_table[i]; p; p = p->next)
7500 if (p->r == r && p->g == g && p->b == b)
7501 break;
7503 if (p == NULL)
7505 XColor color;
7506 Colormap cmap;
7507 int rc;
7509 color.red = r;
7510 color.green = g;
7511 color.blue = b;
7513 cmap = FRAME_X_COLORMAP (f);
7514 rc = x_alloc_nearest_color (f, cmap, &color);
7516 if (rc)
7518 ++ct_colors_allocated;
7520 p = (struct ct_color *) xmalloc (sizeof *p);
7521 p->r = r;
7522 p->g = g;
7523 p->b = b;
7524 p->pixel = color.pixel;
7525 p->next = ct_table[i];
7526 ct_table[i] = p;
7528 else
7529 return FRAME_FOREGROUND_PIXEL (f);
7532 return p->pixel;
7536 /* Look up pixel color PIXEL which is used on frame F in the color
7537 table. If not already present, allocate it. Value is PIXEL. */
7539 static unsigned long
7540 lookup_pixel_color (f, pixel)
7541 struct frame *f;
7542 unsigned long pixel;
7544 int i = pixel % CT_SIZE;
7545 struct ct_color *p;
7547 for (p = ct_table[i]; p; p = p->next)
7548 if (p->pixel == pixel)
7549 break;
7551 if (p == NULL)
7553 XColor color;
7554 Colormap cmap;
7555 int rc;
7557 cmap = FRAME_X_COLORMAP (f);
7558 color.pixel = pixel;
7559 x_query_color (f, &color);
7560 rc = x_alloc_nearest_color (f, cmap, &color);
7562 if (rc)
7564 ++ct_colors_allocated;
7566 p = (struct ct_color *) xmalloc (sizeof *p);
7567 p->r = color.red;
7568 p->g = color.green;
7569 p->b = color.blue;
7570 p->pixel = pixel;
7571 p->next = ct_table[i];
7572 ct_table[i] = p;
7574 else
7575 return FRAME_FOREGROUND_PIXEL (f);
7578 return p->pixel;
7582 /* Value is a vector of all pixel colors contained in the color table,
7583 allocated via xmalloc. Set *N to the number of colors. */
7585 static unsigned long *
7586 colors_in_color_table (n)
7587 int *n;
7589 int i, j;
7590 struct ct_color *p;
7591 unsigned long *colors;
7593 if (ct_colors_allocated == 0)
7595 *n = 0;
7596 colors = NULL;
7598 else
7600 colors = (unsigned long *) xmalloc (ct_colors_allocated
7601 * sizeof *colors);
7602 *n = ct_colors_allocated;
7604 for (i = j = 0; i < CT_SIZE; ++i)
7605 for (p = ct_table[i]; p; p = p->next)
7606 colors[j++] = p->pixel;
7609 return colors;
7614 /***********************************************************************
7615 Algorithms
7616 ***********************************************************************/
7618 static void x_laplace_write_row P_ ((struct frame *, long *,
7619 int, XImage *, int));
7620 static void x_laplace_read_row P_ ((struct frame *, Colormap,
7621 XColor *, int, XImage *, int));
7622 static XColor *x_to_xcolors P_ ((struct frame *, struct image *, int));
7623 static void x_from_xcolors P_ ((struct frame *, struct image *, XColor *));
7624 static void x_detect_edges P_ ((struct frame *, struct image *, int[9], int));
7626 /* Non-zero means draw a cross on images having `:conversion
7627 disabled'. */
7629 int cross_disabled_images;
7631 /* Edge detection matrices for different edge-detection
7632 strategies. */
7634 static int emboss_matrix[9] = {
7635 /* x - 1 x x + 1 */
7636 2, -1, 0, /* y - 1 */
7637 -1, 0, 1, /* y */
7638 0, 1, -2 /* y + 1 */
7641 static int laplace_matrix[9] = {
7642 /* x - 1 x x + 1 */
7643 1, 0, 0, /* y - 1 */
7644 0, 0, 0, /* y */
7645 0, 0, -1 /* y + 1 */
7648 /* Value is the intensity of the color whose red/green/blue values
7649 are R, G, and B. */
7651 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
7654 /* On frame F, return an array of XColor structures describing image
7655 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
7656 non-zero means also fill the red/green/blue members of the XColor
7657 structures. Value is a pointer to the array of XColors structures,
7658 allocated with xmalloc; it must be freed by the caller. */
7660 static XColor *
7661 x_to_xcolors (f, img, rgb_p)
7662 struct frame *f;
7663 struct image *img;
7664 int rgb_p;
7666 int x, y;
7667 XColor *colors, *p;
7668 XImage *ximg;
7670 colors = (XColor *) xmalloc (img->width * img->height * sizeof *colors);
7672 /* Get the X image IMG->pixmap. */
7673 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
7674 0, 0, img->width, img->height, ~0, ZPixmap);
7676 /* Fill the `pixel' members of the XColor array. I wished there
7677 were an easy and portable way to circumvent XGetPixel. */
7678 p = colors;
7679 for (y = 0; y < img->height; ++y)
7681 XColor *row = p;
7683 for (x = 0; x < img->width; ++x, ++p)
7684 p->pixel = XGetPixel (ximg, x, y);
7686 if (rgb_p)
7687 x_query_colors (f, row, img->width);
7690 XDestroyImage (ximg);
7691 return colors;
7695 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
7696 RGB members are set. F is the frame on which this all happens.
7697 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
7699 static void
7700 x_from_xcolors (f, img, colors)
7701 struct frame *f;
7702 struct image *img;
7703 XColor *colors;
7705 int x, y;
7706 XImage *oimg;
7707 Pixmap pixmap;
7708 XColor *p;
7710 init_color_table ();
7712 x_create_x_image_and_pixmap (f, img->width, img->height, 0,
7713 &oimg, &pixmap);
7714 p = colors;
7715 for (y = 0; y < img->height; ++y)
7716 for (x = 0; x < img->width; ++x, ++p)
7718 unsigned long pixel;
7719 pixel = lookup_rgb_color (f, p->red, p->green, p->blue);
7720 XPutPixel (oimg, x, y, pixel);
7723 xfree (colors);
7724 x_clear_image_1 (f, img, 1, 0, 1);
7726 x_put_x_image (f, oimg, pixmap, img->width, img->height);
7727 x_destroy_x_image (oimg);
7728 img->pixmap = pixmap;
7729 img->colors = colors_in_color_table (&img->ncolors);
7730 free_color_table ();
7734 /* On frame F, perform edge-detection on image IMG.
7736 MATRIX is a nine-element array specifying the transformation
7737 matrix. See emboss_matrix for an example.
7739 COLOR_ADJUST is a color adjustment added to each pixel of the
7740 outgoing image. */
7742 static void
7743 x_detect_edges (f, img, matrix, color_adjust)
7744 struct frame *f;
7745 struct image *img;
7746 int matrix[9], color_adjust;
7748 XColor *colors = x_to_xcolors (f, img, 1);
7749 XColor *new, *p;
7750 int x, y, i, sum;
7752 for (i = sum = 0; i < 9; ++i)
7753 sum += abs (matrix[i]);
7755 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
7757 new = (XColor *) xmalloc (img->width * img->height * sizeof *new);
7759 for (y = 0; y < img->height; ++y)
7761 p = COLOR (new, 0, y);
7762 p->red = p->green = p->blue = 0xffff/2;
7763 p = COLOR (new, img->width - 1, y);
7764 p->red = p->green = p->blue = 0xffff/2;
7767 for (x = 1; x < img->width - 1; ++x)
7769 p = COLOR (new, x, 0);
7770 p->red = p->green = p->blue = 0xffff/2;
7771 p = COLOR (new, x, img->height - 1);
7772 p->red = p->green = p->blue = 0xffff/2;
7775 for (y = 1; y < img->height - 1; ++y)
7777 p = COLOR (new, 1, y);
7779 for (x = 1; x < img->width - 1; ++x, ++p)
7781 int r, g, b, y1, x1;
7783 r = g = b = i = 0;
7784 for (y1 = y - 1; y1 < y + 2; ++y1)
7785 for (x1 = x - 1; x1 < x + 2; ++x1, ++i)
7786 if (matrix[i])
7788 XColor *t = COLOR (colors, x1, y1);
7789 r += matrix[i] * t->red;
7790 g += matrix[i] * t->green;
7791 b += matrix[i] * t->blue;
7794 r = (r / sum + color_adjust) & 0xffff;
7795 g = (g / sum + color_adjust) & 0xffff;
7796 b = (b / sum + color_adjust) & 0xffff;
7797 p->red = p->green = p->blue = COLOR_INTENSITY (r, g, b);
7801 xfree (colors);
7802 x_from_xcolors (f, img, new);
7804 #undef COLOR
7808 /* Perform the pre-defined `emboss' edge-detection on image IMG
7809 on frame F. */
7811 static void
7812 x_emboss (f, img)
7813 struct frame *f;
7814 struct image *img;
7816 x_detect_edges (f, img, emboss_matrix, 0xffff / 2);
7820 /* Perform the pre-defined `laplace' edge-detection on image IMG
7821 on frame F. */
7823 static void
7824 x_laplace (f, img)
7825 struct frame *f;
7826 struct image *img;
7828 x_detect_edges (f, img, laplace_matrix, 45000);
7832 /* Perform edge-detection on image IMG on frame F, with specified
7833 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
7835 MATRIX must be either
7837 - a list of at least 9 numbers in row-major form
7838 - a vector of at least 9 numbers
7840 COLOR_ADJUST nil means use a default; otherwise it must be a
7841 number. */
7843 static void
7844 x_edge_detection (f, img, matrix, color_adjust)
7845 struct frame *f;
7846 struct image *img;
7847 Lisp_Object matrix, color_adjust;
7849 int i = 0;
7850 int trans[9];
7852 if (CONSP (matrix))
7854 for (i = 0;
7855 i < 9 && CONSP (matrix) && NUMBERP (XCAR (matrix));
7856 ++i, matrix = XCDR (matrix))
7857 trans[i] = XFLOATINT (XCAR (matrix));
7859 else if (VECTORP (matrix) && ASIZE (matrix) >= 9)
7861 for (i = 0; i < 9 && NUMBERP (AREF (matrix, i)); ++i)
7862 trans[i] = XFLOATINT (AREF (matrix, i));
7865 if (NILP (color_adjust))
7866 color_adjust = make_number (0xffff / 2);
7868 if (i == 9 && NUMBERP (color_adjust))
7869 x_detect_edges (f, img, trans, (int) XFLOATINT (color_adjust));
7873 /* Transform image IMG on frame F so that it looks disabled. */
7875 static void
7876 x_disable_image (f, img)
7877 struct frame *f;
7878 struct image *img;
7880 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7882 if (dpyinfo->n_planes >= 2)
7884 /* Color (or grayscale). Convert to gray, and equalize. Just
7885 drawing such images with a stipple can look very odd, so
7886 we're using this method instead. */
7887 XColor *colors = x_to_xcolors (f, img, 1);
7888 XColor *p, *end;
7889 const int h = 15000;
7890 const int l = 30000;
7892 for (p = colors, end = colors + img->width * img->height;
7893 p < end;
7894 ++p)
7896 int i = COLOR_INTENSITY (p->red, p->green, p->blue);
7897 int i2 = (0xffff - h - l) * i / 0xffff + l;
7898 p->red = p->green = p->blue = i2;
7901 x_from_xcolors (f, img, colors);
7904 /* Draw a cross over the disabled image, if we must or if we
7905 should. */
7906 if (dpyinfo->n_planes < 2 || cross_disabled_images)
7908 Display *dpy = FRAME_X_DISPLAY (f);
7909 GC gc;
7911 gc = XCreateGC (dpy, img->pixmap, 0, NULL);
7912 XSetForeground (dpy, gc, BLACK_PIX_DEFAULT (f));
7913 XDrawLine (dpy, img->pixmap, gc, 0, 0,
7914 img->width - 1, img->height - 1);
7915 XDrawLine (dpy, img->pixmap, gc, 0, img->height - 1,
7916 img->width - 1, 0);
7917 XFreeGC (dpy, gc);
7919 if (img->mask)
7921 gc = XCreateGC (dpy, img->mask, 0, NULL);
7922 XSetForeground (dpy, gc, WHITE_PIX_DEFAULT (f));
7923 XDrawLine (dpy, img->mask, gc, 0, 0,
7924 img->width - 1, img->height - 1);
7925 XDrawLine (dpy, img->mask, gc, 0, img->height - 1,
7926 img->width - 1, 0);
7927 XFreeGC (dpy, gc);
7933 /* Build a mask for image IMG which is used on frame F. FILE is the
7934 name of an image file, for error messages. HOW determines how to
7935 determine the background color of IMG. If it is a list '(R G B)',
7936 with R, G, and B being integers >= 0, take that as the color of the
7937 background. Otherwise, determine the background color of IMG
7938 heuristically. Value is non-zero if successful. */
7940 static int
7941 x_build_heuristic_mask (f, img, how)
7942 struct frame *f;
7943 struct image *img;
7944 Lisp_Object how;
7946 Display *dpy = FRAME_X_DISPLAY (f);
7947 XImage *ximg, *mask_img;
7948 int x, y, rc, look_at_corners_p;
7949 unsigned long bg = 0;
7951 if (img->mask)
7953 XFreePixmap (FRAME_X_DISPLAY (f), img->mask);
7954 img->mask = None;
7957 /* Create an image and pixmap serving as mask. */
7958 rc = x_create_x_image_and_pixmap (f, img->width, img->height, 1,
7959 &mask_img, &img->mask);
7960 if (!rc)
7961 return 0;
7963 /* Get the X image of IMG->pixmap. */
7964 ximg = XGetImage (dpy, img->pixmap, 0, 0, img->width, img->height,
7965 ~0, ZPixmap);
7967 /* Determine the background color of ximg. If HOW is `(R G B)'
7968 take that as color. Otherwise, try to determine the color
7969 heuristically. */
7970 look_at_corners_p = 1;
7972 if (CONSP (how))
7974 int rgb[3], i = 0;
7976 while (i < 3
7977 && CONSP (how)
7978 && NATNUMP (XCAR (how)))
7980 rgb[i] = XFASTINT (XCAR (how)) & 0xffff;
7981 how = XCDR (how);
7984 if (i == 3 && NILP (how))
7986 char color_name[30];
7987 XColor exact, color;
7988 Colormap cmap;
7990 sprintf (color_name, "#%04x%04x%04x", rgb[0], rgb[1], rgb[2]);
7992 cmap = FRAME_X_COLORMAP (f);
7993 if (XLookupColor (dpy, cmap, color_name, &exact, &color))
7995 bg = color.pixel;
7996 look_at_corners_p = 0;
8001 if (look_at_corners_p)
8003 unsigned long corners[4];
8004 int i, best_count;
8006 /* Get the colors at the corners of ximg. */
8007 corners[0] = XGetPixel (ximg, 0, 0);
8008 corners[1] = XGetPixel (ximg, img->width - 1, 0);
8009 corners[2] = XGetPixel (ximg, img->width - 1, img->height - 1);
8010 corners[3] = XGetPixel (ximg, 0, img->height - 1);
8012 /* Choose the most frequently found color as background. */
8013 for (i = best_count = 0; i < 4; ++i)
8015 int j, n;
8017 for (j = n = 0; j < 4; ++j)
8018 if (corners[i] == corners[j])
8019 ++n;
8021 if (n > best_count)
8022 bg = corners[i], best_count = n;
8026 /* Set all bits in mask_img to 1 whose color in ximg is different
8027 from the background color bg. */
8028 for (y = 0; y < img->height; ++y)
8029 for (x = 0; x < img->width; ++x)
8030 XPutPixel (mask_img, x, y, XGetPixel (ximg, x, y) != bg);
8032 /* Put mask_img into img->mask. */
8033 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8034 x_destroy_x_image (mask_img);
8035 XDestroyImage (ximg);
8037 return 1;
8042 /***********************************************************************
8043 PBM (mono, gray, color)
8044 ***********************************************************************/
8046 static int pbm_image_p P_ ((Lisp_Object object));
8047 static int pbm_load P_ ((struct frame *f, struct image *img));
8048 static int pbm_scan_number P_ ((unsigned char **, unsigned char *));
8050 /* The symbol `pbm' identifying images of this type. */
8052 Lisp_Object Qpbm;
8054 /* Indices of image specification fields in gs_format, below. */
8056 enum pbm_keyword_index
8058 PBM_TYPE,
8059 PBM_FILE,
8060 PBM_DATA,
8061 PBM_ASCENT,
8062 PBM_MARGIN,
8063 PBM_RELIEF,
8064 PBM_ALGORITHM,
8065 PBM_HEURISTIC_MASK,
8066 PBM_MASK,
8067 PBM_FOREGROUND,
8068 PBM_BACKGROUND,
8069 PBM_LAST
8072 /* Vector of image_keyword structures describing the format
8073 of valid user-defined image specifications. */
8075 static struct image_keyword pbm_format[PBM_LAST] =
8077 {":type", IMAGE_SYMBOL_VALUE, 1},
8078 {":file", IMAGE_STRING_VALUE, 0},
8079 {":data", IMAGE_STRING_VALUE, 0},
8080 {":ascent", IMAGE_ASCENT_VALUE, 0},
8081 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8082 {":relief", IMAGE_INTEGER_VALUE, 0},
8083 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8084 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8085 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8086 {":foreground", IMAGE_STRING_VALUE, 0},
8087 {":background", IMAGE_STRING_VALUE, 0}
8090 /* Structure describing the image type `pbm'. */
8092 static struct image_type pbm_type =
8094 &Qpbm,
8095 pbm_image_p,
8096 pbm_load,
8097 x_clear_image,
8098 NULL
8102 /* Return non-zero if OBJECT is a valid PBM image specification. */
8104 static int
8105 pbm_image_p (object)
8106 Lisp_Object object;
8108 struct image_keyword fmt[PBM_LAST];
8110 bcopy (pbm_format, fmt, sizeof fmt);
8112 if (!parse_image_spec (object, fmt, PBM_LAST, Qpbm))
8113 return 0;
8115 /* Must specify either :data or :file. */
8116 return fmt[PBM_DATA].count + fmt[PBM_FILE].count == 1;
8120 /* Scan a decimal number from *S and return it. Advance *S while
8121 reading the number. END is the end of the string. Value is -1 at
8122 end of input. */
8124 static int
8125 pbm_scan_number (s, end)
8126 unsigned char **s, *end;
8128 int c = 0, val = -1;
8130 while (*s < end)
8132 /* Skip white-space. */
8133 while (*s < end && (c = *(*s)++, isspace (c)))
8136 if (c == '#')
8138 /* Skip comment to end of line. */
8139 while (*s < end && (c = *(*s)++, c != '\n'))
8142 else if (isdigit (c))
8144 /* Read decimal number. */
8145 val = c - '0';
8146 while (*s < end && (c = *(*s)++, isdigit (c)))
8147 val = 10 * val + c - '0';
8148 break;
8150 else
8151 break;
8154 return val;
8158 /* Load PBM image IMG for use on frame F. */
8160 static int
8161 pbm_load (f, img)
8162 struct frame *f;
8163 struct image *img;
8165 int raw_p, x, y;
8166 int width, height, max_color_idx = 0;
8167 XImage *ximg;
8168 Lisp_Object file, specified_file;
8169 enum {PBM_MONO, PBM_GRAY, PBM_COLOR} type;
8170 struct gcpro gcpro1;
8171 unsigned char *contents = NULL;
8172 unsigned char *end, *p;
8173 int size;
8175 specified_file = image_spec_value (img->spec, QCfile, NULL);
8176 file = Qnil;
8177 GCPRO1 (file);
8179 if (STRINGP (specified_file))
8181 file = x_find_image_file (specified_file);
8182 if (!STRINGP (file))
8184 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8185 UNGCPRO;
8186 return 0;
8189 contents = slurp_file (XSTRING (file)->data, &size);
8190 if (contents == NULL)
8192 image_error ("Error reading `%s'", file, Qnil);
8193 UNGCPRO;
8194 return 0;
8197 p = contents;
8198 end = contents + size;
8200 else
8202 Lisp_Object data;
8203 data = image_spec_value (img->spec, QCdata, NULL);
8204 p = XSTRING (data)->data;
8205 end = p + STRING_BYTES (XSTRING (data));
8208 /* Check magic number. */
8209 if (end - p < 2 || *p++ != 'P')
8211 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8212 error:
8213 xfree (contents);
8214 UNGCPRO;
8215 return 0;
8218 switch (*p++)
8220 case '1':
8221 raw_p = 0, type = PBM_MONO;
8222 break;
8224 case '2':
8225 raw_p = 0, type = PBM_GRAY;
8226 break;
8228 case '3':
8229 raw_p = 0, type = PBM_COLOR;
8230 break;
8232 case '4':
8233 raw_p = 1, type = PBM_MONO;
8234 break;
8236 case '5':
8237 raw_p = 1, type = PBM_GRAY;
8238 break;
8240 case '6':
8241 raw_p = 1, type = PBM_COLOR;
8242 break;
8244 default:
8245 image_error ("Not a PBM image: `%s'", img->spec, Qnil);
8246 goto error;
8249 /* Read width, height, maximum color-component. Characters
8250 starting with `#' up to the end of a line are ignored. */
8251 width = pbm_scan_number (&p, end);
8252 height = pbm_scan_number (&p, end);
8254 if (type != PBM_MONO)
8256 max_color_idx = pbm_scan_number (&p, end);
8257 if (raw_p && max_color_idx > 255)
8258 max_color_idx = 255;
8261 if (width < 0
8262 || height < 0
8263 || (type != PBM_MONO && max_color_idx < 0))
8264 goto error;
8266 if (!x_create_x_image_and_pixmap (f, width, height, 0,
8267 &ximg, &img->pixmap))
8268 goto error;
8270 /* Initialize the color hash table. */
8271 init_color_table ();
8273 if (type == PBM_MONO)
8275 int c = 0, g;
8276 struct image_keyword fmt[PBM_LAST];
8277 unsigned long fg = FRAME_FOREGROUND_PIXEL (f);
8278 unsigned long bg = FRAME_BACKGROUND_PIXEL (f);
8280 /* Parse the image specification. */
8281 bcopy (pbm_format, fmt, sizeof fmt);
8282 parse_image_spec (img->spec, fmt, PBM_LAST, Qpbm);
8284 /* Get foreground and background colors, maybe allocate colors. */
8285 if (fmt[PBM_FOREGROUND].count)
8286 fg = x_alloc_image_color (f, img, fmt[PBM_FOREGROUND].value, fg);
8287 if (fmt[PBM_BACKGROUND].count)
8288 bg = x_alloc_image_color (f, img, fmt[PBM_BACKGROUND].value, bg);
8290 for (y = 0; y < height; ++y)
8291 for (x = 0; x < width; ++x)
8293 if (raw_p)
8295 if ((x & 7) == 0)
8296 c = *p++;
8297 g = c & 0x80;
8298 c <<= 1;
8300 else
8301 g = pbm_scan_number (&p, end);
8303 XPutPixel (ximg, x, y, g ? fg : bg);
8306 else
8308 for (y = 0; y < height; ++y)
8309 for (x = 0; x < width; ++x)
8311 int r, g, b;
8313 if (type == PBM_GRAY)
8314 r = g = b = raw_p ? *p++ : pbm_scan_number (&p, end);
8315 else if (raw_p)
8317 r = *p++;
8318 g = *p++;
8319 b = *p++;
8321 else
8323 r = pbm_scan_number (&p, end);
8324 g = pbm_scan_number (&p, end);
8325 b = pbm_scan_number (&p, end);
8328 if (r < 0 || g < 0 || b < 0)
8330 xfree (ximg->data);
8331 ximg->data = NULL;
8332 XDestroyImage (ximg);
8333 image_error ("Invalid pixel value in image `%s'",
8334 img->spec, Qnil);
8335 goto error;
8338 /* RGB values are now in the range 0..max_color_idx.
8339 Scale this to the range 0..0xffff supported by X. */
8340 r = (double) r * 65535 / max_color_idx;
8341 g = (double) g * 65535 / max_color_idx;
8342 b = (double) b * 65535 / max_color_idx;
8343 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8347 /* Store in IMG->colors the colors allocated for the image, and
8348 free the color table. */
8349 img->colors = colors_in_color_table (&img->ncolors);
8350 free_color_table ();
8352 /* Put the image into a pixmap. */
8353 x_put_x_image (f, ximg, img->pixmap, width, height);
8354 x_destroy_x_image (ximg);
8356 img->width = width;
8357 img->height = height;
8359 UNGCPRO;
8360 xfree (contents);
8361 return 1;
8366 /***********************************************************************
8368 ***********************************************************************/
8370 #if HAVE_PNG
8372 #include <png.h>
8374 /* Function prototypes. */
8376 static int png_image_p P_ ((Lisp_Object object));
8377 static int png_load P_ ((struct frame *f, struct image *img));
8379 /* The symbol `png' identifying images of this type. */
8381 Lisp_Object Qpng;
8383 /* Indices of image specification fields in png_format, below. */
8385 enum png_keyword_index
8387 PNG_TYPE,
8388 PNG_DATA,
8389 PNG_FILE,
8390 PNG_ASCENT,
8391 PNG_MARGIN,
8392 PNG_RELIEF,
8393 PNG_ALGORITHM,
8394 PNG_HEURISTIC_MASK,
8395 PNG_MASK,
8396 PNG_LAST
8399 /* Vector of image_keyword structures describing the format
8400 of valid user-defined image specifications. */
8402 static struct image_keyword png_format[PNG_LAST] =
8404 {":type", IMAGE_SYMBOL_VALUE, 1},
8405 {":data", IMAGE_STRING_VALUE, 0},
8406 {":file", IMAGE_STRING_VALUE, 0},
8407 {":ascent", IMAGE_ASCENT_VALUE, 0},
8408 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8409 {":relief", IMAGE_INTEGER_VALUE, 0},
8410 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8411 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8412 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8415 /* Structure describing the image type `png'. */
8417 static struct image_type png_type =
8419 &Qpng,
8420 png_image_p,
8421 png_load,
8422 x_clear_image,
8423 NULL
8427 /* Return non-zero if OBJECT is a valid PNG image specification. */
8429 static int
8430 png_image_p (object)
8431 Lisp_Object object;
8433 struct image_keyword fmt[PNG_LAST];
8434 bcopy (png_format, fmt, sizeof fmt);
8436 if (!parse_image_spec (object, fmt, PNG_LAST, Qpng))
8437 return 0;
8439 /* Must specify either the :data or :file keyword. */
8440 return fmt[PNG_FILE].count + fmt[PNG_DATA].count == 1;
8444 /* Error and warning handlers installed when the PNG library
8445 is initialized. */
8447 static void
8448 my_png_error (png_ptr, msg)
8449 png_struct *png_ptr;
8450 char *msg;
8452 xassert (png_ptr != NULL);
8453 image_error ("PNG error: %s", build_string (msg), Qnil);
8454 longjmp (png_ptr->jmpbuf, 1);
8458 static void
8459 my_png_warning (png_ptr, msg)
8460 png_struct *png_ptr;
8461 char *msg;
8463 xassert (png_ptr != NULL);
8464 image_error ("PNG warning: %s", build_string (msg), Qnil);
8467 /* Memory source for PNG decoding. */
8469 struct png_memory_storage
8471 unsigned char *bytes; /* The data */
8472 size_t len; /* How big is it? */
8473 int index; /* Where are we? */
8477 /* Function set as reader function when reading PNG image from memory.
8478 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
8479 bytes from the input to DATA. */
8481 static void
8482 png_read_from_memory (png_ptr, data, length)
8483 png_structp png_ptr;
8484 png_bytep data;
8485 png_size_t length;
8487 struct png_memory_storage *tbr
8488 = (struct png_memory_storage *) png_get_io_ptr (png_ptr);
8490 if (length > tbr->len - tbr->index)
8491 png_error (png_ptr, "Read error");
8493 bcopy (tbr->bytes + tbr->index, data, length);
8494 tbr->index = tbr->index + length;
8497 /* Load PNG image IMG for use on frame F. Value is non-zero if
8498 successful. */
8500 static int
8501 png_load (f, img)
8502 struct frame *f;
8503 struct image *img;
8505 Lisp_Object file, specified_file;
8506 Lisp_Object specified_data;
8507 int x, y, i;
8508 XImage *ximg, *mask_img = NULL;
8509 struct gcpro gcpro1;
8510 png_struct *png_ptr = NULL;
8511 png_info *info_ptr = NULL, *end_info = NULL;
8512 FILE *volatile fp = NULL;
8513 png_byte sig[8];
8514 png_byte * volatile pixels = NULL;
8515 png_byte ** volatile rows = NULL;
8516 png_uint_32 width, height;
8517 int bit_depth, color_type, interlace_type;
8518 png_byte channels;
8519 png_uint_32 row_bytes;
8520 int transparent_p;
8521 char *gamma_str;
8522 double screen_gamma, image_gamma;
8523 int intent;
8524 struct png_memory_storage tbr; /* Data to be read */
8526 /* Find out what file to load. */
8527 specified_file = image_spec_value (img->spec, QCfile, NULL);
8528 specified_data = image_spec_value (img->spec, QCdata, NULL);
8529 file = Qnil;
8530 GCPRO1 (file);
8532 if (NILP (specified_data))
8534 file = x_find_image_file (specified_file);
8535 if (!STRINGP (file))
8537 image_error ("Cannot find image file `%s'", specified_file, Qnil);
8538 UNGCPRO;
8539 return 0;
8542 /* Open the image file. */
8543 fp = fopen (XSTRING (file)->data, "rb");
8544 if (!fp)
8546 image_error ("Cannot open image file `%s'", file, Qnil);
8547 UNGCPRO;
8548 fclose (fp);
8549 return 0;
8552 /* Check PNG signature. */
8553 if (fread (sig, 1, sizeof sig, fp) != sizeof sig
8554 || !png_check_sig (sig, sizeof sig))
8556 image_error ("Not a PNG file: `%s'", file, Qnil);
8557 UNGCPRO;
8558 fclose (fp);
8559 return 0;
8562 else
8564 /* Read from memory. */
8565 tbr.bytes = XSTRING (specified_data)->data;
8566 tbr.len = STRING_BYTES (XSTRING (specified_data));
8567 tbr.index = 0;
8569 /* Check PNG signature. */
8570 if (tbr.len < sizeof sig
8571 || !png_check_sig (tbr.bytes, sizeof sig))
8573 image_error ("Not a PNG image: `%s'", img->spec, Qnil);
8574 UNGCPRO;
8575 return 0;
8578 /* Need to skip past the signature. */
8579 tbr.bytes += sizeof (sig);
8582 /* Initialize read and info structs for PNG lib. */
8583 png_ptr = png_create_read_struct (PNG_LIBPNG_VER_STRING, NULL,
8584 my_png_error, my_png_warning);
8585 if (!png_ptr)
8587 if (fp) fclose (fp);
8588 UNGCPRO;
8589 return 0;
8592 info_ptr = png_create_info_struct (png_ptr);
8593 if (!info_ptr)
8595 png_destroy_read_struct (&png_ptr, NULL, NULL);
8596 if (fp) fclose (fp);
8597 UNGCPRO;
8598 return 0;
8601 end_info = png_create_info_struct (png_ptr);
8602 if (!end_info)
8604 png_destroy_read_struct (&png_ptr, &info_ptr, NULL);
8605 if (fp) fclose (fp);
8606 UNGCPRO;
8607 return 0;
8610 /* Set error jump-back. We come back here when the PNG library
8611 detects an error. */
8612 if (setjmp (png_ptr->jmpbuf))
8614 error:
8615 if (png_ptr)
8616 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8617 xfree (pixels);
8618 xfree (rows);
8619 if (fp) fclose (fp);
8620 UNGCPRO;
8621 return 0;
8624 /* Read image info. */
8625 if (!NILP (specified_data))
8626 png_set_read_fn (png_ptr, (void *) &tbr, png_read_from_memory);
8627 else
8628 png_init_io (png_ptr, fp);
8630 png_set_sig_bytes (png_ptr, sizeof sig);
8631 png_read_info (png_ptr, info_ptr);
8632 png_get_IHDR (png_ptr, info_ptr, &width, &height, &bit_depth, &color_type,
8633 &interlace_type, NULL, NULL);
8635 /* If image contains simply transparency data, we prefer to
8636 construct a clipping mask. */
8637 if (png_get_valid (png_ptr, info_ptr, PNG_INFO_tRNS))
8638 transparent_p = 1;
8639 else
8640 transparent_p = 0;
8642 /* This function is easier to write if we only have to handle
8643 one data format: RGB or RGBA with 8 bits per channel. Let's
8644 transform other formats into that format. */
8646 /* Strip more than 8 bits per channel. */
8647 if (bit_depth == 16)
8648 png_set_strip_16 (png_ptr);
8650 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
8651 if available. */
8652 png_set_expand (png_ptr);
8654 /* Convert grayscale images to RGB. */
8655 if (color_type == PNG_COLOR_TYPE_GRAY
8656 || color_type == PNG_COLOR_TYPE_GRAY_ALPHA)
8657 png_set_gray_to_rgb (png_ptr);
8659 /* The value 2.2 is a guess for PC monitors from PNG example.c. */
8660 gamma_str = getenv ("SCREEN_GAMMA");
8661 screen_gamma = gamma_str ? atof (gamma_str) : 2.2;
8663 /* Tell the PNG lib to handle gamma correction for us. */
8665 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
8666 if (png_get_sRGB (png_ptr, info_ptr, &intent))
8667 /* There is a special chunk in the image specifying the gamma. */
8668 png_set_sRGB (png_ptr, info_ptr, intent);
8669 else
8670 #endif
8671 if (png_get_gAMA (png_ptr, info_ptr, &image_gamma))
8672 /* Image contains gamma information. */
8673 png_set_gamma (png_ptr, screen_gamma, image_gamma);
8674 else
8675 /* Use a default of 0.5 for the image gamma. */
8676 png_set_gamma (png_ptr, screen_gamma, 0.5);
8678 /* Handle alpha channel by combining the image with a background
8679 color. Do this only if a real alpha channel is supplied. For
8680 simple transparency, we prefer a clipping mask. */
8681 if (!transparent_p)
8683 png_color_16 *image_background;
8685 if (png_get_bKGD (png_ptr, info_ptr, &image_background))
8686 /* Image contains a background color with which to
8687 combine the image. */
8688 png_set_background (png_ptr, image_background,
8689 PNG_BACKGROUND_GAMMA_FILE, 1, 1.0);
8690 else
8692 /* Image does not contain a background color with which
8693 to combine the image data via an alpha channel. Use
8694 the frame's background instead. */
8695 XColor color;
8696 Colormap cmap;
8697 png_color_16 frame_background;
8699 cmap = FRAME_X_COLORMAP (f);
8700 color.pixel = FRAME_BACKGROUND_PIXEL (f);
8701 x_query_color (f, &color);
8703 bzero (&frame_background, sizeof frame_background);
8704 frame_background.red = color.red;
8705 frame_background.green = color.green;
8706 frame_background.blue = color.blue;
8708 png_set_background (png_ptr, &frame_background,
8709 PNG_BACKGROUND_GAMMA_SCREEN, 0, 1.0);
8713 /* Update info structure. */
8714 png_read_update_info (png_ptr, info_ptr);
8716 /* Get number of channels. Valid values are 1 for grayscale images
8717 and images with a palette, 2 for grayscale images with transparency
8718 information (alpha channel), 3 for RGB images, and 4 for RGB
8719 images with alpha channel, i.e. RGBA. If conversions above were
8720 sufficient we should only have 3 or 4 channels here. */
8721 channels = png_get_channels (png_ptr, info_ptr);
8722 xassert (channels == 3 || channels == 4);
8724 /* Number of bytes needed for one row of the image. */
8725 row_bytes = png_get_rowbytes (png_ptr, info_ptr);
8727 /* Allocate memory for the image. */
8728 pixels = (png_byte *) xmalloc (row_bytes * height * sizeof *pixels);
8729 rows = (png_byte **) xmalloc (height * sizeof *rows);
8730 for (i = 0; i < height; ++i)
8731 rows[i] = pixels + i * row_bytes;
8733 /* Read the entire image. */
8734 png_read_image (png_ptr, rows);
8735 png_read_end (png_ptr, info_ptr);
8736 if (fp)
8738 fclose (fp);
8739 fp = NULL;
8742 /* Create the X image and pixmap. */
8743 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg,
8744 &img->pixmap))
8745 goto error;
8747 /* Create an image and pixmap serving as mask if the PNG image
8748 contains an alpha channel. */
8749 if (channels == 4
8750 && !transparent_p
8751 && !x_create_x_image_and_pixmap (f, width, height, 1,
8752 &mask_img, &img->mask))
8754 x_destroy_x_image (ximg);
8755 XFreePixmap (FRAME_X_DISPLAY (f), img->pixmap);
8756 img->pixmap = None;
8757 goto error;
8760 /* Fill the X image and mask from PNG data. */
8761 init_color_table ();
8763 for (y = 0; y < height; ++y)
8765 png_byte *p = rows[y];
8767 for (x = 0; x < width; ++x)
8769 unsigned r, g, b;
8771 r = *p++ << 8;
8772 g = *p++ << 8;
8773 b = *p++ << 8;
8774 XPutPixel (ximg, x, y, lookup_rgb_color (f, r, g, b));
8776 /* An alpha channel, aka mask channel, associates variable
8777 transparency with an image. Where other image formats
8778 support binary transparency---fully transparent or fully
8779 opaque---PNG allows up to 254 levels of partial transparency.
8780 The PNG library implements partial transparency by combining
8781 the image with a specified background color.
8783 I'm not sure how to handle this here nicely: because the
8784 background on which the image is displayed may change, for
8785 real alpha channel support, it would be necessary to create
8786 a new image for each possible background.
8788 What I'm doing now is that a mask is created if we have
8789 boolean transparency information. Otherwise I'm using
8790 the frame's background color to combine the image with. */
8792 if (channels == 4)
8794 if (mask_img)
8795 XPutPixel (mask_img, x, y, *p > 0);
8796 ++p;
8801 /* Remember colors allocated for this image. */
8802 img->colors = colors_in_color_table (&img->ncolors);
8803 free_color_table ();
8805 /* Clean up. */
8806 png_destroy_read_struct (&png_ptr, &info_ptr, &end_info);
8807 xfree (rows);
8808 xfree (pixels);
8810 img->width = width;
8811 img->height = height;
8813 /* Put the image into the pixmap, then free the X image and its buffer. */
8814 x_put_x_image (f, ximg, img->pixmap, width, height);
8815 x_destroy_x_image (ximg);
8817 /* Same for the mask. */
8818 if (mask_img)
8820 x_put_x_image (f, mask_img, img->mask, img->width, img->height);
8821 x_destroy_x_image (mask_img);
8824 UNGCPRO;
8825 return 1;
8828 #endif /* HAVE_PNG != 0 */
8832 /***********************************************************************
8833 JPEG
8834 ***********************************************************************/
8836 #if HAVE_JPEG
8838 /* Work around a warning about HAVE_STDLIB_H being redefined in
8839 jconfig.h. */
8840 #ifdef HAVE_STDLIB_H
8841 #define HAVE_STDLIB_H_1
8842 #undef HAVE_STDLIB_H
8843 #endif /* HAVE_STLIB_H */
8845 #include <jpeglib.h>
8846 #include <jerror.h>
8847 #include <setjmp.h>
8849 #ifdef HAVE_STLIB_H_1
8850 #define HAVE_STDLIB_H 1
8851 #endif
8853 static int jpeg_image_p P_ ((Lisp_Object object));
8854 static int jpeg_load P_ ((struct frame *f, struct image *img));
8856 /* The symbol `jpeg' identifying images of this type. */
8858 Lisp_Object Qjpeg;
8860 /* Indices of image specification fields in gs_format, below. */
8862 enum jpeg_keyword_index
8864 JPEG_TYPE,
8865 JPEG_DATA,
8866 JPEG_FILE,
8867 JPEG_ASCENT,
8868 JPEG_MARGIN,
8869 JPEG_RELIEF,
8870 JPEG_ALGORITHM,
8871 JPEG_HEURISTIC_MASK,
8872 JPEG_MASK,
8873 JPEG_LAST
8876 /* Vector of image_keyword structures describing the format
8877 of valid user-defined image specifications. */
8879 static struct image_keyword jpeg_format[JPEG_LAST] =
8881 {":type", IMAGE_SYMBOL_VALUE, 1},
8882 {":data", IMAGE_STRING_VALUE, 0},
8883 {":file", IMAGE_STRING_VALUE, 0},
8884 {":ascent", IMAGE_ASCENT_VALUE, 0},
8885 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
8886 {":relief", IMAGE_INTEGER_VALUE, 0},
8887 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8888 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
8889 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
8892 /* Structure describing the image type `jpeg'. */
8894 static struct image_type jpeg_type =
8896 &Qjpeg,
8897 jpeg_image_p,
8898 jpeg_load,
8899 x_clear_image,
8900 NULL
8904 /* Return non-zero if OBJECT is a valid JPEG image specification. */
8906 static int
8907 jpeg_image_p (object)
8908 Lisp_Object object;
8910 struct image_keyword fmt[JPEG_LAST];
8912 bcopy (jpeg_format, fmt, sizeof fmt);
8914 if (!parse_image_spec (object, fmt, JPEG_LAST, Qjpeg))
8915 return 0;
8917 /* Must specify either the :data or :file keyword. */
8918 return fmt[JPEG_FILE].count + fmt[JPEG_DATA].count == 1;
8922 struct my_jpeg_error_mgr
8924 struct jpeg_error_mgr pub;
8925 jmp_buf setjmp_buffer;
8929 static void
8930 my_error_exit (cinfo)
8931 j_common_ptr cinfo;
8933 struct my_jpeg_error_mgr *mgr = (struct my_jpeg_error_mgr *) cinfo->err;
8934 longjmp (mgr->setjmp_buffer, 1);
8938 /* Init source method for JPEG data source manager. Called by
8939 jpeg_read_header() before any data is actually read. See
8940 libjpeg.doc from the JPEG lib distribution. */
8942 static void
8943 our_init_source (cinfo)
8944 j_decompress_ptr cinfo;
8949 /* Fill input buffer method for JPEG data source manager. Called
8950 whenever more data is needed. We read the whole image in one step,
8951 so this only adds a fake end of input marker at the end. */
8953 static boolean
8954 our_fill_input_buffer (cinfo)
8955 j_decompress_ptr cinfo;
8957 /* Insert a fake EOI marker. */
8958 struct jpeg_source_mgr *src = cinfo->src;
8959 static JOCTET buffer[2];
8961 buffer[0] = (JOCTET) 0xFF;
8962 buffer[1] = (JOCTET) JPEG_EOI;
8964 src->next_input_byte = buffer;
8965 src->bytes_in_buffer = 2;
8966 return TRUE;
8970 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
8971 is the JPEG data source manager. */
8973 static void
8974 our_skip_input_data (cinfo, num_bytes)
8975 j_decompress_ptr cinfo;
8976 long num_bytes;
8978 struct jpeg_source_mgr *src = (struct jpeg_source_mgr *) cinfo->src;
8980 if (src)
8982 if (num_bytes > src->bytes_in_buffer)
8983 ERREXIT (cinfo, JERR_INPUT_EOF);
8985 src->bytes_in_buffer -= num_bytes;
8986 src->next_input_byte += num_bytes;
8991 /* Method to terminate data source. Called by
8992 jpeg_finish_decompress() after all data has been processed. */
8994 static void
8995 our_term_source (cinfo)
8996 j_decompress_ptr cinfo;
9001 /* Set up the JPEG lib for reading an image from DATA which contains
9002 LEN bytes. CINFO is the decompression info structure created for
9003 reading the image. */
9005 static void
9006 jpeg_memory_src (cinfo, data, len)
9007 j_decompress_ptr cinfo;
9008 JOCTET *data;
9009 unsigned int len;
9011 struct jpeg_source_mgr *src;
9013 if (cinfo->src == NULL)
9015 /* First time for this JPEG object? */
9016 cinfo->src = (struct jpeg_source_mgr *)
9017 (*cinfo->mem->alloc_small) ((j_common_ptr) cinfo, JPOOL_PERMANENT,
9018 sizeof (struct jpeg_source_mgr));
9019 src = (struct jpeg_source_mgr *) cinfo->src;
9020 src->next_input_byte = data;
9023 src = (struct jpeg_source_mgr *) cinfo->src;
9024 src->init_source = our_init_source;
9025 src->fill_input_buffer = our_fill_input_buffer;
9026 src->skip_input_data = our_skip_input_data;
9027 src->resync_to_restart = jpeg_resync_to_restart; /* Use default method. */
9028 src->term_source = our_term_source;
9029 src->bytes_in_buffer = len;
9030 src->next_input_byte = data;
9034 /* Load image IMG for use on frame F. Patterned after example.c
9035 from the JPEG lib. */
9037 static int
9038 jpeg_load (f, img)
9039 struct frame *f;
9040 struct image *img;
9042 struct jpeg_decompress_struct cinfo;
9043 struct my_jpeg_error_mgr mgr;
9044 Lisp_Object file, specified_file;
9045 Lisp_Object specified_data;
9046 FILE * volatile fp = NULL;
9047 JSAMPARRAY buffer;
9048 int row_stride, x, y;
9049 XImage *ximg = NULL;
9050 int rc;
9051 unsigned long *colors;
9052 int width, height;
9053 struct gcpro gcpro1;
9055 /* Open the JPEG file. */
9056 specified_file = image_spec_value (img->spec, QCfile, NULL);
9057 specified_data = image_spec_value (img->spec, QCdata, NULL);
9058 file = Qnil;
9059 GCPRO1 (file);
9061 if (NILP (specified_data))
9063 file = x_find_image_file (specified_file);
9064 if (!STRINGP (file))
9066 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9067 UNGCPRO;
9068 return 0;
9071 fp = fopen (XSTRING (file)->data, "r");
9072 if (fp == NULL)
9074 image_error ("Cannot open `%s'", file, Qnil);
9075 UNGCPRO;
9076 return 0;
9080 /* Customize libjpeg's error handling to call my_error_exit when an
9081 error is detected. This function will perform a longjmp. */
9082 cinfo.err = jpeg_std_error (&mgr.pub);
9083 mgr.pub.error_exit = my_error_exit;
9085 if ((rc = setjmp (mgr.setjmp_buffer)) != 0)
9087 if (rc == 1)
9089 /* Called from my_error_exit. Display a JPEG error. */
9090 char buffer[JMSG_LENGTH_MAX];
9091 cinfo.err->format_message ((j_common_ptr) &cinfo, buffer);
9092 image_error ("Error reading JPEG image `%s': %s", img->spec,
9093 build_string (buffer));
9096 /* Close the input file and destroy the JPEG object. */
9097 if (fp)
9098 fclose ((FILE *) fp);
9099 jpeg_destroy_decompress (&cinfo);
9101 /* If we already have an XImage, free that. */
9102 x_destroy_x_image (ximg);
9104 /* Free pixmap and colors. */
9105 x_clear_image (f, img);
9107 UNGCPRO;
9108 return 0;
9111 /* Create the JPEG decompression object. Let it read from fp.
9112 Read the JPEG image header. */
9113 jpeg_create_decompress (&cinfo);
9115 if (NILP (specified_data))
9116 jpeg_stdio_src (&cinfo, (FILE *) fp);
9117 else
9118 jpeg_memory_src (&cinfo, XSTRING (specified_data)->data,
9119 STRING_BYTES (XSTRING (specified_data)));
9121 jpeg_read_header (&cinfo, TRUE);
9123 /* Customize decompression so that color quantization will be used.
9124 Start decompression. */
9125 cinfo.quantize_colors = TRUE;
9126 jpeg_start_decompress (&cinfo);
9127 width = img->width = cinfo.output_width;
9128 height = img->height = cinfo.output_height;
9130 /* Create X image and pixmap. */
9131 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9132 longjmp (mgr.setjmp_buffer, 2);
9134 /* Allocate colors. When color quantization is used,
9135 cinfo.actual_number_of_colors has been set with the number of
9136 colors generated, and cinfo.colormap is a two-dimensional array
9137 of color indices in the range 0..cinfo.actual_number_of_colors.
9138 No more than 255 colors will be generated. */
9140 int i, ir, ig, ib;
9142 if (cinfo.out_color_components > 2)
9143 ir = 0, ig = 1, ib = 2;
9144 else if (cinfo.out_color_components > 1)
9145 ir = 0, ig = 1, ib = 0;
9146 else
9147 ir = 0, ig = 0, ib = 0;
9149 /* Use the color table mechanism because it handles colors that
9150 cannot be allocated nicely. Such colors will be replaced with
9151 a default color, and we don't have to care about which colors
9152 can be freed safely, and which can't. */
9153 init_color_table ();
9154 colors = (unsigned long *) alloca (cinfo.actual_number_of_colors
9155 * sizeof *colors);
9157 for (i = 0; i < cinfo.actual_number_of_colors; ++i)
9159 /* Multiply RGB values with 255 because X expects RGB values
9160 in the range 0..0xffff. */
9161 int r = cinfo.colormap[ir][i] << 8;
9162 int g = cinfo.colormap[ig][i] << 8;
9163 int b = cinfo.colormap[ib][i] << 8;
9164 colors[i] = lookup_rgb_color (f, r, g, b);
9167 /* Remember those colors actually allocated. */
9168 img->colors = colors_in_color_table (&img->ncolors);
9169 free_color_table ();
9172 /* Read pixels. */
9173 row_stride = width * cinfo.output_components;
9174 buffer = cinfo.mem->alloc_sarray ((j_common_ptr) &cinfo, JPOOL_IMAGE,
9175 row_stride, 1);
9176 for (y = 0; y < height; ++y)
9178 jpeg_read_scanlines (&cinfo, buffer, 1);
9179 for (x = 0; x < cinfo.output_width; ++x)
9180 XPutPixel (ximg, x, y, colors[buffer[0][x]]);
9183 /* Clean up. */
9184 jpeg_finish_decompress (&cinfo);
9185 jpeg_destroy_decompress (&cinfo);
9186 if (fp)
9187 fclose ((FILE *) fp);
9189 /* Put the image into the pixmap. */
9190 x_put_x_image (f, ximg, img->pixmap, width, height);
9191 x_destroy_x_image (ximg);
9192 UNGCPRO;
9193 return 1;
9196 #endif /* HAVE_JPEG */
9200 /***********************************************************************
9201 TIFF
9202 ***********************************************************************/
9204 #if HAVE_TIFF
9206 #include <tiffio.h>
9208 static int tiff_image_p P_ ((Lisp_Object object));
9209 static int tiff_load P_ ((struct frame *f, struct image *img));
9211 /* The symbol `tiff' identifying images of this type. */
9213 Lisp_Object Qtiff;
9215 /* Indices of image specification fields in tiff_format, below. */
9217 enum tiff_keyword_index
9219 TIFF_TYPE,
9220 TIFF_DATA,
9221 TIFF_FILE,
9222 TIFF_ASCENT,
9223 TIFF_MARGIN,
9224 TIFF_RELIEF,
9225 TIFF_ALGORITHM,
9226 TIFF_HEURISTIC_MASK,
9227 TIFF_MASK,
9228 TIFF_LAST
9231 /* Vector of image_keyword structures describing the format
9232 of valid user-defined image specifications. */
9234 static struct image_keyword tiff_format[TIFF_LAST] =
9236 {":type", IMAGE_SYMBOL_VALUE, 1},
9237 {":data", IMAGE_STRING_VALUE, 0},
9238 {":file", IMAGE_STRING_VALUE, 0},
9239 {":ascent", IMAGE_ASCENT_VALUE, 0},
9240 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9241 {":relief", IMAGE_INTEGER_VALUE, 0},
9242 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9243 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9244 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9247 /* Structure describing the image type `tiff'. */
9249 static struct image_type tiff_type =
9251 &Qtiff,
9252 tiff_image_p,
9253 tiff_load,
9254 x_clear_image,
9255 NULL
9259 /* Return non-zero if OBJECT is a valid TIFF image specification. */
9261 static int
9262 tiff_image_p (object)
9263 Lisp_Object object;
9265 struct image_keyword fmt[TIFF_LAST];
9266 bcopy (tiff_format, fmt, sizeof fmt);
9268 if (!parse_image_spec (object, fmt, TIFF_LAST, Qtiff))
9269 return 0;
9271 /* Must specify either the :data or :file keyword. */
9272 return fmt[TIFF_FILE].count + fmt[TIFF_DATA].count == 1;
9276 /* Reading from a memory buffer for TIFF images Based on the PNG
9277 memory source, but we have to provide a lot of extra functions.
9278 Blah.
9280 We really only need to implement read and seek, but I am not
9281 convinced that the TIFF library is smart enough not to destroy
9282 itself if we only hand it the function pointers we need to
9283 override. */
9285 typedef struct
9287 unsigned char *bytes;
9288 size_t len;
9289 int index;
9291 tiff_memory_source;
9294 static size_t
9295 tiff_read_from_memory (data, buf, size)
9296 thandle_t data;
9297 tdata_t buf;
9298 tsize_t size;
9300 tiff_memory_source *src = (tiff_memory_source *) data;
9302 if (size > src->len - src->index)
9303 return (size_t) -1;
9304 bcopy (src->bytes + src->index, buf, size);
9305 src->index += size;
9306 return size;
9310 static size_t
9311 tiff_write_from_memory (data, buf, size)
9312 thandle_t data;
9313 tdata_t buf;
9314 tsize_t size;
9316 return (size_t) -1;
9320 static toff_t
9321 tiff_seek_in_memory (data, off, whence)
9322 thandle_t data;
9323 toff_t off;
9324 int whence;
9326 tiff_memory_source *src = (tiff_memory_source *) data;
9327 int idx;
9329 switch (whence)
9331 case SEEK_SET: /* Go from beginning of source. */
9332 idx = off;
9333 break;
9335 case SEEK_END: /* Go from end of source. */
9336 idx = src->len + off;
9337 break;
9339 case SEEK_CUR: /* Go from current position. */
9340 idx = src->index + off;
9341 break;
9343 default: /* Invalid `whence'. */
9344 return -1;
9347 if (idx > src->len || idx < 0)
9348 return -1;
9350 src->index = idx;
9351 return src->index;
9355 static int
9356 tiff_close_memory (data)
9357 thandle_t data;
9359 /* NOOP */
9360 return 0;
9364 static int
9365 tiff_mmap_memory (data, pbase, psize)
9366 thandle_t data;
9367 tdata_t *pbase;
9368 toff_t *psize;
9370 /* It is already _IN_ memory. */
9371 return 0;
9375 static void
9376 tiff_unmap_memory (data, base, size)
9377 thandle_t data;
9378 tdata_t base;
9379 toff_t size;
9381 /* We don't need to do this. */
9385 static toff_t
9386 tiff_size_of_memory (data)
9387 thandle_t data;
9389 return ((tiff_memory_source *) data)->len;
9393 /* Load TIFF image IMG for use on frame F. Value is non-zero if
9394 successful. */
9396 static int
9397 tiff_load (f, img)
9398 struct frame *f;
9399 struct image *img;
9401 Lisp_Object file, specified_file;
9402 Lisp_Object specified_data;
9403 TIFF *tiff;
9404 int width, height, x, y;
9405 uint32 *buf;
9406 int rc;
9407 XImage *ximg;
9408 struct gcpro gcpro1;
9409 tiff_memory_source memsrc;
9411 specified_file = image_spec_value (img->spec, QCfile, NULL);
9412 specified_data = image_spec_value (img->spec, QCdata, NULL);
9413 file = Qnil;
9414 GCPRO1 (file);
9416 if (NILP (specified_data))
9418 /* Read from a file */
9419 file = x_find_image_file (specified_file);
9420 if (!STRINGP (file))
9422 image_error ("Cannot find image file `%s'", file, Qnil);
9423 UNGCPRO;
9424 return 0;
9427 /* Try to open the image file. */
9428 tiff = TIFFOpen (XSTRING (file)->data, "r");
9429 if (tiff == NULL)
9431 image_error ("Cannot open `%s'", file, Qnil);
9432 UNGCPRO;
9433 return 0;
9436 else
9438 /* Memory source! */
9439 memsrc.bytes = XSTRING (specified_data)->data;
9440 memsrc.len = STRING_BYTES (XSTRING (specified_data));
9441 memsrc.index = 0;
9443 tiff = TIFFClientOpen ("memory_source", "r", &memsrc,
9444 (TIFFReadWriteProc) tiff_read_from_memory,
9445 (TIFFReadWriteProc) tiff_write_from_memory,
9446 tiff_seek_in_memory,
9447 tiff_close_memory,
9448 tiff_size_of_memory,
9449 tiff_mmap_memory,
9450 tiff_unmap_memory);
9452 if (!tiff)
9454 image_error ("Cannot open memory source for `%s'", img->spec, Qnil);
9455 UNGCPRO;
9456 return 0;
9460 /* Get width and height of the image, and allocate a raster buffer
9461 of width x height 32-bit values. */
9462 TIFFGetField (tiff, TIFFTAG_IMAGEWIDTH, &width);
9463 TIFFGetField (tiff, TIFFTAG_IMAGELENGTH, &height);
9464 buf = (uint32 *) xmalloc (width * height * sizeof *buf);
9466 rc = TIFFReadRGBAImage (tiff, width, height, buf, 0);
9467 TIFFClose (tiff);
9468 if (!rc)
9470 image_error ("Error reading TIFF image `%s'", img->spec, Qnil);
9471 xfree (buf);
9472 UNGCPRO;
9473 return 0;
9476 /* Create the X image and pixmap. */
9477 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9479 xfree (buf);
9480 UNGCPRO;
9481 return 0;
9484 /* Initialize the color table. */
9485 init_color_table ();
9487 /* Process the pixel raster. Origin is in the lower-left corner. */
9488 for (y = 0; y < height; ++y)
9490 uint32 *row = buf + y * width;
9492 for (x = 0; x < width; ++x)
9494 uint32 abgr = row[x];
9495 int r = TIFFGetR (abgr) << 8;
9496 int g = TIFFGetG (abgr) << 8;
9497 int b = TIFFGetB (abgr) << 8;
9498 XPutPixel (ximg, x, height - 1 - y, lookup_rgb_color (f, r, g, b));
9502 /* Remember the colors allocated for the image. Free the color table. */
9503 img->colors = colors_in_color_table (&img->ncolors);
9504 free_color_table ();
9506 /* Put the image into the pixmap, then free the X image and its buffer. */
9507 x_put_x_image (f, ximg, img->pixmap, width, height);
9508 x_destroy_x_image (ximg);
9509 xfree (buf);
9511 img->width = width;
9512 img->height = height;
9514 UNGCPRO;
9515 return 1;
9518 #endif /* HAVE_TIFF != 0 */
9522 /***********************************************************************
9524 ***********************************************************************/
9526 #if HAVE_GIF
9528 #include <gif_lib.h>
9530 static int gif_image_p P_ ((Lisp_Object object));
9531 static int gif_load P_ ((struct frame *f, struct image *img));
9533 /* The symbol `gif' identifying images of this type. */
9535 Lisp_Object Qgif;
9537 /* Indices of image specification fields in gif_format, below. */
9539 enum gif_keyword_index
9541 GIF_TYPE,
9542 GIF_DATA,
9543 GIF_FILE,
9544 GIF_ASCENT,
9545 GIF_MARGIN,
9546 GIF_RELIEF,
9547 GIF_ALGORITHM,
9548 GIF_HEURISTIC_MASK,
9549 GIF_MASK,
9550 GIF_IMAGE,
9551 GIF_LAST
9554 /* Vector of image_keyword structures describing the format
9555 of valid user-defined image specifications. */
9557 static struct image_keyword gif_format[GIF_LAST] =
9559 {":type", IMAGE_SYMBOL_VALUE, 1},
9560 {":data", IMAGE_STRING_VALUE, 0},
9561 {":file", IMAGE_STRING_VALUE, 0},
9562 {":ascent", IMAGE_ASCENT_VALUE, 0},
9563 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9564 {":relief", IMAGE_INTEGER_VALUE, 0},
9565 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9566 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9567 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9568 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE, 0}
9571 /* Structure describing the image type `gif'. */
9573 static struct image_type gif_type =
9575 &Qgif,
9576 gif_image_p,
9577 gif_load,
9578 x_clear_image,
9579 NULL
9583 /* Return non-zero if OBJECT is a valid GIF image specification. */
9585 static int
9586 gif_image_p (object)
9587 Lisp_Object object;
9589 struct image_keyword fmt[GIF_LAST];
9590 bcopy (gif_format, fmt, sizeof fmt);
9592 if (!parse_image_spec (object, fmt, GIF_LAST, Qgif))
9593 return 0;
9595 /* Must specify either the :data or :file keyword. */
9596 return fmt[GIF_FILE].count + fmt[GIF_DATA].count == 1;
9600 /* Reading a GIF image from memory
9601 Based on the PNG memory stuff to a certain extent. */
9603 typedef struct
9605 unsigned char *bytes;
9606 size_t len;
9607 int index;
9609 gif_memory_source;
9612 /* Make the current memory source available to gif_read_from_memory.
9613 It's done this way because not all versions of libungif support
9614 a UserData field in the GifFileType structure. */
9615 static gif_memory_source *current_gif_memory_src;
9617 static int
9618 gif_read_from_memory (file, buf, len)
9619 GifFileType *file;
9620 GifByteType *buf;
9621 int len;
9623 gif_memory_source *src = current_gif_memory_src;
9625 if (len > src->len - src->index)
9626 return -1;
9628 bcopy (src->bytes + src->index, buf, len);
9629 src->index += len;
9630 return len;
9634 /* Load GIF image IMG for use on frame F. Value is non-zero if
9635 successful. */
9637 static int
9638 gif_load (f, img)
9639 struct frame *f;
9640 struct image *img;
9642 Lisp_Object file, specified_file;
9643 Lisp_Object specified_data;
9644 int rc, width, height, x, y, i;
9645 XImage *ximg;
9646 ColorMapObject *gif_color_map;
9647 unsigned long pixel_colors[256];
9648 GifFileType *gif;
9649 struct gcpro gcpro1;
9650 Lisp_Object image;
9651 int ino, image_left, image_top, image_width, image_height;
9652 gif_memory_source memsrc;
9653 unsigned char *raster;
9655 specified_file = image_spec_value (img->spec, QCfile, NULL);
9656 specified_data = image_spec_value (img->spec, QCdata, NULL);
9657 file = Qnil;
9658 GCPRO1 (file);
9660 if (NILP (specified_data))
9662 file = x_find_image_file (specified_file);
9663 if (!STRINGP (file))
9665 image_error ("Cannot find image file `%s'", specified_file, Qnil);
9666 UNGCPRO;
9667 return 0;
9670 /* Open the GIF file. */
9671 gif = DGifOpenFileName (XSTRING (file)->data);
9672 if (gif == NULL)
9674 image_error ("Cannot open `%s'", file, Qnil);
9675 UNGCPRO;
9676 return 0;
9679 else
9681 /* Read from memory! */
9682 current_gif_memory_src = &memsrc;
9683 memsrc.bytes = XSTRING (specified_data)->data;
9684 memsrc.len = STRING_BYTES (XSTRING (specified_data));
9685 memsrc.index = 0;
9687 gif = DGifOpen(&memsrc, gif_read_from_memory);
9688 if (!gif)
9690 image_error ("Cannot open memory source `%s'", img->spec, Qnil);
9691 UNGCPRO;
9692 return 0;
9696 /* Read entire contents. */
9697 rc = DGifSlurp (gif);
9698 if (rc == GIF_ERROR)
9700 image_error ("Error reading `%s'", img->spec, Qnil);
9701 DGifCloseFile (gif);
9702 UNGCPRO;
9703 return 0;
9706 image = image_spec_value (img->spec, QCindex, NULL);
9707 ino = INTEGERP (image) ? XFASTINT (image) : 0;
9708 if (ino >= gif->ImageCount)
9710 image_error ("Invalid image number `%s' in image `%s'",
9711 image, img->spec);
9712 DGifCloseFile (gif);
9713 UNGCPRO;
9714 return 0;
9717 width = img->width = gif->SWidth;
9718 height = img->height = gif->SHeight;
9720 /* Create the X image and pixmap. */
9721 if (!x_create_x_image_and_pixmap (f, width, height, 0, &ximg, &img->pixmap))
9723 DGifCloseFile (gif);
9724 UNGCPRO;
9725 return 0;
9728 /* Allocate colors. */
9729 gif_color_map = gif->SavedImages[ino].ImageDesc.ColorMap;
9730 if (!gif_color_map)
9731 gif_color_map = gif->SColorMap;
9732 init_color_table ();
9733 bzero (pixel_colors, sizeof pixel_colors);
9735 for (i = 0; i < gif_color_map->ColorCount; ++i)
9737 int r = gif_color_map->Colors[i].Red << 8;
9738 int g = gif_color_map->Colors[i].Green << 8;
9739 int b = gif_color_map->Colors[i].Blue << 8;
9740 pixel_colors[i] = lookup_rgb_color (f, r, g, b);
9743 img->colors = colors_in_color_table (&img->ncolors);
9744 free_color_table ();
9746 /* Clear the part of the screen image that are not covered by
9747 the image from the GIF file. Full animated GIF support
9748 requires more than can be done here (see the gif89 spec,
9749 disposal methods). Let's simply assume that the part
9750 not covered by a sub-image is in the frame's background color. */
9751 image_top = gif->SavedImages[ino].ImageDesc.Top;
9752 image_left = gif->SavedImages[ino].ImageDesc.Left;
9753 image_width = gif->SavedImages[ino].ImageDesc.Width;
9754 image_height = gif->SavedImages[ino].ImageDesc.Height;
9756 for (y = 0; y < image_top; ++y)
9757 for (x = 0; x < width; ++x)
9758 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9760 for (y = image_top + image_height; y < height; ++y)
9761 for (x = 0; x < width; ++x)
9762 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9764 for (y = image_top; y < image_top + image_height; ++y)
9766 for (x = 0; x < image_left; ++x)
9767 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9768 for (x = image_left + image_width; x < width; ++x)
9769 XPutPixel (ximg, x, y, FRAME_BACKGROUND_PIXEL (f));
9772 /* Read the GIF image into the X image. We use a local variable
9773 `raster' here because RasterBits below is a char *, and invites
9774 problems with bytes >= 0x80. */
9775 raster = (unsigned char *) gif->SavedImages[ino].RasterBits;
9777 if (gif->SavedImages[ino].ImageDesc.Interlace)
9779 static int interlace_start[] = {0, 4, 2, 1};
9780 static int interlace_increment[] = {8, 8, 4, 2};
9781 int pass;
9782 int row = interlace_start[0];
9784 pass = 0;
9786 for (y = 0; y < image_height; y++)
9788 if (row >= image_height)
9790 row = interlace_start[++pass];
9791 while (row >= image_height)
9792 row = interlace_start[++pass];
9795 for (x = 0; x < image_width; x++)
9797 int i = raster[(y * image_width) + x];
9798 XPutPixel (ximg, x + image_left, row + image_top,
9799 pixel_colors[i]);
9802 row += interlace_increment[pass];
9805 else
9807 for (y = 0; y < image_height; ++y)
9808 for (x = 0; x < image_width; ++x)
9810 int i = raster[y * image_width + x];
9811 XPutPixel (ximg, x + image_left, y + image_top, pixel_colors[i]);
9815 DGifCloseFile (gif);
9817 /* Put the image into the pixmap, then free the X image and its buffer. */
9818 x_put_x_image (f, ximg, img->pixmap, width, height);
9819 x_destroy_x_image (ximg);
9821 UNGCPRO;
9822 return 1;
9825 #endif /* HAVE_GIF != 0 */
9829 /***********************************************************************
9830 Ghostscript
9831 ***********************************************************************/
9833 static int gs_image_p P_ ((Lisp_Object object));
9834 static int gs_load P_ ((struct frame *f, struct image *img));
9835 static void gs_clear_image P_ ((struct frame *f, struct image *img));
9837 /* The symbol `postscript' identifying images of this type. */
9839 Lisp_Object Qpostscript;
9841 /* Keyword symbols. */
9843 Lisp_Object QCloader, QCbounding_box, QCpt_width, QCpt_height;
9845 /* Indices of image specification fields in gs_format, below. */
9847 enum gs_keyword_index
9849 GS_TYPE,
9850 GS_PT_WIDTH,
9851 GS_PT_HEIGHT,
9852 GS_FILE,
9853 GS_LOADER,
9854 GS_BOUNDING_BOX,
9855 GS_ASCENT,
9856 GS_MARGIN,
9857 GS_RELIEF,
9858 GS_ALGORITHM,
9859 GS_HEURISTIC_MASK,
9860 GS_MASK,
9861 GS_LAST
9864 /* Vector of image_keyword structures describing the format
9865 of valid user-defined image specifications. */
9867 static struct image_keyword gs_format[GS_LAST] =
9869 {":type", IMAGE_SYMBOL_VALUE, 1},
9870 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9871 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE, 1},
9872 {":file", IMAGE_STRING_VALUE, 1},
9873 {":loader", IMAGE_FUNCTION_VALUE, 0},
9874 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE, 1},
9875 {":ascent", IMAGE_ASCENT_VALUE, 0},
9876 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR, 0},
9877 {":relief", IMAGE_INTEGER_VALUE, 0},
9878 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9879 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0},
9880 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE, 0}
9883 /* Structure describing the image type `ghostscript'. */
9885 static struct image_type gs_type =
9887 &Qpostscript,
9888 gs_image_p,
9889 gs_load,
9890 gs_clear_image,
9891 NULL
9895 /* Free X resources of Ghostscript image IMG which is used on frame F. */
9897 static void
9898 gs_clear_image (f, img)
9899 struct frame *f;
9900 struct image *img;
9902 /* IMG->data.ptr_val may contain a recorded colormap. */
9903 xfree (img->data.ptr_val);
9904 x_clear_image (f, img);
9908 /* Return non-zero if OBJECT is a valid Ghostscript image
9909 specification. */
9911 static int
9912 gs_image_p (object)
9913 Lisp_Object object;
9915 struct image_keyword fmt[GS_LAST];
9916 Lisp_Object tem;
9917 int i;
9919 bcopy (gs_format, fmt, sizeof fmt);
9921 if (!parse_image_spec (object, fmt, GS_LAST, Qpostscript))
9922 return 0;
9924 /* Bounding box must be a list or vector containing 4 integers. */
9925 tem = fmt[GS_BOUNDING_BOX].value;
9926 if (CONSP (tem))
9928 for (i = 0; i < 4; ++i, tem = XCDR (tem))
9929 if (!CONSP (tem) || !INTEGERP (XCAR (tem)))
9930 return 0;
9931 if (!NILP (tem))
9932 return 0;
9934 else if (VECTORP (tem))
9936 if (XVECTOR (tem)->size != 4)
9937 return 0;
9938 for (i = 0; i < 4; ++i)
9939 if (!INTEGERP (XVECTOR (tem)->contents[i]))
9940 return 0;
9942 else
9943 return 0;
9945 return 1;
9949 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
9950 if successful. */
9952 static int
9953 gs_load (f, img)
9954 struct frame *f;
9955 struct image *img;
9957 char buffer[100];
9958 Lisp_Object window_and_pixmap_id = Qnil, loader, pt_height, pt_width;
9959 struct gcpro gcpro1, gcpro2;
9960 Lisp_Object frame;
9961 double in_width, in_height;
9962 Lisp_Object pixel_colors = Qnil;
9964 /* Compute pixel size of pixmap needed from the given size in the
9965 image specification. Sizes in the specification are in pt. 1 pt
9966 = 1/72 in, xdpi and ydpi are stored in the frame's X display
9967 info. */
9968 pt_width = image_spec_value (img->spec, QCpt_width, NULL);
9969 in_width = XFASTINT (pt_width) / 72.0;
9970 img->width = in_width * FRAME_X_DISPLAY_INFO (f)->resx;
9971 pt_height = image_spec_value (img->spec, QCpt_height, NULL);
9972 in_height = XFASTINT (pt_height) / 72.0;
9973 img->height = in_height * FRAME_X_DISPLAY_INFO (f)->resy;
9975 /* Create the pixmap. */
9976 xassert (img->pixmap == None);
9977 img->pixmap = XCreatePixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9978 img->width, img->height,
9979 DefaultDepthOfScreen (FRAME_X_SCREEN (f)));
9981 if (!img->pixmap)
9983 image_error ("Unable to create pixmap for `%s'", img->spec, Qnil);
9984 return 0;
9987 /* Call the loader to fill the pixmap. It returns a process object
9988 if successful. We do not record_unwind_protect here because
9989 other places in redisplay like calling window scroll functions
9990 don't either. Let the Lisp loader use `unwind-protect' instead. */
9991 GCPRO2 (window_and_pixmap_id, pixel_colors);
9993 sprintf (buffer, "%lu %lu",
9994 (unsigned long) FRAME_X_WINDOW (f),
9995 (unsigned long) img->pixmap);
9996 window_and_pixmap_id = build_string (buffer);
9998 sprintf (buffer, "%lu %lu",
9999 FRAME_FOREGROUND_PIXEL (f),
10000 FRAME_BACKGROUND_PIXEL (f));
10001 pixel_colors = build_string (buffer);
10003 XSETFRAME (frame, f);
10004 loader = image_spec_value (img->spec, QCloader, NULL);
10005 if (NILP (loader))
10006 loader = intern ("gs-load-image");
10008 img->data.lisp_val = call6 (loader, frame, img->spec,
10009 make_number (img->width),
10010 make_number (img->height),
10011 window_and_pixmap_id,
10012 pixel_colors);
10013 UNGCPRO;
10014 return PROCESSP (img->data.lisp_val);
10018 /* Kill the Ghostscript process that was started to fill PIXMAP on
10019 frame F. Called from XTread_socket when receiving an event
10020 telling Emacs that Ghostscript has finished drawing. */
10022 void
10023 x_kill_gs_process (pixmap, f)
10024 Pixmap pixmap;
10025 struct frame *f;
10027 struct image_cache *c = FRAME_X_IMAGE_CACHE (f);
10028 int class, i;
10029 struct image *img;
10031 /* Find the image containing PIXMAP. */
10032 for (i = 0; i < c->used; ++i)
10033 if (c->images[i]->pixmap == pixmap)
10034 break;
10036 /* Kill the GS process. We should have found PIXMAP in the image
10037 cache and its image should contain a process object. */
10038 xassert (i < c->used);
10039 img = c->images[i];
10040 xassert (PROCESSP (img->data.lisp_val));
10041 Fkill_process (img->data.lisp_val, Qnil);
10042 img->data.lisp_val = Qnil;
10044 /* On displays with a mutable colormap, figure out the colors
10045 allocated for the image by looking at the pixels of an XImage for
10046 img->pixmap. */
10047 class = FRAME_X_VISUAL (f)->class;
10048 if (class != StaticColor && class != StaticGray && class != TrueColor)
10050 XImage *ximg;
10052 BLOCK_INPUT;
10054 /* Try to get an XImage for img->pixmep. */
10055 ximg = XGetImage (FRAME_X_DISPLAY (f), img->pixmap,
10056 0, 0, img->width, img->height, ~0, ZPixmap);
10057 if (ximg)
10059 int x, y;
10061 /* Initialize the color table. */
10062 init_color_table ();
10064 /* For each pixel of the image, look its color up in the
10065 color table. After having done so, the color table will
10066 contain an entry for each color used by the image. */
10067 for (y = 0; y < img->height; ++y)
10068 for (x = 0; x < img->width; ++x)
10070 unsigned long pixel = XGetPixel (ximg, x, y);
10071 lookup_pixel_color (f, pixel);
10074 /* Record colors in the image. Free color table and XImage. */
10075 img->colors = colors_in_color_table (&img->ncolors);
10076 free_color_table ();
10077 XDestroyImage (ximg);
10079 #if 0 /* This doesn't seem to be the case. If we free the colors
10080 here, we get a BadAccess later in x_clear_image when
10081 freeing the colors. */
10082 /* We have allocated colors once, but Ghostscript has also
10083 allocated colors on behalf of us. So, to get the
10084 reference counts right, free them once. */
10085 if (img->ncolors)
10086 x_free_colors (f, img->colors, img->ncolors);
10087 #endif
10089 else
10090 image_error ("Cannot get X image of `%s'; colors will not be freed",
10091 img->spec, Qnil);
10093 UNBLOCK_INPUT;
10099 /***********************************************************************
10100 Window properties
10101 ***********************************************************************/
10103 DEFUN ("x-change-window-property", Fx_change_window_property,
10104 Sx_change_window_property, 2, 3, 0,
10105 "Change window property PROP to VALUE on the X window of FRAME.\n\
10106 PROP and VALUE must be strings. FRAME nil or omitted means use the\n\
10107 selected frame. Value is VALUE.")
10108 (prop, value, frame)
10109 Lisp_Object frame, prop, value;
10111 struct frame *f = check_x_frame (frame);
10112 Atom prop_atom;
10114 CHECK_STRING (prop, 1);
10115 CHECK_STRING (value, 2);
10117 BLOCK_INPUT;
10118 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10119 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10120 prop_atom, XA_STRING, 8, PropModeReplace,
10121 XSTRING (value)->data, XSTRING (value)->size);
10123 /* Make sure the property is set when we return. */
10124 XFlush (FRAME_X_DISPLAY (f));
10125 UNBLOCK_INPUT;
10127 return value;
10131 DEFUN ("x-delete-window-property", Fx_delete_window_property,
10132 Sx_delete_window_property, 1, 2, 0,
10133 "Remove window property PROP from X window of FRAME.\n\
10134 FRAME nil or omitted means use the selected frame. Value is PROP.")
10135 (prop, frame)
10136 Lisp_Object prop, frame;
10138 struct frame *f = check_x_frame (frame);
10139 Atom prop_atom;
10141 CHECK_STRING (prop, 1);
10142 BLOCK_INPUT;
10143 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10144 XDeleteProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), prop_atom);
10146 /* Make sure the property is removed when we return. */
10147 XFlush (FRAME_X_DISPLAY (f));
10148 UNBLOCK_INPUT;
10150 return prop;
10154 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
10155 1, 2, 0,
10156 "Value is the value of window property PROP on FRAME.\n\
10157 If FRAME is nil or omitted, use the selected frame. Value is nil\n\
10158 if FRAME hasn't a property with name PROP or if PROP has no string\n\
10159 value.")
10160 (prop, frame)
10161 Lisp_Object prop, frame;
10163 struct frame *f = check_x_frame (frame);
10164 Atom prop_atom;
10165 int rc;
10166 Lisp_Object prop_value = Qnil;
10167 char *tmp_data = NULL;
10168 Atom actual_type;
10169 int actual_format;
10170 unsigned long actual_size, bytes_remaining;
10172 CHECK_STRING (prop, 1);
10173 BLOCK_INPUT;
10174 prop_atom = XInternAtom (FRAME_X_DISPLAY (f), XSTRING (prop)->data, False);
10175 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10176 prop_atom, 0, 0, False, XA_STRING,
10177 &actual_type, &actual_format, &actual_size,
10178 &bytes_remaining, (unsigned char **) &tmp_data);
10179 if (rc == Success)
10181 int size = bytes_remaining;
10183 XFree (tmp_data);
10184 tmp_data = NULL;
10186 rc = XGetWindowProperty (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10187 prop_atom, 0, bytes_remaining,
10188 False, XA_STRING,
10189 &actual_type, &actual_format,
10190 &actual_size, &bytes_remaining,
10191 (unsigned char **) &tmp_data);
10192 if (rc == Success)
10193 prop_value = make_string (tmp_data, size);
10195 XFree (tmp_data);
10198 UNBLOCK_INPUT;
10199 return prop_value;
10204 /***********************************************************************
10205 Busy cursor
10206 ***********************************************************************/
10208 /* If non-null, an asynchronous timer that, when it expires, displays
10209 an hourglass cursor on all frames. */
10211 static struct atimer *hourglass_atimer;
10213 /* Non-zero means an hourglass cursor is currently shown. */
10215 static int hourglass_shown_p;
10217 /* Number of seconds to wait before displaying an hourglass cursor. */
10219 static Lisp_Object Vhourglass_delay;
10221 /* Default number of seconds to wait before displaying an hourglass
10222 cursor. */
10224 #define DEFAULT_HOURGLASS_DELAY 1
10226 /* Function prototypes. */
10228 static void show_hourglass P_ ((struct atimer *));
10229 static void hide_hourglass P_ ((void));
10232 /* Cancel a currently active hourglass timer, and start a new one. */
10234 void
10235 start_hourglass ()
10237 EMACS_TIME delay;
10238 int secs, usecs = 0;
10240 cancel_hourglass ();
10242 if (INTEGERP (Vhourglass_delay)
10243 && XINT (Vhourglass_delay) > 0)
10244 secs = XFASTINT (Vhourglass_delay);
10245 else if (FLOATP (Vhourglass_delay)
10246 && XFLOAT_DATA (Vhourglass_delay) > 0)
10248 Lisp_Object tem;
10249 tem = Ftruncate (Vhourglass_delay, Qnil);
10250 secs = XFASTINT (tem);
10251 usecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000000;
10253 else
10254 secs = DEFAULT_HOURGLASS_DELAY;
10256 EMACS_SET_SECS_USECS (delay, secs, usecs);
10257 hourglass_atimer = start_atimer (ATIMER_RELATIVE, delay,
10258 show_hourglass, NULL);
10262 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
10263 shown. */
10265 void
10266 cancel_hourglass ()
10268 if (hourglass_atimer)
10270 cancel_atimer (hourglass_atimer);
10271 hourglass_atimer = NULL;
10274 if (hourglass_shown_p)
10275 hide_hourglass ();
10279 /* Timer function of hourglass_atimer. TIMER is equal to
10280 hourglass_atimer.
10282 Display an hourglass pointer on all frames by mapping the frames'
10283 hourglass_window. Set the hourglass_p flag in the frames'
10284 output_data.x structure to indicate that an hourglass cursor is
10285 shown on the frames. */
10287 static void
10288 show_hourglass (timer)
10289 struct atimer *timer;
10291 /* The timer implementation will cancel this timer automatically
10292 after this function has run. Set hourglass_atimer to null
10293 so that we know the timer doesn't have to be canceled. */
10294 hourglass_atimer = NULL;
10296 if (!hourglass_shown_p)
10298 Lisp_Object rest, frame;
10300 BLOCK_INPUT;
10302 FOR_EACH_FRAME (rest, frame)
10304 struct frame *f = XFRAME (frame);
10306 if (FRAME_LIVE_P (f) && FRAME_X_P (f) && FRAME_X_DISPLAY (f))
10308 Display *dpy = FRAME_X_DISPLAY (f);
10310 #ifdef USE_X_TOOLKIT
10311 if (f->output_data.x->widget)
10312 #else
10313 if (FRAME_OUTER_WINDOW (f))
10314 #endif
10316 f->output_data.x->hourglass_p = 1;
10318 if (!f->output_data.x->hourglass_window)
10320 unsigned long mask = CWCursor;
10321 XSetWindowAttributes attrs;
10323 attrs.cursor = f->output_data.x->hourglass_cursor;
10325 f->output_data.x->hourglass_window
10326 = XCreateWindow (dpy, FRAME_OUTER_WINDOW (f),
10327 0, 0, 32000, 32000, 0, 0,
10328 InputOnly,
10329 CopyFromParent,
10330 mask, &attrs);
10333 XMapRaised (dpy, f->output_data.x->hourglass_window);
10334 XFlush (dpy);
10339 hourglass_shown_p = 1;
10340 UNBLOCK_INPUT;
10345 /* Hide the hourglass pointer on all frames, if it is currently
10346 shown. */
10348 static void
10349 hide_hourglass ()
10351 if (hourglass_shown_p)
10353 Lisp_Object rest, frame;
10355 BLOCK_INPUT;
10356 FOR_EACH_FRAME (rest, frame)
10358 struct frame *f = XFRAME (frame);
10360 if (FRAME_X_P (f)
10361 /* Watch out for newly created frames. */
10362 && f->output_data.x->hourglass_window)
10364 XUnmapWindow (FRAME_X_DISPLAY (f),
10365 f->output_data.x->hourglass_window);
10366 /* Sync here because XTread_socket looks at the
10367 hourglass_p flag that is reset to zero below. */
10368 XSync (FRAME_X_DISPLAY (f), False);
10369 f->output_data.x->hourglass_p = 0;
10373 hourglass_shown_p = 0;
10374 UNBLOCK_INPUT;
10380 /***********************************************************************
10381 Tool tips
10382 ***********************************************************************/
10384 static Lisp_Object x_create_tip_frame P_ ((struct x_display_info *,
10385 Lisp_Object, Lisp_Object));
10386 static void compute_tip_xy P_ ((struct frame *, Lisp_Object, Lisp_Object,
10387 Lisp_Object, int *, int *));
10389 /* The frame of a currently visible tooltip. */
10391 Lisp_Object tip_frame;
10393 /* If non-nil, a timer started that hides the last tooltip when it
10394 fires. */
10396 Lisp_Object tip_timer;
10397 Window tip_window;
10399 /* If non-nil, a vector of 3 elements containing the last args
10400 with which x-show-tip was called. See there. */
10402 Lisp_Object last_show_tip_args;
10405 static Lisp_Object
10406 unwind_create_tip_frame (frame)
10407 Lisp_Object frame;
10409 Lisp_Object deleted;
10411 deleted = unwind_create_frame (frame);
10412 if (EQ (deleted, Qt))
10414 tip_window = None;
10415 tip_frame = Qnil;
10418 return deleted;
10422 /* Create a frame for a tooltip on the display described by DPYINFO.
10423 PARMS is a list of frame parameters. TEXT is the string to
10424 display in the tip frame. Value is the frame.
10426 Note that functions called here, esp. x_default_parameter can
10427 signal errors, for instance when a specified color name is
10428 undefined. We have to make sure that we're in a consistent state
10429 when this happens. */
10431 static Lisp_Object
10432 x_create_tip_frame (dpyinfo, parms, text)
10433 struct x_display_info *dpyinfo;
10434 Lisp_Object parms, text;
10436 struct frame *f;
10437 Lisp_Object frame, tem;
10438 Lisp_Object name;
10439 long window_prompting = 0;
10440 int width, height;
10441 int count = BINDING_STACK_SIZE ();
10442 struct gcpro gcpro1, gcpro2, gcpro3;
10443 struct kboard *kb;
10444 int face_change_count_before = face_change_count;
10445 Lisp_Object buffer;
10446 struct buffer *old_buffer;
10448 check_x ();
10450 /* Use this general default value to start with until we know if
10451 this frame has a specified name. */
10452 Vx_resource_name = Vinvocation_name;
10454 #ifdef MULTI_KBOARD
10455 kb = dpyinfo->kboard;
10456 #else
10457 kb = &the_only_kboard;
10458 #endif
10460 /* Get the name of the frame to use for resource lookup. */
10461 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
10462 if (!STRINGP (name)
10463 && !EQ (name, Qunbound)
10464 && !NILP (name))
10465 error ("Invalid frame name--not a string or nil");
10466 Vx_resource_name = name;
10468 frame = Qnil;
10469 GCPRO3 (parms, name, frame);
10470 f = make_frame (1);
10471 XSETFRAME (frame, f);
10473 buffer = Fget_buffer_create (build_string (" *tip*"));
10474 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer);
10475 old_buffer = current_buffer;
10476 set_buffer_internal_1 (XBUFFER (buffer));
10477 Ferase_buffer ();
10478 Finsert (1, &text);
10479 set_buffer_internal_1 (old_buffer);
10481 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
10482 record_unwind_protect (unwind_create_tip_frame, frame);
10484 /* By setting the output method, we're essentially saying that
10485 the frame is live, as per FRAME_LIVE_P. If we get a signal
10486 from this point on, x_destroy_window might screw up reference
10487 counts etc. */
10488 f->output_method = output_x_window;
10489 f->output_data.x = (struct x_output *) xmalloc (sizeof (struct x_output));
10490 bzero (f->output_data.x, sizeof (struct x_output));
10491 f->output_data.x->icon_bitmap = -1;
10492 f->output_data.x->fontset = -1;
10493 f->output_data.x->scroll_bar_foreground_pixel = -1;
10494 f->output_data.x->scroll_bar_background_pixel = -1;
10495 f->icon_name = Qnil;
10496 FRAME_X_DISPLAY_INFO (f) = dpyinfo;
10497 #if GLYPH_DEBUG
10498 image_cache_refcount = FRAME_X_IMAGE_CACHE (f)->refcount;
10499 dpyinfo_refcount = dpyinfo->reference_count;
10500 #endif /* GLYPH_DEBUG */
10501 #ifdef MULTI_KBOARD
10502 FRAME_KBOARD (f) = kb;
10503 #endif
10504 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10505 f->output_data.x->explicit_parent = 0;
10507 /* These colors will be set anyway later, but it's important
10508 to get the color reference counts right, so initialize them! */
10510 Lisp_Object black;
10511 struct gcpro gcpro1;
10513 black = build_string ("black");
10514 GCPRO1 (black);
10515 f->output_data.x->foreground_pixel
10516 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10517 f->output_data.x->background_pixel
10518 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10519 f->output_data.x->cursor_pixel
10520 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10521 f->output_data.x->cursor_foreground_pixel
10522 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10523 f->output_data.x->border_pixel
10524 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10525 f->output_data.x->mouse_pixel
10526 = x_decode_color (f, black, BLACK_PIX_DEFAULT (f));
10527 UNGCPRO;
10530 /* Set the name; the functions to which we pass f expect the name to
10531 be set. */
10532 if (EQ (name, Qunbound) || NILP (name))
10534 f->name = build_string (dpyinfo->x_id_name);
10535 f->explicit_name = 0;
10537 else
10539 f->name = name;
10540 f->explicit_name = 1;
10541 /* use the frame's title when getting resources for this frame. */
10542 specbind (Qx_resource_name, name);
10545 /* Extract the window parameters from the supplied values that are
10546 needed to determine window geometry. */
10548 Lisp_Object font;
10550 font = x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
10552 BLOCK_INPUT;
10553 /* First, try whatever font the caller has specified. */
10554 if (STRINGP (font))
10556 tem = Fquery_fontset (font, Qnil);
10557 if (STRINGP (tem))
10558 font = x_new_fontset (f, XSTRING (tem)->data);
10559 else
10560 font = x_new_font (f, XSTRING (font)->data);
10563 /* Try out a font which we hope has bold and italic variations. */
10564 if (!STRINGP (font))
10565 font = x_new_font (f, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
10566 if (!STRINGP (font))
10567 font = x_new_font (f, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10568 if (! STRINGP (font))
10569 font = x_new_font (f, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10570 if (! STRINGP (font))
10571 /* This was formerly the first thing tried, but it finds too many fonts
10572 and takes too long. */
10573 font = x_new_font (f, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
10574 /* If those didn't work, look for something which will at least work. */
10575 if (! STRINGP (font))
10576 font = x_new_font (f, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
10577 UNBLOCK_INPUT;
10578 if (! STRINGP (font))
10579 font = build_string ("fixed");
10581 x_default_parameter (f, parms, Qfont, font,
10582 "font", "Font", RES_TYPE_STRING);
10585 x_default_parameter (f, parms, Qborder_width, make_number (2),
10586 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
10588 /* This defaults to 2 in order to match xterm. We recognize either
10589 internalBorderWidth or internalBorder (which is what xterm calls
10590 it). */
10591 if (NILP (Fassq (Qinternal_border_width, parms)))
10593 Lisp_Object value;
10595 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
10596 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
10597 if (! EQ (value, Qunbound))
10598 parms = Fcons (Fcons (Qinternal_border_width, value),
10599 parms);
10602 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
10603 "internalBorderWidth", "internalBorderWidth",
10604 RES_TYPE_NUMBER);
10606 /* Also do the stuff which must be set before the window exists. */
10607 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
10608 "foreground", "Foreground", RES_TYPE_STRING);
10609 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
10610 "background", "Background", RES_TYPE_STRING);
10611 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
10612 "pointerColor", "Foreground", RES_TYPE_STRING);
10613 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
10614 "cursorColor", "Foreground", RES_TYPE_STRING);
10615 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
10616 "borderColor", "BorderColor", RES_TYPE_STRING);
10618 /* Init faces before x_default_parameter is called for scroll-bar
10619 parameters because that function calls x_set_scroll_bar_width,
10620 which calls change_frame_size, which calls Fset_window_buffer,
10621 which runs hooks, which call Fvertical_motion. At the end, we
10622 end up in init_iterator with a null face cache, which should not
10623 happen. */
10624 init_frame_faces (f);
10626 f->output_data.x->parent_desc = FRAME_X_DISPLAY_INFO (f)->root_window;
10627 window_prompting = x_figure_window_size (f, parms);
10629 if (window_prompting & XNegative)
10631 if (window_prompting & YNegative)
10632 f->output_data.x->win_gravity = SouthEastGravity;
10633 else
10634 f->output_data.x->win_gravity = NorthEastGravity;
10636 else
10638 if (window_prompting & YNegative)
10639 f->output_data.x->win_gravity = SouthWestGravity;
10640 else
10641 f->output_data.x->win_gravity = NorthWestGravity;
10644 f->output_data.x->size_hint_flags = window_prompting;
10646 XSetWindowAttributes attrs;
10647 unsigned long mask;
10649 BLOCK_INPUT;
10650 mask = CWBackPixel | CWOverrideRedirect | CWEventMask;
10651 if (DoesSaveUnders (dpyinfo->screen))
10652 mask |= CWSaveUnder;
10654 /* Window managers look at the override-redirect flag to determine
10655 whether or net to give windows a decoration (Xlib spec, chapter
10656 3.2.8). */
10657 attrs.override_redirect = True;
10658 attrs.save_under = True;
10659 attrs.background_pixel = FRAME_BACKGROUND_PIXEL (f);
10660 /* Arrange for getting MapNotify and UnmapNotify events. */
10661 attrs.event_mask = StructureNotifyMask;
10662 tip_window
10663 = FRAME_X_WINDOW (f)
10664 = XCreateWindow (FRAME_X_DISPLAY (f),
10665 FRAME_X_DISPLAY_INFO (f)->root_window,
10666 /* x, y, width, height */
10667 0, 0, 1, 1,
10668 /* Border. */
10670 CopyFromParent, InputOutput, CopyFromParent,
10671 mask, &attrs);
10672 UNBLOCK_INPUT;
10675 x_make_gc (f);
10677 x_default_parameter (f, parms, Qauto_raise, Qnil,
10678 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
10679 x_default_parameter (f, parms, Qauto_lower, Qnil,
10680 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
10681 x_default_parameter (f, parms, Qcursor_type, Qbox,
10682 "cursorType", "CursorType", RES_TYPE_SYMBOL);
10684 /* Dimensions, especially f->height, must be done via change_frame_size.
10685 Change will not be effected unless different from the current
10686 f->height. */
10687 width = f->width;
10688 height = f->height;
10689 f->height = 0;
10690 SET_FRAME_WIDTH (f, 0);
10691 change_frame_size (f, height, width, 1, 0, 0);
10693 /* Set up faces after all frame parameters are known. This call
10694 also merges in face attributes specified for new frames.
10696 Frame parameters may be changed if .Xdefaults contains
10697 specifications for the default font. For example, if there is an
10698 `Emacs.default.attributeBackground: pink', the `background-color'
10699 attribute of the frame get's set, which let's the internal border
10700 of the tooltip frame appear in pink. Prevent this. */
10702 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
10704 /* Set tip_frame here, so that */
10705 tip_frame = frame;
10706 call1 (Qface_set_after_frame_default, frame);
10708 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
10709 Fmodify_frame_parameters (frame, Fcons (Fcons (Qbackground_color, bg),
10710 Qnil));
10713 f->no_split = 1;
10715 UNGCPRO;
10717 /* It is now ok to make the frame official even if we get an error
10718 below. And the frame needs to be on Vframe_list or making it
10719 visible won't work. */
10720 Vframe_list = Fcons (frame, Vframe_list);
10722 /* Now that the frame is official, it counts as a reference to
10723 its display. */
10724 FRAME_X_DISPLAY_INFO (f)->reference_count++;
10726 /* Setting attributes of faces of the tooltip frame from resources
10727 and similar will increment face_change_count, which leads to the
10728 clearing of all current matrices. Since this isn't necessary
10729 here, avoid it by resetting face_change_count to the value it
10730 had before we created the tip frame. */
10731 face_change_count = face_change_count_before;
10733 /* Discard the unwind_protect. */
10734 return unbind_to (count, frame);
10738 /* Compute where to display tip frame F. PARMS is the list of frame
10739 parameters for F. DX and DY are specified offsets from the current
10740 location of the mouse. Return coordinates relative to the root
10741 window of the display in *ROOT_X, and *ROOT_Y. */
10743 static void
10744 compute_tip_xy (f, parms, dx, dy, root_x, root_y)
10745 struct frame *f;
10746 Lisp_Object parms, dx, dy;
10747 int *root_x, *root_y;
10749 Lisp_Object left, top;
10750 int win_x, win_y;
10751 Window root, child;
10752 unsigned pmask;
10754 /* User-specified position? */
10755 left = Fcdr (Fassq (Qleft, parms));
10756 top = Fcdr (Fassq (Qtop, parms));
10758 /* Move the tooltip window where the mouse pointer is. Resize and
10759 show it. */
10760 BLOCK_INPUT;
10761 XQueryPointer (FRAME_X_DISPLAY (f), FRAME_X_DISPLAY_INFO (f)->root_window,
10762 &root, &child, root_x, root_y, &win_x, &win_y, &pmask);
10763 UNBLOCK_INPUT;
10765 *root_x += XINT (dx);
10766 *root_y += XINT (dy);
10768 if (INTEGERP (left))
10769 *root_x = XINT (left);
10770 if (INTEGERP (top))
10771 *root_y = XINT (top);
10775 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
10776 "Show STRING in a \"tooltip\" window on frame FRAME.\n\
10777 A tooltip window is a small X window displaying a string.\n\
10779 FRAME nil or omitted means use the selected frame.\n\
10781 PARMS is an optional list of frame parameters which can be\n\
10782 used to change the tooltip's appearance.\n\
10784 Automatically hide the tooltip after TIMEOUT seconds.\n\
10785 TIMEOUT nil means use the default timeout of 5 seconds.\n\
10787 If the list of frame parameters PARAMS contains a `left' parameters,\n\
10788 the tooltip is displayed at that x-position. Otherwise it is\n\
10789 displayed at the mouse position, with offset DX added (default is 5 if\n\
10790 DX isn't specified). Likewise for the y-position; if a `top' frame\n\
10791 parameter is specified, it determines the y-position of the tooltip\n\
10792 window, otherwise it is displayed at the mouse position, with offset\n\
10793 DY added (default is -10).")
10794 (string, frame, parms, timeout, dx, dy)
10795 Lisp_Object string, frame, parms, timeout, dx, dy;
10797 struct frame *f;
10798 struct window *w;
10799 Lisp_Object buffer, top, left;
10800 int root_x, root_y;
10801 struct buffer *old_buffer;
10802 struct text_pos pos;
10803 int i, width, height;
10804 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
10805 int old_windows_or_buffers_changed = windows_or_buffers_changed;
10806 int count = BINDING_STACK_SIZE ();
10808 specbind (Qinhibit_redisplay, Qt);
10810 GCPRO4 (string, parms, frame, timeout);
10812 CHECK_STRING (string, 0);
10813 f = check_x_frame (frame);
10814 if (NILP (timeout))
10815 timeout = make_number (5);
10816 else
10817 CHECK_NATNUM (timeout, 2);
10819 if (NILP (dx))
10820 dx = make_number (5);
10821 else
10822 CHECK_NUMBER (dx, 5);
10824 if (NILP (dy))
10825 dy = make_number (-10);
10826 else
10827 CHECK_NUMBER (dy, 6);
10829 if (NILP (last_show_tip_args))
10830 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
10832 if (!NILP (tip_frame))
10834 Lisp_Object last_string = AREF (last_show_tip_args, 0);
10835 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
10836 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
10838 if (EQ (frame, last_frame)
10839 && !NILP (Fequal (last_string, string))
10840 && !NILP (Fequal (last_parms, parms)))
10842 struct frame *f = XFRAME (tip_frame);
10844 /* Only DX and DY have changed. */
10845 if (!NILP (tip_timer))
10847 Lisp_Object timer = tip_timer;
10848 tip_timer = Qnil;
10849 call1 (Qcancel_timer, timer);
10852 BLOCK_INPUT;
10853 compute_tip_xy (f, parms, dx, dy, &root_x, &root_y);
10854 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10855 root_x, root_y - PIXEL_HEIGHT (f));
10856 UNBLOCK_INPUT;
10857 goto start_timer;
10861 /* Hide a previous tip, if any. */
10862 Fx_hide_tip ();
10864 ASET (last_show_tip_args, 0, string);
10865 ASET (last_show_tip_args, 1, frame);
10866 ASET (last_show_tip_args, 2, parms);
10868 /* Add default values to frame parameters. */
10869 if (NILP (Fassq (Qname, parms)))
10870 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
10871 if (NILP (Fassq (Qinternal_border_width, parms)))
10872 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
10873 if (NILP (Fassq (Qborder_width, parms)))
10874 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
10875 if (NILP (Fassq (Qborder_color, parms)))
10876 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
10877 if (NILP (Fassq (Qbackground_color, parms)))
10878 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
10879 parms);
10881 /* Create a frame for the tooltip, and record it in the global
10882 variable tip_frame. */
10883 frame = x_create_tip_frame (FRAME_X_DISPLAY_INFO (f), parms, string);
10884 f = XFRAME (frame);
10886 /* Set up the frame's root window. Currently we use a size of 80
10887 columns x 40 lines. If someone wants to show a larger tip, he
10888 will loose. I don't think this is a realistic case. */
10889 w = XWINDOW (FRAME_ROOT_WINDOW (f));
10890 w->left = w->top = make_number (0);
10891 w->width = make_number (80);
10892 w->height = make_number (40);
10893 adjust_glyphs (f);
10894 w->pseudo_window_p = 1;
10896 /* Display the tooltip text in a temporary buffer. */
10897 old_buffer = current_buffer;
10898 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
10899 clear_glyph_matrix (w->desired_matrix);
10900 clear_glyph_matrix (w->current_matrix);
10901 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
10902 try_window (FRAME_ROOT_WINDOW (f), pos);
10904 /* Compute width and height of the tooltip. */
10905 width = height = 0;
10906 for (i = 0; i < w->desired_matrix->nrows; ++i)
10908 struct glyph_row *row = &w->desired_matrix->rows[i];
10909 struct glyph *last;
10910 int row_width;
10912 /* Stop at the first empty row at the end. */
10913 if (!row->enabled_p || !row->displays_text_p)
10914 break;
10916 /* Let the row go over the full width of the frame. */
10917 row->full_width_p = 1;
10919 /* There's a glyph at the end of rows that is used to place
10920 the cursor there. Don't include the width of this glyph. */
10921 if (row->used[TEXT_AREA])
10923 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
10924 row_width = row->pixel_width - last->pixel_width;
10926 else
10927 row_width = row->pixel_width;
10929 height += row->height;
10930 width = max (width, row_width);
10933 /* Add the frame's internal border to the width and height the X
10934 window should have. */
10935 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
10936 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
10938 /* Move the tooltip window where the mouse pointer is. Resize and
10939 show it. */
10940 compute_tip_xy (f, parms, dx, dy, &root_x, &root_y);
10942 BLOCK_INPUT;
10943 XMoveResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
10944 root_x, root_y - height, width, height);
10945 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
10946 UNBLOCK_INPUT;
10948 /* Draw into the window. */
10949 w->must_be_updated_p = 1;
10950 update_single_window (w, 1);
10952 /* Restore original current buffer. */
10953 set_buffer_internal_1 (old_buffer);
10954 windows_or_buffers_changed = old_windows_or_buffers_changed;
10956 start_timer:
10957 /* Let the tip disappear after timeout seconds. */
10958 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
10959 intern ("x-hide-tip"));
10961 UNGCPRO;
10962 return unbind_to (count, Qnil);
10966 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
10967 "Hide the current tooltip window, if there is any.\n\
10968 Value is t is tooltip was open, nil otherwise.")
10971 int count;
10972 Lisp_Object deleted, frame, timer;
10973 struct gcpro gcpro1, gcpro2;
10975 /* Return quickly if nothing to do. */
10976 if (NILP (tip_timer) && NILP (tip_frame))
10977 return Qnil;
10979 frame = tip_frame;
10980 timer = tip_timer;
10981 GCPRO2 (frame, timer);
10982 tip_frame = tip_timer = deleted = Qnil;
10984 count = BINDING_STACK_SIZE ();
10985 specbind (Qinhibit_redisplay, Qt);
10986 specbind (Qinhibit_quit, Qt);
10988 if (!NILP (timer))
10989 call1 (Qcancel_timer, timer);
10991 if (FRAMEP (frame))
10993 Fdelete_frame (frame, Qnil);
10994 deleted = Qt;
10996 #ifdef USE_LUCID
10997 /* Bloodcurdling hack alert: The Lucid menu bar widget's
10998 redisplay procedure is not called when a tip frame over menu
10999 items is unmapped. Redisplay the menu manually... */
11001 struct frame *f = SELECTED_FRAME ();
11002 Widget w = f->output_data.x->menubar_widget;
11003 extern void xlwmenu_redisplay P_ ((Widget));
11005 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f)->screen)
11006 && w != NULL)
11008 BLOCK_INPUT;
11009 xlwmenu_redisplay (w);
11010 UNBLOCK_INPUT;
11013 #endif /* USE_LUCID */
11016 UNGCPRO;
11017 return unbind_to (count, deleted);
11022 /***********************************************************************
11023 File selection dialog
11024 ***********************************************************************/
11026 #ifdef USE_MOTIF
11028 /* Callback for "OK" and "Cancel" on file selection dialog. */
11030 static void
11031 file_dialog_cb (widget, client_data, call_data)
11032 Widget widget;
11033 XtPointer call_data, client_data;
11035 int *result = (int *) client_data;
11036 XmAnyCallbackStruct *cb = (XmAnyCallbackStruct *) call_data;
11037 *result = cb->reason;
11041 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0,
11042 "Read file name, prompting with PROMPT in directory DIR.\n\
11043 Use a file selection dialog.\n\
11044 Select DEFAULT-FILENAME in the dialog's file selection box, if\n\
11045 specified. Don't let the user enter a file name in the file\n\
11046 selection dialog's entry field, if MUSTMATCH is non-nil.")
11047 (prompt, dir, default_filename, mustmatch)
11048 Lisp_Object prompt, dir, default_filename, mustmatch;
11050 int result;
11051 struct frame *f = SELECTED_FRAME ();
11052 Lisp_Object file = Qnil;
11053 Widget dialog, text, list, help;
11054 Arg al[10];
11055 int ac = 0;
11056 extern XtAppContext Xt_app_con;
11057 char *title;
11058 XmString dir_xmstring, pattern_xmstring;
11059 int popup_activated_flag;
11060 int count = specpdl_ptr - specpdl;
11061 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
11063 GCPRO5 (prompt, dir, default_filename, mustmatch, file);
11064 CHECK_STRING (prompt, 0);
11065 CHECK_STRING (dir, 1);
11067 /* Prevent redisplay. */
11068 specbind (Qinhibit_redisplay, Qt);
11070 BLOCK_INPUT;
11072 /* Create the dialog with PROMPT as title, using DIR as initial
11073 directory and using "*" as pattern. */
11074 dir = Fexpand_file_name (dir, Qnil);
11075 dir_xmstring = XmStringCreateLocalized (XSTRING (dir)->data);
11076 pattern_xmstring = XmStringCreateLocalized ("*");
11078 XtSetArg (al[ac], XmNtitle, XSTRING (prompt)->data); ++ac;
11079 XtSetArg (al[ac], XmNdirectory, dir_xmstring); ++ac;
11080 XtSetArg (al[ac], XmNpattern, pattern_xmstring); ++ac;
11081 XtSetArg (al[ac], XmNresizePolicy, XmRESIZE_GROW); ++ac;
11082 XtSetArg (al[ac], XmNdialogStyle, XmDIALOG_APPLICATION_MODAL); ++ac;
11083 dialog = XmCreateFileSelectionDialog (f->output_data.x->widget,
11084 "fsb", al, ac);
11085 XmStringFree (dir_xmstring);
11086 XmStringFree (pattern_xmstring);
11088 /* Add callbacks for OK and Cancel. */
11089 XtAddCallback (dialog, XmNokCallback, file_dialog_cb,
11090 (XtPointer) &result);
11091 XtAddCallback (dialog, XmNcancelCallback, file_dialog_cb,
11092 (XtPointer) &result);
11094 /* Disable the help button since we can't display help. */
11095 help = XmFileSelectionBoxGetChild (dialog, XmDIALOG_HELP_BUTTON);
11096 XtSetSensitive (help, False);
11098 /* Mark OK button as default. */
11099 XtVaSetValues (XmFileSelectionBoxGetChild (dialog, XmDIALOG_OK_BUTTON),
11100 XmNshowAsDefault, True, NULL);
11102 /* If MUSTMATCH is non-nil, disable the file entry field of the
11103 dialog, so that the user must select a file from the files list
11104 box. We can't remove it because we wouldn't have a way to get at
11105 the result file name, then. */
11106 text = XmFileSelectionBoxGetChild (dialog, XmDIALOG_TEXT);
11107 if (!NILP (mustmatch))
11109 Widget label;
11110 label = XmFileSelectionBoxGetChild (dialog, XmDIALOG_SELECTION_LABEL);
11111 XtSetSensitive (text, False);
11112 XtSetSensitive (label, False);
11115 /* Manage the dialog, so that list boxes get filled. */
11116 XtManageChild (dialog);
11118 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
11119 must include the path for this to work. */
11120 list = XmFileSelectionBoxGetChild (dialog, XmDIALOG_LIST);
11121 if (STRINGP (default_filename))
11123 XmString default_xmstring;
11124 int item_pos;
11126 default_xmstring
11127 = XmStringCreateLocalized (XSTRING (default_filename)->data);
11129 if (!XmListItemExists (list, default_xmstring))
11131 /* Add a new item if DEFAULT_FILENAME is not in the list. */
11132 XmListAddItem (list, default_xmstring, 0);
11133 item_pos = 0;
11135 else
11136 item_pos = XmListItemPos (list, default_xmstring);
11137 XmStringFree (default_xmstring);
11139 /* Select the item and scroll it into view. */
11140 XmListSelectPos (list, item_pos, True);
11141 XmListSetPos (list, item_pos);
11144 /* Process events until the user presses Cancel or OK. */
11145 result = 0;
11146 while (result == 0 || XtAppPending (Xt_app_con))
11147 XtAppProcessEvent (Xt_app_con, XtIMAll);
11149 /* Get the result. */
11150 if (result == XmCR_OK)
11152 XmString text;
11153 String data;
11155 XtVaGetValues (dialog, XmNtextString, &text, NULL);
11156 XmStringGetLtoR (text, XmFONTLIST_DEFAULT_TAG, &data);
11157 XmStringFree (text);
11158 file = build_string (data);
11159 XtFree (data);
11161 else
11162 file = Qnil;
11164 /* Clean up. */
11165 XtUnmanageChild (dialog);
11166 XtDestroyWidget (dialog);
11167 UNBLOCK_INPUT;
11168 UNGCPRO;
11170 /* Make "Cancel" equivalent to C-g. */
11171 if (NILP (file))
11172 Fsignal (Qquit, Qnil);
11174 return unbind_to (count, file);
11177 #endif /* USE_MOTIF */
11181 /***********************************************************************
11182 Keyboard
11183 ***********************************************************************/
11185 #ifdef HAVE_XKBGETKEYBOARD
11186 #include <X11/XKBlib.h>
11187 #include <X11/keysym.h>
11188 #endif
11190 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
11191 Sx_backspace_delete_keys_p, 0, 1, 0,
11192 "Check if both Backspace and Delete keys are on the keyboard of FRAME.\n\
11193 FRAME nil means use the selected frame.\n\
11194 Value is t if we know that both keys are present, and are mapped to the\n\
11195 usual X keysyms.")
11196 (frame)
11197 Lisp_Object frame;
11199 #ifdef HAVE_XKBGETKEYBOARD
11200 XkbDescPtr kb;
11201 struct frame *f = check_x_frame (frame);
11202 Display *dpy = FRAME_X_DISPLAY (f);
11203 Lisp_Object have_keys;
11204 int major, minor, op, event, error;
11206 BLOCK_INPUT;
11208 /* Check library version in case we're dynamically linked. */
11209 major = XkbMajorVersion;
11210 minor = XkbMinorVersion;
11211 if (!XkbLibraryVersion (&major, &minor))
11213 UNBLOCK_INPUT;
11214 return Qnil;
11217 /* Check that the server supports XKB. */
11218 major = XkbMajorVersion;
11219 minor = XkbMinorVersion;
11220 if (!XkbQueryExtension (dpy, &op, &event, &error, &major, &minor))
11222 UNBLOCK_INPUT;
11223 return Qnil;
11226 have_keys = Qnil;
11227 kb = XkbGetMap (dpy, XkbAllMapComponentsMask, XkbUseCoreKbd);
11228 if (kb)
11230 int delete_keycode = 0, backspace_keycode = 0, i;
11232 if (XkbGetNames (dpy, XkbAllNamesMask, kb) == Success)
11234 for (i = kb->min_key_code;
11235 (i < kb->max_key_code
11236 && (delete_keycode == 0 || backspace_keycode == 0));
11237 ++i)
11239 /* The XKB symbolic key names can be seen most easily
11240 in the PS file generated by `xkbprint -label name $DISPLAY'. */
11241 if (bcmp ("DELE", kb->names->keys[i].name, 4) == 0)
11242 delete_keycode = i;
11243 else if (bcmp ("BKSP", kb->names->keys[i].name, 4) == 0)
11244 backspace_keycode = i;
11247 XkbFreeNames (kb, 0, True);
11250 XkbFreeClientMap (kb, 0, True);
11252 if (delete_keycode
11253 && backspace_keycode
11254 && XKeysymToKeycode (dpy, XK_Delete) == delete_keycode
11255 && XKeysymToKeycode (dpy, XK_BackSpace) == backspace_keycode)
11256 have_keys = Qt;
11258 UNBLOCK_INPUT;
11259 return have_keys;
11260 #else /* not HAVE_XKBGETKEYBOARD */
11261 return Qnil;
11262 #endif /* not HAVE_XKBGETKEYBOARD */
11267 /***********************************************************************
11268 Initialization
11269 ***********************************************************************/
11271 void
11272 syms_of_xfns ()
11274 /* This is zero if not using X windows. */
11275 x_in_use = 0;
11277 /* The section below is built by the lisp expression at the top of the file,
11278 just above where these variables are declared. */
11279 /*&&& init symbols here &&&*/
11280 Qauto_raise = intern ("auto-raise");
11281 staticpro (&Qauto_raise);
11282 Qauto_lower = intern ("auto-lower");
11283 staticpro (&Qauto_lower);
11284 Qbar = intern ("bar");
11285 staticpro (&Qbar);
11286 Qborder_color = intern ("border-color");
11287 staticpro (&Qborder_color);
11288 Qborder_width = intern ("border-width");
11289 staticpro (&Qborder_width);
11290 Qbox = intern ("box");
11291 staticpro (&Qbox);
11292 Qcursor_color = intern ("cursor-color");
11293 staticpro (&Qcursor_color);
11294 Qcursor_type = intern ("cursor-type");
11295 staticpro (&Qcursor_type);
11296 Qgeometry = intern ("geometry");
11297 staticpro (&Qgeometry);
11298 Qicon_left = intern ("icon-left");
11299 staticpro (&Qicon_left);
11300 Qicon_top = intern ("icon-top");
11301 staticpro (&Qicon_top);
11302 Qicon_type = intern ("icon-type");
11303 staticpro (&Qicon_type);
11304 Qicon_name = intern ("icon-name");
11305 staticpro (&Qicon_name);
11306 Qinternal_border_width = intern ("internal-border-width");
11307 staticpro (&Qinternal_border_width);
11308 Qleft = intern ("left");
11309 staticpro (&Qleft);
11310 Qright = intern ("right");
11311 staticpro (&Qright);
11312 Qmouse_color = intern ("mouse-color");
11313 staticpro (&Qmouse_color);
11314 Qnone = intern ("none");
11315 staticpro (&Qnone);
11316 Qparent_id = intern ("parent-id");
11317 staticpro (&Qparent_id);
11318 Qscroll_bar_width = intern ("scroll-bar-width");
11319 staticpro (&Qscroll_bar_width);
11320 Qsuppress_icon = intern ("suppress-icon");
11321 staticpro (&Qsuppress_icon);
11322 Qundefined_color = intern ("undefined-color");
11323 staticpro (&Qundefined_color);
11324 Qvertical_scroll_bars = intern ("vertical-scroll-bars");
11325 staticpro (&Qvertical_scroll_bars);
11326 Qvisibility = intern ("visibility");
11327 staticpro (&Qvisibility);
11328 Qwindow_id = intern ("window-id");
11329 staticpro (&Qwindow_id);
11330 Qouter_window_id = intern ("outer-window-id");
11331 staticpro (&Qouter_window_id);
11332 Qx_frame_parameter = intern ("x-frame-parameter");
11333 staticpro (&Qx_frame_parameter);
11334 Qx_resource_name = intern ("x-resource-name");
11335 staticpro (&Qx_resource_name);
11336 Quser_position = intern ("user-position");
11337 staticpro (&Quser_position);
11338 Quser_size = intern ("user-size");
11339 staticpro (&Quser_size);
11340 Qscroll_bar_foreground = intern ("scroll-bar-foreground");
11341 staticpro (&Qscroll_bar_foreground);
11342 Qscroll_bar_background = intern ("scroll-bar-background");
11343 staticpro (&Qscroll_bar_background);
11344 Qscreen_gamma = intern ("screen-gamma");
11345 staticpro (&Qscreen_gamma);
11346 Qline_spacing = intern ("line-spacing");
11347 staticpro (&Qline_spacing);
11348 Qcenter = intern ("center");
11349 staticpro (&Qcenter);
11350 Qcompound_text = intern ("compound-text");
11351 staticpro (&Qcompound_text);
11352 Qcancel_timer = intern ("cancel-timer");
11353 staticpro (&Qcancel_timer);
11354 /* This is the end of symbol initialization. */
11356 /* Text property `display' should be nonsticky by default. */
11357 Vtext_property_default_nonsticky
11358 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
11361 Qlaplace = intern ("laplace");
11362 staticpro (&Qlaplace);
11363 Qemboss = intern ("emboss");
11364 staticpro (&Qemboss);
11365 Qedge_detection = intern ("edge-detection");
11366 staticpro (&Qedge_detection);
11367 Qheuristic = intern ("heuristic");
11368 staticpro (&Qheuristic);
11369 QCmatrix = intern (":matrix");
11370 staticpro (&QCmatrix);
11371 QCcolor_adjustment = intern (":color-adjustment");
11372 staticpro (&QCcolor_adjustment);
11373 QCmask = intern (":mask");
11374 staticpro (&QCmask);
11376 Qface_set_after_frame_default = intern ("face-set-after-frame-default");
11377 staticpro (&Qface_set_after_frame_default);
11379 Fput (Qundefined_color, Qerror_conditions,
11380 Fcons (Qundefined_color, Fcons (Qerror, Qnil)));
11381 Fput (Qundefined_color, Qerror_message,
11382 build_string ("Undefined color"));
11384 init_x_parm_symbols ();
11386 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images,
11387 "Non-nil means always draw a cross over disabled images.\n\
11388 Disabled images are those having an `:conversion disabled' property.\n\
11389 A cross is always drawn on black & white displays.");
11390 cross_disabled_images = 0;
11392 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path,
11393 "List of directories to search for bitmap files for X.");
11394 Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
11396 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
11397 "The shape of the pointer when over text.\n\
11398 Changing the value does not affect existing frames\n\
11399 unless you set the mouse color.");
11400 Vx_pointer_shape = Qnil;
11402 DEFVAR_LISP ("x-resource-name", &Vx_resource_name,
11403 "The name Emacs uses to look up X resources.\n\
11404 `x-get-resource' uses this as the first component of the instance name\n\
11405 when requesting resource values.\n\
11406 Emacs initially sets `x-resource-name' to the name under which Emacs\n\
11407 was invoked, or to the value specified with the `-name' or `-rn'\n\
11408 switches, if present.\n\
11410 It may be useful to bind this variable locally around a call\n\
11411 to `x-get-resource'. See also the variable `x-resource-class'.");
11412 Vx_resource_name = Qnil;
11414 DEFVAR_LISP ("x-resource-class", &Vx_resource_class,
11415 "The class Emacs uses to look up X resources.\n\
11416 `x-get-resource' uses this as the first component of the instance class\n\
11417 when requesting resource values.\n\
11418 Emacs initially sets `x-resource-class' to \"Emacs\".\n\
11420 Setting this variable permanently is not a reasonable thing to do,\n\
11421 but binding this variable locally around a call to `x-get-resource'\n\
11422 is a reasonable practice. See also the variable `x-resource-name'.");
11423 Vx_resource_class = build_string (EMACS_CLASS);
11425 #if 0 /* This doesn't really do anything. */
11426 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape,
11427 "The shape of the pointer when not over text.\n\
11428 This variable takes effect when you create a new frame\n\
11429 or when you set the mouse color.");
11430 #endif
11431 Vx_nontext_pointer_shape = Qnil;
11433 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
11434 "The shape of the pointer when Emacs is busy.\n\
11435 This variable takes effect when you create a new frame\n\
11436 or when you set the mouse color.");
11437 Vx_hourglass_pointer_shape = Qnil;
11439 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p,
11440 "Non-zero means Emacs displays an hourglass pointer on window systems.");
11441 display_hourglass_p = 1;
11443 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay,
11444 "*Seconds to wait before displaying an hourglass pointer.\n\
11445 Value must be an integer or float.");
11446 Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
11448 #if 0 /* This doesn't really do anything. */
11449 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape,
11450 "The shape of the pointer when over the mode line.\n\
11451 This variable takes effect when you create a new frame\n\
11452 or when you set the mouse color.");
11453 #endif
11454 Vx_mode_pointer_shape = Qnil;
11456 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
11457 &Vx_sensitive_text_pointer_shape,
11458 "The shape of the pointer when over mouse-sensitive text.\n\
11459 This variable takes effect when you create a new frame\n\
11460 or when you set the mouse color.");
11461 Vx_sensitive_text_pointer_shape = Qnil;
11463 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
11464 &Vx_window_horizontal_drag_shape,
11465 "Pointer shape to use for indicating a window can be dragged horizontally.\n\
11466 This variable takes effect when you create a new frame\n\
11467 or when you set the mouse color.");
11468 Vx_window_horizontal_drag_shape = Qnil;
11470 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
11471 "A string indicating the foreground color of the cursor box.");
11472 Vx_cursor_fore_pixel = Qnil;
11474 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
11475 "Non-nil if no X window manager is in use.\n\
11476 Emacs doesn't try to figure this out; this is always nil\n\
11477 unless you set it to something else.");
11478 /* We don't have any way to find this out, so set it to nil
11479 and maybe the user would like to set it to t. */
11480 Vx_no_window_manager = Qnil;
11482 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
11483 &Vx_pixel_size_width_font_regexp,
11484 "Regexp matching a font name whose width is the same as `PIXEL_SIZE'.\n\
11486 Since Emacs gets width of a font matching with this regexp from\n\
11487 PIXEL_SIZE field of the name, font finding mechanism gets faster for\n\
11488 such a font. This is especially effective for such large fonts as\n\
11489 Chinese, Japanese, and Korean.");
11490 Vx_pixel_size_width_font_regexp = Qnil;
11492 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay,
11493 "Time after which cached images are removed from the cache.\n\
11494 When an image has not been displayed this many seconds, remove it\n\
11495 from the image cache. Value must be an integer or nil with nil\n\
11496 meaning don't clear the cache.");
11497 Vimage_cache_eviction_delay = make_number (30 * 60);
11499 #ifdef USE_X_TOOLKIT
11500 Fprovide (intern ("x-toolkit"));
11501 #endif
11502 #ifdef USE_MOTIF
11503 Fprovide (intern ("motif"));
11504 #endif
11506 defsubr (&Sx_get_resource);
11508 /* X window properties. */
11509 defsubr (&Sx_change_window_property);
11510 defsubr (&Sx_delete_window_property);
11511 defsubr (&Sx_window_property);
11513 defsubr (&Sxw_display_color_p);
11514 defsubr (&Sx_display_grayscale_p);
11515 defsubr (&Sxw_color_defined_p);
11516 defsubr (&Sxw_color_values);
11517 defsubr (&Sx_server_max_request_size);
11518 defsubr (&Sx_server_vendor);
11519 defsubr (&Sx_server_version);
11520 defsubr (&Sx_display_pixel_width);
11521 defsubr (&Sx_display_pixel_height);
11522 defsubr (&Sx_display_mm_width);
11523 defsubr (&Sx_display_mm_height);
11524 defsubr (&Sx_display_screens);
11525 defsubr (&Sx_display_planes);
11526 defsubr (&Sx_display_color_cells);
11527 defsubr (&Sx_display_visual_class);
11528 defsubr (&Sx_display_backing_store);
11529 defsubr (&Sx_display_save_under);
11530 defsubr (&Sx_parse_geometry);
11531 defsubr (&Sx_create_frame);
11532 defsubr (&Sx_open_connection);
11533 defsubr (&Sx_close_connection);
11534 defsubr (&Sx_display_list);
11535 defsubr (&Sx_synchronize);
11536 defsubr (&Sx_focus_frame);
11537 defsubr (&Sx_backspace_delete_keys_p);
11539 /* Setting callback functions for fontset handler. */
11540 get_font_info_func = x_get_font_info;
11542 #if 0 /* This function pointer doesn't seem to be used anywhere.
11543 And the pointer assigned has the wrong type, anyway. */
11544 list_fonts_func = x_list_fonts;
11545 #endif
11547 load_font_func = x_load_font;
11548 find_ccl_program_func = x_find_ccl_program;
11549 query_font_func = x_query_font;
11550 set_frame_fontset_func = x_set_font;
11551 check_window_system_func = check_x;
11553 /* Images. */
11554 Qxbm = intern ("xbm");
11555 staticpro (&Qxbm);
11556 QCtype = intern (":type");
11557 staticpro (&QCtype);
11558 QCconversion = intern (":conversion");
11559 staticpro (&QCconversion);
11560 QCheuristic_mask = intern (":heuristic-mask");
11561 staticpro (&QCheuristic_mask);
11562 QCcolor_symbols = intern (":color-symbols");
11563 staticpro (&QCcolor_symbols);
11564 QCascent = intern (":ascent");
11565 staticpro (&QCascent);
11566 QCmargin = intern (":margin");
11567 staticpro (&QCmargin);
11568 QCrelief = intern (":relief");
11569 staticpro (&QCrelief);
11570 Qpostscript = intern ("postscript");
11571 staticpro (&Qpostscript);
11572 QCloader = intern (":loader");
11573 staticpro (&QCloader);
11574 QCbounding_box = intern (":bounding-box");
11575 staticpro (&QCbounding_box);
11576 QCpt_width = intern (":pt-width");
11577 staticpro (&QCpt_width);
11578 QCpt_height = intern (":pt-height");
11579 staticpro (&QCpt_height);
11580 QCindex = intern (":index");
11581 staticpro (&QCindex);
11582 Qpbm = intern ("pbm");
11583 staticpro (&Qpbm);
11585 #if HAVE_XPM
11586 Qxpm = intern ("xpm");
11587 staticpro (&Qxpm);
11588 #endif
11590 #if HAVE_JPEG
11591 Qjpeg = intern ("jpeg");
11592 staticpro (&Qjpeg);
11593 #endif
11595 #if HAVE_TIFF
11596 Qtiff = intern ("tiff");
11597 staticpro (&Qtiff);
11598 #endif
11600 #if HAVE_GIF
11601 Qgif = intern ("gif");
11602 staticpro (&Qgif);
11603 #endif
11605 #if HAVE_PNG
11606 Qpng = intern ("png");
11607 staticpro (&Qpng);
11608 #endif
11610 defsubr (&Sclear_image_cache);
11611 defsubr (&Simage_size);
11612 defsubr (&Simage_mask_p);
11614 hourglass_atimer = NULL;
11615 hourglass_shown_p = 0;
11617 defsubr (&Sx_show_tip);
11618 defsubr (&Sx_hide_tip);
11619 tip_timer = Qnil;
11620 staticpro (&tip_timer);
11621 tip_frame = Qnil;
11622 staticpro (&tip_frame);
11624 last_show_tip_args = Qnil;
11625 staticpro (&last_show_tip_args);
11627 #ifdef USE_MOTIF
11628 defsubr (&Sx_file_dialog);
11629 #endif
11633 void
11634 init_xfns ()
11636 image_types = NULL;
11637 Vimage_types = Qnil;
11639 define_image_type (&xbm_type);
11640 define_image_type (&gs_type);
11641 define_image_type (&pbm_type);
11643 #if HAVE_XPM
11644 define_image_type (&xpm_type);
11645 #endif
11647 #if HAVE_JPEG
11648 define_image_type (&jpeg_type);
11649 #endif
11651 #if HAVE_TIFF
11652 define_image_type (&tiff_type);
11653 #endif
11655 #if HAVE_GIF
11656 define_image_type (&gif_type);
11657 #endif
11659 #if HAVE_PNG
11660 define_image_type (&png_type);
11661 #endif
11664 #endif /* HAVE_X_WINDOWS */