gdkimage-x11.c 12.5 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1
2
3
4
/* GDK - The GIMP Drawing Kit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6
7
8
9
10
11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15
16
17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19
20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22
23
24
25
26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Jeff Garzik's avatar
Jeff Garzik committed
27
28
#include <config.h>

29
#include <stdlib.h>
Elliot Lee's avatar
Elliot Lee committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#include <sys/types.h>

#if defined (HAVE_IPC_H) && defined (HAVE_SHM_H) && defined (HAVE_XSHM_H)
#define USE_SHM
#endif

#ifdef USE_SHM
#include <sys/ipc.h>
#include <sys/shm.h>
#endif /* USE_SHM */

#include <X11/Xlib.h>
#include <X11/Xutil.h>

#ifdef USE_SHM
#include <X11/extensions/XShm.h>
#endif /* USE_SHM */

48
49
#include <errno.h>

Owen Taylor's avatar
Started    
Owen Taylor committed
50
51
#include "gdk.h"		/* For gdk_error_trap_* / gdk_flush_* */
#include "gdkimage.h"
Elliot Lee's avatar
Elliot Lee committed
52
#include "gdkprivate.h"
53
#include "gdkprivate-x11.h"
Elliot Lee's avatar
Elliot Lee committed
54
55

static GList *image_list = NULL;
56
57
static gpointer parent_class = NULL;

58
59
60
61
static void gdk_x11_image_destroy (GdkImage      *image);
static void gdk_image_init        (GdkImage      *image);
static void gdk_image_class_init  (GdkImageClass *klass);
static void gdk_image_finalize    (GObject       *object);
62
63
64

#define PRIVATE_DATA(image) ((GdkImagePrivateX11 *) GDK_IMAGE (image)->windowing_data)

65
66
#define	LEAK_IMAGE(image)		/* FIXME!! this should be g_object_unref */

67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
GType
gdk_image_get_type (void)
{
  static GType object_type = 0;

  if (!object_type)
    {
      static const GTypeInfo object_info =
      {
        sizeof (GdkImageClass),
        (GBaseInitFunc) NULL,
        (GBaseFinalizeFunc) NULL,
        (GClassInitFunc) gdk_image_class_init,
        NULL,           /* class_finalize */
        NULL,           /* class_data */
        sizeof (GdkImage),
        0,              /* n_preallocs */
        (GInstanceInitFunc) gdk_image_init,
      };
      
      object_type = g_type_register_static (G_TYPE_OBJECT,
                                            "GdkImage",
89
                                            &object_info, 0);
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
    }
  
  return object_type;
}

static void
gdk_image_init (GdkImage *image)
{
  image->windowing_data = g_new0 (GdkImagePrivateX11, 1);
}

static void
gdk_image_class_init (GdkImageClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  parent_class = g_type_class_peek_parent (klass);

  object_class->finalize = gdk_image_finalize;
}

static void
gdk_image_finalize (GObject *object)
{
  GdkImage *image = GDK_IMAGE (object);

  gdk_x11_image_destroy (image);
  
  G_OBJECT_CLASS (parent_class)->finalize (object);
}
Elliot Lee's avatar
Elliot Lee committed
120
121
122


void
123
gdk_image_exit (void)
Elliot Lee's avatar
Elliot Lee committed
124
125
126
127
128
129
{
  GdkImage *image;

  while (image_list)
    {
      image = image_list->data;
130
      gdk_x11_image_destroy (image);
Elliot Lee's avatar
Elliot Lee committed
131
132
133
134
135
136
137
138
139
    }
}

GdkImage *
gdk_image_new_bitmap(GdkVisual *visual, gpointer data, gint w, gint h)
/*
 * Desc: create a new bitmap image
 */
{
140
141
142
  Visual *xvisual;
  GdkImage *image;
  GdkImagePrivateX11 *private;
143
  image = g_object_new (gdk_image_get_type (), NULL);
144
145
146
147
148
149
150
  private = PRIVATE_DATA (image);
  private->xdisplay = gdk_display;
  image->type = GDK_IMAGE_NORMAL;
  image->visual = visual;
  image->width = w;
  image->height = h;
  image->depth = 1;
151
  image->bits_per_pixel = 1;
152
153
154
155
156
157
158
159
160
161
162
  xvisual = ((GdkVisualPrivate*) visual)->xvisual;
  private->ximage = XCreateImage(private->xdisplay, xvisual, 1, XYBitmap,
				 0, 0, w ,h, 8, 0);
  private->ximage->data = data;
  private->ximage->bitmap_bit_order = MSBFirst;
  private->ximage->byte_order = MSBFirst;
  image->byte_order = MSBFirst;
  image->mem =  private->ximage->data;
  image->bpl = private->ximage->bytes_per_line;
  image->bpp = 1;
  return(image);
Elliot Lee's avatar
Elliot Lee committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
} /* gdk_image_new_bitmap() */

