After a code review since last BookMacster shipment

Author: jerrykrinock

SSYBlocker.h

@@ -2,46 +2,52 @@
 
 
 /*!
- @brief    This class exposes three methods to block a "manager" thread
+ @brief    This class exposes three methods to block a "waiter" thread
  until a "worker" thread completes work.
+ 
+ @details  The typical usage of an SSYBlocker is:
+ 
+ • Waiter or Worker sends +alloc -init.
+ • Worker sends -lockLock.
+ • Worker begins work.
+ • Waiter sends -blockForLock, which blocks.
+ • Worker completes work.
+ • Worker sends -unlockLock
+ • -blockForLock returns, and Waiter continues its execution
+ 
+ Memory management of an SSYBlocker instance can be dangerous
+ if you cannot guarantee the order in which the messages will
+ be sent, or edge cases in which they might be re-sent.  If you
+ don't have too many of these things, you might want to be
+ conservative and retain them as instance variables of some
+ long-lived object.
 */
 @interface SSYBlocker : NSObject {
 	NSConditionLock* m_lock ;
 }
 
 /*!
  @brief    Initializes the receiver and its condition lock.
- 
- @details  This method should be invoked on the "manager" thread.
  */
 - (id)init ;
 
 /*!
  @brief    Locks the receiver's condition lock.
- 
- @details  This method should be invoked on the "worker" thread before
- beginning the work.
  */
 - (void)lockLock ;
 
 /*!
  @brief    Blocks until the receiver's condition lock is unlocked
- by -unlockLock, and then, before returning, removes the condition
- lock from the receiver's info dictionary.
- 
- @details  This method should be invoked on the "manager" thread after
- spinning off the "worker" thread to do the work. 
+ by -unlockLock.
  */
 - (void)blockForLock ;
 
 /*!
  @brief    Unlocks the receiver's condition lock.
  
- @details  This method should be invoked on the "worker" thread after work
- has been completed.  Before unlocking the lock, it checks to
- see that it is still locked, so it is OK if, during some error
- condition, you send -prepareLock, -lockLock, and then send
- this message more than once.
+ @details  Before unlocking the lock, this method checks to see that the
+ receiver's lock is still locked, so it is OK if, during some edge case
+ condition, you send this message more than once.
  */
 - (void)unlockLock ;
 

SSYLazyView.m

@@ -1,5 +1,4 @@
 #import "SSYLazyView.h"
-#import "SSYExtrospectiveViewController.h"
 #import "SSYAlert.h"
 
 NSString* SSYLazyViewErrorDomain = @"SSYLazyViewErrorDomain" ;
