Localization: Add plist support

Author: hmelder

Source/NSBundle.m

@@ -54,6 +54,7 @@
 #import "GNUstepBase/NSTask+GNUstepBase.h"
 
 #import "GSPrivate.h"
+#import "NSPropertyListPrivate.h"
 
 /* Store the working directory at startup */
 static NSString		*_launchDirectory = nil;
@@ -2872,21 +2873,58 @@ - (NSString *) localizedStringForKey: (NSString *)key
       tablePath = [self pathForResource: tableName ofType: @"strings"];
       if (tablePath != nil)
         {
+          NSPropertyListFormat format;
           NSStringEncoding	encoding;
           NSString		*tableContent;
           NSData		*tableData;
           const unsigned char	*bytes;
           unsigned		length;
 
-          tableData = [[NSData alloc] initWithContentsOfFile: tablePath];
-          bytes = [tableData bytes];
-          length = [tableData length];
           /*
            * A localisation file can be:
-           * - UTF-16 with a leading BOM,
-           * - UTF-8,
-           * - or ASCII with \U escapes.
+           *   1. A reduced "old-style" plist containing only one top-level dictionary
+           *   2. An xml-based or binary plist.
+           */
+          tableData = [[NSData alloc] initWithContentsOfFile: tablePath];
+          if (tableData == nil)
+            {
+              NSWarnMLog(@"Failed read contents of file at path %@", tablePath);
+              goto end;
+            }
+
+          /*
+           * Check if tableData is a proper plist
+           */
+          format = [NSPropertyListSerialization formatFromData: tableData];
+          if (format != 0)
+            {
+              NSString *errorDescription = nil;
+              table = [NSPropertyListSerialization propertyListFromData: tableData
+                                                      mutabilityOption: NSPropertyListImmutable
+                                                                format: &format
+                                                      errorDescription: &errorDescription];
+              if (table == nil)
+                {
+                  NSWarnMLog(@"Expected localization file at path %@ to be a property list"
+                    @" of type %lu, but parsing failed - %@", tableData, format, errorDescription);
+                }
+              else
+                {
+                  [_localizations setObject: table forKey: tableName];
+                }
+
+              goto end;
+            }
+
+
+          /*
+           * The following encodings are supported for the reduced "old-style" plist:
+           *   - UTF-16 with a leading BOM,
+           *   - UTF-8,
+           *   - or ASCII with \U escapes.
            */
+          bytes = [tableData bytes];
+          length = [tableData length];
           if (length > 2
               && ((bytes[0] == 0xFF && bytes[1] == 0xFE)
                   || (bytes[0] == 0xFE && bytes[1] == 0xFF)))
@@ -2949,6 +2987,7 @@ - (NSString *) localizedStringForKey: (NSString *)key
         [_localizations setObject: table forKey: tableName];
     }
 
+  end:
   if (key == nil || (newString = [table objectForKey: key]) == nil)
     {
       NSString	*show = [[NSUserDefaults standardUserDefaults]

Source/NSPropertyList.m

@@ -23,6 +23,7 @@
    */
 
 #import "common.h"
+#include <stdint.h>
 #import "GNUstepBase/GSMime.h"
 
 #import "Foundation/NSArray.h"
@@ -2460,6 +2461,40 @@ + (void) initialize
   classInitialized = YES;
 }
 
+// Private class method for retrieving the format from an encoding plist
++ (NSPropertyListFormat) formatFromData: (NSData *) data
+{
+  const uint8_t *bytes = [data bytes];
+  NSUInteger length = [data length];
+  if (length >= 8 && memcmp(bytes, "bplist00", 8) == 0)
+    {
+      return NSPropertyListBinaryFormat_v1_0;
+    }
+  else if (bytes[0] == 0 || bytes[0] == 1)
+    {
+      return NSPropertyListGNUstepBinaryFormat;
+    }
+  else
+    {
+      unsigned int index = 0;
+
+      // Skip any leading white space.
+      while (index < length && GS_IS_WHITESPACE(bytes[index]) == YES)
+        {
+          index++;
+        }
+      
+      if (length - index > 2
+        && bytes[index] == '<' && bytes[index+1] == '?')
+        {
+          // It begins with '<?' so it is xml
+          return NSPropertyListXMLFormat_v1_0;
+        }
+    }
+
+  return 0;
+}
+
 + (NSData*) dataFromPropertyList: (id)aPropertyList
 			  format: (NSPropertyListFormat)aFormat
 		errorDescription: (NSString**)anErrorString

Source/NSPropertyListPrivate.h

@@ -0,0 +1,13 @@
+#ifndef	_INCLUDED_NSPROPERTYLISTPRIVATE_H
+#define	_INCLUDED_NSPROPERTYLISTPRIVATE_H
+
+#import  <Foundation/NSPropertyList.h>
+
+@interface NSPropertyListSerialization (CheckFormat)
+    // Checks if the content of data is a property list.
+    // Returns 0 if not a binary plist (NSPropertyListBinaryFormat_v1_0),
+    // GNUstep binary plist, or XML plist.
+    + (NSPropertyListFormat) formatFromData: (NSData *) data; 
+@end
+
+#endif // _INCLUDED_NSPROPERTYLISTPRIVATE_H