1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include <sys/types.h>
32 #if defined (HAVE_IPC_H) && defined (HAVE_SHM_H) && defined (HAVE_XSHM_H)
42 #include <X11/Xutil.h>
45 #include <X11/extensions/XShm.h>
50 #include "gdk.h" /* For gdk_error_trap_* / gdk_flush_* */
53 #include "gdkprivate.h"
54 #include "gdkprivate-x11.h"
55 #include "gdkdisplay-x11.h"
56 #include "gdkscreen-x11.h"
59 typedef struct _GdkImagePrivateX11 GdkImagePrivateX11;
61 struct _GdkImagePrivateX11
69 static GList *image_list = NULL;
71 static void gdk_x11_image_destroy (GdkImage *image);
72 static void gdk_image_finalize (GObject *object);
74 #define PRIVATE_DATA(image) ((GdkImagePrivateX11 *) GDK_IMAGE (image)->windowing_data)
76 G_DEFINE_TYPE (GdkImage, gdk_image, G_TYPE_OBJECT)
79 gdk_image_init (GdkImage *image)
81 image->windowing_data = G_TYPE_INSTANCE_GET_PRIVATE (image,
87 gdk_image_class_init (GdkImageClass *klass)
89 GObjectClass *object_class = G_OBJECT_CLASS (klass);
91 object_class->finalize = gdk_image_finalize;
93 g_type_class_add_private (object_class, sizeof (GdkImagePrivateX11));
97 gdk_image_finalize (GObject *object)
99 GdkImage *image = GDK_IMAGE (object);
101 gdk_x11_image_destroy (image);
103 G_OBJECT_CLASS (gdk_image_parent_class)->finalize (object);
108 _gdk_image_exit (void)
114 image = image_list->data;
115 gdk_x11_image_destroy (image);
120 _gdk_windowing_image_init (GdkDisplay *display)
122 GdkDisplayX11 *display_x11 = GDK_DISPLAY_X11 (display);
124 if (display_x11->use_xshm)
127 Display *xdisplay = display_x11->xdisplay;
128 int major, minor, event_base;
131 if (XShmQueryExtension (xdisplay) &&
132 XShmQueryVersion (xdisplay, &major, &minor, &pixmaps))
134 display_x11->have_shm_pixmaps = pixmaps;
135 event_base = XShmGetEventBase (xdisplay);
137 gdk_x11_register_standard_event_type (display,
138 event_base, ShmNumberEvents);
142 display_x11->use_xshm = FALSE;
147 _gdk_image_new_for_depth (GdkScreen *screen,
155 GdkImagePrivateX11 *private;
157 XShmSegmentInfo *x_shm_info;
159 Visual *xvisual = NULL;
160 GdkDisplayX11 *display_x11;
161 GdkScreenX11 *screen_x11;
163 g_return_val_if_fail (!visual || GDK_IS_VISUAL (visual), NULL);
164 g_return_val_if_fail (visual || depth != -1, NULL);
165 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
167 screen_x11 = GDK_SCREEN_X11 (screen);
168 display_x11 = GDK_DISPLAY_X11 (screen_x11->display);
171 depth = visual->depth;
175 case GDK_IMAGE_FASTEST:
176 image = _gdk_image_new_for_depth (screen, GDK_IMAGE_SHARED,
177 visual, width, height, depth);
179 image = _gdk_image_new_for_depth (screen, GDK_IMAGE_NORMAL,
180 visual, width, height, depth);
184 image = g_object_new (gdk_image_get_type (), NULL);
186 private = PRIVATE_DATA (image);
188 private->screen = screen;
191 image->visual = visual;
192 image->width = width;
193 image->height = height;
194 image->depth = depth;
197 xvisual = ((GdkVisualPrivate*) visual)->xvisual;
201 case GDK_IMAGE_SHARED:
203 if (display_x11->use_xshm)
205 private->x_shm_info = g_new (XShmSegmentInfo, 1);
206 x_shm_info = private->x_shm_info;
207 x_shm_info->shmid = -1;
208 x_shm_info->shmaddr = (char*) -1;
210 private->ximage = XShmCreateImage (screen_x11->xdisplay, xvisual, depth,
211 ZPixmap, NULL, x_shm_info, width, height);
212 if (private->ximage == NULL)
214 g_warning ("XShmCreateImage failed");
215 display_x11->use_xshm = FALSE;
220 x_shm_info->shmid = shmget (IPC_PRIVATE,
221 private->ximage->bytes_per_line * private->ximage->height,
224 if (x_shm_info->shmid == -1)
226 /* EINVAL indicates, most likely, that the segment we asked for
227 * is bigger than SHMMAX, so we don't treat it as a permanent
228 * error. ENOSPC and ENOMEM may also indicate this, but
229 * more likely are permanent errors.
233 g_warning ("shmget failed: error %d (%s)", errno, g_strerror (errno));
234 display_x11->use_xshm = FALSE;
240 x_shm_info->readOnly = False;
241 x_shm_info->shmaddr = shmat (x_shm_info->shmid, NULL, 0);
242 private->ximage->data = x_shm_info->shmaddr;
244 if (x_shm_info->shmaddr == (char*) -1)
246 g_warning ("shmat failed: error %d (%s)", errno, g_strerror (errno));
247 /* Failure in shmat is almost certainly permanent. Most likely error is
248 * EMFILE, which would mean that we've exceeded the per-process
251 display_x11->use_xshm = FALSE;
255 gdk_error_trap_push ();
257 XShmAttach (screen_x11->xdisplay, x_shm_info);
258 XSync (screen_x11->xdisplay, False);
260 if (gdk_error_trap_pop ())
262 /* this is the common failure case so omit warning */
263 display_x11->use_xshm = FALSE;
267 /* We mark the segment as destroyed so that when
268 * the last process detaches, it will be deleted.
269 * There is a small possibility of leaking if
270 * we die in XShmAttach. In theory, a signal handler
273 shmctl (x_shm_info->shmid, IPC_RMID, NULL);
276 image_list = g_list_prepend (image_list, image);
282 case GDK_IMAGE_NORMAL:
283 private->ximage = XCreateImage (screen_x11->xdisplay, xvisual, depth,
284 ZPixmap, 0, NULL, width, height, 32, 0);
286 /* Use malloc, not g_malloc here, because X will call free()
289 private->ximage->data = malloc (private->ximage->bytes_per_line *
290 private->ximage->height);
291 if (!private->ximage->data)
295 case GDK_IMAGE_FASTEST:
296 g_assert_not_reached ();
301 image->byte_order = (private->ximage->byte_order == LSBFirst) ? GDK_LSB_FIRST : GDK_MSB_FIRST;
302 image->mem = private->ximage->data;
303 image->bpl = private->ximage->bytes_per_line;
304 image->bpp = (private->ximage->bits_per_pixel + 7) / 8;
305 image->bits_per_pixel = private->ximage->bits_per_pixel;
314 XDestroyImage (private->ximage);
315 private->ximage = NULL;
318 if (private->x_shm_info)
320 x_shm_info = private->x_shm_info;
322 if (x_shm_info->shmaddr != (char *)-1)
323 shmdt (x_shm_info->shmaddr);
324 if (x_shm_info->shmid != -1)
325 shmctl (x_shm_info->shmid, IPC_RMID, NULL);
328 private->x_shm_info = NULL;
331 g_object_unref (image);
337 _gdk_x11_image_get_shm_pixmap (GdkImage *image)
339 GdkImagePrivateX11 *private = PRIVATE_DATA (image);
340 GdkDisplay *display = GDK_SCREEN_DISPLAY (private->screen);
346 /* Future: do we need one of these per-screen per-image? ShmPixmaps
347 * are the same for every screen, but can they be shared? Not a concern
348 * right now since we tie images to a particular screen.
350 if (!private->shm_pixmap && image->type == GDK_IMAGE_SHARED &&
351 GDK_DISPLAY_X11 (display)->have_shm_pixmaps)
352 private->shm_pixmap = XShmCreatePixmap (GDK_SCREEN_XDISPLAY (private->screen),
353 GDK_SCREEN_XROOTWIN (private->screen),
354 image->mem, private->x_shm_info,
355 image->width, image->height, image->depth);
357 return private->shm_pixmap;
364 get_full_image (GdkDrawable *drawable,
371 GdkImagePrivateX11 *private;
372 GdkDrawableImplX11 *impl;
375 impl = GDK_DRAWABLE_IMPL_X11 (drawable);
377 ximage = XGetImage (GDK_SCREEN_XDISPLAY (impl->screen),
379 src_x, src_y, width, height,
385 image = g_object_new (gdk_image_get_type (), NULL);
387 private = PRIVATE_DATA (image);
389 private->screen = impl->screen;
390 private->ximage = ximage;
392 image->type = GDK_IMAGE_NORMAL;
393 image->visual = gdk_drawable_get_visual (drawable); /* could be NULL */
394 image->width = width;
395 image->height = height;
396 image->depth = gdk_drawable_get_depth (drawable);
398 image->mem = private->ximage->data;
399 image->bpl = private->ximage->bytes_per_line;
400 image->bits_per_pixel = private->ximage->bits_per_pixel;
401 image->bpp = (private->ximage->bits_per_pixel + 7) / 8;
402 image->byte_order = (private->ximage->byte_order == LSBFirst) ? GDK_LSB_FIRST : GDK_MSB_FIRST;
408 _gdk_x11_copy_to_image (GdkDrawable *drawable,
417 GdkImagePrivateX11 *private;
418 GdkDrawableImplX11 *impl;
424 GdkRectangle window_rect;
425 Pixmap shm_pixmap = None;
426 gboolean success = TRUE;
428 g_return_val_if_fail (GDK_IS_DRAWABLE_IMPL_X11 (drawable), NULL);
429 g_return_val_if_fail (image != NULL || (dest_x == 0 && dest_y == 0), NULL);
431 visual = gdk_drawable_get_visual (drawable);
432 impl = GDK_DRAWABLE_IMPL_X11 (drawable);
433 display = gdk_drawable_get_display (drawable);
434 xdisplay = gdk_x11_display_get_xdisplay (display);
441 #define UNGRAB() G_STMT_START { \
443 gdk_x11_display_ungrab (display); \
444 have_grab = FALSE; } \
447 if (!image && !GDK_IS_WINDOW_IMPL_X11 (drawable))
448 return get_full_image (drawable, src_x, src_y, width, height);
450 if (image && image->type == GDK_IMAGE_SHARED)
452 shm_pixmap = _gdk_x11_image_get_shm_pixmap (image);
458 /* Again easy, we can just XCopyArea, and don't have to worry about clipping
460 values.subwindow_mode = IncludeInferiors;
461 xgc = XCreateGC (xdisplay, impl->xid, GCSubwindowMode, &values);
463 XCopyArea (xdisplay, impl->xid, shm_pixmap, xgc,
464 src_x, src_y, width, height, dest_x, dest_y);
465 XSync (xdisplay, FALSE);
467 XFreeGC (xdisplay, xgc);
473 /* Now the general case - we may have to worry about clipping to the screen
474 * bounds, in which case we'll have to grab the server and only get a piece
477 if (GDK_IS_WINDOW_IMPL_X11 (drawable))
479 GdkRectangle screen_rect;
483 gdk_x11_display_grab (display);
485 /* Translate screen area into window coordinates */
486 XTranslateCoordinates (xdisplay,
487 GDK_SCREEN_XROOTWIN (impl->screen),
490 &screen_rect.x, &screen_rect.y,
493 screen_rect.width = gdk_screen_get_width (impl->screen);
494 screen_rect.height = gdk_screen_get_height (impl->screen);
496 gdk_error_trap_push ();
501 gdk_window_get_geometry (GDK_WINDOW (impl->wrapper),
507 /* compute intersection of screen and window, in window
510 if (gdk_error_trap_pop () ||
511 !gdk_rectangle_intersect (&window_rect, &screen_rect,
519 gdk_drawable_get_size (drawable,
521 &window_rect.height);
529 /* window_rect specifies the part of drawable which we can get from
530 * the server in window coordinates.
531 * For pixmaps this is all of the pixmap, for windows it is just
534 if (!gdk_rectangle_intersect (&req, &window_rect, &req))
537 gdk_error_trap_push ();
540 req.x == src_x && req.y == src_y && req.width == width && req.height == height)
542 image = get_full_image (drawable, src_x, src_y, width, height);
548 gboolean created_image = FALSE;
552 image = _gdk_image_new_for_depth (impl->screen, GDK_IMAGE_NORMAL,
553 visual, width, height,
554 gdk_drawable_get_depth (drawable));
555 created_image = TRUE;
558 private = PRIVATE_DATA (image);
560 /* In the ShmImage but no ShmPixmap case, we could use XShmGetImage when
561 * we are getting the entire image.
563 if (XGetSubImage (xdisplay, impl->xid,
564 req.x, req.y, req.width, req.height,
567 dest_x + req.x - src_x, dest_y + req.y - src_y) == None)
570 g_object_unref (image);
576 gdk_error_trap_pop ();
582 gdk_x11_display_ungrab (display);
586 if (success && !image)
588 /* We "succeeded", but could get no content for the image so return junk */
589 image = _gdk_image_new_for_depth (impl->screen, GDK_IMAGE_NORMAL,
590 visual, width, height,
591 gdk_drawable_get_depth (drawable));
598 gdk_image_get_pixel (GdkImage *image,
603 GdkImagePrivateX11 *private;
605 g_return_val_if_fail (GDK_IS_IMAGE (image), 0);
606 g_return_val_if_fail (x >= 0 && x < image->width, 0);
607 g_return_val_if_fail (y >= 0 && y < image->height, 0);
609 private = PRIVATE_DATA (image);
611 if (!private->screen->closed)
612 pixel = XGetPixel (private->ximage, x, y);
620 gdk_image_put_pixel (GdkImage *image,
625 GdkImagePrivateX11 *private;
627 g_return_if_fail (GDK_IS_IMAGE (image));
628 g_return_if_fail (x >= 0 && x < image->width);
629 g_return_if_fail (y >= 0 && y < image->height);
631 private = PRIVATE_DATA (image);
633 if (!private->screen->closed)
634 pixel = XPutPixel (private->ximage, x, y, pixel);
638 gdk_x11_image_destroy (GdkImage *image)
640 GdkImagePrivateX11 *private;
642 XShmSegmentInfo *x_shm_info;
645 g_return_if_fail (GDK_IS_IMAGE (image));
647 private = PRIVATE_DATA (image);
649 if (private->ximage) /* Deal with failure of creation */
653 case GDK_IMAGE_NORMAL:
654 if (!private->screen->closed)
655 XDestroyImage (private->ximage);
658 case GDK_IMAGE_SHARED:
660 if (!private->screen->closed)
662 gdk_display_sync (GDK_SCREEN_DISPLAY (private->screen));
664 if (private->shm_pixmap)
665 XFreePixmap (GDK_SCREEN_XDISPLAY (private->screen), private->shm_pixmap);
667 XShmDetach (GDK_SCREEN_XDISPLAY (private->screen), private->x_shm_info);
668 XDestroyImage (private->ximage);
671 image_list = g_list_remove (image_list, image);
673 x_shm_info = private->x_shm_info;
674 shmdt (x_shm_info->shmaddr);
676 g_free (private->x_shm_info);
677 private->x_shm_info = NULL;
680 g_error ("trying to destroy shared memory image when gdk was compiled without shared memory support");
684 case GDK_IMAGE_FASTEST:
685 g_assert_not_reached ();
688 private->ximage = NULL;
693 * gdk_x11_image_get_xdisplay:
694 * @image: a #GdkImage.
696 * Returns the display of a #GdkImage.
698 * Return value: an Xlib <type>Display*</type>.
701 gdk_x11_image_get_xdisplay (GdkImage *image)
703 GdkImagePrivateX11 *private;
705 g_return_val_if_fail (GDK_IS_IMAGE (image), NULL);
707 private = PRIVATE_DATA (image);
709 return GDK_SCREEN_XDISPLAY (private->screen);
713 * gdk_x11_image_get_ximage:
714 * @image: a #GdkImage.
716 * Returns the X image belonging to a #GdkImage.
718 * Return value: an <type>XImage*</type>.
721 gdk_x11_image_get_ximage (GdkImage *image)
723 GdkImagePrivateX11 *private;
725 g_return_val_if_fail (GDK_IS_IMAGE (image), NULL);
727 private = PRIVATE_DATA (image);
729 if (private->screen->closed)
732 return private->ximage;
736 _gdk_windowing_get_bits_for_depth (GdkDisplay *display,
739 XPixmapFormatValues *formats;
742 formats = XListPixmapFormats (GDK_DISPLAY_XDISPLAY (display), &count);
744 for (i = 0; i < count; i++)
745 if (formats[i].depth == depth)
747 gint result = formats[i].bits_per_pixel;
752 g_assert_not_reached ();
757 #define __GDK_IMAGE_X11_C__
758 #include "gdkaliasdef.c"