1 /* Image support for the NeXT/Open/GNUstep and MacOSX window system.
2 Copyright (C) 1989, 1992, 1993, 1994, 2005, 2006, 2008
3 Free Software Foundation, Inc.
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 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 Originally by Carl Edman
22 Updated by Christian Limpach (chris@nice.ch)
23 OpenStep/Rhapsody port by Scott Bender (sbender@harmony-ds.com)
24 MacOSX/Aqua port by Christophe de Dinechin (descubes@earthlink.net)
25 GNUstep port and post-20 update by Adrian Robert (arobert@cogsci.ucsd.edu)
28 /* This should be the first include, as it may set up #defines affecting
29 interpretation of even the system includes. */
33 #include "dispextern.h"
37 extern Lisp_Object QCfile, QCdata;
41 int image_trace_num = 0;
42 #define NSTRACE(x) fprintf (stderr, "%s:%d: [%d] " #x "\n", \
43 __FILE__, __LINE__, ++image_trace_num)
49 /* ==========================================================================
51 C interface. This allows easy calling from C files. We could just
52 compile everything as Objective-C, but that might mean slower
53 compilation and possible difficulties on some platforms..
55 ========================================================================== */
58 ns_image_from_XBM (unsigned char *bits, int width, int height)
60 NSTRACE (ns_image_from_XBM);
61 return [[EmacsImage alloc] initFromXBM: bits
62 width: width height: height
67 ns_image_for_XPM (int width, int height, int depth)
69 NSTRACE (ns_image_for_XPM);
70 return [[EmacsImage alloc] initForXPMWithDepth: depth
71 width: width height: height];
75 ns_image_from_file (Lisp_Object file)
77 NSTRACE (ns_image_from_bitmap_file);
78 return [EmacsImage allocInitFromFile: file];
82 ns_load_image (struct frame *f, struct image *img,
83 Lisp_Object spec_file, Lisp_Object spec_data)
85 NSTRACE (ns_load_image);
92 eImg = [EmacsImage allocInitFromFile: spec_file];
96 NSData *data = [NSData dataWithBytes: XSTRING (spec_data)->data
97 length: SBYTES (spec_data)];
98 eImg = [[EmacsImage alloc] initWithData: data];
104 add_to_log ("Unable to load image %s", img->spec, Qnil);
109 img->width = size.width;
110 img->height = size.height;
112 /* 4) set img->pixmap = emacsimage */
119 ns_image_width (void *img)
121 return [(id)img size].width;
125 ns_image_height (void *img)
127 return [(id)img size].height;
131 ns_get_pixel (void *img, int x, int y)
133 return [(EmacsImage *)img getPixelAtX: x Y: y];
137 ns_put_pixel (void *img, int x, int y, unsigned long argb)
139 unsigned char alpha = (argb >> 24) & 0xFF;
142 [(EmacsImage *)img setPixelAtX: x Y: y toRed: (argb >> 16) & 0xFF
143 green: (argb >> 8) & 0xFF blue: (argb & 0xFF) alpha: alpha];
147 ns_set_alpha (void *img, int x, int y, unsigned char a)
149 [(EmacsImage *)img setAlphaAtX: x Y: y to: a];
153 /* ==========================================================================
155 Class supporting bitmaps and images of various sorts.
157 ========================================================================== */
159 @implementation EmacsImage
161 static EmacsImage *ImageList = nil;
163 + allocInitFromFile: (Lisp_Object)file
165 EmacsImage *image = ImageList;
168 /* look for an existing image of the same name */
169 while (image != nil &&
170 [[image name] compare: [NSString stringWithUTF8String: SDATA (file)]]
172 image = [image imageListNext];
180 /* Search bitmap-file-path for the file, if appropriate. */
181 found = x_find_image_file (file);
182 if (!STRINGP (found))
185 image = [[EmacsImage alloc] initByReferencingFile:
186 [NSString stringWithUTF8String: SDATA (found)]];
188 if ([image bestRepresentationForDevice: nil] == nil)
194 [image setName: [NSString stringWithUTF8String: SDATA (file)]];
196 ImageList = [image imageListSetNext: ImageList];
209 - imageListSetNext: (id)arg
218 return imageListNext;
232 [stippleMask release];
235 ImageList = imageListNext;
238 while (list != nil && [list imageListNext] != self)
239 list = [list imageListNext];
240 [list imageListSetNext: imageListNext];
247 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
250 return [self initFromSkipXBM: bits width: w height: h flip: flip length: 0];
254 - initFromSkipXBM: (unsigned char *)bits width: (int)w height: (int)h
255 flip: (BOOL)flip length: (int)length;
257 int bpr = (w + 7) / 8;
258 unsigned char *planes[5];
260 [self initWithSize: NSMakeSize (w, h)];
262 bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
263 pixelsWide: w pixelsHigh: h
264 bitsPerSample: 8 samplesPerPixel: 4
265 hasAlpha: YES isPlanar: YES
266 colorSpaceName: NSCalibratedRGBColorSpace
267 bytesPerRow: w bitsPerPixel: 0];
269 [bmRep getBitmapDataPlanes: planes];
271 /* pull bits out to set the (bytewise) alpha mask */
273 unsigned char *s = bits;
274 unsigned char *alpha = planes[3];
275 unsigned char swt[16] = {0, 8, 4, 12, 2, 10, 6, 14, 1, 9, 5, 13,
277 unsigned char c, bitPat;
279 for (j = 0; j < h; j++)
280 for (i = 0; i < bpr; i++)
284 unsigned char s1, s2;
285 while (*s++ != 'x' && s < bits + length);
286 if (s >= bits + length)
291 #define hexchar(x) (isdigit (x) ? x - '0' : x - 'a' + 10)
294 c = hexchar (s1) * 0x10 + hexchar (s2);
299 bitPat = flip ? swt[c >> 4] | (swt[c & 0xf] << 4) : c ^ 255;
302 *alpha++ = (bitPat & 0x80) ? 0xff : 0;
308 [self addRepresentation: bmRep];
310 bzero (planes[0], w*h);
311 bzero (planes[1], w*h);
312 bzero (planes[2], w*h);
313 [self setXBMColor: [NSColor blackColor]];
318 /* Set color for a bitmap image (see initFromSkipXBM). Note that the alpha
319 is used as a mask, so we just memset the entire array. */
320 - setXBMColor: (NSColor *)color
322 NSSize s = [self size];
323 int len = (int) s.width * s.height;
324 unsigned char *planes[5];
328 if (bmRep == nil || color == nil)
331 if ([color colorSpaceName] != NSCalibratedRGBColorSpace)
332 rgbColor = [color colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
336 [rgbColor getRed: &r green: &g blue: &b alpha: &a];
338 [bmRep getBitmapDataPlanes: planes];
340 /* we used to just do this, but Cocoa seems to have a bug when rendering
341 an alpha-masked image onto a dark background where it bloats the mask */
342 /* memset (planes[0..2], r, g, b*0xff, len); */
344 int i, len = s.width*s.height;
345 int rr = r * 0xff, gg = g * 0xff, bb = b * 0xff;
346 for (i =0; i<len; i++)
347 if (planes[3][i] != 0)
357 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height
359 NSSize s = {width, height};
362 [self initWithSize: s];
364 bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
365 pixelsWide: width pixelsHigh: height
366 /* keep things simple for now */
367 bitsPerSample: 8 samplesPerPixel: 4 /*RGB+A*/
368 hasAlpha: YES isPlanar: YES
369 colorSpaceName: NSCalibratedRGBColorSpace
370 bytesPerRow: width bitsPerPixel: 0];
372 [bmRep getBitmapDataPlanes: pixmapData];
374 bzero (pixmapData[i], width*height);
375 [self addRepresentation: bmRep];
380 /* attempt to pull out pixmap data from a BitmapImageRep; returns NO if fails */
381 - (void) setPixmapData
386 reps = [[self representations] objectEnumerator];
387 while (rep = (NSImageRep *) [reps nextObject])
389 if ([rep respondsToSelector: @selector (getBitmapDataPlanes:)])
391 bmRep = (NSBitmapImageRep *) rep;
392 onTiger = [bmRep respondsToSelector: @selector (colorAtX:y:)];
394 if ([bmRep numberOfPlanes] >= 3)
395 [bmRep getBitmapDataPlanes: pixmapData];
402 /* note; this and next work only for image created with initForXPMWithDepth,
403 initFromSkipXBM, or where setPixmapData was called successfully */
405 - (unsigned long) getPixelAtX: (int)x Y: (int)y
410 /* this method is faster but won't work for bitmaps */
411 if (pixmapData[0] != NULL)
413 int loc = x + y * [self size].width;
414 return (pixmapData[3][loc] << 24) /* alpha */
415 | (pixmapData[0][loc] << 16) | (pixmapData[1][loc] << 8)
416 | (pixmapData[2][loc]);
420 NSColor *color = [bmRep colorAtX: x y: y];
422 [color getRed: &r green: &g blue: &b alpha: &a];
423 return ((int)(a * 255.0) << 24)
424 | ((int)(r * 255.0) << 16) | ((int)(g * 255.0) << 8)
425 | ((int)(b * 255.0));
431 - (void) setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
432 green: (unsigned char)g blue: (unsigned char)b
433 alpha:(unsigned char)a;
438 if (pixmapData[0] != NULL)
440 int loc = x + y * [self size].width;
441 pixmapData[0][loc] = r;
442 pixmapData[1][loc] = g;
443 pixmapData[2][loc] = b;
444 pixmapData[3][loc] = a;
449 [NSColor colorWithCalibratedRed: r green: g blue: b alpha: a]
454 - (void) setAlphaAtX: (int) x Y: (int) y to: (unsigned char) a
459 if (pixmapData[0] != NULL)
461 int loc = x + y * [self size].width;
463 pixmapData[3][loc] = a;
467 NSColor *color = [bmRep colorAtX: x y: y];
468 color = [color colorWithAlphaComponent: (a / 255.0)];
469 [bmRep setColor: color atX: x y: y];
473 /* returns a pattern color, which is cached here */
474 - (NSColor *)stippleMask
476 if (stippleMask == nil)
477 stippleMask = [[NSColor colorWithPatternImage: self] retain];
483 // arch-tag: 6b310280-6892-4e5e-8f34-41c4d384874f