1 /*
2 * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 #include "splashscreen_impl.h"
27
28 #import <Cocoa/Cocoa.h>
29 #import <objc/objc-auto.h>
30
31 #import <JavaNativeFoundation/JavaNativeFoundation.h>
32 #import "NSApplicationAWT.h"
33
34 #include <sys/time.h>
35 #include <pthread.h>
36 #include <iconv.h>
37 #include <langinfo.h>
38 #include <locale.h>
39 #include <fcntl.h>
40 #include <poll.h>
41 #include <errno.h>
42 #include <sys/types.h>
43 #include <signal.h>
44 #include <unistd.h>
45 #include <dlfcn.h>
46
47 #include <sizecalc.h>
48 #import "ThreadUtilities.h"
49
50 static NSScreen* SplashNSScreen()
51 {
52 return [[NSScreen screens] objectAtIndex: 0];
53 }
54
55 static void SplashCenter(Splash * splash)
56 {
57 NSRect screenFrame = [SplashNSScreen() frame];
58
59 splash->x = (screenFrame.size.width - splash->width) / 2;
60 splash->y = (screenFrame.size.height - splash->height) / 2 + screenFrame.origin.y;
61 }
62
63 unsigned
64 SplashTime(void) {
65 struct timeval tv;
66 struct timezone tz;
67 unsigned long long msec;
68
69 gettimeofday(&tv, &tz);
70 msec = (unsigned long long) tv.tv_sec * 1000 +
71 (unsigned long long) tv.tv_usec / 1000;
72
73 return (unsigned) msec;
74 }
75
76 /* Could use npt but decided to cut down on linked code size */
77 char* SplashConvertStringAlloc(const char* in, int* size) {
78 const char *codeset;
79 const char *codeset_out;
80 iconv_t cd;
81 size_t rc;
82 char *buf = NULL, *out;
83 size_t bufSize, inSize, outSize;
84 const char* old_locale;
85
86 if (!in) {
87 return NULL;
88 }
89 old_locale = setlocale(LC_ALL, "");
90
91 codeset = nl_langinfo(CODESET);
92 if ( codeset == NULL || codeset[0] == 0 ) {
93 goto done;
94 }
95 /* we don't need BOM in output so we choose native BE or LE encoding here */
96 codeset_out = (platformByteOrder()==BYTE_ORDER_MSBFIRST) ?
97 "UCS-2BE" : "UCS-2LE";
98
99 cd = iconv_open(codeset_out, codeset);
100 if (cd == (iconv_t)-1 ) {
101 goto done;
102 }
103 inSize = strlen(in);
104 buf = SAFE_SIZE_ARRAY_ALLOC(malloc, inSize, 2);
105 if (!buf) {
106 return NULL;
107 }
108 bufSize = inSize*2; // need 2 bytes per char for UCS-2, this is
109 // 2 bytes per source byte max
110 out = buf; outSize = bufSize;
111 /* linux iconv wants char** source and solaris wants const char**...
112 cast to void* */
113 rc = iconv(cd, (void*)&in, &inSize, &out, &outSize);
114 iconv_close(cd);
115
116 if (rc == (size_t)-1) {
117 free(buf);
118 buf = NULL;
119 } else {
120 if (size) {
121 *size = (bufSize-outSize)/2; /* bytes to wchars */
122 }
123 }
124 done:
125 setlocale(LC_ALL, old_locale);
126 return buf;
127 }
128
129 BOOL isSWTRunning() {
130 char envVar[80];
131 // If this property is present we are running SWT
132 snprintf(envVar, sizeof(envVar), "JAVA_STARTED_ON_FIRST_THREAD_%d", getpid());
133 return getenv(envVar) != NULL;
134 }
135
136 void SplashGetScaledImageName(const char* jar, const char* file,
137 float *scaleFactor, char *scaledFile,
138 const size_t scaledImageLength) {
139 *scaleFactor = 1;
140
141 if(isSWTRunning()){
142 return;
143 }
144
145 NSAutoreleasePool *pool = [NSAutoreleasePool new];
146 __block float screenScaleFactor = 1;
147
148 [ThreadUtilities performOnMainThreadWaiting:YES block:^(){
149 // initialize NSApplication and AWT stuff
150 [NSApplicationAWT sharedApplication];
151 screenScaleFactor = [SplashNSScreen() backingScaleFactor];
152 }];
153
154 if (screenScaleFactor > 1) {
155 NSString *fileName = [NSString stringWithUTF8String: file];
156 NSUInteger length = [fileName length];
157 NSRange range = [fileName rangeOfString: @"."
158 options:NSBackwardsSearch];
159 NSUInteger dotIndex = range.location;
160 NSString *fileName2x = nil;
161
162 if (dotIndex == NSNotFound) {
163 fileName2x = [fileName stringByAppendingString: @"@2x"];
164 } else {
165 fileName2x = [fileName substringToIndex: dotIndex];
166 fileName2x = [fileName2x stringByAppendingString: @"@2x"];
167 fileName2x = [fileName2x stringByAppendingString:
168 [fileName substringFromIndex: dotIndex]];
169 }
170
171 if ((fileName2x != nil) && (jar || [[NSFileManager defaultManager]
172 fileExistsAtPath: fileName2x])){
173 if(strlen([fileName2x UTF8String]) > scaledImageLength) {
174 [pool drain];
175 return;
176 }
177 *scaleFactor = 2;
178 strcpy(scaledFile, [fileName2x UTF8String]);
179 }
180 }
181 [pool drain];
182 return;
183 }
184
185 void
186 SplashInitPlatform(Splash * splash) {
187 pthread_mutex_init(&splash->lock, NULL);
188
189 splash->maskRequired = 0;
190
191
192 //TODO: the following is too much of a hack but should work in 90% cases.
193 // besides we don't use device-dependant drawing, so probably
194 // that's very fine indeed
195 splash->byteAlignment = 1;
196 initFormat(&splash->screenFormat, 0xff << 8,
197 0xff << 16, 0xff << 24, 0xff << 0);
198 splash->screenFormat.byteOrder = 1 ? BYTE_ORDER_LSBFIRST : BYTE_ORDER_MSBFIRST;
199 splash->screenFormat.depthBytes = 4;
200
201 // If we are running SWT we should not start a runLoop
202 if (!isSWTRunning()) {
203 [JNFRunLoop performOnMainThreadWaiting:NO withBlock:^() {
204 [NSApplicationAWT runAWTLoopWithApp:[NSApplicationAWT sharedApplication]];
205 }];
206 }
207 }
208
209 void
210 SplashCleanupPlatform(Splash * splash) {
211 splash->maskRequired = 0;
212 }
213
214 void
215 SplashDonePlatform(Splash * splash) {
216 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
217
218 pthread_mutex_destroy(&splash->lock);
219 [JNFRunLoop performOnMainThreadWaiting:YES withBlock:^(){
220 if (splash->window) {
221 [splash->window orderOut:nil];
222 [splash->window release];
223 }
224 }];
225 [pool drain];
226 }
227
228 void
229 SplashLock(Splash * splash) {
230 pthread_mutex_lock(&splash->lock);
231 }
232
233 void
234 SplashUnlock(Splash * splash) {
235 pthread_mutex_unlock(&splash->lock);
236 }
237
238 void
239 SplashInitFrameShape(Splash * splash, int imageIndex) {
240 // No shapes, we rely on alpha compositing
241 }
242
243 void * SplashScreenThread(void *param);
244 void
245 SplashCreateThread(Splash * splash) {
246 pthread_t thr;
247 pthread_attr_t attr;
248 int rc;
249
250 pthread_attr_init(&attr);
251 rc = pthread_create(&thr, &attr, SplashScreenThread, (void *) splash);
252 }
253
254 void
255 SplashRedrawWindow(Splash * splash) {
256 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
257
258 SplashUpdateScreenData(splash);
259
260 [JNFRunLoop performOnMainThreadWaiting:YES withBlock:^(){
261 // NSDeviceRGBColorSpace vs. NSCalibratedRGBColorSpace ?
262 NSBitmapImageRep * rep = [[NSBitmapImageRep alloc]
263 initWithBitmapDataPlanes: (unsigned char**)&splash->screenData
264 pixelsWide: splash->width
265 pixelsHigh: splash->height
266 bitsPerSample: 8
267 samplesPerPixel: 4
268 hasAlpha: YES
269 isPlanar: NO
270 colorSpaceName: NSDeviceRGBColorSpace
271 bitmapFormat: NSAlphaFirstBitmapFormat | NSAlphaNonpremultipliedBitmapFormat
272 bytesPerRow: splash->width * 4
273 bitsPerPixel: 32];
274
275 NSImage * image = [[NSImage alloc]
276 initWithSize: NSMakeSize(splash->width, splash->height)];
277 [image setBackgroundColor: [NSColor clearColor]];
278
279 [image addRepresentation: rep];
280 float scaleFactor = splash->scaleFactor;
281 if (scaleFactor > 0 && scaleFactor != 1) {
282 NSSize size = [image size];
283 size.width /= scaleFactor;
284 size.height /= scaleFactor;
285 [image setSize: size];
286 }
287
288 NSImageView * view = [[NSImageView alloc] init];
289
290 [view setImage: image];
291 [view setEditable: NO];
292 //NOTE: we don't set a 'wait cursor' for the view because:
293 // 1. The Cocoa GUI guidelines suggest to avoid it, and use a progress
294 // bar instead.
295 // 2. There simply isn't an instance of NSCursor that represent
296 // the 'wait cursor'. So that is undoable.
297
298 //TODO: only the first image in an animated gif preserves transparency.
299 // Loos like the splash->screenData contains inappropriate data
300 // for all but the first frame.
301
302 [image release];
303 [rep release];
304
305 [splash->window setContentView: view];
306 [splash->window orderFrontRegardless];
307 }];
308
309 [pool drain];
310 }
311
312 void SplashReconfigureNow(Splash * splash) {
313 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
314
315 [JNFRunLoop performOnMainThreadWaiting:YES withBlock:^(){
316 SplashCenter(splash);
317
318 if (!splash->window) {
319 return;
320 }
321
322 [splash->window orderOut:nil];
323 [splash->window setFrame: NSMakeRect(splash->x, splash->y, splash->width, splash->height)
324 display: NO];
325 }];
326
327 [pool drain];
328
329 SplashRedrawWindow(splash);
330 }
331
332 void
333 SplashEventLoop(Splash * splash) {
334
335 /* we should have splash _locked_ on entry!!! */
336
337 while (1) {
338 struct pollfd pfd[1];
339 int timeout = -1;
340 int ctl = splash->controlpipe[0];
341 int rc;
342 int pipes_empty;
343
344 pfd[0].fd = ctl;
345 pfd[0].events = POLLIN | POLLPRI;
346
347 errno = 0;
348 if (splash->isVisible>0 && SplashIsStillLooping(splash)) {
349 timeout = splash->time + splash->frames[splash->currentFrame].delay
350 - SplashTime();
351 if (timeout < 0) {
352 timeout = 0;
353 }
354 }
355 SplashUnlock(splash);
356 rc = poll(pfd, 1, timeout);
357 SplashLock(splash);
358 if (splash->isVisible > 0 && splash->currentFrame >= 0 &&
359 SplashTime() >= splash->time + splash->frames[splash->currentFrame].delay) {
360 SplashNextFrame(splash);
361 SplashRedrawWindow(splash);
362 }
363 if (rc <= 0) {
364 errno = 0;
365 continue;
366 }
367 pipes_empty = 0;
368 while(!pipes_empty) {
369 char buf;
370
371 pipes_empty = 1;
372 if (read(ctl, &buf, sizeof(buf)) > 0) {
373 pipes_empty = 0;
374 switch (buf) {
375 case SPLASHCTL_UPDATE:
376 if (splash->isVisible>0) {
377 SplashRedrawWindow(splash);
378 }
379 break;
380 case SPLASHCTL_RECONFIGURE:
381 if (splash->isVisible>0) {
382 SplashReconfigureNow(splash);
383 }
384 break;
385 case SPLASHCTL_QUIT:
386 return;
387 }
388 }
389 }
390 }
391 }
392
393 void *
394 SplashScreenThread(void *param) {
395 objc_registerThreadWithCollector();
396
397 NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
398 Splash *splash = (Splash *) param;
399
400 SplashLock(splash);
401 pipe(splash->controlpipe);
402 fcntl(splash->controlpipe[0], F_SETFL,
403 fcntl(splash->controlpipe[0], F_GETFL, 0) | O_NONBLOCK);
404 splash->time = SplashTime();
405 splash->currentFrame = 0;
406 [JNFRunLoop performOnMainThreadWaiting:YES withBlock:^(){
407 SplashCenter(splash);
408
409 splash->window = (void*) [[NSWindow alloc]
410 initWithContentRect: NSMakeRect(splash->x, splash->y, splash->width, splash->height)
411 styleMask: NSBorderlessWindowMask
412 backing: NSBackingStoreBuffered
413 defer: NO
414 screen: SplashNSScreen()];
415
416 [splash->window setOpaque: NO];
417 [splash->window setBackgroundColor: [NSColor clearColor]];
418 }];
419 fflush(stdout);
420 if (splash->window) {
421 [JNFRunLoop performOnMainThreadWaiting:YES withBlock:^(){
422 [splash->window orderFrontRegardless];
423 }];
424 SplashRedrawWindow(splash);
425 SplashEventLoop(splash);
426 }
427 SplashUnlock(splash);
428 SplashDone(splash);
429
430 splash->isVisible=-1;
431
432 [pool drain];
433
434 return 0;
435 }
436
437 void
438 sendctl(Splash * splash, char code) {
439 if (splash && splash->controlpipe[1]) {
440 write(splash->controlpipe[1], &code, 1);
441 }
442 }
443
444 void
445 SplashClosePlatform(Splash * splash) {
446 sendctl(splash, SPLASHCTL_QUIT);
447 }
448
449 void
450 SplashUpdate(Splash * splash) {
451 sendctl(splash, SPLASHCTL_UPDATE);
452 }
453
454 void
455 SplashReconfigure(Splash * splash) {
456 sendctl(splash, SPLASHCTL_RECONFIGURE);
457 }
458