From http://www.jwz.org/xscreensaver/xscreensaver-5.33.tar.gz
[xscreensaver] / OSX / SaverRunner.m
index 80031e775f6456b895cda3c6da664462e5a4317c..53eeccb8e39640d6285446bca7548b20935e6910 100644 (file)
 
 #ifdef USE_IPHONE
 
+# ifndef __IPHONE_8_0
+#  define UIInterfaceOrientationUnknown UIDeviceOrientationUnknown
+# endif
+# ifndef NSFoundationVersionNumber_iOS_7_1
+#  define NSFoundationVersionNumber_iOS_7_1 1047.25
+# endif
+# ifndef NSFoundationVersionNumber_iOS_8_0
+#  define NSFoundationVersionNumber_iOS_8_0 1134.10
+# endif
+
 @interface RotateyViewController : UINavigationController
 {
   BOOL allowRotation;
 
 @end
 
+
+@implementation SaverViewController
+
+@synthesize saverName;
+
+- (id)initWithSaverRunner:(SaverRunner *)parent
+{
+  self = [super init];
+  if (self) {
+    _parent = parent;
+    _storedOrientation = UIInterfaceOrientationUnknown;
+
+    self.modalTransitionStyle = UIModalTransitionStyleCrossDissolve;
+    self.wantsFullScreenLayout = YES;
+  }
+  return self;
+}
+
+
+- (void)dealloc
+{
+  [_saverName release];
+  [_saverView dealloc];
+  [super dealloc];
+}
+
+
+- (void)loadView
+{
+  // The UIViewController's view must never change, so it gets set here to
+  // a plain black background.
+
+  // This background view doesn't block the status bar, but that's probably
+  // OK, because it's never on screen for more than a fraction of a second.
+  UIView *backgroundView = [[UIView alloc] initWithFrame:CGRectNull];
+  backgroundView.backgroundColor = [UIColor blackColor];
+  self.view = backgroundView;
+}
+
+
+- (void)createSaverView
+{
+  UIView *parentView = self.view;
+
+  if (_saverView) {
+    [_saverView removeFromSuperview];
+    [_saverView release];
+  }
+
+  if (_storedOrientation != UIInterfaceOrientationUnknown) {
+    [[UIApplication sharedApplication]
+     setStatusBarOrientation:_storedOrientation
+     animated:NO];
+  }
+
+  _saverView = [_parent makeSaverView:_saverName
+                             withSize:parentView.bounds.size];
+
+  if (! _saverView) {
+    [[[UIAlertView alloc] initWithTitle: _saverName
+                          message: @"Unable to load!"
+                          delegate: nil
+                          cancelButtonTitle: @"Bummer"
+                          otherButtonTitles: nil]
+     show];
+    return;
+  }
+
+  _saverView.delegate = _parent;
+
+  [self.view addSubview:_saverView];
+
+  // The first responder must be set only after the view was placed in the view
+  // heirarchy.
+  [_saverView becomeFirstResponder]; // For shakes on iOS 6.
+  [_saverView startAnimation];
+  [_parent aboutPanel:_saverView orientation:_storedOrientation];
+}
+
+
+- (void)viewDidAppear:(BOOL)animated
+{
+  [self createSaverView];
+}
+
+
+- (BOOL)shouldAutorotateToInterfaceOrientation: (UIInterfaceOrientation)o
+{
+  return NO;                                   /* Deprecated in iOS 6 */
+}
+
+
+- (BOOL)shouldAutorotate                       /* Added in iOS 6 */
+{
+  return NO;
+}
+
+
+- (NSUInteger)supportedInterfaceOrientations   /* Added in iOS 6 */
+{
+  // Lies from the iOS docs:
+  // "This method is only called if the view controller's shouldAutorotate
+  // method returns YES."
+  return UIInterfaceOrientationMaskPortrait;
+}
+
+
+- (UIInterfaceOrientation)preferredInterfaceOrientationForPresentation
+{
+  return UIInterfaceOrientationPortrait;
+}
+
+
+- (void)setSaverName:(NSString *)name
+{
+  [name retain];
+  [_saverName release];
+  _saverName = name;
+  _storedOrientation = [UIApplication sharedApplication].statusBarOrientation;
+
+  if (_saverView)
+    [self createSaverView];
+}
+
+@end
+
 #endif // USE_IPHONE
 
 
 @implementation SaverRunner
 
 
-- (ScreenSaverView *) makeSaverView: (NSString *) module
-                           withSize: (NSSize) size
+- (XScreenSaverView *) makeSaverView: (NSString *) module
+                            withSize: (NSSize) size
 {
   Class new_class = 0;
 
   }
 # endif
 
-  return (ScreenSaverView *) instance;
+  return (XScreenSaverView *) instance;
 }
 
 
