1 /* Image support for the NeXT/Open/GNUstep and MacOSX window system.
2 Copyright (C) 1989, 1992-1994, 2005-2006, 2008-2013 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"
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 EmacsImage
*eImg
= nil
;
88 NSTRACE
(ns_load_image
);
90 if (STRINGP
(spec_file
))
92 eImg
= [EmacsImage allocInitFromFile
: spec_file
];
94 else if (STRINGP
(spec_data
))
98 data
= [NSData dataWithBytes
: SSDATA
(spec_data
)
99 length: SBYTES
(spec_data
)];
100 eImg
= [[EmacsImage alloc
] initWithData
: data
];
101 [eImg setPixmapData
];
106 add_to_log
("Unable to
load image %s", img->spec, Qnil);
111 img
->width
= size.width
;
112 img
->height
= size.height
;
114 /* 4) set img->pixmap = emacsimage */
121 ns_image_width
(void
*img
)
123 return [(id
)img
size].width
;
127 ns_image_height
(void
*img
)
129 return [(id
)img
size].height
;
133 ns_get_pixel
(void
*img
, int x
, int y
)
135 return [(EmacsImage
*)img getPixelAtX
: x Y
: y
];
139 ns_put_pixel
(void
*img
, int x
, int y
, unsigned
long argb
)
141 unsigned
char alpha
= (argb
>> 24) & 0xFF;
144 [(EmacsImage
*)img setPixelAtX
: x Y
: y toRed
: (argb
>> 16) & 0xFF
145 green
: (argb
>> 8) & 0xFF blue
: (argb
& 0xFF) alpha
: alpha
];
149 ns_set_alpha
(void
*img
, int x
, int y
, unsigned
char a
)
151 [(EmacsImage
*)img setAlphaAtX
: x Y
: y to
: a
];
155 /* ==========================================================================
157 Class supporting bitmaps and images of various sorts.
159 ========================================================================== */
161 @implementation EmacsImage
163 static EmacsImage
*ImageList
= nil
;
165 + allocInitFromFile
: (Lisp_Object
)file
167 EmacsImage
*image = ImageList
;
171 /* look for an existing image of the same name */
172 while (image != nil
&&
173 [[image name
] compare
: [NSString stringWithUTF8String
: SSDATA
(file
)]]
175 image = [image imageListNext
];
183 /* Search bitmap-file-path for the file, if appropriate. */
184 found
= x_find_image_file
(file
);
185 if (!STRINGP
(found
))
188 image = [[EmacsImage alloc
] initByReferencingFile
:
189 [NSString stringWithUTF8String
: SSDATA
(found
)]];
191 #
if defined
(NS_IMPL_COCOA
) && MAC_OS_X_VERSION_MAX_ALLOWED
>= MAC_OS_X_VERSION_10_6
192 imgRep
= [NSBitmapImageRep imageRepWithData
:[image TIFFRepresentation
]];
194 imgRep
= [image bestRepresentationForDevice
: nil
];
202 /* The next two lines cause the DPI of the image to be ignored.
203 This seems to be the behavior users expect. */
204 [image setScalesWhenResized
: YES
];
205 [image setSize
: NSMakeSize
([imgRep pixelsWide
], [imgRep pixelsHigh
])];
207 [image setName
: [NSString stringWithUTF8String
: SSDATA
(file
)]];
209 ImageList
= [image imageListSetNext
: ImageList
];
222 - imageListSetNext
: (id
)arg
231 return imageListNext
;
245 [stippleMask release
];
248 ImageList
= imageListNext
;
251 while (list
!= nil
&& [list imageListNext
] != self
)
252 list
= [list imageListNext
];
253 [list imageListSetNext
: imageListNext
];
260 - initFromXBM
: (unsigned
char *)bits width
: (int
)w height
: (int
)h
263 return [self initFromSkipXBM
: bits width
: w height
: h flip
: flip
length: 0];
267 - initFromSkipXBM
: (unsigned
char *)bits width
: (int
)w height
: (int
)h
268 flip
: (BOOL
)flip
length: (int
)length;
270 int bpr
= (w
+ 7) / 8;
271 unsigned
char *planes
[5];
273 [self initWithSize
: NSMakeSize
(w
, h
)];
275 bmRep
= [[NSBitmapImageRep alloc
] initWithBitmapDataPlanes
: NULL
276 pixelsWide
: w pixelsHigh
: h
277 bitsPerSample
: 8 samplesPerPixel
: 4
278 hasAlpha
: YES isPlanar
: YES
279 colorSpaceName
: NSCalibratedRGBColorSpace
280 bytesPerRow
: w bitsPerPixel
: 0];
282 [bmRep getBitmapDataPlanes
: planes
];
284 /* pull bits out to set the (bytewise) alpha mask */
286 unsigned
char *s
= bits
;
287 unsigned
char *alpha
= planes
[3];
288 unsigned
char swt
[16] = {0, 8, 4, 12, 2, 10, 6, 14, 1, 9, 5, 13,
290 unsigned
char c
, bitPat
;
292 for (j
= 0; j
< h
; j
++)
293 for (i
= 0; i
< bpr
; i
++)
297 unsigned
char s1
, s2
;
298 while (*s
++ != 'x' && s
< bits
+ length);
299 if (s
>= bits
+ length)
304 #define hexchar
(x
) ('0' <= (x
) && (x
) <= '9' ?
(x
) - '0' : (x
) - 'a' + 10)
307 c
= hexchar
(s1
) * 0x10 + hexchar
(s2
);
312 bitPat
= flip ? swt
[c
>> 4] |
(swt
[c
& 0xf] << 4) : c ^
255;
315 *alpha
++ = (bitPat
& 0x80) ?
0xff : 0;
321 [self addRepresentation
: bmRep
];
323 memset
(planes
[0], 0, w
*h
);
324 memset
(planes
[1], 0, w
*h
);
325 memset
(planes
[2], 0, w
*h
);
326 [self setXBMColor
: [NSColor blackColor
]];
331 /* Set color for a bitmap image (see initFromSkipXBM). Note that the alpha
332 is used as a mask, so we just memset the entire array. */
333 - setXBMColor
: (NSColor
*)color
335 NSSize s
= [self
size];
336 unsigned
char *planes
[5];
340 if (bmRep
== nil || color
== nil
)
343 if ([color colorSpaceName
] != NSCalibratedRGBColorSpace
)
344 rgbColor
= [color colorUsingColorSpaceName
: NSCalibratedRGBColorSpace
];
348 [rgbColor getRed
: &r green
: &g blue
: &b alpha
: &a
];
350 [bmRep getBitmapDataPlanes
: planes
];
352 /* we used to just do this, but Cocoa seems to have a bug when rendering
353 an alpha-masked image onto a dark background where it bloats the mask */
354 /* memset (planes[0..2], r, g, b*0xff, len); */
356 int i
, len
= s.width
*s.height
;
357 int rr
= r
* 0xff, gg
= g
* 0xff, bb
= b
* 0xff;
358 for (i
=0; i
<len
; i
++)
359 if (planes
[3][i
] != 0)
371 - initForXPMWithDepth
: (int
)depth width
: (int
)width height
: (int
)height
373 NSSize s
= {width
, height
};
376 [self initWithSize
: s
];
378 bmRep
= [[NSBitmapImageRep alloc
] initWithBitmapDataPlanes
: NULL
379 pixelsWide
: width pixelsHigh
: height
380 /* keep things simple for now */
381 bitsPerSample
: 8 samplesPerPixel
: 4 /*RGB+A*/
382 hasAlpha
: YES isPlanar
: YES
383 colorSpaceName
: NSCalibratedRGBColorSpace
384 bytesPerRow
: width bitsPerPixel
: 0];
386 [bmRep getBitmapDataPlanes
: pixmapData
];
388 memset
(pixmapData
[i
], 0, width
*height
);
389 [self addRepresentation
: bmRep
];
394 /* attempt to pull out pixmap data from a BitmapImageRep; returns NO if fails */
395 - (void
) setPixmapData
400 reps
= [[self representations
] objectEnumerator
];
401 while ((rep
= (NSImageRep
*) [reps nextObject
]))
403 if ([rep respondsToSelector
: @selector
(getBitmapDataPlanes
:)])
405 bmRep
= (NSBitmapImageRep
*) rep
;
407 if ([bmRep numberOfPlanes
] >= 3)
408 [bmRep getBitmapDataPlanes
: pixmapData
];
410 /* The next two lines cause the DPI of the image to be ignored.
411 This seems to be the behavior users expect. */
412 [self setScalesWhenResized
: YES
];
413 [self setSize
: NSMakeSize
([bmRep pixelsWide
], [bmRep pixelsHigh
])];
421 /* note; this and next work only for image created with initForXPMWithDepth,
422 initFromSkipXBM, or where setPixmapData was called successfully */
424 - (unsigned
long) getPixelAtX
: (int
)x Y
: (int
)y
429 /* this method is faster but won't work for bitmaps */
430 if (pixmapData
[0] != NULL)
432 int loc
= x
+ y
* [self
size].width
;
433 return (pixmapData
[3][loc
] << 24) /* alpha */
434 |
(pixmapData
[0][loc
] << 16) |
(pixmapData
[1][loc
] << 8)
435 |
(pixmapData
[2][loc
]);
439 NSColor
*color
= [bmRep colorAtX
: x y
: y
];
441 [color getRed
: &r green
: &g blue
: &b alpha
: &a
];
442 return ((int
)(a
* 255.0) << 24)
443 |
((int
)(r
* 255.0) << 16) |
((int
)(g
* 255.0) << 8)
444 |
((int
)(b
* 255.0));
449 - (void
) setPixelAtX
: (int
)x Y
: (int
)y toRed
: (unsigned
char)r
450 green
: (unsigned
char)g blue
: (unsigned
char)b
451 alpha
:(unsigned
char)a
;
456 if (pixmapData
[0] != NULL)
458 int loc
= x
+ y
* [self
size].width
;
459 pixmapData
[0][loc
] = r
;
460 pixmapData
[1][loc
] = g
;
461 pixmapData
[2][loc
] = b
;
462 pixmapData
[3][loc
] = a
;
467 [NSColor colorWithCalibratedRed
: (r
/255.0) green
: (g
/255.0)
468 blue
: (b
/255.0) alpha
: (a
/255.0)]
473 - (void
) setAlphaAtX
: (int
) x Y
: (int
) y to
: (unsigned
char) a
478 if (pixmapData
[0] != NULL)
480 int loc
= x
+ y
* [self
size].width
;
482 pixmapData
[3][loc
] = a
;
486 NSColor
*color
= [bmRep colorAtX
: x y
: y
];
487 color
= [color colorWithAlphaComponent
: (a
/ 255.0)];
488 [bmRep setColor
: color atX
: x y
: y
];
492 /* returns a pattern color, which is cached here */
493 - (NSColor
*)stippleMask
495 if (stippleMask
== nil
)
496 stippleMask
= [[NSColor colorWithPatternImage
: self
] retain
];