static int
gdk_image_check_xshm(Display *display)
/* 
 * Desc: query the server for support for the MIT_SHM extension
 * Return:  0 = not available
 *          1 = shared XImage support available
 *          2 = shared Pixmap support available also
 */
{
#ifdef USE_SHM
  int major, minor, ignore;
  Bool pixmaps;
  
  if (XQueryExtension(display, "MIT-SHM", &ignore, &ignore, &ignore)) 
    {
      if (XShmQueryVersion(display, &major, &minor, &pixmaps )==True) 
	{
	  return (pixmaps==True) ? 2 : 1;
	}
    }
#endif /* USE_SHM */
  return 0;
}

void
190
_gdk_windowing_image_init (void)
Elliot Lee's avatar
Elliot Lee committed
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
{
  if (gdk_use_xshm)
    {
      if (!gdk_image_check_xshm (gdk_display))
	{
	  gdk_use_xshm = False;
	}
    }
}

GdkImage*
gdk_image_new (GdkImageType  type,
	       GdkVisual    *visual,
	       gint          width,
	       gint          height)
{
  GdkImage *image;
208
  GdkImagePrivateX11 *private;
Elliot Lee's avatar
Elliot Lee committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
#ifdef USE_SHM
  XShmSegmentInfo *x_shm_info;
#endif /* USE_SHM */
  Visual *xvisual;

  switch (type)
    {
    case GDK_IMAGE_FASTEST:
      image = gdk_image_new (GDK_IMAGE_SHARED, visual, width, height);

      if (!image)
	image = gdk_image_new (GDK_IMAGE_NORMAL, visual, width, height);
      break;

    default:
224
      image = g_object_new (gdk_image_get_type (), NULL);
225
226
      
      private = PRIVATE_DATA (image);
Elliot Lee's avatar
Elliot Lee committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243

      private->xdisplay = gdk_display;

      image->type = type;
      image->visual = visual;
      image->width = width;
      image->height = height;
      image->depth = visual->depth;

      xvisual = ((GdkVisualPrivate*) visual)->xvisual;

      switch (type)
	{
	case GDK_IMAGE_SHARED:
#ifdef USE_SHM
	  if (gdk_use_xshm)
	    {
244
	      private->x_shm_info = g_new (XShmSegmentInfo, 1);
Elliot Lee's avatar
Elliot Lee committed
245
246
247
248
249
250
251
252
	      x_shm_info = private->x_shm_info;

	      private->ximage = XShmCreateImage (private->xdisplay, xvisual, visual->depth,
						 ZPixmap, NULL, x_shm_info, width, height);
	      if (private->ximage == NULL)
		{
		  g_warning ("XShmCreateImage failed");
		  
253
		  LEAK_IMAGE (image);
Elliot Lee's avatar
Elliot Lee committed
254
255
256
257
258
259
		  gdk_use_xshm = False;
		  return NULL;
		}

	      x_shm_info->shmid = shmget (IPC_PRIVATE,
					  private->ximage->bytes_per_line * private->ximage->height,
260
					  IPC_CREAT | 0600);
Elliot Lee's avatar
Elliot Lee committed
261
262
263

	      if (x_shm_info->shmid == -1)
		{
264
		  /* EINVAL indicates, most likely, that the segment we asked for
265
266
		   * is bigger than SHMMAX, so we don't treat it as a permanent
		   * error. ENOSPC and ENOMEM may also indicate this, but
267
268
269
270
		   * more likely are permanent errors.
		   */
		  if (errno != EINVAL)
		    {
271
		      g_warning ("shmget failed: error %d (%s)", errno, g_strerror (errno));
272
273
		      gdk_use_xshm = False;
		    }
Elliot Lee's avatar
Elliot Lee committed
274
275

		  XDestroyImage (private->ximage);
276
		  g_free (private->x_shm_info);
277
		  LEAK_IMAGE (image);
Elliot Lee's avatar
Elliot Lee committed
278
279
280
281
282
283
284
285
286
287

		  return NULL;
		}

	      x_shm_info->readOnly = False;
	      x_shm_info->shmaddr = shmat (x_shm_info->shmid, 0, 0);
	      private->ximage->data = x_shm_info->shmaddr;

	      if (x_shm_info->shmaddr == (char*) -1)
		{
288
		  g_warning ("shmat failed: error %d (%s)", errno, g_strerror (errno));
Elliot Lee's avatar
Elliot Lee committed
289
290
291
292

		  XDestroyImage (private->ximage);
		  shmctl (x_shm_info->shmid, IPC_RMID, 0);
		  
293
		  g_free (private->x_shm_info);
294
		  LEAK_IMAGE (image);
Elliot Lee's avatar
Elliot Lee committed
295

296
297
298
299
300
301
		  /* Failure in shmat is almost certainly permanent. Most likely error is
		   * EMFILE, which would mean that we've exceeded the per-process
		   * Shm segment limit.
		   */
		  gdk_use_xshm = False;
		  
Elliot Lee's avatar
Elliot Lee committed
302
303
304
		  return NULL;
		}

305
	      gdk_error_trap_push ();
Elliot Lee's avatar
Elliot Lee committed
306
307
308
309

	      XShmAttach (private->xdisplay, x_shm_info);
	      XSync (private->xdisplay, False);

310
	      if (gdk_error_trap_pop ())
Elliot Lee's avatar
Elliot Lee committed
311
		{
312
		  /* this is the common failure case so omit warning */
Elliot Lee's avatar
Elliot Lee committed
313
314
315
316
		  XDestroyImage (private->ximage);
		  shmdt (x_shm_info->shmaddr);
		  shmctl (x_shm_info->shmid, IPC_RMID, 0);
                  
317
		  g_free (private->x_shm_info);
318
		  LEAK_IMAGE (image);
Elliot Lee's avatar
Elliot Lee committed
319
320

		  gdk_use_xshm = False;
321

Elliot Lee's avatar
Elliot Lee committed
322
323
		  return NULL;
		}
324
325
326
327
328
329
330
331
	      
	      /* We mark the segment as destroyed so that when
	       * the last process detaches, it will be deleted.
	       * There is a small possibility of leaking if
	       * we die in XShmAttach. In theory, a signal handler
	       * could be set up.
	       */
	      shmctl (x_shm_info->shmid, IPC_RMID, 0);		      
Elliot Lee's avatar
Elliot Lee committed
332
333
334
335
336
337

	      if (image)
		image_list = g_list_prepend (image_list, image);
	    }
	  else
	    {
338
	      LEAK_IMAGE (image);
Elliot Lee's avatar
Elliot Lee committed
339
340
341
342
	      return NULL;
	    }
	  break;
#else /* USE_SHM */
343
	  LEAK_IMAGE (image);
Elliot Lee's avatar
Elliot Lee committed
344
345
346
347
348
349
	  return NULL;
#endif /* USE_SHM */
	case GDK_IMAGE_NORMAL:
	  private->ximage = XCreateImage (private->xdisplay, xvisual, visual->depth,
					  ZPixmap, 0, 0, width, height, 32, 0);

350
351
352
353
354
	  /* Use malloc, not g_malloc here, because X will call free()
	   * on this data
	   */
	  private->ximage->data = malloc (private->ximage->bytes_per_line *
					  private->ximage->height);
Elliot Lee's avatar
Elliot Lee committed
355
356
357
358
359
360
361
362
363
364
365
	  break;

	case GDK_IMAGE_FASTEST:
	  g_assert_not_reached ();
	}

      if (image)
	{
	  image->byte_order = private->ximage->byte_order;
	  image->mem = private->ximage->data;
	  image->bpl = private->ximage->bytes_per_line;
366
	  image->bpp = (private->ximage->bits_per_pixel + 7) / 8;
367
	  image->bits_per_pixel = private->ximage->bits_per_pixel;
Elliot Lee's avatar
Elliot Lee committed
368
369
370
371
372
373
374
	}
    }

  return image;
}