@@ -77,9 +76,11 @@ - (void)loadWithOwner:(id)owner {
     BOOL isMacOSX10_8orLater = [bundle respondsToSelector:@selector(loadNibNamed:owner:topLevelObjects:)] ;
 
     if (isMacOSX10_8orLater) {
+#pragma deploymate push "ignored-api-availability" // Skip it until next "pop"
         ok = [bundle loadNibNamed:nibName
                             owner:owner
                   topLevelObjects:&topLevelObjects] ;
+#pragma deploymate pop
         if (ok) {
             // See details of doc for -loadNibNamed:owner:topLevelObjects:,
             // https://developer.apple.com/library/ios/documentation/Cocoa/Conceptual/LoadingResources/CocoaNibs/CocoaNibs.html#//apple_ref/doc/uid/10000051i-CH4-SW6

SSYOperation.h

@@ -81,10 +81,27 @@
 - (NSError*)error ;
 
 /*!
- @brief    Sets the error of the receiver's operation queue.
+ @brief    Sets the error of the receiver's operation queue, and into the
+ userInfo dictionary of the error, adds key constKeySSYOperationGroup
+ with value equal to the name of the receiver's operation group
+ 
+ @details  Due to the addition of constKeySSYOperationGroup in the error's
+ userInfo, when other operations in the receiver's queue receive an -error
+ message, they will only return the error given here if their operation group's
+ name is the same as that of the receiver of this message.
 */
 - (void)setError:(NSError*)error ;
 
+/*!
+ @brief    Sets the error of the receiver's operation queue, without adding
+ key constKeySSYOperationGroup to the userInfo of the error
+ 
+ @details  Due to the non-addition of constKeySSYOperationGroup in the error's
+ userInfo, when other operations in the receiver's queue receive an -error
+ message, they will always return the error given here.
+ */
+- (void)setAllGroupsError:(NSError*)error ;
+
 /*!
  @brief    Appends the suffix _unsafe to the name of a given selector
  and performs the _unsafe selector on the main thread, making it safe(r).

SSYOperation.m

@@ -118,6 +118,12 @@ - (void)setError:(NSError*)error {
 						  operation:self] ;
 }
 
+- (void)setAllGroupsError:(NSError*)error {
+        [[self operationQueue] setError:error
+                              operation:nil] ;
+}
+
+
 - (NSString*)description {
 	NSString* selectorName = NSStringFromSelector([self selector]) ;
 	if ([selectorName isEqualToString:@"doDone:"]) {

SSYOperationQueue.m

@@ -238,7 +238,9 @@ - (void)observeValueForKeyPath:(NSString*)keyPath
                 // responds to -beginActivityWithOptions:reason:,
                 // which means that it should also respond to -endActivity:
                 if ([[NSProcessInfo processInfo] respondsToSelector:@selector(endActivity:)]) {
+#pragma deploymate push "ignored-api-availability" // Skip this until matching "pop"
                     [[NSProcessInfo processInfo] endActivity:activity] ;
+#pragma deploymate pop
                 }
             }
 #endif
@@ -282,8 +284,10 @@ - (void)observeValueForKeyPath:(NSString*)keyPath
                                     @"SSYOperations beginning with group %@ at %@",
                                     groupName,
                                     [[NSDate date] geekDateTimeString]] ;
+#pragma deploymate push "ignored-api-availability" // Skip it until next "pop"
                 id activity = [[NSProcessInfo processInfo] beginActivityWithOptions:NSActivityAutomaticTerminationDisabled
                                                                              reason:reason] ;
+#pragma deploymate pop
                 [self setNoAppNapActivity:activity] ;
             }
 #endif

SSYPersistentDocumentMultiMigrator.m

@@ -6,6 +6,8 @@
 #import "NSDocument+SyncModDate.h"
 #import "NSError+Recovery.h"
 #import "NSBundle+MainApp.h"
+#import "NSDocument+SSYAutosaveBetter.h"
+
 
 NSString* const SSYPersistentDocumentMultiMigratorErrorDomain = @"SSYPersistentDocumentMultiMigratorErrorDomain" ;
 NSString* const SSYPersistentDocumentMultiMigratorDidBeginMigrationNotification = @"SSYPersistentDocumentMultiMigratorDidBeginMigrationNotification" ;
@@ -255,7 +257,7 @@ + (BOOL)migrateIfNeededStoreAtUrl:(NSURL*)url
         // Fix in BookMacster 1.18.1, for Mac OS X 10.6
         BOOL isInViewingMode = NO ;
         if ([document respondsToSelector:@selector(isInViewingMode)]) {
-            isInViewingMode = [document isInViewingMode] ;
+            isInViewingMode = [document ssy_isInViewingMode] ;
         }
 #if 0
         // Fix 20130610 - Does not work.

SSYProcessTyper.m

@@ -154,7 +154,9 @@ + (NSInteger)weGotMenuBar {
         &&
         [[NSWorkspace sharedWorkspace] respondsToSelector:@selector(menuBarOwningApplication)]
         ) {
+#pragma deploymate push "ignored-api-availability" // Skip it until next "pop"
         NSRunningApplication* menuBarApp = [[NSWorkspace sharedWorkspace] menuBarOwningApplication] ;
+#pragma deploymate pop
         BOOL weGotMenuBar = ([menuBarApp isEqual:[NSRunningApplication currentApplication]]) ;
         answer = weGotMenuBar ? NSOnState : NSOffState ;
     }