@@ -285,8 +421,14 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
 
   CGSize size = [[UIScreen mainScreen] bounds].size;
 
+  // iOS 7: Needs to be the actual device orientation.
+  // iOS 8: Needs to be UIInterfaceOrientationPortrait.
+
   UIInterfaceOrientation orient =
+    NSFoundationVersionNumber > NSFoundationVersionNumber_iOS_7_1 ?
+    UIInterfaceOrientationPortrait /* iOS 8 broke -[UIScreen bounds]. */ :
     [[window rootViewController] interfaceOrientation];
+
   if (orient == UIInterfaceOrientationLandscapeLeft ||
       orient == UIInterfaceOrientationLandscapeRight) {
     // Rotate the shape of the canvas 90 degrees.
@@ -374,7 +516,8 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
 
 - (void) openPreferences: (NSString *) saver
 {
-  [self loadSaver:saver launch:NO];
+  XScreenSaverView *saverView = [self makeSaverView:saver
+                                           withSize:CGSizeMake(0, 0)];
   if (! saverView) return;
 
   NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
@@ -383,6 +526,8 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
 
   [rotating_nav pushViewController: [saverView configureView]
                       animated:YES];
+
+  [saverView release];
 }
 
 
@@ -390,17 +535,16 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
 
 
 
-- (void)loadSaver:(NSString *)name launch:(BOOL)launch
+- (void)loadSaver:(NSString *)name
 {
 # ifndef USE_IPHONE
 
   if (saverName && [saverName isEqualToString: name]) {
-    if (launch)
-      for (NSWindow *win in windows) {
-        ScreenSaverView *sv = find_saverView ([win contentView]);
-        if (![sv isAnimating])
-          [sv startAnimation];
-      }
+    for (NSWindow *win in windows) {
+      ScreenSaverView *sv = find_saverView ([win contentView]);
+      if (![sv isAnimating])
+        [sv startAnimation];
+    }
     return;
   }
 
@@ -431,8 +575,7 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
     [win makeFirstResponder:new_view];
     [new_view setAutoresizingMask:NSViewWidthSizable|NSViewHeightSizable];
     [new_view retain];
-    if (launch)
-      [new_view startAnimation];
+    [new_view startAnimation];
   }
 
   NSUserDefaultsController *ctl =
@@ -449,106 +592,118 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
   [prefs setObject:name forKey:@"selectedSaverName"];
   [prefs synchronize];
 
+/* Cacheing this screws up rotation when starting a saver twice in a row.
   if (saverName && [saverName isEqualToString: name]) {
     if ([saverView isAnimating])
       return;
     else
       goto LAUNCH;
   }
+*/
 
   saverName = name;
 
-  if (saverView) {
-    if ([saverView isAnimating])
-      [saverView stopAnimation];
-    [saverView removeFromSuperview];
-    [backgroundView removeFromSuperview];
-    [[NSNotificationCenter defaultCenter] removeObserver:saverView];
-    [saverView release];
+  if (nonrotating_controller) {
+    nonrotating_controller.saverName = name;
+    return;
   }
 
-  /* We can't just use [window bounds] because that is the *rotated* rectangle
-     and we need the *unrotated* rectangle, so that the view is always created
-     in portrait orientation.  Without that, the initial rotation event that
-     takes us from unknown->landscape will be out of step with reality.
-   */
+# if TARGET_IPHONE_SIMULATOR
   UIScreen *screen = [UIScreen mainScreen];
-# ifndef __IPHONE_8_0                          // iOS 7 SDK
-  NSSize size = [screen bounds].size;
-  int ss = [screen scale];
-# else                                         // iOS 8 SDK
-  NSSize size = ([screen respondsToSelector:@selector(nativeBounds)]
-                 ? [screen nativeBounds].size  //  iOS 8
-                 : [screen bounds].size);      //  iOS 7
-  int ss = ([screen respondsToSelector:@selector(nativeScale)]
-            ? [screen nativeScale]             //  iOS 8
-            : [screen scale]);                 //  iOS 7
-# endif                                                // iOS 8 SDK
-
-  size.width  /= ss;
-  size.height /= ss;
-  saverView = [self makeSaverView:name withSize:size];
-
-  if (! saverView) {
-    [[[UIAlertView alloc] initWithTitle: name
-                          message: @"Unable to load!"
-                          delegate: nil
-                          cancelButtonTitle: @"Bummer"
-                          otherButtonTitles: nil]
-     show];
-    return;
-  }
 
-  [[NSNotificationCenter defaultCenter]
-    addObserver:saverView
-    selector:@selector(didRotate:)
-    name:UIDeviceOrientationDidChangeNotification object:nil];
-
- LAUNCH:
-
-  if (launch) {
-    [self saveScreenshot];
-    NSRect f = [saverWindow bounds];
-    [backgroundView setFrame:f];
-    [saverView setFrame:f];
-    [saverWindow addSubview: backgroundView];
-    [backgroundView addSubview: saverView];
-    [saverView setBackgroundColor:[NSColor blackColor]];
-
-    /* WTF! Without creating and keying this window, we get no events
-       delivered on the saverView/saverWindow!  Bad craziness.
-     */
-    {
-      UIWindow *dummy = [[UIWindow alloc] initWithFrame:CGRectMake(0,0,0,0)];
-      [dummy setRootViewController: nonrotating_nav];  // Must be this one.
-      [dummy setHidden:NO];  // required
-      [dummy setHidden:YES];
-      [dummy release];
-    }
+  /* 'nativeScale' is very confusing.
+
+     iPhone 4s:
+        bounds:        320x480   scale:        2
+        nativeBounds:  640x960   nativeScale:  2
+     iPhone 5s:
+        bounds:        320x568   scale:        2
+        nativeBounds:  640x1136  nativeScale:  2
+     iPad 2:
+        bounds:       768x1024   scale:        1
+        nativeBounds: 768x1024   nativeScale:  1
+     iPad Retina/Air:
+        bounds:       768x1024   scale:        2
+        nativeBounds: 1536x2048  nativeScale:  2
+     iPhone 6:
+        bounds:        320x568   scale:        2
+        nativeBounds:  640x1136  nativeScale:  2
+     iPhone 6+:
+        bounds:        320x568   scale:        2
+        nativeBounds:  960x1704  nativeScale:  3
+
+     According to a StackOverflow comment:
+
+       The iPhone 6+ renders internally using @3x assets at a virtual
+       resolution of 2208x1242 (with 736x414 points), then samples that down
+       for display. The same as using a scaled resolution on a Retina MacBook
+       -- it lets them hit an integral multiple for pixel assets while still
+       having e.g. 12pt text look the same size on the screen.
+
+       The 6, the 5s, the 5, the 4s and the 4 are all 326 pixels per inch,
+       and use @2x assets to stick to the approximately 160 points per inch
+       of all previous devices.
+
+       The 6+ is 401 pixels per inch. So it'd hypothetically need roughly
+       @2.46x assets. Instead Apple uses @3x assets and scales the complete
+       output down to about 84% of its natural size.
+
+       In practice Apple has decided to go with more like 87%, turning the
+       1080 into 1242. No doubt that was to find something as close as
+       possible to 84% that still produced integral sizes in both directions
+       -- 1242/1080 = 2208/1920 exactly, whereas if you'd turned the 1080
+       into, say, 1286, you'd somehow need to render 2286.22 pixels
+       vertically to scale well.
+   */
 
-    [saverWindow setHidden:NO];
-    [saverWindow makeKeyAndVisible];
-    [saverView startAnimation];
-    [self aboutPanel:nil];
+  NSLog(@"screen: %.0fx%0.f",
+        [[screen currentMode] size].width,
+        [[screen currentMode] size].height);
+  NSLog(@"bounds: %.0fx%0.f x %.1f = %.0fx%0.f",
+        [screen bounds].size.width,
+        [screen bounds].size.height,
+        [screen scale],
+        [screen scale] * [screen bounds].size.width,
+        [screen scale] * [screen bounds].size.height);
+
+#  ifdef __IPHONE_8_0
+  if ([screen respondsToSelector:@selector(nativeBounds)])
+    NSLog(@"native: %.0fx%0.f / %.1f = %.0fx%0.f",
+          [screen nativeBounds].size.width,
+          [screen nativeBounds].size.height,
+          [screen nativeScale],
+          [screen nativeBounds].size.width  / [screen nativeScale],
+          [screen nativeBounds].size.height / [screen nativeScale]);
+#  endif
+# endif // TARGET_IPHONE_SIMULATOR
 
-    // Doing this makes savers cut back to the list instead of fading,
-    // even though [XScreenSaverView stopAndClose] does setHidden:NO first.
-    // [window setHidden:YES];
-  }
-# endif // USE_IPHONE
-}
+  // Take the screen shot before creating the screen saver view, because this
+  // can screw with the layout.
+  [self saveScreenshot];
 
+  // iOS 3.2. Before this were iPhones (and iPods) only, which always did modal
+  // presentation full screen.
+  rotating_nav.modalPresentationStyle = UIModalPresentationFullScreen;
 
-- (void)loadSaver:(NSString *)name
-{
-  [self loadSaver:name launch:YES];
+  nonrotating_controller = [[SaverViewController alloc] initWithSaverRunner:self];
+  nonrotating_controller.saverName = name;
+
+  /* LAUNCH: */
+
+  [rotating_nav presentViewController:nonrotating_controller animated:NO completion:nil];
+
+  // Doing this makes savers cut back to the list instead of fading,
+  // even though [XScreenSaverView stopAndClose] does setHidden:NO first.
+  // [window setHidden:YES];
+
+# endif // USE_IPHONE
 }
 
 
+#ifndef USE_IPHONE
+
 - (void)aboutPanel:(id)sender
 {
-# ifndef USE_IPHONE
-
   NSDictionary *bd = [saverBundle infoDictionary];
   NSMutableDictionary *d = [NSMutableDictionary dictionaryWithCapacity:20];
 
@@ -564,8 +719,13 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
 
   [[NSApplication sharedApplication]
     orderFrontStandardAboutPanelWithOptions:d];
-# else  // USE_IPHONE
+}
+
+#else  // USE_IPHONE
 
+- (void)aboutPanel:(UIView *)saverView
+       orientation:(UIInterfaceOrientation)orient
+{
   if ([saverNames count] == 1)
     return;
 
@@ -601,7 +761,7 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
   CGSize tsize2 = [year sizeWithFont:font2
                    constrainedToSize:CGSizeMake(frame.size.width,
                                                 frame.size.height)];
-#endif
+# endif
 
   CGSize tsize = CGSizeMake (tsize1.width > tsize2.width ?
                              tsize1.width : tsize2.width,
@@ -620,25 +780,23 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
 
   frame = CGRectMake (0, 0, tsize.width, tsize.height);
 
-  UIInterfaceOrientation orient = [rotating_nav interfaceOrientation];
-
   /* Get the text oriented properly, and move it to the bottom of the
      screen, since many savers have action in the middle.
    */
   switch (orient) {
-  case UIDeviceOrientationLandscapeRight:     
+  case UIInterfaceOrientationLandscapeLeft:
     rot = -M_PI/2;
     frame.origin.x = ([saverView frame].size.width
                       - (tsize.width - tsize.height) / 2
                       - tsize.height);
     frame.origin.y = ([saverView frame].size.height - tsize.height) / 2;
     break;
-  case UIDeviceOrientationLandscapeLeft:
+  case UIInterfaceOrientationLandscapeRight:
     rot = M_PI/2;
     frame.origin.x = -(tsize.width - tsize.height) / 2;
     frame.origin.y = ([saverView frame].size.height - tsize.height) / 2;
     break;
-  case UIDeviceOrientationPortraitUpsideDown: 
+  case UIInterfaceOrientationPortraitUpsideDown:
     rot = M_PI;
     frame.origin.x = ([saverView frame].size.width  - tsize.width) / 2;
     frame.origin.y = 0;
@@ -711,7 +869,7 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
   anim.toValue      = [NSNumber numberWithFloat:1.0];
   [aboutBox.layer addAnimation:anim forKey:@"animateOpacity"];
 
-  [backgroundView addSubview:aboutBox];
+  [saverView addSubview:aboutBox];
 
   if (splashTimer)
     [splashTimer invalidate];
@@ -722,11 +880,9 @@ relabel_menus (NSObject *v, NSString *old_str, NSString *new_str)
              selector:@selector(aboutOff)
              userInfo:nil
              repeats:NO];
-# endif // USE_IPHONE
 }
 
 
-# ifdef USE_IPHONE
 - (void)aboutOff
 {
   if (aboutBox) {
@@ -1014,6 +1170,37 @@ FAIL:
 }
 
 
+- (void) wantsFadeOut:(XScreenSaverView *)sender
+{
+  rotating_nav.view.hidden = NO; // In case it was hidden during startup.
+
+  /* The XScreenSaverView screws with the status bar orientation, mostly to
+     keep the simulator oriented properly. But on iOS 8.1 (and maybe 8.0
+     and/or 8.2), this confuses the UINavigationController, so put the
+     orientation back to portrait before dismissing the SaverViewController.
+   */
+  [[UIApplication sharedApplication]
+   setStatusBarOrientation:UIInterfaceOrientationPortrait
+   animated:NO];
+
+  [rotating_nav dismissViewControllerAnimated:YES completion:^() {
+    [nonrotating_controller release];
+    nonrotating_controller = nil;
+    [[rotating_nav view] becomeFirstResponder];
+  }];
+}
+
+
+- (void) didShake:(XScreenSaverView *)sender
+{
+# if TARGET_IPHONE_SIMULATOR
+  NSLog (@"simulating shake on saver list");
+# endif
+  [[rotating_nav topViewController] motionEnded: UIEventSubtypeMotionShake
+                                      withEvent: nil];
+}
+
+
 #endif // USE_IPHONE
 
 
@@ -1173,6 +1360,8 @@ FAIL:
 {
   [self listSaverBundleNames];
 
+  NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
+
 # ifndef USE_IPHONE
   int window_count = ([saverNames count] <= 1 ? 1 : 2);
   NSMutableArray *a = [[NSMutableArray arrayWithCapacity: window_count+1]
@@ -1197,54 +1386,28 @@ FAIL:
 # undef ya_rand_init
   ya_rand_init (0);    // Now's a good time.
 
+
+  /* iOS docs say:
+     "You must call this method before attempting to get orientation data from
+      the receiver. This method enables the device's accelerometer hardware
+      and begins the delivery of acceleration events to the receiver."
+
+     Adding or removing this doesn't seem to make any difference. It's
+     probably getting called by the UINavigationController. Still... */
+  [[UIDevice currentDevice] beginGeneratingDeviceOrientationNotifications];
+
   rotating_nav = [[[RotateyViewController alloc] initWithRotation:YES]
                          retain];
+
+  if ([prefs boolForKey:@"wasRunning"]) // Prevents menu flicker on startup.
+    rotating_nav.view.hidden = YES;
+
   [window setRootViewController: rotating_nav];
   [window setAutoresizesSubviews:YES];
   [window setAutoresizingMask: 
             (UIViewAutoresizingFlexibleWidth | 
              UIViewAutoresizingFlexibleHeight)];
 
-  nonrotating_nav = [[[RotateyViewController alloc] initWithRotation:NO]
-                          retain];
-  [nonrotating_nav setNavigationBarHidden:YES animated:NO];
-
-  /* We run the saver on a different UIWindow than the one the
-     SaverListController and preferences panels run on, because that's
-     the only way to make rotation work right.  We want the system to
-     handle rotation of the UI stuff, but we want it to keep its hands
-     off of rotation of the savers.  As of iOS 8, this seems to be the
-     only way to accomplish that.
-
-     Also, we need to create saverWindow with a portrait rectangle, always.
-     Note that [UIScreen bounds] returns rotated and scaled values.
-  */
-  UIScreen *screen = [UIScreen mainScreen];
-# ifndef __IPHONE_8_0                          // iOS 7 SDK
-  NSRect frame = [screen bounds];
-  int ss = [screen scale];
-# else                                         // iOS 8 SDK
-  NSRect frame = ([screen respondsToSelector:@selector(nativeBounds)]
-                 ? [screen nativeBounds]       //   iOS 8
-                 : [screen bounds]);           //   iOS 7
-  int ss = ([screen respondsToSelector:@selector(nativeScale)]
-            ? [screen nativeScale]             //   iOS 8
-            : [screen scale]);                 //   iOS 7
-# endif                                                // iOS 8 SDK
-  frame.size.width  /= ss;
-  frame.size.height /= ss;
-  saverWindow = [[UIWindow alloc] initWithFrame:frame];
-  [saverWindow setRootViewController: nonrotating_nav];
-  [saverWindow setHidden:YES];
-
-  /* This view is the parent of the XScreenSaverView, and exists only
-     so that there is a black background behind it.  Without this, when
-     rotation is in progress, the scrolling-list window's corners show
-     through in the corners.
-  */
-  backgroundView = [[[NSView class] alloc] initWithFrame:[saverWindow frame]];
-  [backgroundView setBackgroundColor:[NSColor blackColor]];
-
   SaverListController *menu = [[SaverListController alloc] 
                                 initWithNames:saverNames
                                 descriptions:[self makeDescTable]];
@@ -1277,8 +1440,6 @@ FAIL:
   if (!forced && [saverNames count] == 1)
     forced = [saverNames objectAtIndex:0];
 
-  NSUserDefaults *prefs = [NSUserDefaults standardUserDefaults];
-
 # ifdef USE_IPHONE
   NSString *prev = [prefs stringForKey:@"selectedSaverName"];