1 /* Image support for the NeXT/Open/GNUstep and MacOSX window system.
2 Copyright (C) 1989, 1992-1994, 2005-2006, 2008-2015 Free Software
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"
39 int image_trace_num = 0;
40 #define NSTRACE(x) fprintf (stderr, "%s:%d: [%d] " #x "\n", \
41 __FILE__, __LINE__, ++image_trace_num)
47 /* ==========================================================================
49 C interface. This allows easy calling from C files. We could just
50 compile everything as Objective-C, but that might mean slower
51 compilation and possible difficulties on some platforms..
53 ========================================================================== */
56 ns_image_from_XBM (unsigned char *bits, int width, int height,
57 unsigned long fg, unsigned long bg)
59 NSTRACE (ns_image_from_XBM);
60 return [[EmacsImage alloc] initFromXBM: bits
61 width: width height: height
66 ns_image_for_XPM (int width, int height, int depth)
68 NSTRACE (ns_image_for_XPM);
69 return [[EmacsImage alloc] initForXPMWithDepth: depth
70 width: width height: height];
74 ns_image_from_file (Lisp_Object file)
76 NSTRACE (ns_image_from_bitmap_file);
77 return [EmacsImage allocInitFromFile: file];
81 ns_load_image (struct frame *f, struct image *img,
82 Lisp_Object spec_file, Lisp_Object spec_data)
84 EmacsImage *eImg = nil;
87 NSTRACE (ns_load_image);
89 if (STRINGP (spec_file))
91 eImg = [EmacsImage allocInitFromFile: spec_file];
93 else if (STRINGP (spec_data))
97 data = [NSData dataWithBytes: SSDATA (spec_data)
98 length: SBYTES (spec_data)];
99 eImg = [[EmacsImage alloc] initWithData: data];
100 [eImg setPixmapData];
105 add_to_log ("Unable to load image %s", img->spec, Qnil);
110 img->width = size.width;
111 img->height = size.height;
113 /* 4) set img->pixmap = emacsimage */
120 ns_image_width (void *img)
122 return [(id)img size].width;
126 ns_image_height (void *img)
128 return [(id)img size].height;
132 ns_get_pixel (void *img, int x, int y)
134 return [(EmacsImage *)img getPixelAtX: x Y: y];
138 ns_put_pixel (void *img, int x, int y, unsigned long argb)
140 unsigned char alpha = (argb >> 24) & 0xFF;
143 [(EmacsImage *)img setPixelAtX: x Y: y toRed: (argb >> 16) & 0xFF
144 green: (argb >> 8) & 0xFF blue: (argb & 0xFF) alpha: alpha];
148 ns_set_alpha (void *img, int x, int y, unsigned char a)
150 [(EmacsImage *)img setAlphaAtX: x Y: y to: a];
154 /* ==========================================================================
156 Class supporting bitmaps and images of various sorts.
158 ========================================================================== */
160 @implementation EmacsImage
162 + allocInitFromFile: (Lisp_Object)file
168 /* Search bitmap-file-path for the file, if appropriate. */
169 found = x_find_image_file (file);
170 if (!STRINGP (found))
173 image = [[EmacsImage alloc] initByReferencingFile:
174 [NSString stringWithUTF8String: SSDATA (found)]];
178 imgRep = [NSBitmapImageRep imageRepWithData:[image TIFFRepresentation]];
180 imgRep = [image bestRepresentationForDevice: nil];
188 /* The next two lines cause the DPI of the image to be ignored.
189 This seems to be the behavior users expect. */
191 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
192 [image setScalesWhenResized: YES];
195 [image setSize: NSMakeSize([imgRep pixelsWide], [imgRep pixelsHigh])];
197 [image setName: [NSString stringWithUTF8String: SSDATA (file)]];
205 [stippleMask release];
211 - initFromXBM: (unsigned char *)bits width: (int)w height: (int)h
212 fg: (unsigned long)fg bg: (unsigned long)bg
214 int bpr = (w + 7) / 8;
215 unsigned char *planes[5];
217 [self initWithSize: NSMakeSize (w, h)];
219 bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
220 pixelsWide: w pixelsHigh: h
221 bitsPerSample: 8 samplesPerPixel: 4
222 hasAlpha: YES isPlanar: YES
223 colorSpaceName: NSCalibratedRGBColorSpace
224 bytesPerRow: w bitsPerPixel: 0];
226 [bmRep getBitmapDataPlanes: planes];
228 if (fg == 0 && bg == 0)
232 /* pull bits out to set the (bytewise) alpha mask */
234 unsigned char *s = bits;
235 unsigned char *rr = planes[0];
236 unsigned char *gg = planes[1];
237 unsigned char *bb = planes[2];
238 unsigned char *alpha = planes[3];
239 unsigned char fgr = (fg >> 16) & 0xff;
240 unsigned char fgg = (fg >> 8) & 0xff;
241 unsigned char fgb = fg & 0xff;
242 unsigned char bgr = (bg >> 16) & 0xff;
243 unsigned char bgg = (bg >> 8) & 0xff;
244 unsigned char bgb = bg & 0xff;
248 for (j = 0; j < h; ++j)
252 for (k = 0; i < w && k < 8; ++k, ++i)
274 [self addRepresentation: bmRep];
278 /* Set color for a bitmap image. */
279 - setXBMColor: (NSColor *)color
281 NSSize s = [self size];
282 unsigned char *planes[5];
283 EmacsCGFloat r, g, b, a;
286 if (bmRep == nil || color == nil)
289 if ([color colorSpaceName] != NSCalibratedRGBColorSpace)
290 rgbColor = [color colorUsingColorSpaceName: NSCalibratedRGBColorSpace];
294 [rgbColor getRed: &r green: &g blue: &b alpha: &a];
296 [bmRep getBitmapDataPlanes: planes];
299 int i, len = s.width*s.height;
300 int rr = r * 0xff, gg = g * 0xff, bb = b * 0xff;
301 unsigned char fgr = (xbm_fg >> 16) & 0xff;
302 unsigned char fgg = (xbm_fg >> 8) & 0xff;
303 unsigned char fgb = xbm_fg & 0xff;
305 for (i = 0; i < len; ++i)
306 if (planes[0][i] == fgr && planes[1][i] == fgg && planes[2][i] == fgb)
312 xbm_fg = ((rr << 16) & 0xff) + ((gg << 8) & 0xff) + (bb & 0xff);
319 - initForXPMWithDepth: (int)depth width: (int)width height: (int)height
321 NSSize s = {width, height};
324 [self initWithSize: s];
326 bmRep = [[NSBitmapImageRep alloc] initWithBitmapDataPlanes: NULL
327 pixelsWide: width pixelsHigh: height
328 /* keep things simple for now */
329 bitsPerSample: 8 samplesPerPixel: 4 /*RGB+A*/
330 hasAlpha: YES isPlanar: YES
331 colorSpaceName: NSCalibratedRGBColorSpace
332 bytesPerRow: width bitsPerPixel: 0];
334 [bmRep getBitmapDataPlanes: pixmapData];
336 memset (pixmapData[i], 0, width*height);
337 [self addRepresentation: bmRep];
342 /* attempt to pull out pixmap data from a BitmapImageRep; returns NO if fails */
343 - (void) setPixmapData
348 reps = [[self representations] objectEnumerator];
349 while ((rep = (NSImageRep *) [reps nextObject]))
351 if ([rep respondsToSelector: @selector (getBitmapDataPlanes:)])
353 NSBitmapImageRep *bmr = (NSBitmapImageRep *) rep;
355 if ([bmr numberOfPlanes] >= 3)
356 [bmr getBitmapDataPlanes: pixmapData];
358 /* The next two lines cause the DPI of the image to be ignored.
359 This seems to be the behavior users expect. */
361 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
362 [self setScalesWhenResized: YES];
365 [self setSize: NSMakeSize([bmr pixelsWide], [bmr pixelsHigh])];
373 /* note; this and next work only for image created with initForXPMWithDepth,
374 initFromSkipXBM, or where setPixmapData was called successfully */
376 - (unsigned long) getPixelAtX: (int)x Y: (int)y
381 /* this method is faster but won't work for bitmaps */
382 if (pixmapData[0] != NULL)
384 int loc = x + y * [self size].width;
385 return (pixmapData[3][loc] << 24) /* alpha */
386 | (pixmapData[0][loc] << 16) | (pixmapData[1][loc] << 8)
387 | (pixmapData[2][loc]);
391 NSColor *color = [bmRep colorAtX: x y: y];
392 EmacsCGFloat r, g, b, a;
393 [color getRed: &r green: &g blue: &b alpha: &a];
394 return ((int)(a * 255.0) << 24)
395 | ((int)(r * 255.0) << 16) | ((int)(g * 255.0) << 8)
396 | ((int)(b * 255.0));
401 - (void) setPixelAtX: (int)x Y: (int)y toRed: (unsigned char)r
402 green: (unsigned char)g blue: (unsigned char)b
403 alpha:(unsigned char)a;
408 if (pixmapData[0] != NULL)
410 int loc = x + y * [self size].width;
411 pixmapData[0][loc] = r;
412 pixmapData[1][loc] = g;
413 pixmapData[2][loc] = b;
414 pixmapData[3][loc] = a;
419 [NSColor colorWithCalibratedRed: (r/255.0) green: (g/255.0)
420 blue: (b/255.0) alpha: (a/255.0)]
425 - (void) setAlphaAtX: (int) x Y: (int) y to: (unsigned char) a
430 if (pixmapData[0] != NULL)
432 int loc = x + y * [self size].width;
434 pixmapData[3][loc] = a;
438 NSColor *color = [bmRep colorAtX: x y: y];
439 color = [color colorWithAlphaComponent: (a / 255.0)];
440 [bmRep setColor: color atX: x y: y];
444 /* returns a pattern color, which is cached here */
445 - (NSColor *)stippleMask
447 if (stippleMask == nil)
448 stippleMask = [[NSColor colorWithPatternImage: self] retain];