1 /* Functions for the X window system.
2 Copyright (C) 1989, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 01, 02, 03
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)
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. */
31 /* This makes the fields of a Display accessible, in Xlib header files. */
33 #define XLIB_ILLEGAL_ACCESS
40 #include "intervals.h"
41 #include "dispextern.h"
43 #include "blockinput.h"
49 #include "termhooks.h"
57 #include <sys/types.h>
61 #if 1 /* Used to be #ifdef EMACS_BITMAP_FILES, but this should always work. */
62 #include "bitmaps/gray.xbm"
64 #include <X11/bitmaps/gray>
67 #include "[.bitmaps]gray.xbm"
75 #include <X11/Shell.h>
78 #include <X11/Xaw/Paned.h>
79 #include <X11/Xaw/Label.h>
80 #endif /* USE_MOTIF */
83 #undef USG /* ####KLUDGE for Solaris 2.2 and up */
92 #include "../lwlib/lwlib.h"
96 #include <Xm/DialogS.h>
97 #include <Xm/FileSB.h>
100 /* Do the EDITRES protocol if running X11R5
101 Exception: HP-UX (at least version A.09.05) has X11R5 without EditRes */
103 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
105 extern void _XEditResCheckMessages ();
106 #endif /* R5 + Athena */
108 /* Unique id counter for widgets created by the Lucid Widget Library. */
110 extern LWLIB_ID widget_id_tick
;
113 /* This is part of a kludge--see lwlib/xlwmenu.c. */
114 extern XFontStruct
*xlwmenu_default_font
;
117 extern void free_frame_menubar ();
118 extern double atof ();
122 /* LessTif/Motif version info. */
124 static Lisp_Object Vmotif_version_string
;
126 #endif /* USE_MOTIF */
128 #endif /* USE_X_TOOLKIT */
132 /* GTK+ version info */
134 static Lisp_Object Vgtk_version_string
;
139 #define MAXREQUEST(dpy) (XMaxRequestSize (dpy))
141 #define MAXREQUEST(dpy) ((dpy)->max_request_size)
144 /* The gray bitmap `bitmaps/gray'. This is done because xterm.c uses
145 it, and including `bitmaps/gray' more than once is a problem when
146 config.h defines `static' as an empty replacement string. */
148 int gray_bitmap_width
= gray_width
;
149 int gray_bitmap_height
= gray_height
;
150 char *gray_bitmap_bits
= gray_bits
;
152 /* Non-zero means we're allowed to display an hourglass cursor. */
154 int display_hourglass_p
;
156 /* The background and shape of the mouse pointer, and shape when not
157 over text or in the modeline. */
159 Lisp_Object Vx_pointer_shape
, Vx_nontext_pointer_shape
, Vx_mode_pointer_shape
;
160 Lisp_Object Vx_hourglass_pointer_shape
;
162 /* The shape when over mouse-sensitive text. */
164 Lisp_Object Vx_sensitive_text_pointer_shape
;
166 /* If non-nil, the pointer shape to indicate that windows can be
167 dragged horizontally. */
169 Lisp_Object Vx_window_horizontal_drag_shape
;
171 /* Color of chars displayed in cursor box. */
173 Lisp_Object Vx_cursor_fore_pixel
;
175 /* Nonzero if using X. */
179 /* Non nil if no window manager is in use. */
181 Lisp_Object Vx_no_window_manager
;
183 /* Search path for bitmap files. */
185 Lisp_Object Vx_bitmap_file_path
;
187 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
189 Lisp_Object Vx_pixel_size_width_font_regexp
;
192 Lisp_Object Qsuppress_icon
;
193 Lisp_Object Qundefined_color
;
195 Lisp_Object Qcompound_text
, Qcancel_timer
;
199 extern Lisp_Object Vwindow_system_version
;
201 /* The below are defined in frame.c. */
204 int image_cache_refcount
, dpyinfo_refcount
;
209 /* Error if we are not connected to X. */
215 error ("X windows are not in use or not initialized");
218 /* Nonzero if we can use mouse menus.
219 You should not call this unless HAVE_MENUS is defined. */
227 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
228 and checking validity for X. */
231 check_x_frame (frame
)
237 frame
= selected_frame
;
238 CHECK_LIVE_FRAME (frame
);
241 error ("Non-X frame used");
245 /* Let the user specify an X display with a frame.
246 nil stands for the selected frame--or, if that is not an X frame,
247 the first X display on the list. */
249 struct x_display_info
*
250 check_x_display_info (frame
)
253 struct x_display_info
*dpyinfo
= NULL
;
257 struct frame
*sf
= XFRAME (selected_frame
);
259 if (FRAME_X_P (sf
) && FRAME_LIVE_P (sf
))
260 dpyinfo
= FRAME_X_DISPLAY_INFO (sf
);
261 else if (x_display_list
!= 0)
262 dpyinfo
= x_display_list
;
264 error ("X windows are not in use or not initialized");
266 else if (STRINGP (frame
))
267 dpyinfo
= x_display_info_for_name (frame
);
270 FRAME_PTR f
= check_x_frame (frame
);
271 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
278 /* Return the Emacs frame-object corresponding to an X window.
279 It could be the frame's main window or an icon window. */
281 /* This function can be called during GC, so use GC_xxx type test macros. */
284 x_window_to_frame (dpyinfo
, wdesc
)
285 struct x_display_info
*dpyinfo
;
288 Lisp_Object tail
, frame
;
291 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
294 if (!GC_FRAMEP (frame
))
297 if (!FRAME_X_P (f
) || FRAME_X_DISPLAY_INFO (f
) != dpyinfo
)
299 if (f
->output_data
.x
->hourglass_window
== wdesc
)
302 if ((f
->output_data
.x
->edit_widget
303 && XtWindow (f
->output_data
.x
->edit_widget
) == wdesc
)
304 /* A tooltip frame? */
305 || (!f
->output_data
.x
->edit_widget
306 && FRAME_X_WINDOW (f
) == wdesc
)
307 || f
->output_data
.x
->icon_desc
== wdesc
)
309 #else /* not USE_X_TOOLKIT */
311 if (f
->output_data
.x
->edit_widget
)
313 GtkWidget
*gwdesc
= xg_win_to_widget (dpyinfo
->display
, wdesc
);
314 struct x_output
*x
= f
->output_data
.x
;
315 if (gwdesc
!= 0 && gwdesc
== x
->edit_widget
)
319 if (FRAME_X_WINDOW (f
) == wdesc
320 || f
->output_data
.x
->icon_desc
== wdesc
)
322 #endif /* not USE_X_TOOLKIT */
327 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
328 /* Like x_window_to_frame but also compares the window with the widget's
332 x_any_window_to_frame (dpyinfo
, wdesc
)
333 struct x_display_info
*dpyinfo
;
336 Lisp_Object tail
, frame
;
337 struct frame
*f
, *found
;
341 for (tail
= Vframe_list
; GC_CONSP (tail
) && !found
; tail
= XCDR (tail
))
344 if (!GC_FRAMEP (frame
))
348 if (FRAME_X_P (f
) && FRAME_X_DISPLAY_INFO (f
) == dpyinfo
)
350 /* This frame matches if the window is any of its widgets. */
351 x
= f
->output_data
.x
;
352 if (x
->hourglass_window
== wdesc
)
357 GtkWidget
*gwdesc
= xg_win_to_widget (dpyinfo
->display
, wdesc
);
359 && (gwdesc
== x
->widget
360 || gwdesc
== x
->edit_widget
361 || gwdesc
== x
->vbox_widget
362 || gwdesc
== x
->menubar_widget
))
365 if (wdesc
== XtWindow (x
->widget
)
366 || wdesc
== XtWindow (x
->column_widget
)
367 || wdesc
== XtWindow (x
->edit_widget
))
369 /* Match if the window is this frame's menubar. */
370 else if (lw_window_is_in_menubar (wdesc
, x
->menubar_widget
))
374 else if (FRAME_X_WINDOW (f
) == wdesc
)
375 /* A tooltip frame. */
383 /* Likewise, but exclude the menu bar widget. */
386 x_non_menubar_window_to_frame (dpyinfo
, wdesc
)
387 struct x_display_info
*dpyinfo
;
390 Lisp_Object tail
, frame
;
394 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
397 if (!GC_FRAMEP (frame
))
400 if (!FRAME_X_P (f
) || FRAME_X_DISPLAY_INFO (f
) != dpyinfo
)
402 x
= f
->output_data
.x
;
403 /* This frame matches if the window is any of its widgets. */
404 if (x
->hourglass_window
== wdesc
)
409 GtkWidget
*gwdesc
= xg_win_to_widget (dpyinfo
->display
, wdesc
);
411 && (gwdesc
== x
->widget
412 || gwdesc
== x
->edit_widget
413 || gwdesc
== x
->vbox_widget
))
416 if (wdesc
== XtWindow (x
->widget
)
417 || wdesc
== XtWindow (x
->column_widget
)
418 || wdesc
== XtWindow (x
->edit_widget
))
422 else if (FRAME_X_WINDOW (f
) == wdesc
)
423 /* A tooltip frame. */
429 /* Likewise, but consider only the menu bar widget. */
432 x_menubar_window_to_frame (dpyinfo
, wdesc
)
433 struct x_display_info
*dpyinfo
;
436 Lisp_Object tail
, frame
;
440 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
443 if (!GC_FRAMEP (frame
))
446 if (!FRAME_X_P (f
) || FRAME_X_DISPLAY_INFO (f
) != dpyinfo
)
448 x
= f
->output_data
.x
;
449 /* Match if the window is this frame's menubar. */
451 if (x
->menubar_widget
)
453 GtkWidget
*gwdesc
= xg_win_to_widget (dpyinfo
->display
, wdesc
);
458 && (gwdesc
== x
->menubar_widget
459 || gtk_widget_get_parent (gwdesc
) == x
->menubar_widget
))
465 if (x
->menubar_widget
466 && lw_window_is_in_menubar (wdesc
, x
->menubar_widget
))
473 /* Return the frame whose principal (outermost) window is WDESC.
474 If WDESC is some other (smaller) window, we return 0. */
477 x_top_window_to_frame (dpyinfo
, wdesc
)
478 struct x_display_info
*dpyinfo
;
481 Lisp_Object tail
, frame
;
485 for (tail
= Vframe_list
; GC_CONSP (tail
); tail
= XCDR (tail
))
488 if (!GC_FRAMEP (frame
))
491 if (!FRAME_X_P (f
) || FRAME_X_DISPLAY_INFO (f
) != dpyinfo
)
493 x
= f
->output_data
.x
;
497 /* This frame matches if the window is its topmost widget. */
499 GtkWidget
*gwdesc
= xg_win_to_widget (dpyinfo
->display
, wdesc
);
500 if (gwdesc
== x
->widget
)
503 if (wdesc
== XtWindow (x
->widget
))
505 #if 0 /* I don't know why it did this,
506 but it seems logically wrong,
507 and it causes trouble for MapNotify events. */
508 /* Match if the window is this frame's menubar. */
509 if (x
->menubar_widget
510 && wdesc
== XtWindow (x
->menubar_widget
))
515 else if (FRAME_X_WINDOW (f
) == wdesc
)
521 #endif /* USE_X_TOOLKIT || USE_GTK */
525 /* Code to deal with bitmaps. Bitmaps are referenced by their bitmap
526 id, which is just an int that this section returns. Bitmaps are
527 reference counted so they can be shared among frames.
529 Bitmap indices are guaranteed to be > 0, so a negative number can
530 be used to indicate no bitmap.
532 If you use x_create_bitmap_from_data, then you must keep track of
533 the bitmaps yourself. That is, creating a bitmap from the same
534 data more than once will not be caught. */
537 /* Functions to access the contents of a bitmap, given an id. */
540 x_bitmap_height (f
, id
)
544 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].height
;
548 x_bitmap_width (f
, id
)
552 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].width
;
556 x_bitmap_pixmap (f
, id
)
560 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].pixmap
;
564 x_bitmap_mask (f
, id
)
568 return FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].mask
;
572 /* Allocate a new bitmap record. Returns index of new record. */
575 x_allocate_bitmap_record (f
)
578 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
581 if (dpyinfo
->bitmaps
== NULL
)
583 dpyinfo
->bitmaps_size
= 10;
585 = (struct x_bitmap_record
*) xmalloc (dpyinfo
->bitmaps_size
* sizeof (struct x_bitmap_record
));
586 dpyinfo
->bitmaps_last
= 1;
590 if (dpyinfo
->bitmaps_last
< dpyinfo
->bitmaps_size
)
591 return ++dpyinfo
->bitmaps_last
;
593 for (i
= 0; i
< dpyinfo
->bitmaps_size
; ++i
)
594 if (dpyinfo
->bitmaps
[i
].refcount
== 0)
597 dpyinfo
->bitmaps_size
*= 2;
599 = (struct x_bitmap_record
*) xrealloc (dpyinfo
->bitmaps
,
600 dpyinfo
->bitmaps_size
* sizeof (struct x_bitmap_record
));
601 return ++dpyinfo
->bitmaps_last
;
604 /* Add one reference to the reference count of the bitmap with id ID. */
607 x_reference_bitmap (f
, id
)
611 ++FRAME_X_DISPLAY_INFO (f
)->bitmaps
[id
- 1].refcount
;
614 /* Create a bitmap for frame F from a HEIGHT x WIDTH array of bits at BITS. */
617 x_create_bitmap_from_data (f
, bits
, width
, height
)
620 unsigned int width
, height
;
622 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
626 bitmap
= XCreateBitmapFromData (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
627 bits
, width
, height
);
634 id
= x_allocate_bitmap_record (f
);
635 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
636 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
637 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
638 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
639 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
640 dpyinfo
->bitmaps
[id
- 1].height
= height
;
641 dpyinfo
->bitmaps
[id
- 1].width
= width
;
646 /* Create bitmap from file FILE for frame F. */
649 x_create_bitmap_from_file (f
, file
)
653 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
654 unsigned int width
, height
;
656 int xhot
, yhot
, result
, id
;
661 /* Look for an existing bitmap with the same name. */
662 for (id
= 0; id
< dpyinfo
->bitmaps_last
; ++id
)
664 if (dpyinfo
->bitmaps
[id
].refcount
665 && dpyinfo
->bitmaps
[id
].file
666 && !strcmp (dpyinfo
->bitmaps
[id
].file
, (char *) SDATA (file
)))
668 ++dpyinfo
->bitmaps
[id
].refcount
;
673 /* Search bitmap-file-path for the file, if appropriate. */
674 fd
= openp (Vx_bitmap_file_path
, file
, Qnil
, &found
, Qnil
);
679 filename
= (char *) SDATA (found
);
681 result
= XReadBitmapFile (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
682 filename
, &width
, &height
, &bitmap
, &xhot
, &yhot
);
683 if (result
!= BitmapSuccess
)
686 id
= x_allocate_bitmap_record (f
);
687 dpyinfo
->bitmaps
[id
- 1].pixmap
= bitmap
;
688 dpyinfo
->bitmaps
[id
- 1].have_mask
= 0;
689 dpyinfo
->bitmaps
[id
- 1].refcount
= 1;
690 dpyinfo
->bitmaps
[id
- 1].file
691 = (char *) xmalloc (SBYTES (file
) + 1);
692 dpyinfo
->bitmaps
[id
- 1].depth
= 1;
693 dpyinfo
->bitmaps
[id
- 1].height
= height
;
694 dpyinfo
->bitmaps
[id
- 1].width
= width
;
695 strcpy (dpyinfo
->bitmaps
[id
- 1].file
, SDATA (file
));
700 /* Remove reference to bitmap with id number ID. */
703 x_destroy_bitmap (f
, id
)
707 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
711 --dpyinfo
->bitmaps
[id
- 1].refcount
;
712 if (dpyinfo
->bitmaps
[id
- 1].refcount
== 0)
715 XFreePixmap (FRAME_X_DISPLAY (f
), dpyinfo
->bitmaps
[id
- 1].pixmap
);
716 if (dpyinfo
->bitmaps
[id
- 1].have_mask
)
717 XFreePixmap (FRAME_X_DISPLAY (f
), dpyinfo
->bitmaps
[id
- 1].mask
);
718 if (dpyinfo
->bitmaps
[id
- 1].file
)
720 xfree (dpyinfo
->bitmaps
[id
- 1].file
);
721 dpyinfo
->bitmaps
[id
- 1].file
= NULL
;
728 /* Free all the bitmaps for the display specified by DPYINFO. */
731 x_destroy_all_bitmaps (dpyinfo
)
732 struct x_display_info
*dpyinfo
;
735 for (i
= 0; i
< dpyinfo
->bitmaps_last
; i
++)
736 if (dpyinfo
->bitmaps
[i
].refcount
> 0)
738 XFreePixmap (dpyinfo
->display
, dpyinfo
->bitmaps
[i
].pixmap
);
739 if (dpyinfo
->bitmaps
[i
].have_mask
)
740 XFreePixmap (dpyinfo
->display
, dpyinfo
->bitmaps
[i
].mask
);
741 if (dpyinfo
->bitmaps
[i
].file
)
742 xfree (dpyinfo
->bitmaps
[i
].file
);
744 dpyinfo
->bitmaps_last
= 0;
750 /* Useful functions defined in the section
751 `Image type independent image structures' below. */
753 static unsigned long four_corners_best
P_ ((XImage
*ximg
, unsigned long width
,
754 unsigned long height
));
756 static int x_create_x_image_and_pixmap
P_ ((struct frame
*f
, int width
, int height
,
757 int depth
, XImage
**ximg
,
760 static void x_destroy_x_image
P_ ((XImage
*ximg
));
763 /* Create a mask of a bitmap. Note is this not a perfect mask.
764 It's nicer with some borders in this context */
767 x_create_bitmap_mask (f
, id
)
772 XImage
*ximg
, *mask_img
;
773 unsigned long width
, height
;
776 unsigned long x
, y
, xp
, xm
, yp
, ym
;
779 int depth
= DefaultDepthOfScreen (FRAME_X_SCREEN (f
));
780 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
785 pixmap
= x_bitmap_pixmap (f
, id
);
786 width
= x_bitmap_width (f
, id
);
787 height
= x_bitmap_height (f
, id
);
790 ximg
= XGetImage (FRAME_X_DISPLAY (f
), pixmap
, 0, 0, width
, height
,
799 result
= x_create_x_image_and_pixmap (f
, width
, height
, 1, &mask_img
, &mask
);
804 XDestroyImage (ximg
);
808 bg
= four_corners_best (ximg
, width
, height
);
810 for (y
= 0; y
< ximg
->height
; ++y
)
812 for (x
= 0; x
< ximg
->width
; ++x
)
814 xp
= x
!= ximg
->width
- 1 ? x
+ 1 : 0;
815 xm
= x
!= 0 ? x
- 1 : ximg
->width
- 1;
816 yp
= y
!= ximg
->height
- 1 ? y
+ 1 : 0;
817 ym
= y
!= 0 ? y
- 1 : ximg
->height
- 1;
818 if (XGetPixel (ximg
, x
, y
) == bg
819 && XGetPixel (ximg
, x
, yp
) == bg
820 && XGetPixel (ximg
, x
, ym
) == bg
821 && XGetPixel (ximg
, xp
, y
) == bg
822 && XGetPixel (ximg
, xp
, yp
) == bg
823 && XGetPixel (ximg
, xp
, ym
) == bg
824 && XGetPixel (ximg
, xm
, y
) == bg
825 && XGetPixel (ximg
, xm
, yp
) == bg
826 && XGetPixel (ximg
, xm
, ym
) == bg
)
827 XPutPixel (mask_img
, x
, y
, 0);
829 XPutPixel (mask_img
, x
, y
, 1);
833 xassert (interrupt_input_blocked
);
834 gc
= XCreateGC (FRAME_X_DISPLAY (f
), mask
, 0, NULL
);
835 XPutImage (FRAME_X_DISPLAY (f
), mask
, gc
, mask_img
, 0, 0, 0, 0,
837 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
839 dpyinfo
->bitmaps
[id
- 1].have_mask
= 1;
840 dpyinfo
->bitmaps
[id
- 1].mask
= mask
;
842 XDestroyImage (ximg
);
843 x_destroy_x_image (mask_img
);
848 static Lisp_Object unwind_create_frame
P_ ((Lisp_Object
));
849 static Lisp_Object unwind_create_tip_frame
P_ ((Lisp_Object
));
850 static void x_disable_image
P_ ((struct frame
*, struct image
*));
852 void x_set_foreground_color
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
853 static void x_set_wait_for_wm
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
854 void x_set_background_color
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
855 void x_set_mouse_color
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
856 void x_set_cursor_color
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
857 void x_set_border_color
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
858 void x_set_cursor_type
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
859 void x_set_icon_type
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
860 void x_set_icon_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
861 void x_explicitly_set_name
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
862 void x_set_menu_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
863 void x_set_title
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
864 void x_set_tool_bar_lines
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
));
865 void x_set_scroll_bar_foreground
P_ ((struct frame
*, Lisp_Object
,
867 void x_set_scroll_bar_background
P_ ((struct frame
*, Lisp_Object
,
869 static Lisp_Object x_default_scroll_bar_color_parameter
P_ ((struct frame
*,
874 static void x_edge_detection
P_ ((struct frame
*, struct image
*, Lisp_Object
,
876 static void init_color_table
P_ ((void));
877 static void free_color_table
P_ ((void));
878 static unsigned long *colors_in_color_table
P_ ((int *n
));
879 static unsigned long lookup_rgb_color
P_ ((struct frame
*f
, int r
, int g
, int b
));
880 static unsigned long lookup_pixel_color
P_ ((struct frame
*f
, unsigned long p
));
886 /* Store the screen positions of frame F into XPTR and YPTR.
887 These are the positions of the containing window manager window,
888 not Emacs's own window. */
891 x_real_positions (f
, xptr
, yptr
)
895 int win_x
, win_y
, outer_x
, outer_y
;
896 int real_x
= 0, real_y
= 0;
898 Window win
= f
->output_data
.x
->parent_desc
;
904 count
= x_catch_errors (FRAME_X_DISPLAY (f
));
906 if (win
== FRAME_X_DISPLAY_INFO (f
)->root_window
)
907 win
= FRAME_OUTER_WINDOW (f
);
909 /* This loop traverses up the containment tree until we hit the root
910 window. Window managers may intersect many windows between our window
911 and the root window. The window we find just before the root window
912 should be the outer WM window. */
915 Window wm_window
, rootw
;
916 Window
*tmp_children
;
917 unsigned int tmp_nchildren
;
920 success
= XQueryTree (FRAME_X_DISPLAY (f
), win
, &rootw
,
921 &wm_window
, &tmp_children
, &tmp_nchildren
);
923 had_errors
= x_had_errors_p (FRAME_X_DISPLAY (f
));
925 /* Don't free tmp_children if XQueryTree failed. */
929 XFree ((char *) tmp_children
);
931 if (wm_window
== rootw
|| had_errors
)
942 /* Get the real coordinates for the WM window upper left corner */
943 XGetGeometry (FRAME_X_DISPLAY (f
), win
,
944 &rootw
, &real_x
, &real_y
, &ign
, &ign
, &ign
, &ign
);
946 /* Translate real coordinates to coordinates relative to our
947 window. For our window, the upper left corner is 0, 0.
948 Since the upper left corner of the WM window is outside
949 our window, win_x and win_y will be negative:
951 ------------------ ---> x
953 | ----------------- v y
956 XTranslateCoordinates (FRAME_X_DISPLAY (f
),
958 /* From-window, to-window. */
959 FRAME_X_DISPLAY_INFO (f
)->root_window
,
962 /* From-position, to-position. */
963 real_x
, real_y
, &win_x
, &win_y
,
968 if (FRAME_X_WINDOW (f
) == FRAME_OUTER_WINDOW (f
))
975 XTranslateCoordinates (FRAME_X_DISPLAY (f
),
977 /* From-window, to-window. */
978 FRAME_X_DISPLAY_INFO (f
)->root_window
,
979 FRAME_OUTER_WINDOW (f
),
981 /* From-position, to-position. */
982 real_x
, real_y
, &outer_x
, &outer_y
,
988 had_errors
= x_had_errors_p (FRAME_X_DISPLAY (f
));
991 x_uncatch_errors (FRAME_X_DISPLAY (f
), count
);
995 if (had_errors
) return;
997 f
->x_pixels_diff
= -win_x
;
998 f
->y_pixels_diff
= -win_y
;
1000 FRAME_X_OUTPUT (f
)->x_pixels_outer_diff
= -outer_x
;
1001 FRAME_X_OUTPUT (f
)->y_pixels_outer_diff
= -outer_y
;
1010 /* Gamma-correct COLOR on frame F. */
1013 gamma_correct (f
, color
)
1019 color
->red
= pow (color
->red
/ 65535.0, f
->gamma
) * 65535.0 + 0.5;
1020 color
->green
= pow (color
->green
/ 65535.0, f
->gamma
) * 65535.0 + 0.5;
1021 color
->blue
= pow (color
->blue
/ 65535.0, f
->gamma
) * 65535.0 + 0.5;
1026 /* Decide if color named COLOR_NAME is valid for use on frame F. If
1027 so, return the RGB values in COLOR. If ALLOC_P is non-zero,
1028 allocate the color. Value is zero if COLOR_NAME is invalid, or
1029 no color could be allocated. */
1032 x_defined_color (f
, color_name
, color
, alloc_p
)
1039 Display
*dpy
= FRAME_X_DISPLAY (f
);
1040 Colormap cmap
= FRAME_X_COLORMAP (f
);
1043 success_p
= XParseColor (dpy
, cmap
, color_name
, color
);
1044 if (success_p
&& alloc_p
)
1045 success_p
= x_alloc_nearest_color (f
, cmap
, color
);
1052 /* Return the pixel color value for color COLOR_NAME on frame F. If F
1053 is a monochrome frame, return MONO_COLOR regardless of what ARG says.
1054 Signal an error if color can't be allocated. */
1057 x_decode_color (f
, color_name
, mono_color
)
1059 Lisp_Object color_name
;
1064 CHECK_STRING (color_name
);
1066 #if 0 /* Don't do this. It's wrong when we're not using the default
1067 colormap, it makes freeing difficult, and it's probably not
1068 an important optimization. */
1069 if (strcmp (SDATA (color_name
), "black") == 0)
1070 return BLACK_PIX_DEFAULT (f
);
1071 else if (strcmp (SDATA (color_name
), "white") == 0)
1072 return WHITE_PIX_DEFAULT (f
);
1075 /* Return MONO_COLOR for monochrome frames. */
1076 if (FRAME_X_DISPLAY_INFO (f
)->n_planes
== 1)
1079 /* x_defined_color is responsible for coping with failures
1080 by looking for a near-miss. */
1081 if (x_defined_color (f
, SDATA (color_name
), &cdef
, 1))
1084 Fsignal (Qerror
, Fcons (build_string ("Undefined color"),
1085 Fcons (color_name
, Qnil
)));
1091 /* Change the `wait-for-wm' frame parameter of frame F. OLD_VALUE is
1092 the previous value of that parameter, NEW_VALUE is the new value.
1093 See also the comment of wait_for_wm in struct x_output. */
1096 x_set_wait_for_wm (f
, new_value
, old_value
)
1098 Lisp_Object new_value
, old_value
;
1100 f
->output_data
.x
->wait_for_wm
= !NILP (new_value
);
1105 static Lisp_Object x_find_image_file
P_ ((Lisp_Object file
));
1107 /* Set icon from FILE for frame F. By using GTK functions the icon
1108 may be any format that GdkPixbuf knows about, i.e. not just bitmaps. */
1111 xg_set_icon (f
, file
)
1115 struct gcpro gcpro1
;
1121 found
= x_find_image_file (file
);
1129 filename
= SDATA (found
);
1132 pixbuf
= gdk_pixbuf_new_from_file (filename
, &err
);
1136 gtk_window_set_icon (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f
)),
1138 g_object_unref (pixbuf
);
1151 #endif /* USE_GTK */
1154 /* Functions called only from `x_set_frame_param'
1155 to set individual parameters.
1157 If FRAME_X_WINDOW (f) is 0,
1158 the frame is being created and its X-window does not exist yet.
1159 In that case, just record the parameter's new value
1160 in the standard place; do not attempt to change the window. */
1163 x_set_foreground_color (f
, arg
, oldval
)
1165 Lisp_Object arg
, oldval
;
1167 struct x_output
*x
= f
->output_data
.x
;
1168 unsigned long fg
, old_fg
;
1170 fg
= x_decode_color (f
, arg
, BLACK_PIX_DEFAULT (f
));
1171 old_fg
= x
->foreground_pixel
;
1172 x
->foreground_pixel
= fg
;
1174 if (FRAME_X_WINDOW (f
) != 0)
1176 Display
*dpy
= FRAME_X_DISPLAY (f
);
1179 XSetForeground (dpy
, x
->normal_gc
, fg
);
1180 XSetBackground (dpy
, x
->reverse_gc
, fg
);
1182 if (x
->cursor_pixel
== old_fg
)
1184 unload_color (f
, x
->cursor_pixel
);
1185 x
->cursor_pixel
= x_copy_color (f
, fg
);
1186 XSetBackground (dpy
, x
->cursor_gc
, x
->cursor_pixel
);
1191 update_face_from_frame_parameter (f
, Qforeground_color
, arg
);
1193 if (FRAME_VISIBLE_P (f
))
1197 unload_color (f
, old_fg
);
1201 x_set_background_color (f
, arg
, oldval
)
1203 Lisp_Object arg
, oldval
;
1205 struct x_output
*x
= f
->output_data
.x
;
1208 bg
= x_decode_color (f
, arg
, WHITE_PIX_DEFAULT (f
));
1209 unload_color (f
, x
->background_pixel
);
1210 x
->background_pixel
= bg
;
1212 if (FRAME_X_WINDOW (f
) != 0)
1214 Display
*dpy
= FRAME_X_DISPLAY (f
);
1217 XSetBackground (dpy
, x
->normal_gc
, bg
);
1218 XSetForeground (dpy
, x
->reverse_gc
, bg
);
1219 XSetWindowBackground (dpy
, FRAME_X_WINDOW (f
), bg
);
1220 XSetForeground (dpy
, x
->cursor_gc
, bg
);
1223 xg_set_background_color (f
, bg
);
1226 #ifndef USE_TOOLKIT_SCROLL_BARS /* Turns out to be annoying with
1227 toolkit scroll bars. */
1230 for (bar
= FRAME_SCROLL_BARS (f
);
1232 bar
= XSCROLL_BAR (bar
)->next
)
1234 Window window
= SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar
));
1235 XSetWindowBackground (dpy
, window
, bg
);
1238 #endif /* USE_TOOLKIT_SCROLL_BARS */
1241 update_face_from_frame_parameter (f
, Qbackground_color
, arg
);
1243 if (FRAME_VISIBLE_P (f
))
1249 x_set_mouse_color (f
, arg
, oldval
)
1251 Lisp_Object arg
, oldval
;
1253 struct x_output
*x
= f
->output_data
.x
;
1254 Display
*dpy
= FRAME_X_DISPLAY (f
);
1255 Cursor cursor
, nontext_cursor
, mode_cursor
, hand_cursor
;
1256 Cursor hourglass_cursor
, horizontal_drag_cursor
;
1258 unsigned long pixel
= x_decode_color (f
, arg
, BLACK_PIX_DEFAULT (f
));
1259 unsigned long mask_color
= x
->background_pixel
;
1261 /* Don't let pointers be invisible. */
1262 if (mask_color
== pixel
)
1264 x_free_colors (f
, &pixel
, 1);
1265 pixel
= x_copy_color (f
, x
->foreground_pixel
);
1268 unload_color (f
, x
->mouse_pixel
);
1269 x
->mouse_pixel
= pixel
;
1273 /* It's not okay to crash if the user selects a screwy cursor. */
1274 count
= x_catch_errors (dpy
);
1276 if (!NILP (Vx_pointer_shape
))
1278 CHECK_NUMBER (Vx_pointer_shape
);
1279 cursor
= XCreateFontCursor (dpy
, XINT (Vx_pointer_shape
));
1282 cursor
= XCreateFontCursor (dpy
, XC_xterm
);
1283 x_check_errors (dpy
, "bad text pointer cursor: %s");
1285 if (!NILP (Vx_nontext_pointer_shape
))
1287 CHECK_NUMBER (Vx_nontext_pointer_shape
);
1289 = XCreateFontCursor (dpy
, XINT (Vx_nontext_pointer_shape
));
1292 nontext_cursor
= XCreateFontCursor (dpy
, XC_left_ptr
);
1293 x_check_errors (dpy
, "bad nontext pointer cursor: %s");
1295 if (!NILP (Vx_hourglass_pointer_shape
))
1297 CHECK_NUMBER (Vx_hourglass_pointer_shape
);
1299 = XCreateFontCursor (dpy
, XINT (Vx_hourglass_pointer_shape
));
1302 hourglass_cursor
= XCreateFontCursor (dpy
, XC_watch
);
1303 x_check_errors (dpy
, "bad hourglass pointer cursor: %s");
1305 if (!NILP (Vx_mode_pointer_shape
))
1307 CHECK_NUMBER (Vx_mode_pointer_shape
);
1308 mode_cursor
= XCreateFontCursor (dpy
, XINT (Vx_mode_pointer_shape
));
1311 mode_cursor
= XCreateFontCursor (dpy
, XC_xterm
);
1312 x_check_errors (dpy
, "bad modeline pointer cursor: %s");
1314 if (!NILP (Vx_sensitive_text_pointer_shape
))
1316 CHECK_NUMBER (Vx_sensitive_text_pointer_shape
);
1318 = XCreateFontCursor (dpy
, XINT (Vx_sensitive_text_pointer_shape
));
1321 hand_cursor
= XCreateFontCursor (dpy
, XC_hand2
);
1323 if (!NILP (Vx_window_horizontal_drag_shape
))
1325 CHECK_NUMBER (Vx_window_horizontal_drag_shape
);
1326 horizontal_drag_cursor
1327 = XCreateFontCursor (dpy
, XINT (Vx_window_horizontal_drag_shape
));
1330 horizontal_drag_cursor
1331 = XCreateFontCursor (dpy
, XC_sb_h_double_arrow
);
1333 /* Check and report errors with the above calls. */
1334 x_check_errors (dpy
, "can't set cursor shape: %s");
1335 x_uncatch_errors (dpy
, count
);
1338 XColor fore_color
, back_color
;
1340 fore_color
.pixel
= x
->mouse_pixel
;
1341 x_query_color (f
, &fore_color
);
1342 back_color
.pixel
= mask_color
;
1343 x_query_color (f
, &back_color
);
1345 XRecolorCursor (dpy
, cursor
, &fore_color
, &back_color
);
1346 XRecolorCursor (dpy
, nontext_cursor
, &fore_color
, &back_color
);
1347 XRecolorCursor (dpy
, mode_cursor
, &fore_color
, &back_color
);
1348 XRecolorCursor (dpy
, hand_cursor
, &fore_color
, &back_color
);
1349 XRecolorCursor (dpy
, hourglass_cursor
, &fore_color
, &back_color
);
1350 XRecolorCursor (dpy
, horizontal_drag_cursor
, &fore_color
, &back_color
);
1353 if (FRAME_X_WINDOW (f
) != 0)
1354 XDefineCursor (dpy
, FRAME_X_WINDOW (f
), cursor
);
1356 if (cursor
!= x
->text_cursor
1357 && x
->text_cursor
!= 0)
1358 XFreeCursor (dpy
, x
->text_cursor
);
1359 x
->text_cursor
= cursor
;
1361 if (nontext_cursor
!= x
->nontext_cursor
1362 && x
->nontext_cursor
!= 0)
1363 XFreeCursor (dpy
, x
->nontext_cursor
);
1364 x
->nontext_cursor
= nontext_cursor
;
1366 if (hourglass_cursor
!= x
->hourglass_cursor
1367 && x
->hourglass_cursor
!= 0)
1368 XFreeCursor (dpy
, x
->hourglass_cursor
);
1369 x
->hourglass_cursor
= hourglass_cursor
;
1371 if (mode_cursor
!= x
->modeline_cursor
1372 && x
->modeline_cursor
!= 0)
1373 XFreeCursor (dpy
, f
->output_data
.x
->modeline_cursor
);
1374 x
->modeline_cursor
= mode_cursor
;
1376 if (hand_cursor
!= x
->hand_cursor
1377 && x
->hand_cursor
!= 0)
1378 XFreeCursor (dpy
, x
->hand_cursor
);
1379 x
->hand_cursor
= hand_cursor
;
1381 if (horizontal_drag_cursor
!= x
->horizontal_drag_cursor
1382 && x
->horizontal_drag_cursor
!= 0)
1383 XFreeCursor (dpy
, x
->horizontal_drag_cursor
);
1384 x
->horizontal_drag_cursor
= horizontal_drag_cursor
;
1389 update_face_from_frame_parameter (f
, Qmouse_color
, arg
);
1393 x_set_cursor_color (f
, arg
, oldval
)
1395 Lisp_Object arg
, oldval
;
1397 unsigned long fore_pixel
, pixel
;
1398 int fore_pixel_allocated_p
= 0, pixel_allocated_p
= 0;
1399 struct x_output
*x
= f
->output_data
.x
;
1401 if (!NILP (Vx_cursor_fore_pixel
))
1403 fore_pixel
= x_decode_color (f
, Vx_cursor_fore_pixel
,
1404 WHITE_PIX_DEFAULT (f
));
1405 fore_pixel_allocated_p
= 1;
1408 fore_pixel
= x
->background_pixel
;
1410 pixel
= x_decode_color (f
, arg
, BLACK_PIX_DEFAULT (f
));
1411 pixel_allocated_p
= 1;
1413 /* Make sure that the cursor color differs from the background color. */
1414 if (pixel
== x
->background_pixel
)
1416 if (pixel_allocated_p
)
1418 x_free_colors (f
, &pixel
, 1);
1419 pixel_allocated_p
= 0;
1422 pixel
= x
->mouse_pixel
;
1423 if (pixel
== fore_pixel
)
1425 if (fore_pixel_allocated_p
)
1427 x_free_colors (f
, &fore_pixel
, 1);
1428 fore_pixel_allocated_p
= 0;
1430 fore_pixel
= x
->background_pixel
;
1434 unload_color (f
, x
->cursor_foreground_pixel
);
1435 if (!fore_pixel_allocated_p
)
1436 fore_pixel
= x_copy_color (f
, fore_pixel
);
1437 x
->cursor_foreground_pixel
= fore_pixel
;
1439 unload_color (f
, x
->cursor_pixel
);
1440 if (!pixel_allocated_p
)
1441 pixel
= x_copy_color (f
, pixel
);
1442 x
->cursor_pixel
= pixel
;
1444 if (FRAME_X_WINDOW (f
) != 0)
1447 XSetBackground (FRAME_X_DISPLAY (f
), x
->cursor_gc
, x
->cursor_pixel
);
1448 XSetForeground (FRAME_X_DISPLAY (f
), x
->cursor_gc
, fore_pixel
);
1451 if (FRAME_VISIBLE_P (f
))
1453 x_update_cursor (f
, 0);
1454 x_update_cursor (f
, 1);
1458 update_face_from_frame_parameter (f
, Qcursor_color
, arg
);
1461 /* Set the border-color of frame F to pixel value PIX.
1462 Note that this does not fully take effect if done before
1463 F has an x-window. */
1466 x_set_border_pixel (f
, pix
)
1470 unload_color (f
, f
->output_data
.x
->border_pixel
);
1471 f
->output_data
.x
->border_pixel
= pix
;
1473 if (FRAME_X_WINDOW (f
) != 0 && f
->border_width
> 0)
1476 XSetWindowBorder (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
1477 (unsigned long)pix
);
1480 if (FRAME_VISIBLE_P (f
))
1485 /* Set the border-color of frame F to value described by ARG.
1486 ARG can be a string naming a color.
1487 The border-color is used for the border that is drawn by the X server.
1488 Note that this does not fully take effect if done before
1489 F has an x-window; it must be redone when the window is created.
1491 Note: this is done in two routines because of the way X10 works.
1493 Note: under X11, this is normally the province of the window manager,
1494 and so emacs' border colors may be overridden. */
1497 x_set_border_color (f
, arg
, oldval
)
1499 Lisp_Object arg
, oldval
;
1504 pix
= x_decode_color (f
, arg
, BLACK_PIX_DEFAULT (f
));
1505 x_set_border_pixel (f
, pix
);
1506 update_face_from_frame_parameter (f
, Qborder_color
, arg
);
1511 x_set_cursor_type (f
, arg
, oldval
)
1513 Lisp_Object arg
, oldval
;
1515 set_frame_cursor_types (f
, arg
);
1517 /* Make sure the cursor gets redrawn. */
1518 cursor_type_changed
= 1;
1522 x_set_icon_type (f
, arg
, oldval
)
1524 Lisp_Object arg
, oldval
;
1530 if (STRINGP (oldval
) && EQ (Fstring_equal (oldval
, arg
), Qt
))
1533 else if (!STRINGP (oldval
) && EQ (oldval
, Qnil
) == EQ (arg
, Qnil
))
1538 result
= x_text_icon (f
,
1539 (char *) SDATA ((!NILP (f
->icon_name
)
1543 result
= x_bitmap_icon (f
, arg
);
1548 error ("No icon window available");
1551 XFlush (FRAME_X_DISPLAY (f
));
1556 x_set_icon_name (f
, arg
, oldval
)
1558 Lisp_Object arg
, oldval
;
1564 if (STRINGP (oldval
) && EQ (Fstring_equal (oldval
, arg
), Qt
))
1567 else if (!STRINGP (oldval
) && EQ (oldval
, Qnil
) == EQ (arg
, Qnil
))
1572 if (f
->output_data
.x
->icon_bitmap
!= 0)
1577 result
= x_text_icon (f
,
1578 (char *) SDATA ((!NILP (f
->icon_name
)
1587 error ("No icon window available");
1590 XFlush (FRAME_X_DISPLAY (f
));
1596 x_set_menu_bar_lines (f
, value
, oldval
)
1598 Lisp_Object value
, oldval
;
1601 #ifndef USE_X_TOOLKIT
1602 int olines
= FRAME_MENU_BAR_LINES (f
);
1605 /* Right now, menu bars don't work properly in minibuf-only frames;
1606 most of the commands try to apply themselves to the minibuffer
1607 frame itself, and get an error because you can't switch buffers
1608 in or split the minibuffer window. */
1609 if (FRAME_MINIBUF_ONLY_P (f
))
1612 if (INTEGERP (value
))
1613 nlines
= XINT (value
);
1617 /* Make sure we redisplay all windows in this frame. */
1618 windows_or_buffers_changed
++;
1620 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
1621 FRAME_MENU_BAR_LINES (f
) = 0;
1624 FRAME_EXTERNAL_MENU_BAR (f
) = 1;
1625 if (FRAME_X_P (f
) && f
->output_data
.x
->menubar_widget
== 0)
1626 /* Make sure next redisplay shows the menu bar. */
1627 XWINDOW (FRAME_SELECTED_WINDOW (f
))->update_mode_line
= Qt
;
1631 if (FRAME_EXTERNAL_MENU_BAR (f
) == 1)
1632 free_frame_menubar (f
);
1633 FRAME_EXTERNAL_MENU_BAR (f
) = 0;
1635 f
->output_data
.x
->menubar_widget
= 0;
1637 #else /* not USE_X_TOOLKIT && not USE_GTK */
1638 FRAME_MENU_BAR_LINES (f
) = nlines
;
1639 change_window_heights (f
->root_window
, nlines
- olines
);
1640 #endif /* not USE_X_TOOLKIT */
1645 /* Set the number of lines used for the tool bar of frame F to VALUE.
1646 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1647 is the old number of tool bar lines. This function changes the
1648 height of all windows on frame F to match the new tool bar height.
1649 The frame's height doesn't change. */
1652 x_set_tool_bar_lines (f
, value
, oldval
)
1654 Lisp_Object value
, oldval
;
1656 int delta
, nlines
, root_height
;
1657 Lisp_Object root_window
;
1659 /* Treat tool bars like menu bars. */
1660 if (FRAME_MINIBUF_ONLY_P (f
))
1663 /* Use VALUE only if an integer >= 0. */
1664 if (INTEGERP (value
) && XINT (value
) >= 0)
1665 nlines
= XFASTINT (value
);
1670 FRAME_TOOL_BAR_LINES (f
) = 0;
1673 FRAME_EXTERNAL_TOOL_BAR (f
) = 1;
1674 if (FRAME_X_P (f
) && f
->output_data
.x
->toolbar_widget
== 0)
1675 /* Make sure next redisplay shows the tool bar. */
1676 XWINDOW (FRAME_SELECTED_WINDOW (f
))->update_mode_line
= Qt
;
1677 update_frame_tool_bar (f
);
1681 if (FRAME_EXTERNAL_TOOL_BAR (f
))
1682 free_frame_tool_bar (f
);
1683 FRAME_EXTERNAL_TOOL_BAR (f
) = 0;
1689 /* Make sure we redisplay all windows in this frame. */
1690 ++windows_or_buffers_changed
;
1692 delta
= nlines
- FRAME_TOOL_BAR_LINES (f
);
1694 /* Don't resize the tool-bar to more than we have room for. */
1695 root_window
= FRAME_ROOT_WINDOW (f
);
1696 root_height
= WINDOW_TOTAL_LINES (XWINDOW (root_window
));
1697 if (root_height
- delta
< 1)
1699 delta
= root_height
- 1;
1700 nlines
= FRAME_TOOL_BAR_LINES (f
) + delta
;
1703 FRAME_TOOL_BAR_LINES (f
) = nlines
;
1704 change_window_heights (root_window
, delta
);
1707 /* We also have to make sure that the internal border at the top of
1708 the frame, below the menu bar or tool bar, is redrawn when the
1709 tool bar disappears. This is so because the internal border is
1710 below the tool bar if one is displayed, but is below the menu bar
1711 if there isn't a tool bar. The tool bar draws into the area
1712 below the menu bar. */
1713 if (FRAME_X_WINDOW (f
) && FRAME_TOOL_BAR_LINES (f
) == 0)
1717 clear_current_matrices (f
);
1718 updating_frame
= NULL
;
1721 /* If the tool bar gets smaller, the internal border below it
1722 has to be cleared. It was formerly part of the display
1723 of the larger tool bar, and updating windows won't clear it. */
1726 int height
= FRAME_INTERNAL_BORDER_WIDTH (f
);
1727 int width
= FRAME_PIXEL_WIDTH (f
);
1728 int y
= nlines
* FRAME_LINE_HEIGHT (f
);
1731 x_clear_area (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
1732 0, y
, width
, height
, False
);
1735 if (WINDOWP (f
->tool_bar_window
))
1736 clear_glyph_matrix (XWINDOW (f
->tool_bar_window
)->current_matrix
);
1741 /* Set the foreground color for scroll bars on frame F to VALUE.
1742 VALUE should be a string, a color name. If it isn't a string or
1743 isn't a valid color name, do nothing. OLDVAL is the old value of
1744 the frame parameter. */
1747 x_set_scroll_bar_foreground (f
, value
, oldval
)
1749 Lisp_Object value
, oldval
;
1751 unsigned long pixel
;
1753 if (STRINGP (value
))
1754 pixel
= x_decode_color (f
, value
, BLACK_PIX_DEFAULT (f
));
1758 if (f
->output_data
.x
->scroll_bar_foreground_pixel
!= -1)
1759 unload_color (f
, f
->output_data
.x
->scroll_bar_foreground_pixel
);
1761 f
->output_data
.x
->scroll_bar_foreground_pixel
= pixel
;
1762 if (FRAME_X_WINDOW (f
) && FRAME_VISIBLE_P (f
))
1764 /* Remove all scroll bars because they have wrong colors. */
1765 if (condemn_scroll_bars_hook
)
1766 (*condemn_scroll_bars_hook
) (f
);
1767 if (judge_scroll_bars_hook
)
1768 (*judge_scroll_bars_hook
) (f
);
1770 update_face_from_frame_parameter (f
, Qscroll_bar_foreground
, value
);
1776 /* Set the background color for scroll bars on frame F to VALUE VALUE
1777 should be a string, a color name. If it isn't a string or isn't a
1778 valid color name, do nothing. OLDVAL is the old value of the frame
1782 x_set_scroll_bar_background (f
, value
, oldval
)
1784 Lisp_Object value
, oldval
;
1786 unsigned long pixel
;
1788 if (STRINGP (value
))
1789 pixel
= x_decode_color (f
, value
, WHITE_PIX_DEFAULT (f
));
1793 if (f
->output_data
.x
->scroll_bar_background_pixel
!= -1)
1794 unload_color (f
, f
->output_data
.x
->scroll_bar_background_pixel
);
1796 #ifdef USE_TOOLKIT_SCROLL_BARS
1797 /* Scrollbar shadow colors. */
1798 if (f
->output_data
.x
->scroll_bar_top_shadow_pixel
!= -1)
1800 unload_color (f
, f
->output_data
.x
->scroll_bar_top_shadow_pixel
);
1801 f
->output_data
.x
->scroll_bar_top_shadow_pixel
= -1;
1803 if (f
->output_data
.x
->scroll_bar_bottom_shadow_pixel
!= -1)
1805 unload_color (f
, f
->output_data
.x
->scroll_bar_bottom_shadow_pixel
);
1806 f
->output_data
.x
->scroll_bar_bottom_shadow_pixel
= -1;
1808 #endif /* USE_TOOLKIT_SCROLL_BARS */
1810 f
->output_data
.x
->scroll_bar_background_pixel
= pixel
;
1811 if (FRAME_X_WINDOW (f
) && FRAME_VISIBLE_P (f
))
1813 /* Remove all scroll bars because they have wrong colors. */
1814 if (condemn_scroll_bars_hook
)
1815 (*condemn_scroll_bars_hook
) (f
);
1816 if (judge_scroll_bars_hook
)
1817 (*judge_scroll_bars_hook
) (f
);
1819 update_face_from_frame_parameter (f
, Qscroll_bar_background
, value
);
1825 /* Encode Lisp string STRING as a text in a format appropriate for
1826 XICCC (X Inter Client Communication Conventions).
1828 If STRING contains only ASCII characters, do no conversion and
1829 return the string data of STRING. Otherwise, encode the text by
1830 CODING_SYSTEM, and return a newly allocated memory area which
1831 should be freed by `xfree' by a caller.
1833 SELECTIONP non-zero means the string is being encoded for an X
1834 selection, so it is safe to run pre-write conversions (which
1837 Store the byte length of resulting text in *TEXT_BYTES.
1839 If the text contains only ASCII and Latin-1, store 1 in *STRING_P,
1840 which means that the `encoding' of the result can be `STRING'.
1841 Otherwise store 0 in *STRINGP, which means that the `encoding' of
1842 the result should be `COMPOUND_TEXT'. */
1845 x_encode_text (string
, coding_system
, selectionp
, text_bytes
, stringp
)
1846 Lisp_Object string
, coding_system
;
1847 int *text_bytes
, *stringp
;
1850 unsigned char *str
= SDATA (string
);
1851 int chars
= SCHARS (string
);
1852 int bytes
= SBYTES (string
);
1856 struct coding_system coding
;
1857 extern Lisp_Object Qcompound_text_with_extensions
;
1859 charset_info
= find_charset_in_text (str
, chars
, bytes
, NULL
, Qnil
);
1860 if (charset_info
== 0)
1862 /* No multibyte character in OBJ. We need not encode it. */
1863 *text_bytes
= bytes
;
1868 setup_coding_system (coding_system
, &coding
);
1870 && SYMBOLP (coding
.pre_write_conversion
)
1871 && !NILP (Ffboundp (coding
.pre_write_conversion
)))
1873 string
= run_pre_post_conversion_on_str (string
, &coding
, 1);
1874 str
= SDATA (string
);
1875 chars
= SCHARS (string
);
1876 bytes
= SBYTES (string
);
1878 coding
.src_multibyte
= 1;
1879 coding
.dst_multibyte
= 0;
1880 coding
.mode
|= CODING_MODE_LAST_BLOCK
;
1881 if (coding
.type
== coding_type_iso2022
)
1882 coding
.flags
|= CODING_FLAG_ISO_SAFE
;
1883 /* We suppress producing escape sequences for composition. */
1884 coding
.composing
= COMPOSITION_DISABLED
;
1885 bufsize
= encoding_buffer_size (&coding
, bytes
);
1886 buf
= (unsigned char *) xmalloc (bufsize
);
1887 encode_coding (&coding
, str
, buf
, bytes
, bufsize
);
1888 *text_bytes
= coding
.produced
;
1889 *stringp
= (charset_info
== 1
1890 || (!EQ (coding_system
, Qcompound_text
)
1891 && !EQ (coding_system
, Qcompound_text_with_extensions
)));
1896 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1899 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1900 name; if NAME is a string, set F's name to NAME and set
1901 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1903 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1904 suggesting a new name, which lisp code should override; if
1905 F->explicit_name is set, ignore the new name; otherwise, set it. */
1908 x_set_name (f
, name
, explicit)
1913 /* Make sure that requests from lisp code override requests from
1914 Emacs redisplay code. */
1917 /* If we're switching from explicit to implicit, we had better
1918 update the mode lines and thereby update the title. */
1919 if (f
->explicit_name
&& NILP (name
))
1920 update_mode_lines
= 1;
1922 f
->explicit_name
= ! NILP (name
);
1924 else if (f
->explicit_name
)
1927 /* If NAME is nil, set the name to the x_id_name. */
1930 /* Check for no change needed in this very common case
1931 before we do any consing. */
1932 if (!strcmp (FRAME_X_DISPLAY_INFO (f
)->x_id_name
,
1935 name
= build_string (FRAME_X_DISPLAY_INFO (f
)->x_id_name
);
1938 CHECK_STRING (name
);
1940 /* Don't change the name if it's already NAME. */
1941 if (! NILP (Fstring_equal (name
, f
->name
)))
1946 /* For setting the frame title, the title parameter should override
1947 the name parameter. */
1948 if (! NILP (f
->title
))
1951 if (FRAME_X_WINDOW (f
))
1956 XTextProperty text
, icon
;
1958 Lisp_Object coding_system
;
1960 /* Note: Encoding strategy
1962 We encode NAME by compound-text and use "COMPOUND-TEXT" in
1963 text.encoding. But, there are non-internationalized window
1964 managers which don't support that encoding. So, if NAME
1965 contains only ASCII and 8859-1 characters, encode it by
1966 iso-latin-1, and use "STRING" in text.encoding hoping that
1967 such window managers at least analyze this format correctly,
1968 i.e. treat 8-bit bytes as 8859-1 characters.
1970 We may also be able to use "UTF8_STRING" in text.encoding
1971 in the future which can encode all Unicode characters.
1972 But, for the moment, there's no way to know that the
1973 current window manager supports it or not. */
1974 coding_system
= Qcompound_text
;
1975 text
.value
= x_encode_text (name
, coding_system
, 0, &bytes
, &stringp
);
1976 text
.encoding
= (stringp
? XA_STRING
1977 : FRAME_X_DISPLAY_INFO (f
)->Xatom_COMPOUND_TEXT
);
1979 text
.nitems
= bytes
;
1981 if (NILP (f
->icon_name
))
1987 /* See the above comment "Note: Encoding strategy". */
1988 icon
.value
= x_encode_text (f
->icon_name
, coding_system
, 0,
1990 icon
.encoding
= (stringp
? XA_STRING
1991 : FRAME_X_DISPLAY_INFO (f
)->Xatom_COMPOUND_TEXT
);
1993 icon
.nitems
= bytes
;
1996 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f
)),
1998 #else /* not USE_GTK */
1999 XSetWMName (FRAME_X_DISPLAY (f
), FRAME_OUTER_WINDOW (f
), &text
);
2000 #endif /* not USE_GTK */
2002 XSetWMIconName (FRAME_X_DISPLAY (f
), FRAME_OUTER_WINDOW (f
), &icon
);
2004 if (!NILP (f
->icon_name
)
2005 && icon
.value
!= (unsigned char *) SDATA (f
->icon_name
))
2007 if (text
.value
!= (unsigned char *) SDATA (name
))
2010 #else /* not HAVE_X11R4 */
2011 XSetIconName (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2013 XStoreName (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2015 #endif /* not HAVE_X11R4 */
2020 /* This function should be called when the user's lisp code has
2021 specified a name for the frame; the name will override any set by the
2024 x_explicitly_set_name (f
, arg
, oldval
)
2026 Lisp_Object arg
, oldval
;
2028 x_set_name (f
, arg
, 1);
2031 /* This function should be called by Emacs redisplay code to set the
2032 name; names set this way will never override names set by the user's
2035 x_implicitly_set_name (f
, arg
, oldval
)
2037 Lisp_Object arg
, oldval
;
2039 x_set_name (f
, arg
, 0);
2042 /* Change the title of frame F to NAME.
2043 If NAME is nil, use the frame name as the title.
2045 If EXPLICIT is non-zero, that indicates that lisp code is setting the
2046 name; if NAME is a string, set F's name to NAME and set
2047 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
2049 If EXPLICIT is zero, that indicates that Emacs redisplay code is
2050 suggesting a new name, which lisp code should override; if
2051 F->explicit_name is set, ignore the new name; otherwise, set it. */
2054 x_set_title (f
, name
, old_name
)
2056 Lisp_Object name
, old_name
;
2058 /* Don't change the title if it's already NAME. */
2059 if (EQ (name
, f
->title
))
2062 update_mode_lines
= 1;
2069 CHECK_STRING (name
);
2071 if (FRAME_X_WINDOW (f
))
2076 XTextProperty text
, icon
;
2078 Lisp_Object coding_system
;
2080 coding_system
= Qcompound_text
;
2081 /* See the comment "Note: Encoding strategy" in x_set_name. */
2082 text
.value
= x_encode_text (name
, coding_system
, 0, &bytes
, &stringp
);
2083 text
.encoding
= (stringp
? XA_STRING
2084 : FRAME_X_DISPLAY_INFO (f
)->Xatom_COMPOUND_TEXT
);
2086 text
.nitems
= bytes
;
2088 if (NILP (f
->icon_name
))
2094 /* See the comment "Note: Encoding strategy" in x_set_name. */
2095 icon
.value
= x_encode_text (f
->icon_name
, coding_system
, 0,
2097 icon
.encoding
= (stringp
? XA_STRING
2098 : FRAME_X_DISPLAY_INFO (f
)->Xatom_COMPOUND_TEXT
);
2100 icon
.nitems
= bytes
;
2104 gtk_window_set_title (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f
)),
2106 #else /* not USE_GTK */
2107 XSetWMName (FRAME_X_DISPLAY (f
), FRAME_OUTER_WINDOW (f
), &text
);
2108 #endif /* not USE_GTK */
2110 XSetWMIconName (FRAME_X_DISPLAY (f
), FRAME_OUTER_WINDOW (f
),
2113 if (!NILP (f
->icon_name
)
2114 && icon
.value
!= (unsigned char *) SDATA (f
->icon_name
))
2116 if (text
.value
!= (unsigned char *) SDATA (name
))
2119 #else /* not HAVE_X11R4 */
2120 XSetIconName (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2122 XStoreName (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2124 #endif /* not HAVE_X11R4 */
2130 x_set_scroll_bar_default_width (f
)
2133 int wid
= FRAME_COLUMN_WIDTH (f
);
2135 #ifdef USE_TOOLKIT_SCROLL_BARS
2136 /* A minimum width of 14 doesn't look good for toolkit scroll bars. */
2137 int width
= 16 + 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM
;
2138 FRAME_CONFIG_SCROLL_BAR_COLS (f
) = (width
+ wid
- 1) / wid
;
2139 FRAME_CONFIG_SCROLL_BAR_WIDTH (f
) = width
;
2141 /* Make the actual width at least 14 pixels and a multiple of a
2143 FRAME_CONFIG_SCROLL_BAR_COLS (f
) = (14 + wid
- 1) / wid
;
2145 /* Use all of that space (aside from required margins) for the
2147 FRAME_CONFIG_SCROLL_BAR_WIDTH (f
) = 0;
2152 /* Record in frame F the specified or default value according to ALIST
2153 of the parameter named PROP (a Lisp symbol). If no value is
2154 specified for PROP, look for an X default for XPROP on the frame
2155 named NAME. If that is not found either, use the value DEFLT. */
2158 x_default_scroll_bar_color_parameter (f
, alist
, prop
, xprop
, xclass
,
2167 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
2170 tem
= x_get_arg (dpyinfo
, alist
, prop
, xprop
, xclass
, RES_TYPE_STRING
);
2171 if (EQ (tem
, Qunbound
))
2173 #ifdef USE_TOOLKIT_SCROLL_BARS
2175 /* See if an X resource for the scroll bar color has been
2177 tem
= display_x_get_resource (dpyinfo
,
2178 build_string (foreground_p
2182 build_string ("verticalScrollBar"),
2186 /* If nothing has been specified, scroll bars will use a
2187 toolkit-dependent default. Because these defaults are
2188 difficult to get at without actually creating a scroll
2189 bar, use nil to indicate that no color has been
2194 #else /* not USE_TOOLKIT_SCROLL_BARS */
2198 #endif /* not USE_TOOLKIT_SCROLL_BARS */
2201 x_set_frame_parameters (f
, Fcons (Fcons (prop
, tem
), Qnil
));
2207 #if !defined (HAVE_X11R4) && !defined (HAVE_XSETWMPROTOCOLS)
2210 XSetWMProtocols (dpy
, w
, protocols
, count
)
2217 prop
= XInternAtom (dpy
, "WM_PROTOCOLS", False
);
2218 if (prop
== None
) return False
;
2219 XChangeProperty (dpy
, w
, prop
, XA_ATOM
, 32, PropModeReplace
,
2220 (unsigned char *) protocols
, count
);
2223 #endif /* not HAVE_X11R4 && not HAVE_XSETWMPROTOCOLS */
2225 #ifdef USE_X_TOOLKIT
2227 /* If the WM_PROTOCOLS property does not already contain WM_TAKE_FOCUS,
2228 WM_DELETE_WINDOW, and WM_SAVE_YOURSELF, then add them. (They may
2229 already be present because of the toolkit (Motif adds some of them,
2230 for example, but Xt doesn't). */
2233 hack_wm_protocols (f
, widget
)
2237 Display
*dpy
= XtDisplay (widget
);
2238 Window w
= XtWindow (widget
);
2239 int need_delete
= 1;
2245 Atom type
, *atoms
= 0;
2247 unsigned long nitems
= 0;
2248 unsigned long bytes_after
;
2250 if ((XGetWindowProperty (dpy
, w
,
2251 FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_protocols
,
2252 (long)0, (long)100, False
, XA_ATOM
,
2253 &type
, &format
, &nitems
, &bytes_after
,
2254 (unsigned char **) &atoms
)
2256 && format
== 32 && type
== XA_ATOM
)
2260 if (atoms
[nitems
] == FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_delete_window
)
2262 else if (atoms
[nitems
] == FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_take_focus
)
2264 else if (atoms
[nitems
] == FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_save_yourself
)
2267 if (atoms
) XFree ((char *) atoms
);
2273 props
[count
++] = FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_delete_window
;
2275 props
[count
++] = FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_take_focus
;
2277 props
[count
++] = FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_save_yourself
;
2279 XChangeProperty (dpy
, w
, FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_protocols
,
2280 XA_ATOM
, 32, PropModeAppend
,
2281 (unsigned char *) props
, count
);
2289 /* Support routines for XIC (X Input Context). */
2293 static XFontSet xic_create_xfontset
P_ ((struct frame
*, char *));
2294 static XIMStyle best_xim_style
P_ ((XIMStyles
*, XIMStyles
*));
2297 /* Supported XIM styles, ordered by preference. */
2299 static XIMStyle supported_xim_styles
[] =
2301 XIMPreeditPosition
| XIMStatusArea
,
2302 XIMPreeditPosition
| XIMStatusNothing
,
2303 XIMPreeditPosition
| XIMStatusNone
,
2304 XIMPreeditNothing
| XIMStatusArea
,
2305 XIMPreeditNothing
| XIMStatusNothing
,
2306 XIMPreeditNothing
| XIMStatusNone
,
2307 XIMPreeditNone
| XIMStatusArea
,
2308 XIMPreeditNone
| XIMStatusNothing
,
2309 XIMPreeditNone
| XIMStatusNone
,
2314 /* Create an X fontset on frame F with base font name
2318 xic_create_xfontset (f
, base_fontname
)
2320 char *base_fontname
;
2323 char **missing_list
;
2327 xfs
= XCreateFontSet (FRAME_X_DISPLAY (f
),
2328 base_fontname
, &missing_list
,
2329 &missing_count
, &def_string
);
2331 XFreeStringList (missing_list
);
2333 /* No need to free def_string. */
2338 /* Value is the best input style, given user preferences USER (already
2339 checked to be supported by Emacs), and styles supported by the
2340 input method XIM. */
2343 best_xim_style (user
, xim
)
2349 for (i
= 0; i
< user
->count_styles
; ++i
)
2350 for (j
= 0; j
< xim
->count_styles
; ++j
)
2351 if (user
->supported_styles
[i
] == xim
->supported_styles
[j
])
2352 return user
->supported_styles
[i
];
2354 /* Return the default style. */
2355 return XIMPreeditNothing
| XIMStatusNothing
;
2358 /* Create XIC for frame F. */
2360 static XIMStyle xic_style
;
2363 create_frame_xic (f
)
2368 XFontSet xfs
= NULL
;
2373 xim
= FRAME_X_XIM (f
);
2378 XVaNestedList preedit_attr
;
2379 XVaNestedList status_attr
;
2380 char *base_fontname
;
2383 s_area
.x
= 0; s_area
.y
= 0; s_area
.width
= 1; s_area
.height
= 1;
2384 spot
.x
= 0; spot
.y
= 1;
2385 /* Create X fontset. */
2386 fontset
= FRAME_FONTSET (f
);
2388 base_fontname
= "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
2391 /* Determine the base fontname from the ASCII font name of
2393 char *ascii_font
= (char *) SDATA (fontset_ascii (fontset
));
2394 char *p
= ascii_font
;
2397 for (i
= 0; *p
; p
++)
2400 /* As the font name doesn't conform to XLFD, we can't
2401 modify it to get a suitable base fontname for the
2403 base_fontname
= "-*-*-*-r-normal--14-*-*-*-*-*-*-*";
2406 int len
= strlen (ascii_font
) + 1;
2409 for (i
= 0, p
= ascii_font
; i
< 8; p
++)
2418 base_fontname
= (char *) alloca (len
);
2419 bzero (base_fontname
, len
);
2420 strcpy (base_fontname
, "-*-*-");
2421 bcopy (p1
, base_fontname
+ 5, p
- p1
);
2422 strcat (base_fontname
, "*-*-*-*-*-*-*");
2425 xfs
= xic_create_xfontset (f
, base_fontname
);
2427 /* Determine XIC style. */
2430 XIMStyles supported_list
;
2431 supported_list
.count_styles
= (sizeof supported_xim_styles
2432 / sizeof supported_xim_styles
[0]);
2433 supported_list
.supported_styles
= supported_xim_styles
;
2434 xic_style
= best_xim_style (&supported_list
,
2435 FRAME_X_XIM_STYLES (f
));
2438 preedit_attr
= XVaCreateNestedList (0,
2441 FRAME_FOREGROUND_PIXEL (f
),
2443 FRAME_BACKGROUND_PIXEL (f
),
2444 (xic_style
& XIMPreeditPosition
2449 status_attr
= XVaCreateNestedList (0,
2455 FRAME_FOREGROUND_PIXEL (f
),
2457 FRAME_BACKGROUND_PIXEL (f
),
2460 xic
= XCreateIC (xim
,
2461 XNInputStyle
, xic_style
,
2462 XNClientWindow
, FRAME_X_WINDOW (f
),
2463 XNFocusWindow
, FRAME_X_WINDOW (f
),
2464 XNStatusAttributes
, status_attr
,
2465 XNPreeditAttributes
, preedit_attr
,
2467 XFree (preedit_attr
);
2468 XFree (status_attr
);
2471 FRAME_XIC (f
) = xic
;
2472 FRAME_XIC_STYLE (f
) = xic_style
;
2473 FRAME_XIC_FONTSET (f
) = xfs
;
2477 /* Destroy XIC and free XIC fontset of frame F, if any. */
2483 if (FRAME_XIC (f
) == NULL
)
2486 XDestroyIC (FRAME_XIC (f
));
2487 if (FRAME_XIC_FONTSET (f
))
2488 XFreeFontSet (FRAME_X_DISPLAY (f
), FRAME_XIC_FONTSET (f
));
2490 FRAME_XIC (f
) = NULL
;
2491 FRAME_XIC_FONTSET (f
) = NULL
;
2495 /* Place preedit area for XIC of window W's frame to specified
2496 pixel position X/Y. X and Y are relative to window W. */
2499 xic_set_preeditarea (w
, x
, y
)
2503 struct frame
*f
= XFRAME (w
->frame
);
2507 spot
.x
= WINDOW_TO_FRAME_PIXEL_X (w
, x
) + WINDOW_LEFT_FRINGE_WIDTH (w
);
2508 spot
.y
= WINDOW_TO_FRAME_PIXEL_Y (w
, y
) + FONT_BASE (FRAME_FONT (f
));
2509 attr
= XVaCreateNestedList (0, XNSpotLocation
, &spot
, NULL
);
2510 XSetICValues (FRAME_XIC (f
), XNPreeditAttributes
, attr
, NULL
);
2515 /* Place status area for XIC in bottom right corner of frame F.. */
2518 xic_set_statusarea (f
)
2521 XIC xic
= FRAME_XIC (f
);
2526 /* Negotiate geometry of status area. If input method has existing
2527 status area, use its current size. */
2528 area
.x
= area
.y
= area
.width
= area
.height
= 0;
2529 attr
= XVaCreateNestedList (0, XNAreaNeeded
, &area
, NULL
);
2530 XSetICValues (xic
, XNStatusAttributes
, attr
, NULL
);
2533 attr
= XVaCreateNestedList (0, XNAreaNeeded
, &needed
, NULL
);
2534 XGetICValues (xic
, XNStatusAttributes
, attr
, NULL
);
2537 if (needed
->width
== 0) /* Use XNArea instead of XNAreaNeeded */
2539 attr
= XVaCreateNestedList (0, XNArea
, &needed
, NULL
);
2540 XGetICValues (xic
, XNStatusAttributes
, attr
, NULL
);
2544 area
.width
= needed
->width
;
2545 area
.height
= needed
->height
;
2546 area
.x
= FRAME_PIXEL_WIDTH (f
) - area
.width
- FRAME_INTERNAL_BORDER_WIDTH (f
);
2547 area
.y
= (FRAME_PIXEL_HEIGHT (f
) - area
.height
2548 - FRAME_MENUBAR_HEIGHT (f
)
2549 - FRAME_TOOLBAR_HEIGHT (f
)
2550 - FRAME_INTERNAL_BORDER_WIDTH (f
));
2553 attr
= XVaCreateNestedList (0, XNArea
, &area
, NULL
);
2554 XSetICValues (xic
, XNStatusAttributes
, attr
, NULL
);
2559 /* Set X fontset for XIC of frame F, using base font name
2560 BASE_FONTNAME. Called when a new Emacs fontset is chosen. */
2563 xic_set_xfontset (f
, base_fontname
)
2565 char *base_fontname
;
2570 xfs
= xic_create_xfontset (f
, base_fontname
);
2572 attr
= XVaCreateNestedList (0, XNFontSet
, xfs
, NULL
);
2573 if (FRAME_XIC_STYLE (f
) & XIMPreeditPosition
)
2574 XSetICValues (FRAME_XIC (f
), XNPreeditAttributes
, attr
, NULL
);
2575 if (FRAME_XIC_STYLE (f
) & XIMStatusArea
)
2576 XSetICValues (FRAME_XIC (f
), XNStatusAttributes
, attr
, NULL
);
2579 if (FRAME_XIC_FONTSET (f
))
2580 XFreeFontSet (FRAME_X_DISPLAY (f
), FRAME_XIC_FONTSET (f
));
2581 FRAME_XIC_FONTSET (f
) = xfs
;
2584 #endif /* HAVE_X_I18N */
2588 #ifdef USE_X_TOOLKIT
2590 /* Create and set up the X widget for frame F. */
2593 x_window (f
, window_prompting
, minibuffer_only
)
2595 long window_prompting
;
2596 int minibuffer_only
;
2598 XClassHint class_hints
;
2599 XSetWindowAttributes attributes
;
2600 unsigned long attribute_mask
;
2601 Widget shell_widget
;
2603 Widget frame_widget
;
2609 /* Use the resource name as the top-level widget name
2610 for looking up resources. Make a non-Lisp copy
2611 for the window manager, so GC relocation won't bother it.
2613 Elsewhere we specify the window name for the window manager. */
2616 char *str
= (char *) SDATA (Vx_resource_name
);
2617 f
->namebuf
= (char *) xmalloc (strlen (str
) + 1);
2618 strcpy (f
->namebuf
, str
);
2622 XtSetArg (al
[ac
], XtNallowShellResize
, 1); ac
++;
2623 XtSetArg (al
[ac
], XtNinput
, 1); ac
++;
2624 XtSetArg (al
[ac
], XtNmappedWhenManaged
, 0); ac
++;
2625 XtSetArg (al
[ac
], XtNborderWidth
, f
->border_width
); ac
++;
2626 XtSetArg (al
[ac
], XtNvisual
, FRAME_X_VISUAL (f
)); ac
++;
2627 XtSetArg (al
[ac
], XtNdepth
, FRAME_X_DISPLAY_INFO (f
)->n_planes
); ac
++;
2628 XtSetArg (al
[ac
], XtNcolormap
, FRAME_X_COLORMAP (f
)); ac
++;
2629 shell_widget
= XtAppCreateShell (f
->namebuf
, EMACS_CLASS
,
2630 applicationShellWidgetClass
,
2631 FRAME_X_DISPLAY (f
), al
, ac
);
2633 f
->output_data
.x
->widget
= shell_widget
;
2634 /* maybe_set_screen_title_format (shell_widget); */
2636 pane_widget
= lw_create_widget ("main", "pane", widget_id_tick
++,
2637 (widget_value
*) NULL
,
2638 shell_widget
, False
,
2642 (lw_callback
) NULL
);
2645 XtSetArg (al
[ac
], XtNvisual
, FRAME_X_VISUAL (f
)); ac
++;
2646 XtSetArg (al
[ac
], XtNdepth
, FRAME_X_DISPLAY_INFO (f
)->n_planes
); ac
++;
2647 XtSetArg (al
[ac
], XtNcolormap
, FRAME_X_COLORMAP (f
)); ac
++;
2648 XtSetValues (pane_widget
, al
, ac
);
2649 f
->output_data
.x
->column_widget
= pane_widget
;
2651 /* mappedWhenManaged to false tells to the paned window to not map/unmap
2652 the emacs screen when changing menubar. This reduces flickering. */
2655 XtSetArg (al
[ac
], XtNmappedWhenManaged
, 0); ac
++;
2656 XtSetArg (al
[ac
], XtNshowGrip
, 0); ac
++;
2657 XtSetArg (al
[ac
], XtNallowResize
, 1); ac
++;
2658 XtSetArg (al
[ac
], XtNresizeToPreferred
, 1); ac
++;
2659 XtSetArg (al
[ac
], XtNemacsFrame
, f
); ac
++;
2660 XtSetArg (al
[ac
], XtNvisual
, FRAME_X_VISUAL (f
)); ac
++;
2661 XtSetArg (al
[ac
], XtNdepth
, FRAME_X_DISPLAY_INFO (f
)->n_planes
); ac
++;
2662 XtSetArg (al
[ac
], XtNcolormap
, FRAME_X_COLORMAP (f
)); ac
++;
2663 frame_widget
= XtCreateWidget (f
->namebuf
, emacsFrameClass
, pane_widget
,
2666 f
->output_data
.x
->edit_widget
= frame_widget
;
2668 XtManageChild (frame_widget
);
2670 /* Do some needed geometry management. */
2673 char *tem
, shell_position
[32];
2676 int extra_borders
= 0;
2678 = (f
->output_data
.x
->menubar_widget
2679 ? (f
->output_data
.x
->menubar_widget
->core
.height
2680 + f
->output_data
.x
->menubar_widget
->core
.border_width
)
2683 #if 0 /* Experimentally, we now get the right results
2684 for -geometry -0-0 without this. 24 Aug 96, rms. */
2685 if (FRAME_EXTERNAL_MENU_BAR (f
))
2688 XtVaGetValues (pane_widget
, XtNinternalBorderWidth
, &ibw
, NULL
);
2689 menubar_size
+= ibw
;
2693 f
->output_data
.x
->menubar_height
= menubar_size
;
2696 /* Motif seems to need this amount added to the sizes
2697 specified for the shell widget. The Athena/Lucid widgets don't.
2698 Both conclusions reached experimentally. -- rms. */
2699 XtVaGetValues (f
->output_data
.x
->edit_widget
, XtNinternalBorderWidth
,
2700 &extra_borders
, NULL
);
2704 /* Convert our geometry parameters into a geometry string
2706 Note that we do not specify here whether the position
2707 is a user-specified or program-specified one.
2708 We pass that information later, in x_wm_set_size_hints. */
2710 int left
= f
->left_pos
;
2711 int xneg
= window_prompting
& XNegative
;
2712 int top
= f
->top_pos
;
2713 int yneg
= window_prompting
& YNegative
;
2719 if (window_prompting
& USPosition
)
2720 sprintf (shell_position
, "=%dx%d%c%d%c%d",
2721 FRAME_PIXEL_WIDTH (f
) + extra_borders
,
2722 FRAME_PIXEL_HEIGHT (f
) + menubar_size
+ extra_borders
,
2723 (xneg
? '-' : '+'), left
,
2724 (yneg
? '-' : '+'), top
);
2727 sprintf (shell_position
, "=%dx%d",
2728 FRAME_PIXEL_WIDTH (f
) + extra_borders
,
2729 FRAME_PIXEL_HEIGHT (f
) + menubar_size
+ extra_borders
);
2731 /* Setting x and y when the position is not specified in
2732 the geometry string will set program position in the WM hints.
2733 If Emacs had just one program position, we could set it in
2734 fallback resources, but since each make-frame call can specify
2735 different program positions, this is easier. */
2736 XtSetArg (al
[ac
], XtNx
, left
); ac
++;
2737 XtSetArg (al
[ac
], XtNy
, top
); ac
++;
2741 len
= strlen (shell_position
) + 1;
2742 /* We don't free this because we don't know whether
2743 it is safe to free it while the frame exists.
2744 It isn't worth the trouble of arranging to free it
2745 when the frame is deleted. */
2746 tem
= (char *) xmalloc (len
);
2747 strncpy (tem
, shell_position
, len
);
2748 XtSetArg (al
[ac
], XtNgeometry
, tem
); ac
++;
2749 XtSetValues (shell_widget
, al
, ac
);
2752 XtManageChild (pane_widget
);
2753 XtRealizeWidget (shell_widget
);
2755 FRAME_X_WINDOW (f
) = XtWindow (frame_widget
);
2757 validate_x_resource_name ();
2759 class_hints
.res_name
= (char *) SDATA (Vx_resource_name
);
2760 class_hints
.res_class
= (char *) SDATA (Vx_resource_class
);
2761 XSetClassHint (FRAME_X_DISPLAY (f
), XtWindow (shell_widget
), &class_hints
);
2764 FRAME_XIC (f
) = NULL
;
2766 create_frame_xic (f
);
2769 f
->output_data
.x
->wm_hints
.input
= True
;
2770 f
->output_data
.x
->wm_hints
.flags
|= InputHint
;
2771 XSetWMHints (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2772 &f
->output_data
.x
->wm_hints
);
2774 hack_wm_protocols (f
, shell_widget
);
2777 XtAddEventHandler (shell_widget
, 0, True
, _XEditResCheckMessages
, 0);
2780 /* Do a stupid property change to force the server to generate a
2781 PropertyNotify event so that the event_stream server timestamp will
2782 be initialized to something relevant to the time we created the window.
2784 XChangeProperty (XtDisplay (frame_widget
), XtWindow (frame_widget
),
2785 FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_protocols
,
2786 XA_ATOM
, 32, PropModeAppend
,
2787 (unsigned char*) NULL
, 0);
2789 /* Make all the standard events reach the Emacs frame. */
2790 attributes
.event_mask
= STANDARD_EVENT_SET
;
2795 /* XIM server might require some X events. */
2796 unsigned long fevent
= NoEventMask
;
2797 XGetICValues (FRAME_XIC (f
), XNFilterEvents
, &fevent
, NULL
);
2798 attributes
.event_mask
|= fevent
;
2800 #endif /* HAVE_X_I18N */
2802 attribute_mask
= CWEventMask
;
2803 XChangeWindowAttributes (XtDisplay (shell_widget
), XtWindow (shell_widget
),
2804 attribute_mask
, &attributes
);
2806 XtMapWidget (frame_widget
);
2808 /* x_set_name normally ignores requests to set the name if the
2809 requested name is the same as the current name. This is the one
2810 place where that assumption isn't correct; f->name is set, but
2811 the X server hasn't been told. */
2814 int explicit = f
->explicit_name
;
2816 f
->explicit_name
= 0;
2819 x_set_name (f
, name
, explicit);
2822 XDefineCursor (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2823 f
->output_data
.x
->text_cursor
);
2827 /* This is a no-op, except under Motif. Make sure main areas are
2828 set to something reasonable, in case we get an error later. */
2829 lw_set_main_areas (pane_widget
, 0, frame_widget
);
2832 #else /* not USE_X_TOOLKIT */
2838 if (! xg_create_frame_widgets (f
))
2839 error ("Unable to create window");
2842 FRAME_XIC (f
) = NULL
;
2846 create_frame_xic (f
);
2849 /* XIM server might require some X events. */
2850 unsigned long fevent
= NoEventMask
;
2851 XGetICValues (FRAME_XIC (f
), XNFilterEvents
, &fevent
, NULL
);
2853 if (fevent
!= NoEventMask
)
2855 XSetWindowAttributes attributes
;
2856 XWindowAttributes wattr
;
2857 unsigned long attribute_mask
;
2859 XGetWindowAttributes (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2861 attributes
.event_mask
= wattr
.your_event_mask
| fevent
;
2862 attribute_mask
= CWEventMask
;
2863 XChangeWindowAttributes (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2864 attribute_mask
, &attributes
);
2872 #else /*! USE_GTK */
2873 /* Create and set up the X window for frame F. */
2880 XClassHint class_hints
;
2881 XSetWindowAttributes attributes
;
2882 unsigned long attribute_mask
;
2884 attributes
.background_pixel
= f
->output_data
.x
->background_pixel
;
2885 attributes
.border_pixel
= f
->output_data
.x
->border_pixel
;
2886 attributes
.bit_gravity
= StaticGravity
;
2887 attributes
.backing_store
= NotUseful
;
2888 attributes
.save_under
= True
;
2889 attributes
.event_mask
= STANDARD_EVENT_SET
;
2890 attributes
.colormap
= FRAME_X_COLORMAP (f
);
2891 attribute_mask
= (CWBackPixel
| CWBorderPixel
| CWBitGravity
| CWEventMask
2896 = XCreateWindow (FRAME_X_DISPLAY (f
),
2897 f
->output_data
.x
->parent_desc
,
2900 FRAME_PIXEL_WIDTH (f
), FRAME_PIXEL_HEIGHT (f
),
2902 CopyFromParent
, /* depth */
2903 InputOutput
, /* class */
2905 attribute_mask
, &attributes
);
2910 create_frame_xic (f
);
2913 /* XIM server might require some X events. */
2914 unsigned long fevent
= NoEventMask
;
2915 XGetICValues (FRAME_XIC (f
), XNFilterEvents
, &fevent
, NULL
);
2916 attributes
.event_mask
|= fevent
;
2917 attribute_mask
= CWEventMask
;
2918 XChangeWindowAttributes (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2919 attribute_mask
, &attributes
);
2922 #endif /* HAVE_X_I18N */
2924 validate_x_resource_name ();
2926 class_hints
.res_name
= (char *) SDATA (Vx_resource_name
);
2927 class_hints
.res_class
= (char *) SDATA (Vx_resource_class
);
2928 XSetClassHint (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
), &class_hints
);
2930 /* The menubar is part of the ordinary display;
2931 it does not count in addition to the height of the window. */
2932 f
->output_data
.x
->menubar_height
= 0;
2934 /* This indicates that we use the "Passive Input" input model.
2935 Unless we do this, we don't get the Focus{In,Out} events that we
2936 need to draw the cursor correctly. Accursed bureaucrats.
2937 XWhipsAndChains (FRAME_X_DISPLAY (f), IronMaiden, &TheRack); */
2939 f
->output_data
.x
->wm_hints
.input
= True
;
2940 f
->output_data
.x
->wm_hints
.flags
|= InputHint
;
2941 XSetWMHints (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2942 &f
->output_data
.x
->wm_hints
);
2943 f
->output_data
.x
->wm_hints
.icon_pixmap
= None
;
2945 /* Request "save yourself" and "delete window" commands from wm. */
2948 protocols
[0] = FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_delete_window
;
2949 protocols
[1] = FRAME_X_DISPLAY_INFO (f
)->Xatom_wm_save_yourself
;
2950 XSetWMProtocols (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
), protocols
, 2);
2953 /* x_set_name normally ignores requests to set the name if the
2954 requested name is the same as the current name. This is the one
2955 place where that assumption isn't correct; f->name is set, but
2956 the X server hasn't been told. */
2959 int explicit = f
->explicit_name
;
2961 f
->explicit_name
= 0;
2964 x_set_name (f
, name
, explicit);
2967 XDefineCursor (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
2968 f
->output_data
.x
->text_cursor
);
2972 if (FRAME_X_WINDOW (f
) == 0)
2973 error ("Unable to create window");
2976 #endif /* not USE_GTK */
2977 #endif /* not USE_X_TOOLKIT */
2979 /* Handle the icon stuff for this window. Perhaps later we might
2980 want an x_set_icon_position which can be called interactively as
2988 Lisp_Object icon_x
, icon_y
;
2989 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
2991 /* Set the position of the icon. Note that twm groups all
2992 icons in an icon window. */
2993 icon_x
= x_frame_get_and_record_arg (f
, parms
, Qicon_left
, 0, 0, RES_TYPE_NUMBER
);
2994 icon_y
= x_frame_get_and_record_arg (f
, parms
, Qicon_top
, 0, 0, RES_TYPE_NUMBER
);
2995 if (!EQ (icon_x
, Qunbound
) && !EQ (icon_y
, Qunbound
))
2997 CHECK_NUMBER (icon_x
);
2998 CHECK_NUMBER (icon_y
);
3000 else if (!EQ (icon_x
, Qunbound
) || !EQ (icon_y
, Qunbound
))
3001 error ("Both left and top icon corners of icon must be specified");
3005 if (! EQ (icon_x
, Qunbound
))
3006 x_wm_set_icon_position (f
, XINT (icon_x
), XINT (icon_y
));
3008 /* Start up iconic or window? */
3009 x_wm_set_window_state
3010 (f
, (EQ (x_get_arg (dpyinfo
, parms
, Qvisibility
, 0, 0, RES_TYPE_SYMBOL
),
3015 x_text_icon (f
, (char *) SDATA ((!NILP (f
->icon_name
)
3022 /* Make the GCs needed for this window, setting the
3023 background, border and mouse colors; also create the
3024 mouse cursor and the gray border tile. */
3026 static char cursor_bits
[] =
3028 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3029 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3030 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
3031 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
3038 XGCValues gc_values
;
3042 /* Create the GCs of this frame.
3043 Note that many default values are used. */
3046 gc_values
.font
= FRAME_FONT (f
)->fid
;
3047 gc_values
.foreground
= f
->output_data
.x
->foreground_pixel
;
3048 gc_values
.background
= f
->output_data
.x
->background_pixel
;
3049 gc_values
.line_width
= 0; /* Means 1 using fast algorithm. */
3050 f
->output_data
.x
->normal_gc
3051 = XCreateGC (FRAME_X_DISPLAY (f
),
3053 GCLineWidth
| GCFont
| GCForeground
| GCBackground
,
3056 /* Reverse video style. */
3057 gc_values
.foreground
= f
->output_data
.x
->background_pixel
;
3058 gc_values
.background
= f
->output_data
.x
->foreground_pixel
;
3059 f
->output_data
.x
->reverse_gc
3060 = XCreateGC (FRAME_X_DISPLAY (f
),
3062 GCFont
| GCForeground
| GCBackground
| GCLineWidth
,
3065 /* Cursor has cursor-color background, background-color foreground. */
3066 gc_values
.foreground
= f
->output_data
.x
->background_pixel
;
3067 gc_values
.background
= f
->output_data
.x
->cursor_pixel
;
3068 gc_values
.fill_style
= FillOpaqueStippled
;
3070 = XCreateBitmapFromData (FRAME_X_DISPLAY (f
),
3071 FRAME_X_DISPLAY_INFO (f
)->root_window
,
3072 cursor_bits
, 16, 16);
3073 f
->output_data
.x
->cursor_gc
3074 = XCreateGC (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3075 (GCFont
| GCForeground
| GCBackground
3076 | GCFillStyle
/* | GCStipple */ | GCLineWidth
),
3080 f
->output_data
.x
->white_relief
.gc
= 0;
3081 f
->output_data
.x
->black_relief
.gc
= 0;
3083 /* Create the gray border tile used when the pointer is not in
3084 the frame. Since this depends on the frame's pixel values,
3085 this must be done on a per-frame basis. */
3086 f
->output_data
.x
->border_tile
3087 = (XCreatePixmapFromBitmapData
3088 (FRAME_X_DISPLAY (f
), FRAME_X_DISPLAY_INFO (f
)->root_window
,
3089 gray_bits
, gray_width
, gray_height
,
3090 f
->output_data
.x
->foreground_pixel
,
3091 f
->output_data
.x
->background_pixel
,
3092 DefaultDepth (FRAME_X_DISPLAY (f
), FRAME_X_SCREEN_NUMBER (f
))));
3098 /* Free what was was allocated in x_make_gc. */
3104 Display
*dpy
= FRAME_X_DISPLAY (f
);
3108 if (f
->output_data
.x
->normal_gc
)
3110 XFreeGC (dpy
, f
->output_data
.x
->normal_gc
);
3111 f
->output_data
.x
->normal_gc
= 0;
3114 if (f
->output_data
.x
->reverse_gc
)
3116 XFreeGC (dpy
, f
->output_data
.x
->reverse_gc
);
3117 f
->output_data
.x
->reverse_gc
= 0;
3120 if (f
->output_data
.x
->cursor_gc
)
3122 XFreeGC (dpy
, f
->output_data
.x
->cursor_gc
);
3123 f
->output_data
.x
->cursor_gc
= 0;
3126 if (f
->output_data
.x
->border_tile
)
3128 XFreePixmap (dpy
, f
->output_data
.x
->border_tile
);
3129 f
->output_data
.x
->border_tile
= 0;
3136 /* Handler for signals raised during x_create_frame and
3137 x_create_top_frame. FRAME is the frame which is partially
3141 unwind_create_frame (frame
)
3144 struct frame
*f
= XFRAME (frame
);
3146 /* If frame is ``official'', nothing to do. */
3147 if (!CONSP (Vframe_list
) || !EQ (XCAR (Vframe_list
), frame
))
3150 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
3153 x_free_frame_resources (f
);
3155 /* Check that reference counts are indeed correct. */
3156 xassert (dpyinfo
->reference_count
== dpyinfo_refcount
);
3157 xassert (dpyinfo
->image_cache
->refcount
== image_cache_refcount
);
3165 DEFUN ("x-create-frame", Fx_create_frame
, Sx_create_frame
,
3167 doc
: /* Make a new X window, which is called a "frame" in Emacs terms.
3168 Returns an Emacs frame object.
3169 ALIST is an alist of frame parameters.
3170 If the parameters specify that the frame should not have a minibuffer,
3171 and do not specify a specific minibuffer window to use,
3172 then `default-minibuffer-frame' must be a frame whose minibuffer can
3173 be shared by the new frame.
3175 This function is an internal primitive--use `make-frame' instead. */)
3180 Lisp_Object frame
, tem
;
3182 int minibuffer_only
= 0;
3183 long window_prompting
= 0;
3185 int count
= SPECPDL_INDEX ();
3186 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
3187 Lisp_Object display
;
3188 struct x_display_info
*dpyinfo
= NULL
;
3194 /* XXX rif hack:Make sure rif is set to the right value. */
3195 rif
= x_display_method
.rif
;
3197 /* Use this general default value to start with
3198 until we know if this frame has a specified name. */
3199 Vx_resource_name
= Vinvocation_name
;
3201 display
= x_get_arg (dpyinfo
, parms
, Qdisplay
, 0, 0, RES_TYPE_STRING
);
3202 if (EQ (display
, Qunbound
))
3204 dpyinfo
= check_x_display_info (display
);
3206 kb
= dpyinfo
->kboard
;
3208 kb
= &the_only_kboard
;
3211 name
= x_get_arg (dpyinfo
, parms
, Qname
, "name", "Name", RES_TYPE_STRING
);
3213 && ! EQ (name
, Qunbound
)
3215 error ("Invalid frame name--not a string or nil");
3218 Vx_resource_name
= name
;
3220 /* See if parent window is specified. */
3221 parent
= x_get_arg (dpyinfo
, parms
, Qparent_id
, NULL
, NULL
, RES_TYPE_NUMBER
);
3222 if (EQ (parent
, Qunbound
))
3224 if (! NILP (parent
))
3225 CHECK_NUMBER (parent
);
3227 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
3228 /* No need to protect DISPLAY because that's not used after passing
3229 it to make_frame_without_minibuffer. */
3231 GCPRO4 (parms
, parent
, name
, frame
);
3232 tem
= x_get_arg (dpyinfo
, parms
, Qminibuffer
, "minibuffer", "Minibuffer",
3234 if (EQ (tem
, Qnone
) || NILP (tem
))
3235 f
= make_frame_without_minibuffer (Qnil
, kb
, display
);
3236 else if (EQ (tem
, Qonly
))
3238 f
= make_minibuffer_frame ();
3239 minibuffer_only
= 1;
3241 else if (WINDOWP (tem
))
3242 f
= make_frame_without_minibuffer (tem
, kb
, display
);
3246 XSETFRAME (frame
, f
);
3248 /* Note that X Windows does support scroll bars. */
3249 FRAME_CAN_HAVE_SCROLL_BARS (f
) = 1;
3251 f
->display_method
= &x_display_method
;
3252 f
->output_method
= output_x_window
;
3253 f
->output_data
.x
= (struct x_output
*) xmalloc (sizeof (struct x_output
));
3254 bzero (f
->output_data
.x
, sizeof (struct x_output
));
3255 f
->output_data
.x
->icon_bitmap
= -1;
3256 FRAME_FONTSET (f
) = -1;
3257 f
->output_data
.x
->scroll_bar_foreground_pixel
= -1;
3258 f
->output_data
.x
->scroll_bar_background_pixel
= -1;
3259 #ifdef USE_TOOLKIT_SCROLL_BARS
3260 f
->output_data
.x
->scroll_bar_top_shadow_pixel
= -1;
3261 f
->output_data
.x
->scroll_bar_bottom_shadow_pixel
= -1;
3262 #endif /* USE_TOOLKIT_SCROLL_BARS */
3263 record_unwind_protect (unwind_create_frame
, frame
);
3266 = x_get_arg (dpyinfo
, parms
, Qicon_name
, "iconName", "Title",
3268 if (! STRINGP (f
->icon_name
))
3269 f
->icon_name
= Qnil
;
3271 FRAME_X_DISPLAY_INFO (f
) = dpyinfo
;
3273 image_cache_refcount
= FRAME_X_IMAGE_CACHE (f
)->refcount
;
3274 dpyinfo_refcount
= dpyinfo
->reference_count
;
3275 #endif /* GLYPH_DEBUG */
3277 FRAME_KBOARD (f
) = kb
;
3280 /* These colors will be set anyway later, but it's important
3281 to get the color reference counts right, so initialize them! */
3284 struct gcpro gcpro1
;
3286 /* Function x_decode_color can signal an error. Make
3287 sure to initialize color slots so that we won't try
3288 to free colors we haven't allocated. */
3289 f
->output_data
.x
->foreground_pixel
= -1;
3290 f
->output_data
.x
->background_pixel
= -1;
3291 f
->output_data
.x
->cursor_pixel
= -1;
3292 f
->output_data
.x
->cursor_foreground_pixel
= -1;
3293 f
->output_data
.x
->border_pixel
= -1;
3294 f
->output_data
.x
->mouse_pixel
= -1;
3296 black
= build_string ("black");
3298 f
->output_data
.x
->foreground_pixel
3299 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
3300 f
->output_data
.x
->background_pixel
3301 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
3302 f
->output_data
.x
->cursor_pixel
3303 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
3304 f
->output_data
.x
->cursor_foreground_pixel
3305 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
3306 f
->output_data
.x
->border_pixel
3307 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
3308 f
->output_data
.x
->mouse_pixel
3309 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
3313 /* Specify the parent under which to make this X window. */
3317 f
->output_data
.x
->parent_desc
= (Window
) XFASTINT (parent
);
3318 f
->output_data
.x
->explicit_parent
= 1;
3322 f
->output_data
.x
->parent_desc
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
3323 f
->output_data
.x
->explicit_parent
= 0;
3326 /* Set the name; the functions to which we pass f expect the name to
3328 if (EQ (name
, Qunbound
) || NILP (name
))
3330 f
->name
= build_string (dpyinfo
->x_id_name
);
3331 f
->explicit_name
= 0;
3336 f
->explicit_name
= 1;
3337 /* use the frame's title when getting resources for this frame. */
3338 specbind (Qx_resource_name
, name
);
3341 /* Extract the window parameters from the supplied values
3342 that are needed to determine window geometry. */
3346 font
= x_get_arg (dpyinfo
, parms
, Qfont
, "font", "Font", RES_TYPE_STRING
);
3349 /* First, try whatever font the caller has specified. */
3352 tem
= Fquery_fontset (font
, Qnil
);
3354 font
= x_new_fontset (f
, SDATA (tem
));
3356 font
= x_new_font (f
, SDATA (font
));
3359 /* Try out a font which we hope has bold and italic variations. */
3360 if (!STRINGP (font
))
3361 font
= x_new_font (f
, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
3362 if (!STRINGP (font
))
3363 font
= x_new_font (f
, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3364 if (! STRINGP (font
))
3365 font
= x_new_font (f
, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
3366 if (! STRINGP (font
))
3367 /* This was formerly the first thing tried, but it finds too many fonts
3368 and takes too long. */
3369 font
= x_new_font (f
, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
3370 /* If those didn't work, look for something which will at least work. */
3371 if (! STRINGP (font
))
3372 font
= x_new_font (f
, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
3374 if (! STRINGP (font
))
3375 font
= build_string ("fixed");
3377 x_default_parameter (f
, parms
, Qfont
, font
,
3378 "font", "Font", RES_TYPE_STRING
);
3382 /* Prevent lwlib/xlwmenu.c from crashing because of a bug
3383 whereby it fails to get any font. */
3384 xlwmenu_default_font
= FRAME_FONT (f
);
3387 x_default_parameter (f
, parms
, Qborder_width
, make_number (2),
3388 "borderWidth", "BorderWidth", RES_TYPE_NUMBER
);
3390 /* This defaults to 1 in order to match xterm. We recognize either
3391 internalBorderWidth or internalBorder (which is what xterm calls
3393 if (NILP (Fassq (Qinternal_border_width
, parms
)))
3397 value
= x_get_arg (dpyinfo
, parms
, Qinternal_border_width
,
3398 "internalBorder", "internalBorder", RES_TYPE_NUMBER
);
3399 if (! EQ (value
, Qunbound
))
3400 parms
= Fcons (Fcons (Qinternal_border_width
, value
),
3403 x_default_parameter (f
, parms
, Qinternal_border_width
, make_number (1),
3404 "internalBorderWidth", "internalBorderWidth",
3406 x_default_parameter (f
, parms
, Qvertical_scroll_bars
, Qleft
,
3407 "verticalScrollBars", "ScrollBars",
3410 /* Also do the stuff which must be set before the window exists. */
3411 x_default_parameter (f
, parms
, Qforeground_color
, build_string ("black"),
3412 "foreground", "Foreground", RES_TYPE_STRING
);
3413 x_default_parameter (f
, parms
, Qbackground_color
, build_string ("white"),
3414 "background", "Background", RES_TYPE_STRING
);
3415 x_default_parameter (f
, parms
, Qmouse_color
, build_string ("black"),
3416 "pointerColor", "Foreground", RES_TYPE_STRING
);
3417 x_default_parameter (f
, parms
, Qcursor_color
, build_string ("black"),
3418 "cursorColor", "Foreground", RES_TYPE_STRING
);
3419 x_default_parameter (f
, parms
, Qborder_color
, build_string ("black"),
3420 "borderColor", "BorderColor", RES_TYPE_STRING
);
3421 x_default_parameter (f
, parms
, Qscreen_gamma
, Qnil
,
3422 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT
);
3423 x_default_parameter (f
, parms
, Qline_spacing
, Qnil
,
3424 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER
);
3425 x_default_parameter (f
, parms
, Qleft_fringe
, Qnil
,
3426 "leftFringe", "LeftFringe", RES_TYPE_NUMBER
);
3427 x_default_parameter (f
, parms
, Qright_fringe
, Qnil
,
3428 "rightFringe", "RightFringe", RES_TYPE_NUMBER
);
3430 x_default_scroll_bar_color_parameter (f
, parms
, Qscroll_bar_foreground
,
3431 "scrollBarForeground",
3432 "ScrollBarForeground", 1);
3433 x_default_scroll_bar_color_parameter (f
, parms
, Qscroll_bar_background
,
3434 "scrollBarBackground",
3435 "ScrollBarBackground", 0);
3437 /* Init faces before x_default_parameter is called for scroll-bar
3438 parameters because that function calls x_set_scroll_bar_width,
3439 which calls change_frame_size, which calls Fset_window_buffer,
3440 which runs hooks, which call Fvertical_motion. At the end, we
3441 end up in init_iterator with a null face cache, which should not
3443 init_frame_faces (f
);
3445 x_default_parameter (f
, parms
, Qmenu_bar_lines
, make_number (1),
3446 "menuBar", "MenuBar", RES_TYPE_NUMBER
);
3447 x_default_parameter (f
, parms
, Qtool_bar_lines
, make_number (1),
3448 "toolBar", "ToolBar", RES_TYPE_NUMBER
);
3449 x_default_parameter (f
, parms
, Qbuffer_predicate
, Qnil
,
3450 "bufferPredicate", "BufferPredicate",
3452 x_default_parameter (f
, parms
, Qtitle
, Qnil
,
3453 "title", "Title", RES_TYPE_STRING
);
3454 x_default_parameter (f
, parms
, Qwait_for_wm
, Qt
,
3455 "waitForWM", "WaitForWM", RES_TYPE_BOOLEAN
);
3456 x_default_parameter (f
, parms
, Qfullscreen
, Qnil
,
3457 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL
);
3459 f
->output_data
.x
->parent_desc
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
3461 /* Compute the size of the X window. */
3462 window_prompting
= x_figure_window_size (f
, parms
, 1);
3464 tem
= x_get_arg (dpyinfo
, parms
, Qunsplittable
, 0, 0, RES_TYPE_BOOLEAN
);
3465 f
->no_split
= minibuffer_only
|| EQ (tem
, Qt
);
3467 /* Create the X widget or window. */
3468 #ifdef USE_X_TOOLKIT
3469 x_window (f
, window_prompting
, minibuffer_only
);
3477 /* Now consider the frame official. */
3478 FRAME_X_DISPLAY_INFO (f
)->reference_count
++;
3479 Vframe_list
= Fcons (frame
, Vframe_list
);
3481 /* We need to do this after creating the X window, so that the
3482 icon-creation functions can say whose icon they're describing. */
3483 x_default_parameter (f
, parms
, Qicon_type
, Qnil
,
3484 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL
);
3486 x_default_parameter (f
, parms
, Qauto_raise
, Qnil
,
3487 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN
);
3488 x_default_parameter (f
, parms
, Qauto_lower
, Qnil
,
3489 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN
);
3490 x_default_parameter (f
, parms
, Qcursor_type
, Qbox
,
3491 "cursorType", "CursorType", RES_TYPE_SYMBOL
);
3492 x_default_parameter (f
, parms
, Qscroll_bar_width
, Qnil
,
3493 "scrollBarWidth", "ScrollBarWidth",
3496 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
3497 Change will not be effected unless different from the current
3499 width
= FRAME_COLS (f
);
3500 height
= FRAME_LINES (f
);
3502 SET_FRAME_COLS (f
, 0);
3503 FRAME_LINES (f
) = 0;
3504 change_frame_size (f
, height
, width
, 1, 0, 0);
3506 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
3507 /* Create the menu bar. */
3508 if (!minibuffer_only
&& FRAME_EXTERNAL_MENU_BAR (f
))
3510 /* If this signals an error, we haven't set size hints for the
3511 frame and we didn't make it visible. */
3512 initialize_frame_menubar (f
);
3515 /* This is a no-op, except under Motif where it arranges the
3516 main window for the widgets on it. */
3517 lw_set_main_areas (f
->output_data
.x
->column_widget
,
3518 f
->output_data
.x
->menubar_widget
,
3519 f
->output_data
.x
->edit_widget
);
3520 #endif /* not USE_GTK */
3522 #endif /* USE_X_TOOLKIT || USE_GTK */
3524 /* Tell the server what size and position, etc, we want, and how
3525 badly we want them. This should be done after we have the menu
3526 bar so that its size can be taken into account. */
3528 x_wm_set_size_hint (f
, window_prompting
, 0);
3531 /* Make the window appear on the frame and enable display, unless
3532 the caller says not to. However, with explicit parent, Emacs
3533 cannot control visibility, so don't try. */
3534 if (! f
->output_data
.x
->explicit_parent
)
3536 Lisp_Object visibility
;
3538 visibility
= x_get_arg (dpyinfo
, parms
, Qvisibility
, 0, 0,
3540 if (EQ (visibility
, Qunbound
))
3543 if (EQ (visibility
, Qicon
))
3544 x_iconify_frame (f
);
3545 else if (! NILP (visibility
))
3546 x_make_frame_visible (f
);
3548 /* Must have been Qnil. */
3552 /* Set the WM leader property. GTK does this itself, so this is not
3553 needed when using GTK. */
3554 if (dpyinfo
->client_leader_window
!= 0)
3557 XChangeProperty (FRAME_X_DISPLAY (f
),
3558 FRAME_OUTER_WINDOW (f
),
3559 dpyinfo
->Xatom_wm_client_leader
,
3560 XA_WINDOW
, 32, PropModeReplace
,
3561 (char *) &dpyinfo
->client_leader_window
, 1);
3567 /* Make sure windows on this frame appear in calls to next-window
3568 and similar functions. */
3569 Vwindow_list
= Qnil
;
3571 return unbind_to (count
, frame
);
3575 /* FRAME is used only to get a handle on the X display. We don't pass the
3576 display info directly because we're called from frame.c, which doesn't
3577 know about that structure. */
3580 x_get_focus_frame (frame
)
3581 struct frame
*frame
;
3583 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (frame
);
3585 if (! dpyinfo
->x_focus_frame
)
3588 XSETFRAME (xfocus
, dpyinfo
->x_focus_frame
);
3593 /* In certain situations, when the window manager follows a
3594 click-to-focus policy, there seems to be no way around calling
3595 XSetInputFocus to give another frame the input focus .
3597 In an ideal world, XSetInputFocus should generally be avoided so
3598 that applications don't interfere with the window manager's focus
3599 policy. But I think it's okay to use when it's clearly done
3600 following a user-command. */
3602 DEFUN ("x-focus-frame", Fx_focus_frame
, Sx_focus_frame
, 1, 1, 0,
3603 doc
: /* Set the input focus to FRAME.
3604 FRAME nil means use the selected frame. */)
3608 struct frame
*f
= check_x_frame (frame
);
3609 Display
*dpy
= FRAME_X_DISPLAY (f
);
3613 count
= x_catch_errors (dpy
);
3614 XSetInputFocus (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
3615 RevertToParent
, CurrentTime
);
3616 x_uncatch_errors (dpy
, count
);
3623 DEFUN ("xw-color-defined-p", Fxw_color_defined_p
, Sxw_color_defined_p
, 1, 2, 0,
3624 doc
: /* Internal function called by `color-defined-p', which see. */)
3626 Lisp_Object color
, frame
;
3629 FRAME_PTR f
= check_x_frame (frame
);
3631 CHECK_STRING (color
);
3633 if (x_defined_color (f
, SDATA (color
), &foo
, 0))
3639 DEFUN ("xw-color-values", Fxw_color_values
, Sxw_color_values
, 1, 2, 0,
3640 doc
: /* Internal function called by `color-values', which see. */)
3642 Lisp_Object color
, frame
;
3645 FRAME_PTR f
= check_x_frame (frame
);
3647 CHECK_STRING (color
);
3649 if (x_defined_color (f
, SDATA (color
), &foo
, 0))
3653 rgb
[0] = make_number (foo
.red
);
3654 rgb
[1] = make_number (foo
.green
);
3655 rgb
[2] = make_number (foo
.blue
);
3656 return Flist (3, rgb
);
3662 DEFUN ("xw-display-color-p", Fxw_display_color_p
, Sxw_display_color_p
, 0, 1, 0,
3663 doc
: /* Internal function called by `display-color-p', which see. */)
3665 Lisp_Object display
;
3667 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3669 if (dpyinfo
->n_planes
<= 2)
3672 switch (dpyinfo
->visual
->class)
3685 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p
, Sx_display_grayscale_p
,
3687 doc
: /* Return t if the X display supports shades of gray.
3688 Note that color displays do support shades of gray.
3689 The optional argument DISPLAY specifies which display to ask about.
3690 DISPLAY should be either a frame or a display name (a string).
3691 If omitted or nil, that stands for the selected frame's display. */)
3693 Lisp_Object display
;
3695 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3697 if (dpyinfo
->n_planes
<= 1)
3700 switch (dpyinfo
->visual
->class)
3715 DEFUN ("x-display-pixel-width", Fx_display_pixel_width
, Sx_display_pixel_width
,
3717 doc
: /* Returns the width in pixels of the X display DISPLAY.
3718 The optional argument DISPLAY specifies which display to ask about.
3719 DISPLAY should be either a frame or a display name (a string).
3720 If omitted or nil, that stands for the selected frame's display. */)
3722 Lisp_Object display
;
3724 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3726 return make_number (dpyinfo
->width
);
3729 DEFUN ("x-display-pixel-height", Fx_display_pixel_height
,
3730 Sx_display_pixel_height
, 0, 1, 0,
3731 doc
: /* Returns the height in pixels of the X display DISPLAY.
3732 The optional argument DISPLAY specifies which display to ask about.
3733 DISPLAY should be either a frame or a display name (a string).
3734 If omitted or nil, that stands for the selected frame's display. */)
3736 Lisp_Object display
;
3738 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3740 return make_number (dpyinfo
->height
);
3743 DEFUN ("x-display-planes", Fx_display_planes
, Sx_display_planes
,
3745 doc
: /* Returns the number of bitplanes of the X display DISPLAY.
3746 The optional argument DISPLAY specifies which display to ask about.
3747 DISPLAY should be either a frame or a display name (a string).
3748 If omitted or nil, that stands for the selected frame's display. */)
3750 Lisp_Object display
;
3752 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3754 return make_number (dpyinfo
->n_planes
);
3757 DEFUN ("x-display-color-cells", Fx_display_color_cells
, Sx_display_color_cells
,
3759 doc
: /* Returns the number of color cells of the X display DISPLAY.
3760 The optional argument DISPLAY specifies which display to ask about.
3761 DISPLAY should be either a frame or a display name (a string).
3762 If omitted or nil, that stands for the selected frame's display. */)
3764 Lisp_Object display
;
3766 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3768 return make_number (DisplayCells (dpyinfo
->display
,
3769 XScreenNumberOfScreen (dpyinfo
->screen
)));
3772 DEFUN ("x-server-max-request-size", Fx_server_max_request_size
,
3773 Sx_server_max_request_size
,
3775 doc
: /* Returns the maximum request size of the X server of display DISPLAY.
3776 The optional argument DISPLAY specifies which display to ask about.
3777 DISPLAY should be either a frame or a display name (a string).
3778 If omitted or nil, that stands for the selected frame's display. */)
3780 Lisp_Object display
;
3782 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3784 return make_number (MAXREQUEST (dpyinfo
->display
));
3787 DEFUN ("x-server-vendor", Fx_server_vendor
, Sx_server_vendor
, 0, 1, 0,
3788 doc
: /* Returns the vendor ID string of the X server of display DISPLAY.
3789 The optional argument DISPLAY specifies which display to ask about.
3790 DISPLAY should be either a frame or a display name (a string).
3791 If omitted or nil, that stands for the selected frame's display. */)
3793 Lisp_Object display
;
3795 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3796 char *vendor
= ServerVendor (dpyinfo
->display
);
3798 if (! vendor
) vendor
= "";
3799 return build_string (vendor
);
3802 DEFUN ("x-server-version", Fx_server_version
, Sx_server_version
, 0, 1, 0,
3803 doc
: /* Returns the version numbers of the X server of display DISPLAY.
3804 The value is a list of three integers: the major and minor
3805 version numbers of the X Protocol in use, and the vendor-specific release
3806 number. See also the function `x-server-vendor'.
3808 The optional argument DISPLAY specifies which display to ask about.
3809 DISPLAY should be either a frame or a display name (a string).
3810 If omitted or nil, that stands for the selected frame's display. */)
3812 Lisp_Object display
;
3814 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3815 Display
*dpy
= dpyinfo
->display
;
3817 return Fcons (make_number (ProtocolVersion (dpy
)),
3818 Fcons (make_number (ProtocolRevision (dpy
)),
3819 Fcons (make_number (VendorRelease (dpy
)), Qnil
)));
3822 DEFUN ("x-display-screens", Fx_display_screens
, Sx_display_screens
, 0, 1, 0,
3823 doc
: /* Return the number of screens on the X server of display DISPLAY.
3824 The optional argument DISPLAY specifies which display to ask about.
3825 DISPLAY should be either a frame or a display name (a string).
3826 If omitted or nil, that stands for the selected frame's display. */)
3828 Lisp_Object display
;
3830 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3832 return make_number (ScreenCount (dpyinfo
->display
));
3835 DEFUN ("x-display-mm-height", Fx_display_mm_height
, Sx_display_mm_height
, 0, 1, 0,
3836 doc
: /* Return the height in millimeters of the X display DISPLAY.
3837 The optional argument DISPLAY specifies which display to ask about.
3838 DISPLAY should be either a frame or a display name (a string).
3839 If omitted or nil, that stands for the selected frame's display. */)
3841 Lisp_Object display
;
3843 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3845 return make_number (HeightMMOfScreen (dpyinfo
->screen
));
3848 DEFUN ("x-display-mm-width", Fx_display_mm_width
, Sx_display_mm_width
, 0, 1, 0,
3849 doc
: /* Return the width in millimeters of the X display DISPLAY.
3850 The optional argument DISPLAY specifies which display to ask about.
3851 DISPLAY should be either a frame or a display name (a string).
3852 If omitted or nil, that stands for the selected frame's display. */)
3854 Lisp_Object display
;
3856 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3858 return make_number (WidthMMOfScreen (dpyinfo
->screen
));
3861 DEFUN ("x-display-backing-store", Fx_display_backing_store
,
3862 Sx_display_backing_store
, 0, 1, 0,
3863 doc
: /* Returns an indication of whether X display DISPLAY does backing store.
3864 The value may be `always', `when-mapped', or `not-useful'.
3865 The optional argument DISPLAY specifies which display to ask about.
3866 DISPLAY should be either a frame or a display name (a string).
3867 If omitted or nil, that stands for the selected frame's display. */)
3869 Lisp_Object display
;
3871 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3874 switch (DoesBackingStore (dpyinfo
->screen
))
3877 result
= intern ("always");
3881 result
= intern ("when-mapped");
3885 result
= intern ("not-useful");
3889 error ("Strange value for BackingStore parameter of screen");
3896 DEFUN ("x-display-visual-class", Fx_display_visual_class
,
3897 Sx_display_visual_class
, 0, 1, 0,
3898 doc
: /* Return the visual class of the X display DISPLAY.
3899 The value is one of the symbols `static-gray', `gray-scale',
3900 `static-color', `pseudo-color', `true-color', or `direct-color'.
3902 The optional argument DISPLAY specifies which display to ask about.
3903 DISPLAY should be either a frame or a display name (a string).
3904 If omitted or nil, that stands for the selected frame's display. */)
3906 Lisp_Object display
;
3908 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3911 switch (dpyinfo
->visual
->class)
3914 result
= intern ("static-gray");
3917 result
= intern ("gray-scale");
3920 result
= intern ("static-color");
3923 result
= intern ("pseudo-color");
3926 result
= intern ("true-color");
3929 result
= intern ("direct-color");
3932 error ("Display has an unknown visual class");
3939 DEFUN ("x-display-save-under", Fx_display_save_under
,
3940 Sx_display_save_under
, 0, 1, 0,
3941 doc
: /* Returns t if the X display DISPLAY supports the save-under feature.
3942 The optional argument DISPLAY specifies which display to ask about.
3943 DISPLAY should be either a frame or a display name (a string).
3944 If omitted or nil, that stands for the selected frame's display. */)
3946 Lisp_Object display
;
3948 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
3950 if (DoesSaveUnders (dpyinfo
->screen
) == True
)
3958 register struct frame
*f
;
3960 return FRAME_PIXEL_WIDTH (f
);
3965 register struct frame
*f
;
3967 return FRAME_PIXEL_HEIGHT (f
);
3972 register struct frame
*f
;
3974 return FRAME_COLUMN_WIDTH (f
);
3979 register struct frame
*f
;
3981 return FRAME_LINE_HEIGHT (f
);
3986 register struct frame
*f
;
3988 return FRAME_X_DISPLAY_INFO (f
)->n_planes
;
3993 /************************************************************************
3995 ************************************************************************/
3998 /* Mapping visual names to visuals. */
4000 static struct visual_class
4007 {"StaticGray", StaticGray
},
4008 {"GrayScale", GrayScale
},
4009 {"StaticColor", StaticColor
},
4010 {"PseudoColor", PseudoColor
},
4011 {"TrueColor", TrueColor
},
4012 {"DirectColor", DirectColor
},
4017 #ifndef HAVE_XSCREENNUMBEROFSCREEN
4019 /* Value is the screen number of screen SCR. This is a substitute for
4020 the X function with the same name when that doesn't exist. */
4023 XScreenNumberOfScreen (scr
)
4024 register Screen
*scr
;
4026 Display
*dpy
= scr
->display
;
4029 for (i
= 0; i
< dpy
->nscreens
; ++i
)
4030 if (scr
== dpy
->screens
+ i
)
4036 #endif /* not HAVE_XSCREENNUMBEROFSCREEN */
4039 /* Select the visual that should be used on display DPYINFO. Set
4040 members of DPYINFO appropriately. Called from x_term_init. */
4043 select_visual (dpyinfo
)
4044 struct x_display_info
*dpyinfo
;
4046 Display
*dpy
= dpyinfo
->display
;
4047 Screen
*screen
= dpyinfo
->screen
;
4050 /* See if a visual is specified. */
4051 value
= display_x_get_resource (dpyinfo
,
4052 build_string ("visualClass"),
4053 build_string ("VisualClass"),
4055 if (STRINGP (value
))
4057 /* VALUE should be of the form CLASS-DEPTH, where CLASS is one
4058 of `PseudoColor', `TrueColor' etc. and DEPTH is the color
4059 depth, a decimal number. NAME is compared with case ignored. */
4060 char *s
= (char *) alloca (SBYTES (value
) + 1);
4065 strcpy (s
, SDATA (value
));
4066 dash
= index (s
, '-');
4069 dpyinfo
->n_planes
= atoi (dash
+ 1);
4073 /* We won't find a matching visual with depth 0, so that
4074 an error will be printed below. */
4075 dpyinfo
->n_planes
= 0;
4077 /* Determine the visual class. */
4078 for (i
= 0; visual_classes
[i
].name
; ++i
)
4079 if (xstricmp (s
, visual_classes
[i
].name
) == 0)
4081 class = visual_classes
[i
].class;
4085 /* Look up a matching visual for the specified class. */
4087 || !XMatchVisualInfo (dpy
, XScreenNumberOfScreen (screen
),
4088 dpyinfo
->n_planes
, class, &vinfo
))
4089 fatal ("Invalid visual specification `%s'", SDATA (value
));
4091 dpyinfo
->visual
= vinfo
.visual
;
4096 XVisualInfo
*vinfo
, vinfo_template
;
4098 dpyinfo
->visual
= DefaultVisualOfScreen (screen
);
4101 vinfo_template
.visualid
= XVisualIDFromVisual (dpyinfo
->visual
);
4103 vinfo_template
.visualid
= dpyinfo
->visual
->visualid
;
4105 vinfo_template
.screen
= XScreenNumberOfScreen (screen
);
4106 vinfo
= XGetVisualInfo (dpy
, VisualIDMask
| VisualScreenMask
,
4107 &vinfo_template
, &n_visuals
);
4109 fatal ("Can't get proper X visual info");
4111 dpyinfo
->n_planes
= vinfo
->depth
;
4112 XFree ((char *) vinfo
);
4117 /* Return the X display structure for the display named NAME.
4118 Open a new connection if necessary. */
4120 struct x_display_info
*
4121 x_display_info_for_name (name
)
4125 struct x_display_info
*dpyinfo
;
4127 CHECK_STRING (name
);
4129 if (! EQ (Vwindow_system
, intern ("x")))
4130 error ("Not using X Windows");
4132 for (dpyinfo
= x_display_list
, names
= x_display_name_list
;
4134 dpyinfo
= dpyinfo
->next
, names
= XCDR (names
))
4137 tem
= Fstring_equal (XCAR (XCAR (names
)), name
);
4142 /* Use this general default value to start with. */
4143 Vx_resource_name
= Vinvocation_name
;
4145 validate_x_resource_name ();
4147 dpyinfo
= x_term_init (name
, (char *)0,
4148 (char *) SDATA (Vx_resource_name
));
4151 error ("Cannot connect to X server %s", SDATA (name
));
4154 XSETFASTINT (Vwindow_system_version
, 11);
4160 DEFUN ("x-open-connection", Fx_open_connection
, Sx_open_connection
,
4162 doc
: /* Open a connection to an X server.
4163 DISPLAY is the name of the display to connect to.
4164 Optional second arg XRM-STRING is a string of resources in xrdb format.
4165 If the optional third arg MUST-SUCCEED is non-nil,
4166 terminate Emacs if we can't open the connection. */)
4167 (display
, xrm_string
, must_succeed
)
4168 Lisp_Object display
, xrm_string
, must_succeed
;
4170 unsigned char *xrm_option
;
4171 struct x_display_info
*dpyinfo
;
4173 CHECK_STRING (display
);
4174 if (! NILP (xrm_string
))
4175 CHECK_STRING (xrm_string
);
4177 if (! EQ (Vwindow_system
, intern ("x")))
4178 error ("Not using X Windows");
4180 if (! NILP (xrm_string
))
4181 xrm_option
= (unsigned char *) SDATA (xrm_string
);
4183 xrm_option
= (unsigned char *) 0;
4185 validate_x_resource_name ();
4187 /* This is what opens the connection and sets x_current_display.
4188 This also initializes many symbols, such as those used for input. */
4189 dpyinfo
= x_term_init (display
, xrm_option
,
4190 (char *) SDATA (Vx_resource_name
));
4194 if (!NILP (must_succeed
))
4195 fatal ("Cannot connect to X server %s.\n\
4196 Check the DISPLAY environment variable or use `-d'.\n\
4197 Also use the `xauth' program to verify that you have the proper\n\
4198 authorization information needed to connect the X server.\n\
4199 An insecure way to solve the problem may be to use `xhost'.\n",
4202 error ("Cannot connect to X server %s", SDATA (display
));
4207 XSETFASTINT (Vwindow_system_version
, 11);
4211 DEFUN ("x-close-connection", Fx_close_connection
,
4212 Sx_close_connection
, 1, 1, 0,
4213 doc
: /* Close the connection to DISPLAY's X server.
4214 For DISPLAY, specify either a frame or a display name (a string).
4215 If DISPLAY is nil, that stands for the selected frame's display. */)
4217 Lisp_Object display
;
4219 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
4222 if (dpyinfo
->reference_count
> 0)
4223 error ("Display still has frames on it");
4226 /* Free the fonts in the font table. */
4227 for (i
= 0; i
< dpyinfo
->n_fonts
; i
++)
4228 if (dpyinfo
->font_table
[i
].name
)
4230 XFreeFont (dpyinfo
->display
, dpyinfo
->font_table
[i
].font
);
4233 x_destroy_all_bitmaps (dpyinfo
);
4234 XSetCloseDownMode (dpyinfo
->display
, DestroyAll
);
4236 #ifdef USE_X_TOOLKIT
4237 XtCloseDisplay (dpyinfo
->display
);
4239 XCloseDisplay (dpyinfo
->display
);
4242 x_delete_display (dpyinfo
);
4248 DEFUN ("x-display-list", Fx_display_list
, Sx_display_list
, 0, 0, 0,
4249 doc
: /* Return the list of display names that Emacs has connections to. */)
4252 Lisp_Object tail
, result
;
4255 for (tail
= x_display_name_list
; ! NILP (tail
); tail
= XCDR (tail
))
4256 result
= Fcons (XCAR (XCAR (tail
)), result
);
4261 DEFUN ("x-synchronize", Fx_synchronize
, Sx_synchronize
, 1, 2, 0,
4262 doc
: /* If ON is non-nil, report X errors as soon as the erring request is made.
4263 If ON is nil, allow buffering of requests.
4264 Turning on synchronization prohibits the Xlib routines from buffering
4265 requests and seriously degrades performance, but makes debugging much
4267 The optional second argument DISPLAY specifies which display to act on.
4268 DISPLAY should be either a frame or a display name (a string).
4269 If DISPLAY is omitted or nil, that stands for the selected frame's display. */)
4271 Lisp_Object display
, on
;
4273 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
4275 XSynchronize (dpyinfo
->display
, !EQ (on
, Qnil
));
4280 /* Wait for responses to all X commands issued so far for frame F. */
4287 XSync (FRAME_X_DISPLAY (f
), False
);
4292 /***********************************************************************
4293 General X functions exposed to Elisp.
4294 ***********************************************************************/
4296 DEFUN ("x-send-client-message", Fx_send_client_event
,
4297 Sx_send_client_message
, 6, 6, 0,
4298 doc
: /* Send a client message of MESSAGE-TYPE to window DEST on DISPLAY.
4300 For DISPLAY, specify either a frame or a display name (a string).
4301 If DISPLAY is nil, that stands for the selected frame's display.
4302 DEST may be an integer, in which case it is a Window id. The value 0 may
4303 be used to send to the root window of the DISPLAY.
4304 If DEST is a frame the event is sent to the outer window of that frame.
4305 Nil means the currently selected frame.
4306 If DEST is the string "PointerWindow" the event is sent to the window that
4307 contains the pointer. If DEST is the string "InputFocus" the event is
4308 sent to the window that has the input focus.
4309 FROM is the frame sending the event. Use nil for currently selected frame.
4310 MESSAGE-TYPE is the name of an Atom as a string.
4311 FORMAT must be one of 8, 16 or 32 and determines the size of the values in
4312 bits. VALUES is a list of integer and/or strings containing the values to
4313 send. If a value is a string, it is converted to an Atom and the value of
4314 the Atom is sent. If more values than fits into the event is given,
4315 the excessive values are ignored. */)
4316 (display
, dest
, from
, message_type
, format
, values
)
4317 Lisp_Object display
, dest
, from
, message_type
, format
, values
;
4319 struct x_display_info
*dpyinfo
= check_x_display_info (display
);
4324 int max_nr_values
= (int) sizeof (event
.xclient
.data
.b
);
4325 struct frame
*f
= check_x_frame (from
);
4327 CHECK_STRING (message_type
);
4328 CHECK_NUMBER (format
);
4329 CHECK_CONS (values
);
4331 for (cons
= values
; CONSP (cons
); cons
= XCDR (cons
))
4333 Lisp_Object o
= XCAR (cons
);
4335 if (! INTEGERP (o
) && ! STRINGP (o
))
4336 error ("Bad data in VALUES, must be integer or string");
4339 event
.xclient
.type
= ClientMessage
;
4340 event
.xclient
.format
= XFASTINT (format
);
4342 if (event
.xclient
.format
!= 8 && event
.xclient
.format
!= 16
4343 && event
.xclient
.format
!= 32)
4344 error ("FORMAT must be one of 8, 16 or 32");
4345 if (event
.xclient
.format
== 16) max_nr_values
/= 2;
4346 if (event
.xclient
.format
== 32) max_nr_values
/= 4;
4348 if (FRAMEP (dest
) || NILP (dest
))
4350 struct frame
*fdest
= check_x_frame (dest
);
4351 wdest
= FRAME_OUTER_WINDOW (fdest
);
4353 else if (STRINGP (dest
))
4355 if (strcmp (SDATA (dest
), "PointerWindow") == 0)
4356 wdest
= PointerWindow
;
4357 else if (strcmp (SDATA (dest
), "InputFocus") == 0)
4360 error ("DEST as a string must be one of PointerWindow or InputFocus");
4364 CHECK_NUMBER (dest
);
4365 wdest
= (Window
) XFASTINT (dest
);
4366 if (wdest
== 0) wdest
= dpyinfo
->root_window
;
4370 for (cons
= values
, i
= 0;
4371 CONSP (cons
) && i
< max_nr_values
;
4372 cons
= XCDR (cons
), ++i
)
4374 Lisp_Object o
= XCAR (cons
);
4379 else if (STRINGP (o
))
4380 val
= XInternAtom (dpyinfo
->display
, SDATA (o
), False
);
4382 if (event
.xclient
.format
== 8)
4383 event
.xclient
.data
.b
[i
] = (char) val
;
4384 else if (event
.xclient
.format
== 16)
4385 event
.xclient
.data
.s
[i
] = (short) val
;
4387 event
.xclient
.data
.l
[i
] = val
;
4390 for ( ; i
< max_nr_values
; ++i
)
4391 if (event
.xclient
.format
== 8)
4392 event
.xclient
.data
.b
[i
] = 0;
4393 else if (event
.xclient
.format
== 16)
4394 event
.xclient
.data
.s
[i
] = 0;
4396 event
.xclient
.data
.l
[i
] = 0;
4398 event
.xclient
.message_type
4399 = XInternAtom (dpyinfo
->display
, SDATA (message_type
), False
);
4400 event
.xclient
.display
= dpyinfo
->display
;
4401 event
.xclient
.window
= FRAME_OUTER_WINDOW (f
);
4403 XSendEvent (dpyinfo
->display
, wdest
, False
, 0xffff, &event
);
4405 XFlush (dpyinfo
->display
);
4411 /***********************************************************************
4413 ***********************************************************************/
4415 /* Value is the number of elements of vector VECTOR. */
4417 #define DIM(VECTOR) (sizeof (VECTOR) / sizeof *(VECTOR))
4419 /* List of supported image types. Use define_image_type to add new
4420 types. Use lookup_image_type to find a type for a given symbol. */
4422 static struct image_type
*image_types
;
4424 /* The symbol `xbm' which is used as the type symbol for XBM images. */
4430 extern Lisp_Object QCwidth
, QCheight
, QCforeground
, QCbackground
, QCfile
;
4431 extern Lisp_Object QCdata
, QCtype
;
4432 Lisp_Object QCascent
, QCmargin
, QCrelief
;
4433 Lisp_Object QCconversion
, QCcolor_symbols
, QCheuristic_mask
;
4434 Lisp_Object QCindex
, QCmatrix
, QCcolor_adjustment
, QCmask
;
4436 /* Other symbols. */
4438 Lisp_Object Qlaplace
, Qemboss
, Qedge_detection
, Qheuristic
;
4440 /* Time in seconds after which images should be removed from the cache
4441 if not displayed. */
4443 Lisp_Object Vimage_cache_eviction_delay
;
4445 /* Function prototypes. */
4447 static void define_image_type
P_ ((struct image_type
*type
));
4448 static struct image_type
*lookup_image_type
P_ ((Lisp_Object symbol
));
4449 static void image_error
P_ ((char *format
, Lisp_Object
, Lisp_Object
));
4450 static void x_laplace
P_ ((struct frame
*, struct image
*));
4451 static void x_emboss
P_ ((struct frame
*, struct image
*));
4452 static int x_build_heuristic_mask
P_ ((struct frame
*, struct image
*,
4456 /* Define a new image type from TYPE. This adds a copy of TYPE to
4457 image_types and adds the symbol *TYPE->type to Vimage_types. */
4460 define_image_type (type
)
4461 struct image_type
*type
;
4463 /* Make a copy of TYPE to avoid a bus error in a dumped Emacs.
4464 The initialized data segment is read-only. */
4465 struct image_type
*p
= (struct image_type
*) xmalloc (sizeof *p
);
4466 bcopy (type
, p
, sizeof *p
);
4467 p
->next
= image_types
;
4469 Vimage_types
= Fcons (*p
->type
, Vimage_types
);
4473 /* Look up image type SYMBOL, and return a pointer to its image_type
4474 structure. Value is null if SYMBOL is not a known image type. */
4476 static INLINE
struct image_type
*
4477 lookup_image_type (symbol
)
4480 struct image_type
*type
;
4482 for (type
= image_types
; type
; type
= type
->next
)
4483 if (EQ (symbol
, *type
->type
))
4490 /* Value is non-zero if OBJECT is a valid Lisp image specification. A
4491 valid image specification is a list whose car is the symbol
4492 `image', and whose rest is a property list. The property list must
4493 contain a value for key `:type'. That value must be the name of a
4494 supported image type. The rest of the property list depends on the
4498 valid_image_p (object
)
4503 if (IMAGEP (object
))
4507 for (tem
= XCDR (object
); CONSP (tem
); tem
= XCDR (tem
))
4508 if (EQ (XCAR (tem
), QCtype
))
4511 if (CONSP (tem
) && SYMBOLP (XCAR (tem
)))
4513 struct image_type
*type
;
4514 type
= lookup_image_type (XCAR (tem
));
4516 valid_p
= type
->valid_p (object
);
4527 /* Log error message with format string FORMAT and argument ARG.
4528 Signaling an error, e.g. when an image cannot be loaded, is not a
4529 good idea because this would interrupt redisplay, and the error
4530 message display would lead to another redisplay. This function
4531 therefore simply displays a message. */
4534 image_error (format
, arg1
, arg2
)
4536 Lisp_Object arg1
, arg2
;
4538 add_to_log (format
, arg1
, arg2
);
4543 /***********************************************************************
4544 Image specifications
4545 ***********************************************************************/
4547 enum image_value_type
4549 IMAGE_DONT_CHECK_VALUE_TYPE
,
4551 IMAGE_STRING_OR_NIL_VALUE
,
4553 IMAGE_POSITIVE_INTEGER_VALUE
,
4554 IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
,
4555 IMAGE_NON_NEGATIVE_INTEGER_VALUE
,
4557 IMAGE_INTEGER_VALUE
,
4558 IMAGE_FUNCTION_VALUE
,
4563 /* Structure used when parsing image specifications. */
4565 struct image_keyword
4567 /* Name of keyword. */
4570 /* The type of value allowed. */
4571 enum image_value_type type
;
4573 /* Non-zero means key must be present. */
4576 /* Used to recognize duplicate keywords in a property list. */
4579 /* The value that was found. */
4584 static int parse_image_spec
P_ ((Lisp_Object
, struct image_keyword
*,
4586 static Lisp_Object image_spec_value
P_ ((Lisp_Object
, Lisp_Object
, int *));
4589 /* Parse image spec SPEC according to KEYWORDS. A valid image spec
4590 has the format (image KEYWORD VALUE ...). One of the keyword/
4591 value pairs must be `:type TYPE'. KEYWORDS is a vector of
4592 image_keywords structures of size NKEYWORDS describing other
4593 allowed keyword/value pairs. Value is non-zero if SPEC is valid. */
4596 parse_image_spec (spec
, keywords
, nkeywords
, type
)
4598 struct image_keyword
*keywords
;
4608 plist
= XCDR (spec
);
4609 while (CONSP (plist
))
4611 Lisp_Object key
, value
;
4613 /* First element of a pair must be a symbol. */
4615 plist
= XCDR (plist
);
4619 /* There must follow a value. */
4622 value
= XCAR (plist
);
4623 plist
= XCDR (plist
);
4625 /* Find key in KEYWORDS. Error if not found. */
4626 for (i
= 0; i
< nkeywords
; ++i
)
4627 if (strcmp (keywords
[i
].name
, SDATA (SYMBOL_NAME (key
))) == 0)
4633 /* Record that we recognized the keyword. If a keywords
4634 was found more than once, it's an error. */
4635 keywords
[i
].value
= value
;
4636 ++keywords
[i
].count
;
4638 if (keywords
[i
].count
> 1)
4641 /* Check type of value against allowed type. */
4642 switch (keywords
[i
].type
)
4644 case IMAGE_STRING_VALUE
:
4645 if (!STRINGP (value
))
4649 case IMAGE_STRING_OR_NIL_VALUE
:
4650 if (!STRINGP (value
) && !NILP (value
))
4654 case IMAGE_SYMBOL_VALUE
:
4655 if (!SYMBOLP (value
))
4659 case IMAGE_POSITIVE_INTEGER_VALUE
:
4660 if (!INTEGERP (value
) || XINT (value
) <= 0)
4664 case IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
:
4665 if (INTEGERP (value
) && XINT (value
) >= 0)
4668 && INTEGERP (XCAR (value
)) && INTEGERP (XCDR (value
))
4669 && XINT (XCAR (value
)) >= 0 && XINT (XCDR (value
)) >= 0)
4673 case IMAGE_ASCENT_VALUE
:
4674 if (SYMBOLP (value
) && EQ (value
, Qcenter
))
4676 else if (INTEGERP (value
)
4677 && XINT (value
) >= 0
4678 && XINT (value
) <= 100)
4682 case IMAGE_NON_NEGATIVE_INTEGER_VALUE
:
4683 if (!INTEGERP (value
) || XINT (value
) < 0)
4687 case IMAGE_DONT_CHECK_VALUE_TYPE
:
4690 case IMAGE_FUNCTION_VALUE
:
4691 value
= indirect_function (value
);
4693 || COMPILEDP (value
)
4694 || (CONSP (value
) && EQ (XCAR (value
), Qlambda
)))
4698 case IMAGE_NUMBER_VALUE
:
4699 if (!INTEGERP (value
) && !FLOATP (value
))
4703 case IMAGE_INTEGER_VALUE
:
4704 if (!INTEGERP (value
))
4708 case IMAGE_BOOL_VALUE
:
4709 if (!NILP (value
) && !EQ (value
, Qt
))
4718 if (EQ (key
, QCtype
) && !EQ (type
, value
))
4722 /* Check that all mandatory fields are present. */
4723 for (i
= 0; i
< nkeywords
; ++i
)
4724 if (keywords
[i
].mandatory_p
&& keywords
[i
].count
== 0)
4727 return NILP (plist
);
4731 /* Return the value of KEY in image specification SPEC. Value is nil
4732 if KEY is not present in SPEC. if FOUND is not null, set *FOUND
4733 to 1 if KEY was found in SPEC, set it to 0 otherwise. */
4736 image_spec_value (spec
, key
, found
)
4737 Lisp_Object spec
, key
;
4742 xassert (valid_image_p (spec
));
4744 for (tail
= XCDR (spec
);
4745 CONSP (tail
) && CONSP (XCDR (tail
));
4746 tail
= XCDR (XCDR (tail
)))
4748 if (EQ (XCAR (tail
), key
))
4752 return XCAR (XCDR (tail
));
4762 DEFUN ("image-size", Fimage_size
, Simage_size
, 1, 3, 0,
4763 doc
: /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
4764 PIXELS non-nil means return the size in pixels, otherwise return the
4765 size in canonical character units.
4766 FRAME is the frame on which the image will be displayed. FRAME nil
4767 or omitted means use the selected frame. */)
4768 (spec
, pixels
, frame
)
4769 Lisp_Object spec
, pixels
, frame
;
4774 if (valid_image_p (spec
))
4776 struct frame
*f
= check_x_frame (frame
);
4777 int id
= lookup_image (f
, spec
);
4778 struct image
*img
= IMAGE_FROM_ID (f
, id
);
4779 int width
= img
->width
+ 2 * img
->hmargin
;
4780 int height
= img
->height
+ 2 * img
->vmargin
;
4783 size
= Fcons (make_float ((double) width
/ FRAME_COLUMN_WIDTH (f
)),
4784 make_float ((double) height
/ FRAME_LINE_HEIGHT (f
)));
4786 size
= Fcons (make_number (width
), make_number (height
));
4789 error ("Invalid image specification");
4795 DEFUN ("image-mask-p", Fimage_mask_p
, Simage_mask_p
, 1, 2, 0,
4796 doc
: /* Return t if image SPEC has a mask bitmap.
4797 FRAME is the frame on which the image will be displayed. FRAME nil
4798 or omitted means use the selected frame. */)
4800 Lisp_Object spec
, frame
;
4805 if (valid_image_p (spec
))
4807 struct frame
*f
= check_x_frame (frame
);
4808 int id
= lookup_image (f
, spec
);
4809 struct image
*img
= IMAGE_FROM_ID (f
, id
);
4814 error ("Invalid image specification");
4821 /***********************************************************************
4822 Image type independent image structures
4823 ***********************************************************************/
4825 static struct image
*make_image
P_ ((Lisp_Object spec
, unsigned hash
));
4826 static void free_image
P_ ((struct frame
*f
, struct image
*img
));
4829 /* Allocate and return a new image structure for image specification
4830 SPEC. SPEC has a hash value of HASH. */
4832 static struct image
*
4833 make_image (spec
, hash
)
4837 struct image
*img
= (struct image
*) xmalloc (sizeof *img
);
4839 xassert (valid_image_p (spec
));
4840 bzero (img
, sizeof *img
);
4841 img
->type
= lookup_image_type (image_spec_value (spec
, QCtype
, NULL
));
4842 xassert (img
->type
!= NULL
);
4844 img
->data
.lisp_val
= Qnil
;
4845 img
->ascent
= DEFAULT_IMAGE_ASCENT
;
4851 /* Free image IMG which was used on frame F, including its resources. */
4860 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
4862 /* Remove IMG from the hash table of its cache. */
4864 img
->prev
->next
= img
->next
;
4866 c
->buckets
[img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
] = img
->next
;
4869 img
->next
->prev
= img
->prev
;
4871 c
->images
[img
->id
] = NULL
;
4873 /* Free resources, then free IMG. */
4874 img
->type
->free (f
, img
);
4880 /* Prepare image IMG for display on frame F. Must be called before
4881 drawing an image. */
4884 prepare_image_for_display (f
, img
)
4890 /* We're about to display IMG, so set its timestamp to `now'. */
4892 img
->timestamp
= EMACS_SECS (t
);
4894 /* If IMG doesn't have a pixmap yet, load it now, using the image
4895 type dependent loader function. */
4896 if (img
->pixmap
== None
&& !img
->load_failed_p
)
4897 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
4901 /* Value is the number of pixels for the ascent of image IMG when
4902 drawn in face FACE. */
4905 image_ascent (img
, face
)
4909 int height
= img
->height
+ img
->vmargin
;
4912 if (img
->ascent
== CENTERED_IMAGE_ASCENT
)
4915 /* This expression is arranged so that if the image can't be
4916 exactly centered, it will be moved slightly up. This is
4917 because a typical font is `top-heavy' (due to the presence
4918 uppercase letters), so the image placement should err towards
4919 being top-heavy too. It also just generally looks better. */
4920 ascent
= (height
+ face
->font
->ascent
- face
->font
->descent
+ 1) / 2;
4922 ascent
= height
/ 2;
4925 ascent
= height
* img
->ascent
/ 100.0;
4931 /* Image background colors. */
4933 static unsigned long
4934 four_corners_best (ximg
, width
, height
)
4936 unsigned long width
, height
;
4938 unsigned long corners
[4], best
;
4941 /* Get the colors at the corners of ximg. */
4942 corners
[0] = XGetPixel (ximg
, 0, 0);
4943 corners
[1] = XGetPixel (ximg
, width
- 1, 0);
4944 corners
[2] = XGetPixel (ximg
, width
- 1, height
- 1);
4945 corners
[3] = XGetPixel (ximg
, 0, height
- 1);
4947 /* Choose the most frequently found color as background. */
4948 for (i
= best_count
= 0; i
< 4; ++i
)
4952 for (j
= n
= 0; j
< 4; ++j
)
4953 if (corners
[i
] == corners
[j
])
4957 best
= corners
[i
], best_count
= n
;
4963 /* Return the `background' field of IMG. If IMG doesn't have one yet,
4964 it is guessed heuristically. If non-zero, XIMG is an existing XImage
4965 object to use for the heuristic. */
4968 image_background (img
, f
, ximg
)
4973 if (! img
->background_valid
)
4974 /* IMG doesn't have a background yet, try to guess a reasonable value. */
4976 int free_ximg
= !ximg
;
4979 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
4980 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
4982 img
->background
= four_corners_best (ximg
, img
->width
, img
->height
);
4985 XDestroyImage (ximg
);
4987 img
->background_valid
= 1;
4990 return img
->background
;
4993 /* Return the `background_transparent' field of IMG. If IMG doesn't
4994 have one yet, it is guessed heuristically. If non-zero, MASK is an
4995 existing XImage object to use for the heuristic. */
4998 image_background_transparent (img
, f
, mask
)
5003 if (! img
->background_transparent_valid
)
5004 /* IMG doesn't have a background yet, try to guess a reasonable value. */
5008 int free_mask
= !mask
;
5011 mask
= XGetImage (FRAME_X_DISPLAY (f
), img
->mask
,
5012 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
5014 img
->background_transparent
5015 = !four_corners_best (mask
, img
->width
, img
->height
);
5018 XDestroyImage (mask
);
5021 img
->background_transparent
= 0;
5023 img
->background_transparent_valid
= 1;
5026 return img
->background_transparent
;
5030 /***********************************************************************
5031 Helper functions for X image types
5032 ***********************************************************************/
5034 static void x_clear_image_1
P_ ((struct frame
*, struct image
*, int,
5036 static void x_clear_image
P_ ((struct frame
*f
, struct image
*img
));
5037 static unsigned long x_alloc_image_color
P_ ((struct frame
*f
,
5039 Lisp_Object color_name
,
5040 unsigned long dflt
));
5043 /* Clear X resources of image IMG on frame F. PIXMAP_P non-zero means
5044 free the pixmap if any. MASK_P non-zero means clear the mask
5045 pixmap if any. COLORS_P non-zero means free colors allocated for
5046 the image, if any. */
5049 x_clear_image_1 (f
, img
, pixmap_p
, mask_p
, colors_p
)
5052 int pixmap_p
, mask_p
, colors_p
;
5054 if (pixmap_p
&& img
->pixmap
)
5056 XFreePixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
5058 img
->background_valid
= 0;
5061 if (mask_p
&& img
->mask
)
5063 XFreePixmap (FRAME_X_DISPLAY (f
), img
->mask
);
5065 img
->background_transparent_valid
= 0;
5068 if (colors_p
&& img
->ncolors
)
5070 x_free_colors (f
, img
->colors
, img
->ncolors
);
5071 xfree (img
->colors
);
5077 /* Free X resources of image IMG which is used on frame F. */
5080 x_clear_image (f
, img
)
5085 x_clear_image_1 (f
, img
, 1, 1, 1);
5090 /* Allocate color COLOR_NAME for image IMG on frame F. If color
5091 cannot be allocated, use DFLT. Add a newly allocated color to
5092 IMG->colors, so that it can be freed again. Value is the pixel
5095 static unsigned long
5096 x_alloc_image_color (f
, img
, color_name
, dflt
)
5099 Lisp_Object color_name
;
5103 unsigned long result
;
5105 xassert (STRINGP (color_name
));
5107 if (x_defined_color (f
, SDATA (color_name
), &color
, 1))
5109 /* This isn't called frequently so we get away with simply
5110 reallocating the color vector to the needed size, here. */
5113 (unsigned long *) xrealloc (img
->colors
,
5114 img
->ncolors
* sizeof *img
->colors
);
5115 img
->colors
[img
->ncolors
- 1] = color
.pixel
;
5116 result
= color
.pixel
;
5126 /***********************************************************************
5128 ***********************************************************************/
5130 static void cache_image
P_ ((struct frame
*f
, struct image
*img
));
5131 static void postprocess_image
P_ ((struct frame
*, struct image
*));
5134 /* Return a new, initialized image cache that is allocated from the
5135 heap. Call free_image_cache to free an image cache. */
5137 struct image_cache
*
5140 struct image_cache
*c
= (struct image_cache
*) xmalloc (sizeof *c
);
5143 bzero (c
, sizeof *c
);
5145 c
->images
= (struct image
**) xmalloc (c
->size
* sizeof *c
->images
);
5146 size
= IMAGE_CACHE_BUCKETS_SIZE
* sizeof *c
->buckets
;
5147 c
->buckets
= (struct image
**) xmalloc (size
);
5148 bzero (c
->buckets
, size
);
5153 /* Free image cache of frame F. Be aware that X frames share images
5157 free_image_cache (f
)
5160 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
5165 /* Cache should not be referenced by any frame when freed. */
5166 xassert (c
->refcount
== 0);
5168 for (i
= 0; i
< c
->used
; ++i
)
5169 free_image (f
, c
->images
[i
]);
5173 FRAME_X_IMAGE_CACHE (f
) = NULL
;
5178 /* Clear image cache of frame F. FORCE_P non-zero means free all
5179 images. FORCE_P zero means clear only images that haven't been
5180 displayed for some time. Should be called from time to time to
5181 reduce the number of loaded images. If image-eviction-seconds is
5182 non-nil, this frees images in the cache which weren't displayed for
5183 at least that many seconds. */
5186 clear_image_cache (f
, force_p
)
5190 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
5192 if (c
&& INTEGERP (Vimage_cache_eviction_delay
))
5199 old
= EMACS_SECS (t
) - XFASTINT (Vimage_cache_eviction_delay
);
5201 /* Block input so that we won't be interrupted by a SIGIO
5202 while being in an inconsistent state. */
5205 for (i
= nfreed
= 0; i
< c
->used
; ++i
)
5207 struct image
*img
= c
->images
[i
];
5209 && (force_p
|| img
->timestamp
< old
))
5211 free_image (f
, img
);
5216 /* We may be clearing the image cache because, for example,
5217 Emacs was iconified for a longer period of time. In that
5218 case, current matrices may still contain references to
5219 images freed above. So, clear these matrices. */
5222 Lisp_Object tail
, frame
;
5224 FOR_EACH_FRAME (tail
, frame
)
5226 struct frame
*f
= XFRAME (frame
);
5228 && FRAME_X_IMAGE_CACHE (f
) == c
)
5229 clear_current_matrices (f
);
5232 ++windows_or_buffers_changed
;
5240 DEFUN ("clear-image-cache", Fclear_image_cache
, Sclear_image_cache
,
5242 doc
: /* Clear the image cache of FRAME.
5243 FRAME nil or omitted means use the selected frame.
5244 FRAME t means clear the image caches of all frames. */)
5252 FOR_EACH_FRAME (tail
, frame
)
5253 if (FRAME_X_P (XFRAME (frame
)))
5254 clear_image_cache (XFRAME (frame
), 1);
5257 clear_image_cache (check_x_frame (frame
), 1);
5263 /* Compute masks and transform image IMG on frame F, as specified
5264 by the image's specification, */
5267 postprocess_image (f
, img
)
5271 /* Manipulation of the image's mask. */
5274 Lisp_Object conversion
, spec
;
5279 /* `:heuristic-mask t'
5281 means build a mask heuristically.
5282 `:heuristic-mask (R G B)'
5283 `:mask (heuristic (R G B))'
5284 means build a mask from color (R G B) in the
5287 means remove a mask, if any. */
5289 mask
= image_spec_value (spec
, QCheuristic_mask
, NULL
);
5291 x_build_heuristic_mask (f
, img
, mask
);
5296 mask
= image_spec_value (spec
, QCmask
, &found_p
);
5298 if (EQ (mask
, Qheuristic
))
5299 x_build_heuristic_mask (f
, img
, Qt
);
5300 else if (CONSP (mask
)
5301 && EQ (XCAR (mask
), Qheuristic
))
5303 if (CONSP (XCDR (mask
)))
5304 x_build_heuristic_mask (f
, img
, XCAR (XCDR (mask
)));
5306 x_build_heuristic_mask (f
, img
, XCDR (mask
));
5308 else if (NILP (mask
) && found_p
&& img
->mask
)
5310 XFreePixmap (FRAME_X_DISPLAY (f
), img
->mask
);
5316 /* Should we apply an image transformation algorithm? */
5317 conversion
= image_spec_value (spec
, QCconversion
, NULL
);
5318 if (EQ (conversion
, Qdisabled
))
5319 x_disable_image (f
, img
);
5320 else if (EQ (conversion
, Qlaplace
))
5322 else if (EQ (conversion
, Qemboss
))
5324 else if (CONSP (conversion
)
5325 && EQ (XCAR (conversion
), Qedge_detection
))
5328 tem
= XCDR (conversion
);
5330 x_edge_detection (f
, img
,
5331 Fplist_get (tem
, QCmatrix
),
5332 Fplist_get (tem
, QCcolor_adjustment
));
5338 /* Return the id of image with Lisp specification SPEC on frame F.
5339 SPEC must be a valid Lisp image specification (see valid_image_p). */
5342 lookup_image (f
, spec
)
5346 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
5350 struct gcpro gcpro1
;
5353 /* F must be a window-system frame, and SPEC must be a valid image
5355 xassert (FRAME_WINDOW_P (f
));
5356 xassert (valid_image_p (spec
));
5360 /* Look up SPEC in the hash table of the image cache. */
5361 hash
= sxhash (spec
, 0);
5362 i
= hash
% IMAGE_CACHE_BUCKETS_SIZE
;
5364 for (img
= c
->buckets
[i
]; img
; img
= img
->next
)
5365 if (img
->hash
== hash
&& !NILP (Fequal (img
->spec
, spec
)))
5368 /* If not found, create a new image and cache it. */
5371 extern Lisp_Object Qpostscript
;
5374 img
= make_image (spec
, hash
);
5375 cache_image (f
, img
);
5376 img
->load_failed_p
= img
->type
->load (f
, img
) == 0;
5378 /* If we can't load the image, and we don't have a width and
5379 height, use some arbitrary width and height so that we can
5380 draw a rectangle for it. */
5381 if (img
->load_failed_p
)
5385 value
= image_spec_value (spec
, QCwidth
, NULL
);
5386 img
->width
= (INTEGERP (value
)
5387 ? XFASTINT (value
) : DEFAULT_IMAGE_WIDTH
);
5388 value
= image_spec_value (spec
, QCheight
, NULL
);
5389 img
->height
= (INTEGERP (value
)
5390 ? XFASTINT (value
) : DEFAULT_IMAGE_HEIGHT
);
5394 /* Handle image type independent image attributes
5395 `:ascent ASCENT', `:margin MARGIN', `:relief RELIEF',
5396 `:background COLOR'. */
5397 Lisp_Object ascent
, margin
, relief
, bg
;
5399 ascent
= image_spec_value (spec
, QCascent
, NULL
);
5400 if (INTEGERP (ascent
))
5401 img
->ascent
= XFASTINT (ascent
);
5402 else if (EQ (ascent
, Qcenter
))
5403 img
->ascent
= CENTERED_IMAGE_ASCENT
;
5405 margin
= image_spec_value (spec
, QCmargin
, NULL
);
5406 if (INTEGERP (margin
) && XINT (margin
) >= 0)
5407 img
->vmargin
= img
->hmargin
= XFASTINT (margin
);
5408 else if (CONSP (margin
) && INTEGERP (XCAR (margin
))
5409 && INTEGERP (XCDR (margin
)))
5411 if (XINT (XCAR (margin
)) > 0)
5412 img
->hmargin
= XFASTINT (XCAR (margin
));
5413 if (XINT (XCDR (margin
)) > 0)
5414 img
->vmargin
= XFASTINT (XCDR (margin
));
5417 relief
= image_spec_value (spec
, QCrelief
, NULL
);
5418 if (INTEGERP (relief
))
5420 img
->relief
= XINT (relief
);
5421 img
->hmargin
+= abs (img
->relief
);
5422 img
->vmargin
+= abs (img
->relief
);
5425 if (! img
->background_valid
)
5427 bg
= image_spec_value (img
->spec
, QCbackground
, NULL
);
5431 = x_alloc_image_color (f
, img
, bg
,
5432 FRAME_BACKGROUND_PIXEL (f
));
5433 img
->background_valid
= 1;
5437 /* Do image transformations and compute masks, unless we
5438 don't have the image yet. */
5439 if (!EQ (*img
->type
->type
, Qpostscript
))
5440 postprocess_image (f
, img
);
5444 xassert (!interrupt_input_blocked
);
5447 /* We're using IMG, so set its timestamp to `now'. */
5448 EMACS_GET_TIME (now
);
5449 img
->timestamp
= EMACS_SECS (now
);
5453 /* Value is the image id. */
5458 /* Cache image IMG in the image cache of frame F. */
5461 cache_image (f
, img
)
5465 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
5468 /* Find a free slot in c->images. */
5469 for (i
= 0; i
< c
->used
; ++i
)
5470 if (c
->images
[i
] == NULL
)
5473 /* If no free slot found, maybe enlarge c->images. */
5474 if (i
== c
->used
&& c
->used
== c
->size
)
5477 c
->images
= (struct image
**) xrealloc (c
->images
,
5478 c
->size
* sizeof *c
->images
);
5481 /* Add IMG to c->images, and assign IMG an id. */
5487 /* Add IMG to the cache's hash table. */
5488 i
= img
->hash
% IMAGE_CACHE_BUCKETS_SIZE
;
5489 img
->next
= c
->buckets
[i
];
5491 img
->next
->prev
= img
;
5493 c
->buckets
[i
] = img
;
5497 /* Call FN on every image in the image cache of frame F. Used to mark
5498 Lisp Objects in the image cache. */
5501 forall_images_in_image_cache (f
, fn
)
5503 void (*fn
) P_ ((struct image
*img
));
5505 if (FRAME_LIVE_P (f
) && FRAME_X_P (f
))
5507 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
5511 for (i
= 0; i
< c
->used
; ++i
)
5520 /***********************************************************************
5522 ***********************************************************************/
5524 static int x_create_x_image_and_pixmap
P_ ((struct frame
*, int, int, int,
5525 XImage
**, Pixmap
*));
5526 static void x_destroy_x_image
P_ ((XImage
*));
5527 static void x_put_x_image
P_ ((struct frame
*, XImage
*, Pixmap
, int, int));
5530 /* Create an XImage and a pixmap of size WIDTH x HEIGHT for use on
5531 frame F. Set *XIMG and *PIXMAP to the XImage and Pixmap created.
5532 Set (*XIMG)->data to a raster of WIDTH x HEIGHT pixels allocated
5533 via xmalloc. Print error messages via image_error if an error
5534 occurs. Value is non-zero if successful. */
5537 x_create_x_image_and_pixmap (f
, width
, height
, depth
, ximg
, pixmap
)
5539 int width
, height
, depth
;
5543 Display
*display
= FRAME_X_DISPLAY (f
);
5544 Screen
*screen
= FRAME_X_SCREEN (f
);
5545 Window window
= FRAME_X_WINDOW (f
);
5547 xassert (interrupt_input_blocked
);
5550 depth
= DefaultDepthOfScreen (screen
);
5551 *ximg
= XCreateImage (display
, DefaultVisualOfScreen (screen
),
5552 depth
, ZPixmap
, 0, NULL
, width
, height
,
5553 depth
> 16 ? 32 : depth
> 8 ? 16 : 8, 0);
5556 image_error ("Unable to allocate X image", Qnil
, Qnil
);
5560 /* Allocate image raster. */
5561 (*ximg
)->data
= (char *) xmalloc ((*ximg
)->bytes_per_line
* height
);
5563 /* Allocate a pixmap of the same size. */
5564 *pixmap
= XCreatePixmap (display
, window
, width
, height
, depth
);
5565 if (*pixmap
== None
)
5567 x_destroy_x_image (*ximg
);
5569 image_error ("Unable to create X pixmap", Qnil
, Qnil
);
5577 /* Destroy XImage XIMG. Free XIMG->data. */
5580 x_destroy_x_image (ximg
)
5583 xassert (interrupt_input_blocked
);
5588 XDestroyImage (ximg
);
5593 /* Put XImage XIMG into pixmap PIXMAP on frame F. WIDTH and HEIGHT
5594 are width and height of both the image and pixmap. */
5597 x_put_x_image (f
, ximg
, pixmap
, width
, height
)
5605 xassert (interrupt_input_blocked
);
5606 gc
= XCreateGC (FRAME_X_DISPLAY (f
), pixmap
, 0, NULL
);
5607 XPutImage (FRAME_X_DISPLAY (f
), pixmap
, gc
, ximg
, 0, 0, 0, 0, width
, height
);
5608 XFreeGC (FRAME_X_DISPLAY (f
), gc
);
5613 /***********************************************************************
5615 ***********************************************************************/
5617 static Lisp_Object x_find_image_file
P_ ((Lisp_Object
));
5618 static char *slurp_file
P_ ((char *, int *));
5621 /* Find image file FILE. Look in data-directory, then
5622 x-bitmap-file-path. Value is the full name of the file found, or
5623 nil if not found. */
5626 x_find_image_file (file
)
5629 Lisp_Object file_found
, search_path
;
5630 struct gcpro gcpro1
, gcpro2
;
5634 search_path
= Fcons (Vdata_directory
, Vx_bitmap_file_path
);
5635 GCPRO2 (file_found
, search_path
);
5637 /* Try to find FILE in data-directory, then x-bitmap-file-path. */
5638 fd
= openp (search_path
, file
, Qnil
, &file_found
, Qnil
);
5650 /* Read FILE into memory. Value is a pointer to a buffer allocated
5651 with xmalloc holding FILE's contents. Value is null if an error
5652 occurred. *SIZE is set to the size of the file. */
5655 slurp_file (file
, size
)
5663 if (stat (file
, &st
) == 0
5664 && (fp
= fopen (file
, "r")) != NULL
5665 && (buf
= (char *) xmalloc (st
.st_size
),
5666 fread (buf
, 1, st
.st_size
, fp
) == st
.st_size
))
5687 /***********************************************************************
5689 ***********************************************************************/
5691 static int xbm_scan
P_ ((char **, char *, char *, int *));
5692 static int xbm_load
P_ ((struct frame
*f
, struct image
*img
));
5693 static int xbm_load_image
P_ ((struct frame
*f
, struct image
*img
,
5695 static int xbm_image_p
P_ ((Lisp_Object object
));
5696 static int xbm_read_bitmap_data
P_ ((char *, char *, int *, int *,
5698 static int xbm_file_p
P_ ((Lisp_Object
));
5701 /* Indices of image specification fields in xbm_format, below. */
5703 enum xbm_keyword_index
5721 /* Vector of image_keyword structures describing the format
5722 of valid XBM image specifications. */
5724 static struct image_keyword xbm_format
[XBM_LAST
] =
5726 {":type", IMAGE_SYMBOL_VALUE
, 1},
5727 {":file", IMAGE_STRING_VALUE
, 0},
5728 {":width", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
5729 {":height", IMAGE_POSITIVE_INTEGER_VALUE
, 0},
5730 {":data", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5731 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
5732 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0},
5733 {":ascent", IMAGE_ASCENT_VALUE
, 0},
5734 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
5735 {":relief", IMAGE_INTEGER_VALUE
, 0},
5736 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5737 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
5738 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0}
5741 /* Structure describing the image type XBM. */
5743 static struct image_type xbm_type
=
5752 /* Tokens returned from xbm_scan. */
5761 /* Return non-zero if OBJECT is a valid XBM-type image specification.
5762 A valid specification is a list starting with the symbol `image'
5763 The rest of the list is a property list which must contain an
5766 If the specification specifies a file to load, it must contain
5767 an entry `:file FILENAME' where FILENAME is a string.
5769 If the specification is for a bitmap loaded from memory it must
5770 contain `:width WIDTH', `:height HEIGHT', and `:data DATA', where
5771 WIDTH and HEIGHT are integers > 0. DATA may be:
5773 1. a string large enough to hold the bitmap data, i.e. it must
5774 have a size >= (WIDTH + 7) / 8 * HEIGHT
5776 2. a bool-vector of size >= WIDTH * HEIGHT
5778 3. a vector of strings or bool-vectors, one for each line of the
5781 4. A string containing an in-memory XBM file. WIDTH and HEIGHT
5782 may not be specified in this case because they are defined in the
5785 Both the file and data forms may contain the additional entries
5786 `:background COLOR' and `:foreground COLOR'. If not present,
5787 foreground and background of the frame on which the image is
5788 displayed is used. */
5791 xbm_image_p (object
)
5794 struct image_keyword kw
[XBM_LAST
];
5796 bcopy (xbm_format
, kw
, sizeof kw
);
5797 if (!parse_image_spec (object
, kw
, XBM_LAST
, Qxbm
))
5800 xassert (EQ (kw
[XBM_TYPE
].value
, Qxbm
));
5802 if (kw
[XBM_FILE
].count
)
5804 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_DATA
].count
)
5807 else if (kw
[XBM_DATA
].count
&& xbm_file_p (kw
[XBM_DATA
].value
))
5809 /* In-memory XBM file. */
5810 if (kw
[XBM_WIDTH
].count
|| kw
[XBM_HEIGHT
].count
|| kw
[XBM_FILE
].count
)
5818 /* Entries for `:width', `:height' and `:data' must be present. */
5819 if (!kw
[XBM_WIDTH
].count
5820 || !kw
[XBM_HEIGHT
].count
5821 || !kw
[XBM_DATA
].count
)
5824 data
= kw
[XBM_DATA
].value
;
5825 width
= XFASTINT (kw
[XBM_WIDTH
].value
);
5826 height
= XFASTINT (kw
[XBM_HEIGHT
].value
);
5828 /* Check type of data, and width and height against contents of
5834 /* Number of elements of the vector must be >= height. */
5835 if (XVECTOR (data
)->size
< height
)
5838 /* Each string or bool-vector in data must be large enough
5839 for one line of the image. */
5840 for (i
= 0; i
< height
; ++i
)
5842 Lisp_Object elt
= XVECTOR (data
)->contents
[i
];
5847 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
)
5850 else if (BOOL_VECTOR_P (elt
))
5852 if (XBOOL_VECTOR (elt
)->size
< width
)
5859 else if (STRINGP (data
))
5862 < (width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
* height
)
5865 else if (BOOL_VECTOR_P (data
))
5867 if (XBOOL_VECTOR (data
)->size
< width
* height
)
5878 /* Scan a bitmap file. FP is the stream to read from. Value is
5879 either an enumerator from enum xbm_token, or a character for a
5880 single-character token, or 0 at end of file. If scanning an
5881 identifier, store the lexeme of the identifier in SVAL. If
5882 scanning a number, store its value in *IVAL. */
5885 xbm_scan (s
, end
, sval
, ival
)
5894 /* Skip white space. */
5895 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
5900 else if (isdigit (c
))
5902 int value
= 0, digit
;
5904 if (c
== '0' && *s
< end
)
5907 if (c
== 'x' || c
== 'X')
5914 else if (c
>= 'a' && c
<= 'f')
5915 digit
= c
- 'a' + 10;
5916 else if (c
>= 'A' && c
<= 'F')
5917 digit
= c
- 'A' + 10;
5920 value
= 16 * value
+ digit
;
5923 else if (isdigit (c
))
5927 && (c
= *(*s
)++, isdigit (c
)))
5928 value
= 8 * value
+ c
- '0';
5935 && (c
= *(*s
)++, isdigit (c
)))
5936 value
= 10 * value
+ c
- '0';
5944 else if (isalpha (c
) || c
== '_')
5948 && (c
= *(*s
)++, (isalnum (c
) || c
== '_')))
5955 else if (c
== '/' && **s
== '*')
5957 /* C-style comment. */
5959 while (**s
&& (**s
!= '*' || *(*s
+ 1) != '/'))
5972 /* Replacement for XReadBitmapFileData which isn't available under old
5973 X versions. CONTENTS is a pointer to a buffer to parse; END is the
5974 buffer's end. Set *WIDTH and *HEIGHT to the width and height of
5975 the image. Return in *DATA the bitmap data allocated with xmalloc.
5976 Value is non-zero if successful. DATA null means just test if
5977 CONTENTS looks like an in-memory XBM file. */
5980 xbm_read_bitmap_data (contents
, end
, width
, height
, data
)
5981 char *contents
, *end
;
5982 int *width
, *height
;
5983 unsigned char **data
;
5986 char buffer
[BUFSIZ
];
5989 int bytes_per_line
, i
, nbytes
;
5995 LA1 = xbm_scan (&s, end, buffer, &value)
5997 #define expect(TOKEN) \
5998 if (LA1 != (TOKEN)) \
6003 #define expect_ident(IDENT) \
6004 if (LA1 == XBM_TK_IDENT && strcmp (buffer, (IDENT)) == 0) \
6009 *width
= *height
= -1;
6012 LA1
= xbm_scan (&s
, end
, buffer
, &value
);
6014 /* Parse defines for width, height and hot-spots. */
6018 expect_ident ("define");
6019 expect (XBM_TK_IDENT
);
6021 if (LA1
== XBM_TK_NUMBER
);
6023 char *p
= strrchr (buffer
, '_');
6024 p
= p
? p
+ 1 : buffer
;
6025 if (strcmp (p
, "width") == 0)
6027 else if (strcmp (p
, "height") == 0)
6030 expect (XBM_TK_NUMBER
);
6033 if (*width
< 0 || *height
< 0)
6035 else if (data
== NULL
)
6038 /* Parse bits. Must start with `static'. */
6039 expect_ident ("static");
6040 if (LA1
== XBM_TK_IDENT
)
6042 if (strcmp (buffer
, "unsigned") == 0)
6045 expect_ident ("char");
6047 else if (strcmp (buffer
, "short") == 0)
6051 if (*width
% 16 && *width
% 16 < 9)
6054 else if (strcmp (buffer
, "char") == 0)
6062 expect (XBM_TK_IDENT
);
6068 bytes_per_line
= (*width
+ 7) / 8 + padding_p
;
6069 nbytes
= bytes_per_line
* *height
;
6070 p
= *data
= (char *) xmalloc (nbytes
);
6074 for (i
= 0; i
< nbytes
; i
+= 2)
6077 expect (XBM_TK_NUMBER
);
6080 if (!padding_p
|| ((i
+ 2) % bytes_per_line
))
6083 if (LA1
== ',' || LA1
== '}')
6091 for (i
= 0; i
< nbytes
; ++i
)
6094 expect (XBM_TK_NUMBER
);
6098 if (LA1
== ',' || LA1
== '}')
6123 /* Load XBM image IMG which will be displayed on frame F from buffer
6124 CONTENTS. END is the end of the buffer. Value is non-zero if
6128 xbm_load_image (f
, img
, contents
, end
)
6131 char *contents
, *end
;
6134 unsigned char *data
;
6137 rc
= xbm_read_bitmap_data (contents
, end
, &img
->width
, &img
->height
, &data
);
6140 int depth
= DefaultDepthOfScreen (FRAME_X_SCREEN (f
));
6141 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
6142 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
6145 xassert (img
->width
> 0 && img
->height
> 0);
6147 /* Get foreground and background colors, maybe allocate colors. */
6148 value
= image_spec_value (img
->spec
, QCforeground
, NULL
);
6150 foreground
= x_alloc_image_color (f
, img
, value
, foreground
);
6151 value
= image_spec_value (img
->spec
, QCbackground
, NULL
);
6154 background
= x_alloc_image_color (f
, img
, value
, background
);
6155 img
->background
= background
;
6156 img
->background_valid
= 1;
6160 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
6163 img
->width
, img
->height
,
6164 foreground
, background
,
6168 if (img
->pixmap
== None
)
6170 x_clear_image (f
, img
);
6171 image_error ("Unable to create X pixmap for `%s'", img
->spec
, Qnil
);
6177 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
6183 /* Value is non-zero if DATA looks like an in-memory XBM file. */
6190 return (STRINGP (data
)
6191 && xbm_read_bitmap_data (SDATA (data
),
6198 /* Fill image IMG which is used on frame F with pixmap data. Value is
6199 non-zero if successful. */
6207 Lisp_Object file_name
;
6209 xassert (xbm_image_p (img
->spec
));
6211 /* If IMG->spec specifies a file name, create a non-file spec from it. */
6212 file_name
= image_spec_value (img
->spec
, QCfile
, NULL
);
6213 if (STRINGP (file_name
))
6218 struct gcpro gcpro1
;
6220 file
= x_find_image_file (file_name
);
6222 if (!STRINGP (file
))
6224 image_error ("Cannot find image file `%s'", file_name
, Qnil
);
6229 contents
= slurp_file (SDATA (file
), &size
);
6230 if (contents
== NULL
)
6232 image_error ("Error loading XBM image `%s'", img
->spec
, Qnil
);
6237 success_p
= xbm_load_image (f
, img
, contents
, contents
+ size
);
6242 struct image_keyword fmt
[XBM_LAST
];
6245 unsigned long foreground
= FRAME_FOREGROUND_PIXEL (f
);
6246 unsigned long background
= FRAME_BACKGROUND_PIXEL (f
);
6249 int in_memory_file_p
= 0;
6251 /* See if data looks like an in-memory XBM file. */
6252 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
6253 in_memory_file_p
= xbm_file_p (data
);
6255 /* Parse the image specification. */
6256 bcopy (xbm_format
, fmt
, sizeof fmt
);
6257 parsed_p
= parse_image_spec (img
->spec
, fmt
, XBM_LAST
, Qxbm
);
6260 /* Get specified width, and height. */
6261 if (!in_memory_file_p
)
6263 img
->width
= XFASTINT (fmt
[XBM_WIDTH
].value
);
6264 img
->height
= XFASTINT (fmt
[XBM_HEIGHT
].value
);
6265 xassert (img
->width
> 0 && img
->height
> 0);
6268 /* Get foreground and background colors, maybe allocate colors. */
6269 if (fmt
[XBM_FOREGROUND
].count
6270 && STRINGP (fmt
[XBM_FOREGROUND
].value
))
6271 foreground
= x_alloc_image_color (f
, img
, fmt
[XBM_FOREGROUND
].value
,
6273 if (fmt
[XBM_BACKGROUND
].count
6274 && STRINGP (fmt
[XBM_BACKGROUND
].value
))
6275 background
= x_alloc_image_color (f
, img
, fmt
[XBM_BACKGROUND
].value
,
6278 if (in_memory_file_p
)
6279 success_p
= xbm_load_image (f
, img
, SDATA (data
),
6288 int nbytes
= (img
->width
+ BITS_PER_CHAR
- 1) / BITS_PER_CHAR
;
6290 p
= bits
= (char *) alloca (nbytes
* img
->height
);
6291 for (i
= 0; i
< img
->height
; ++i
, p
+= nbytes
)
6293 Lisp_Object line
= XVECTOR (data
)->contents
[i
];
6295 bcopy (SDATA (line
), p
, nbytes
);
6297 bcopy (XBOOL_VECTOR (line
)->data
, p
, nbytes
);
6300 else if (STRINGP (data
))
6301 bits
= SDATA (data
);
6303 bits
= XBOOL_VECTOR (data
)->data
;
6305 /* Create the pixmap. */
6306 depth
= DefaultDepthOfScreen (FRAME_X_SCREEN (f
));
6308 = XCreatePixmapFromBitmapData (FRAME_X_DISPLAY (f
),
6311 img
->width
, img
->height
,
6312 foreground
, background
,
6318 image_error ("Unable to create pixmap for XBM image `%s'",
6320 x_clear_image (f
, img
);
6330 /***********************************************************************
6332 ***********************************************************************/
6336 static int xpm_image_p
P_ ((Lisp_Object object
));
6337 static int xpm_load
P_ ((struct frame
*f
, struct image
*img
));
6338 static int xpm_valid_color_symbols_p
P_ ((Lisp_Object
));
6340 #include "X11/xpm.h"
6342 /* The symbol `xpm' identifying XPM-format images. */
6346 /* Indices of image specification fields in xpm_format, below. */
6348 enum xpm_keyword_index
6364 /* Vector of image_keyword structures describing the format
6365 of valid XPM image specifications. */
6367 static struct image_keyword xpm_format
[XPM_LAST
] =
6369 {":type", IMAGE_SYMBOL_VALUE
, 1},
6370 {":file", IMAGE_STRING_VALUE
, 0},
6371 {":data", IMAGE_STRING_VALUE
, 0},
6372 {":ascent", IMAGE_ASCENT_VALUE
, 0},
6373 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
6374 {":relief", IMAGE_INTEGER_VALUE
, 0},
6375 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6376 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6377 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6378 {":color-symbols", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
6379 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
6382 /* Structure describing the image type XBM. */
6384 static struct image_type xpm_type
=
6394 /* Define ALLOC_XPM_COLORS if we can use Emacs' own color allocation
6395 functions for allocating image colors. Our own functions handle
6396 color allocation failures more gracefully than the ones on the XPM
6399 #if defined XpmAllocColor && defined XpmFreeColors && defined XpmColorClosure
6400 #define ALLOC_XPM_COLORS
6403 #ifdef ALLOC_XPM_COLORS
6405 static void xpm_init_color_cache
P_ ((struct frame
*, XpmAttributes
*));
6406 static void xpm_free_color_cache
P_ ((void));
6407 static int xpm_lookup_color
P_ ((struct frame
*, char *, XColor
*));
6408 static int xpm_color_bucket
P_ ((char *));
6409 static struct xpm_cached_color
*xpm_cache_color
P_ ((struct frame
*, char *,
6412 /* An entry in a hash table used to cache color definitions of named
6413 colors. This cache is necessary to speed up XPM image loading in
6414 case we do color allocations ourselves. Without it, we would need
6415 a call to XParseColor per pixel in the image. */
6417 struct xpm_cached_color
6419 /* Next in collision chain. */
6420 struct xpm_cached_color
*next
;
6422 /* Color definition (RGB and pixel color). */
6429 /* The hash table used for the color cache, and its bucket vector
6432 #define XPM_COLOR_CACHE_BUCKETS 1001
6433 struct xpm_cached_color
**xpm_color_cache
;
6435 /* Initialize the color cache. */
6438 xpm_init_color_cache (f
, attrs
)
6440 XpmAttributes
*attrs
;
6442 size_t nbytes
= XPM_COLOR_CACHE_BUCKETS
* sizeof *xpm_color_cache
;
6443 xpm_color_cache
= (struct xpm_cached_color
**) xmalloc (nbytes
);
6444 memset (xpm_color_cache
, 0, nbytes
);
6445 init_color_table ();
6447 if (attrs
->valuemask
& XpmColorSymbols
)
6452 for (i
= 0; i
< attrs
->numsymbols
; ++i
)
6453 if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
6454 attrs
->colorsymbols
[i
].value
, &color
))
6456 color
.pixel
= lookup_rgb_color (f
, color
.red
, color
.green
,
6458 xpm_cache_color (f
, attrs
->colorsymbols
[i
].name
, &color
, -1);
6464 /* Free the color cache. */
6467 xpm_free_color_cache ()
6469 struct xpm_cached_color
*p
, *next
;
6472 for (i
= 0; i
< XPM_COLOR_CACHE_BUCKETS
; ++i
)
6473 for (p
= xpm_color_cache
[i
]; p
; p
= next
)
6479 xfree (xpm_color_cache
);
6480 xpm_color_cache
= NULL
;
6481 free_color_table ();
6485 /* Return the bucket index for color named COLOR_NAME in the color
6489 xpm_color_bucket (color_name
)
6495 for (s
= color_name
; *s
; ++s
)
6497 return h
%= XPM_COLOR_CACHE_BUCKETS
;
6501 /* On frame F, cache values COLOR for color with name COLOR_NAME.
6502 BUCKET, if >= 0, is a precomputed bucket index. Value is the cache
6505 static struct xpm_cached_color
*
6506 xpm_cache_color (f
, color_name
, color
, bucket
)
6513 struct xpm_cached_color
*p
;
6516 bucket
= xpm_color_bucket (color_name
);
6518 nbytes
= sizeof *p
+ strlen (color_name
);
6519 p
= (struct xpm_cached_color
*) xmalloc (nbytes
);
6520 strcpy (p
->name
, color_name
);
6522 p
->next
= xpm_color_cache
[bucket
];
6523 xpm_color_cache
[bucket
] = p
;
6528 /* Look up color COLOR_NAME for frame F in the color cache. If found,
6529 return the cached definition in *COLOR. Otherwise, make a new
6530 entry in the cache and allocate the color. Value is zero if color
6531 allocation failed. */
6534 xpm_lookup_color (f
, color_name
, color
)
6539 struct xpm_cached_color
*p
;
6540 int h
= xpm_color_bucket (color_name
);
6542 for (p
= xpm_color_cache
[h
]; p
; p
= p
->next
)
6543 if (strcmp (p
->name
, color_name
) == 0)
6548 else if (XParseColor (FRAME_X_DISPLAY (f
), FRAME_X_COLORMAP (f
),
6551 color
->pixel
= lookup_rgb_color (f
, color
->red
, color
->green
,
6553 p
= xpm_cache_color (f
, color_name
, color
, h
);
6555 /* You get `opaque' at least from ImageMagick converting pbm to xpm
6556 with transparency, and it's useful. */
6557 else if (strcmp ("opaque", color_name
) == 0)
6559 bzero (color
, sizeof (XColor
)); /* Is this necessary/correct? */
6560 color
->pixel
= FRAME_FOREGROUND_PIXEL (f
);
6561 p
= xpm_cache_color (f
, color_name
, color
, h
);
6568 /* Callback for allocating color COLOR_NAME. Called from the XPM lib.
6569 CLOSURE is a pointer to the frame on which we allocate the
6570 color. Return in *COLOR the allocated color. Value is non-zero
6574 xpm_alloc_color (dpy
, cmap
, color_name
, color
, closure
)
6581 return xpm_lookup_color ((struct frame
*) closure
, color_name
, color
);
6585 /* Callback for freeing NPIXELS colors contained in PIXELS. CLOSURE
6586 is a pointer to the frame on which we allocate the color. Value is
6587 non-zero if successful. */
6590 xpm_free_colors (dpy
, cmap
, pixels
, npixels
, closure
)
6600 #endif /* ALLOC_XPM_COLORS */
6603 /* Value is non-zero if COLOR_SYMBOLS is a valid color symbols list
6604 for XPM images. Such a list must consist of conses whose car and
6608 xpm_valid_color_symbols_p (color_symbols
)
6609 Lisp_Object color_symbols
;
6611 while (CONSP (color_symbols
))
6613 Lisp_Object sym
= XCAR (color_symbols
);
6615 || !STRINGP (XCAR (sym
))
6616 || !STRINGP (XCDR (sym
)))
6618 color_symbols
= XCDR (color_symbols
);
6621 return NILP (color_symbols
);
6625 /* Value is non-zero if OBJECT is a valid XPM image specification. */
6628 xpm_image_p (object
)
6631 struct image_keyword fmt
[XPM_LAST
];
6632 bcopy (xpm_format
, fmt
, sizeof fmt
);
6633 return (parse_image_spec (object
, fmt
, XPM_LAST
, Qxpm
)
6634 /* Either `:file' or `:data' must be present. */
6635 && fmt
[XPM_FILE
].count
+ fmt
[XPM_DATA
].count
== 1
6636 /* Either no `:color-symbols' or it's a list of conses
6637 whose car and cdr are strings. */
6638 && (fmt
[XPM_COLOR_SYMBOLS
].count
== 0
6639 || xpm_valid_color_symbols_p (fmt
[XPM_COLOR_SYMBOLS
].value
)));
6643 /* Load image IMG which will be displayed on frame F. Value is
6644 non-zero if successful. */
6652 XpmAttributes attrs
;
6653 Lisp_Object specified_file
, color_symbols
;
6655 /* Configure the XPM lib. Use the visual of frame F. Allocate
6656 close colors. Return colors allocated. */
6657 bzero (&attrs
, sizeof attrs
);
6658 attrs
.visual
= FRAME_X_VISUAL (f
);
6659 attrs
.colormap
= FRAME_X_COLORMAP (f
);
6660 attrs
.valuemask
|= XpmVisual
;
6661 attrs
.valuemask
|= XpmColormap
;
6663 #ifdef ALLOC_XPM_COLORS
6664 /* Allocate colors with our own functions which handle
6665 failing color allocation more gracefully. */
6666 attrs
.color_closure
= f
;
6667 attrs
.alloc_color
= xpm_alloc_color
;
6668 attrs
.free_colors
= xpm_free_colors
;
6669 attrs
.valuemask
|= XpmAllocColor
| XpmFreeColors
| XpmColorClosure
;
6670 #else /* not ALLOC_XPM_COLORS */
6671 /* Let the XPM lib allocate colors. */
6672 attrs
.valuemask
|= XpmReturnAllocPixels
;
6673 #ifdef XpmAllocCloseColors
6674 attrs
.alloc_close_colors
= 1;
6675 attrs
.valuemask
|= XpmAllocCloseColors
;
6676 #else /* not XpmAllocCloseColors */
6677 attrs
.closeness
= 600;
6678 attrs
.valuemask
|= XpmCloseness
;
6679 #endif /* not XpmAllocCloseColors */
6680 #endif /* ALLOC_XPM_COLORS */
6682 /* If image specification contains symbolic color definitions, add
6683 these to `attrs'. */
6684 color_symbols
= image_spec_value (img
->spec
, QCcolor_symbols
, NULL
);
6685 if (CONSP (color_symbols
))
6688 XpmColorSymbol
*xpm_syms
;
6691 attrs
.valuemask
|= XpmColorSymbols
;
6693 /* Count number of symbols. */
6694 attrs
.numsymbols
= 0;
6695 for (tail
= color_symbols
; CONSP (tail
); tail
= XCDR (tail
))
6698 /* Allocate an XpmColorSymbol array. */
6699 size
= attrs
.numsymbols
* sizeof *xpm_syms
;
6700 xpm_syms
= (XpmColorSymbol
*) alloca (size
);
6701 bzero (xpm_syms
, size
);
6702 attrs
.colorsymbols
= xpm_syms
;
6704 /* Fill the color symbol array. */
6705 for (tail
= color_symbols
, i
= 0;
6707 ++i
, tail
= XCDR (tail
))
6709 Lisp_Object name
= XCAR (XCAR (tail
));
6710 Lisp_Object color
= XCDR (XCAR (tail
));
6711 xpm_syms
[i
].name
= (char *) alloca (SCHARS (name
) + 1);
6712 strcpy (xpm_syms
[i
].name
, SDATA (name
));
6713 xpm_syms
[i
].value
= (char *) alloca (SCHARS (color
) + 1);
6714 strcpy (xpm_syms
[i
].value
, SDATA (color
));
6718 /* Create a pixmap for the image, either from a file, or from a
6719 string buffer containing data in the same format as an XPM file. */
6720 #ifdef ALLOC_XPM_COLORS
6721 xpm_init_color_cache (f
, &attrs
);
6724 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
6725 if (STRINGP (specified_file
))
6727 Lisp_Object file
= x_find_image_file (specified_file
);
6728 if (!STRINGP (file
))
6730 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
6734 rc
= XpmReadFileToPixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
6735 SDATA (file
), &img
->pixmap
, &img
->mask
,
6740 Lisp_Object buffer
= image_spec_value (img
->spec
, QCdata
, NULL
);
6741 rc
= XpmCreatePixmapFromBuffer (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
6743 &img
->pixmap
, &img
->mask
,
6747 if (rc
== XpmSuccess
)
6749 #ifdef ALLOC_XPM_COLORS
6750 img
->colors
= colors_in_color_table (&img
->ncolors
);
6751 #else /* not ALLOC_XPM_COLORS */
6754 img
->ncolors
= attrs
.nalloc_pixels
;
6755 img
->colors
= (unsigned long *) xmalloc (img
->ncolors
6756 * sizeof *img
->colors
);
6757 for (i
= 0; i
< attrs
.nalloc_pixels
; ++i
)
6759 img
->colors
[i
] = attrs
.alloc_pixels
[i
];
6760 #ifdef DEBUG_X_COLORS
6761 register_color (img
->colors
[i
]);
6764 #endif /* not ALLOC_XPM_COLORS */
6766 img
->width
= attrs
.width
;
6767 img
->height
= attrs
.height
;
6768 xassert (img
->width
> 0 && img
->height
> 0);
6770 /* The call to XpmFreeAttributes below frees attrs.alloc_pixels. */
6771 XpmFreeAttributes (&attrs
);
6778 image_error ("Error opening XPM file (%s)", img
->spec
, Qnil
);
6781 case XpmFileInvalid
:
6782 image_error ("Invalid XPM file (%s)", img
->spec
, Qnil
);
6786 image_error ("Out of memory (%s)", img
->spec
, Qnil
);
6789 case XpmColorFailed
:
6790 image_error ("Color allocation error (%s)", img
->spec
, Qnil
);
6794 image_error ("Unknown error (%s)", img
->spec
, Qnil
);
6799 #ifdef ALLOC_XPM_COLORS
6800 xpm_free_color_cache ();
6802 return rc
== XpmSuccess
;
6805 #endif /* HAVE_XPM != 0 */
6808 /***********************************************************************
6810 ***********************************************************************/
6812 /* An entry in the color table mapping an RGB color to a pixel color. */
6817 unsigned long pixel
;
6819 /* Next in color table collision list. */
6820 struct ct_color
*next
;
6823 /* The bucket vector size to use. Must be prime. */
6827 /* Value is a hash of the RGB color given by R, G, and B. */
6829 #define CT_HASH_RGB(R, G, B) (((R) << 16) ^ ((G) << 8) ^ (B))
6831 /* The color hash table. */
6833 struct ct_color
**ct_table
;
6835 /* Number of entries in the color table. */
6837 int ct_colors_allocated
;
6839 /* Initialize the color table. */
6844 int size
= CT_SIZE
* sizeof (*ct_table
);
6845 ct_table
= (struct ct_color
**) xmalloc (size
);
6846 bzero (ct_table
, size
);
6847 ct_colors_allocated
= 0;
6851 /* Free memory associated with the color table. */
6857 struct ct_color
*p
, *next
;
6859 for (i
= 0; i
< CT_SIZE
; ++i
)
6860 for (p
= ct_table
[i
]; p
; p
= next
)
6871 /* Value is a pixel color for RGB color R, G, B on frame F. If an
6872 entry for that color already is in the color table, return the
6873 pixel color of that entry. Otherwise, allocate a new color for R,
6874 G, B, and make an entry in the color table. */
6876 static unsigned long
6877 lookup_rgb_color (f
, r
, g
, b
)
6881 unsigned hash
= CT_HASH_RGB (r
, g
, b
);
6882 int i
= hash
% CT_SIZE
;
6884 struct x_display_info
*dpyinfo
;
6886 /* Handle TrueColor visuals specially, which improves performance by
6887 two orders of magnitude. Freeing colors on TrueColor visuals is
6888 a nop, and pixel colors specify RGB values directly. See also
6889 the Xlib spec, chapter 3.1. */
6890 dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
6891 if (dpyinfo
->red_bits
> 0)
6893 unsigned long pr
, pg
, pb
;
6895 /* Apply gamma-correction like normal color allocation does. */
6899 color
.red
= r
, color
.green
= g
, color
.blue
= b
;
6900 gamma_correct (f
, &color
);
6901 r
= color
.red
, g
= color
.green
, b
= color
.blue
;
6904 /* Scale down RGB values to the visual's bits per RGB, and shift
6905 them to the right position in the pixel color. Note that the
6906 original RGB values are 16-bit values, as usual in X. */
6907 pr
= (r
>> (16 - dpyinfo
->red_bits
)) << dpyinfo
->red_offset
;
6908 pg
= (g
>> (16 - dpyinfo
->green_bits
)) << dpyinfo
->green_offset
;
6909 pb
= (b
>> (16 - dpyinfo
->blue_bits
)) << dpyinfo
->blue_offset
;
6911 /* Assemble the pixel color. */
6912 return pr
| pg
| pb
;
6915 for (p
= ct_table
[i
]; p
; p
= p
->next
)
6916 if (p
->r
== r
&& p
->g
== g
&& p
->b
== b
)
6929 cmap
= FRAME_X_COLORMAP (f
);
6930 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
6934 ++ct_colors_allocated
;
6936 p
= (struct ct_color
*) xmalloc (sizeof *p
);
6940 p
->pixel
= color
.pixel
;
6941 p
->next
= ct_table
[i
];
6945 return FRAME_FOREGROUND_PIXEL (f
);
6952 /* Look up pixel color PIXEL which is used on frame F in the color
6953 table. If not already present, allocate it. Value is PIXEL. */
6955 static unsigned long
6956 lookup_pixel_color (f
, pixel
)
6958 unsigned long pixel
;
6960 int i
= pixel
% CT_SIZE
;
6963 for (p
= ct_table
[i
]; p
; p
= p
->next
)
6964 if (p
->pixel
== pixel
)
6973 cmap
= FRAME_X_COLORMAP (f
);
6974 color
.pixel
= pixel
;
6975 x_query_color (f
, &color
);
6976 rc
= x_alloc_nearest_color (f
, cmap
, &color
);
6980 ++ct_colors_allocated
;
6982 p
= (struct ct_color
*) xmalloc (sizeof *p
);
6987 p
->next
= ct_table
[i
];
6991 return FRAME_FOREGROUND_PIXEL (f
);
6998 /* Value is a vector of all pixel colors contained in the color table,
6999 allocated via xmalloc. Set *N to the number of colors. */
7001 static unsigned long *
7002 colors_in_color_table (n
)
7007 unsigned long *colors
;
7009 if (ct_colors_allocated
== 0)
7016 colors
= (unsigned long *) xmalloc (ct_colors_allocated
7018 *n
= ct_colors_allocated
;
7020 for (i
= j
= 0; i
< CT_SIZE
; ++i
)
7021 for (p
= ct_table
[i
]; p
; p
= p
->next
)
7022 colors
[j
++] = p
->pixel
;
7030 /***********************************************************************
7032 ***********************************************************************/
7034 static XColor
*x_to_xcolors
P_ ((struct frame
*, struct image
*, int));
7035 static void x_from_xcolors
P_ ((struct frame
*, struct image
*, XColor
*));
7036 static void x_detect_edges
P_ ((struct frame
*, struct image
*, int[9], int));
7038 /* Non-zero means draw a cross on images having `:conversion
7041 int cross_disabled_images
;
7043 /* Edge detection matrices for different edge-detection
7046 static int emboss_matrix
[9] = {
7048 2, -1, 0, /* y - 1 */
7050 0, 1, -2 /* y + 1 */
7053 static int laplace_matrix
[9] = {
7055 1, 0, 0, /* y - 1 */
7057 0, 0, -1 /* y + 1 */
7060 /* Value is the intensity of the color whose red/green/blue values
7063 #define COLOR_INTENSITY(R, G, B) ((2 * (R) + 3 * (G) + (B)) / 6)
7066 /* On frame F, return an array of XColor structures describing image
7067 IMG->pixmap. Each XColor structure has its pixel color set. RGB_P
7068 non-zero means also fill the red/green/blue members of the XColor
7069 structures. Value is a pointer to the array of XColors structures,
7070 allocated with xmalloc; it must be freed by the caller. */
7073 x_to_xcolors (f
, img
, rgb_p
)
7082 colors
= (XColor
*) xmalloc (img
->width
* img
->height
* sizeof *colors
);
7084 /* Get the X image IMG->pixmap. */
7085 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
7086 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
7088 /* Fill the `pixel' members of the XColor array. I wished there
7089 were an easy and portable way to circumvent XGetPixel. */
7091 for (y
= 0; y
< img
->height
; ++y
)
7095 for (x
= 0; x
< img
->width
; ++x
, ++p
)
7096 p
->pixel
= XGetPixel (ximg
, x
, y
);
7099 x_query_colors (f
, row
, img
->width
);
7102 XDestroyImage (ximg
);
7107 /* Create IMG->pixmap from an array COLORS of XColor structures, whose
7108 RGB members are set. F is the frame on which this all happens.
7109 COLORS will be freed; an existing IMG->pixmap will be freed, too. */
7112 x_from_xcolors (f
, img
, colors
)
7122 init_color_table ();
7124 x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 0,
7127 for (y
= 0; y
< img
->height
; ++y
)
7128 for (x
= 0; x
< img
->width
; ++x
, ++p
)
7130 unsigned long pixel
;
7131 pixel
= lookup_rgb_color (f
, p
->red
, p
->green
, p
->blue
);
7132 XPutPixel (oimg
, x
, y
, pixel
);
7136 x_clear_image_1 (f
, img
, 1, 0, 1);
7138 x_put_x_image (f
, oimg
, pixmap
, img
->width
, img
->height
);
7139 x_destroy_x_image (oimg
);
7140 img
->pixmap
= pixmap
;
7141 img
->colors
= colors_in_color_table (&img
->ncolors
);
7142 free_color_table ();
7146 /* On frame F, perform edge-detection on image IMG.
7148 MATRIX is a nine-element array specifying the transformation
7149 matrix. See emboss_matrix for an example.
7151 COLOR_ADJUST is a color adjustment added to each pixel of the
7155 x_detect_edges (f
, img
, matrix
, color_adjust
)
7158 int matrix
[9], color_adjust
;
7160 XColor
*colors
= x_to_xcolors (f
, img
, 1);
7164 for (i
= sum
= 0; i
< 9; ++i
)
7165 sum
+= abs (matrix
[i
]);
7167 #define COLOR(A, X, Y) ((A) + (Y) * img->width + (X))
7169 new = (XColor
*) xmalloc (img
->width
* img
->height
* sizeof *new);
7171 for (y
= 0; y
< img
->height
; ++y
)
7173 p
= COLOR (new, 0, y
);
7174 p
->red
= p
->green
= p
->blue
= 0xffff/2;
7175 p
= COLOR (new, img
->width
- 1, y
);
7176 p
->red
= p
->green
= p
->blue
= 0xffff/2;
7179 for (x
= 1; x
< img
->width
- 1; ++x
)
7181 p
= COLOR (new, x
, 0);
7182 p
->red
= p
->green
= p
->blue
= 0xffff/2;
7183 p
= COLOR (new, x
, img
->height
- 1);
7184 p
->red
= p
->green
= p
->blue
= 0xffff/2;
7187 for (y
= 1; y
< img
->height
- 1; ++y
)
7189 p
= COLOR (new, 1, y
);
7191 for (x
= 1; x
< img
->width
- 1; ++x
, ++p
)
7193 int r
, g
, b
, y1
, x1
;
7196 for (y1
= y
- 1; y1
< y
+ 2; ++y1
)
7197 for (x1
= x
- 1; x1
< x
+ 2; ++x1
, ++i
)
7200 XColor
*t
= COLOR (colors
, x1
, y1
);
7201 r
+= matrix
[i
] * t
->red
;
7202 g
+= matrix
[i
] * t
->green
;
7203 b
+= matrix
[i
] * t
->blue
;
7206 r
= (r
/ sum
+ color_adjust
) & 0xffff;
7207 g
= (g
/ sum
+ color_adjust
) & 0xffff;
7208 b
= (b
/ sum
+ color_adjust
) & 0xffff;
7209 p
->red
= p
->green
= p
->blue
= COLOR_INTENSITY (r
, g
, b
);
7214 x_from_xcolors (f
, img
, new);
7220 /* Perform the pre-defined `emboss' edge-detection on image IMG
7228 x_detect_edges (f
, img
, emboss_matrix
, 0xffff / 2);
7232 /* Perform the pre-defined `laplace' edge-detection on image IMG
7240 x_detect_edges (f
, img
, laplace_matrix
, 45000);
7244 /* Perform edge-detection on image IMG on frame F, with specified
7245 transformation matrix MATRIX and color-adjustment COLOR_ADJUST.
7247 MATRIX must be either
7249 - a list of at least 9 numbers in row-major form
7250 - a vector of at least 9 numbers
7252 COLOR_ADJUST nil means use a default; otherwise it must be a
7256 x_edge_detection (f
, img
, matrix
, color_adjust
)
7259 Lisp_Object matrix
, color_adjust
;
7267 i
< 9 && CONSP (matrix
) && NUMBERP (XCAR (matrix
));
7268 ++i
, matrix
= XCDR (matrix
))
7269 trans
[i
] = XFLOATINT (XCAR (matrix
));
7271 else if (VECTORP (matrix
) && ASIZE (matrix
) >= 9)
7273 for (i
= 0; i
< 9 && NUMBERP (AREF (matrix
, i
)); ++i
)
7274 trans
[i
] = XFLOATINT (AREF (matrix
, i
));
7277 if (NILP (color_adjust
))
7278 color_adjust
= make_number (0xffff / 2);
7280 if (i
== 9 && NUMBERP (color_adjust
))
7281 x_detect_edges (f
, img
, trans
, (int) XFLOATINT (color_adjust
));
7285 /* Transform image IMG on frame F so that it looks disabled. */
7288 x_disable_image (f
, img
)
7292 struct x_display_info
*dpyinfo
= FRAME_X_DISPLAY_INFO (f
);
7294 if (dpyinfo
->n_planes
>= 2)
7296 /* Color (or grayscale). Convert to gray, and equalize. Just
7297 drawing such images with a stipple can look very odd, so
7298 we're using this method instead. */
7299 XColor
*colors
= x_to_xcolors (f
, img
, 1);
7301 const int h
= 15000;
7302 const int l
= 30000;
7304 for (p
= colors
, end
= colors
+ img
->width
* img
->height
;
7308 int i
= COLOR_INTENSITY (p
->red
, p
->green
, p
->blue
);
7309 int i2
= (0xffff - h
- l
) * i
/ 0xffff + l
;
7310 p
->red
= p
->green
= p
->blue
= i2
;
7313 x_from_xcolors (f
, img
, colors
);
7316 /* Draw a cross over the disabled image, if we must or if we
7318 if (dpyinfo
->n_planes
< 2 || cross_disabled_images
)
7320 Display
*dpy
= FRAME_X_DISPLAY (f
);
7323 gc
= XCreateGC (dpy
, img
->pixmap
, 0, NULL
);
7324 XSetForeground (dpy
, gc
, BLACK_PIX_DEFAULT (f
));
7325 XDrawLine (dpy
, img
->pixmap
, gc
, 0, 0,
7326 img
->width
- 1, img
->height
- 1);
7327 XDrawLine (dpy
, img
->pixmap
, gc
, 0, img
->height
- 1,
7333 gc
= XCreateGC (dpy
, img
->mask
, 0, NULL
);
7334 XSetForeground (dpy
, gc
, WHITE_PIX_DEFAULT (f
));
7335 XDrawLine (dpy
, img
->mask
, gc
, 0, 0,
7336 img
->width
- 1, img
->height
- 1);
7337 XDrawLine (dpy
, img
->mask
, gc
, 0, img
->height
- 1,
7345 /* Build a mask for image IMG which is used on frame F. FILE is the
7346 name of an image file, for error messages. HOW determines how to
7347 determine the background color of IMG. If it is a list '(R G B)',
7348 with R, G, and B being integers >= 0, take that as the color of the
7349 background. Otherwise, determine the background color of IMG
7350 heuristically. Value is non-zero if successful. */
7353 x_build_heuristic_mask (f
, img
, how
)
7358 Display
*dpy
= FRAME_X_DISPLAY (f
);
7359 XImage
*ximg
, *mask_img
;
7360 int x
, y
, rc
, use_img_background
;
7361 unsigned long bg
= 0;
7365 XFreePixmap (FRAME_X_DISPLAY (f
), img
->mask
);
7367 img
->background_transparent_valid
= 0;
7370 /* Create an image and pixmap serving as mask. */
7371 rc
= x_create_x_image_and_pixmap (f
, img
->width
, img
->height
, 1,
7372 &mask_img
, &img
->mask
);
7376 /* Get the X image of IMG->pixmap. */
7377 ximg
= XGetImage (dpy
, img
->pixmap
, 0, 0, img
->width
, img
->height
,
7380 /* Determine the background color of ximg. If HOW is `(R G B)'
7381 take that as color. Otherwise, use the image's background color. */
7382 use_img_background
= 1;
7388 for (i
= 0; i
< 3 && CONSP (how
) && NATNUMP (XCAR (how
)); ++i
)
7390 rgb
[i
] = XFASTINT (XCAR (how
)) & 0xffff;
7394 if (i
== 3 && NILP (how
))
7396 char color_name
[30];
7397 sprintf (color_name
, "#%04x%04x%04x", rgb
[0], rgb
[1], rgb
[2]);
7398 bg
= x_alloc_image_color (f
, img
, build_string (color_name
), 0);
7399 use_img_background
= 0;
7403 if (use_img_background
)
7404 bg
= four_corners_best (ximg
, img
->width
, img
->height
);
7406 /* Set all bits in mask_img to 1 whose color in ximg is different
7407 from the background color bg. */
7408 for (y
= 0; y
< img
->height
; ++y
)
7409 for (x
= 0; x
< img
->width
; ++x
)
7410 XPutPixel (mask_img
, x
, y
, XGetPixel (ximg
, x
, y
) != bg
);
7412 /* Fill in the background_transparent field while we have the mask handy. */
7413 image_background_transparent (img
, f
, mask_img
);
7415 /* Put mask_img into img->mask. */
7416 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
7417 x_destroy_x_image (mask_img
);
7418 XDestroyImage (ximg
);
7425 /***********************************************************************
7426 PBM (mono, gray, color)
7427 ***********************************************************************/
7429 static int pbm_image_p
P_ ((Lisp_Object object
));
7430 static int pbm_load
P_ ((struct frame
*f
, struct image
*img
));
7431 static int pbm_scan_number
P_ ((unsigned char **, unsigned char *));
7433 /* The symbol `pbm' identifying images of this type. */
7437 /* Indices of image specification fields in gs_format, below. */
7439 enum pbm_keyword_index
7455 /* Vector of image_keyword structures describing the format
7456 of valid user-defined image specifications. */
7458 static struct image_keyword pbm_format
[PBM_LAST
] =
7460 {":type", IMAGE_SYMBOL_VALUE
, 1},
7461 {":file", IMAGE_STRING_VALUE
, 0},
7462 {":data", IMAGE_STRING_VALUE
, 0},
7463 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7464 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
7465 {":relief", IMAGE_INTEGER_VALUE
, 0},
7466 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7467 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7468 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7469 {":foreground", IMAGE_STRING_OR_NIL_VALUE
, 0},
7470 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7473 /* Structure describing the image type `pbm'. */
7475 static struct image_type pbm_type
=
7485 /* Return non-zero if OBJECT is a valid PBM image specification. */
7488 pbm_image_p (object
)
7491 struct image_keyword fmt
[PBM_LAST
];
7493 bcopy (pbm_format
, fmt
, sizeof fmt
);
7495 if (!parse_image_spec (object
, fmt
, PBM_LAST
, Qpbm
))
7498 /* Must specify either :data or :file. */
7499 return fmt
[PBM_DATA
].count
+ fmt
[PBM_FILE
].count
== 1;
7503 /* Scan a decimal number from *S and return it. Advance *S while
7504 reading the number. END is the end of the string. Value is -1 at
7508 pbm_scan_number (s
, end
)
7509 unsigned char **s
, *end
;
7511 int c
= 0, val
= -1;
7515 /* Skip white-space. */
7516 while (*s
< end
&& (c
= *(*s
)++, isspace (c
)))
7521 /* Skip comment to end of line. */
7522 while (*s
< end
&& (c
= *(*s
)++, c
!= '\n'))
7525 else if (isdigit (c
))
7527 /* Read decimal number. */
7529 while (*s
< end
&& (c
= *(*s
)++, isdigit (c
)))
7530 val
= 10 * val
+ c
- '0';
7541 /* Load PBM image IMG for use on frame F. */
7549 int width
, height
, max_color_idx
= 0;
7551 Lisp_Object file
, specified_file
;
7552 enum {PBM_MONO
, PBM_GRAY
, PBM_COLOR
} type
;
7553 struct gcpro gcpro1
;
7554 unsigned char *contents
= NULL
;
7555 unsigned char *end
, *p
;
7558 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7562 if (STRINGP (specified_file
))
7564 file
= x_find_image_file (specified_file
);
7565 if (!STRINGP (file
))
7567 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7572 contents
= slurp_file (SDATA (file
), &size
);
7573 if (contents
== NULL
)
7575 image_error ("Error reading `%s'", file
, Qnil
);
7581 end
= contents
+ size
;
7586 data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7588 end
= p
+ SBYTES (data
);
7591 /* Check magic number. */
7592 if (end
- p
< 2 || *p
++ != 'P')
7594 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
7604 raw_p
= 0, type
= PBM_MONO
;
7608 raw_p
= 0, type
= PBM_GRAY
;
7612 raw_p
= 0, type
= PBM_COLOR
;
7616 raw_p
= 1, type
= PBM_MONO
;
7620 raw_p
= 1, type
= PBM_GRAY
;
7624 raw_p
= 1, type
= PBM_COLOR
;
7628 image_error ("Not a PBM image: `%s'", img
->spec
, Qnil
);
7632 /* Read width, height, maximum color-component. Characters
7633 starting with `#' up to the end of a line are ignored. */
7634 width
= pbm_scan_number (&p
, end
);
7635 height
= pbm_scan_number (&p
, end
);
7637 if (type
!= PBM_MONO
)
7639 max_color_idx
= pbm_scan_number (&p
, end
);
7640 if (raw_p
&& max_color_idx
> 255)
7641 max_color_idx
= 255;
7646 || (type
!= PBM_MONO
&& max_color_idx
< 0))
7649 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0,
7650 &ximg
, &img
->pixmap
))
7653 /* Initialize the color hash table. */
7654 init_color_table ();
7656 if (type
== PBM_MONO
)
7659 struct image_keyword fmt
[PBM_LAST
];
7660 unsigned long fg
= FRAME_FOREGROUND_PIXEL (f
);
7661 unsigned long bg
= FRAME_BACKGROUND_PIXEL (f
);
7663 /* Parse the image specification. */
7664 bcopy (pbm_format
, fmt
, sizeof fmt
);
7665 parse_image_spec (img
->spec
, fmt
, PBM_LAST
, Qpbm
);
7667 /* Get foreground and background colors, maybe allocate colors. */
7668 if (fmt
[PBM_FOREGROUND
].count
7669 && STRINGP (fmt
[PBM_FOREGROUND
].value
))
7670 fg
= x_alloc_image_color (f
, img
, fmt
[PBM_FOREGROUND
].value
, fg
);
7671 if (fmt
[PBM_BACKGROUND
].count
7672 && STRINGP (fmt
[PBM_BACKGROUND
].value
))
7674 bg
= x_alloc_image_color (f
, img
, fmt
[PBM_BACKGROUND
].value
, bg
);
7675 img
->background
= bg
;
7676 img
->background_valid
= 1;
7679 for (y
= 0; y
< height
; ++y
)
7680 for (x
= 0; x
< width
; ++x
)
7690 g
= pbm_scan_number (&p
, end
);
7692 XPutPixel (ximg
, x
, y
, g
? fg
: bg
);
7697 for (y
= 0; y
< height
; ++y
)
7698 for (x
= 0; x
< width
; ++x
)
7702 if (type
== PBM_GRAY
)
7703 r
= g
= b
= raw_p
? *p
++ : pbm_scan_number (&p
, end
);
7712 r
= pbm_scan_number (&p
, end
);
7713 g
= pbm_scan_number (&p
, end
);
7714 b
= pbm_scan_number (&p
, end
);
7717 if (r
< 0 || g
< 0 || b
< 0)
7721 XDestroyImage (ximg
);
7722 image_error ("Invalid pixel value in image `%s'",
7727 /* RGB values are now in the range 0..max_color_idx.
7728 Scale this to the range 0..0xffff supported by X. */
7729 r
= (double) r
* 65535 / max_color_idx
;
7730 g
= (double) g
* 65535 / max_color_idx
;
7731 b
= (double) b
* 65535 / max_color_idx
;
7732 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
7736 /* Store in IMG->colors the colors allocated for the image, and
7737 free the color table. */
7738 img
->colors
= colors_in_color_table (&img
->ncolors
);
7739 free_color_table ();
7741 /* Maybe fill in the background field while we have ximg handy. */
7742 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
7743 IMAGE_BACKGROUND (img
, f
, ximg
);
7745 /* Put the image into a pixmap. */
7746 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
7747 x_destroy_x_image (ximg
);
7750 img
->height
= height
;
7759 /***********************************************************************
7761 ***********************************************************************/
7765 #if defined HAVE_LIBPNG_PNG_H
7766 # include <libpng/png.h>
7771 /* Function prototypes. */
7773 static int png_image_p
P_ ((Lisp_Object object
));
7774 static int png_load
P_ ((struct frame
*f
, struct image
*img
));
7776 /* The symbol `png' identifying images of this type. */
7780 /* Indices of image specification fields in png_format, below. */
7782 enum png_keyword_index
7797 /* Vector of image_keyword structures describing the format
7798 of valid user-defined image specifications. */
7800 static struct image_keyword png_format
[PNG_LAST
] =
7802 {":type", IMAGE_SYMBOL_VALUE
, 1},
7803 {":data", IMAGE_STRING_VALUE
, 0},
7804 {":file", IMAGE_STRING_VALUE
, 0},
7805 {":ascent", IMAGE_ASCENT_VALUE
, 0},
7806 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
7807 {":relief", IMAGE_INTEGER_VALUE
, 0},
7808 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7809 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7810 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
7811 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
7814 /* Structure describing the image type `png'. */
7816 static struct image_type png_type
=
7826 /* Return non-zero if OBJECT is a valid PNG image specification. */
7829 png_image_p (object
)
7832 struct image_keyword fmt
[PNG_LAST
];
7833 bcopy (png_format
, fmt
, sizeof fmt
);
7835 if (!parse_image_spec (object
, fmt
, PNG_LAST
, Qpng
))
7838 /* Must specify either the :data or :file keyword. */
7839 return fmt
[PNG_FILE
].count
+ fmt
[PNG_DATA
].count
== 1;
7843 /* Error and warning handlers installed when the PNG library
7847 my_png_error (png_ptr
, msg
)
7848 png_struct
*png_ptr
;
7851 xassert (png_ptr
!= NULL
);
7852 image_error ("PNG error: %s", build_string (msg
), Qnil
);
7853 longjmp (png_ptr
->jmpbuf
, 1);
7858 my_png_warning (png_ptr
, msg
)
7859 png_struct
*png_ptr
;
7862 xassert (png_ptr
!= NULL
);
7863 image_error ("PNG warning: %s", build_string (msg
), Qnil
);
7866 /* Memory source for PNG decoding. */
7868 struct png_memory_storage
7870 unsigned char *bytes
; /* The data */
7871 size_t len
; /* How big is it? */
7872 int index
; /* Where are we? */
7876 /* Function set as reader function when reading PNG image from memory.
7877 PNG_PTR is a pointer to the PNG control structure. Copy LENGTH
7878 bytes from the input to DATA. */
7881 png_read_from_memory (png_ptr
, data
, length
)
7882 png_structp png_ptr
;
7886 struct png_memory_storage
*tbr
7887 = (struct png_memory_storage
*) png_get_io_ptr (png_ptr
);
7889 if (length
> tbr
->len
- tbr
->index
)
7890 png_error (png_ptr
, "Read error");
7892 bcopy (tbr
->bytes
+ tbr
->index
, data
, length
);
7893 tbr
->index
= tbr
->index
+ length
;
7896 /* Load PNG image IMG for use on frame F. Value is non-zero if
7904 Lisp_Object file
, specified_file
;
7905 Lisp_Object specified_data
;
7907 XImage
*ximg
, *mask_img
= NULL
;
7908 struct gcpro gcpro1
;
7909 png_struct
*png_ptr
= NULL
;
7910 png_info
*info_ptr
= NULL
, *end_info
= NULL
;
7911 FILE *volatile fp
= NULL
;
7913 png_byte
* volatile pixels
= NULL
;
7914 png_byte
** volatile rows
= NULL
;
7915 png_uint_32 width
, height
;
7916 int bit_depth
, color_type
, interlace_type
;
7918 png_uint_32 row_bytes
;
7920 double screen_gamma
;
7921 struct png_memory_storage tbr
; /* Data to be read */
7923 /* Find out what file to load. */
7924 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
7925 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
7929 if (NILP (specified_data
))
7931 file
= x_find_image_file (specified_file
);
7932 if (!STRINGP (file
))
7934 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
7939 /* Open the image file. */
7940 fp
= fopen (SDATA (file
), "rb");
7943 image_error ("Cannot open image file `%s'", file
, Qnil
);
7949 /* Check PNG signature. */
7950 if (fread (sig
, 1, sizeof sig
, fp
) != sizeof sig
7951 || !png_check_sig (sig
, sizeof sig
))
7953 image_error ("Not a PNG file: `%s'", file
, Qnil
);
7961 /* Read from memory. */
7962 tbr
.bytes
= SDATA (specified_data
);
7963 tbr
.len
= SBYTES (specified_data
);
7966 /* Check PNG signature. */
7967 if (tbr
.len
< sizeof sig
7968 || !png_check_sig (tbr
.bytes
, sizeof sig
))
7970 image_error ("Not a PNG image: `%s'", img
->spec
, Qnil
);
7975 /* Need to skip past the signature. */
7976 tbr
.bytes
+= sizeof (sig
);
7979 /* Initialize read and info structs for PNG lib. */
7980 png_ptr
= png_create_read_struct (PNG_LIBPNG_VER_STRING
, NULL
,
7981 my_png_error
, my_png_warning
);
7984 if (fp
) fclose (fp
);
7989 info_ptr
= png_create_info_struct (png_ptr
);
7992 png_destroy_read_struct (&png_ptr
, NULL
, NULL
);
7993 if (fp
) fclose (fp
);
7998 end_info
= png_create_info_struct (png_ptr
);
8001 png_destroy_read_struct (&png_ptr
, &info_ptr
, NULL
);
8002 if (fp
) fclose (fp
);
8007 /* Set error jump-back. We come back here when the PNG library
8008 detects an error. */
8009 if (setjmp (png_ptr
->jmpbuf
))
8013 png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
8016 if (fp
) fclose (fp
);
8021 /* Read image info. */
8022 if (!NILP (specified_data
))
8023 png_set_read_fn (png_ptr
, (void *) &tbr
, png_read_from_memory
);
8025 png_init_io (png_ptr
, fp
);
8027 png_set_sig_bytes (png_ptr
, sizeof sig
);
8028 png_read_info (png_ptr
, info_ptr
);
8029 png_get_IHDR (png_ptr
, info_ptr
, &width
, &height
, &bit_depth
, &color_type
,
8030 &interlace_type
, NULL
, NULL
);
8032 /* If image contains simply transparency data, we prefer to
8033 construct a clipping mask. */
8034 if (png_get_valid (png_ptr
, info_ptr
, PNG_INFO_tRNS
))
8039 /* This function is easier to write if we only have to handle
8040 one data format: RGB or RGBA with 8 bits per channel. Let's
8041 transform other formats into that format. */
8043 /* Strip more than 8 bits per channel. */
8044 if (bit_depth
== 16)
8045 png_set_strip_16 (png_ptr
);
8047 /* Expand data to 24 bit RGB, or 8 bit grayscale, with alpha channel
8049 png_set_expand (png_ptr
);
8051 /* Convert grayscale images to RGB. */
8052 if (color_type
== PNG_COLOR_TYPE_GRAY
8053 || color_type
== PNG_COLOR_TYPE_GRAY_ALPHA
)
8054 png_set_gray_to_rgb (png_ptr
);
8056 screen_gamma
= (f
->gamma
? 1 / f
->gamma
/ 0.45455 : 2.2);
8058 #if 0 /* Avoid double gamma correction for PNG images. */
8059 { /* Tell the PNG lib to handle gamma correction for us. */
8062 #if defined(PNG_READ_sRGB_SUPPORTED) || defined(PNG_WRITE_sRGB_SUPPORTED)
8063 if (png_get_sRGB (png_ptr
, info_ptr
, &intent
))
8064 /* The libpng documentation says this is right in this case. */
8065 png_set_gamma (png_ptr
, screen_gamma
, 0.45455);
8068 if (png_get_gAMA (png_ptr
, info_ptr
, &image_gamma
))
8069 /* Image contains gamma information. */
8070 png_set_gamma (png_ptr
, screen_gamma
, image_gamma
);
8072 /* Use the standard default for the image gamma. */
8073 png_set_gamma (png_ptr
, screen_gamma
, 0.45455);
8077 /* Handle alpha channel by combining the image with a background
8078 color. Do this only if a real alpha channel is supplied. For
8079 simple transparency, we prefer a clipping mask. */
8082 png_color_16
*image_bg
;
8083 Lisp_Object specified_bg
8084 = image_spec_value (img
->spec
, QCbackground
, NULL
);
8086 if (STRINGP (specified_bg
))
8087 /* The user specified `:background', use that. */
8090 if (x_defined_color (f
, SDATA (specified_bg
), &color
, 0))
8092 png_color_16 user_bg
;
8094 bzero (&user_bg
, sizeof user_bg
);
8095 user_bg
.red
= color
.red
;
8096 user_bg
.green
= color
.green
;
8097 user_bg
.blue
= color
.blue
;
8099 png_set_background (png_ptr
, &user_bg
,
8100 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
8103 else if (png_get_bKGD (png_ptr
, info_ptr
, &image_bg
))
8104 /* Image contains a background color with which to
8105 combine the image. */
8106 png_set_background (png_ptr
, image_bg
,
8107 PNG_BACKGROUND_GAMMA_FILE
, 1, 1.0);
8110 /* Image does not contain a background color with which
8111 to combine the image data via an alpha channel. Use
8112 the frame's background instead. */
8115 png_color_16 frame_background
;
8117 cmap
= FRAME_X_COLORMAP (f
);
8118 color
.pixel
= FRAME_BACKGROUND_PIXEL (f
);
8119 x_query_color (f
, &color
);
8121 bzero (&frame_background
, sizeof frame_background
);
8122 frame_background
.red
= color
.red
;
8123 frame_background
.green
= color
.green
;
8124 frame_background
.blue
= color
.blue
;
8126 png_set_background (png_ptr
, &frame_background
,
8127 PNG_BACKGROUND_GAMMA_SCREEN
, 0, 1.0);
8131 /* Update info structure. */
8132 png_read_update_info (png_ptr
, info_ptr
);
8134 /* Get number of channels. Valid values are 1 for grayscale images
8135 and images with a palette, 2 for grayscale images with transparency
8136 information (alpha channel), 3 for RGB images, and 4 for RGB
8137 images with alpha channel, i.e. RGBA. If conversions above were
8138 sufficient we should only have 3 or 4 channels here. */
8139 channels
= png_get_channels (png_ptr
, info_ptr
);
8140 xassert (channels
== 3 || channels
== 4);
8142 /* Number of bytes needed for one row of the image. */
8143 row_bytes
= png_get_rowbytes (png_ptr
, info_ptr
);
8145 /* Allocate memory for the image. */
8146 pixels
= (png_byte
*) xmalloc (row_bytes
* height
* sizeof *pixels
);
8147 rows
= (png_byte
**) xmalloc (height
* sizeof *rows
);
8148 for (i
= 0; i
< height
; ++i
)
8149 rows
[i
] = pixels
+ i
* row_bytes
;
8151 /* Read the entire image. */
8152 png_read_image (png_ptr
, rows
);
8153 png_read_end (png_ptr
, info_ptr
);
8160 /* Create the X image and pixmap. */
8161 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
,
8165 /* Create an image and pixmap serving as mask if the PNG image
8166 contains an alpha channel. */
8169 && !x_create_x_image_and_pixmap (f
, width
, height
, 1,
8170 &mask_img
, &img
->mask
))
8172 x_destroy_x_image (ximg
);
8173 XFreePixmap (FRAME_X_DISPLAY (f
), img
->pixmap
);
8178 /* Fill the X image and mask from PNG data. */
8179 init_color_table ();
8181 for (y
= 0; y
< height
; ++y
)
8183 png_byte
*p
= rows
[y
];
8185 for (x
= 0; x
< width
; ++x
)
8192 XPutPixel (ximg
, x
, y
, lookup_rgb_color (f
, r
, g
, b
));
8194 /* An alpha channel, aka mask channel, associates variable
8195 transparency with an image. Where other image formats
8196 support binary transparency---fully transparent or fully
8197 opaque---PNG allows up to 254 levels of partial transparency.
8198 The PNG library implements partial transparency by combining
8199 the image with a specified background color.
8201 I'm not sure how to handle this here nicely: because the
8202 background on which the image is displayed may change, for
8203 real alpha channel support, it would be necessary to create
8204 a new image for each possible background.
8206 What I'm doing now is that a mask is created if we have
8207 boolean transparency information. Otherwise I'm using
8208 the frame's background color to combine the image with. */
8213 XPutPixel (mask_img
, x
, y
, *p
> 0);
8219 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
8220 /* Set IMG's background color from the PNG image, unless the user
8224 if (png_get_bKGD (png_ptr
, info_ptr
, &bg
))
8226 img
->background
= lookup_rgb_color (f
, bg
->red
, bg
->green
, bg
->blue
);
8227 img
->background_valid
= 1;
8231 /* Remember colors allocated for this image. */
8232 img
->colors
= colors_in_color_table (&img
->ncolors
);
8233 free_color_table ();
8236 png_destroy_read_struct (&png_ptr
, &info_ptr
, &end_info
);
8241 img
->height
= height
;
8243 /* Maybe fill in the background field while we have ximg handy. */
8244 IMAGE_BACKGROUND (img
, f
, ximg
);
8246 /* Put the image into the pixmap, then free the X image and its buffer. */
8247 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8248 x_destroy_x_image (ximg
);
8250 /* Same for the mask. */
8253 /* Fill in the background_transparent field while we have the mask
8255 image_background_transparent (img
, f
, mask_img
);
8257 x_put_x_image (f
, mask_img
, img
->mask
, img
->width
, img
->height
);
8258 x_destroy_x_image (mask_img
);
8265 #endif /* HAVE_PNG != 0 */
8269 /***********************************************************************
8271 ***********************************************************************/
8275 /* Work around a warning about HAVE_STDLIB_H being redefined in
8277 #ifdef HAVE_STDLIB_H
8278 #define HAVE_STDLIB_H_1
8279 #undef HAVE_STDLIB_H
8280 #endif /* HAVE_STLIB_H */
8282 #include <jpeglib.h>
8286 #ifdef HAVE_STLIB_H_1
8287 #define HAVE_STDLIB_H 1
8290 static int jpeg_image_p
P_ ((Lisp_Object object
));
8291 static int jpeg_load
P_ ((struct frame
*f
, struct image
*img
));
8293 /* The symbol `jpeg' identifying images of this type. */
8297 /* Indices of image specification fields in gs_format, below. */
8299 enum jpeg_keyword_index
8308 JPEG_HEURISTIC_MASK
,
8314 /* Vector of image_keyword structures describing the format
8315 of valid user-defined image specifications. */
8317 static struct image_keyword jpeg_format
[JPEG_LAST
] =
8319 {":type", IMAGE_SYMBOL_VALUE
, 1},
8320 {":data", IMAGE_STRING_VALUE
, 0},
8321 {":file", IMAGE_STRING_VALUE
, 0},
8322 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8323 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
8324 {":relief", IMAGE_INTEGER_VALUE
, 0},
8325 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8326 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8327 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8328 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8331 /* Structure describing the image type `jpeg'. */
8333 static struct image_type jpeg_type
=
8343 /* Return non-zero if OBJECT is a valid JPEG image specification. */
8346 jpeg_image_p (object
)
8349 struct image_keyword fmt
[JPEG_LAST
];
8351 bcopy (jpeg_format
, fmt
, sizeof fmt
);
8353 if (!parse_image_spec (object
, fmt
, JPEG_LAST
, Qjpeg
))
8356 /* Must specify either the :data or :file keyword. */
8357 return fmt
[JPEG_FILE
].count
+ fmt
[JPEG_DATA
].count
== 1;
8361 struct my_jpeg_error_mgr
8363 struct jpeg_error_mgr pub
;
8364 jmp_buf setjmp_buffer
;
8369 my_error_exit (cinfo
)
8372 struct my_jpeg_error_mgr
*mgr
= (struct my_jpeg_error_mgr
*) cinfo
->err
;
8373 longjmp (mgr
->setjmp_buffer
, 1);
8377 /* Init source method for JPEG data source manager. Called by
8378 jpeg_read_header() before any data is actually read. See
8379 libjpeg.doc from the JPEG lib distribution. */
8382 our_init_source (cinfo
)
8383 j_decompress_ptr cinfo
;
8388 /* Fill input buffer method for JPEG data source manager. Called
8389 whenever more data is needed. We read the whole image in one step,
8390 so this only adds a fake end of input marker at the end. */
8393 our_fill_input_buffer (cinfo
)
8394 j_decompress_ptr cinfo
;
8396 /* Insert a fake EOI marker. */
8397 struct jpeg_source_mgr
*src
= cinfo
->src
;
8398 static JOCTET buffer
[2];
8400 buffer
[0] = (JOCTET
) 0xFF;
8401 buffer
[1] = (JOCTET
) JPEG_EOI
;
8403 src
->next_input_byte
= buffer
;
8404 src
->bytes_in_buffer
= 2;
8409 /* Method to skip over NUM_BYTES bytes in the image data. CINFO->src
8410 is the JPEG data source manager. */
8413 our_skip_input_data (cinfo
, num_bytes
)
8414 j_decompress_ptr cinfo
;
8417 struct jpeg_source_mgr
*src
= (struct jpeg_source_mgr
*) cinfo
->src
;
8421 if (num_bytes
> src
->bytes_in_buffer
)
8422 ERREXIT (cinfo
, JERR_INPUT_EOF
);
8424 src
->bytes_in_buffer
-= num_bytes
;
8425 src
->next_input_byte
+= num_bytes
;
8430 /* Method to terminate data source. Called by
8431 jpeg_finish_decompress() after all data has been processed. */
8434 our_term_source (cinfo
)
8435 j_decompress_ptr cinfo
;
8440 /* Set up the JPEG lib for reading an image from DATA which contains
8441 LEN bytes. CINFO is the decompression info structure created for
8442 reading the image. */
8445 jpeg_memory_src (cinfo
, data
, len
)
8446 j_decompress_ptr cinfo
;
8450 struct jpeg_source_mgr
*src
;
8452 if (cinfo
->src
== NULL
)
8454 /* First time for this JPEG object? */
8455 cinfo
->src
= (struct jpeg_source_mgr
*)
8456 (*cinfo
->mem
->alloc_small
) ((j_common_ptr
) cinfo
, JPOOL_PERMANENT
,
8457 sizeof (struct jpeg_source_mgr
));
8458 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
8459 src
->next_input_byte
= data
;
8462 src
= (struct jpeg_source_mgr
*) cinfo
->src
;
8463 src
->init_source
= our_init_source
;
8464 src
->fill_input_buffer
= our_fill_input_buffer
;
8465 src
->skip_input_data
= our_skip_input_data
;
8466 src
->resync_to_restart
= jpeg_resync_to_restart
; /* Use default method. */
8467 src
->term_source
= our_term_source
;
8468 src
->bytes_in_buffer
= len
;
8469 src
->next_input_byte
= data
;
8473 /* Load image IMG for use on frame F. Patterned after example.c
8474 from the JPEG lib. */
8481 struct jpeg_decompress_struct cinfo
;
8482 struct my_jpeg_error_mgr mgr
;
8483 Lisp_Object file
, specified_file
;
8484 Lisp_Object specified_data
;
8485 FILE * volatile fp
= NULL
;
8487 int row_stride
, x
, y
;
8488 XImage
*ximg
= NULL
;
8490 unsigned long *colors
;
8492 struct gcpro gcpro1
;
8494 /* Open the JPEG file. */
8495 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
8496 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8500 if (NILP (specified_data
))
8502 file
= x_find_image_file (specified_file
);
8503 if (!STRINGP (file
))
8505 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
8510 fp
= fopen (SDATA (file
), "r");
8513 image_error ("Cannot open `%s'", file
, Qnil
);
8519 /* Customize libjpeg's error handling to call my_error_exit when an
8520 error is detected. This function will perform a longjmp. */
8521 cinfo
.err
= jpeg_std_error (&mgr
.pub
);
8522 mgr
.pub
.error_exit
= my_error_exit
;
8524 if ((rc
= setjmp (mgr
.setjmp_buffer
)) != 0)
8528 /* Called from my_error_exit. Display a JPEG error. */
8529 char buffer
[JMSG_LENGTH_MAX
];
8530 cinfo
.err
->format_message ((j_common_ptr
) &cinfo
, buffer
);
8531 image_error ("Error reading JPEG image `%s': %s", img
->spec
,
8532 build_string (buffer
));
8535 /* Close the input file and destroy the JPEG object. */
8537 fclose ((FILE *) fp
);
8538 jpeg_destroy_decompress (&cinfo
);
8540 /* If we already have an XImage, free that. */
8541 x_destroy_x_image (ximg
);
8543 /* Free pixmap and colors. */
8544 x_clear_image (f
, img
);
8550 /* Create the JPEG decompression object. Let it read from fp.
8551 Read the JPEG image header. */
8552 jpeg_create_decompress (&cinfo
);
8554 if (NILP (specified_data
))
8555 jpeg_stdio_src (&cinfo
, (FILE *) fp
);
8557 jpeg_memory_src (&cinfo
, SDATA (specified_data
),
8558 SBYTES (specified_data
));
8560 jpeg_read_header (&cinfo
, TRUE
);
8562 /* Customize decompression so that color quantization will be used.
8563 Start decompression. */
8564 cinfo
.quantize_colors
= TRUE
;
8565 jpeg_start_decompress (&cinfo
);
8566 width
= img
->width
= cinfo
.output_width
;
8567 height
= img
->height
= cinfo
.output_height
;
8569 /* Create X image and pixmap. */
8570 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
8571 longjmp (mgr
.setjmp_buffer
, 2);
8573 /* Allocate colors. When color quantization is used,
8574 cinfo.actual_number_of_colors has been set with the number of
8575 colors generated, and cinfo.colormap is a two-dimensional array
8576 of color indices in the range 0..cinfo.actual_number_of_colors.
8577 No more than 255 colors will be generated. */
8581 if (cinfo
.out_color_components
> 2)
8582 ir
= 0, ig
= 1, ib
= 2;
8583 else if (cinfo
.out_color_components
> 1)
8584 ir
= 0, ig
= 1, ib
= 0;
8586 ir
= 0, ig
= 0, ib
= 0;
8588 /* Use the color table mechanism because it handles colors that
8589 cannot be allocated nicely. Such colors will be replaced with
8590 a default color, and we don't have to care about which colors
8591 can be freed safely, and which can't. */
8592 init_color_table ();
8593 colors
= (unsigned long *) alloca (cinfo
.actual_number_of_colors
8596 for (i
= 0; i
< cinfo
.actual_number_of_colors
; ++i
)
8598 /* Multiply RGB values with 255 because X expects RGB values
8599 in the range 0..0xffff. */
8600 int r
= cinfo
.colormap
[ir
][i
] << 8;
8601 int g
= cinfo
.colormap
[ig
][i
] << 8;
8602 int b
= cinfo
.colormap
[ib
][i
] << 8;
8603 colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
8606 /* Remember those colors actually allocated. */
8607 img
->colors
= colors_in_color_table (&img
->ncolors
);
8608 free_color_table ();
8612 row_stride
= width
* cinfo
.output_components
;
8613 buffer
= cinfo
.mem
->alloc_sarray ((j_common_ptr
) &cinfo
, JPOOL_IMAGE
,
8615 for (y
= 0; y
< height
; ++y
)
8617 jpeg_read_scanlines (&cinfo
, buffer
, 1);
8618 for (x
= 0; x
< cinfo
.output_width
; ++x
)
8619 XPutPixel (ximg
, x
, y
, colors
[buffer
[0][x
]]);
8623 jpeg_finish_decompress (&cinfo
);
8624 jpeg_destroy_decompress (&cinfo
);
8626 fclose ((FILE *) fp
);
8628 /* Maybe fill in the background field while we have ximg handy. */
8629 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
8630 IMAGE_BACKGROUND (img
, f
, ximg
);
8632 /* Put the image into the pixmap. */
8633 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8634 x_destroy_x_image (ximg
);
8639 #endif /* HAVE_JPEG */
8643 /***********************************************************************
8645 ***********************************************************************/
8651 static int tiff_image_p
P_ ((Lisp_Object object
));
8652 static int tiff_load
P_ ((struct frame
*f
, struct image
*img
));
8654 /* The symbol `tiff' identifying images of this type. */
8658 /* Indices of image specification fields in tiff_format, below. */
8660 enum tiff_keyword_index
8669 TIFF_HEURISTIC_MASK
,
8675 /* Vector of image_keyword structures describing the format
8676 of valid user-defined image specifications. */
8678 static struct image_keyword tiff_format
[TIFF_LAST
] =
8680 {":type", IMAGE_SYMBOL_VALUE
, 1},
8681 {":data", IMAGE_STRING_VALUE
, 0},
8682 {":file", IMAGE_STRING_VALUE
, 0},
8683 {":ascent", IMAGE_ASCENT_VALUE
, 0},
8684 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
8685 {":relief", IMAGE_INTEGER_VALUE
, 0},
8686 {":conversions", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8687 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8688 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
8689 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
8692 /* Structure describing the image type `tiff'. */
8694 static struct image_type tiff_type
=
8704 /* Return non-zero if OBJECT is a valid TIFF image specification. */
8707 tiff_image_p (object
)
8710 struct image_keyword fmt
[TIFF_LAST
];
8711 bcopy (tiff_format
, fmt
, sizeof fmt
);
8713 if (!parse_image_spec (object
, fmt
, TIFF_LAST
, Qtiff
))
8716 /* Must specify either the :data or :file keyword. */
8717 return fmt
[TIFF_FILE
].count
+ fmt
[TIFF_DATA
].count
== 1;
8721 /* Reading from a memory buffer for TIFF images Based on the PNG
8722 memory source, but we have to provide a lot of extra functions.
8725 We really only need to implement read and seek, but I am not
8726 convinced that the TIFF library is smart enough not to destroy
8727 itself if we only hand it the function pointers we need to
8732 unsigned char *bytes
;
8740 tiff_read_from_memory (data
, buf
, size
)
8745 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
8747 if (size
> src
->len
- src
->index
)
8749 bcopy (src
->bytes
+ src
->index
, buf
, size
);
8756 tiff_write_from_memory (data
, buf
, size
)
8766 tiff_seek_in_memory (data
, off
, whence
)
8771 tiff_memory_source
*src
= (tiff_memory_source
*) data
;
8776 case SEEK_SET
: /* Go from beginning of source. */
8780 case SEEK_END
: /* Go from end of source. */
8781 idx
= src
->len
+ off
;
8784 case SEEK_CUR
: /* Go from current position. */
8785 idx
= src
->index
+ off
;
8788 default: /* Invalid `whence'. */
8792 if (idx
> src
->len
|| idx
< 0)
8801 tiff_close_memory (data
)
8810 tiff_mmap_memory (data
, pbase
, psize
)
8815 /* It is already _IN_ memory. */
8821 tiff_unmap_memory (data
, base
, size
)
8826 /* We don't need to do this. */
8831 tiff_size_of_memory (data
)
8834 return ((tiff_memory_source
*) data
)->len
;
8839 tiff_error_handler (title
, format
, ap
)
8840 const char *title
, *format
;
8846 len
= sprintf (buf
, "TIFF error: %s ", title
);
8847 vsprintf (buf
+ len
, format
, ap
);
8848 add_to_log (buf
, Qnil
, Qnil
);
8853 tiff_warning_handler (title
, format
, ap
)
8854 const char *title
, *format
;
8860 len
= sprintf (buf
, "TIFF warning: %s ", title
);
8861 vsprintf (buf
+ len
, format
, ap
);
8862 add_to_log (buf
, Qnil
, Qnil
);
8866 /* Load TIFF image IMG for use on frame F. Value is non-zero if
8874 Lisp_Object file
, specified_file
;
8875 Lisp_Object specified_data
;
8877 int width
, height
, x
, y
;
8881 struct gcpro gcpro1
;
8882 tiff_memory_source memsrc
;
8884 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
8885 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
8889 TIFFSetErrorHandler (tiff_error_handler
);
8890 TIFFSetWarningHandler (tiff_warning_handler
);
8892 if (NILP (specified_data
))
8894 /* Read from a file */
8895 file
= x_find_image_file (specified_file
);
8896 if (!STRINGP (file
))
8898 image_error ("Cannot find image file `%s'", file
, Qnil
);
8903 /* Try to open the image file. */
8904 tiff
= TIFFOpen (SDATA (file
), "r");
8907 image_error ("Cannot open `%s'", file
, Qnil
);
8914 /* Memory source! */
8915 memsrc
.bytes
= SDATA (specified_data
);
8916 memsrc
.len
= SBYTES (specified_data
);
8919 tiff
= TIFFClientOpen ("memory_source", "r", &memsrc
,
8920 (TIFFReadWriteProc
) tiff_read_from_memory
,
8921 (TIFFReadWriteProc
) tiff_write_from_memory
,
8922 tiff_seek_in_memory
,
8924 tiff_size_of_memory
,
8930 image_error ("Cannot open memory source for `%s'", img
->spec
, Qnil
);
8936 /* Get width and height of the image, and allocate a raster buffer
8937 of width x height 32-bit values. */
8938 TIFFGetField (tiff
, TIFFTAG_IMAGEWIDTH
, &width
);
8939 TIFFGetField (tiff
, TIFFTAG_IMAGELENGTH
, &height
);
8940 buf
= (uint32
*) xmalloc (width
* height
* sizeof *buf
);
8942 rc
= TIFFReadRGBAImage (tiff
, width
, height
, buf
, 0);
8946 image_error ("Error reading TIFF image `%s'", img
->spec
, Qnil
);
8952 /* Create the X image and pixmap. */
8953 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
8960 /* Initialize the color table. */
8961 init_color_table ();
8963 /* Process the pixel raster. Origin is in the lower-left corner. */
8964 for (y
= 0; y
< height
; ++y
)
8966 uint32
*row
= buf
+ y
* width
;
8968 for (x
= 0; x
< width
; ++x
)
8970 uint32 abgr
= row
[x
];
8971 int r
= TIFFGetR (abgr
) << 8;
8972 int g
= TIFFGetG (abgr
) << 8;
8973 int b
= TIFFGetB (abgr
) << 8;
8974 XPutPixel (ximg
, x
, height
- 1 - y
, lookup_rgb_color (f
, r
, g
, b
));
8978 /* Remember the colors allocated for the image. Free the color table. */
8979 img
->colors
= colors_in_color_table (&img
->ncolors
);
8980 free_color_table ();
8983 img
->height
= height
;
8985 /* Maybe fill in the background field while we have ximg handy. */
8986 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
8987 IMAGE_BACKGROUND (img
, f
, ximg
);
8989 /* Put the image into the pixmap, then free the X image and its buffer. */
8990 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
8991 x_destroy_x_image (ximg
);
8998 #endif /* HAVE_TIFF != 0 */
9002 /***********************************************************************
9004 ***********************************************************************/
9008 #include <gif_lib.h>
9010 static int gif_image_p
P_ ((Lisp_Object object
));
9011 static int gif_load
P_ ((struct frame
*f
, struct image
*img
));
9013 /* The symbol `gif' identifying images of this type. */
9017 /* Indices of image specification fields in gif_format, below. */
9019 enum gif_keyword_index
9035 /* Vector of image_keyword structures describing the format
9036 of valid user-defined image specifications. */
9038 static struct image_keyword gif_format
[GIF_LAST
] =
9040 {":type", IMAGE_SYMBOL_VALUE
, 1},
9041 {":data", IMAGE_STRING_VALUE
, 0},
9042 {":file", IMAGE_STRING_VALUE
, 0},
9043 {":ascent", IMAGE_ASCENT_VALUE
, 0},
9044 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
9045 {":relief", IMAGE_INTEGER_VALUE
, 0},
9046 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
9047 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
9048 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
9049 {":image", IMAGE_NON_NEGATIVE_INTEGER_VALUE
, 0},
9050 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
9053 /* Structure describing the image type `gif'. */
9055 static struct image_type gif_type
=
9065 /* Return non-zero if OBJECT is a valid GIF image specification. */
9068 gif_image_p (object
)
9071 struct image_keyword fmt
[GIF_LAST
];
9072 bcopy (gif_format
, fmt
, sizeof fmt
);
9074 if (!parse_image_spec (object
, fmt
, GIF_LAST
, Qgif
))
9077 /* Must specify either the :data or :file keyword. */
9078 return fmt
[GIF_FILE
].count
+ fmt
[GIF_DATA
].count
== 1;
9082 /* Reading a GIF image from memory
9083 Based on the PNG memory stuff to a certain extent. */
9087 unsigned char *bytes
;
9094 /* Make the current memory source available to gif_read_from_memory.
9095 It's done this way because not all versions of libungif support
9096 a UserData field in the GifFileType structure. */
9097 static gif_memory_source
*current_gif_memory_src
;
9100 gif_read_from_memory (file
, buf
, len
)
9105 gif_memory_source
*src
= current_gif_memory_src
;
9107 if (len
> src
->len
- src
->index
)
9110 bcopy (src
->bytes
+ src
->index
, buf
, len
);
9116 /* Load GIF image IMG for use on frame F. Value is non-zero if
9124 Lisp_Object file
, specified_file
;
9125 Lisp_Object specified_data
;
9126 int rc
, width
, height
, x
, y
, i
;
9128 ColorMapObject
*gif_color_map
;
9129 unsigned long pixel_colors
[256];
9131 struct gcpro gcpro1
;
9133 int ino
, image_left
, image_top
, image_width
, image_height
;
9134 gif_memory_source memsrc
;
9135 unsigned char *raster
;
9137 specified_file
= image_spec_value (img
->spec
, QCfile
, NULL
);
9138 specified_data
= image_spec_value (img
->spec
, QCdata
, NULL
);
9142 if (NILP (specified_data
))
9144 file
= x_find_image_file (specified_file
);
9145 if (!STRINGP (file
))
9147 image_error ("Cannot find image file `%s'", specified_file
, Qnil
);
9152 /* Open the GIF file. */
9153 gif
= DGifOpenFileName (SDATA (file
));
9156 image_error ("Cannot open `%s'", file
, Qnil
);
9163 /* Read from memory! */
9164 current_gif_memory_src
= &memsrc
;
9165 memsrc
.bytes
= SDATA (specified_data
);
9166 memsrc
.len
= SBYTES (specified_data
);
9169 gif
= DGifOpen (&memsrc
, gif_read_from_memory
);
9172 image_error ("Cannot open memory source `%s'", img
->spec
, Qnil
);
9178 /* Read entire contents. */
9179 rc
= DGifSlurp (gif
);
9180 if (rc
== GIF_ERROR
)
9182 image_error ("Error reading `%s'", img
->spec
, Qnil
);
9183 DGifCloseFile (gif
);
9188 image
= image_spec_value (img
->spec
, QCindex
, NULL
);
9189 ino
= INTEGERP (image
) ? XFASTINT (image
) : 0;
9190 if (ino
>= gif
->ImageCount
)
9192 image_error ("Invalid image number `%s' in image `%s'",
9194 DGifCloseFile (gif
);
9199 width
= img
->width
= max (gif
->SWidth
, gif
->Image
.Left
+ gif
->Image
.Width
);
9200 height
= img
->height
= max (gif
->SHeight
, gif
->Image
.Top
+ gif
->Image
.Height
);
9202 /* Create the X image and pixmap. */
9203 if (!x_create_x_image_and_pixmap (f
, width
, height
, 0, &ximg
, &img
->pixmap
))
9205 DGifCloseFile (gif
);
9210 /* Allocate colors. */
9211 gif_color_map
= gif
->SavedImages
[ino
].ImageDesc
.ColorMap
;
9213 gif_color_map
= gif
->SColorMap
;
9214 init_color_table ();
9215 bzero (pixel_colors
, sizeof pixel_colors
);
9217 for (i
= 0; i
< gif_color_map
->ColorCount
; ++i
)
9219 int r
= gif_color_map
->Colors
[i
].Red
<< 8;
9220 int g
= gif_color_map
->Colors
[i
].Green
<< 8;
9221 int b
= gif_color_map
->Colors
[i
].Blue
<< 8;
9222 pixel_colors
[i
] = lookup_rgb_color (f
, r
, g
, b
);
9225 img
->colors
= colors_in_color_table (&img
->ncolors
);
9226 free_color_table ();
9228 /* Clear the part of the screen image that are not covered by
9229 the image from the GIF file. Full animated GIF support
9230 requires more than can be done here (see the gif89 spec,
9231 disposal methods). Let's simply assume that the part
9232 not covered by a sub-image is in the frame's background color. */
9233 image_top
= gif
->SavedImages
[ino
].ImageDesc
.Top
;
9234 image_left
= gif
->SavedImages
[ino
].ImageDesc
.Left
;
9235 image_width
= gif
->SavedImages
[ino
].ImageDesc
.Width
;
9236 image_height
= gif
->SavedImages
[ino
].ImageDesc
.Height
;
9238 for (y
= 0; y
< image_top
; ++y
)
9239 for (x
= 0; x
< width
; ++x
)
9240 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
9242 for (y
= image_top
+ image_height
; y
< height
; ++y
)
9243 for (x
= 0; x
< width
; ++x
)
9244 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
9246 for (y
= image_top
; y
< image_top
+ image_height
; ++y
)
9248 for (x
= 0; x
< image_left
; ++x
)
9249 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
9250 for (x
= image_left
+ image_width
; x
< width
; ++x
)
9251 XPutPixel (ximg
, x
, y
, FRAME_BACKGROUND_PIXEL (f
));
9254 /* Read the GIF image into the X image. We use a local variable
9255 `raster' here because RasterBits below is a char *, and invites
9256 problems with bytes >= 0x80. */
9257 raster
= (unsigned char *) gif
->SavedImages
[ino
].RasterBits
;
9259 if (gif
->SavedImages
[ino
].ImageDesc
.Interlace
)
9261 static int interlace_start
[] = {0, 4, 2, 1};
9262 static int interlace_increment
[] = {8, 8, 4, 2};
9264 int row
= interlace_start
[0];
9268 for (y
= 0; y
< image_height
; y
++)
9270 if (row
>= image_height
)
9272 row
= interlace_start
[++pass
];
9273 while (row
>= image_height
)
9274 row
= interlace_start
[++pass
];
9277 for (x
= 0; x
< image_width
; x
++)
9279 int i
= raster
[(y
* image_width
) + x
];
9280 XPutPixel (ximg
, x
+ image_left
, row
+ image_top
,
9284 row
+= interlace_increment
[pass
];
9289 for (y
= 0; y
< image_height
; ++y
)
9290 for (x
= 0; x
< image_width
; ++x
)
9292 int i
= raster
[y
* image_width
+ x
];
9293 XPutPixel (ximg
, x
+ image_left
, y
+ image_top
, pixel_colors
[i
]);
9297 DGifCloseFile (gif
);
9299 /* Maybe fill in the background field while we have ximg handy. */
9300 if (NILP (image_spec_value (img
->spec
, QCbackground
, NULL
)))
9301 IMAGE_BACKGROUND (img
, f
, ximg
);
9303 /* Put the image into the pixmap, then free the X image and its buffer. */
9304 x_put_x_image (f
, ximg
, img
->pixmap
, width
, height
);
9305 x_destroy_x_image (ximg
);
9311 #endif /* HAVE_GIF != 0 */
9315 /***********************************************************************
9317 ***********************************************************************/
9319 static int gs_image_p
P_ ((Lisp_Object object
));
9320 static int gs_load
P_ ((struct frame
*f
, struct image
*img
));
9321 static void gs_clear_image
P_ ((struct frame
*f
, struct image
*img
));
9323 /* The symbol `postscript' identifying images of this type. */
9325 Lisp_Object Qpostscript
;
9327 /* Keyword symbols. */
9329 Lisp_Object QCloader
, QCbounding_box
, QCpt_width
, QCpt_height
;
9331 /* Indices of image specification fields in gs_format, below. */
9333 enum gs_keyword_index
9351 /* Vector of image_keyword structures describing the format
9352 of valid user-defined image specifications. */
9354 static struct image_keyword gs_format
[GS_LAST
] =
9356 {":type", IMAGE_SYMBOL_VALUE
, 1},
9357 {":pt-width", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
9358 {":pt-height", IMAGE_POSITIVE_INTEGER_VALUE
, 1},
9359 {":file", IMAGE_STRING_VALUE
, 1},
9360 {":loader", IMAGE_FUNCTION_VALUE
, 0},
9361 {":bounding-box", IMAGE_DONT_CHECK_VALUE_TYPE
, 1},
9362 {":ascent", IMAGE_ASCENT_VALUE
, 0},
9363 {":margin", IMAGE_POSITIVE_INTEGER_VALUE_OR_PAIR
, 0},
9364 {":relief", IMAGE_INTEGER_VALUE
, 0},
9365 {":conversion", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
9366 {":heuristic-mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
9367 {":mask", IMAGE_DONT_CHECK_VALUE_TYPE
, 0},
9368 {":background", IMAGE_STRING_OR_NIL_VALUE
, 0}
9371 /* Structure describing the image type `ghostscript'. */
9373 static struct image_type gs_type
=
9383 /* Free X resources of Ghostscript image IMG which is used on frame F. */
9386 gs_clear_image (f
, img
)
9390 /* IMG->data.ptr_val may contain a recorded colormap. */
9391 xfree (img
->data
.ptr_val
);
9392 x_clear_image (f
, img
);
9396 /* Return non-zero if OBJECT is a valid Ghostscript image
9403 struct image_keyword fmt
[GS_LAST
];
9407 bcopy (gs_format
, fmt
, sizeof fmt
);
9409 if (!parse_image_spec (object
, fmt
, GS_LAST
, Qpostscript
))
9412 /* Bounding box must be a list or vector containing 4 integers. */
9413 tem
= fmt
[GS_BOUNDING_BOX
].value
;
9416 for (i
= 0; i
< 4; ++i
, tem
= XCDR (tem
))
9417 if (!CONSP (tem
) || !INTEGERP (XCAR (tem
)))
9422 else if (VECTORP (tem
))
9424 if (XVECTOR (tem
)->size
!= 4)
9426 for (i
= 0; i
< 4; ++i
)
9427 if (!INTEGERP (XVECTOR (tem
)->contents
[i
]))
9437 /* Load Ghostscript image IMG for use on frame F. Value is non-zero
9446 Lisp_Object window_and_pixmap_id
= Qnil
, loader
, pt_height
, pt_width
;
9447 struct gcpro gcpro1
, gcpro2
;
9449 double in_width
, in_height
;
9450 Lisp_Object pixel_colors
= Qnil
;
9452 /* Compute pixel size of pixmap needed from the given size in the
9453 image specification. Sizes in the specification are in pt. 1 pt
9454 = 1/72 in, xdpi and ydpi are stored in the frame's X display
9456 pt_width
= image_spec_value (img
->spec
, QCpt_width
, NULL
);
9457 in_width
= XFASTINT (pt_width
) / 72.0;
9458 img
->width
= in_width
* FRAME_X_DISPLAY_INFO (f
)->resx
;
9459 pt_height
= image_spec_value (img
->spec
, QCpt_height
, NULL
);
9460 in_height
= XFASTINT (pt_height
) / 72.0;
9461 img
->height
= in_height
* FRAME_X_DISPLAY_INFO (f
)->resy
;
9463 /* Create the pixmap. */
9464 xassert (img
->pixmap
== None
);
9465 img
->pixmap
= XCreatePixmap (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
9466 img
->width
, img
->height
,
9467 DefaultDepthOfScreen (FRAME_X_SCREEN (f
)));
9471 image_error ("Unable to create pixmap for `%s'", img
->spec
, Qnil
);
9475 /* Call the loader to fill the pixmap. It returns a process object
9476 if successful. We do not record_unwind_protect here because
9477 other places in redisplay like calling window scroll functions
9478 don't either. Let the Lisp loader use `unwind-protect' instead. */
9479 GCPRO2 (window_and_pixmap_id
, pixel_colors
);
9481 sprintf (buffer
, "%lu %lu",
9482 (unsigned long) FRAME_X_WINDOW (f
),
9483 (unsigned long) img
->pixmap
);
9484 window_and_pixmap_id
= build_string (buffer
);
9486 sprintf (buffer
, "%lu %lu",
9487 FRAME_FOREGROUND_PIXEL (f
),
9488 FRAME_BACKGROUND_PIXEL (f
));
9489 pixel_colors
= build_string (buffer
);
9491 XSETFRAME (frame
, f
);
9492 loader
= image_spec_value (img
->spec
, QCloader
, NULL
);
9494 loader
= intern ("gs-load-image");
9496 img
->data
.lisp_val
= call6 (loader
, frame
, img
->spec
,
9497 make_number (img
->width
),
9498 make_number (img
->height
),
9499 window_and_pixmap_id
,
9502 return PROCESSP (img
->data
.lisp_val
);
9506 /* Kill the Ghostscript process that was started to fill PIXMAP on
9507 frame F. Called from XTread_socket when receiving an event
9508 telling Emacs that Ghostscript has finished drawing. */
9511 x_kill_gs_process (pixmap
, f
)
9515 struct image_cache
*c
= FRAME_X_IMAGE_CACHE (f
);
9519 /* Find the image containing PIXMAP. */
9520 for (i
= 0; i
< c
->used
; ++i
)
9521 if (c
->images
[i
]->pixmap
== pixmap
)
9524 /* Should someone in between have cleared the image cache, for
9525 instance, give up. */
9529 /* Kill the GS process. We should have found PIXMAP in the image
9530 cache and its image should contain a process object. */
9532 xassert (PROCESSP (img
->data
.lisp_val
));
9533 Fkill_process (img
->data
.lisp_val
, Qnil
);
9534 img
->data
.lisp_val
= Qnil
;
9536 /* On displays with a mutable colormap, figure out the colors
9537 allocated for the image by looking at the pixels of an XImage for
9539 class = FRAME_X_VISUAL (f
)->class;
9540 if (class != StaticColor
&& class != StaticGray
&& class != TrueColor
)
9546 /* Try to get an XImage for img->pixmep. */
9547 ximg
= XGetImage (FRAME_X_DISPLAY (f
), img
->pixmap
,
9548 0, 0, img
->width
, img
->height
, ~0, ZPixmap
);
9553 /* Initialize the color table. */
9554 init_color_table ();
9556 /* For each pixel of the image, look its color up in the
9557 color table. After having done so, the color table will
9558 contain an entry for each color used by the image. */
9559 for (y
= 0; y
< img
->height
; ++y
)
9560 for (x
= 0; x
< img
->width
; ++x
)
9562 unsigned long pixel
= XGetPixel (ximg
, x
, y
);
9563 lookup_pixel_color (f
, pixel
);
9566 /* Record colors in the image. Free color table and XImage. */
9567 img
->colors
= colors_in_color_table (&img
->ncolors
);
9568 free_color_table ();
9569 XDestroyImage (ximg
);
9571 #if 0 /* This doesn't seem to be the case. If we free the colors
9572 here, we get a BadAccess later in x_clear_image when
9573 freeing the colors. */
9574 /* We have allocated colors once, but Ghostscript has also
9575 allocated colors on behalf of us. So, to get the
9576 reference counts right, free them once. */
9578 x_free_colors (f
, img
->colors
, img
->ncolors
);
9582 image_error ("Cannot get X image of `%s'; colors will not be freed",
9588 /* Now that we have the pixmap, compute mask and transform the
9589 image if requested. */
9591 postprocess_image (f
, img
);
9597 /***********************************************************************
9599 ***********************************************************************/
9601 DEFUN ("x-change-window-property", Fx_change_window_property
,
9602 Sx_change_window_property
, 2, 3, 0,
9603 doc
: /* Change window property PROP to VALUE on the X window of FRAME.
9604 PROP and VALUE must be strings. FRAME nil or omitted means use the
9605 selected frame. Value is VALUE. */)
9606 (prop
, value
, frame
)
9607 Lisp_Object frame
, prop
, value
;
9609 struct frame
*f
= check_x_frame (frame
);
9612 CHECK_STRING (prop
);
9613 CHECK_STRING (value
);
9616 prop_atom
= XInternAtom (FRAME_X_DISPLAY (f
), SDATA (prop
), False
);
9617 XChangeProperty (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
9618 prop_atom
, XA_STRING
, 8, PropModeReplace
,
9619 SDATA (value
), SCHARS (value
));
9621 /* Make sure the property is set when we return. */
9622 XFlush (FRAME_X_DISPLAY (f
));
9629 DEFUN ("x-delete-window-property", Fx_delete_window_property
,
9630 Sx_delete_window_property
, 1, 2, 0,
9631 doc
: /* Remove window property PROP from X window of FRAME.
9632 FRAME nil or omitted means use the selected frame. Value is PROP. */)
9634 Lisp_Object prop
, frame
;
9636 struct frame
*f
= check_x_frame (frame
);
9639 CHECK_STRING (prop
);
9641 prop_atom
= XInternAtom (FRAME_X_DISPLAY (f
), SDATA (prop
), False
);
9642 XDeleteProperty (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
), prop_atom
);
9644 /* Make sure the property is removed when we return. */
9645 XFlush (FRAME_X_DISPLAY (f
));
9652 DEFUN ("x-window-property", Fx_window_property
, Sx_window_property
,
9654 doc
: /* Value is the value of window property PROP on FRAME.
9655 If FRAME is nil or omitted, use the selected frame. Value is nil
9656 if FRAME hasn't a property with name PROP or if PROP has no string
9659 Lisp_Object prop
, frame
;
9661 struct frame
*f
= check_x_frame (frame
);
9664 Lisp_Object prop_value
= Qnil
;
9665 char *tmp_data
= NULL
;
9668 unsigned long actual_size
, bytes_remaining
;
9670 CHECK_STRING (prop
);
9672 prop_atom
= XInternAtom (FRAME_X_DISPLAY (f
), SDATA (prop
), False
);
9673 rc
= XGetWindowProperty (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
9674 prop_atom
, 0, 0, False
, XA_STRING
,
9675 &actual_type
, &actual_format
, &actual_size
,
9676 &bytes_remaining
, (unsigned char **) &tmp_data
);
9679 int size
= bytes_remaining
;
9684 rc
= XGetWindowProperty (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
9685 prop_atom
, 0, bytes_remaining
,
9687 &actual_type
, &actual_format
,
9688 &actual_size
, &bytes_remaining
,
9689 (unsigned char **) &tmp_data
);
9690 if (rc
== Success
&& tmp_data
)
9691 prop_value
= make_string (tmp_data
, size
);
9702 /***********************************************************************
9704 ***********************************************************************/
9706 /* If non-null, an asynchronous timer that, when it expires, displays
9707 an hourglass cursor on all frames. */
9709 static struct atimer
*hourglass_atimer
;
9711 /* Non-zero means an hourglass cursor is currently shown. */
9713 static int hourglass_shown_p
;
9715 /* Number of seconds to wait before displaying an hourglass cursor. */
9717 static Lisp_Object Vhourglass_delay
;
9719 /* Default number of seconds to wait before displaying an hourglass
9722 #define DEFAULT_HOURGLASS_DELAY 1
9724 /* Function prototypes. */
9726 static void show_hourglass
P_ ((struct atimer
*));
9727 static void hide_hourglass
P_ ((void));
9730 /* Cancel a currently active hourglass timer, and start a new one. */
9736 int secs
, usecs
= 0;
9738 cancel_hourglass ();
9740 if (INTEGERP (Vhourglass_delay
)
9741 && XINT (Vhourglass_delay
) > 0)
9742 secs
= XFASTINT (Vhourglass_delay
);
9743 else if (FLOATP (Vhourglass_delay
)
9744 && XFLOAT_DATA (Vhourglass_delay
) > 0)
9747 tem
= Ftruncate (Vhourglass_delay
, Qnil
);
9748 secs
= XFASTINT (tem
);
9749 usecs
= (XFLOAT_DATA (Vhourglass_delay
) - secs
) * 1000000;
9752 secs
= DEFAULT_HOURGLASS_DELAY
;
9754 EMACS_SET_SECS_USECS (delay
, secs
, usecs
);
9755 hourglass_atimer
= start_atimer (ATIMER_RELATIVE
, delay
,
9756 show_hourglass
, NULL
);
9760 /* Cancel the hourglass cursor timer if active, hide a busy cursor if
9766 if (hourglass_atimer
)
9768 cancel_atimer (hourglass_atimer
);
9769 hourglass_atimer
= NULL
;
9772 if (hourglass_shown_p
)
9777 /* Timer function of hourglass_atimer. TIMER is equal to
9780 Display an hourglass pointer on all frames by mapping the frames'
9781 hourglass_window. Set the hourglass_p flag in the frames'
9782 output_data.x structure to indicate that an hourglass cursor is
9783 shown on the frames. */
9786 show_hourglass (timer
)
9787 struct atimer
*timer
;
9789 /* The timer implementation will cancel this timer automatically
9790 after this function has run. Set hourglass_atimer to null
9791 so that we know the timer doesn't have to be canceled. */
9792 hourglass_atimer
= NULL
;
9794 if (!hourglass_shown_p
)
9796 Lisp_Object rest
, frame
;
9800 FOR_EACH_FRAME (rest
, frame
)
9802 struct frame
*f
= XFRAME (frame
);
9804 if (FRAME_LIVE_P (f
) && FRAME_X_P (f
) && FRAME_X_DISPLAY (f
))
9806 Display
*dpy
= FRAME_X_DISPLAY (f
);
9808 #ifdef USE_X_TOOLKIT
9809 if (f
->output_data
.x
->widget
)
9811 if (FRAME_OUTER_WINDOW (f
))
9814 f
->output_data
.x
->hourglass_p
= 1;
9816 if (!f
->output_data
.x
->hourglass_window
)
9818 unsigned long mask
= CWCursor
;
9819 XSetWindowAttributes attrs
;
9821 attrs
.cursor
= f
->output_data
.x
->hourglass_cursor
;
9823 f
->output_data
.x
->hourglass_window
9824 = XCreateWindow (dpy
, FRAME_OUTER_WINDOW (f
),
9825 0, 0, 32000, 32000, 0, 0,
9831 XMapRaised (dpy
, f
->output_data
.x
->hourglass_window
);
9837 hourglass_shown_p
= 1;
9843 /* Hide the hourglass pointer on all frames, if it is currently
9849 if (hourglass_shown_p
)
9851 Lisp_Object rest
, frame
;
9854 FOR_EACH_FRAME (rest
, frame
)
9856 struct frame
*f
= XFRAME (frame
);
9859 /* Watch out for newly created frames. */
9860 && f
->output_data
.x
->hourglass_window
)
9862 XUnmapWindow (FRAME_X_DISPLAY (f
),
9863 f
->output_data
.x
->hourglass_window
);
9864 /* Sync here because XTread_socket looks at the
9865 hourglass_p flag that is reset to zero below. */
9866 XSync (FRAME_X_DISPLAY (f
), False
);
9867 f
->output_data
.x
->hourglass_p
= 0;
9871 hourglass_shown_p
= 0;
9878 /***********************************************************************
9880 ***********************************************************************/
9882 static Lisp_Object x_create_tip_frame
P_ ((struct x_display_info
*,
9883 Lisp_Object
, Lisp_Object
));
9884 static void compute_tip_xy
P_ ((struct frame
*, Lisp_Object
, Lisp_Object
,
9885 Lisp_Object
, int, int, int *, int *));
9887 /* The frame of a currently visible tooltip. */
9889 Lisp_Object tip_frame
;
9891 /* If non-nil, a timer started that hides the last tooltip when it
9894 Lisp_Object tip_timer
;
9897 /* If non-nil, a vector of 3 elements containing the last args
9898 with which x-show-tip was called. See there. */
9900 Lisp_Object last_show_tip_args
;
9902 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
9904 Lisp_Object Vx_max_tooltip_size
;
9908 unwind_create_tip_frame (frame
)
9911 Lisp_Object deleted
;
9913 deleted
= unwind_create_frame (frame
);
9914 if (EQ (deleted
, Qt
))
9924 /* Create a frame for a tooltip on the display described by DPYINFO.
9925 PARMS is a list of frame parameters. TEXT is the string to
9926 display in the tip frame. Value is the frame.
9928 Note that functions called here, esp. x_default_parameter can
9929 signal errors, for instance when a specified color name is
9930 undefined. We have to make sure that we're in a consistent state
9931 when this happens. */
9934 x_create_tip_frame (dpyinfo
, parms
, text
)
9935 struct x_display_info
*dpyinfo
;
9936 Lisp_Object parms
, text
;
9939 Lisp_Object frame
, tem
;
9941 long window_prompting
= 0;
9943 int count
= SPECPDL_INDEX ();
9944 struct gcpro gcpro1
, gcpro2
, gcpro3
;
9946 int face_change_count_before
= face_change_count
;
9948 struct buffer
*old_buffer
;
9952 /* Use this general default value to start with until we know if
9953 this frame has a specified name. */
9954 Vx_resource_name
= Vinvocation_name
;
9957 kb
= dpyinfo
->kboard
;
9959 kb
= &the_only_kboard
;
9962 /* Get the name of the frame to use for resource lookup. */
9963 name
= x_get_arg (dpyinfo
, parms
, Qname
, "name", "Name", RES_TYPE_STRING
);
9965 && !EQ (name
, Qunbound
)
9967 error ("Invalid frame name--not a string or nil");
9968 Vx_resource_name
= name
;
9971 GCPRO3 (parms
, name
, frame
);
9973 XSETFRAME (frame
, f
);
9975 buffer
= Fget_buffer_create (build_string (" *tip*"));
9976 Fset_window_buffer (FRAME_ROOT_WINDOW (f
), buffer
, Qnil
);
9977 old_buffer
= current_buffer
;
9978 set_buffer_internal_1 (XBUFFER (buffer
));
9979 current_buffer
->truncate_lines
= Qnil
;
9982 set_buffer_internal_1 (old_buffer
);
9984 FRAME_CAN_HAVE_SCROLL_BARS (f
) = 0;
9985 record_unwind_protect (unwind_create_tip_frame
, frame
);
9987 f
->display_method
= &x_display_method
;
9989 /* By setting the output method, we're essentially saying that
9990 the frame is live, as per FRAME_LIVE_P. If we get a signal
9991 from this point on, x_destroy_window might screw up reference
9993 f
->output_method
= output_x_window
;
9994 f
->output_data
.x
= (struct x_output
*) xmalloc (sizeof (struct x_output
));
9995 bzero (f
->output_data
.x
, sizeof (struct x_output
));
9996 f
->output_data
.x
->icon_bitmap
= -1;
9997 FRAME_FONTSET (f
) = -1;
9998 f
->output_data
.x
->scroll_bar_foreground_pixel
= -1;
9999 f
->output_data
.x
->scroll_bar_background_pixel
= -1;
10000 #ifdef USE_TOOLKIT_SCROLL_BARS
10001 f
->output_data
.x
->scroll_bar_top_shadow_pixel
= -1;
10002 f
->output_data
.x
->scroll_bar_bottom_shadow_pixel
= -1;
10003 #endif /* USE_TOOLKIT_SCROLL_BARS */
10004 f
->icon_name
= Qnil
;
10005 FRAME_X_DISPLAY_INFO (f
) = dpyinfo
;
10007 image_cache_refcount
= FRAME_X_IMAGE_CACHE (f
)->refcount
;
10008 dpyinfo_refcount
= dpyinfo
->reference_count
;
10009 #endif /* GLYPH_DEBUG */
10010 #ifdef MULTI_KBOARD
10011 FRAME_KBOARD (f
) = kb
;
10013 f
->output_data
.x
->parent_desc
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
10014 f
->output_data
.x
->explicit_parent
= 0;
10016 /* These colors will be set anyway later, but it's important
10017 to get the color reference counts right, so initialize them! */
10020 struct gcpro gcpro1
;
10022 black
= build_string ("black");
10024 f
->output_data
.x
->foreground_pixel
10025 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
10026 f
->output_data
.x
->background_pixel
10027 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
10028 f
->output_data
.x
->cursor_pixel
10029 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
10030 f
->output_data
.x
->cursor_foreground_pixel
10031 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
10032 f
->output_data
.x
->border_pixel
10033 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
10034 f
->output_data
.x
->mouse_pixel
10035 = x_decode_color (f
, black
, BLACK_PIX_DEFAULT (f
));
10039 /* Set the name; the functions to which we pass f expect the name to
10041 if (EQ (name
, Qunbound
) || NILP (name
))
10043 f
->name
= build_string (dpyinfo
->x_id_name
);
10044 f
->explicit_name
= 0;
10049 f
->explicit_name
= 1;
10050 /* use the frame's title when getting resources for this frame. */
10051 specbind (Qx_resource_name
, name
);
10054 /* Extract the window parameters from the supplied values that are
10055 needed to determine window geometry. */
10059 font
= x_get_arg (dpyinfo
, parms
, Qfont
, "font", "Font", RES_TYPE_STRING
);
10062 /* First, try whatever font the caller has specified. */
10063 if (STRINGP (font
))
10065 tem
= Fquery_fontset (font
, Qnil
);
10067 font
= x_new_fontset (f
, SDATA (tem
));
10069 font
= x_new_font (f
, SDATA (font
));
10072 /* Try out a font which we hope has bold and italic variations. */
10073 if (!STRINGP (font
))
10074 font
= x_new_font (f
, "-adobe-courier-medium-r-*-*-*-120-*-*-*-*-iso8859-1");
10075 if (!STRINGP (font
))
10076 font
= x_new_font (f
, "-misc-fixed-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10077 if (! STRINGP (font
))
10078 font
= x_new_font (f
, "-*-*-medium-r-normal-*-*-140-*-*-c-*-iso8859-1");
10079 if (! STRINGP (font
))
10080 /* This was formerly the first thing tried, but it finds too many fonts
10081 and takes too long. */
10082 font
= x_new_font (f
, "-*-*-medium-r-*-*-*-*-*-*-c-*-iso8859-1");
10083 /* If those didn't work, look for something which will at least work. */
10084 if (! STRINGP (font
))
10085 font
= x_new_font (f
, "-*-fixed-*-*-*-*-*-140-*-*-c-*-iso8859-1");
10087 if (! STRINGP (font
))
10088 font
= build_string ("fixed");
10090 x_default_parameter (f
, parms
, Qfont
, font
,
10091 "font", "Font", RES_TYPE_STRING
);
10094 x_default_parameter (f
, parms
, Qborder_width
, make_number (2),
10095 "borderWidth", "BorderWidth", RES_TYPE_NUMBER
);
10097 /* This defaults to 2 in order to match xterm. We recognize either
10098 internalBorderWidth or internalBorder (which is what xterm calls
10100 if (NILP (Fassq (Qinternal_border_width
, parms
)))
10104 value
= x_get_arg (dpyinfo
, parms
, Qinternal_border_width
,
10105 "internalBorder", "internalBorder", RES_TYPE_NUMBER
);
10106 if (! EQ (value
, Qunbound
))
10107 parms
= Fcons (Fcons (Qinternal_border_width
, value
),
10111 x_default_parameter (f
, parms
, Qinternal_border_width
, make_number (1),
10112 "internalBorderWidth", "internalBorderWidth",
10115 /* Also do the stuff which must be set before the window exists. */
10116 x_default_parameter (f
, parms
, Qforeground_color
, build_string ("black"),
10117 "foreground", "Foreground", RES_TYPE_STRING
);
10118 x_default_parameter (f
, parms
, Qbackground_color
, build_string ("white"),
10119 "background", "Background", RES_TYPE_STRING
);
10120 x_default_parameter (f
, parms
, Qmouse_color
, build_string ("black"),
10121 "pointerColor", "Foreground", RES_TYPE_STRING
);
10122 x_default_parameter (f
, parms
, Qcursor_color
, build_string ("black"),
10123 "cursorColor", "Foreground", RES_TYPE_STRING
);
10124 x_default_parameter (f
, parms
, Qborder_color
, build_string ("black"),
10125 "borderColor", "BorderColor", RES_TYPE_STRING
);
10127 /* Init faces before x_default_parameter is called for scroll-bar
10128 parameters because that function calls x_set_scroll_bar_width,
10129 which calls change_frame_size, which calls Fset_window_buffer,
10130 which runs hooks, which call Fvertical_motion. At the end, we
10131 end up in init_iterator with a null face cache, which should not
10133 init_frame_faces (f
);
10135 f
->output_data
.x
->parent_desc
= FRAME_X_DISPLAY_INFO (f
)->root_window
;
10137 window_prompting
= x_figure_window_size (f
, parms
, 0);
10140 XSetWindowAttributes attrs
;
10141 unsigned long mask
;
10144 mask
= CWBackPixel
| CWOverrideRedirect
| CWEventMask
;
10145 if (DoesSaveUnders (dpyinfo
->screen
))
10146 mask
|= CWSaveUnder
;
10148 /* Window managers look at the override-redirect flag to determine
10149 whether or net to give windows a decoration (Xlib spec, chapter
10151 attrs
.override_redirect
= True
;
10152 attrs
.save_under
= True
;
10153 attrs
.background_pixel
= FRAME_BACKGROUND_PIXEL (f
);
10154 /* Arrange for getting MapNotify and UnmapNotify events. */
10155 attrs
.event_mask
= StructureNotifyMask
;
10157 = FRAME_X_WINDOW (f
)
10158 = XCreateWindow (FRAME_X_DISPLAY (f
),
10159 FRAME_X_DISPLAY_INFO (f
)->root_window
,
10160 /* x, y, width, height */
10164 CopyFromParent
, InputOutput
, CopyFromParent
,
10171 x_default_parameter (f
, parms
, Qauto_raise
, Qnil
,
10172 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN
);
10173 x_default_parameter (f
, parms
, Qauto_lower
, Qnil
,
10174 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN
);
10175 x_default_parameter (f
, parms
, Qcursor_type
, Qbox
,
10176 "cursorType", "CursorType", RES_TYPE_SYMBOL
);
10178 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
10179 Change will not be effected unless different from the current
10180 FRAME_LINES (f). */
10181 width
= FRAME_COLS (f
);
10182 height
= FRAME_LINES (f
);
10183 SET_FRAME_COLS (f
, 0);
10184 FRAME_LINES (f
) = 0;
10185 change_frame_size (f
, height
, width
, 1, 0, 0);
10187 /* Add `tooltip' frame parameter's default value. */
10188 if (NILP (Fframe_parameter (frame
, intern ("tooltip"))))
10189 Fmodify_frame_parameters (frame
, Fcons (Fcons (intern ("tooltip"), Qt
),
10192 /* Set up faces after all frame parameters are known. This call
10193 also merges in face attributes specified for new frames.
10195 Frame parameters may be changed if .Xdefaults contains
10196 specifications for the default font. For example, if there is an
10197 `Emacs.default.attributeBackground: pink', the `background-color'
10198 attribute of the frame get's set, which let's the internal border
10199 of the tooltip frame appear in pink. Prevent this. */
10201 Lisp_Object bg
= Fframe_parameter (frame
, Qbackground_color
);
10203 /* Set tip_frame here, so that */
10205 call1 (Qface_set_after_frame_default
, frame
);
10207 if (!EQ (bg
, Fframe_parameter (frame
, Qbackground_color
)))
10208 Fmodify_frame_parameters (frame
, Fcons (Fcons (Qbackground_color
, bg
),
10216 /* It is now ok to make the frame official even if we get an error
10217 below. And the frame needs to be on Vframe_list or making it
10218 visible won't work. */
10219 Vframe_list
= Fcons (frame
, Vframe_list
);
10221 /* Now that the frame is official, it counts as a reference to
10223 FRAME_X_DISPLAY_INFO (f
)->reference_count
++;
10225 /* Setting attributes of faces of the tooltip frame from resources
10226 and similar will increment face_change_count, which leads to the
10227 clearing of all current matrices. Since this isn't necessary
10228 here, avoid it by resetting face_change_count to the value it
10229 had before we created the tip frame. */
10230 face_change_count
= face_change_count_before
;
10232 /* Discard the unwind_protect. */
10233 return unbind_to (count
, frame
);
10237 /* Compute where to display tip frame F. PARMS is the list of frame
10238 parameters for F. DX and DY are specified offsets from the current
10239 location of the mouse. WIDTH and HEIGHT are the width and height
10240 of the tooltip. Return coordinates relative to the root window of
10241 the display in *ROOT_X, and *ROOT_Y. */
10244 compute_tip_xy (f
, parms
, dx
, dy
, width
, height
, root_x
, root_y
)
10246 Lisp_Object parms
, dx
, dy
;
10248 int *root_x
, *root_y
;
10250 Lisp_Object left
, top
;
10252 Window root
, child
;
10255 /* User-specified position? */
10256 left
= Fcdr (Fassq (Qleft
, parms
));
10257 top
= Fcdr (Fassq (Qtop
, parms
));
10259 /* Move the tooltip window where the mouse pointer is. Resize and
10261 if (!INTEGERP (left
) || !INTEGERP (top
))
10264 XQueryPointer (FRAME_X_DISPLAY (f
), FRAME_X_DISPLAY_INFO (f
)->root_window
,
10265 &root
, &child
, root_x
, root_y
, &win_x
, &win_y
, &pmask
);
10269 if (INTEGERP (top
))
10270 *root_y
= XINT (top
);
10271 else if (*root_y
+ XINT (dy
) - height
< 0)
10272 *root_y
-= XINT (dy
);
10276 *root_y
+= XINT (dy
);
10279 if (INTEGERP (left
))
10280 *root_x
= XINT (left
);
10281 else if (*root_x
+ XINT (dx
) + width
<= FRAME_X_DISPLAY_INFO (f
)->width
)
10282 /* It fits to the right of the pointer. */
10283 *root_x
+= XINT (dx
);
10284 else if (width
+ XINT (dx
) <= *root_x
)
10285 /* It fits to the left of the pointer. */
10286 *root_x
-= width
+ XINT (dx
);
10288 /* Put it left-justified on the screen--it ought to fit that way. */
10293 DEFUN ("x-show-tip", Fx_show_tip
, Sx_show_tip
, 1, 6, 0,
10294 doc
: /* Show STRING in a "tooltip" window on frame FRAME.
10295 A tooltip window is a small X window displaying a string.
10297 FRAME nil or omitted means use the selected frame.
10299 PARMS is an optional list of frame parameters which can be used to
10300 change the tooltip's appearance.
10302 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
10303 means use the default timeout of 5 seconds.
10305 If the list of frame parameters PARAMS contains a `left' parameters,
10306 the tooltip is displayed at that x-position. Otherwise it is
10307 displayed at the mouse position, with offset DX added (default is 5 if
10308 DX isn't specified). Likewise for the y-position; if a `top' frame
10309 parameter is specified, it determines the y-position of the tooltip
10310 window, otherwise it is displayed at the mouse position, with offset
10311 DY added (default is -10).
10313 A tooltip's maximum size is specified by `x-max-tooltip-size'.
10314 Text larger than the specified size is clipped. */)
10315 (string
, frame
, parms
, timeout
, dx
, dy
)
10316 Lisp_Object string
, frame
, parms
, timeout
, dx
, dy
;
10320 int root_x
, root_y
;
10321 struct buffer
*old_buffer
;
10322 struct text_pos pos
;
10323 int i
, width
, height
;
10324 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10325 int old_windows_or_buffers_changed
= windows_or_buffers_changed
;
10326 int count
= SPECPDL_INDEX ();
10328 specbind (Qinhibit_redisplay
, Qt
);
10330 GCPRO4 (string
, parms
, frame
, timeout
);
10332 CHECK_STRING (string
);
10333 f
= check_x_frame (frame
);
10334 if (NILP (timeout
))
10335 timeout
= make_number (5);
10337 CHECK_NATNUM (timeout
);
10340 dx
= make_number (5);
10345 dy
= make_number (-10);
10349 if (NILP (last_show_tip_args
))
10350 last_show_tip_args
= Fmake_vector (make_number (3), Qnil
);
10352 if (!NILP (tip_frame
))
10354 Lisp_Object last_string
= AREF (last_show_tip_args
, 0);
10355 Lisp_Object last_frame
= AREF (last_show_tip_args
, 1);
10356 Lisp_Object last_parms
= AREF (last_show_tip_args
, 2);
10358 if (EQ (frame
, last_frame
)
10359 && !NILP (Fequal (last_string
, string
))
10360 && !NILP (Fequal (last_parms
, parms
)))
10362 struct frame
*f
= XFRAME (tip_frame
);
10364 /* Only DX and DY have changed. */
10365 if (!NILP (tip_timer
))
10367 Lisp_Object timer
= tip_timer
;
10369 call1 (Qcancel_timer
, timer
);
10373 compute_tip_xy (f
, parms
, dx
, dy
, FRAME_PIXEL_WIDTH (f
),
10374 FRAME_PIXEL_HEIGHT (f
), &root_x
, &root_y
);
10375 XMoveWindow (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
10382 /* Hide a previous tip, if any. */
10385 ASET (last_show_tip_args
, 0, string
);
10386 ASET (last_show_tip_args
, 1, frame
);
10387 ASET (last_show_tip_args
, 2, parms
);
10389 /* Add default values to frame parameters. */
10390 if (NILP (Fassq (Qname
, parms
)))
10391 parms
= Fcons (Fcons (Qname
, build_string ("tooltip")), parms
);
10392 if (NILP (Fassq (Qinternal_border_width
, parms
)))
10393 parms
= Fcons (Fcons (Qinternal_border_width
, make_number (3)), parms
);
10394 if (NILP (Fassq (Qborder_width
, parms
)))
10395 parms
= Fcons (Fcons (Qborder_width
, make_number (1)), parms
);
10396 if (NILP (Fassq (Qborder_color
, parms
)))
10397 parms
= Fcons (Fcons (Qborder_color
, build_string ("lightyellow")), parms
);
10398 if (NILP (Fassq (Qbackground_color
, parms
)))
10399 parms
= Fcons (Fcons (Qbackground_color
, build_string ("lightyellow")),
10402 /* Create a frame for the tooltip, and record it in the global
10403 variable tip_frame. */
10404 frame
= x_create_tip_frame (FRAME_X_DISPLAY_INFO (f
), parms
, string
);
10405 f
= XFRAME (frame
);
10407 /* Set up the frame's root window. */
10408 w
= XWINDOW (FRAME_ROOT_WINDOW (f
));
10409 w
->left_col
= w
->top_line
= make_number (0);
10411 if (CONSP (Vx_max_tooltip_size
)
10412 && INTEGERP (XCAR (Vx_max_tooltip_size
))
10413 && XINT (XCAR (Vx_max_tooltip_size
)) > 0
10414 && INTEGERP (XCDR (Vx_max_tooltip_size
))
10415 && XINT (XCDR (Vx_max_tooltip_size
)) > 0)
10417 w
->total_cols
= XCAR (Vx_max_tooltip_size
);
10418 w
->total_lines
= XCDR (Vx_max_tooltip_size
);
10422 w
->total_cols
= make_number (80);
10423 w
->total_lines
= make_number (40);
10426 FRAME_TOTAL_COLS (f
) = XINT (w
->total_cols
);
10428 w
->pseudo_window_p
= 1;
10430 /* Display the tooltip text in a temporary buffer. */
10431 old_buffer
= current_buffer
;
10432 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f
))->buffer
));
10433 current_buffer
->truncate_lines
= Qnil
;
10434 clear_glyph_matrix (w
->desired_matrix
);
10435 clear_glyph_matrix (w
->current_matrix
);
10436 SET_TEXT_POS (pos
, BEGV
, BEGV_BYTE
);
10437 try_window (FRAME_ROOT_WINDOW (f
), pos
);
10439 /* Compute width and height of the tooltip. */
10440 width
= height
= 0;
10441 for (i
= 0; i
< w
->desired_matrix
->nrows
; ++i
)
10443 struct glyph_row
*row
= &w
->desired_matrix
->rows
[i
];
10444 struct glyph
*last
;
10447 /* Stop at the first empty row at the end. */
10448 if (!row
->enabled_p
|| !row
->displays_text_p
)
10451 /* Let the row go over the full width of the frame. */
10452 row
->full_width_p
= 1;
10454 /* There's a glyph at the end of rows that is used to place
10455 the cursor there. Don't include the width of this glyph. */
10456 if (row
->used
[TEXT_AREA
])
10458 last
= &row
->glyphs
[TEXT_AREA
][row
->used
[TEXT_AREA
] - 1];
10459 row_width
= row
->pixel_width
- last
->pixel_width
;
10462 row_width
= row
->pixel_width
;
10464 height
+= row
->height
;
10465 width
= max (width
, row_width
);
10468 /* Add the frame's internal border to the width and height the X
10469 window should have. */
10470 height
+= 2 * FRAME_INTERNAL_BORDER_WIDTH (f
);
10471 width
+= 2 * FRAME_INTERNAL_BORDER_WIDTH (f
);
10473 /* Move the tooltip window where the mouse pointer is. Resize and
10475 compute_tip_xy (f
, parms
, dx
, dy
, width
, height
, &root_x
, &root_y
);
10478 XMoveResizeWindow (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
),
10479 root_x
, root_y
, width
, height
);
10480 XMapRaised (FRAME_X_DISPLAY (f
), FRAME_X_WINDOW (f
));
10483 /* Draw into the window. */
10484 w
->must_be_updated_p
= 1;
10485 update_single_window (w
, 1);
10487 /* Restore original current buffer. */
10488 set_buffer_internal_1 (old_buffer
);
10489 windows_or_buffers_changed
= old_windows_or_buffers_changed
;
10492 /* Let the tip disappear after timeout seconds. */
10493 tip_timer
= call3 (intern ("run-at-time"), timeout
, Qnil
,
10494 intern ("x-hide-tip"));
10497 return unbind_to (count
, Qnil
);
10501 DEFUN ("x-hide-tip", Fx_hide_tip
, Sx_hide_tip
, 0, 0, 0,
10502 doc
: /* Hide the current tooltip window, if there is any.
10503 Value is t if tooltip was open, nil otherwise. */)
10507 Lisp_Object deleted
, frame
, timer
;
10508 struct gcpro gcpro1
, gcpro2
;
10510 /* Return quickly if nothing to do. */
10511 if (NILP (tip_timer
) && NILP (tip_frame
))
10516 GCPRO2 (frame
, timer
);
10517 tip_frame
= tip_timer
= deleted
= Qnil
;
10519 count
= SPECPDL_INDEX ();
10520 specbind (Qinhibit_redisplay
, Qt
);
10521 specbind (Qinhibit_quit
, Qt
);
10524 call1 (Qcancel_timer
, timer
);
10526 if (FRAMEP (frame
))
10528 Fdelete_frame (frame
, Qnil
);
10532 /* Bloodcurdling hack alert: The Lucid menu bar widget's
10533 redisplay procedure is not called when a tip frame over menu
10534 items is unmapped. Redisplay the menu manually... */
10536 struct frame
*f
= SELECTED_FRAME ();
10537 Widget w
= f
->output_data
.x
->menubar_widget
;
10538 extern void xlwmenu_redisplay
P_ ((Widget
));
10540 if (!DoesSaveUnders (FRAME_X_DISPLAY_INFO (f
)->screen
)
10544 xlwmenu_redisplay (w
);
10548 #endif /* USE_LUCID */
10552 return unbind_to (count
, deleted
);
10557 /***********************************************************************
10558 File selection dialog
10559 ***********************************************************************/
10563 /* Callback for "OK" and "Cancel" on file selection dialog. */
10566 file_dialog_cb (widget
, client_data
, call_data
)
10568 XtPointer call_data
, client_data
;
10570 int *result
= (int *) client_data
;
10571 XmAnyCallbackStruct
*cb
= (XmAnyCallbackStruct
*) call_data
;
10572 *result
= cb
->reason
;
10576 /* Callback for unmapping a file selection dialog. This is used to
10577 capture the case where a dialog is closed via a window manager's
10578 closer button, for example. Using a XmNdestroyCallback didn't work
10582 file_dialog_unmap_cb (widget
, client_data
, call_data
)
10584 XtPointer call_data
, client_data
;
10586 int *result
= (int *) client_data
;
10587 *result
= XmCR_CANCEL
;
10591 DEFUN ("x-file-dialog", Fx_file_dialog
, Sx_file_dialog
, 2, 4, 0,
10592 doc
: /* Read file name, prompting with PROMPT in directory DIR.
10593 Use a file selection dialog.
10594 Select DEFAULT-FILENAME in the dialog's file selection box, if
10595 specified. Don't let the user enter a file name in the file
10596 selection dialog's entry field, if MUSTMATCH is non-nil. */)
10597 (prompt
, dir
, default_filename
, mustmatch
)
10598 Lisp_Object prompt
, dir
, default_filename
, mustmatch
;
10601 struct frame
*f
= SELECTED_FRAME ();
10602 Lisp_Object file
= Qnil
;
10603 Widget dialog
, text
, list
, help
;
10606 extern XtAppContext Xt_app_con
;
10607 XmString dir_xmstring
, pattern_xmstring
;
10608 int count
= SPECPDL_INDEX ();
10609 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
10611 GCPRO5 (prompt
, dir
, default_filename
, mustmatch
, file
);
10612 CHECK_STRING (prompt
);
10613 CHECK_STRING (dir
);
10615 /* Prevent redisplay. */
10616 specbind (Qinhibit_redisplay
, Qt
);
10620 /* Create the dialog with PROMPT as title, using DIR as initial
10621 directory and using "*" as pattern. */
10622 dir
= Fexpand_file_name (dir
, Qnil
);
10623 dir_xmstring
= XmStringCreateLocalized (SDATA (dir
));
10624 pattern_xmstring
= XmStringCreateLocalized ("*");
10626 XtSetArg (al
[ac
], XmNtitle
, SDATA (prompt
)); ++ac
;
10627 XtSetArg (al
[ac
], XmNdirectory
, dir_xmstring
); ++ac
;
10628 XtSetArg (al
[ac
], XmNpattern
, pattern_xmstring
); ++ac
;
10629 XtSetArg (al
[ac
], XmNresizePolicy
, XmRESIZE_GROW
); ++ac
;
10630 XtSetArg (al
[ac
], XmNdialogStyle
, XmDIALOG_APPLICATION_MODAL
); ++ac
;
10631 dialog
= XmCreateFileSelectionDialog (f
->output_data
.x
->widget
,
10633 XmStringFree (dir_xmstring
);
10634 XmStringFree (pattern_xmstring
);
10636 /* Add callbacks for OK and Cancel. */
10637 XtAddCallback (dialog
, XmNokCallback
, file_dialog_cb
,
10638 (XtPointer
) &result
);
10639 XtAddCallback (dialog
, XmNcancelCallback
, file_dialog_cb
,
10640 (XtPointer
) &result
);
10641 XtAddCallback (dialog
, XmNunmapCallback
, file_dialog_unmap_cb
,
10642 (XtPointer
) &result
);
10644 /* Disable the help button since we can't display help. */
10645 help
= XmFileSelectionBoxGetChild (dialog
, XmDIALOG_HELP_BUTTON
);
10646 XtSetSensitive (help
, False
);
10648 /* Mark OK button as default. */
10649 XtVaSetValues (XmFileSelectionBoxGetChild (dialog
, XmDIALOG_OK_BUTTON
),
10650 XmNshowAsDefault
, True
, NULL
);
10652 /* If MUSTMATCH is non-nil, disable the file entry field of the
10653 dialog, so that the user must select a file from the files list
10654 box. We can't remove it because we wouldn't have a way to get at
10655 the result file name, then. */
10656 text
= XmFileSelectionBoxGetChild (dialog
, XmDIALOG_TEXT
);
10657 if (!NILP (mustmatch
))
10660 label
= XmFileSelectionBoxGetChild (dialog
, XmDIALOG_SELECTION_LABEL
);
10661 XtSetSensitive (text
, False
);
10662 XtSetSensitive (label
, False
);
10665 /* Manage the dialog, so that list boxes get filled. */
10666 XtManageChild (dialog
);
10668 /* Select DEFAULT_FILENAME in the files list box. DEFAULT_FILENAME
10669 must include the path for this to work. */
10670 list
= XmFileSelectionBoxGetChild (dialog
, XmDIALOG_LIST
);
10671 if (STRINGP (default_filename
))
10673 XmString default_xmstring
;
10677 = XmStringCreateLocalized (SDATA (default_filename
));
10679 if (!XmListItemExists (list
, default_xmstring
))
10681 /* Add a new item if DEFAULT_FILENAME is not in the list. */
10682 XmListAddItem (list
, default_xmstring
, 0);
10686 item_pos
= XmListItemPos (list
, default_xmstring
);
10687 XmStringFree (default_xmstring
);
10689 /* Select the item and scroll it into view. */
10690 XmListSelectPos (list
, item_pos
, True
);
10691 XmListSetPos (list
, item_pos
);
10694 /* Process events until the user presses Cancel or OK. */
10696 while (result
== 0)
10699 XtAppNextEvent (Xt_app_con
, &event
);
10700 (void) x_dispatch_event (&event
, FRAME_X_DISPLAY (f
) );
10703 /* Get the result. */
10704 if (result
== XmCR_OK
)
10709 XtVaGetValues (dialog
, XmNtextString
, &text
, NULL
);
10710 XmStringGetLtoR (text
, XmFONTLIST_DEFAULT_TAG
, &data
);
10711 XmStringFree (text
);
10712 file
= build_string (data
);
10719 XtUnmanageChild (dialog
);
10720 XtDestroyWidget (dialog
);
10724 /* Make "Cancel" equivalent to C-g. */
10726 Fsignal (Qquit
, Qnil
);
10728 return unbind_to (count
, file
);
10731 #endif /* USE_MOTIF */
10735 DEFUN ("x-file-dialog", Fx_file_dialog
, Sx_file_dialog
, 2, 4, 0,
10736 "Read file name, prompting with PROMPT in directory DIR.\n\
10737 Use a file selection dialog.\n\
10738 Select DEFAULT-FILENAME in the dialog's file selection box, if\n\
10739 specified. Don't let the user enter a file name in the file\n\
10740 selection dialog's entry field, if MUSTMATCH is non-nil.")
10741 (prompt
, dir
, default_filename
, mustmatch
)
10742 Lisp_Object prompt
, dir
, default_filename
, mustmatch
;
10744 FRAME_PTR f
= SELECTED_FRAME ();
10746 Lisp_Object file
= Qnil
;
10747 int count
= specpdl_ptr
- specpdl
;
10748 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
10752 GCPRO5 (prompt
, dir
, default_filename
, mustmatch
, file
);
10753 CHECK_STRING (prompt
);
10754 CHECK_STRING (dir
);
10756 /* Prevent redisplay. */
10757 specbind (Qinhibit_redisplay
, Qt
);
10761 if (STRINGP (default_filename
))
10762 cdef_file
= SDATA (default_filename
);
10764 cdef_file
= SDATA (dir
);
10766 fn
= xg_get_file_name (f
, SDATA (prompt
), cdef_file
, ! NILP (mustmatch
));
10770 file
= build_string (fn
);
10777 /* Make "Cancel" equivalent to C-g. */
10779 Fsignal (Qquit
, Qnil
);
10781 return unbind_to (count
, file
);
10784 #endif /* USE_GTK */
10787 /***********************************************************************
10789 ***********************************************************************/
10791 #ifdef HAVE_XKBGETKEYBOARD
10792 #include <X11/XKBlib.h>
10793 #include <X11/keysym.h>
10796 DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p
,
10797 Sx_backspace_delete_keys_p
, 0, 1, 0,
10798 doc
: /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
10799 FRAME nil means use the selected frame.
10800 Value is t if we know that both keys are present, and are mapped to the
10801 usual X keysyms. */)
10805 #ifdef HAVE_XKBGETKEYBOARD
10807 struct frame
*f
= check_x_frame (frame
);
10808 Display
*dpy
= FRAME_X_DISPLAY (f
);
10809 Lisp_Object have_keys
;
10810 int major
, minor
, op
, event
, error
;
10814 /* Check library version in case we're dynamically linked. */
10815 major
= XkbMajorVersion
;
10816 minor
= XkbMinorVersion
;
10817 if (!XkbLibraryVersion (&major
, &minor
))
10823 /* Check that the server supports XKB. */
10824 major
= XkbMajorVersion
;
10825 minor
= XkbMinorVersion
;
10826 if (!XkbQueryExtension (dpy
, &op
, &event
, &error
, &major
, &minor
))
10833 kb
= XkbGetMap (dpy
, XkbAllMapComponentsMask
, XkbUseCoreKbd
);
10836 int delete_keycode
= 0, backspace_keycode
= 0, i
;
10838 if (XkbGetNames (dpy
, XkbAllNamesMask
, kb
) == Success
)
10840 for (i
= kb
->min_key_code
;
10841 (i
< kb
->max_key_code
10842 && (delete_keycode
== 0 || backspace_keycode
== 0));
10845 /* The XKB symbolic key names can be seen most easily in
10846 the PS file generated by `xkbprint -label name
10848 if (bcmp ("DELE", kb
->names
->keys
[i
].name
, 4) == 0)
10849 delete_keycode
= i
;
10850 else if (bcmp ("BKSP", kb
->names
->keys
[i
].name
, 4) == 0)
10851 backspace_keycode
= i
;
10854 XkbFreeNames (kb
, 0, True
);
10857 XkbFreeClientMap (kb
, 0, True
);
10860 && backspace_keycode
10861 && XKeysymToKeycode (dpy
, XK_Delete
) == delete_keycode
10862 && XKeysymToKeycode (dpy
, XK_BackSpace
) == backspace_keycode
)
10867 #else /* not HAVE_XKBGETKEYBOARD */
10869 #endif /* not HAVE_XKBGETKEYBOARD */
10874 /***********************************************************************
10876 ***********************************************************************/
10878 /* Keep this list in the same order as frame_parms in frame.c.
10879 Use 0 for unsupported frame parameters. */
10881 frame_parm_handler x_frame_parm_handlers
[] =
10885 x_set_background_color
,
10886 x_set_border_color
,
10887 x_set_border_width
,
10888 x_set_cursor_color
,
10891 x_set_foreground_color
,
10894 x_set_internal_border_width
,
10895 x_set_menu_bar_lines
,
10897 x_explicitly_set_name
,
10898 x_set_scroll_bar_width
,
10900 x_set_unsplittable
,
10901 x_set_vertical_scroll_bars
,
10903 x_set_tool_bar_lines
,
10904 x_set_scroll_bar_foreground
,
10905 x_set_scroll_bar_background
,
10906 x_set_screen_gamma
,
10907 x_set_line_spacing
,
10908 x_set_fringe_width
,
10909 x_set_fringe_width
,
10917 /* This is zero if not using X windows. */
10920 /* The section below is built by the lisp expression at the top of the file,
10921 just above where these variables are declared. */
10922 /*&&& init symbols here &&&*/
10923 Qnone
= intern ("none");
10924 staticpro (&Qnone
);
10925 Qsuppress_icon
= intern ("suppress-icon");
10926 staticpro (&Qsuppress_icon
);
10927 Qundefined_color
= intern ("undefined-color");
10928 staticpro (&Qundefined_color
);
10929 Qcenter
= intern ("center");
10930 staticpro (&Qcenter
);
10931 Qcompound_text
= intern ("compound-text");
10932 staticpro (&Qcompound_text
);
10933 Qcancel_timer
= intern ("cancel-timer");
10934 staticpro (&Qcancel_timer
);
10935 /* This is the end of symbol initialization. */
10937 /* Text property `display' should be nonsticky by default. */
10938 Vtext_property_default_nonsticky
10939 = Fcons (Fcons (Qdisplay
, Qt
), Vtext_property_default_nonsticky
);
10942 Qlaplace
= intern ("laplace");
10943 staticpro (&Qlaplace
);
10944 Qemboss
= intern ("emboss");
10945 staticpro (&Qemboss
);
10946 Qedge_detection
= intern ("edge-detection");
10947 staticpro (&Qedge_detection
);
10948 Qheuristic
= intern ("heuristic");
10949 staticpro (&Qheuristic
);
10950 QCmatrix
= intern (":matrix");
10951 staticpro (&QCmatrix
);
10952 QCcolor_adjustment
= intern (":color-adjustment");
10953 staticpro (&QCcolor_adjustment
);
10954 QCmask
= intern (":mask");
10955 staticpro (&QCmask
);
10957 Fput (Qundefined_color
, Qerror_conditions
,
10958 Fcons (Qundefined_color
, Fcons (Qerror
, Qnil
)));
10959 Fput (Qundefined_color
, Qerror_message
,
10960 build_string ("Undefined color"));
10962 DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images
,
10963 doc
: /* Non-nil means always draw a cross over disabled images.
10964 Disabled images are those having an `:conversion disabled' property.
10965 A cross is always drawn on black & white displays. */);
10966 cross_disabled_images
= 0;
10968 DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path
,
10969 doc
: /* List of directories to search for window system bitmap files. */);
10970 Vx_bitmap_file_path
= decode_env_path ((char *) 0, PATH_BITMAPS
);
10972 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape
,
10973 doc
: /* The shape of the pointer when over text.
10974 Changing the value does not affect existing frames
10975 unless you set the mouse color. */);
10976 Vx_pointer_shape
= Qnil
;
10978 #if 0 /* This doesn't really do anything. */
10979 DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape
,
10980 doc
: /* The shape of the pointer when not over text.
10981 This variable takes effect when you create a new frame
10982 or when you set the mouse color. */);
10984 Vx_nontext_pointer_shape
= Qnil
;
10986 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape
,
10987 doc
: /* The shape of the pointer when Emacs is busy.
10988 This variable takes effect when you create a new frame
10989 or when you set the mouse color. */);
10990 Vx_hourglass_pointer_shape
= Qnil
;
10992 DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
,
10993 doc
: /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
10994 display_hourglass_p
= 1;
10996 DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
,
10997 doc
: /* *Seconds to wait before displaying an hourglass pointer.
10998 Value must be an integer or float. */);
10999 Vhourglass_delay
= make_number (DEFAULT_HOURGLASS_DELAY
);
11001 #if 0 /* This doesn't really do anything. */
11002 DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape
,
11003 doc
: /* The shape of the pointer when over the mode line.
11004 This variable takes effect when you create a new frame
11005 or when you set the mouse color. */);
11007 Vx_mode_pointer_shape
= Qnil
;
11009 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
11010 &Vx_sensitive_text_pointer_shape
,
11011 doc
: /* The shape of the pointer when over mouse-sensitive text.
11012 This variable takes effect when you create a new frame
11013 or when you set the mouse color. */);
11014 Vx_sensitive_text_pointer_shape
= Qnil
;
11016 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
11017 &Vx_window_horizontal_drag_shape
,
11018 doc
: /* Pointer shape to use for indicating a window can be dragged horizontally.
11019 This variable takes effect when you create a new frame
11020 or when you set the mouse color. */);
11021 Vx_window_horizontal_drag_shape
= Qnil
;
11023 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel
,
11024 doc
: /* A string indicating the foreground color of the cursor box. */);
11025 Vx_cursor_fore_pixel
= Qnil
;
11027 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size
,
11028 doc
: /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
11029 Text larger than this is clipped. */);
11030 Vx_max_tooltip_size
= Fcons (make_number (80), make_number (40));
11032 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager
,
11033 doc
: /* Non-nil if no X window manager is in use.
11034 Emacs doesn't try to figure this out; this is always nil
11035 unless you set it to something else. */);
11036 /* We don't have any way to find this out, so set it to nil
11037 and maybe the user would like to set it to t. */
11038 Vx_no_window_manager
= Qnil
;
11040 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
11041 &Vx_pixel_size_width_font_regexp
,
11042 doc
: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
11044 Since Emacs gets width of a font matching with this regexp from
11045 PIXEL_SIZE field of the name, font finding mechanism gets faster for
11046 such a font. This is especially effective for such large fonts as
11047 Chinese, Japanese, and Korean. */);
11048 Vx_pixel_size_width_font_regexp
= Qnil
;
11050 DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay
,
11051 doc
: /* Time after which cached images are removed from the cache.
11052 When an image has not been displayed this many seconds, remove it
11053 from the image cache. Value must be an integer or nil with nil
11054 meaning don't clear the cache. */);
11055 Vimage_cache_eviction_delay
= make_number (30 * 60);
11057 #ifdef USE_X_TOOLKIT
11058 Fprovide (intern ("x-toolkit"), Qnil
);
11060 Fprovide (intern ("motif"), Qnil
);
11062 DEFVAR_LISP ("motif-version-string", &Vmotif_version_string
,
11063 doc
: /* Version info for LessTif/Motif. */);
11064 Vmotif_version_string
= build_string (XmVERSION_STRING
);
11065 #endif /* USE_MOTIF */
11066 #endif /* USE_X_TOOLKIT */
11069 Fprovide (intern ("gtk"), Qnil
);
11071 DEFVAR_LISP ("gtk-version-string", &Vgtk_version_string
,
11072 doc
: /* Version info for GTK+. */);
11074 char gtk_version
[40];
11075 g_snprintf (gtk_version
, sizeof (gtk_version
), "%u.%u.%u",
11076 GTK_MAJOR_VERSION
, GTK_MINOR_VERSION
, GTK_MICRO_VERSION
);
11077 Vgtk_version_string
= build_string (gtk_version
);
11079 #endif /* USE_GTK */
11081 /* X window properties. */
11082 defsubr (&Sx_change_window_property
);
11083 defsubr (&Sx_delete_window_property
);
11084 defsubr (&Sx_window_property
);
11086 defsubr (&Sxw_display_color_p
);
11087 defsubr (&Sx_display_grayscale_p
);
11088 defsubr (&Sxw_color_defined_p
);
11089 defsubr (&Sxw_color_values
);
11090 defsubr (&Sx_server_max_request_size
);
11091 defsubr (&Sx_server_vendor
);
11092 defsubr (&Sx_server_version
);
11093 defsubr (&Sx_display_pixel_width
);
11094 defsubr (&Sx_display_pixel_height
);
11095 defsubr (&Sx_display_mm_width
);
11096 defsubr (&Sx_display_mm_height
);
11097 defsubr (&Sx_display_screens
);
11098 defsubr (&Sx_display_planes
);
11099 defsubr (&Sx_display_color_cells
);
11100 defsubr (&Sx_display_visual_class
);
11101 defsubr (&Sx_display_backing_store
);
11102 defsubr (&Sx_display_save_under
);
11103 defsubr (&Sx_create_frame
);
11104 defsubr (&Sx_open_connection
);
11105 defsubr (&Sx_close_connection
);
11106 defsubr (&Sx_display_list
);
11107 defsubr (&Sx_synchronize
);
11108 defsubr (&Sx_send_client_message
);
11109 defsubr (&Sx_focus_frame
);
11110 defsubr (&Sx_backspace_delete_keys_p
);
11112 /* Setting callback functions for fontset handler. */
11113 get_font_info_func
= x_get_font_info
;
11115 #if 0 /* This function pointer doesn't seem to be used anywhere.
11116 And the pointer assigned has the wrong type, anyway. */
11117 list_fonts_func
= x_list_fonts
;
11120 load_font_func
= x_load_font
;
11121 find_ccl_program_func
= x_find_ccl_program
;
11122 query_font_func
= x_query_font
;
11123 set_frame_fontset_func
= x_set_font
;
11124 check_window_system_func
= check_x
;
11127 Qxbm
= intern ("xbm");
11129 QCconversion
= intern (":conversion");
11130 staticpro (&QCconversion
);
11131 QCheuristic_mask
= intern (":heuristic-mask");
11132 staticpro (&QCheuristic_mask
);
11133 QCcolor_symbols
= intern (":color-symbols");
11134 staticpro (&QCcolor_symbols
);
11135 QCascent
= intern (":ascent");
11136 staticpro (&QCascent
);
11137 QCmargin
= intern (":margin");
11138 staticpro (&QCmargin
);
11139 QCrelief
= intern (":relief");
11140 staticpro (&QCrelief
);
11141 Qpostscript
= intern ("postscript");
11142 staticpro (&Qpostscript
);
11143 QCloader
= intern (":loader");
11144 staticpro (&QCloader
);
11145 QCbounding_box
= intern (":bounding-box");
11146 staticpro (&QCbounding_box
);
11147 QCpt_width
= intern (":pt-width");
11148 staticpro (&QCpt_width
);
11149 QCpt_height
= intern (":pt-height");
11150 staticpro (&QCpt_height
);
11151 QCindex
= intern (":index");
11152 staticpro (&QCindex
);
11153 Qpbm
= intern ("pbm");
11157 Qxpm
= intern ("xpm");
11162 Qjpeg
= intern ("jpeg");
11163 staticpro (&Qjpeg
);
11167 Qtiff
= intern ("tiff");
11168 staticpro (&Qtiff
);
11172 Qgif
= intern ("gif");
11177 Qpng
= intern ("png");
11181 defsubr (&Sclear_image_cache
);
11182 defsubr (&Simage_size
);
11183 defsubr (&Simage_mask_p
);
11185 hourglass_atimer
= NULL
;
11186 hourglass_shown_p
= 0;
11188 defsubr (&Sx_show_tip
);
11189 defsubr (&Sx_hide_tip
);
11191 staticpro (&tip_timer
);
11193 staticpro (&tip_frame
);
11195 last_show_tip_args
= Qnil
;
11196 staticpro (&last_show_tip_args
);
11199 defsubr (&Sx_file_dialog
);
11207 image_types
= NULL
;
11208 Vimage_types
= Qnil
;
11210 define_image_type (&xbm_type
);
11211 define_image_type (&gs_type
);
11212 define_image_type (&pbm_type
);
11215 define_image_type (&xpm_type
);
11219 define_image_type (&jpeg_type
);
11223 define_image_type (&tiff_type
);
11227 define_image_type (&gif_type
);
11231 define_image_type (&png_type
);
11235 #endif /* HAVE_X_WINDOWS */
11237 /* arch-tag: 55040d02-5485-4d58-8b22-95a7a05f3288
11238 (do not change this comment) */