GdkImage*
Havoc Pennington's avatar
Havoc Pennington committed
375
376
377
378
379
_gdk_x11_get_image (GdkDrawable    *drawable,
                    gint            x,
                    gint            y,
                    gint            width,
                    gint            height)
Elliot Lee's avatar
Elliot Lee committed
380
381
{
  GdkImage *image;
382
  GdkImagePrivateX11 *private;
Havoc Pennington's avatar
Havoc Pennington committed
383
384
  GdkDrawableImplX11 *impl;
  GdkVisual *visual;
385
386
  XImage *ximage;
 
Havoc Pennington's avatar
Havoc Pennington committed
387
  g_return_val_if_fail (GDK_IS_DRAWABLE_IMPL_X11 (drawable), NULL);
Elliot Lee's avatar
Elliot Lee committed
388

Havoc Pennington's avatar
Havoc Pennington committed
389
  visual = gdk_drawable_get_visual (drawable);
Elliot Lee's avatar
Elliot Lee committed
390

Havoc Pennington's avatar
Havoc Pennington committed
391
392
393
394
395
396
  if (visual == NULL)
    {
      g_warning ("To get the image from a drawable, the drawable "
                 "must have a visual and colormap; calling "
                 "gtk_drawable_set_colormap() on a drawable "
                 "created without a colormap should solve this problem");
Elliot Lee's avatar
Elliot Lee committed
397

Havoc Pennington's avatar
Havoc Pennington committed
398
399
400
401
402
      return NULL;
    }
  
  impl = GDK_DRAWABLE_IMPL_X11 (drawable);
  
403
404
405
406
407
408
409
410
  ximage = XGetImage (impl->xdisplay,
		      impl->xid,
		      x, y, width, height,
		      AllPlanes, ZPixmap);

  if (!ximage)
    return NULL;

411
  image = g_object_new (gdk_image_get_type (), NULL);
412
  private = PRIVATE_DATA (image);
Elliot Lee's avatar
Elliot Lee committed
413
414

  private->xdisplay = gdk_display;
415
  private->ximage = ximage;
Elliot Lee's avatar
Elliot Lee committed
416
417

  image->type = GDK_IMAGE_NORMAL;
Havoc Pennington's avatar
Havoc Pennington committed
418
  image->visual = visual;
Elliot Lee's avatar
Elliot Lee committed
419
420
421
422
423
424
  image->width = width;
  image->height = height;
  image->depth = private->ximage->depth;

  image->mem = private->ximage->data;
  image->bpl = private->ximage->bytes_per_line;
425
426
  image->bits_per_pixel = private->ximage->bits_per_pixel;
  image->bpp = (private->ximage->bits_per_pixel + 7) / 8;
427
  image->byte_order = private->ximage->byte_order;
Elliot Lee's avatar
Elliot Lee committed
428
429
430
431
432
433
434
435
436
437

  return image;
}

