In the macOS, iOS, NeXTSTEP, and GNUstep programming frameworks, property list files are files that store serialized objects. Property list files use the filename extension .plist, and thus are often referred to as p-list files.
Property list files are often used to store a user's settings. They are also used to store information about bundles and applications, a task served by the resource fork in the old Mac OS.
Property lists are also used for localization strings for development. These files use the .strings or .stringsdict extensions. The former is a "reduced" old-style plist containing only one dictionary without the braces (see propertyListFromStringsFileFormat),[1] while the latter is a fully-fledged plist. Xcode also uses a .pbxproj extension for old-style plists used as project files.
Representations[edit]
Since the data represented by property lists is somewhat abstract, the underlying file format can be implemented many ways. Namely, NeXTSTEP used one format to represent a property list, and the subsequent GNUstep and macOS frameworks introduced differing formats.
NeXTSTEP[edit]
Under NeXTSTEP, property lists were designed to be human-readable and edited by hand, serialized to ASCII in a syntax somewhat like a programming language. This same format was used by OpenStep.
- Strings are represented in C literal style:
"This is a plist string\n"; simpler, unquoted strings are allowed as long as they consist of alphanumericals and one of _$+/:.-. - Binary data are represented as:
< [hexadecimal codes in ASCII] >. Spaces and comments between paired hex-codes are ignored. - Arrays are represented as:
( "1", "2", "3" ). Trailing commas are tolerated. - Dictionaries are represented as:
{ "key" = "value"; ... }. The left-hand side must be a string, but it can be unquoted. - Comments are allowed as:
/* This is a comment */and// This is a line comment. - As in C, whitespace are generally insignificant to syntax. Value statements terminate by a semicolon.
One limitation of the original NeXT property list format is that it could not represent an NSValue (number, boolean, etc.) object. As a result, these values would have to be converted to string, and "fuzzily" recovered by the application.[2] Another limitation is that there is no official 8-bit encoding defined.[3]
The defaults utility, introduced in OpenStep (1998), can be used to manipulate plist files used for storage of preferences (known as defaults in NeXTSTEP, hence the name) on the command line via their preferences domain, and this utility can be used to edit arbitrary plist files. This utility superseded three older commands.[4]
GNUstep[edit]
GNUstep adopts the NeXTSTEP format, with additions for representing NSValue and NSDate data types. The new typed entries have the form <*T...>, where T is a one-letter type code. For example, an NSValue of boolean YES is represented as <*BY> and NSDate objects are represented as <*DYYYY-MM-DD HH:MM:SS +ZZZZ>.[5][6] Binary data can also use the more efficient base64 format as <[ b64... ]>. The 8-bit problem is implicitly solved as well, as most deployments use UTF-8. All in all, NSPropertyListGNUstepFormat brings the expressiveness and compactness of the human-readable textual format on par with Apple's XML format.
GNUstep also has its own binary format, NSPropertyListGNUstepBinaryFormat, implemented in NSSerialization. This format is defined recursively like the textual formats, with a single-byte type marker preceding some data. A form of string interning is supported via a GS-extension shouldBeCompact switch.[7]
Two relative independent plist handlers are found in GNUstep: the CFPropertyList in libs-core-base (CoreFoundation), and the NSPropertyList in libs-base (Foundation Kit). Both support the binary and XML forms used by macOS to some degree, but the latter is a lot more complete. For example, the two GNUstep-specific formats are only handled in the latter.[8]
GNUstep provides a set of plist command-line tools based on NSPropertyList, including a version of pl[9] and defaults.[4]
macOS[edit]
While macOS can also read the NeXTSTEP format, Apple sets it aside in favor of two new formats of its own, one XML-based and the other binary. Apple also has a partially-compatible JSON format (NSJSONSerialization).
History[edit]
In Mac OS X 10.0, the NeXTSTEP format was deprecated, and a new XML format was introduced, with a public DTD defined by Apple. The XML format supports non-ASCII characters and storing NSValue objects (which, unlike GNUstep's ASCII property list format, Apple's ASCII property list format does not support).[10]
Since XML files, however, are not the most space-efficient means of storage, Mac OS X 10.2 introduced a new format where property list files are stored as binary files. Starting with Mac OS X 10.4, this is the default format for preference files. In Mac OS X 10.7, support for reading and writing files in JSON format was introduced. JSON and property lists are not fully compatible with each other, though. For example, property lists have native date and data types, which the JSON format does not support. Conversely, JSON permits null values while property lists do not support explicit nulls.
Tooling[edit]
The old defaults tool from NeXTSTEP remains available. The /usr/libexec/PlistBuddy command provides an interactive plist editor. It can also be scripted.[11]
The plutil utility (introduced in Mac OS X 10.2) can be used to check the syntax of property lists, or convert a property list file from one format to another. It also supports converting plists to Objective-C or Swift object literals.[12] Like the Cocoa NSPropertyListSerialization it is built on, it takes "old-style" inputs, but does not convert to this type. (The Cocoa NSSerializer from before Mac OS X 10.2 emits old-styled output.)
The pl utility is introduced in Mac OS X v10.5. It takes any input and tries to generate "old-style" plists.[13][a] Like the GNUstep version, it appears to use the description property of Foundation types found in plists, which Apple has specified to produce valid old-style plists.[b]
In terms of the internals, Apple provides an open source parser for old style, XML, and binary formats in their C Core Foundation code as CFPropertyList. However, all the utilities and most parts of the system use the closed-source NSPropertyList parser from the Obj-C Foundation Kit. The Swift reimplementation is open source, but is not guaranteed to be identical.
Format[edit]
XML and JSON property lists are hand-editable in any text editor. Additionally, Apple provides support in Xcode for editing property lists in a hierarchical viewer/editor that can handle plists formatted in binary or XML, but not JSON. As of Mac OS X 10.4, Apple provides an AppleScript interface for reading property list files through the System Events application. As of Mac OS X 10.5, Apple provides an AppleScript interface for editing, creating and writing property list files as well.[14]
For the XML format, the tags, related Foundation classes and CoreFoundation types, and data storage formats are as follows:
| Foundation class | CoreFoundation type | XML Tag | hideStorage format |
|---|---|---|---|
| NSString | CFString | <string> | UTF-8 encoded string |
| NSNumber | CFNumber | <real>, <integer> | Decimal string; reals can have exponents, or be Infinity (inf) or NaN (nan). |
| NSNumber | CFBoolean | <true/>, <false/> | No data (tag only) |
| NSDate | CFDate | <date> | ISO 8601 formatted string |
| NSData | CFData | <data> | Base64 encoded data |
| NSArray | CFArray | <array> | Can contain any number of child elements. Can be empty. |
| NSDictionary | CFDictionary | <dict> | Alternating <key> tags and plist element tags. Can be empty. |
The Binary file format is documented in a comment block in the Core Foundation C code source file (CF/CFBinaryPList.c) for Apple's open sourced implementation of binary plists in its Foundation library.[15] Apple describes the implementation as opaque in its plist(5) manual page documentation,[16] which means that reliance on the format is discouraged. In the binary file format the magic number (the first few bytes of the file which indicate that it's a valid plist file) is the text bplist, followed by two bytes indicating the version of the format.
The binary file can store some information that cannot be captured in the XML or JSON file formats. The array, set and dictionary binary types are made up of pointers - the objref and keyref entries - that index into an object table in the file. This means that binary plists can capture the fact that - for example - a separate array and dictionary serialized into a file both have the same data element stored in them. This cannot be captured in an XML file. Converting such a binary file will result in a copy of the data element being placed into the XML file. Additionally the binary file has a UID type that is used to identify data items when serialized. The complete list of data that can be stored taken from the C code source file is as follows:
| Foundation class | CoreFoundation type | Object type | Marker byte | Encoded data |
|---|---|---|---|---|
| nil | nil | null (v"1?"+) | 0000 0000 | n/a |
| NSNumber | CFBoolean | bool | 0000 1000 (false) 0000 1001 (true) | n/a |
| NSURL | CFURL | url (v"1?"+) | 0000 1100 (base string) 0000 1101 (string) | string: URL string in recursive encoding (as in "string object format?"); base string: the same, but with a base URL encoded first. |
| NSUUID | CFUUID | uuid (v"1?"+) | 0000 1110 | 16 bytes of UUID |
| fill | 0000 1111 | nothing - just a padding | ||
| NSNumber | CFNumber | int | 0001 nnnn | # of bytes is 2^nnnn, big-endian bytes (1, 2, 4, or 8) |
| NSNumber | CFNumber | real | 0010 nnnn | # of bytes is 2^nnnn, big-endian bytes (4 or 8) |
| NSDate | CFDate | date | 0011 0011 | 8 byte float follows, big-endian bytes; seconds from 1/1/2001 (Core Data epoch) |
| NSData | CFData | data | 0100 nnnn [int] | nnnn is number of bytes unless 1111 then int count follows, followed by bytes |
| NSString | CFString | string | 0101 nnnn [int] | ASCII string, nnnn is # of chars, else 1111 then int count, then bytes |
| NSString | CFString | string | 0110 nnnn [int] | Unicode string, nnnn is # of chars, else 1111 then int count, then big-endian 2-byte uint16_t |
| NSString | CFString | string (v"1?"+) | 0111 nnnn [int] | UTF-8 string, nnnn is # of chars, else 1111 then int count, then bytes |
| UID | 1000 nnnn | nnnn+1 is # of big-endian bytes (1, 2, 4, or 8). Unsigned int, only produced by NSKeyedArchiver (see below).[17] | ||
| NSArray | CFArray | array | 1010 nnnn [int] | objref* nnnn is count, unless '1111', then int count follows |
| NSOrderedSet | ordset (v"1?"+) | 1011 nnnn [int] | objref* nnnn is count, unless '1111', then int count follows | |
| NSSet | CFSet | set (v"1?"+) | 1100 nnnn [int] | objref* nnnn is count, unless '1111', then int count follows |
| NSDictionary | CFDictionary | dict | 1101 nnnn [int] | keyref* objref* nnnn is count, unless '1111', then int count follo |
Note the v"1?"+ note in many types. This means that the marker byte is only found in files with a format version no lower than the "1?" magic number. The precise way to parse them is more nebulous than the way to parse legacy types, since the CFBinaryPlist implementation only handles version "0?". In practice, these types are never encountered, since NSKeyedArchiver is already capable of capturing these information.
A table of offsets follow the object table, which is then followed by a trailer containing information on the size and location of the two tables.
Serializing to plist[edit]
Since property lists do not capture all the information and data types required to describe an arbitrary object, an extra layer of encoding and decoding is often done. The OpenStep specification abstracts the operation of serializing any NSObject under the NSCoding protocol. Any class implementing this protocol can have its instances serialized by a NSCoder subclass to some other format.[18] Two main coders exist for the purpose of serializing objects to plists:
- NSArchiver, which converts an object into a block of binary data somewhat like a tagged struct. This class is part of OpenStep, although no concrete format has been defined. In practice, one can use it to serialize an object to a file (skipping the plist), or to embed the data in a plist. It must be read and written in the same order as written. The introduction of NSKeyedArchiver deprecates its use.
- NSKeyedArchiver, introduced in Mac OS X 10.2, transforms the object into an NSDictionary. The main improvement of this format for programmers is that it accesses members not by a fixed order, but by string keys. Internally, it somewhat recapitulates the binary plist format by storing an object table array called $objects in the dictionary. Everything else, including class information, is referenced by a UID pointer. A $top entry under the dict points to the top-level object the programmer was meaning to encode.[17]
Among other things, using an archiver allows for new datatypes to be encoded without changing the plist format itself and it is the preferred way for Apple to encode things like NSSets and null values. Parsing the formats do prove a bit harder, since one more layer must be followed even for some classes plists were supposed to support. Like the binary format which also has an object table, it is possible to create circular references in NSKeyedArchiver. Since there is not a UID data type in XML, the integers are stored in a dictionary under the key "CF$UID".[19]
Apple publishes an open-source NSKeyedArchiver in Swift Corelibs Foundation; like the closed-source Apple Foundation, it restricts output formats to binary and XML only. It also has some test cases showing the results of serialization.[20] GNUstep also has a compatible implementation, which does not limit output formats.[21]
Path language[edit]
There is not a single, standardized path language for property lists like XPath does for XML, but informal conventions used by various programs exist.
- A dot syntax version is found in the keypath argument of Apple's plutil. It appears to derive from
(id) -[NSObject(NSKeyValueCoding) valueForKeyPath:].[12] - A different format is used by PlistBuddy, with a colon syntax for indexing.[11]
Neither format is able to express a key with the separator character in it.
Other platforms[edit]
Windows[edit]
Although best known on Apple or Darwin systems, including iOS and macOS, plist files are also present on Windows computers when Apple software, such as iTunes[22] or Safari[23] are installed. On Windows, the files are typically binary files,[24] although some applications may generate PLIST files in the other formats.
On Windows the Apple plist files are stored in the user's home directory under %USERPROFILE%\AppData\Roaming\Apple Computer. These plist files on Windows typically store preferences and other information, rather than using the Windows registry.
Options for editing PLIST files on Windows are not as extensive as on macOS. If the file is in the XML or JSON format with care a text editor such as Notepad++ can be used. Apple ships a plutil.exe within its "Apple Application Support" package (which is part of iTunes), and it is identical to its macOS counterpart.
NetBSD[edit]
Introduced in 2006 and first released with NetBSD#4.0 (2007) is a proplib library, which can be used for serialising data between the kernel and userland. It implements part of the XML plist language.[25]
One of the sample users of proplib is the second revision of the sysmon envsys framework for system monitoring.
NetBSD's proplib library has also been ported to DragonFly in 2010, and is available since DragonFly BSD#2.8.[26]
Cross-platform[edit]
- Facebook's open-source reimplementation of the Xcode build tool, xcbuild, contains a plist library as well as plutil and PlistBuddy. These cross-platform utilities are written in C++.[27]
- The Python programming language has a builtin
plistlibmodule to read and write plist files, in Apple's XML or in binary (since Python 3.4).[28] ProperTree is a cross-platform editor that makes use of this library.[29]- A third-party library called ccl-bplist has the additional ability to handle NSKeyedArchiver UIDs.[19]
- Go has a
plistpackage that supports four types of plists: OpenStep text, GNUStep text, Apple XML, and Apple Binary. It also handles UIDs in XML and binary formats.[2]
See also[edit]
Notes[edit]
References[edit]
- ^ "NSString class reference: propertyListFromStringsFileFormat". GNUstep. Retrieved February 17, 2020.
- ^ a b "Package plist". godoc.org.
When Unmarshal encounters an OpenStep property list, it will enter a relaxed parsing mode: OpenStep property lists can only store plain old data as strings, so we will attempt to recover integer, floating-point, boolean and date values wherever they are necessary.
- ^ "Old-Style ASCII Property Lists". Apple Developer (Property List Programming Guide). Retrieved February 16, 2020.
- ^ a b – Linux General Commands Manual
- ^ Frith-Macdonald, Richard (2004). "NSPropertyListSerialization class documentation". GNUstep.
- ^ "Property Lists". GNUstepWiki.
- ^ "NSSerialization documentation". GNUstep. source code
- ^ "Types and Constants: NSPropertyListFormat". gnustep.org.
- ^ – Linux General Commands Manual
- ^ "appleexaminer.com: "PLIST files"". Archived from the original on February 19, 2014. Retrieved February 27, 2014.
- ^ a b – Darwin and macOS System Manager's Manual
- ^ a b – Darwin and macOS General Commands Manual
- ^ – Darwin and macOS General Commands Manual
- ^ "AppleScript: Property Lists". April 24, 2009. Archived from the original on April 24, 2009.
- ^ a b "CF/CFBinaryPList.c". Apple Open Source. Retrieved January 6, 2020.
- ^ – Darwin and macOS File Formats Manual
- ^ a b Caithness, Alex (April 4, 2012). "Geek post: NSKeyedArchiver files – what are they, and how can I use them?". Digital Investigation.
The CF$UID data type in Listing 2 is a dictionary with a single key (“CF$UID”) which is followed by an integer number (this layout is what you will see when the property list is represented in XML; in the raw binary format the “UID” data type is a separate entity which doesn't require the dictionary structure). These data types represent a reference to another entity in the “$objects” array. The number of the CF$UID gives the position of the array.
- ^ "NSCoder.html". OpenStep specification.
- ^ a b CCLForensics Group (January 15, 2020). "cclgroupltd/ccl-bplist". GitHub.
- ^ "apple/swift-corelibs-foundation: NSKeyedArchiver.swift". GitHub. tests
- ^ "NSKeyedArchiver documentation". GNUstep documentation. Retrieved February 23, 2020. source code
- ^ "iTunes Backup - The iPhone Wiki". www.theiphonewiki.com.
- ^ "How does the Apple Safari web-browser store its settings on Windows?". Super User.
- ^ "GitHub - microsoft/NSPlist: NSPlist". May 3, 2019 – via GitHub.
- ^ Jason R. Thorpe. "proplib — property container object library". NetBSD. Lay summary.
- ^ Jason R. Thorpe. "proplib — property container object library". DragonFly BSD. Lay summary.
- ^ "facebook/xcbuild/Libraries/plist". GitHub. Retrieved February 17, 2020.
- ^ "plistlib — Generate and parse Mac OS X .plist files". Python 3 documentation. Retrieved January 6, 2020.
- ^ "corpnewt/ProperTree: Cross platform GUI plist editor written in python". GitHub. February 17, 2020. Retrieved February 17, 2020.
