Update to new APIs for reading/writing plists

rdwampler · rdwampler · commit 2f5d7381835f · 2014-09-10T22:22:14.000-04:00
These do not cause a problem yet, but the new APIs follow proper Cocoa memory management rules and will make upgrading to ARC easier.

Also, since we now return an NSError instead of an NSString, we should not expect upon successful completion that these methods will return nil for the passed NSError object.
diff --git a/CLIProxy.mm b/CLIProxy.mm
@@ -140,11 +140,11 @@ - (void)writeStringToError:(NSString*)text;
 
 - (id)readPropertyListFromInput;
 {
-	NSString* error = nil;
-	id plist        = [TMDCommand readPropertyList:[self inputHandle] error:&error];
+	NSError* error = nil;
+	id plist       = [TMDCommand readPropertyList:[self inputHandle] error:&error];
 
-	if(error || !plist)
-		[self writeStringToError:error ?: @"unknown error parsing property list\n"];
+	if(!plist)
+		[self writeStringToError:[error localizedDescription] ?: @"unknown error parsing property list\n"];
 
 	return plist;
 }
diff --git a/Commands/defaults.mm b/Commands/defaults.mm
@@ -17,7 +17,7 @@ - (void)handleCommand:(CLIProxy*)proxy
 	{
 		// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)
 		if([defaults isKindOfClass:[NSString class]])
-			defaults = [NSPropertyListSerialization propertyListFromData:[(NSString*)defaults dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+			defaults = [NSPropertyListSerialization propertyListWithData:[(NSString*)defaults dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 
 		[[NSUserDefaults standardUserDefaults] registerDefaults:defaults];
 	}
diff --git a/Commands/filepanel.mm b/Commands/filepanel.mm
@@ -47,7 +47,7 @@ - (NSSavePanel*)setupSavePanel:(NSSavePanel*)savePanel usingParameters:(NSDictio
 
 	if(NSString* typesStr = args[@"allowedFileTypes"])
 	{
-		id rawTypes = [NSPropertyListSerialization propertyListFromData:[typesStr dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+		id rawTypes = [NSPropertyListSerialization propertyListWithData:[typesStr dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 		NSArray* types = nil;
 		if([rawTypes isKindOfClass:[NSString class]])
 			types = [NSArray arrayWithObject:rawTypes];
diff --git a/Commands/images.mm b/Commands/images.mm
@@ -17,7 +17,7 @@ - (void)handleCommand:(CLIProxy*)proxy
 	// Convert image paths to NSImages
 	NSDictionary* imagePaths = [args objectForKey:@"register"];
 	if([imagePaths isKindOfClass:[NSString class]])
-		imagePaths = [NSPropertyListSerialization propertyListFromData:[(NSString*)imagePaths dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+		imagePaths = [NSPropertyListSerialization propertyListWithData:[(NSString*)imagePaths dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 
 	for(NSString* imageName in [imagePaths allKeys])
 	{
diff --git a/Commands/menu.mm b/Commands/menu.mm
@@ -55,7 +55,7 @@ - (void)handleCommand:(CLIProxy*)proxy
 
 	// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)
 	if([menuItems isKindOfClass:[NSString class]])
-		menuItems = [NSPropertyListSerialization propertyListFromData:[(NSString*)menuItems dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+		menuItems = [NSPropertyListSerialization propertyListWithData:[(NSString*)menuItems dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 
 	NSMenu* menu = [[[NSMenu alloc] init] autorelease];
 	[menu setFont:[NSFont menuFontOfSize:([[NSUserDefaults standardUserDefaults] integerForKey:@"OakBundleManagerDisambiguateMenuFontSize"] ?: [NSFont smallSystemFontSize])]];
diff --git a/Commands/nib/nib.mm b/Commands/nib/nib.mm
@@ -83,7 +83,7 @@ - (void)handleCommand:(CLIProxy*)proxy
 
 	// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)
 	if([model isKindOfClass:[NSString class]])
-		model = [NSPropertyListSerialization propertyListFromData:[(NSString*)model dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+		model = [NSPropertyListSerialization propertyListWithData:[(NSString*)model dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 
 	if(NSString* updateToken = [args objectForKey:@"update"])
 	{
diff --git a/Commands/popup/popup.mm b/Commands/popup/popup.mm
@@ -31,7 +31,7 @@ - (void)handleCommand:(CLIProxy*)proxy
 
 	NSArray* suggestions = [args objectForKey:@"suggestions"];
 	if([suggestions isKindOfClass:[NSString class]])
-		suggestions = [NSPropertyListSerialization propertyListFromData:[(NSString*)suggestions dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+		suggestions = [NSPropertyListSerialization propertyListWithData:[(NSString*)suggestions dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 
 	TMDIncrementalPopUpMenu* xPopUp = [[TMDIncrementalPopUpMenu alloc] initWithItems:suggestions alreadyTyped:filter staticPrefix:prefix additionalWordCharacters:allow caseSensitive:!caseInsensitive writeChoiceToFileDescriptor:(wait ? [proxy outputHandle] : nil)];
 
diff --git a/Commands/prototype/prototype.mm b/Commands/prototype/prototype.mm
@@ -19,7 +19,7 @@ - (void)handleCommand:(CLIProxy*)proxy
 	{
 		// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)
 		if([values isKindOfClass:[NSString class]])
-			values = [NSPropertyListSerialization propertyListFromData:[(NSString*)values dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];
+			values = [NSPropertyListSerialization propertyListWithData:[(NSString*)values dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];
 
 		for(id key in [values allKeys])
 			[TMD2Chameleon createSubclassNamed:key withValues:[values objectForKey:key]];
diff --git a/OptionParser.mm b/OptionParser.mm
@@ -136,13 +136,13 @@ id create_type (std::string const& str, option_t::type_t const& type, NSString**
 
 		case option_t::plist:
 		{
-			NSString* error = nil;
+			NSError* error = nil;
 
 			if (str.size() > 0)
 			{
-				res = [NSPropertyListSerialization propertyListFromData:[NSData dataWithBytes:str.data() length:str.size()] mutabilityOption:NSPropertyListMutableContainersAndLeaves format:nil errorDescription:&error];
-				if(error || !res)
-					*err_out = [NSString stringWithFormat:@"%@\n%s\n", (error ?: @"unknown error parsing property list"), str.c_str()];
+				res = [NSPropertyListSerialization propertyListWithData:[NSData dataWithBytes:str.data() length:str.size()] options:NSPropertyListMutableContainersAndLeaves format:NULL error:&error];
+				if(!res)
+					*err_out = [NSString stringWithFormat:@"%@\n%s\n", ([error localizedDescription] ?: @"unknown error parsing property list"), str.c_str()];
 			}
 			else
 			{
diff --git a/TMDCommand.h b/TMDCommand.h
@@ -6,7 +6,7 @@
 
 + (id)objectForCommand:(NSString*)aCommand;
 
-+ (id)readPropertyList:(NSFileHandle*)aFileHandle error:(NSString**)error;
++ (id)readPropertyList:(NSFileHandle*)aFileHandle error:(NSError**)error;
 + (void)writePropertyList:(id)aPlist toFileHandle:(NSFileHandle*)aFileHandle;
 
 - (NSString*)commandDescription;
diff --git a/TMDCommand.mm b/TMDCommand.mm
@@ -20,27 +20,27 @@ + (id)objectForCommand:(NSString*)aCommand
 	return [Commands objectForKey:aCommand];
 }
 
-+ (id)readPropertyList:(NSFileHandle*)aFileHandle error:(NSString**)error;
++ (id)readPropertyList:(NSFileHandle*)aFileHandle error:(NSError**)error;
 {
 	NSData* data = [aFileHandle readDataToEndOfFile];
 	if([data length] == 0)
 		return nil;
 
-	id plist = [NSPropertyListSerialization propertyListFromData:data mutabilityOption:NSPropertyListMutableContainersAndLeaves format:nil errorDescription:error];
+	id plist = [NSPropertyListSerialization propertyListWithData:data options:NSPropertyListMutableContainersAndLeaves format:nil error:error];
 
 	return plist;
 }
 
 + (void)writePropertyList:(id)aPlist toFileHandle:(NSFileHandle*)aFileHandle
 {
-	NSString* error = nil;
-	if(NSData* data = [NSPropertyListSerialization dataFromPropertyList:aPlist format:NSPropertyListXMLFormat_v1_0 errorDescription:&error])
+	NSError* error = nil;
+	if(NSData* data = [NSPropertyListSerialization  dataWithPropertyList:aPlist format:NSPropertyListXMLFormat_v1_0 options:0 error:&error])
 	{
 		[aFileHandle writeData:data];
 	}
 	else
 	{
-		fprintf(stderr, "%s\n", [error UTF8String] ?: "unknown error serializing returned property list");
+		fprintf(stderr, "%s\n", [[error localizedDescription] UTF8String] ?: "unknown error serializing returned property list");
 		fprintf(stderr, "%s\n", [[aPlist description] UTF8String]);
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -140,11 +140,11 @@ - (void)writeStringToError:(NSString*)text;`
`140`	`140`
`141`	`141`	`- (id)readPropertyListFromInput;`
`142`	`142`	`{`
`143`		`- NSString* error = nil;`
`144`		`- id plist = [TMDCommand readPropertyList:[self inputHandle] error:&error];`
	`143`	`+ NSError* error = nil;`
	`144`	`+ id plist = [TMDCommand readPropertyList:[self inputHandle] error:&error];`
`145`	`145`
`146`		`- if(error \|\| !plist)`
`147`		`- [self writeStringToError:error ?: @"unknown error parsing property list\n"];`
	`146`	`+ if(!plist)`
	`147`	`+ [self writeStringToError:[error localizedDescription] ?: @"unknown error parsing property list\n"];`
`148`	`148`
`149`	`149`	`return plist;`
`150`	`150`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ - (void)handleCommand:(CLIProxy*)proxy`
`17`	`17`	`{`
`18`	`18`	`// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)`
`19`	`19`	`if([defaults isKindOfClass:[NSString class]])`
`20`		`- defaults = [NSPropertyListSerialization propertyListFromData:[(NSString*)defaults dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];`
	`20`	`+ defaults = [NSPropertyListSerialization propertyListWithData:[(NSString*)defaults dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];`
`21`	`21`
`22`	`22`	`[[NSUserDefaults standardUserDefaults] registerDefaults:defaults];`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ - (NSSavePanel)setupSavePanel:(NSSavePanel)savePanel usingParameters:(NSDictio`
`47`	`47`
`48`	`48`	`if(NSString* typesStr = args[@"allowedFileTypes"])`
`49`	`49`	`{`
`50`		`- id rawTypes = [NSPropertyListSerialization propertyListFromData:[typesStr dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];`
	`50`	`+ id rawTypes = [NSPropertyListSerialization propertyListWithData:[typesStr dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];`
`51`	`51`	`NSArray* types = nil;`
`52`	`52`	`if([rawTypes isKindOfClass:[NSString class]])`
`53`	`53`	`types = [NSArray arrayWithObject:rawTypes];`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ - (void)handleCommand:(CLIProxy*)proxy`
`83`	`83`
`84`	`84`	`// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)`
`85`	`85`	`if([model isKindOfClass:[NSString class]])`
`86`		`- model = [NSPropertyListSerialization propertyListFromData:[(NSString*)model dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];`
	`86`	`+ model = [NSPropertyListSerialization propertyListWithData:[(NSString*)model dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];`
`87`	`87`
`88`	`88`	`if(NSString* updateToken = [args objectForKey:@"update"])`
`89`	`89`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ - (void)handleCommand:(CLIProxy*)proxy`
`19`	`19`	`{`
`20`	`20`	`// FIXME this is needed only because we presently can’t express argument constraints (CLIProxy would otherwise correctly validate/convert CLI arguments)`
`21`	`21`	`if([values isKindOfClass:[NSString class]])`
`22`		`- values = [NSPropertyListSerialization propertyListFromData:[(NSString*)values dataUsingEncoding:NSUTF8StringEncoding] mutabilityOption:NSPropertyListImmutable format:nil errorDescription:NULL];`
	`22`	`+ values = [NSPropertyListSerialization propertyListWithData:[(NSString*)values dataUsingEncoding:NSUTF8StringEncoding] options:NSPropertyListImmutable format:NULL error:NULL];`
`23`	`23`
`24`	`24`	`for(id key in [values allKeys])`
`25`	`25`	`[TMD2Chameleon createSubclassNamed:key withValues:[values objectForKey:key]];`
Original file line number	Diff line number	Diff line change
`@@ -136,13 +136,13 @@ id create_type (std::string const& str, option_t::type_t const& type, NSString**`
`136`	`136`
`137`	`137`	`case option_t::plist:`
`138`	`138`	`{`
`139`		`- NSString* error = nil;`
	`139`	`+ NSError* error = nil;`
`140`	`140`
`141`	`141`	`if (str.size() > 0)`
`142`	`142`	`{`
`143`		`- res = [NSPropertyListSerialization propertyListFromData:[NSData dataWithBytes:str.data() length:str.size()] mutabilityOption:NSPropertyListMutableContainersAndLeaves format:nil errorDescription:&error];`
`144`		`- if(error \|\| !res)`
`145`		`- *err_out = [NSString stringWithFormat:@"%@\n%s\n", (error ?: @"unknown error parsing property list"), str.c_str()];`
	`143`	`+ res = [NSPropertyListSerialization propertyListWithData:[NSData dataWithBytes:str.data() length:str.size()] options:NSPropertyListMutableContainersAndLeaves format:NULL error:&error];`
	`144`	`+ if(!res)`
	`145`	`+ *err_out = [NSString stringWithFormat:@"%@\n%s\n", ([error localizedDescription] ?: @"unknown error parsing property list"), str.c_str()];`
`146`	`146`	`}`
`147`	`147`	`else`
`148`	`148`	`{`