guint32
gdk_image_get_pixel (GdkImage *image,
		     gint x,
		     gint y)
{
  guint32 pixel;
438
  GdkImagePrivateX11 *private;
Elliot Lee's avatar
Elliot Lee committed
439

440
  g_return_val_if_fail (GDK_IS_IMAGE (image), 0);
Elliot Lee's avatar
Elliot Lee committed
441

442
  private = PRIVATE_DATA (image);
Elliot Lee's avatar
Elliot Lee committed
443
444
445
446
447
448
449
450
451
452
453
454

  pixel = XGetPixel (private->ximage, x, y);

  return pixel;
}

void
gdk_image_put_pixel (GdkImage *image,
		     gint x,
		     gint y,
		     guint32 pixel)
{
455
  GdkImagePrivateX11 *private;
Elliot Lee's avatar
Elliot Lee committed
456

457
  g_return_if_fail (GDK_IS_IMAGE (image));
Elliot Lee's avatar
Elliot Lee committed
458

459
  private = PRIVATE_DATA (image);
Elliot Lee's avatar
Elliot Lee committed
460
461
462
463

  pixel = XPutPixel (private->ximage, x, y, pixel);
}

464
465
static void
gdk_x11_image_destroy (GdkImage *image)
Elliot Lee's avatar
Elliot Lee committed
466
{
467
  GdkImagePrivateX11 *private;
Elliot Lee's avatar
Elliot Lee committed
468
469
470
471
#ifdef USE_SHM
  XShmSegmentInfo *x_shm_info;
#endif /* USE_SHM */

472
  g_return_if_fail (GDK_IS_IMAGE (image));
Elliot Lee's avatar
Elliot Lee committed
473

474
475
476
477
478
479
480
481
  private = PRIVATE_DATA (image);

  if (private == NULL) /* This means that gdk_image_exit() destroyed the
                        * image already, and now we're called a second
                        * time from _finalize()
                        */
    return;
  
Elliot Lee's avatar
Elliot Lee committed
482
483
484
485
486
487
488
489
  switch (image->type)
    {
    case GDK_IMAGE_NORMAL:
      XDestroyImage (private->ximage);
      break;

    case GDK_IMAGE_SHARED:
#ifdef USE_SHM
490
491
      gdk_flush();

Elliot Lee's avatar
Elliot Lee committed
492
493
494
495
496
497
      XShmDetach (private->xdisplay, private->x_shm_info);
      XDestroyImage (private->ximage);

      x_shm_info = private->x_shm_info;
      shmdt (x_shm_info->shmaddr);
      
498
      g_free (private->x_shm_info);
499
500
      private->x_shm_info = NULL;
      
Elliot Lee's avatar
Elliot Lee committed
501
502
503
504
505
506
507
508
509
510
      image_list = g_list_remove (image_list, image);
#else /* USE_SHM */
      g_error ("trying to destroy shared memory image when gdk was compiled without shared memory support");
#endif /* USE_SHM */
      break;

    case GDK_IMAGE_FASTEST:
      g_assert_not_reached ();
    }

511
512
  g_free (private);
  image->windowing_data = NULL;
Elliot Lee's avatar
Elliot Lee committed
513
}