various bug fixes and small improvements for version 2.2.2 (2023-08-17)

Author: chuchusoft

AppKitAdditions/PGAppKitAdditions.m

@@ -120,13 +120,14 @@ - (NSColor *)PG_checkerboardPatternColor
 }
 - (NSColor *)PG_patternColorWithImage:(NSImage *)image fraction:(CGFloat)fraction
 {
+	assert(image);
 	NSSize const s = [image size];
 	NSRect const r = (NSRect){NSZeroPoint, s};
 	NSImage *const pattern = [[[NSImage alloc] initWithSize:s] autorelease];
 	[pattern lockFocus];
-	[self set];
-	NSRectFill(r);
-	[image drawInRect:r fromRect:NSZeroRect operation:NSCompositingOperationSourceAtop fraction:fraction];
+		[self set];
+		NSRectFill(r);
+		[image drawInRect:r fromRect:NSZeroRect operation:NSCompositingOperationSourceAtop fraction:fraction];
 	[pattern unlockFocus];
 	return [NSColor colorWithPatternImage:pattern];
 }

Controllers/PGBookmarkController.h

@@ -34,7 +34,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 	IBOutlet NSMenu *bookmarkMenu;
 	IBOutlet NSMenuItem *emptyMenuItem;
 	BOOL _deletesBookmarks;
-	NSMutableArray *_bookmarks;
+	NSMutableArray<PGBookmark*> *_bookmarks;
 }
 
 + (id)sharedBookmarkController;

Controllers/PGBookmarkController.m

@@ -36,7 +36,16 @@
 #import "PGAppKitAdditions.h"
 #import "PGFoundationAdditions.h"
 
-static NSString *const PGPausedDocumentsKey            = @"PGPausedDocuments4"; // file-ref is NSURL (not AliasHandle)
+//	2023/08/12 the paused document data blob is too large for NSUserDefaults in macOS 12 Monterey:
+//	"Sequential [User Defaults] CFPrefsPlistSource (Domain: com.SequentialX.Sequential,
+//	User: kCFPreferencesCurrentUser, ByHost: No, Container: (null), Contents Need Refresh: Yes):
+//	Attempting to store >= 4194304 bytes of data in CFPreferences/NSUserDefaults on this platform
+//	is invalid. This is a bug in Sequential or a library it uses."
+//
+//	Solution: store this data in a separate file in the Application Support folder instead of in
+//	the app's UserDefaults object.
+static NSString *const PGPausedDocumentsFileName		=	@"PausedDocuments.plist";
+//static NSString *const PGPausedDocumentsKey            = @"PGPausedDocuments4"; // file-ref is NSURL (not AliasHandle)
 #if 0
 static NSString *const PGPausedDocumentsDeprecated3Key = @"PGPausedDocuments3"; // Deprecated after 2.1.2.
 static NSString *const PGPausedDocumentsDeprecated2Key = @"PGPausedDocuments2"; // Deprecated after 1.3.2.
@@ -53,6 +62,42 @@ static OSStatus PGBookmarkControllerFlagsChanged(EventHandlerCallRef inHandlerCa
 }
 #endif
 
+static
+NSURL*
+GetBookmarksFileURL(BOOL createParentFolderIfNonExistant) {
+	NSFileManager*		fileMgr = NSFileManager.defaultManager;
+	NSArray<NSURL*>*	urls = [fileMgr URLsForDirectory:NSApplicationSupportDirectory
+											   inDomains:NSUserDomainMask];
+	if (nil == urls || 1 != urls.count)
+		return nil;
+
+	NSURL*	parentFolder = [[urls objectAtIndex:0] URLByAppendingPathComponent:NSBundle.mainBundle.bundleIdentifier
+																   isDirectory:YES];
+	if (nil == parentFolder)
+		return nil;
+	NSError*	error = nil;
+	BOOL		b = createParentFolderIfNonExistant ?
+					[fileMgr createDirectoryAtURL:parentFolder
+					  withIntermediateDirectories:NO
+									   attributes:nil
+											error:&error] : YES;
+//if (!b) NSLog(@"error %@", error);
+	if (!b) {
+		if (!error || !error.userInfo)
+			return nil;
+
+		id	ue	=	[error.userInfo objectForKey:NSUnderlyingErrorKey];
+		if (!ue || ![ue isKindOfClass:NSError.class])
+			return nil;
+
+		error	=	(NSError*) ue;
+		if (NSPOSIXErrorDomain != error.domain || EEXIST != error.code)
+			return nil;
+	}
+
+	return [parentFolder URLByAppendingPathComponent:PGPausedDocumentsFileName isDirectory:NO];
+}
+
 @interface PGBookmarkController(Private)
 
 - (void)_updateMenuItemForBookmark:(PGBookmark *)aBookmark;
@@ -177,9 +222,21 @@ - (void)_removeBookmarkAtIndex:(NSUInteger)index
 	[bookmarkMenu removeItemAtIndex:[bookmarkMenu numberOfItems] - index - 1];
 	if(![_bookmarks count]) [bookmarkMenu addItem:emptyMenuItem];
 }
+
 - (void)_saveBookmarks
 {
-#if 1	//	2021/07/21 modernized
+#if 1	//	2023/08/12 now saved to a separate file instead of NSUserDefaults (because it generates too-much-data warnings)
+		NSError*	error = nil;
+		NSData*		archivedBookmarks = [NSKeyedArchiver archivedDataWithRootObject:_bookmarks
+															  requiringSecureCoding:YES
+																			  error:&error];
+		if (nil == archivedBookmarks || nil != error)
+			return;
+
+		NSURL*	url = GetBookmarksFileURL(YES);
+//NSLog(@"%@ url = %@", PGPausedDocumentsFileName, url);
+		(void) [archivedBookmarks writeToURL:url options:NSDataWritingAtomic error:&error];
+#elif 1	//	2021/07/21 modernized
 /*	{
 		NSError*	error = nil;
 		NSData* d = [NSKeyedArchiver archivedDataWithRootObject:NSUserDefaults.standardUserDefaults.dictionaryRepresentation
@@ -228,13 +285,33 @@ - (id)init
 			InstallEventHandler(GetUserFocusEventTarget(), PGBookmarkControllerFlagsChanged, 2, list, self, NULL);
 #endif
 		}
+
+#if 1	//	2023/08/12 now saved to a separate file instead of NSUserDefaults (because it generates too-much-data warnings)
+		NSURL*		url = GetBookmarksFileURL(NO);
+//NSLog(@"%@ url = %@", PGPausedDocumentsFileName, url);
+		NSError*	error = nil;
+		NSData*		bookmarksData = [NSData dataWithContentsOfURL:url options:0 error:&error];
+#else
 		NSUserDefaults *const defaults = [NSUserDefaults standardUserDefaults];
 		NSData *bookmarksData = [defaults objectForKey:PGPausedDocumentsKey];
+#endif
+
 		BOOL bookmarksDataIsFromPGPausedDocumentsKey = nil != bookmarksData;
+
+		//	2023/08/12 transfer list of paused documents from UserDefaults to separate file
+		if (!bookmarksDataIsFromPGPausedDocumentsKey) {
+			bookmarksData	=	[NSUserDefaults.standardUserDefaults objectForKey:@"PGPausedDocuments4"];
+			if (nil != bookmarksData) {
+				[NSUserDefaults.standardUserDefaults removeObjectForKey:@"PGPausedDocuments4"];
+				[NSUserDefaults.standardUserDefaults synchronize];
+			}
+		}
+
 #if 1	//	2021/07/21 modernized
 		if(bookmarksData) {
 			NSError* error = nil;
 			NSSet* classes = [NSSet setWithArray:@[[NSMutableArray class], [PGBookmark class]]];
+		//	NSSet* classes = [NSSet setWithArray:@[[NSData class], [NSMutableArray class], [PGBookmark class]]];
 			_bookmarks = [[NSKeyedUnarchiver unarchivedObjectOfClasses:classes
 															  fromData:bookmarksData
 																 error:&error] retain];

Controllers/PGDisplayController.h

@@ -97,6 +97,7 @@ PGClipViewDelegate, PGDocumentWindowDelegate>
 - (IBAction)hideFindPanel:(id)sender;
 
 - (IBAction)toggleFullscreen:(id)sender;
+- (IBAction)toggleEntireScreenWhenInFullScreen:(id)sender;
 - (IBAction)toggleInfo:(id)sender;
 - (IBAction)toggleThumbnails:(id)sender;
 - (IBAction)changeReadingDirection:(id)sender;

Controllers/PGDisplayController.m

@@ -78,6 +78,7 @@ static inline NSSize PGConstrainSize(NSSize min, NSSize size, NSSize max)
 
 @interface PGDisplayController(Private)
 
+- (void)_setClipViewBackground;
 - (void)_setImageView:(PGImageView *)aView;
 - (BOOL)_setActiveNode:(PGNode *)aNode;
 - (void)_readActiveNode;
@@ -228,11 +229,23 @@ - (IBAction)hideFindPanel:(id)sender
 - (IBAction)toggleFullscreen:(id)sender
 {
 	[[PGDocumentController sharedDocumentController] setFullscreen:![PGDocumentController sharedDocumentController].fullscreen];
+
+	//	2023/08/14 the background color now depends on whether the view's window
+	//	is in fullscreen mode so the background color must be updated:
+	[self _setClipViewBackground];
+}
+
+- (IBAction)toggleEntireScreenWhenInFullScreen:(id)sender	//	2023/08/14 added
+{
+	PGDocumentController*	dc = PGDocumentController.sharedDocumentController;
+	dc.usesEntireScreenWhenInFullScreen	=	!dc.usesEntireScreenWhenInFullScreen;
 }
+
 - (IBAction)toggleInfo:(id)sender
 {
 	[[self activeDocument] setShowsInfo:![[self activeDocument] showsInfo]];
 }
+
 - (IBAction)toggleThumbnails:(id)sender
 {
 	[[self activeDocument] setShowsThumbnails:![[self activeDocument] showsThumbnails]];
@@ -856,13 +869,31 @@ - (void)thumbnailControllerContentInsetDidChange:(NSNotification *)aNotif
 	[w setMinSize:minSize];
 //	NSEnableScreenUpdates();	2021/07/21 deprecated
 }
+
 - (void)prefControllerBackgroundPatternColorDidChange:(NSNotification *)aNotif;
 {
-	[clipView setBackgroundColor:[[PGPreferenceWindowController sharedPrefController] backgroundPatternColor]];
+	[self _setClipViewBackground];
+}
+
+- (void)prefControllerBackgroundColorUsedInFullScreenDidChange:(NSNotification *)aNotif;
+{
+	if (PGDocumentController.sharedDocumentController.fullscreen)
+		[self _setClipViewBackground];	//	updates only when in fullscreen mode
 }
 
 #pragma mark -PGDisplayController(Private)
 
+- (void)_setClipViewBackground {
+	//	2023/08/14 added this method to enable the background color to depend on
+	//	whether the view's window is in fullscreen mode and whether user wants it
+	//	used in fullscreen mode.
+	if (PGDocumentController.sharedDocumentController.fullscreen &&
+		![NSUserDefaults.standardUserDefaults boolForKey:PGBackgroundColorUsedInFullScreenKey])
+		[clipView setBackgroundColor:NSColor.blackColor];
+	else
+		[clipView setBackgroundColor:[PGPreferenceWindowController.sharedPrefController backgroundPatternColor]];
+}
+
 - (void)_setImageView:(PGImageView *)aView
 {
 	if(aView == _imageView) return;
@@ -1055,6 +1086,7 @@ - (id)init
 		[self _updateInfoPanelText];
 
 		[[PGPreferenceWindowController sharedPrefController] PG_addObserver:self selector:@selector(prefControllerBackgroundPatternColorDidChange:) name:PGPreferenceWindowControllerBackgroundPatternColorDidChangeNotification];
+		[[PGPreferenceWindowController sharedPrefController] PG_addObserver:self selector:@selector(prefControllerBackgroundColorUsedInFullScreenDidChange:) name:PGPreferenceWindowControllerBackgroundColorUsedInFullScreenDidChangeNotification];
 		[[NSUserDefaults standardUserDefaults] addObserver:self forKeyPath:PGImageScaleConstraintKey options:kNilOptions context:NULL];
 	}
 	return self;
@@ -1112,6 +1144,11 @@ - (BOOL)validateMenuItem:(NSMenuItem *)anItem
 
 	// View:
 	if(@selector(toggleFullscreen:) == action) [anItem setTitle:NSLocalizedString(([[PGDocumentController sharedDocumentController] isFullscreen] ? @"Exit Full Screen" : @"Enter Full Screen"), @"Enter/exit full screen. Two states of the same item.")];
+	if(@selector(toggleEntireScreenWhenInFullScreen:) == action) {	//	2023/08/14 added
+		[anItem setState:PGDocumentController.sharedDocumentController.usesEntireScreenWhenInFullScreen];
+		//	this menu item is only enabled when the window is in full screen mode
+		return PGDocumentController.sharedDocumentController.fullscreen;
+	}
 	if(@selector(toggleInfo:) == action) [anItem setTitle:NSLocalizedString(([[self activeDocument] showsInfo] ? @"Hide Info" : @"Show Info"), @"Lets the user toggle the on-screen display. Two states of the same item.")];
 	if(@selector(toggleThumbnails:) == action) [anItem setTitle:NSLocalizedString(([[self activeDocument] showsThumbnails] ? @"Hide Thumbnails" : @"Show Thumbnails"), @"Lets the user toggle whether thumbnails are shown. Two states of the same item.")];
 	if(@selector(changeReadingDirection:) == action) [anItem setState:[[self activeDocument] readingDirection] == tag];

Controllers/PGDocumentController.h

@@ -36,8 +36,10 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 @class PGActivityPanelController;
 
 extern NSString *const PGAntialiasWhenUpscalingKey;
+extern NSString *const PGBackgroundColorSourceKey;	//	2023/08/17
 extern NSString *const PGBackgroundColorKey;
 extern NSString *const PGBackgroundPatternKey;
+extern NSString *const PGBackgroundColorUsedInFullScreenKey;	//	2023/08/14
 extern NSString *const PGMouseClickActionKey;
 extern NSString *const PGEscapeKeyMappingKey;
 extern NSString *const PGDimOtherScreensKey;
@@ -131,6 +133,8 @@ typedef NSUInteger PGImageScaleConstraint;
 @property(readonly) PGDisplayController *displayControllerForNewDocument;
 @property(assign, nonatomic, getter = isFullscreen) BOOL fullscreen;
 @property(readonly) BOOL canToggleFullscreen;
+@property(assign, nonatomic) BOOL usesEntireScreenWhenInFullScreen;	//	2023/08/14 added
+@property(readonly) BOOL canToggleUsesEntireScreenWhenInFullScreen;	//	2023/08/14 added
 @property(readonly, copy) NSArray *documents;
 @property(readonly) NSMenu *scaleMenu;
 @property(readonly) NSSlider *scaleSlider;

Controllers/PGDocumentController.m

@@ -59,8 +59,10 @@
 #import "PGZooming.h"
 
 NSString *const PGAntialiasWhenUpscalingKey = @"PGAntialiasWhenUpscaling";
+NSString *const PGBackgroundColorSourceKey = @"PGBackgroundColorSource";	//	2023/08/17
 NSString *const PGBackgroundColorKey = @"PGBackgroundColor";
 NSString *const PGBackgroundPatternKey = @"PGBackgroundPattern";
+NSString *const PGBackgroundColorUsedInFullScreenKey = @"PGBackgroundColorUsedInFullScreen";	//	2023/08/14
 NSString *const PGMouseClickActionKey = @"PGMouseClickAction";
 NSString *const PGEscapeKeyMappingKey = @"PGEscapeKeyMapping";
 NSString *const PGDimOtherScreensKey = @"PGDimOtherScreens";
@@ -69,6 +71,7 @@
 NSString *const PGShowFileNameOnImageThumbnailKey = @"PGShowFileNameOnImageThumbnail";
 NSString *const PGShowCountsAndSizesOnContainerThumbnailKey = @"PGShowCountsAndSizesOnContainerThumbnail";
 
+//	TODO: work out if these can be removed
 static NSString *const PGRecentItemsKey = @"PGRecentItems2";
 static NSString *const PGRecentItemsDeprecated2Key = @"PGRecentItems"; // Deprecated after 1.3.2
 static NSString *const PGRecentItemsDeprecatedKey = @"PGRecentDocuments"; // Deprecated after 1.2.2.
@@ -110,7 +113,7 @@ + (void)initialize
 	//	[NSArchiver archivedDataWithRootObject:[NSColor blackColor]],
 		[NSKeyedArchiver archivedDataWithRootObject:[NSColor blackColor] requiringSecureCoding:YES error:&error],
 		PGBackgroundColorKey,
-		[NSNumber numberWithUnsignedInteger:PGNoPattern], PGBackgroundPatternKey,
+		[NSNumber numberWithUnsignedInteger:PGNoPattern], PGBackgroundPatternKey,	//	misnomer; should be PGBackgroundPatternTypeKey
 		[NSNumber numberWithInteger:PGNextPreviousAction], PGMouseClickActionKey,
 		[NSNumber numberWithUnsignedInteger:1], PGMaxDepthKey,
 		@NO /* no */, PGFullscreenKey,
@@ -280,6 +283,7 @@ - (PGDisplayController *)displayControllerForNewDocument
 	}
 	return [[[PGWindowController alloc] init] autorelease];
 }
+
 @synthesize fullscreen = _fullscreen;
 - (void)setFullscreen:(BOOL)flag
 {
@@ -288,12 +292,38 @@ - (void)setFullscreen:(BOOL)flag
 	[[NSUserDefaults standardUserDefaults] setObject:[NSNumber numberWithBool:flag] forKey:PGFullscreenKey];
 	[self _setFullscreen:flag];
 }
+
 - (BOOL)canToggleFullscreen
 {
 	if(_fullscreen) return YES;
 	for(PGDocument *const doc in [self documents]) if([[[doc displayController] window] attachedSheet]) return NO;
 	return YES;
 }
+
+extern	const NSString* const	PGUseEntireScreenWhenInFullScreenKey;
+		const NSString* const	PGUseEntireScreenWhenInFullScreenKey	=	@"PGUseEntireScreenWhenInFullScreen";
+
+- (BOOL) usesEntireScreenWhenInFullScreen
+{
+	return [NSUserDefaults.standardUserDefaults
+			boolForKey:(NSString*)PGUseEntireScreenWhenInFullScreenKey];
+}
+
+- (void)setUsesEntireScreenWhenInFullScreen:(BOOL)flag	//	2023/08/14 added
+{
+	assert(_fullscreen && _fullscreenController);
+
+	[NSUserDefaults.standardUserDefaults setBool:flag
+										  forKey:(NSString*)PGUseEntireScreenWhenInFullScreenKey];
+
+	[_fullscreenController resizeToUseEntireScreen];
+}
+
+- (BOOL)canToggleUsesEntireScreenWhenInFullScreen	//	2023/08/14
+{
+	return _fullscreen;
+}
+
 @synthesize documents = _documents;
 - (NSMenu *)scaleMenu
 {
@@ -500,7 +530,7 @@ - (id)init
 		NSArray*	rdia = nil;
 		if (recentItemsData) {
 			NSError* error = nil;
-			NSSet* classes = [NSSet setWithArray:@[[NSArray class], [PGResourceIdentifier class]]];
+			NSSet* classes = [NSSet setWithArray:@[NSArray.class, NSData.class, PGResourceIdentifier.class]];
 			rdia	=	[NSKeyedUnarchiver unarchivedObjectOfClasses:classes
 															fromData:recentItemsData
 															   error:&error];

Controllers/PGFullscreenController.h

@@ -38,4 +38,6 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
 
 - (void)displayScreenDidChange:(NSNotification *)aNotif;
 
+- (void)resizeToUseEntireScreen;	//	2023/08/14 added
+
 @end

Controllers/PGFullscreenController.m

@@ -64,8 +64,6 @@ - (void)prepareToExitFullscreen
 	[self _setMenuBarHidden:NO delayed:NO]; // For some reason, this moves windows downward slightly (at least on 10.5.3), so make sure it happens before our new windows get put onscreen.
 }
 
-#pragma mark -
-
 - (void)displayScreenDidChange:(NSNotification *)aNotif
 {
 	NSScreen *const screen = [[PGPreferenceWindowController sharedPrefController] displayScreen];
@@ -74,6 +72,11 @@ - (void)displayScreenDidChange:(NSNotification *)aNotif
 	[self _setMenuBarHidden:[NSScreen PG_mainScreen] == screen delayed:YES];
 }
 
+- (void)resizeToUseEntireScreen	//	2023/08/14 added
+{
+	[(PGFullscreenWindow *)self.window resizeToUseEntireScreen];
+}
+
 #pragma mark -PGFullscreenController(Private)
 
 - (void)_setMenuBarHidden:(BOOL)hidden delayed:(BOOL)delayed
@@ -217,8 +220,7 @@ - (NSDragOperation)window:(PGDocumentWindow *)window dragOperationForInfo:(id<NS
 	NSArray *const types = [pboard types];
 #if 1
 	if([types containsObject:NSPasteboardTypeFileURL]) {
-		NSArray *const paths = [pboard propertyListForType:NSPasteboardTypeFileURL];
-		return [paths count] == 1 ? NSDragOperationGeneric : NSDragOperationNone;
+		return NSDragOperationGeneric;	//	2023/08/16 bugfix: no complex testing is now done
 	} else if([types containsObject:NSPasteboardTypeURL]) {
 		return [NSURL URLFromPasteboard:pboard] ? NSDragOperationGeneric : NSDragOperationNone;
 	}